@zip.js/zip.js 2.7.7 → 2.7.9

package/index.cjs

@@ -8745,10 +8745,13 @@ class ZipEntry$1 {
 			}
 		}
 		const dataOffset = offset + 30 + localDirectory.filenameLength + localDirectory.extraFieldLength;
+		const size = compressedSize;
 		const readable = reader.readable;
-		readable.diskNumberStart = diskNumberStart;
-		readable.offset = dataOffset;
-		let size = readable.size = compressedSize;
+		Object.assign(readable, {
+			diskNumberStart,
+			offset: dataOffset,
+			size
+		});
 		const signal = getOptionValue$1(zipEntry, options, "signal");
 		const checkPasswordOnly = getOptionValue$1(zipEntry, options, "checkPasswordOnly");
 		if (checkPasswordOnly) {
@@ -10369,7 +10372,26 @@ class ZipDirectoryEntry extends ZipEntry {
 	}
 
 	addFileSystemEntry(fileSystemEntry, options = {}) {
-		return addFileSystemEntry(this, fileSystemEntry, options);
+		return addFileSystemHandle(this, fileSystemEntry, options);
+	}
+
+	addFileSystemHandle(handle, options = {}) {
+		return addFileSystemHandle(this, handle, options);
+	}
+
+	addFile(file, options = {}) {
+		if (!options.lastModDate) {
+			options.lastModDate = new Date(file.lastModified);
+		}
+		return addChild(this, file.name, {
+			data: file,
+			Reader: function () {
+				const readable = file.stream();
+				const size = file.size;
+				return { readable, size };
+			},
+			options
+		});
 	}
 
 	addData(name, params) {
@@ -10572,6 +10594,14 @@ class FS {
 		return this.root.addFileSystemEntry(fileSystemEntry, options);
 	}
 
+	addFileSystemHandle(handle, options) {
+		return this.root.addFileSystemHandle(handle, options);
+	}
+
+	addFile(file, options) {
+		return this.root.addFile(file, options);
+	}
+
 	addData(name, params) {
 		return this.root.addData(name, params);
 	}
@@ -10762,54 +10792,92 @@ async function exportZip(zipWriter, entry, totalSize, options) {
 	}
 }
 
-async function addFileSystemEntry(zipEntry, fileSystemEntry, options) {
-	if (fileSystemEntry.isDirectory) {
-		const entry = zipEntry.addDirectory(fileSystemEntry.name, options);
-		await addDirectory(entry, fileSystemEntry);
-		return entry;
-	} else {
-		return new Promise((resolve, reject) => fileSystemEntry.file(file => resolve(zipEntry.addBlob(fileSystemEntry.name, file, options)), reject));
-	}
+async function addFileSystemHandle(zipEntry, handle, options) {
+	await addFile(zipEntry, handle, []);
 
-	async function addDirectory(zipEntry, fileEntry) {
-		const children = await getChildren(fileEntry);
-		for (const child of children) {
-			if (child.isDirectory) {
-				await addDirectory(zipEntry.addDirectory(child.name, options), child);
-			} else {
-				await new Promise((resolve, reject) => {
-					child.file(file => {
-						const childZipEntry = zipEntry.addBlob(child.name, file, options);
-						childZipEntry.uncompressedSize = file.size;
-						resolve(childZipEntry);
-					}, reject);
-				});
+	async function addFile(parentEntry, handle, addedEntries) {
+		try {
+			if (handle.isFile || handle.isDirectory) {
+				handle = await transformToFileSystemhandle(handle);
+			}
+			if (handle.kind == "file") {
+				const file = await handle.getFile();
+				addedEntries.push(
+					parentEntry.addData(file.name, {
+						Reader: function () {
+							const readable = file.stream();
+							const size = file.size;
+							return { readable, size };
+						},
+						options: {
+							lastModDate: new Date(file.lastModified)
+						}
+					}, options)
+				);
+			} else if (handle.kind == "directory") {
+				const directoryEntry = parentEntry.addDirectory(handle.name);
+				addedEntries.push(directoryEntry);
+				for await (const childHandle of handle.values()) {
+					await addFile(directoryEntry, childHandle, addedEntries);
+				}
 			}
+		} catch (error) {
+			const message = error.message + (handle ? " (" + handle.name + ")" : "");
+			throw new Error(message);
 		}
+		return addedEntries;
 	}
+}
 
-	function getChildren(fileEntry) {
-		return new Promise((resolve, reject) => {
-			let entries = [];
-			if (fileEntry.isDirectory) {
-				readEntries(fileEntry.createReader());
-			}
-			if (fileEntry.isFile) {
-				resolve(entries);
-			}
+async function transformToFileSystemhandle(entry) {
+	const handle = {
+		name: entry.name
+	};
+	if (entry.isFile) {
+		handle.kind = "file";
+		handle.getFile = () =>
+			new Promise((resolve, reject) => entry.file(resolve, reject));
+	}
+	if (entry.isDirectory) {
+		handle.kind = "directory";
+		const handles = await transformToFileSystemhandles(entry);
+		handle.values = () => handles;
+	}
+	return handle;
+}
 
-			function readEntries(directoryReader) {
-				directoryReader.readEntries(temporaryEntries => {
-					if (!temporaryEntries.length) {
-						resolve(entries);
-					} else {
-						entries = entries.concat(temporaryEntries);
-						readEntries(directoryReader);
-					}
-				}, reject);
+async function transformToFileSystemhandles(entry) {
+	const entries = [];
+	function readEntries(directoryReader, resolve, reject) {
+		directoryReader.readEntries(async (entriesPart) => {
+			if (!entriesPart.length) {
+				resolve(entries);
+			} else {
+				for (const entry of entriesPart) {
+					entries.push(await transformToFileSystemhandle(entry));
+				}
+				readEntries(directoryReader, resolve, reject);
 			}
-		});
+		}, reject);
 	}
+	await new Promise((resolve, reject) =>
+		readEntries(entry.createReader(), resolve, reject)
+	);
+	return {
+		[Symbol.iterator]() {
+			let entryIndex = 0;
+			return {
+				next() {
+					const result = {
+						value: entries[entryIndex],
+						done: entryIndex === entries.length
+					};
+					entryIndex++;
+					return result;
+				}
+			};
+		}
+	};
 }
 
 function resetFS(fs) {

package/index.d.ts

@@ -9,6 +9,13 @@ declare global {
    */
   // deno-lint-ignore no-empty-interface
   interface FileSystemEntry {}
+  /**
+   * Represents the `FileSystemHandle` class.
+   *
+   * @see {@link https://fs.spec.whatwg.org/#api-filesystemhandle}
+   */
+  // deno-lint-ignore no-empty-interface
+  interface FileSystemHandle {}
 }
 
 /**
@@ -1530,6 +1537,17 @@ export class ZipDirectoryEntry extends ZipEntry {
     readable: ReadableStream,
     options?: ZipWriterAddDataOptions,
   ): ZipFileEntry<ReadableStream, void>;
+  /**
+   * Adds an entry with content provided via a `File` instance
+   *
+   * @param file The `File` instance.
+   * @param options The options.
+   * @returns A promise resolving to a {@link ZipFileEntry} or a {@link ZipDirectoryEntry} instance.
+   */
+  addFile(
+    file: File, 
+    options?: ZipWriterAddDataOptions,
+  ): Promise<ZipEntry>;
   /**
    * Adds an entry with content provided via a `FileSystemEntry` instance
    *
@@ -1541,6 +1559,17 @@ export class ZipDirectoryEntry extends ZipEntry {
     fileSystemEntry: FileSystemEntry,
     options?: ZipWriterAddDataOptions,
   ): Promise<ZipEntry>;
+  /**
+   * Adds an entry with content provided via a `FileSystemHandle` instance
+   *
+   * @param fileSystemHandle The `fileSystemHandle` instance.
+   * @param options The options.
+   * @returns A promise resolving to a {@link ZipFileEntry} or a {@link ZipDirectoryEntry} instance.
+   */
+  addFileSystemHandle(
+    fileSystemEntry: FileSystemHandle,
+    options?: ZipWriterAddDataOptions,
+  ): Promise<ZipEntry>;
   /**
    * Extracts a zip file provided as a `Blob` instance into the entry
    *

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

@@ -318,7 +318,26 @@ class ZipDirectoryEntry extends ZipEntry {
 	}
 
 	addFileSystemEntry(fileSystemEntry, options = {}) {
-		return addFileSystemEntry(this, fileSystemEntry, options);
+		return addFileSystemHandle(this, fileSystemEntry, options);
+	}
+
+	addFileSystemHandle(handle, options = {}) {
+		return addFileSystemHandle(this, handle, options);
+	}
+
+	addFile(file, options = {}) {
+		if (!options.lastModDate) {
+			options.lastModDate = new Date(file.lastModified);
+		}
+		return addChild(this, file.name, {
+			data: file,
+			Reader: function () {
+				const readable = file.stream();
+				const size = file.size;
+				return { readable, size };
+			},
+			options
+		});
 	}
 
 	addData(name, params) {
@@ -521,6 +540,14 @@ class FS {
 		return this.root.addFileSystemEntry(fileSystemEntry, options);
 	}
 
+	addFileSystemHandle(handle, options) {
+		return this.root.addFileSystemHandle(handle, options);
+	}
+
+	addFile(file, options) {
+		return this.root.addFile(file, options);
+	}
+
 	addData(name, params) {
 		return this.root.addData(name, params);
 	}
@@ -712,54 +739,92 @@ async function exportZip(zipWriter, entry, totalSize, options) {
 	}
 }
 
-async function addFileSystemEntry(zipEntry, fileSystemEntry, options) {
-	if (fileSystemEntry.isDirectory) {
-		const entry = zipEntry.addDirectory(fileSystemEntry.name, options);
-		await addDirectory(entry, fileSystemEntry);
-		return entry;
-	} else {
-		return new Promise((resolve, reject) => fileSystemEntry.file(file => resolve(zipEntry.addBlob(fileSystemEntry.name, file, options)), reject));
-	}
+async function addFileSystemHandle(zipEntry, handle, options) {
+	await addFile(zipEntry, handle, []);
 
-	async function addDirectory(zipEntry, fileEntry) {
-		const children = await getChildren(fileEntry);
-		for (const child of children) {
-			if (child.isDirectory) {
-				await addDirectory(zipEntry.addDirectory(child.name, options), child);
-			} else {
-				await new Promise((resolve, reject) => {
-					child.file(file => {
-						const childZipEntry = zipEntry.addBlob(child.name, file, options);
-						childZipEntry.uncompressedSize = file.size;
-						resolve(childZipEntry);
-					}, reject);
-				});
+	async function addFile(parentEntry, handle, addedEntries) {
+		try {
+			if (handle.isFile || handle.isDirectory) {
+				handle = await transformToFileSystemhandle(handle);
+			}
+			if (handle.kind == "file") {
+				const file = await handle.getFile();
+				addedEntries.push(
+					parentEntry.addData(file.name, {
+						Reader: function () {
+							const readable = file.stream();
+							const size = file.size;
+							return { readable, size };
+						},
+						options: {
+							lastModDate: new Date(file.lastModified)
+						}
+					}, options)
+				);
+			} else if (handle.kind == "directory") {
+				const directoryEntry = parentEntry.addDirectory(handle.name);
+				addedEntries.push(directoryEntry);
+				for await (const childHandle of handle.values()) {
+					await addFile(directoryEntry, childHandle, addedEntries);
+				}
 			}
+		} catch (error) {
+			const message = error.message + (handle ? " (" + handle.name + ")" : "");
+			throw new Error(message);
 		}
+		return addedEntries;
 	}
+}
 
-	function getChildren(fileEntry) {
-		return new Promise((resolve, reject) => {
-			let entries = [];
-			if (fileEntry.isDirectory) {
-				readEntries(fileEntry.createReader());
-			}
-			if (fileEntry.isFile) {
-				resolve(entries);
-			}
+async function transformToFileSystemhandle(entry) {
+	const handle = {
+		name: entry.name
+	};
+	if (entry.isFile) {
+		handle.kind = "file";
+		handle.getFile = () =>
+			new Promise((resolve, reject) => entry.file(resolve, reject));
+	}
+	if (entry.isDirectory) {
+		handle.kind = "directory";
+		const handles = await transformToFileSystemhandles(entry);
+		handle.values = () => handles;
+	}
+	return handle;
+}
 
-			function readEntries(directoryReader) {
-				directoryReader.readEntries(temporaryEntries => {
-					if (!temporaryEntries.length) {
-						resolve(entries);
-					} else {
-						entries = entries.concat(temporaryEntries);
-						readEntries(directoryReader);
-					}
-				}, reject);
+async function transformToFileSystemhandles(entry) {
+	const entries = [];
+	function readEntries(directoryReader, resolve, reject) {
+		directoryReader.readEntries(async (entriesPart) => {
+			if (!entriesPart.length) {
+				resolve(entries);
+			} else {
+				for (const entry of entriesPart) {
+					entries.push(await transformToFileSystemhandle(entry));
+				}
+				readEntries(directoryReader, resolve, reject);
 			}
-		});
-	}
+		}, reject);
+	}
+	await new Promise((resolve, reject) =>
+		readEntries(entry.createReader(), resolve, reject)
+	);
+	return {
+		[Symbol.iterator]() {
+			let entryIndex = 0;
+			return {
+				next() {
+					const result = {
+						value: entries[entryIndex],
+						done: entryIndex === entries.length
+					};
+					entryIndex++;
+					return result;
+				}
+			};
+		}
+	};
 }
 
 function resetFS(fs) {

package/lib/core/zip-reader.js

@@ -392,10 +392,13 @@ class ZipEntry {
 			}
 		}
 		const dataOffset = offset + 30 + localDirectory.filenameLength + localDirectory.extraFieldLength;
+		const size = compressedSize;
 		const readable = reader.readable;
-		readable.diskNumberStart = diskNumberStart;
-		readable.offset = dataOffset;
-		let size = readable.size = compressedSize;
+		Object.assign(readable, {
+			diskNumberStart,
+			offset: dataOffset,
+			size
+		});
 		const signal = getOptionValue(zipEntry, options, "signal");
 		const checkPasswordOnly = getOptionValue(zipEntry, options, "checkPasswordOnly");
 		if (checkPasswordOnly) {

package/package.json

@@ -3,7 +3,7 @@
     "description": "A JavaScript library to zip and unzip files in the browser, Deno and Node.js",
     "author": "Gildas Lormeau",
     "license": "BSD-3-Clause",
-    "version": "2.7.7",
+    "version": "2.7.9",
     "type": "module",
     "keywords": [
         "zip",