@zip.js/zip.js 2.8.41 → 2.8.42

package/README.md

@@ -171,6 +171,43 @@ function downloadFile(blob) {
 
 Run the code on Plunker: https://plnkr.co/edit/4sVljNIpqSUE9HCA?preview
 
+## Using external assets
+
+By default, zip.js embeds the code of the web worker and the WebAssembly module
+in the library. The `@zip.js/zip.js/external` entry point references them as
+external files instead.
+
+```js
+import * as zip from "@zip.js/zip.js/external";
+```
+
+Bundlers like webpack and Vite detect these references. They emit
+`zip-web-worker.js` and `zip-module.wasm` as separate assets and remove
+approximately 45KB of embedded payloads from the main bundle. The worker also
+runs from a real file URL. This avoids `blob:` restrictions on pages and
+browser extensions with a strict Content Security Policy.
+
+With Vite, add `@zip.js/zip.js` to `optimizeDeps.exclude` to resolve the assets
+during development. With bundlers which do not rewrite
+`new URL(..., import.meta.url)` expressions, copy the two files next to the
+output bundle.
+
+The build `dist/zip-fs-external.min.js` offers the same behavior without a
+bundler. It resolves `zip-web-worker.js` and `zip-module.wasm` relative to its
+own location. The three files must be deployed in the same directory.
+
+Smaller compositions of this entry point are also available.
+`@zip.js/zip.js/lib/zip-fs-core-external.js` excludes the MIME type table
+(approximately 23KB), `getMimeType()` then returns
+`"application/octet-stream"`. `@zip.js/zip.js/lib/zip-core-external.js` also
+excludes the filesystem API. Both compositions come with prebuilt bundles in
+the `/dist` directory. The full table remains available from any entry point
+via `@zip.js/zip.js/mime-types`:
+
+```js
+import { getMimeType } from "@zip.js/zip.js/mime-types";
+```
+
 ## Tests
 
 See https://github.com/gildas-lormeau/zip.js/tree/master/tests/all

package/deno.json

@@ -1,8 +1,12 @@
 {
 	"name": "@zip-js/zip-js",
-	"version": "2.8.41",
+	"version": "2.8.42",
 	"exports": {
-		".": "./index.js"
+		".": "./index.js",
+		"./external": "./lib/zip-fs-external.js",
+		"./mime-types": "./lib/zip-mime-types.js",
+		"./lib/zip-core-external.js": "./lib/zip-core-external.js",
+		"./lib/zip-fs-core-external.js": "./lib/zip-fs-core-external.js"
 	},
 	"lint": {
 		"exclude": [

package/dist/README.md

@@ -1,6 +1,6 @@
 # Prebuilt zip.js bundles
 
-**Note**: These bundles are not ES module compatible (you cannot `import` them directly). Use `index.js` at the project root or one of the `zip-*.js` files in [`/lib`](../lib) (e.g. `/lib/zip-core.js`) for ESM usage.
+**Note**: These bundles are not ES module compatible (you cannot `import` them directly), except the files suffixed with `-external` which are ES modules. Use `index.js` at the project root or one of the `zip-*.js` files in [`/lib`](../lib) (e.g. `/lib/zip-core.js`) for ESM usage.
 
 **Note**: These bundles are standalone and always contain both `ZipReader` and `ZipWriter`, they are not tree-shaken. With a bundler, importing named identifiers from `index.js` already removes the direction you do not use.
 
@@ -10,6 +10,15 @@ Contents:
 - `zip-fs.js` / `zip-fs.min.js`: Full `ZipWriter` / `ZipReader` plus virtual file system (`fs`), with embedded Web Worker code and WASM.
 - `zip-core.js` / `zip-core.min.js`: Minimal `ZipWriter` / `ZipReader`.
 - `zip-fs-core.js` / `zip-fs-core.min.js`: Minimal `ZipWriter` / `ZipReader` plus virtual file system (`fs`).
+- `zip-fs-external.js` / `zip-fs-external.min.js`: ES module equivalent of `zip-fs.min.js` which references `zip-web-worker.js` and `zip-module.wasm` as external files instead of embedding them. The worker runs from a real file URL, which avoids `blob:` restrictions on pages and browser extensions with a strict Content Security Policy.
+- `zip-fs-core-external.js` / `zip-fs-core-external.min.js`: Same as `zip-fs-external.min.js` without the MIME type table, `getMimeType()` returns `"application/octet-stream"`.
+- `zip-core-external.js` / `zip-core-external.min.js`: Same as `zip-fs-core-external.min.js` without the virtual file system.
+- `zip-native.js` / `zip-native.min.js`, `zip-fs-native.js` / `zip-fs-native.min.js`: Equivalents of `zip.min.js` and `zip-fs.min.js` embedding a JavaScript implementation of the Compression Streams API instead of the WASM module (see the notes below).
+- `zip-legacy.js` / `zip-legacy.min.js`: Equivalent of `zip.min.js` before the version `2.8` (see the notes below).
+- `zip-web-worker.js`, `zip-web-worker-native.js`: Web Worker scripts embedding the codecs, referenced by the `-external` bundles or passed manually via the `workerURI` option of `configure()`.
+- `zip-module.wasm`: The WASM module (zlib), referenced by the `-external` bundles or passed manually via the `wasmURI` option of `configure()`.
+
+The `-external` bundles resolve `zip-web-worker.js` and `zip-module.wasm` relative to their own location, the files must be deployed in the same directory.
 
 Online builder: