@zip.js/zip.js 2.21.0 → 2.22.0

package/index.cjs

@@ -219,6 +219,7 @@ const ERR_INVALID_FUNCTION_OPTION = "Invalid option (must be a function)";
 const ERR_INVALID_SIGNAL = "Invalid signal (must be an AbortSignal instance)";
 const ERR_INVALID_PASSWORD_TYPE = "Invalid password (password must be a string, rawPassword must be a Uint8Array)";
 const ERR_INVALID_PASS_THROUGH_VALUE = "Invalid passThrough option (must be a boolean or 'compressed')";
+const ERR_INVALID_READER_OPTIONS = "Invalid readerOptions (must be an object)";
 const ERR_ABORTED = "The operation was aborted";
 const ABORT_ERROR_NAME$1 = "AbortError";
 
@@ -229,6 +230,13 @@ function checkFunctionOption(value) {
 	return value;
 }
 
+function checkReaderOptionsObject(readerOptions) {
+	if (readerOptions && (typeof readerOptions != OBJECT_TYPE || Array.isArray(readerOptions))) {
+		throw new Error(ERR_INVALID_READER_OPTIONS);
+	}
+	return readerOptions;
+}
+
 function checkSignalOption(signal) {
 	if (signal && (typeof signal.addEventListener != FUNCTION_TYPE || typeof signal.aborted != BOOLEAN_TYPE)) {
 		throw new Error(ERR_INVALID_SIGNAL);
@@ -324,7 +332,6 @@ const DEFAULT_CONFIGURATION = {
 	workerStartupTimeout: 5000,
 	useWebWorkers: true,
 	useCompressionStream: true,
-	transferStreams: true,
 	CompressionStream: typeof CompressionStream != UNDEFINED_TYPE && CompressionStream,
 	DecompressionStream: typeof DecompressionStream != UNDEFINED_TYPE && DecompressionStream
 };
@@ -338,8 +345,7 @@ const URI_PROPERTY_NAMES = [
 ];
 const BOOLEAN_PROPERTY_NAMES = [
 	"useCompressionStream",
-	"useWebWorkers",
-	"transferStreams"
+	"useWebWorkers"
 ];
 const NUMBER_PROPERTY_NAMES = [
 	"chunkSize",
@@ -4849,7 +4855,7 @@ class ZipReader {
 	constructor(reader, options = {}) {
 		Object.assign(this, {
 			reader: new GenericReader(reader),
-			options,
+			options: options || {},
 			readRanges: { indexes: new Set(), sortedRanges: [], pendingRanges: [] },
 			entriesMissingZip64ExtraField: new WeakSet()
 		});
@@ -6869,6 +6875,7 @@ function watchPromiseError(zipWriter, promise) {
 async function appendZipEntries(zipWriter, reader, options = {}) {
 	const { pendingAddFileCalls, filenames, fileEntries } = zipWriter;
 	const filter = checkFunctionOption(options.filter);
+	const readerOptions = checkReaderOptionsObject(options.readerOptions);
 	while (pendingAddFileCalls.size) {
 		await Promise.allSettled(Array.from(pendingAddFileCalls));
 	}
@@ -6885,15 +6892,19 @@ async function appendZipEntries(zipWriter, reader, options = {}) {
 			await initStream(reader);
 		}
 		const { ZipReader, getEntryDataDescriptorLength } = await Promise.resolve().then(function () { return zipReader; });
-		const zipReader$1 = new ZipReader(reader);
-		const entries = await zipReader$1.getEntries();
+		const zipReader$1 = new ZipReader(reader, readerOptions);
 		const keptEntries = [];
-		for (const entry of entries) {
-			if (!filter || await filter(entry)) {
-				keptEntries.push(entry);
+		let entries;
+		try {
+			entries = await zipReader$1.getEntries();
+			for (const entry of entries) {
+				if (!filter || await filter(entry, getExistingEntry(fileEntries, entry.filename))) {
+					keptEntries.push(entry);
+				}
 			}
+		} finally {
+			await zipReader$1.close();
 		}
-		await zipReader$1.close();
 		await initStream(zipWriter.writer);
 		const { directoryOffset, entriesMissingZip64ExtraField } = zipReader$1;
 		keptEntries.forEach(entry => {
@@ -6963,7 +6974,7 @@ async function appendZipEntries(zipWriter, reader, options = {}) {
 				setUint32(headerView, HEADER_OFFSET_SIGNATURE, crc32);
 			}
 			const { offset, diskNumberStart } = entryPositions.get(entry);
-			Object.assign(entry, {
+			fileEntries.set(entry.filename, Object.assign({}, entry, {
 				zip64Enabled: true,
 				zip64UncompressedSize,
 				zip64CompressedSize,
@@ -6980,8 +6991,7 @@ async function appendZipEntries(zipWriter, reader, options = {}) {
 				rawCentralExtraField: EMPTY_UINT8_ARRAY,
 				headerArray,
 				headerView
-			});
-			fileEntries.set(entry.filename, entry);
+			}));
 		});
 	} catch (error) {
 		appendedFilenames.forEach(filename => filenames.delete(filename));
@@ -6995,6 +7005,11 @@ async function appendZipEntries(zipWriter, reader, options = {}) {
 	}
 }
 
+function getExistingEntry(fileEntries, filename) {
+	const fileEntry = fileEntries.get(filename);
+	return fileEntry ? new Entry(fileEntry) : UNDEFINED_VALUE;
+}
+
 async function prependZipEntries(zipWriter, reader) {
 	if (zipWriter.filenames.size) {
 		throw new Error(ERR_ZIP_NOT_EMPTY);
@@ -9237,7 +9252,7 @@ function formatSupported(StreamClass, format) {
  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-const VERSION = "2.21.0";
+const VERSION = "2.22.0";
 
 /*
  Copyright (c) 2025 Gildas Lormeau. All rights reserved.
@@ -10312,7 +10327,6 @@ const DUPLICATES_KEEP_FIRST = "keep-first";
 const DUPLICATES_KEEP_LAST = "keep-last";
 const DUPLICATES_VALUES = new Set([DUPLICATES_THROW, DUPLICATES_KEEP_FIRST, DUPLICATES_KEEP_LAST]);
 const ERR_INVALID_PASS_THROUGH = "Invalid passThrough option (use readerOptions.passThrough or set uncompressedSize for each entry)";
-const ERR_INVALID_READER_OPTIONS = "Invalid readerOptions (must be an object)";
 const ERR_UNSUPPORTED_PASS_THROUGH_VALUE = "The 'compressed' passThrough option is only supported by Entry#getData() and ZipWriter#add()";
 const ERR_INVALID_PASSWORDS = "Invalid passwords option (must be an array of strings)";
 const ERR_INVALID_REQUEST_PASSWORD = "Invalid requestPassword option (must be a function returning a string or undefined)";
@@ -11238,9 +11252,7 @@ function getDeterminedSize(child, passThrough) {
 }
 
 function checkReaderOptions(readerOptions) {
-	if (readerOptions && (typeof readerOptions != OBJECT_TYPE || Array.isArray(readerOptions))) {
-		throw new Error(ERR_INVALID_READER_OPTIONS);
-	}
+	checkReaderOptionsObject(readerOptions);
 	if (readerOptions) {
 		checkPassThroughValue(readerOptions.passThrough);
 		checkPasswordCandidatesOptions(readerOptions);

package/index.d.cts

@@ -635,13 +635,6 @@ export interface WorkerConfiguration {
    * @defaultValue true
    */
   useCompressionStream?: boolean;
-  /**
-   * `true` to transfer stream ownership to web workers.
-   *
-   * @deprecated The option is ignored whatever its value: the data always crosses the worker boundary chunk by
-   * chunk, transferring the streams instead was slower on every engine measured.
-   */
-  transferStreams?: boolean;
 }
 
 /**
@@ -3086,11 +3079,15 @@ export class ZipWriter<Type> {
    * are not applied to the copied entries. The comment and the digital signature of the zip file are not copied,
    * since its central directory is rebuilt: pass them to {@link ZipWriter#close}.
    *
-   * Pending {@link ZipWriter#add} calls are completed before the data is copied, and add() calls made
-   * while the copy is in progress are written after it. If an entry of the zip file has the same
+   * Pending {@link ZipWriter#add} calls are completed before the data is copied. add() calls made while the
+   * `filter` option runs are written before the copied entries, and add() calls made once the copy has started
+   * are written after it. If an entry of the zip file has the same
    * filename as an entry of the current zip, the method throws with the `ERR_DUPLICATED_NAME` error
    * message and leaves the current zip unchanged; call {@link ZipWriter#remove} beforehand to resolve
-   * the conflicts. An entry whose sizes or offset are unusable because its Zip64 extra field is missing (see
+   * the conflicts. The same error is thrown when two entries of the zip file share a filename, since a
+   * `ZipWriter` holds one entry per filename: use the {@link ZipWriterAppendZipOptions#filter} option to
+   * keep one of them. The entries passed to `filter` are not modified by the copy. An entry whose sizes or
+   * offset are unusable because its Zip64 extra field is missing (see
    * {@link WARNING_MISSING_ZIP64_EXTRA_FIELD}) cannot be copied: the method throws
    * {@link ERR_EXTRAFIELD_ZIP64_NOT_FOUND} and leaves the current zip unchanged, unless the
    * {@link ZipWriterAppendZipOptions#filter} option leaves the entry out.
@@ -3174,10 +3171,11 @@ export class ZipWriter<Type> {
    * Removes an entry from the central directory that will be written for the zip file. The entry
    * data itself cannot be removed because it has already been streamed to the output.
    *
-   * @param entry The entry to remove. This can be an {@link Entry} instance or the filename of the entry.
+   * @param entry The entry to remove. This can be an {@link Entry} instance, the {@link EntryMetaData} returned by
+   * {@link ZipWriter#add} or passed to the `filter` option of {@link ZipWriter#appendZip}, or the filename of the entry.
    * @returns `true` if the entry has been removed, `false` otherwise.
    */
-  remove(entry: Entry | string): boolean;
+  remove(entry: EntryMetaData | string): boolean;
 
   /**
    * Writes the entries directory, writes the global comment, and returns the content of the zip file
@@ -3342,6 +3340,13 @@ export interface ZipWriterAppendZipOptions {
    * central directory, and the entry is copied when it returns (or resolves to) `true`. The function can read
    * the data of the entry with {@link Entry#getData} to decide: every call completes before any data is copied.
    *
+   * The second argument is the entry of the current zip which has the same filename, as {@link ZipWriter#add}
+   * or a previous call to {@link ZipWriter#appendZip} left it, or `undefined` when there is none. It is the way to
+   * apply a duplicate filename policy, since keeping both entries throws `ERR_DUPLICATED_NAME`: return
+   * `!existingEntry` to keep the entry of the current zip, call {@link ZipWriter#remove} with `existingEntry` and
+   * return `true` to replace it, or compare `crc32`, `uncompressedSize` or `lastModDate` to decide. An entry
+   * being added concurrently by a pending {@link ZipWriter#add} call is not passed.
+   *
    * @remarks
    * When the option is set, the data of the zip file is copied entry by entry and the entries left out leave no
    * bytes behind in the output, unlike {@link ZipWriter#remove}, which drops an entry from the central directory
@@ -3360,9 +3365,25 @@ export interface ZipWriterAppendZipOptions {
    * as well.
    *
    * @param entry The entry read from the zip file.
+   * @param existingEntry The entry of the current zip with the same filename, if any.
    * @returns `true` to copy the entry.
    */
-  filter?: (entry: Entry) => boolean | Promise<boolean>;
+  filter?: (entry: Entry, existingEntry?: EntryMetaData) => boolean | Promise<boolean>;
+  /**
+   * The options of the {@link ZipReader} which reads the zip file.
+   *
+   * @remarks
+   * The zip file is read with the default options otherwise, so a zip file which a `ZipReader` rejects by default
+   * cannot be appended as-is: set {@link ZipReaderConstructorOptions#filenameValidation} or
+   * {@link ZipReaderConstructorOptions#strictness} here to copy the entries of a zip file holding unsafe or
+   * unusual filenames, {@link ZipReaderConstructorOptions#filenameEncoding} to decode the filenames the
+   * duplicate check and the `filter` option see, and {@link ZipReaderConstructorOptions#password} to let
+   * `filter` read the data of encrypted entries with {@link Entry#getData}. The bytes of the entries are copied
+   * as-is whatever the options are.
+   *
+   * A value which is neither an object nor unset throws an {@link ERR_INVALID_READER_OPTIONS} error.
+   */
+  readerOptions?: ZipReaderConstructorOptions;
 }
 
 export interface ZipWriterCloseOptions extends EntryOnprogressOptions {
@@ -5506,7 +5527,8 @@ export const ERR_UNSUPPORTED_PASS_THROUGH_VALUE: string;
 /**
  * Invalid readerOptions error (thrown by `{@link ZipDirectoryEntry}#export*()`,
  * {@link ZipDirectoryEntry#getExportedSize} and {@link ZipDirectoryEntry#exportFileSystemHandle} when the
- * {@link ZipDirectoryEntryExportOptions#readerOptions} option is neither an object nor unset)
+ * {@link ZipDirectoryEntryExportOptions#readerOptions} option is neither an object nor unset, and by
+ * {@link ZipWriter#appendZip} for {@link ZipWriterAppendZipOptions#readerOptions})
  *
  * @remarks A value of another type was silently ignored: a password passed as a string instead of an object failed
  * with the unrelated {@link ERR_ENCRYPTED}, while the other options were dropped without any error. Note that an

package/index.d.ts

@@ -635,13 +635,6 @@ export interface WorkerConfiguration {
    * @defaultValue true
    */
   useCompressionStream?: boolean;
-  /**
-   * `true` to transfer stream ownership to web workers.
-   *
-   * @deprecated The option is ignored whatever its value: the data always crosses the worker boundary chunk by
-   * chunk, transferring the streams instead was slower on every engine measured.
-   */
-  transferStreams?: boolean;
 }
 
 /**
@@ -3086,11 +3079,15 @@ export class ZipWriter<Type> {
    * are not applied to the copied entries. The comment and the digital signature of the zip file are not copied,
    * since its central directory is rebuilt: pass them to {@link ZipWriter#close}.
    *
-   * Pending {@link ZipWriter#add} calls are completed before the data is copied, and add() calls made
-   * while the copy is in progress are written after it. If an entry of the zip file has the same
+   * Pending {@link ZipWriter#add} calls are completed before the data is copied. add() calls made while the
+   * `filter` option runs are written before the copied entries, and add() calls made once the copy has started
+   * are written after it. If an entry of the zip file has the same
    * filename as an entry of the current zip, the method throws with the `ERR_DUPLICATED_NAME` error
    * message and leaves the current zip unchanged; call {@link ZipWriter#remove} beforehand to resolve
-   * the conflicts. An entry whose sizes or offset are unusable because its Zip64 extra field is missing (see
+   * the conflicts. The same error is thrown when two entries of the zip file share a filename, since a
+   * `ZipWriter` holds one entry per filename: use the {@link ZipWriterAppendZipOptions#filter} option to
+   * keep one of them. The entries passed to `filter` are not modified by the copy. An entry whose sizes or
+   * offset are unusable because its Zip64 extra field is missing (see
    * {@link WARNING_MISSING_ZIP64_EXTRA_FIELD}) cannot be copied: the method throws
    * {@link ERR_EXTRAFIELD_ZIP64_NOT_FOUND} and leaves the current zip unchanged, unless the
    * {@link ZipWriterAppendZipOptions#filter} option leaves the entry out.
@@ -3174,10 +3171,11 @@ export class ZipWriter<Type> {
    * Removes an entry from the central directory that will be written for the zip file. The entry
    * data itself cannot be removed because it has already been streamed to the output.
    *
-   * @param entry The entry to remove. This can be an {@link Entry} instance or the filename of the entry.
+   * @param entry The entry to remove. This can be an {@link Entry} instance, the {@link EntryMetaData} returned by
+   * {@link ZipWriter#add} or passed to the `filter` option of {@link ZipWriter#appendZip}, or the filename of the entry.
    * @returns `true` if the entry has been removed, `false` otherwise.
    */
-  remove(entry: Entry | string): boolean;
+  remove(entry: EntryMetaData | string): boolean;
 
   /**
    * Writes the entries directory, writes the global comment, and returns the content of the zip file
@@ -3342,6 +3340,13 @@ export interface ZipWriterAppendZipOptions {
    * central directory, and the entry is copied when it returns (or resolves to) `true`. The function can read
    * the data of the entry with {@link Entry#getData} to decide: every call completes before any data is copied.
    *
+   * The second argument is the entry of the current zip which has the same filename, as {@link ZipWriter#add}
+   * or a previous call to {@link ZipWriter#appendZip} left it, or `undefined` when there is none. It is the way to
+   * apply a duplicate filename policy, since keeping both entries throws `ERR_DUPLICATED_NAME`: return
+   * `!existingEntry` to keep the entry of the current zip, call {@link ZipWriter#remove} with `existingEntry` and
+   * return `true` to replace it, or compare `crc32`, `uncompressedSize` or `lastModDate` to decide. An entry
+   * being added concurrently by a pending {@link ZipWriter#add} call is not passed.
+   *
    * @remarks
    * When the option is set, the data of the zip file is copied entry by entry and the entries left out leave no
    * bytes behind in the output, unlike {@link ZipWriter#remove}, which drops an entry from the central directory
@@ -3360,9 +3365,25 @@ export interface ZipWriterAppendZipOptions {
    * as well.
    *
    * @param entry The entry read from the zip file.
+   * @param existingEntry The entry of the current zip with the same filename, if any.
    * @returns `true` to copy the entry.
    */
-  filter?: (entry: Entry) => boolean | Promise<boolean>;
+  filter?: (entry: Entry, existingEntry?: EntryMetaData) => boolean | Promise<boolean>;
+  /**
+   * The options of the {@link ZipReader} which reads the zip file.
+   *
+   * @remarks
+   * The zip file is read with the default options otherwise, so a zip file which a `ZipReader` rejects by default
+   * cannot be appended as-is: set {@link ZipReaderConstructorOptions#filenameValidation} or
+   * {@link ZipReaderConstructorOptions#strictness} here to copy the entries of a zip file holding unsafe or
+   * unusual filenames, {@link ZipReaderConstructorOptions#filenameEncoding} to decode the filenames the
+   * duplicate check and the `filter` option see, and {@link ZipReaderConstructorOptions#password} to let
+   * `filter` read the data of encrypted entries with {@link Entry#getData}. The bytes of the entries are copied
+   * as-is whatever the options are.
+   *
+   * A value which is neither an object nor unset throws an {@link ERR_INVALID_READER_OPTIONS} error.
+   */
+  readerOptions?: ZipReaderConstructorOptions;
 }
 
 export interface ZipWriterCloseOptions extends EntryOnprogressOptions {
@@ -5506,7 +5527,8 @@ export const ERR_UNSUPPORTED_PASS_THROUGH_VALUE: string;
 /**
  * Invalid readerOptions error (thrown by `{@link ZipDirectoryEntry}#export*()`,
  * {@link ZipDirectoryEntry#getExportedSize} and {@link ZipDirectoryEntry#exportFileSystemHandle} when the
- * {@link ZipDirectoryEntryExportOptions#readerOptions} option is neither an object nor unset)
+ * {@link ZipDirectoryEntryExportOptions#readerOptions} option is neither an object nor unset, and by
+ * {@link ZipWriter#appendZip} for {@link ZipWriterAppendZipOptions#readerOptions})
  *
  * @remarks A value of another type was silently ignored: a password passed as a string instead of an object failed
  * with the unrelated {@link ERR_ENCRYPTED}, while the other options were dropped without any error. Note that an