@zip.js/zip.js 2.18.2 → 2.20.0

package/index.d.cts

@@ -569,7 +569,11 @@ export interface Configuration extends WorkerConfiguration {
    * Values lower than 64 are raised to 64, and a value that is not an integer greater than 0 is replaced with the default
    * value.
    *
-   * @defaultValue 65536
+   * @remarks
+   * Every stage of the pipeline of an entry holds up to one chunk, and the data crosses the boundary of a web worker one
+   * chunk per message, so a larger value costs more memory per entry in progress and buys fewer messages.
+   *
+   * @defaultValue 262144
    */
   chunkSize?: number;
   /**
@@ -634,7 +638,8 @@ export interface WorkerConfiguration {
   /**
    * `true` to transfer stream ownership to web workers.
    *
-   * @defaultValue true
+   * @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;
 }
@@ -919,7 +924,7 @@ export class Reader<Type> implements Initializable, ReadableReader {
    */
   constructor(value: Type);
   /**
-   * The `ReadableStream` instance.
+   * The `ReadableStream` instance, a new one reading the data from its start on each access.
    */
   readable: ReadableStream;
   /**
@@ -1538,9 +1543,12 @@ export class ZipReader<Type> {
    * `strictness: "strict"` rejects with {@link ERR_AMBIGUOUS_ARCHIVE}: when the effective strictness tolerates
    * one of them and the evidence is already in hand, the same reason string is deposited as a warning instead —
    * {@link WARNING_APPENDED_DATA}, {@link WARNING_PREPENDED_DATA}, {@link WARNING_TRAILING_CENTRAL_DIRECTORY_DATA},
-   * {@link WARNING_DUPLICATE_FILENAME} and {@link WARNING_MISMATCHED_ZIP64_END_OF_CENTRAL_DIRECTORY}.
+   * {@link WARNING_MISMATCHED_CENTRAL_DIRECTORY_OFFSET}, {@link WARNING_DUPLICATE_FILENAME} and
+   * {@link WARNING_MISMATCHED_ZIP64_END_OF_CENTRAL_DIRECTORY}.
    * {@link WARNING_MULTIPLE_END_OF_CENTRAL_DIRECTORY} is the one reason of that group which is never tolerated,
-   * so it is only ever the reason of an error.
+   * so it is only ever the reason of an error. {@link WARNING_MISSING_ZIP64_EXTRA_FIELD} is deposited when an
+   * entry cannot be read because its central directory record lacks a Zip64 extra field, and `"strict"` throws
+   * {@link ERR_EXTRAFIELD_ZIP64_NOT_FOUND} for it.
    *
    * The warnings related to the local file header of an entry are deposited on
    * {@link EntryMetaData#warnings} when its data is read, not here.
@@ -1753,8 +1761,10 @@ export interface GetEntriesOptions {
    * systems, and it also occurs as the trail byte of legitimate double-byte filenames (e.g. CP932) decoded with
    * another charset.
    *
-   * Names are validated, never rewritten, so the filename reported for an entry always matches its central
-   * directory record.
+   * Names are validated, never rewritten: the filename reported for an entry is the one its central directory
+   * record stores, decoded, or the one of its Unicode Path extra field when the entry carries a valid one (see
+   * {@link EntryMetaData#extraFieldUnicodePath}), and the bytes of the record stay available in
+   * {@link EntryMetaData#rawFilename}. The name validated is that final name.
    *
    * @defaultValue The value of {@link GetEntriesOptions#strictness}.
    */
@@ -1763,8 +1773,9 @@ export interface GetEntriesOptions {
    * The function called for normalizing the filename of each entry, e.g. to repair the names rejected by
    * {@link GetEntriesOptions#filenameValidation}.
    *
-   * It is called with the decoded filename, after {@link GetEntriesOptions#decodeText} and before the name is
-   * validated, so a name it fails to repair is still rejected. The returned name becomes the name of the entry:
+   * It is called with the decoded filename, after {@link GetEntriesOptions#decodeText} and after a valid Unicode
+   * Path extra field (see {@link EntryMetaData#extraFieldUnicodePath}) has replaced the name, and before the name
+   * is validated, so a name it fails to repair is still rejected. The returned name becomes the name of the entry:
    * it is used to detect directory entries by their trailing `"/"`, and to detect duplicate filenames when
    * {@link GetEntriesOptions#checkAmbiguity} is set, so two names normalized into the same name are reported as
    * an {@link ERR_AMBIGUOUS_ARCHIVE} error instead of silently shadowing each other. The raw filename remains
@@ -2378,13 +2389,13 @@ export interface LocalDirectory {
   extraFieldNTFS?: EntryExtraFieldNTFS;
   /**
    * The Info-ZIP Unix type 2 extra field (0x7855). Its uid/gid are stored in the local file header only, the
-   * central directory version carries no data and merely flags their presence.
+   * central directory version carries no data and merely flags their presence. Its ids are used when the
+   * header holds no New Unix extra field (0x7875).
    */
   extraFieldUnix?: EntryExtraFieldUnix;
   /**
-   * The Info-ZIP New Unix extra field (0x7875), storing variable-length uid/gid in both headers. It is read
-   * whenever the type 2 extra field (0x7855) is absent or carries no ids, which is its usual state in the
-   * central directory.
+   * The Info-ZIP New Unix extra field (0x7875), storing variable-length uid/gid in both headers. It takes
+   * precedence over the type 2 extra field (0x7855) when a header carries both.
    */
   extraFieldInfoZip?: EntryExtraFieldUnix;
   /**
@@ -2514,7 +2525,9 @@ export interface EntryMetaData {
    * `true` if the entry is an executable file
    *
    * Always `false` when {@link EntryMetaData#symlink} is `true`: the permissions of a symbolic link
-   * are not meaningful, Unix systems store them as `0o777`.
+   * are not meaningful, Unix systems store them as `0o777`. Always `false` when
+   * {@link EntryMetaData#directory} is `true` too: the execute bits of a directory mean that it can be
+   * searched, and every directory carries them; read {@link EntryMetaData#unixMode} for the bits themselves.
    */
   executable: boolean;
   /**
@@ -2562,8 +2575,9 @@ export interface EntryMetaData {
   creationDate?: Date;
   /**
    * The last modification date (raw), as the MS-DOS date and time stored in the header. Unlike
-   * {@link EntryMetaData#lastModDate}, it is not replaced by the value of the NTFS extra field when that field
-   * is present; read {@link EntryMetaData#extraFieldNTFS} for the raw NTFS value.
+   * {@link EntryMetaData#lastModDate}, it is not replaced by the value of the extended timestamp or NTFS extra
+   * field when one is present (the NTFS value wins over the extended timestamp one, being the finer of the two);
+   * read {@link EntryMetaData#extraFieldNTFS} for the raw NTFS value.
    */
   rawLastModDate: number | bigint;
   /**
@@ -2747,13 +2761,13 @@ export interface EntryMetaData {
   extraFieldNTFS?: EntryExtraFieldNTFS;
   /**
    * The Info-ZIP Unix type 2 extra field (0x7855). Its uid/gid are stored in the local file header only, the
-   * central directory version carries no data and merely flags their presence.
+   * central directory version carries no data and merely flags their presence. Its ids are used when the
+   * header holds no New Unix extra field (0x7875).
    */
   extraFieldUnix?: EntryExtraFieldUnix;
   /**
-   * The Info-ZIP New Unix extra field (0x7875), storing variable-length uid/gid in both headers. It is read
-   * whenever the type 2 extra field (0x7855) is absent or carries no ids, which is its usual state in the
-   * central directory.
+   * The Info-ZIP New Unix extra field (0x7875), storing variable-length uid/gid in both headers. It takes
+   * precedence over the type 2 extra field (0x7855) when a header carries both.
    */
   extraFieldInfoZip?: EntryExtraFieldUnix;
   /**
@@ -2785,8 +2799,8 @@ export interface EntryMetaData {
    *
    * The local file header is the only place where the Info-ZIP Unix extra fields type 1 (0x5855) and type 2
    * (0x7855) store the uid/gid, so this is where they are read for entries carrying just these fields, e.g.
-   * with `entry.localDirectory.extraFieldUnixType1.uid`. The values are not merged into
-   * {@link EntryMetaData#uid} and {@link EntryMetaData#gid}, which are read from the central directory.
+   * with `entry.localDirectory.extraFieldUnixType1.uid`. The values fill in {@link EntryMetaData#uid} and
+   * {@link EntryMetaData#gid} only when the central directory gave none, see {@link EntryMetaData#uid}.
    */
   localDirectory?: LocalDirectory;
   /**
@@ -3072,7 +3086,13 @@ export class ZipWriter<Type> {
    * The returned promise can safely be left un-awaited: {@link ZipWriter#close} waits for the copy
    * and throws its error if it was not caught.
    *
+   * With the {@link ZipWriterAppendZipOptions#filter} option, only the entries the function keeps are copied.
+   * Combined with {@link ZipWriter#add}, this edits an existing zip file into a new one without decompressing
+   * its data: the entries to keep are copied as-is, the entries to delete or replace are left out, and the
+   * replacements and additions are added afterwards.
+   *
    * @param reader The {@link Reader} instance used to read the content of the zip file.
+   * @param options The options.
    * @returns A promise resolving when the zip file has been added.
    */
   appendZip<ReaderType>(
@@ -3082,7 +3102,8 @@ export class ZipWriter<Type> {
       | ReadableStream
       | Reader<unknown>[]
       | ReadableReader[]
-      | ReadableStream[]
+      | ReadableStream[],
+    options?: ZipWriterAppendZipOptions
   ): Promise<void>;
 
   /**
@@ -3300,6 +3321,29 @@ export interface ZipWriterAddDataOptions
 /**
  * Represents the options passed to  {@link ZipWriter#close}.
  */
+/**
+ * Represents the options passed to {@link ZipWriter#appendZip}.
+ */
+export interface ZipWriterAppendZipOptions {
+  /**
+   * Selects the entries of the zip file to copy: the function is called once per entry, in the order of the
+   * 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, the zip file is closed after the last call.
+   *
+   * @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
+   * after its data has been written. The bytes of the zip file outside its entries, e.g. a self-extracting stub
+   * before the first entry, are not copied either. Without the option, the data of the zip file is copied as a
+   * whole. The duplicate filename check applies to the entries kept only, so an entry can be replaced by
+   * leaving it out and adding its replacement with {@link ZipWriter#add}.
+   *
+   * @param entry The entry read from the zip file.
+   * @returns `true` to copy the entry.
+   */
+  filter?: (entry: Entry) => boolean | Promise<boolean>;
+}
+
 export interface ZipWriterCloseOptions extends EntryOnprogressOptions {
   /**
    * `true` to use Zip64 to write the entries directory.
@@ -3649,8 +3693,10 @@ export interface ZipWriterConstructorOptions extends WorkerConfiguration {
    * Which Unix extra field format to write when creating entries that include Unix metadata.
    * - "infozip": Info-ZIP New Unix extra field (0x7875), storing variable-length uid/gid up to 32 bits.
    * - "unix": Info-ZIP Unix extra field type 2 (0x7855), storing fixed 2-byte uid/gid (0..65535); a
-   *   larger uid or gid is rejected. The Unix mode is not part of this field; it is written to the
-   *   external file attributes.
+   *   larger uid or gid is rejected. The ids are written in the local file header only, the central
+   *   directory copy is empty as Info-ZIP specifies, so a reader working from the central directory,
+   *   {@link ZipReader} included, reports them once the entry data has been read. The Unix mode is not
+   *   part of this field; it is written to the external file attributes.
    *
    * When {@link ZipFS} exports imported entries, their uid/gid are re-emitted as "infozip" regardless
    * of the field type found in the imported zip file, unless this option is set explicitly.
@@ -4989,7 +5035,9 @@ export const ERR_BAD_FORMAT: string;
  */
 export const ERR_EOCDR_NOT_FOUND: string;
 /**
- * Zip64 End of Central Directory Locator not found error
+ * Zip64 End of Central Directory Locator not found error: the end of central directory record holds a Zip64
+ * sentinel in its offset, size or disk number field but no Zip64 locator precedes it, or the locator does not
+ * point at a Zip64 end of central directory record
  */
 export const ERR_EOCDR_LOCATOR_ZIP64_NOT_FOUND: string;
 /**
@@ -5588,6 +5636,27 @@ export const WARNING_PREPENDED_CENTRAL_DIRECTORY: string;
  * the reason of {@link ERR_AMBIGUOUS_ARCHIVE} under `strictness: "strict"`
  */
 export const WARNING_TRAILING_CENTRAL_DIRECTORY_DATA: string;
+/**
+ * Warning reason: the end of central directory record stores a central directory offset that points past the
+ * central directory actually found before it, so the archive was read from the directory found rather than from
+ * the stored offset (see {@link ZipReader#warnings}); the reason of {@link ERR_AMBIGUOUS_ARCHIVE} under
+ * `strictness: "strict"`
+ *
+ * @remarks
+ * Such an archive is typically one written with absolute offsets for a prefix that is no longer there, e.g. a
+ * self-extracting archive whose stub was removed. When the local file header of the first entry is found at
+ * the same shifted position, the entries are read from the shifted positions; otherwise the offsets stored in
+ * the central directory are used as they are.
+ */
+export const WARNING_MISMATCHED_CENTRAL_DIRECTORY_OFFSET: string;
+/**
+ * Warning reason: a central directory record holds the Zip64 sentinel in a size, offset or disk number field
+ * but carries no Zip64 extra field resolving it (see {@link ZipReader#warnings}). The entry is listed, its
+ * sizes and offset are unusable, and reading its data throws {@link ERR_EXTRAFIELD_ZIP64_NOT_FOUND}; the
+ * other entries are unaffected. Under `strictness: "strict"`, {@link ZipReader#getEntries} throws
+ * {@link ERR_EXTRAFIELD_ZIP64_NOT_FOUND} instead.
+ */
+export const WARNING_MISSING_ZIP64_EXTRA_FIELD: string;
 /**
  * Warning reason: several entries share the same filename (see {@link ZipReader#warnings}); the reason of
  * {@link ERR_AMBIGUOUS_ARCHIVE} under `strictness: "strict"`

package/index.d.ts

@@ -569,7 +569,11 @@ export interface Configuration extends WorkerConfiguration {
    * Values lower than 64 are raised to 64, and a value that is not an integer greater than 0 is replaced with the default
    * value.
    *
-   * @defaultValue 65536
+   * @remarks
+   * Every stage of the pipeline of an entry holds up to one chunk, and the data crosses the boundary of a web worker one
+   * chunk per message, so a larger value costs more memory per entry in progress and buys fewer messages.
+   *
+   * @defaultValue 262144
    */
   chunkSize?: number;
   /**
@@ -634,7 +638,8 @@ export interface WorkerConfiguration {
   /**
    * `true` to transfer stream ownership to web workers.
    *
-   * @defaultValue true
+   * @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;
 }
@@ -919,7 +924,7 @@ export class Reader<Type> implements Initializable, ReadableReader {
    */
   constructor(value: Type);
   /**
-   * The `ReadableStream` instance.
+   * The `ReadableStream` instance, a new one reading the data from its start on each access.
    */
   readable: ReadableStream;
   /**
@@ -1538,9 +1543,12 @@ export class ZipReader<Type> {
    * `strictness: "strict"` rejects with {@link ERR_AMBIGUOUS_ARCHIVE}: when the effective strictness tolerates
    * one of them and the evidence is already in hand, the same reason string is deposited as a warning instead —
    * {@link WARNING_APPENDED_DATA}, {@link WARNING_PREPENDED_DATA}, {@link WARNING_TRAILING_CENTRAL_DIRECTORY_DATA},
-   * {@link WARNING_DUPLICATE_FILENAME} and {@link WARNING_MISMATCHED_ZIP64_END_OF_CENTRAL_DIRECTORY}.
+   * {@link WARNING_MISMATCHED_CENTRAL_DIRECTORY_OFFSET}, {@link WARNING_DUPLICATE_FILENAME} and
+   * {@link WARNING_MISMATCHED_ZIP64_END_OF_CENTRAL_DIRECTORY}.
    * {@link WARNING_MULTIPLE_END_OF_CENTRAL_DIRECTORY} is the one reason of that group which is never tolerated,
-   * so it is only ever the reason of an error.
+   * so it is only ever the reason of an error. {@link WARNING_MISSING_ZIP64_EXTRA_FIELD} is deposited when an
+   * entry cannot be read because its central directory record lacks a Zip64 extra field, and `"strict"` throws
+   * {@link ERR_EXTRAFIELD_ZIP64_NOT_FOUND} for it.
    *
    * The warnings related to the local file header of an entry are deposited on
    * {@link EntryMetaData#warnings} when its data is read, not here.
@@ -1753,8 +1761,10 @@ export interface GetEntriesOptions {
    * systems, and it also occurs as the trail byte of legitimate double-byte filenames (e.g. CP932) decoded with
    * another charset.
    *
-   * Names are validated, never rewritten, so the filename reported for an entry always matches its central
-   * directory record.
+   * Names are validated, never rewritten: the filename reported for an entry is the one its central directory
+   * record stores, decoded, or the one of its Unicode Path extra field when the entry carries a valid one (see
+   * {@link EntryMetaData#extraFieldUnicodePath}), and the bytes of the record stay available in
+   * {@link EntryMetaData#rawFilename}. The name validated is that final name.
    *
    * @defaultValue The value of {@link GetEntriesOptions#strictness}.
    */
@@ -1763,8 +1773,9 @@ export interface GetEntriesOptions {
    * The function called for normalizing the filename of each entry, e.g. to repair the names rejected by
    * {@link GetEntriesOptions#filenameValidation}.
    *
-   * It is called with the decoded filename, after {@link GetEntriesOptions#decodeText} and before the name is
-   * validated, so a name it fails to repair is still rejected. The returned name becomes the name of the entry:
+   * It is called with the decoded filename, after {@link GetEntriesOptions#decodeText} and after a valid Unicode
+   * Path extra field (see {@link EntryMetaData#extraFieldUnicodePath}) has replaced the name, and before the name
+   * is validated, so a name it fails to repair is still rejected. The returned name becomes the name of the entry:
    * it is used to detect directory entries by their trailing `"/"`, and to detect duplicate filenames when
    * {@link GetEntriesOptions#checkAmbiguity} is set, so two names normalized into the same name are reported as
    * an {@link ERR_AMBIGUOUS_ARCHIVE} error instead of silently shadowing each other. The raw filename remains
@@ -2378,13 +2389,13 @@ export interface LocalDirectory {
   extraFieldNTFS?: EntryExtraFieldNTFS;
   /**
    * The Info-ZIP Unix type 2 extra field (0x7855). Its uid/gid are stored in the local file header only, the
-   * central directory version carries no data and merely flags their presence.
+   * central directory version carries no data and merely flags their presence. Its ids are used when the
+   * header holds no New Unix extra field (0x7875).
    */
   extraFieldUnix?: EntryExtraFieldUnix;
   /**
-   * The Info-ZIP New Unix extra field (0x7875), storing variable-length uid/gid in both headers. It is read
-   * whenever the type 2 extra field (0x7855) is absent or carries no ids, which is its usual state in the
-   * central directory.
+   * The Info-ZIP New Unix extra field (0x7875), storing variable-length uid/gid in both headers. It takes
+   * precedence over the type 2 extra field (0x7855) when a header carries both.
    */
   extraFieldInfoZip?: EntryExtraFieldUnix;
   /**
@@ -2514,7 +2525,9 @@ export interface EntryMetaData {
    * `true` if the entry is an executable file
    *
    * Always `false` when {@link EntryMetaData#symlink} is `true`: the permissions of a symbolic link
-   * are not meaningful, Unix systems store them as `0o777`.
+   * are not meaningful, Unix systems store them as `0o777`. Always `false` when
+   * {@link EntryMetaData#directory} is `true` too: the execute bits of a directory mean that it can be
+   * searched, and every directory carries them; read {@link EntryMetaData#unixMode} for the bits themselves.
    */
   executable: boolean;
   /**
@@ -2562,8 +2575,9 @@ export interface EntryMetaData {
   creationDate?: Date;
   /**
    * The last modification date (raw), as the MS-DOS date and time stored in the header. Unlike
-   * {@link EntryMetaData#lastModDate}, it is not replaced by the value of the NTFS extra field when that field
-   * is present; read {@link EntryMetaData#extraFieldNTFS} for the raw NTFS value.
+   * {@link EntryMetaData#lastModDate}, it is not replaced by the value of the extended timestamp or NTFS extra
+   * field when one is present (the NTFS value wins over the extended timestamp one, being the finer of the two);
+   * read {@link EntryMetaData#extraFieldNTFS} for the raw NTFS value.
    */
   rawLastModDate: number | bigint;
   /**
@@ -2747,13 +2761,13 @@ export interface EntryMetaData {
   extraFieldNTFS?: EntryExtraFieldNTFS;
   /**
    * The Info-ZIP Unix type 2 extra field (0x7855). Its uid/gid are stored in the local file header only, the
-   * central directory version carries no data and merely flags their presence.
+   * central directory version carries no data and merely flags their presence. Its ids are used when the
+   * header holds no New Unix extra field (0x7875).
    */
   extraFieldUnix?: EntryExtraFieldUnix;
   /**
-   * The Info-ZIP New Unix extra field (0x7875), storing variable-length uid/gid in both headers. It is read
-   * whenever the type 2 extra field (0x7855) is absent or carries no ids, which is its usual state in the
-   * central directory.
+   * The Info-ZIP New Unix extra field (0x7875), storing variable-length uid/gid in both headers. It takes
+   * precedence over the type 2 extra field (0x7855) when a header carries both.
    */
   extraFieldInfoZip?: EntryExtraFieldUnix;
   /**
@@ -2785,8 +2799,8 @@ export interface EntryMetaData {
    *
    * The local file header is the only place where the Info-ZIP Unix extra fields type 1 (0x5855) and type 2
    * (0x7855) store the uid/gid, so this is where they are read for entries carrying just these fields, e.g.
-   * with `entry.localDirectory.extraFieldUnixType1.uid`. The values are not merged into
-   * {@link EntryMetaData#uid} and {@link EntryMetaData#gid}, which are read from the central directory.
+   * with `entry.localDirectory.extraFieldUnixType1.uid`. The values fill in {@link EntryMetaData#uid} and
+   * {@link EntryMetaData#gid} only when the central directory gave none, see {@link EntryMetaData#uid}.
    */
   localDirectory?: LocalDirectory;
   /**
@@ -3072,7 +3086,13 @@ export class ZipWriter<Type> {
    * The returned promise can safely be left un-awaited: {@link ZipWriter#close} waits for the copy
    * and throws its error if it was not caught.
    *
+   * With the {@link ZipWriterAppendZipOptions#filter} option, only the entries the function keeps are copied.
+   * Combined with {@link ZipWriter#add}, this edits an existing zip file into a new one without decompressing
+   * its data: the entries to keep are copied as-is, the entries to delete or replace are left out, and the
+   * replacements and additions are added afterwards.
+   *
    * @param reader The {@link Reader} instance used to read the content of the zip file.
+   * @param options The options.
    * @returns A promise resolving when the zip file has been added.
    */
   appendZip<ReaderType>(
@@ -3082,7 +3102,8 @@ export class ZipWriter<Type> {
       | ReadableStream
       | Reader<unknown>[]
       | ReadableReader[]
-      | ReadableStream[]
+      | ReadableStream[],
+    options?: ZipWriterAppendZipOptions
   ): Promise<void>;
 
   /**
@@ -3300,6 +3321,29 @@ export interface ZipWriterAddDataOptions
 /**
  * Represents the options passed to  {@link ZipWriter#close}.
  */
+/**
+ * Represents the options passed to {@link ZipWriter#appendZip}.
+ */
+export interface ZipWriterAppendZipOptions {
+  /**
+   * Selects the entries of the zip file to copy: the function is called once per entry, in the order of the
+   * 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, the zip file is closed after the last call.
+   *
+   * @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
+   * after its data has been written. The bytes of the zip file outside its entries, e.g. a self-extracting stub
+   * before the first entry, are not copied either. Without the option, the data of the zip file is copied as a
+   * whole. The duplicate filename check applies to the entries kept only, so an entry can be replaced by
+   * leaving it out and adding its replacement with {@link ZipWriter#add}.
+   *
+   * @param entry The entry read from the zip file.
+   * @returns `true` to copy the entry.
+   */
+  filter?: (entry: Entry) => boolean | Promise<boolean>;
+}
+
 export interface ZipWriterCloseOptions extends EntryOnprogressOptions {
   /**
    * `true` to use Zip64 to write the entries directory.
@@ -3649,8 +3693,10 @@ export interface ZipWriterConstructorOptions extends WorkerConfiguration {
    * Which Unix extra field format to write when creating entries that include Unix metadata.
    * - "infozip": Info-ZIP New Unix extra field (0x7875), storing variable-length uid/gid up to 32 bits.
    * - "unix": Info-ZIP Unix extra field type 2 (0x7855), storing fixed 2-byte uid/gid (0..65535); a
-   *   larger uid or gid is rejected. The Unix mode is not part of this field; it is written to the
-   *   external file attributes.
+   *   larger uid or gid is rejected. The ids are written in the local file header only, the central
+   *   directory copy is empty as Info-ZIP specifies, so a reader working from the central directory,
+   *   {@link ZipReader} included, reports them once the entry data has been read. The Unix mode is not
+   *   part of this field; it is written to the external file attributes.
    *
    * When {@link ZipFS} exports imported entries, their uid/gid are re-emitted as "infozip" regardless
    * of the field type found in the imported zip file, unless this option is set explicitly.
@@ -4989,7 +5035,9 @@ export const ERR_BAD_FORMAT: string;
  */
 export const ERR_EOCDR_NOT_FOUND: string;
 /**
- * Zip64 End of Central Directory Locator not found error
+ * Zip64 End of Central Directory Locator not found error: the end of central directory record holds a Zip64
+ * sentinel in its offset, size or disk number field but no Zip64 locator precedes it, or the locator does not
+ * point at a Zip64 end of central directory record
  */
 export const ERR_EOCDR_LOCATOR_ZIP64_NOT_FOUND: string;
 /**
@@ -5588,6 +5636,27 @@ export const WARNING_PREPENDED_CENTRAL_DIRECTORY: string;
  * the reason of {@link ERR_AMBIGUOUS_ARCHIVE} under `strictness: "strict"`
  */
 export const WARNING_TRAILING_CENTRAL_DIRECTORY_DATA: string;
+/**
+ * Warning reason: the end of central directory record stores a central directory offset that points past the
+ * central directory actually found before it, so the archive was read from the directory found rather than from
+ * the stored offset (see {@link ZipReader#warnings}); the reason of {@link ERR_AMBIGUOUS_ARCHIVE} under
+ * `strictness: "strict"`
+ *
+ * @remarks
+ * Such an archive is typically one written with absolute offsets for a prefix that is no longer there, e.g. a
+ * self-extracting archive whose stub was removed. When the local file header of the first entry is found at
+ * the same shifted position, the entries are read from the shifted positions; otherwise the offsets stored in
+ * the central directory are used as they are.
+ */
+export const WARNING_MISMATCHED_CENTRAL_DIRECTORY_OFFSET: string;
+/**
+ * Warning reason: a central directory record holds the Zip64 sentinel in a size, offset or disk number field
+ * but carries no Zip64 extra field resolving it (see {@link ZipReader#warnings}). The entry is listed, its
+ * sizes and offset are unusable, and reading its data throws {@link ERR_EXTRAFIELD_ZIP64_NOT_FOUND}; the
+ * other entries are unaffected. Under `strictness: "strict"`, {@link ZipReader#getEntries} throws
+ * {@link ERR_EXTRAFIELD_ZIP64_NOT_FOUND} instead.
+ */
+export const WARNING_MISSING_ZIP64_EXTRA_FIELD: string;
 /**
  * Warning reason: several entries share the same filename (see {@link ZipReader#warnings}); the reason of
  * {@link ERR_AMBIGUOUS_ARCHIVE} under `strictness: "strict"`