@zip.js/zip.js 2.6.13 → 2.6.16

package/README.md

@@ -1,13 +1,74 @@
-zip.js is an open-source library (BSD-3-Clause license) to zip and unzip files
-supporting multi-core compression, compression streams, Zip64 and encryption.
+# Introduction
+
+zip.js is an open-source library (BSD-3-Clause license) implemented in
+JavaScript to compress and decompress zip files. It has been designed to handle
+large amounts of data and notably supports multi-core compression, compression
+streams, Zip64 and encryption.
+
+# Documentation
 
 See here for more info: https://gildas-lormeau.github.io/zip.js/
 
+# Examples
+
+## Hello world
+
 ```js
+import {
+  BlobReader,
+  BlobWriter,
+  TextReader,
+  TextWriter,
+  ZipReader,
+  ZipWriter,
+} from "https://deno.land/x/zipjs/index.js";
+
 // ----
-// Hello world with zip.js (and Streams)
+// Write the zip file
 // ----
 
+// Creates a BlobWriter object where the zip content will be written.
+const zipFileWriter = new BlobWriter();
+// Creates a TextReader object storing the text of the entry to add in the zip
+// (i.e. "Hello world!").
+const helloWorldReader = new TextReader("Hello world!");
+
+// Creates a ZipWriter object writing data via `zipFileWriter`, adds the entry
+// "hello.txt" containing the text "Hello world!" via `helloWorldReader`, and
+// closes the writer.
+const zipWriter = new ZipWriter(zipFileWriter);
+await zipWriter.add("hello.txt", helloWorldReader);
+await zipWriter.close();
+
+// Retrieves the Blob object containing the zip content into `zipFileBlob`. It
+// is also returned by zipWriter.close() for more convenience.
+const zipFileBlob = await zipFileWriter.getData();
+
+// ----
+// Read the zip file
+// ----
+
+// Creates a BlobReader object used to read `zipFileBlob`.
+const zipFileReader = new BlobReader(zipFileBlob);
+// Creates a TextWriter object where the content of the first entry in the zip
+// will be written.
+const helloWorldWriter = new TextWriter();
+
+// Creates a ZipReader object reading the zip content via `zipFileReader`,
+// retrieves metadata (name, dates, etc.) of the first entry, retrieves its
+// content via `helloWorldWriter`, and closes the reader.
+const zipReader = new ZipReader(zipFileReader);
+const firstEntry = (await zipReader.getEntries()).shift();
+const helloWorldText = await firstEntry.getData(helloWorldWriter);
+await zipReader.close();
+
+// Displays "Hello world!".
+console.log(helloWorldText);
+```
+
+## Hello world with Streams
+
+```js
 import {
   BlobReader,
   ZipReader,
@@ -18,8 +79,8 @@ import {
 // Write the zip file
 // ----
 
-// Creates a TransformStream object where the zip content will be written in
-// the `writable` property.
+// Creates a TransformStream object, the zip content will be written in the
+// `writable` property.
 const zipFileWriter = new TransformStream();
 // Creates a Promise object resolved to the zip content returned as a Blob
 // object via the `readable` property of `zipFileWriter`.
@@ -30,8 +91,8 @@ const zipFileBlobPromise = new Response(zipFileWriter.readable).blob();
 const helloWorldReader = { readable: new Blob(["Hello world!"]).stream() };
 
 // Creates a ZipWriter object writing data via `zipFileWriter`, adds the entry
-// "hello.txt" containing the text "Hello world!" via `helloWorldReader` in the
-// zip, and closes the writer.
+// "hello.txt" containing the text "Hello world!" via `helloWorldReader`, and
+// closes the writer.
 const zipWriter = new ZipWriter(zipFileWriter);
 await zipWriter.add("hello.txt", helloWorldReader);
 await zipWriter.close();
@@ -39,22 +100,14 @@ await zipWriter.close();
 // Retrieves the Blob object containing the zip content into `zipFileBlob`.
 const zipFileBlob = await zipFileBlobPromise;
 
-// Uncomment the following code to download the zip file (in a browser)
-//
-// const anchorElement = document.createElement("a");
-// anchorElement.href = URL.createObjectURL(zipFileBlob);
-// anchorElement.download = "hello.zip";
-// anchorElement.click();
-//
-
 // ----
 // Read the zip file
 // ----
 
 // Creates a BlobReader object used to read `zipFileBlob`.
 const zipFileReader = new BlobReader(zipFileBlob);
-// Creates a TransformStream object where the content of the first entry in the
-// zip will be written in the `writable` property.
+// Creates a TransformStream object, the content of the first entry in the zip
+// will be written in the `writable` property.
 const helloWorldWriter = new TransformStream();
 // Creates a Promise object resolved to the content of the first entry returned
 // as text via the `readable` property of `helloWorldWriter`.

package/dist/README.md

@@ -1,8 +1,10 @@
 # Built scripts of zip.js
- 
+
+**Warning**: These files are not compatible with ES modules, i.e. they cannot be imported with `import`. Instead, import `index.js` in the root folder of the project or one of the files prefixed with `zip-` in the [`/lib`](../lib) folder (e.g. `/lib/zip-no-worker-inflate.js`).
+
 - for production (minified):
 
-|                                | [`ZipReader`](https://gildas-lormeau.github.io/zip.js/core-api.html#zip-reading) API | [`ZipWriter`](https://gildas-lormeau.github.io/zip.js/core-api.html#zip-writing) API | [`zip.fs`](https://gildas-lormeau.github.io/zip.js/fs-api.html#fs-constructor) API | Web Workers | No Web Workers | Usage                                                 |
+|                                | [`ZipReader`](https://gildas-lormeau.github.io/zip.js/api/classes/ZipReader.html) API | [`ZipWriter`](https://gildas-lormeau.github.io/zip.js/api/classes/ZipWriter.html) API | [`zip.fs`](https://gildas-lormeau.github.io/zip.js/api/classes/FS.html) API | Web Workers | No Web Workers | Usage                                                 |
 |--------------------------------|-----------------|-----------------|--------------|-------------|----------------|-------------------------------------------------------|
 | `zip.min.js`                   |               x |               x |              |           x |                | compression/decompression with web workers            |
 | `zip-no-worker.min.js`         |               x |               x |              |             |              x | compression/decompression without web workers         |
@@ -14,13 +16,13 @@
 
 - for development/debugging:
 
-|                       | [`zip`](https://gildas-lormeau.github.io/zip.js/core-api.html) API | [`zip.fs`](https://gildas-lormeau.github.io/zip.js/fs-api.html#fs-constructor) API | Web Workers | No Web Workers | 
+|                       | `zip` API | [`zip.fs`](https://gildas-lormeau.github.io/zip.js/api/classes/FS.html) API | Web Workers | No Web Workers | 
 |-----------------------|-----------|--------------|-------------|----------------|
 | `zip.js`              |         x |              |           x |                |
 | `zip-full.js`         |         x |              |           x |              x |
 | `zip-fs.js`           |         x |            x |           x |                |
 | `zip-fs-full.js`      |         x |            x |           x |              x |
 
-- `z-worker.js` can be used as a web worker script if the [CSP](https://developer.mozilla.org/docs/Web/HTTP/CSP) does not allow to load it with a Blob URI
+- `z-worker.js` can be used as a web worker script if the [Content Security Policy](https://developer.mozilla.org/docs/Web/HTTP/CSP) blocks scripts loaded with a `blob:` scheme
 - `z-worker-fflate.js` is the web worker script for using [fflate](https://gildas-lormeau.github.io/zip.js/core-api.html#alternative-codec-fflate)
 - `z-worker-pako.js` is the web worker script for using [pako](https://gildas-lormeau.github.io/zip.js/core-api.html#alternative-codec-pako)

package/dist/zip-fs-full.js

@@ -7951,18 +7951,19 @@
 
 	class Uint8ArrayWriter extends Writer {
 
-		constructor() {
-			super();
-			this.array = new Uint8Array();
+		init(initSize = 0) {
+			this.array = new Uint8Array(initSize);
 		}
 
 		writeUint8Array(array) {
-			super.writeUint8Array(array);
 			const writer = this;
-			const previousArray = writer.array;
-			writer.array = new Uint8Array(previousArray.length + array.length);
-			writer.array.set(previousArray);
-			writer.array.set(array, previousArray.length);
+			if (writer.size + array.length > writer.array.length) {
+				const previousArray = writer.array;
+				writer.array = new Uint8Array(previousArray.length + array.length);
+				writer.array.set(previousArray);
+			}
+			writer.array.set(array, writer.size);
+			super.writeUint8Array(array);
 		}
 
 		getData() {
@@ -7976,9 +7977,9 @@
 		return protocol == "http:" || protocol == "https:";
 	}
 
-	async function initStream(stream) {
+	async function initStream(stream, initSize) {
 		if (stream.init && !stream.initialized) {
-			await stream.init();
+			await stream.init(initSize);
 		}
 	}
 
@@ -8397,6 +8398,7 @@
 				bitFlag,
 				signature,
 				rawLastModDate,
+				uncompressedSize,
 				compressedSize
 			} = zipEntry;
 			const localDirectory = zipEntry.localDirectory = {};
@@ -8437,7 +8439,7 @@
 			readable.size = size;
 			const { writable } = writer;
 			const signal = getOptionValue$1(zipEntry, options, "signal");
-			await initStream(writer);
+			await initStream(writer, uncompressedSize);
 			const { onstart, onprogress, onend } = options;
 			const workerOptions = {
 				options: {
@@ -8765,6 +8767,7 @@
 	const EXTRAFIELD_LENGTH_ZIP64 = 24;
 
 	let workers = 0;
+	const pendingEntries = [];
 
 	class ZipWriter {
 
@@ -8777,7 +8780,6 @@
 				filenames: new Set(),
 				offset: writer.size || 0,
 				pendingCompressedSize: 0,
-				pendingEntries: [],
 				pendingAddFileCalls: new Set()
 			});
 		}
@@ -8786,36 +8788,34 @@
 			const zipWriter = this;
 			const {
 				pendingAddFileCalls,
-				pendingEntries,
 				config
 			} = zipWriter;
 			if (workers < config.maxWorkers) {
 				workers++;
-				let promiseAddFile;
-				try {
-					name = name.trim();
-					if (zipWriter.filenames.has(name)) {
-						throw new Error(ERR_DUPLICATED_NAME);
-					}
-					zipWriter.filenames.add(name);
-					promiseAddFile = addFile(zipWriter, name, reader, options);
-					pendingAddFileCalls.add(promiseAddFile);
-					return await promiseAddFile;
-				} catch (error) {
-					zipWriter.filenames.delete(name);
-					throw error;
-				} finally {
-					pendingAddFileCalls.delete(promiseAddFile);
+			} else {
+				await new Promise(resolve => pendingEntries.push(resolve));
+			}
+			let promiseAddFile;
+			try {
+				name = name.trim();
+				if (zipWriter.filenames.has(name)) {
+					throw new Error(ERR_DUPLICATED_NAME);
+				}
+				zipWriter.filenames.add(name);
+				promiseAddFile = addFile(zipWriter, name, reader, options);
+				pendingAddFileCalls.add(promiseAddFile);
+				return await promiseAddFile;
+			} catch (error) {
+				zipWriter.filenames.delete(name);
+				throw error;
+			} finally {
+				pendingAddFileCalls.delete(promiseAddFile);
+				const pendingEntry = pendingEntries.shift();
+				if (pendingEntry) {
+					pendingEntry();
+				} else {
 					workers--;
-					const pendingEntry = pendingEntries.shift();
-					if (pendingEntry) {
-						zipWriter.add(pendingEntry.name, pendingEntry.reader, pendingEntry.options)
-							.then(pendingEntry.resolve)
-							.catch(pendingEntry.reject);
-					}
 				}
-			} else {
-				return new Promise((resolve, reject) => pendingEntries.push({ name, reader, options, resolve, reject }));
 			}
 		}
 
@@ -8985,8 +8985,9 @@
 		let bufferedWrite;
 		let releaseLockWriter;
 		let releaseLockCurrentFileEntry;
-		let bufferedDataWritten;
+		let writingBufferedData;
 		let fileWriter;
+		let fileWriterSize;
 		files.set(name, fileEntry);
 		try {
 			let lockPreviousFileEntry;
@@ -9003,6 +9004,7 @@
 				await initStream(writer);
 				fileWriter = writer;
 			}
+			fileWriterSize = fileWriter.size;
 			fileEntry = await createFileEntry(reader, fileEntry, fileWriter.writable, zipWriter.config, options);
 			files.set(name, fileEntry);
 			fileEntry.filename = name;
@@ -9010,7 +9012,7 @@
 				let blob = fileWriter.getData();
 				await lockPreviousFileEntry;
 				await requestLockWriter();
-				bufferedDataWritten = true;
+				writingBufferedData = true;
 				const { writable } = writer;
 				if (!dataDescriptor) {
 					const headerLength = 26;
@@ -9030,7 +9032,7 @@
 					blob = blob.slice(headerLength);
 				}
 				await blob.stream().pipeTo(writable, { preventClose: true, signal });
-				bufferedDataWritten = false;
+				writingBufferedData = false;
 			}
 			fileEntry.offset = zipWriter.offset;
 			if (fileEntry.zip64) {
@@ -9042,9 +9044,12 @@
 			zipWriter.offset += fileEntry.length;
 			return fileEntry;
 		} catch (error) {
-			if ((bufferedWrite && bufferedDataWritten) || (!bufferedWrite && fileEntry.dataWritten)) {
-				error.corruptedEntry = zipWriter.hasCorruptedEntries = true;
-				zipWriter.offset += fileWriter.size;
+			if ((bufferedWrite && writingBufferedData) || (!bufferedWrite && fileEntry.writingData)) {
+				zipWriter.hasCorruptedEntries = true;
+				if (error) {
+					error.corruptedEntry = true;
+				}
+				zipWriter.offset += fileWriter.size - fileWriterSize;
 			}
 			files.delete(name);
 			throw error;
@@ -9221,10 +9226,10 @@
 		arraySet(localHeaderArray, rawExtraField, 30 + rawFilename.length + rawExtraFieldAES.length + rawExtraFieldExtendedTimestamp.length + rawExtraFieldNTFS.length);
 		let result;
 		let compressedSize = 0;
+		fileEntry.writingData = pendingFileEntry.writingData = true;
 		if (reader) {
 			reader.chunkSize = getChunkSize(config);
 			await writeData(writable, localHeaderArray);
-			fileEntry.dataWritten = pendingFileEntry.dataWritten = true;
 			const size = () => reader.size;
 			const readable = reader.readable;
 			readable.size = size;
@@ -9251,7 +9256,6 @@
 			compressedSize = result.size;
 		} else {
 			await writeData(writable, localHeaderArray);
-			fileEntry.dataWritten = pendingFileEntry.dataWritten = true;
 		}
 		let dataDescriptorArray = new Uint8Array();
 		let dataDescriptorView, dataDescriptorOffset = 0;
@@ -9304,7 +9308,8 @@
 			creationDate,
 			lastAccessDate,
 			encrypted,
-			length
+			length,
+			writingData: false
 		});
 		return fileEntry;
 	}
@@ -9586,7 +9591,7 @@
 				return zipEntry.data;
 			} else {
 				const reader = zipEntry.reader = new zipEntry.Reader(zipEntry.data, options);
-				await Promise.all([initStream(reader), initStream(writer)]);
+				await Promise.all([initStream(reader), initStream(writer, zipEntry.data.uncompressedSize)]);
 				zipEntry.uncompressedSize = reader.size;
 				const readable = reader.readable;
 				readable.size = () => reader.size;