parquet-wasm - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

package.json

@@ -7,3 +7,3 @@ {
   "description": "WebAssembly Parquet reader and writer.",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "license": "MIT OR Apache-2.0",
@@ -20,3 +20,11 @@ "repository": {
     "LICENSE_APACHE",
-    "LICENSE_MIT"
+    "LICENSE_MIT",
+    "node.d.ts",
+    "node.js",
+    "node_bg.wasm",
+    "node_bg.wasm.d.ts",
+    "web.d.ts",
+    "web.js",
+    "web_bg.wasm",
+    "web_bg.wasm.d.ts"
   ],
@@ -31,2 +39,2 @@ "module": "parquet_wasm.js",
   ]
-}
+}

README.md

@@ -9,4 +9,14 @@ # `parquet-wasm`
 
-## Usage
+## Install
 
+`parquet-wasm` is published to NPM. Install with
+
+```
+yarn add parquet-wasm
+# or
+npm install parquet-wasm
+```
+
+## API
+
 ### `readParquet`
@@ -36,2 +46,10 @@
 
+## Using
+
+`parquet-wasm` is distributed with three bindings for use in different environments.
+
+- Default, to be used in bundlers such as Webpack: `import * as parquet from 'parquet-wasm'`
+- Node, to be used with `require` in NodeJS: `const parquet = require('parquet-wasm/node');`
+- ESM, to be used directly from the Web as an ES Module: `import * as parquet from 'parquet-wasm/web';`
+
 ## Example
@@ -92,4 +110,23 @@
 
-## Credits
+### Publishing
 
+`wasm-pack` supports [three different targets](https://rustwasm.github.io/docs/wasm-pack/commands/build.html#target):
+
+- `bundler` (used with bundlers like Webpack)
+- `nodejs` (used with Node, supports `require`)
+- `web` (used as an ES module directly from the web)
+
+There are good reasons to distribute as any of these... so why not distribute as all three? `wasm-pack` doesn't support this directly but the build script in `scripts/build.sh` calls `wasm-pack` three times and merges the outputs. This means that bundler users can use the default, Node users can use `parquet-wasm/node` and ES Modules users can use `parquet-wasm/web` in their imports.
+
+To publish:
+
+```
+bash ./scripts/build.sh
+wasm-pack publish
+```
+
+## Acknowledgements
+
 A starting point of my work came from @my-liminal-space's [`read-parquet-browser`](https://github.com/my-liminal-space/read-parquet-browser) (which is also dual licensed MIT and Apache 2).
+
+@domoritz's [`arrow-wasm`](https://github.com/domoritz/arrow-wasm) was a very helpful reference for bootstrapping Rust-WASM bindings.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Native code

Supply chain risk

Contains native code (e.g., compiled binaries or shared libraries). Including native code can obscure malicious behavior.

Found 2 instances in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

11914952

increased by200.78%

Number of package files

16

increased by100%

Lines of code

1354

increased by594.36%

Number of lines in readme file

130

increased by39.78%

Worsened metrics

Number of low supply chain risk alerts

2

increased byInfinity%

Number of medium supply chain risk alerts

5

increased by400%

No dependency changes