@zip.js/zip.js 2.6.5 → 2.6.8

package/lib/core/io.js

@@ -519,7 +519,14 @@ function isHttpFamily(url) {
 	return protocol == "http:" || protocol == "https:";
 }
 
+async function initStream(stream) {
+	if (stream.init && !stream.initialized) {
+		await stream.init();
+	}
+}
+
 export {
+	initStream,
 	Reader,
 	Writer,
 	TextReader,

package/lib/core/zip-fs-core.js

@@ -26,7 +26,10 @@
  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
+/* global WritableStream */
+
 import {
+	initStream,
 	Reader,
 	TextReader,
 	TextWriter,
@@ -38,10 +41,12 @@ import {
 	BlobWriter,
 	HttpReader
 } from "./io.js";
-import { ZipReader } from "./zip-reader.js";
-import { ZipWriter } from "./zip-writer.js";
-
-const CHUNK_SIZE = 512 * 1024;
+import {
+	ZipReader
+} from "./zip-reader.js";
+import {
+	ZipWriter
+} from "./zip-writer.js";
 
 class ZipEntry {
 
@@ -115,13 +120,13 @@ class ZipFileEntry extends ZipEntry {
 		if (!writer || (writer.constructor == zipEntry.Writer && zipEntry.data)) {
 			return zipEntry.data;
 		} else {
-			zipEntry.reader = new zipEntry.Reader(zipEntry.data, options);
-			await zipEntry.reader.init();
-			if (writer.init && !writer.initialized) {
-				await writer.init();
-			}
-			zipEntry.uncompressedSize = zipEntry.reader.size;
-			return pipe(zipEntry.reader, writer);
+			const reader = zipEntry.reader = new zipEntry.Reader(zipEntry.data, options);
+			await Promise.all([initStream(reader), initStream(writer)]);
+			zipEntry.uncompressedSize = reader.size;
+			const readable = reader.readable;
+			readable.size = () => reader.size;
+			await readable.pipeTo(writer.writable);
+			return writer.getData ? writer.getData() : writer.writable;
 		}
 	}
 
@@ -141,6 +146,10 @@ class ZipFileEntry extends ZipEntry {
 		return this.getData(new Uint8ArrayWriter(), options);
 	}
 
+	getWritable(writable = new WritableStream(), options) {
+		return this.getData({ writable }, options);
+	}
+
 	replaceBlob(blob) {
 		Object.assign(this, {
 			data: blob,
@@ -176,6 +185,15 @@ class ZipFileEntry extends ZipEntry {
 			reader: null
 		});
 	}
+
+	replaceReadable(readable) {
+		Object.assign(this, {
+			data: null,
+			Reader: function () { return { readable }; },
+			Writer: null,
+			reader: null
+		});
+	}
 }
 
 class ZipDirectoryEntry extends ZipEntry {
@@ -232,6 +250,12 @@ class ZipDirectoryEntry extends ZipEntry {
 		});
 	}
 
+	addReadable(name, readable) {
+		return addChild(this, name, {
+			Reader: function () { return { readable }; }
+		});
+	}
+
 	addFileSystemEntry(fileSystemEntry) {
 		return addFileSystemEntry(this, fileSystemEntry);
 	}
@@ -256,6 +280,10 @@ class ZipDirectoryEntry extends ZipEntry {
 		await this.importZip(new HttpReader(url, options), options);
 	}
 
+	async importReadable(readable, options = {}) {
+		await this.importZip({ readable }, options);
+	}
+
 	exportBlob(options = {}) {
 		return this.exportZip(new BlobWriter("application/zip"), options);
 	}
@@ -268,10 +296,13 @@ class ZipDirectoryEntry extends ZipEntry {
 		return this.exportZip(new Uint8ArrayWriter(), options);
 	}
 
+	async exportWritable(writable = new WritableStream(), options = {}) {
+		await this.exportZip({ writable }, options);
+		return writable;
+	}
+
 	async importZip(reader, options) {
-		if (!reader.initialized) {
-			await reader.init();
-		}
+		await initStream(reader);
 		const zipReader = new ZipReader(reader, options);
 		const entries = await zipReader.getEntries();
 		entries.forEach((entry) => {
@@ -290,12 +321,11 @@ class ZipDirectoryEntry extends ZipEntry {
 
 	async exportZip(writer, options) {
 		const zipEntry = this;
-		await initReaders(zipEntry);
-		await writer.init();
+		await Promise.all([initReaders(zipEntry), initStream(writer)]);
 		const zipWriter = new ZipWriter(writer, options);
 		await exportZip(zipWriter, zipEntry, getTotalSize([zipEntry], "uncompressedSize"), options);
 		await zipWriter.close();
-		return writer.getData();
+		return writer.getData ? writer.getData() : writer.writable;
 	}
 
 	getChildByName(name) {
@@ -385,6 +415,10 @@ class FS {
 		return this.root.addHttpContent(name, url, options);
 	}
 
+	addReadable(name, readable) {
+		return this.root.addReadable(name, readable);
+	}
+
 	addFileSystemEntry(fileSystemEntry) {
 		return this.root.addFileSystemEntry(fileSystemEntry);
 	}
@@ -408,6 +442,11 @@ class FS {
 		await this.root.importHttpContent(url, options);
 	}
 
+	async importReadable(readable, options) {
+		resetFS(this);
+		await this.root.importReadable(readable, options);
+	}
+
 	exportBlob(options) {
 		return this.root.exportBlob(options);
 	}
@@ -415,6 +454,14 @@ class FS {
 	exportData64URI(options) {
 		return this.root.exportData64URI(options);
 	}
+
+	exportUint8Array(options) {
+		return this.root.exportUint8Array(options);
+	}
+
+	exportWritable(writable, options) {
+		return this.root.exportWritable(writable, options);
+	}
 }
 
 const fs = { FS, ZipDirectoryEntry, ZipFileEntry };
@@ -443,6 +490,7 @@ function getZipBlobReader(options) {
 		}
 
 		async init() {
+			super.init();
 			const zipBlobReader = this;
 			zipBlobReader.size = zipBlobReader.entry.uncompressedSize;
 			const data = await zipBlobReader.entry.getData(new BlobWriter(), Object.assign({}, zipBlobReader.options, options));
@@ -462,9 +510,9 @@ async function initReaders(entry) {
 			if (child.directory) {
 				await initReaders(child);
 			} else {
-				child.reader = new child.Reader(child.data);
-				await child.reader.init();
-				child.uncompressedSize = child.reader.size;
+				const reader = child.reader = new child.Reader(child.data);
+				await initStream(reader);
+				child.uncompressedSize = reader.size;
 			}
 		}
 	}
@@ -573,21 +621,6 @@ function resetFS(fs) {
 	fs.root = new ZipDirectoryEntry(fs);
 }
 
-function pipe(reader, writer) {
-	return copyChunk();
-
-	async function copyChunk(chunkIndex = 0) {
-		const index = chunkIndex * CHUNK_SIZE;
-		if (index < reader.size) {
-			const array = await reader.readUint8Array(index, Math.min(CHUNK_SIZE, reader.size - index));
-			await writer.writeUint8Array(array);
-			return copyChunk(chunkIndex + 1);
-		} else {
-			return writer.getData();
-		}
-	}
-}
-
 function addChild(parent, name, params, directory) {
 	if (parent.directory) {
 		return directory ? new ZipDirectoryEntry(parent.fs, name, params, parent) : new ZipFileEntry(parent.fs, name, params, parent);

package/lib/core/zip-reader.js

@@ -66,7 +66,10 @@ import {
 	ERR_INVALID_SIGNATURE,
 	ERR_INVALID_PASSWORD
 } from "./codec-pool.js";
-import { BlobReader } from "./io.js";
+import {
+	initStream,
+	BlobReader
+} from "./io.js";
 import decodeText from "./util/decode-text.js";
 import Crc32 from "./streams/codecs/crc32.js";
 import Entry from "./zip-entry.js";
@@ -99,9 +102,7 @@ class ZipReader {
 		const zipReader = this;
 		let { reader } = zipReader;
 		const { config } = zipReader;
-		if (!reader.initialized && reader.init) {
-			await reader.init();
-		}
+		await initStream(reader);
 		if (reader.size === undefined || !reader.readUint8Array) {
 			const blob = await new Response(reader.readable).blob();
 			reader = new BlobReader(blob);
@@ -167,7 +168,7 @@ class ZipReader {
 			throw new Error(ERR_BAD_FORMAT);
 		}
 		const filenameEncoding = getOptionValue(zipReader, options, "filenameEncoding");
-		const commentEncoding = getOptionValue(zipReader, options, "commentEncoding");	
+		const commentEncoding = getOptionValue(zipReader, options, "commentEncoding");
 		for (let indexFile = 0; indexFile < filesLength; indexFile++) {
 			const fileEntry = new ZipEntry(reader, config, zipReader.options);
 			if (getUint32(directoryView, offset) != CENTRAL_FILE_HEADER_SIGNATURE) {
@@ -188,7 +189,7 @@ class ZipReader {
 				commentLength: getUint16(directoryView, offset + 32),
 				directory: msDosCompatible && ((getUint8(directoryView, offset + 38) & FILE_ATTR_MSDOS_DIR_MASK) == FILE_ATTR_MSDOS_DIR_MASK),
 				offset: getUint32(directoryView, offset + 42) + prependedDataLength,
-				internalFileAttribute: getUint32(directoryView, offset + 34),
+				internalFileAttribute: getUint16(directoryView, offset + 36),
 				externalFileAttribute: getUint32(directoryView, offset + 38),
 				rawFilename: directoryArray.subarray(filenameOffset, extraFieldOffset),
 				filenameUTF8: languageEncodingFlag,
@@ -321,9 +322,7 @@ class ZipEntry {
 		readable.size = size;
 		const { writable } = writer;
 		const signal = getOptionValue(zipEntry, options, "signal");
-		if (writer.init && !writer.initialized) {
-			await writer.init();
-		}
+		await initStream(writer);
 		const { onstart, onprogress, onend } = options;
 		const workerOptions = {
 			options: {

package/lib/core/zip-writer.js

@@ -69,6 +69,7 @@ import {
 } from "./codec-pool.js";
 import encodeText from "./util/encode-text.js";
 import {
+	initStream,
 	BlobWriter
 } from "./io.js";
 import Entry from "./zip-entry.js";
@@ -232,9 +233,7 @@ async function addFile(zipWriter, name, reader, options) {
 	const internalFileAttribute = getOptionValue(zipWriter, options, "internalFileAttribute") || 0;
 	const externalFileAttribute = getOptionValue(zipWriter, options, "externalFileAttribute") || 0;
 	if (reader) {
-		if (reader.init && !reader.initialized) {
-			await reader.init();
-		}
+		await initStream(reader);
 		if (reader.size === undefined) {
 			options.dataDescriptor = true;
 		} else {
@@ -331,9 +330,7 @@ async function getFileEntry(zipWriter, name, reader, options) {
 			bufferedWrite = true;
 		} else {
 			zipWriter.lockWriter = Promise.resolve();
-			if (writer.init && !writer.initialized) {
-				await writer.init();
-			}
+			await initStream(writer);
 			fileWriter = writer;
 		}
 		fileEntry = await createFileEntry(reader, fileEntry, fileWriter.writable, zipWriter.config, options);
@@ -359,7 +356,7 @@ async function getFileEntry(zipWriter, name, reader, options) {
 					setUint32(arrayBufferView, 18, fileEntry.compressedSize);
 					setUint32(arrayBufferView, 22, fileEntry.uncompressedSize);
 				}
-				await writeUint8Array(writable, new Uint8Array(arrayBuffer));
+				await writeData(writable, new Uint8Array(arrayBuffer));
 				blob = blob.slice(headerLength);
 			}
 			await blob.stream().pipeTo(writable, { preventClose: true, signal });
@@ -479,6 +476,7 @@ async function createFileEntry(reader, pendingFileEntry, writable, config, optio
 		rawExtraFieldNTFS = rawExtraFieldExtendedTimestamp = new Uint8Array();
 	}
 	const fileEntry = {
+		lock: pendingFileEntry.lock,
 		version: version || VERSION_DEFLATE,
 		versionMadeBy,
 		zip64,
@@ -555,7 +553,7 @@ async function createFileEntry(reader, pendingFileEntry, writable, config, optio
 	let compressedSize = 0;
 	if (reader) {
 		reader.chunkSize = getChunkSize(config);
-		await writeUint8Array(writable, localHeaderArray);
+		await writeData(writable, localHeaderArray);
 		fileEntry.dataWritten = pendingFileEntry.dataWritten = true;
 		const size = () => reader.size;
 		const readable = reader.readable;
@@ -582,7 +580,7 @@ async function createFileEntry(reader, pendingFileEntry, writable, config, optio
 		uncompressedSize = fileEntry.uncompressedSize = reader.size = readable.size();
 		compressedSize = result.size;
 	} else {
-		await writeUint8Array(writable, localHeaderArray);
+		await writeData(writable, localHeaderArray);
 		fileEntry.dataWritten = pendingFileEntry.dataWritten = true;
 	}
 	let dataDescriptorArray = new Uint8Array();
@@ -626,7 +624,7 @@ async function createFileEntry(reader, pendingFileEntry, writable, config, optio
 		}
 	}
 	if (dataDescriptor) {
-		await writeUint8Array(writable, dataDescriptorArray);
+		await writeData(writable, dataDescriptorArray);
 	}
 	const length = localHeaderArray.length + compressedSize + dataDescriptorArray.length;
 	Object.assign(fileEntry, {
@@ -701,7 +699,7 @@ async function closeFile(zipWriter, comment, options) {
 		arraySet(directoryArray, headerArray, offset + 6);
 		setUint16(directoryView, offset + 30, extraFieldLength);
 		setUint16(directoryView, offset + 32, rawComment.length);
-		setUint32(directoryView, offset + 34, internalFileAttribute);
+		setUint16(directoryView, offset + 36, internalFileAttribute);
 		if (externalFileAttribute) {
 			setUint32(directoryView, offset + 38, externalFileAttribute);
 		} else if (directory && msDosCompatible) {
@@ -758,9 +756,9 @@ async function closeFile(zipWriter, comment, options) {
 		}
 	}
 	const { writable } = zipWriter.writer;
-	await writeUint8Array(writable, directoryArray);
+	await writeData(writable, directoryArray);
 	if (comment && comment.length) {
-		await writeUint8Array(writable, comment);
+		await writeData(writable, comment);
 	}
 }
 
@@ -772,7 +770,7 @@ function sliceAsArrayBuffer(blob, start, end) {
 	}
 }
 
-async function writeUint8Array(writable, array) {
+async function writeData(writable, array) {
 	const streamWriter = writable.getWriter();
 	await streamWriter.ready;
 	await streamWriter.write(array);

package/package.json

@@ -3,7 +3,7 @@
     "description": "A JavaScript library to zip and unzip files in the browser and Deno",
     "author": "Gildas Lormeau",
     "license": "BSD-3-Clause",
-    "version": "2.6.5",
+    "version": "2.6.8",
     "type": "module",
     "keywords": [
         "zip",
@@ -17,12 +17,14 @@
         "encryption",
         "zip64",
         "web-streams",
+        "compression-streams",
         "web-crypto",
         "web-workers",
         "deno"
     ],
     "scripts": {
         "build": "./build.sh",
+        "dev": "npx rollup -c rollup.config.dev.js",
         "test": "cd ./tests && \"./run-tests.sh\""
     },
     "main": "index.js",
@@ -38,7 +40,8 @@
     "devDependencies": {
         "@rollup/plugin-node-resolve": "^13.3.0",
         "@rollup/plugin-replace": "^4.0.0",
-        "rollup": "^2.77.0",
-        "rollup-plugin-terser": "^7.0.2"
+        "rollup": "^2.77.2",
+        "rollup-plugin-terser": "^7.0.2",
+        "typedoc": "^0.23.10"
     }
 }

package/tests/all/test-fs-streams.js

@@ -0,0 +1,22 @@
+/* global Blob, TransformStream, Response */
+
+import * as zip from "../../index.js";
+
+const TEXT_CONTENT = "Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat. Ut wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis nisl ut aliquip ex ea commodo consequat. Duis autem vel eum iriure dolor in hendrerit in vulputate velit esse molestie consequat, vel illum dolore eu feugiat nulla facilisis at vero eros et accumsan et iusto odio dignissim qui blandit praesent luptatum zzril delenit augue duis dolore te feugait nulla facilisi. Nam liber tempor cum soluta nobis eleifend option congue nihil imperdiet doming id quod mazim placerat facer possim assum. Typi non habent claritatem insitam; est usus legentis in iis qui facit eorum claritatem. Investigationes demonstraverunt lectores legere me lius quod ii legunt saepius. Claritas est etiam processus dynamicus, qui sequitur mutationem consuetudium lectorum. Mirum est notare quam littera gothica, quam nunc putamus parum claram, anteposuerit litterarum formas humanitatis per seacula quarta decima et quinta decima. Eodem modo typi, qui nunc nobis videntur parum clari, fiant sollemnes in futurum.";
+const FILENAME = "lorem.txt";
+
+export { test };
+
+async function test() {
+	zip.configure({ chunkSize: 128, useWebWorkers: true });
+	const sourceFS = new zip.fs.FS();
+	sourceFS.addReadable(FILENAME, new Blob([TEXT_CONTENT]).stream());
+	let transformStream = new TransformStream();
+	const destinationFS = new zip.fs.FS();
+	await Promise.all([sourceFS.exportWritable(transformStream.writable), destinationFS.importReadable(transformStream.readable)]);
+	const firstEntry = destinationFS.children[0];
+	transformStream = new TransformStream();
+	const [text] = await Promise.all([new Response(transformStream.readable).text(), firstEntry.getWritable(transformStream.writable)]);
+	zip.terminateWorkers();
+	return text == TEXT_CONTENT && firstEntry.name == FILENAME && firstEntry.uncompressedSize == TEXT_CONTENT.length;
+}

package/tests/all/test-parallel-writes-ordered.js

@@ -4,14 +4,14 @@ import * as zip from "../../index.js";
 
 const KB = 1024;
 const ENTRIES_DATA = [
-	{ name: "entry #1", blob: getBlob(8.5 * KB) }, { name: "entry #2", blob: getBlob(10.2 * KB) }, { name: "entry #3", blob: getBlob(64.7 * KB) },
-	{ name: "entry #4", blob: getBlob(2.8 * KB) }, { name: "entry #5", blob: getBlob(30.9 * KB) }, { name: "entry #6", blob: getBlob(76.2 * KB) },
-	{ name: "entry #7", blob: getBlob(5.1 * KB) }, { name: "entry #8", blob: getBlob(42.6 * KB) }, { name: "entry #9", blob: getBlob(3.1 * KB) }];
+	{ name: "entry #1", blob: getBlob(8.5 * KB) }, { name: "entry #2", blob: getBlob(100.2 * KB) }, { name: "entry #3", blob: getBlob(640.7 * KB) },
+	{ name: "entry #4", blob: getBlob(200.8 * KB) }, { name: "entry #5", blob: getBlob(3.9 * KB) }, { name: "entry #6", blob: getBlob(7.2 * KB) },
+	{ name: "entry #7", blob: getBlob(5.1 * KB) }, { name: "entry #8", blob: getBlob(4.6 * KB) }, { name: "entry #9", blob: getBlob(3.1 * KB) }];
 
 export { test };
 
 async function test() {
-	zip.configure({ chunkSize: 512, useWebWorkers: true });
+	zip.configure({ chunkSize: 512, useWebWorkers: true, maxWorkers: 4 });
 	const blobWriter = new zip.BlobWriter("application/zip");
 	const zipWriter = new zip.ZipWriter(blobWriter, { keepOrder: true });
 	await Promise.all(ENTRIES_DATA.map(entryData => zipWriter.add(entryData.name, new zip.BlobReader(entryData.blob))));

package/tests/tests-data.js

@@ -19,6 +19,7 @@ export default ([
 	{ title: "Filesystem HTTP import", script: "./test-fs-http-import.js" },
 	{ title: "Filesystem HTTP reader", script: "./test-fs-http-reader.js" },
 	{ title: "Filesystem replace entry", script: "./test-fs-replace.js" },
+	{ title: "Filesystem streams", script: "./test-fs-streams.js" },
 	{ title: "Filesystem text", script: "./test-fs-text.js" },
 	{ title: "Filesystem unzip uncompressed file", script: "./test-fs-unzip-store.js" },
 	{ title: "Filesystem test", script: "./test-fs.js" },

package/tests/web-runner.js

@@ -17,8 +17,8 @@ if (!location.search.startsWith("?keepTests")) {
 		if (!result.error) {
 			Array.from(document.querySelectorAll("tr")).find(row => row.dataset.script == result.script).remove();
 		}
-		indexTest++;
 		const test = tests[indexTest];
+		indexTest++;
 		if (test) {
 			addTest(test);
 		} else if (!document.querySelectorAll("tr").length) {

package/tsconfig.json

@@ -0,0 +1,6 @@
+{
+    "typedocOptions": {
+        "entryPoints": ["index.d.ts"],
+        "out": "../doc/api"
+    }
+}