@zip.js/zip.js 2.8.29 → 2.8.31

package/index.d.cts

@@ -0,0 +1,2814 @@
+/**
+ * zip.js is a JavaScript open-source library (BSD-3-Clause license) for
+ * compressing and decompressing zip files. It has been designed to handle large amounts
+ * of data. It supports notably multi-core compression, native compression with
+ * compression streams, archives larger than 4GB with Zip64, split zip files, data
+ * encryption, and Deflate64 decompression.
+ *
+ * @author Gildas Lormeau
+ * @license BSD-3-Clause
+ *
+ * @example
+ * Hello world
+ * ```js
+ * import {
+ *   BlobReader,
+ *   BlobWriter,
+ *   TextReader,
+ *   TextWriter,
+ *   ZipReader,
+ *   ZipWriter,
+ * } from from "@zip-js/zip-js";
+ *
+ * // ----
+ * // 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);
+ * ```
+ *
+ * @example
+ * Hello world with Streams
+ * ```js
+ * import {
+ *   BlobReader,
+ *   ZipReader,
+ *   ZipWriter,
+ * } from "@zip-js/zip-js";
+ *
+ * // ----
+ * // Write the zip file
+ * // ----
+ *
+ * // Creates a TransformStream object, the zip content will be written in the
+ * // `writable` property.
+ * const zipFileStream = new TransformStream();
+ * // Creates a Promise object resolved to the zip content returned as a Blob
+ * // object retrieved from `zipFileStream.readable`.
+ * const zipFileBlobPromise = new Response(zipFileStream.readable).blob();
+ * // Creates a ReadableStream object storing the text of the entry to add in the
+ * // zip (i.e. "Hello world!").
+ * const helloWorldReadable = new Blob(["Hello world!"]).stream();
+ *
+ * // Creates a ZipWriter object writing data into `zipFileStream.writable`, adds
+ * // the entry "hello.txt" containing the text "Hello world!" retrieved from
+ * // `helloWorldReadable`, and closes the writer.
+ * const zipWriter = new ZipWriter(zipFileStream.writable);
+ * await zipWriter.add("hello.txt", helloWorldReadable);
+ * await zipWriter.close();
+ *
+ * // Retrieves the Blob object containing the zip content into `zipFileBlob`.
+ * const zipFileBlob = await zipFileBlobPromise;
+ *
+ * // ----
+ * // Read the zip file
+ * // ----
+ *
+ * // Creates a BlobReader object used to read `zipFileBlob`.
+ * const zipFileReader = new BlobReader(zipFileBlob);
+ * // Creates a TransformStream object, the content of the first entry in the zip
+ * // will be written in the `writable` property.
+ * const helloWorldStream = new TransformStream();
+ * // Creates a Promise object resolved to the content of the first entry returned
+ * // as text from `helloWorldStream.readable`.
+ * const helloWorldTextPromise = new Response(helloWorldStream.readable).text();
+ *
+ * // Creates a ZipReader object reading the zip content via `zipFileReader`,
+ * // retrieves metadata (name, dates, etc.) of the first entry, retrieves its
+ * // content into `helloWorldStream.writable`, and closes the reader.
+ * const zipReader = new ZipReader(zipFileReader);
+ * const firstEntry = (await zipReader.getEntries()).shift();
+ * await firstEntry.getData(helloWorldStream.writable);
+ * await zipReader.close();
+ *
+ * // Displays "Hello world!".
+ * const helloWorldText = await helloWorldTextPromise;
+ * console.log(helloWorldText);
+ * ```
+ *
+ * @example
+ * Adding concurrently multiple entries in a zip file
+ * ```js
+ * import {
+ *   BlobWriter,
+ *   HttpReader,
+ *   TextReader,
+ *   ZipWriter,
+ * } from "@zip-js/zip-js";
+ *
+ * const README_URL = "https://unpkg.com/@zip.js/zip.js/README.md";
+ * getZipFileBlob()
+ *   .then(downloadFile);
+ *
+ * async function getZipFileBlob() {
+ *   const zipWriter = new ZipWriter(new BlobWriter("application/zip"));
+ *   await Promise.all([
+ *     zipWriter.add("hello.txt", new TextReader("Hello world!")),
+ *     zipWriter.add("README.md", new HttpReader(README_URL)),
+ *   ]);
+ *   return zipWriter.close();
+ * }
+ *
+ * function downloadFile(blob) {
+ *   document.body.appendChild(Object.assign(document.createElement("a"), {
+ *     download: "hello.zip",
+ *     href: URL.createObjectURL(blob),
+ *     textContent: "Download zip file",
+ *   }));
+ * }
+ * ```
+ *
+ * @module
+ */
+
+/**
+ * Represents the `FileSystemEntry` class.
+ *
+ * @see {@link https://wicg.github.io/entries-api/#api-entry|specification}
+ */
+// deno-lint-ignore no-empty-interface
+interface FileSystemEntryLike {}
+
+/**
+ * Represents the `FileSystemHandle` class.
+ *
+ * @see {@link https://fs.spec.whatwg.org/#api-filesystemhandle}
+ */
+// deno-lint-ignore no-empty-interface
+interface FileSystemHandleLike {}
+
+/**
+ * Represents a generic `TransformStream` class.
+ *
+ * @see {@link https://streams.spec.whatwg.org/#generictransformstream|specification}
+ */
+declare class TransformStreamLike {
+  /**
+   * The readable stream.
+   */
+  readable: ReadableStream;
+  /**
+   * The writable stream.
+   */
+  writable: WritableStream;
+}
+
+/**
+ * Configures zip.js
+ *
+ * @param configuration The configuration.
+ */
+export function configure(configuration: Configuration): void;
+
+/**
+ * Represents the configuration passed to {@link configure}.
+ */
+export interface Configuration extends WorkerConfiguration {
+  /**
+   * The maximum number of web workers used to compress/decompress data simultaneously.
+   *
+   * @defaultValue `navigator.hardwareConcurrency`
+   */
+  maxWorkers?: number;
+  /**
+   * The delay in milliseconds before idle web workers are automatically terminated. You can call `terminateWorkers()` to terminate idle workers.
+   *
+   * @defaultValue 5000
+   */
+  terminateWorkerTimeout?: number;
+  /**
+   * The delay in milliseconds after which the oldest pending compression/decompression task is run without a web worker when no task completes.
+   *
+   * It prevents deadlocks when entries read from a `ZipReader` are added concurrently into a `ZipWriter` and all the web workers are waiting for data.
+   *
+   * @defaultValue 5000
+   */
+  workerStarvationTimeout?: number;
+  /**
+   * The URI of the web worker.
+   *
+   * It allows using alternative deflate implementations or specifying a URL to the worker script if the CSP of the page blocks scripts imported from a Data URI.
+   *
+   * Here is an example to import the worker module as a URL (see `?url`) and avoid CSP issues:
+   * ```
+   * import workerURI from "@zip.js/zip.js/dist/zip-web-worker.js?url";
+   *
+   * configure({
+   *   workerURI
+   * });
+   * ```
+   *
+   * @defaultValue "./core/web-worker.js"
+   */
+  workerURI?: string;
+  /**
+   * The URI of the WebAssembly module used by default implementations to compress/decompress data. It is ignored if `useCompressionStream` is set to `true` and `CompressionStream`/`DecompressionStream` are supported by the environment.
+   *
+   * Here is an example to import the WASM module as a URL (see `?url`) and avoid CSP issues:
+   * ```
+   * import wasmURI from "@zip.js/zip.js/dist/zip-module.wasm?url";
+   *
+   * configure({
+   *   wasmURI
+   * });
+   * ```
+   *
+   * @defaultValue "./core/streams/zlib-wasm/zlib-streams.wasm"
+   */
+  wasmURI?: string;
+  /**
+   * The size of the chunks in bytes during data compression/decompression.
+   *
+   * @defaultValue 65536
+   */
+  chunkSize?: number;
+  /**
+   * The stream implementation used to compress data when `useCompressionStream` is set to `true`.
+   *
+   * @defaultValue {@link CodecStream}
+   */
+  CompressionStream?: typeof TransformStreamLike;
+  /**
+   * The stream implementation used to decompress data when `useCompressionStream` is set to `true`.
+   *
+   * @defaultValue {@link CodecStream}
+   */
+  DecompressionStream?: typeof TransformStreamLike;
+  /**
+   * The stream implementation used to compress data when `useCompressionStream` is set to `false`.
+   *
+   * @defaultValue {@link CodecStream}
+   */
+  CompressionStreamZlib?: typeof TransformStreamLike;
+  /**
+   * The stream implementation used to decompress data when `useCompressionStream` is set to `false`.
+   *
+   * @defaultValue {@link CodecStream}
+   */
+  DecompressionStreamZlib?: typeof TransformStreamLike;
+}
+
+/**
+ * Represents configuration passed to {@link configure}, the constructor of {@link ZipReader}, {@link FileEntry#getData}, the constructor of {@link ZipWriter}, and {@link ZipWriter#add}.
+ */
+export interface WorkerConfiguration {
+  /**
+   * `true` to use web workers to compress/decompress data in non-blocking background processes.
+   *
+   * @defaultValue true
+   */
+  useWebWorkers?: boolean;
+  /**
+   * `true` to use the native API `CompressionStream`/`DecompressionStream` to compress/decompress data.
+   *
+   * @defaultValue true
+   */
+  useCompressionStream?: boolean;
+  /**
+   * `true` to transfer stream ownership to web workers.
+   *
+   * @defaultValue true
+   */
+  transferStreams?: boolean;
+}
+
+/**
+ * Terminates all the web workers
+ */
+export function terminateWorkers(): Promise<void>;
+
+/**
+ * Represents a class implementing `CompressionStream` or `DecompressionStream` interfaces.
+ */
+declare class CodecStream extends TransformStream {}
+
+/**
+ * Returns the MIME type corresponding to a filename extension.
+ *
+ * @param fileExtension the extension of the filename.
+ * @returns The corresponding MIME type.
+ */
+export function getMimeType(fileExtension: string): string;
+
+/**
+ * A `TransformStream`-like temporary buffer returned by a {@link ZipWriterConstructorOptions.createTempStream} factory.
+ */
+export interface TempStream {
+  /**
+   * The writable side, receiving the compressed data of a buffered entry.
+   */
+  writable: WritableStream;
+  /**
+   * The readable side, replayed into the final zip stream once the entry is ready.
+   */
+  readable: ReadableStream;
+  /**
+   * Optional cleanup, called once the entry has been processed (on success, error, or abort) to release any backing resource.
+   */
+  dispose?: () => void | Promise<void>;
+}
+
+/**
+ * Options for {@link createOPFSTempStream}.
+ */
+export interface OPFSTempStreamOptions {
+  /**
+   * Spill a buffered entry to a file once its buffered data exceeds this size, in bytes. Smaller entries stay in memory.
+   *
+   * @defaultValue 1048576
+   */
+  thresholdBytes?: number;
+  /**
+   * Name of the OPFS sub-directory holding the temporary files.
+   *
+   * @defaultValue ".zip.js-temp"
+   */
+  directoryName?: string;
+  /**
+   * Returns (or resolves to) the root `FileSystemDirectoryHandle`. Defaults to `navigator.storage.getDirectory()`.
+   *
+   * Provide it to run inside a worker with a pre-obtained handle, or to test against a mock.
+   */
+  getDirectory?: () => FileSystemDirectoryHandle | Promise<FileSystemDirectoryHandle>;
+}
+
+/**
+ * Builds a {@link ZipWriterConstructorOptions.createTempStream} factory that spills the data of buffered entries to the Origin Private File System (OPFS) instead of keeping it in memory.
+ *
+ * An entry stays in memory until it exceeds `thresholdBytes`, then spills to a temporary OPFS file that is streamed back and deleted afterwards, so peak memory stays bounded on large buffered entries.
+ *
+ * OPFS is a browser/worker feature; feature-detect `navigator.storage.getDirectory` (or pass `getDirectory`) before using it, and let the writer use its in-memory default elsewhere.
+ *
+ * @param options The options.
+ * @returns A factory suitable for {@link ZipWriterConstructorOptions.createTempStream}.
+ */
+export function createOPFSTempStream(options?: OPFSTempStreamOptions): () => Promise<TempStream>;
+
+/**
+ * Represents an instance used to read or write unknown type of data.
+ *
+ * zip.js can handle multiple types of data thanks to a generic API. This feature is based on 2 abstract constructors: {@link Reader} and {@link Writer}.
+ * The classes inheriting from {@link Reader} help to read data from a source of data. The classes inheriting from {@link Writer} help to write data into a destination.
+ */
+export interface Initializable {
+  /**
+   * Initializes the instance asynchronously
+   */
+  init?(): Promise<void>;
+  /**
+   * `true` if the instance is initialized.
+   */
+  initialized?: boolean;
+}
+
+/**
+ * Represents an instance used to read data from a `ReadableStream` instance.
+ */
+export interface ReadableReader {
+  /**
+   * The `ReadableStream` instance.
+   */
+  readable: ReadableStream;
+}
+
+/**
+ * Represents an instance used to read unknown type of data.
+ *
+ * @example
+ * Here is an example of custom {@link Reader} class used to read binary strings:
+ * ```
+ * class BinaryStringReader extends Reader {
+ *
+ *   constructor(binaryString) {
+ *     super();
+ *     this.binaryString = binaryString;
+ *   }
+ *
+ *   init() {
+ *     super.init();
+ *     this.size = this.binaryString.length;
+ *   }
+ *
+ *   readUint8Array(offset, length) {
+ *     const result = new Uint8Array(length);
+ *     for (let indexCharacter = 0; indexCharacter < length; indexCharacter++) {
+ *       result[indexCharacter] = this.binaryString.charCodeAt(indexCharacter + offset) & 0xFF;
+ *     }
+ *     return result;
+ *   }
+ * }
+ * ```
+ */
+export class Reader<Type> implements Initializable, ReadableReader {
+  /**
+   * Creates the {@link Reader} instance
+   *
+   * @param value The data to read.
+   */
+  constructor(value: Type);
+  /**
+   * The `ReadableStream` instance.
+   */
+  readable: ReadableStream;
+  /**
+   * The total size of the data in bytes.
+   */
+  size: number;
+  /**
+   * Initializes the instance asynchronously
+   */
+  init?(): Promise<void>;
+  /**
+   * Reads a chunk of data
+   *
+   * @param index The byte index of the data to read.
+   * @param length The length of the data to read in bytes.
+   * @returns A promise resolving to a chunk of data. The data must be trucated to the remaining size if the requested length is larger than the remaining size.
+   */
+  readUint8Array(index: number, length: number): Promise<Uint8Array>;
+}
+
+/**
+ * Represents a {@link Reader} instance used to read data provided as a `string`.
+ */
+export class TextReader extends Reader<string> {}
+
+/**
+ * Represents a {@link Reader} instance used to read data provided as a `Blob` instance.
+ */
+export class BlobReader extends Reader<Blob> {}
+
+/**
+ * Represents a {@link Reader} instance used to read data provided as a Data URI `string` encoded in Base64.
+ */
+export class Data64URIReader extends Reader<string> {}
+
+/**
+ * Represents a {@link Reader} instance used to read data provided as a `Uint8Array` instance.
+ */
+export class Uint8ArrayReader extends Reader<Uint8Array> {}
+
+/**
+ * Represents a {@link Reader} instance used to read data provided as an array of {@link ReadableReader} instances (e.g. split zip files).
+ */
+export class SplitDataReader extends Reader<
+  Reader<unknown>[] | ReadableReader[] | ReadableStream[]
+> {}
+
+/**
+ * Represents a URL stored into a `string`.
+ */
+type URLString = string;
+
+/**
+ * Represents a {@link Reader} instance used to fetch data from a URL.
+ */
+export class HttpReader extends Reader<URLString> {
+  /**
+   * Creates the {@link HttpReader} instance
+   *
+   * @param url The URL of the data.
+   * @param options The options.
+   */
+  constructor(url: URLString | URL, options?: HttpOptions);
+}
+
+/**
+ * Represents a {@link Reader} instance used to fetch data from servers returning `Accept-Ranges` headers.
+ */
+export class HttpRangeReader extends HttpReader {
+  /**
+   * Creates the {@link HttpRangeReader} instance.  It is particularly useful for reading ZIP files via HTTP.
+   * If you just want to add content retrieved via HTTP to a ZIP file, you can simply use
+   * `Response#body` {@link https://developer.mozilla.org/en-US/docs/Web/API/Response/body} instead.
+   *
+   * @param url The URL of the data.
+   * @param options The options.
+   */
+  constructor(url: URLString | URL, options?: HttpRangeOptions);
+}
+
+/**
+ * Represents the options passed to the constructor of {@link HttpReader}.
+ */
+export interface HttpOptions extends HttpRangeOptions {
+  /**
+   * `true` to use `Range` headers when fetching data from servers returning `Accept-Ranges` headers.
+   *
+   * @defaultValue false
+   */
+  useRangeHeader?: boolean;
+  /**
+   * `true` to always use `Range` headers when fetching data.
+   *
+   * @defaultValue false
+   */
+  forceRangeRequests?: boolean;
+  /**
+   * `true` to prevent using `HEAD` HTTP request in order the get the size of the content.
+   * `false` to explicitly use `HEAD`, this is useful in case of CORS where `Access-Control-Expose-Headers: Content-Range` is not returned by the server.
+   *
+   * @defaultValue false
+   */
+  preventHeadRequest?: boolean;
+  /**
+   * `true` to use `Range: bytes=-22` on the first request and cache the EOCD, make sure beforehand that the server supports a suffix range request.
+   *
+   * @defaultValue false
+   */
+  combineSizeEocd?: boolean;
+}
+
+/**
+ * Represents options passed to the constructor of {@link HttpRangeReader} and {@link HttpReader}.
+ */
+export interface HttpRangeOptions {
+  /**
+   * `true` to rely `XMLHttpRequest` instead of `fetch` to fetch data.
+   *
+   * @defaultValue false
+   */
+  useXHR?: boolean;
+  /**
+   * The function used to fetch the data. It takes precedence over {@link HttpRangeOptions#useXHR}
+   * when set. The returned object must expose the `status`, `statusText` and `headers` properties,
+   * and the `arrayBuffer()` method of the `Response` class.
+   *
+   * @defaultValue `fetch`
+   */
+  fetch?(input: string, init?: RequestInit): Promise<Response>;
+  /**
+   * The HTTP headers.
+   */
+  headers?: Iterable<[string, string]> | Map<string, string>;
+}
+
+/**
+ * Represents an instance used to write data into a `WritableStream` instance.
+ */
+export interface WritableWriter {
+  /**
+   * The `WritableStream` instance.
+   */
+  writable: WritableStream;
+  /**
+   * The maximum size of split data when creating a {@link ZipWriter} instance or when calling {@link FileEntry#getData} with a generator of {@link WritableWriter} instances.
+   */
+  maxSize?: number;
+}
+
+/**
+ * Represents an instance used to write unknown type of data.
+ *
+ * @example
+ * Here is an example of custom {@link Writer} class used to write binary strings:
+ * ```
+ * class BinaryStringWriter extends Writer {
+ *
+ *   constructor() {
+ *     super();
+ *     this.binaryString = "";
+ *   }
+ *
+ *   writeUint8Array(array) {
+ *     for (let indexCharacter = 0; indexCharacter < array.length; indexCharacter++) {
+ *       this.binaryString += String.fromCharCode(array[indexCharacter]);
+ *     }
+ *   }
+ *
+ *   getData() {
+ *     return this.binaryString;
+ *   }
+ * }
+ * ```
+ */
+export class Writer<Type> implements Initializable, WritableWriter {
+  /**
+   * The `WritableStream` instance.
+   */
+  writable: WritableStream;
+  /**
+   * Initializes the instance asynchronously
+   *
+   * @param size the total size of the written data in bytes.
+   */
+  init?(size?: number): Promise<void>;
+  /**
+   * Appends a chunk of data
+   *
+   * @param array The chunk data to append.
+   *
+   * @virtual
+   */
+  writeUint8Array(array: Uint8Array): Promise<void>;
+  /**
+   * Retrieves all the written data
+   *
+   * @returns A promise resolving to the written data.
+   */
+  getData(): Promise<Type>;
+}
+
+/**
+ * Represents a {@link Writer} instance used to retrieve the written data as a `string`.
+ */
+export class TextWriter extends Writer<string> {
+  /**
+   * Creates the {@link TextWriter} instance
+   *
+   * @param encoding The encoding of the text.
+   */
+  constructor(encoding?: string);
+}
+
+/**
+ * Represents a {@link WritableWriter} instance used to retrieve the written data as a `Blob` instance.
+ */
+export class BlobWriter implements Initializable, WritableWriter {
+  /**
+   * The `WritableStream` instance.
+   */
+  writable: WritableStream;
+  /**
+   * Initializes the instance asynchronously
+   */
+  init(): Promise<void>;
+  /**
+   * Creates the {@link BlobWriter} instance
+   *
+   * @param mimeString The MIME type of the content.
+   */
+  constructor(mimeString?: string);
+  /**
+   * Retrieves all the written data
+   *
+   * @returns A promise resolving to the written data.
+   */
+  getData(): Promise<Blob>;
+}
+
+/**
+ * Represents a {@link Writer} instance used to retrieve the written data as a Data URI `string` encoded in Base64.
+ */
+export class Data64URIWriter extends Writer<string> {
+  /**
+   * Creates the {@link Data64URIWriter} instance
+   *
+   * @param mimeString The MIME type of the content.
+   */
+  constructor(mimeString?: string);
+}
+
+/**
+ * Represents a {@link Writer}  instance used to retrieve the written data from a generator of {@link WritableWriter}  instances  (i.e. split zip files).
+ */
+export class SplitDataWriter implements Initializable, WritableWriter {
+  /**
+   * The `WritableStream` instance.
+   */
+  writable: WritableStream;
+  /**
+   * The number of the disk being written.
+   */
+  diskNumber: number;
+  /**
+   * The byte offset of the disk being written.
+   */
+  diskOffset: number;
+  /**
+   * The maximum size of each disk in bytes.
+   */
+  maxSize: number;
+  /**
+   * The number of bytes still available on the disk being written.
+   */
+  availableSize: number;
+  /**
+   * Initializes the instance asynchronously
+   */
+  init(): Promise<void>;
+  /**
+   * Creates the {@link SplitDataWriter} instance
+   *
+   * @param writerGenerator A generator of Writer instances.
+   * @param maxSize The maximum size of the data written into {@link Writer} instances (default: 4GB).
+   */
+  constructor(
+    writerGenerator: AsyncGenerator<
+      Writer<unknown> | WritableWriter | WritableStream,
+      boolean
+    >,
+    maxSize?: number
+  );
+}
+
+/**
+ * Represents a {@link Writer} instance used to retrieve the written data as a `Uint8Array` instance.
+ */
+export class Uint8ArrayWriter extends Writer<Uint8Array<ArrayBuffer>> {
+  /**
+   * Creates the {@link Uint8ArrayWriter} instance
+   *
+   * @param defaultBufferSize The initial size of the internal buffer (default: 256KB).
+   */
+  constructor(defaultBufferSize?: number);
+}
+
+/**
+ * Represents an instance used to create an unzipped stream.
+ *
+ * @example
+ * This example will take a zip file, decompress it and then save its files and directories to disk.
+ * ```
+ * import {resolve} from "https://deno.land/std/path/mod.ts";
+ * import {ensureDir, ensureFile} from "https://deno.land/std/fs/mod.ts";
+ *
+ * for await (const entry of (await fetch(urlToZippedFile)).body.pipeThrough(new ZipReaderStream())) {
+ *   const fullPath = resolve(destination, entry.filename);
+ *   if (entry.directory) {
+ *     await ensureDir(fullPath);
+ *     continue;
+ *   }
+ *
+ *   await ensureFile(fullPath);
+ *   await entry.readable?.pipeTo((await Deno.create(fullPath)).writable);
+ * }
+ * ```
+ */
+export class ZipReaderStream<T> {
+  /**
+   * Creates the stream.
+   *
+   * @param options The options.
+   */
+  constructor(options?: ZipReaderConstructorOptions);
+
+  /**
+   * The readable stream.
+   */
+  readable: ReadableStream<
+    Omit<Entry, "getData"> & { readable?: ReadableStream<Uint8Array> }
+  >;
+
+  /**
+   * The writable stream.
+   */
+  writable: WritableStream<T>;
+}
+
+/**
+ * Represents an instance used to read a zip file.
+ *
+ * @example
+ * Here is an example showing how to read the text data of the first entry from a zip file:
+ * ```
+ * // create a BlobReader to read with a ZipReader the zip from a Blob object
+ * const reader = new zip.ZipReader(new zip.BlobReader(blob));
+ *
+ * // get all entries from the zip
+ * const entries = await reader.getEntries();
+ * if (entries.length) {
+ *
+ *   // get first entry content as text by using a TextWriter
+ *   const text = await entries[0].getData(
+ *     // writer
+ *     new zip.TextWriter(),
+ *     // options
+ *     {
+ *       onprogress: (index, max) => {
+ *         // onprogress callback
+ *       }
+ *     }
+ *   );
+ *   // text contains the entry data as a String
+ *   console.log(text);
+ * }
+ *
+ * // close the ZipReader
+ * await reader.close();
+ * ```
+ */
+export class ZipReader<Type> {
+  /**
+   * Creates the instance
+   *
+   * @param reader The {@link Reader} instance used to read data.
+   * @param options The options.
+   */
+  constructor(
+    reader:
+      | Reader<Type>
+      | ReadableReader
+      | ReadableStream
+      | Reader<unknown>[]
+      | ReadableReader[]
+      | ReadableStream[],
+    options?: ZipReaderConstructorOptions
+  );
+  /**
+   * The global comment of the zip file.
+   */
+  comment: Uint8Array;
+  /**
+   * The data prepended before the zip file.
+   */
+  prependedData?: Uint8Array;
+  /**
+   * The data appended after the zip file.
+   */
+  appendedData?: Uint8Array;
+  /**
+   * Returns all the entries in the zip file
+   *
+   * @param options The options.
+   * @returns A promise resolving to an `array` of {@link Entry} instances.
+   */
+  getEntries(options?: ZipReaderGetEntriesOptions): Promise<Entry[]>;
+  /**
+   * Returns a generator used to iterate on all the entries in the zip file
+   *
+   * @param options The options.
+   * @returns An asynchronous generator of {@link Entry} instances.
+   */
+  getEntriesGenerator(
+    options?: ZipReaderGetEntriesOptions
+  ): AsyncGenerator<Entry, boolean>;
+  /**
+   * Closes the zip file
+   */
+  close(): Promise<void>;
+}
+
+/**
+ * Represents the options passed to the constructor of {@link ZipReader}, and `{@link ZipDirectory}#import*`.
+ */
+export interface ZipReaderConstructorOptions
+  extends ZipReaderOptions,
+    GetEntriesOptions,
+    WorkerConfiguration {
+  /**
+   * `true` to extract the prepended data into {@link ZipReader#prependedData}.
+   *
+   * @defaultValue false
+   */
+  extractPrependedData?: boolean;
+  /**
+   * `true` to extract the appended data into {@link ZipReader#appendedData}.
+   *
+   * @defaultValue false
+   */
+  extractAppendedData?: boolean;
+}
+
+/**
+ * Represents the options passed to {@link ZipReader#getEntries} and {@link ZipReader#getEntriesGenerator}.
+ */
+export interface ZipReaderGetEntriesOptions
+  extends GetEntriesOptions,
+    EntryOnprogressOptions {}
+
+/**
+ * Represents options passed to the constructor of {@link ZipReader}, {@link ZipReader#getEntries} and {@link ZipReader#getEntriesGenerator}.
+ */
+export interface GetEntriesOptions {
+  /**
+   * The encoding of the filename of the entry.
+   */
+  filenameEncoding?: string;
+  /**
+   * The encoding of the comment of the entry.
+   */
+  commentEncoding?: string;
+  /**
+   * The function called for decoding the filename and the comment of the entry.
+   *
+   * @param value The raw text value.
+   * @param encoding The encoding of the text.
+   * @returns The decoded text value or `undefined` if the raw text value should be decoded by zip.js.
+   */
+  decodeText?(value: Uint8Array, encoding: string): string | undefined;
+  /**
+   * `true` to throw an {@link ERR_AMBIGUOUS_ARCHIVE} error when the archive could be parsed differently by other
+   * tools. This detects data before or after the zip structure (e.g. a self-extracting archive stub or a
+   * concatenated archive), central directory records not accounted for by the end of central directory record, an
+   * end of central directory record disagreeing with its zip64 counterpart, and duplicate filenames. When reading
+   * the content of an entry, it also validates the local file header against the central directory record (see
+   * {@link ZipReaderOptions#checkAmbiguity}).
+   *
+   * @defaultValue false
+   */
+  checkAmbiguity?: boolean;
+  /**
+   * How tolerant the reader should be when the archive can be parsed in more than one way.
+   *
+   * - `"strict"`: reject anything another tool could interpret differently. The end of central directory
+   * record must sit exactly at the end of the file, no data may precede the zip structure, and the local file
+   * headers must agree with the central directory records. Equivalent to {@link GetEntriesOptions#checkAmbiguity}
+   * set to `true`.
+   * - `"balanced"`: select the last end of central directory record whose comment reaches the end of the file
+   * and that points to a central directory, ignore stale records left by in-place updates as well as records
+   * forged inside a comment, and tolerate a self-extracting stub or up to
+   * {@link GetEntriesOptions#maxAppendedDataSize} bytes of appended data. Throw an {@link ERR_AMBIGUOUS_ARCHIVE}
+   * error only when two or more records reach the end of the file and each points to a central directory, which
+   * cannot be disambiguated. A record that reaches the end of the file but points to no central directory (an
+   * empty archive) is only selected when no record points to one.
+   * - `"tolerant"`: never reject a parseable archive, except when {@link GetEntriesOptions#maxAppendedDataSize}
+   * is set explicitly and exceeded; recover by selecting the last end of central directory record that reaches
+   * the end of the file and points to a central directory (or, failing that, the last one that reaches the end
+   * of the file).
+   *
+   * @defaultValue "balanced"
+   */
+  strictness?: "strict" | "balanced" | "tolerant";
+  /**
+   * The maximum number of bytes tolerated after the zip structure before the archive is rejected. Defaults to
+   * `0` when {@link GetEntriesOptions#strictness} is `"strict"`, `65535` when it is `"balanced"`, and `Infinity`
+   * when it is `"tolerant"`.
+   *
+   * An explicit value takes precedence over the strictness default at every level, so it can loosen `"strict"`
+   * or reintroduce a rejection under `"tolerant"`. It also bounds how far back the end of central directory
+   * record is searched for, so a value smaller than the amount of data actually appended surfaces an
+   * {@link ERR_EOCDR_NOT_FOUND} error when the record lies beyond the searched region and an
+   * {@link ERR_AMBIGUOUS_ARCHIVE} error otherwise.
+   */
+  maxAppendedDataSize?: number;
+}
+
+/**
+ * Represents options passed to the constructor of {@link ZipReader} and {@link FileEntry#getData}.
+ */
+export interface ZipReaderOptions {
+  /**
+   * How tolerant the reader should be when the local file header of an entry disagrees with its central
+   * directory record. `"strict"` throws an {@link ERR_AMBIGUOUS_ARCHIVE} error (equivalent to
+   * {@link ZipReaderOptions#checkAmbiguity} set to `true`); `"balanced"` and `"tolerant"` trust the central
+   * directory record.
+   *
+   * @defaultValue "balanced"
+   */
+  strictness?: "strict" | "balanced" | "tolerant";
+  /**
+   * `true` to throw an {@link ERR_AMBIGUOUS_ARCHIVE} error when calling {@link FileEntry#getData} if the local
+   * file header of the entry disagrees with its central directory record in a way that could make other tools
+   * (e.g. streaming readers based on local file headers) interpret the entry differently. This detects mismatched
+   * filenames, general purpose bit flags (encryption, data descriptor and language encoding flags), compression
+   * methods, signatures and sizes. The extra fields are not compared because the zip specification allows them
+   * to differ.
+   *
+   * @defaultValue false
+   */
+  checkAmbiguity?: boolean;
+  /**
+   * `true` to check only if the password is valid.
+   *
+   * @defaultValue false
+   */
+  checkPasswordOnly?: boolean;
+  /**
+   * `true` to check the signature of the entry.
+   *
+   * @defaultValue false
+   */
+  checkSignature?: boolean;
+  /**
+   * `true` to throw an {@link ERR_OVERLAPPING_ENTRY} error when calling {@link FileEntry#getData} if the entry
+   *  overlaps with another entry on which {@link FileEntry#getData} has already been called (with the option
+   * `checkOverlappingEntry` or  `checkOverlappingEntryOnly` set to `true`).
+   *
+   * @defaultValue false
+   */
+  checkOverlappingEntry?: boolean;
+  /**
+   * `true` to throw an {@link ERR_OVERLAPPING_ENTRY} error when calling {@link FileEntry#getData} if the entry
+   *  overlaps with another entry on which {@link FileEntry#getData} has already been called (with the option
+   * `checkOverlappingEntry` or  `checkOverlappingEntryOnly` set to `true`) without trying to read the content of the
+   * entry.
+   *
+   * @defaultValue false
+   */
+  checkOverlappingEntryOnly?: boolean;
+  /**
+   * The password used to decrypt the content of the entry.
+   */
+  password?: string;
+  /**
+   * `true` to read the data as-is without decompressing it and without decrypting it.
+   */
+  passThrough?: boolean;
+  /**
+   * The password used to encrypt the content of the entry (raw).
+   */
+  rawPassword?: Uint8Array;
+  /**
+   * The `AbortSignal` instance used to cancel the decompression.
+   */
+  signal?: AbortSignal;
+  /**
+   * `true` to prevent closing of {@link Writer#writable} when calling {@link FileEntry#getData}.
+   *
+   * @defaultValue false
+   */
+  preventClose?: boolean;
+}
+
+/**
+ * Represents the parsed general purpose bit flag of an entry.
+ */
+export interface EntryBitFlag {
+  /**
+   * The compression option bits.
+   */
+  level: number;
+  /**
+   * `true` if the entry data is followed by a data descriptor.
+   */
+  dataDescriptor: boolean;
+  /**
+   * `true` if the filename and the comment are encoded in UTF-8 (EFS).
+   */
+  languageEncodingFlag: boolean;
+}
+/**
+ * Represents an extra field record of an entry.
+ */
+export interface EntryExtraField {
+  /**
+   * The type (header id) of the extra field.
+   */
+  type: number;
+  /**
+   * The data of the extra field.
+   */
+  data: Uint8Array;
+}
+/**
+ * Represents the AES extra field record of an entry.
+ */
+export interface EntryExtraFieldAES extends EntryExtraField {
+  /**
+   * The encryption strength (1, 2 or 3).
+   */
+  strength?: number;
+  /**
+   * The compression method stored in the AES extra field.
+   */
+  originalCompressionMethod?: number;
+}
+/**
+ * Represents a Unicode path or comment extra field record of an entry.
+ */
+export interface EntryExtraFieldUnicode extends EntryExtraField {
+  /**
+   * `true` if the extra field is consistent with the entry metadata.
+   */
+  valid?: boolean;
+}
+/**
+ * Represents the local file header fields of an entry, read when getting the entry data.
+ */
+export interface LocalDirectory {
+  /**
+   * The "Version" field.
+   */
+  version: number;
+  /**
+   * `true` if the entry is encrypted.
+   */
+  encrypted: boolean;
+  /**
+   * The general purpose bit flag (raw).
+   */
+  rawBitFlag: number;
+  /**
+   * The general purpose bit flag.
+   */
+  bitFlag: EntryBitFlag;
+  /**
+   * The last modification date (raw).
+   */
+  rawLastModDate: number;
+  /**
+   * The last modification date.
+   */
+  lastModDate: Date;
+  /**
+   * The length of the filename in bytes.
+   */
+  filenameLength: number;
+  /**
+   * The length of the extra field in bytes.
+   */
+  extraFieldLength: number;
+  /**
+   * The extra field (raw).
+   */
+  rawExtraField: Uint8Array;
+  /**
+   * The extra field.
+   */
+  extraField?: Map<number, EntryExtraField>;
+  /**
+   * The signature (CRC32 checksum) of the content.
+   */
+  signature?: number;
+  /**
+   * The compressed size of the content.
+   */
+  compressedSize?: number;
+  /**
+   * The uncompressed size of the content.
+   */
+  uncompressedSize?: number;
+  /**
+   * The compression method.
+   */
+  compressionMethod?: number;
+  /**
+   * The Zip64 extra field.
+   */
+  extraFieldZip64?: EntryExtraField;
+  /**
+   * The AES extra field.
+   */
+  extraFieldAES?: EntryExtraFieldAES;
+  /**
+   * The NTFS extra field.
+   */
+  extraFieldNTFS?: EntryExtraField;
+  /**
+   * The Unix extra field.
+   */
+  extraFieldUnix?: EntryExtraField;
+  /**
+   * The Info-ZIP Unix extra field.
+   */
+  extraFieldInfoZip?: EntryExtraField;
+  /**
+   * The extended timestamp extra field.
+   */
+  extraFieldExtendedTimestamp?: EntryExtraField;
+  /**
+   * The Unicode path extra field.
+   */
+  extraFieldUnicodePath?: EntryExtraFieldUnicode;
+  /**
+   * The Unicode comment extra field.
+   */
+  extraFieldUnicodeComment?: EntryExtraFieldUnicode;
+  /**
+   * The USDZ extra field.
+   */
+  extraFieldUSDZ?: EntryExtraField;
+}
+/**
+ * Represents an error raised while processing an entry, decorated with entry context.
+ */
+export interface EntryError extends Error {
+  /**
+   * `true` if the zip file is corrupted because the entry data could not be written entirely.
+   */
+  corruptedEntry?: boolean;
+  /**
+   * The id of the related {@link ZipEntry} (filesystem API).
+   */
+  entryId?: number;
+}
+/**
+ * Represents the metadata of an entry in a zip file (Core API).
+ */
+export interface EntryMetaData {
+  /**
+   * The byte offset of the entry.
+   */
+  offset: number;
+  /**
+   * The filename of the entry.
+   */
+  filename: string;
+  /**
+   * The filename of the entry (raw).
+   */
+  rawFilename: Uint8Array;
+  /**
+   * `true` if the filename is encoded in UTF-8.
+   */
+  filenameUTF8: boolean;
+  /**
+   * `true` if the entry is an executable file
+   */
+  executable: boolean;
+  /**
+   * `true` if the content of the entry is encrypted.
+   */
+  encrypted: boolean;
+  /**
+   * `true` if the content of the entry is encrypted with the ZipCrypto algorithm.
+   */
+  zipCrypto: boolean;
+  /**
+   * The size of the compressed data in bytes.
+   */
+  compressedSize: number;
+  /**
+   * The size of the decompressed data in bytes.
+   */
+  uncompressedSize: number;
+  /**
+   * The last modification date.
+   */
+  lastModDate: Date;
+  /**
+   * The last access date.
+   */
+  lastAccessDate?: Date;
+  /**
+   * The creation date.
+   */
+  creationDate?: Date;
+  /**
+   * The last modification date (raw).
+   */
+  rawLastModDate: number | bigint;
+  /**
+   * The last access date (raw).
+   */
+  rawLastAccessDate?: number | bigint;
+  /**
+   * The creation date (raw).
+   */
+  rawCreationDate?: number | bigint;
+  /**
+   * The comment of the entry.
+   */
+  comment: string;
+  /**
+   * The comment of the entry (raw).
+   */
+  rawComment: Uint8Array;
+  /**
+   * `true` if the comment is encoded in UTF-8.
+   */
+  commentUTF8: boolean;
+  /**
+   * The signature (CRC32 checksum) of the content.
+   */
+  signature: number;
+  /**
+   * The extra field.
+   */
+  extraField?: Map<number, { type: number; data: Uint8Array }>;
+  /**
+   * The extra field (raw).
+   */
+  rawExtraField: Uint8Array;
+  /**
+   * `true` if the entry is using Zip64.
+   */
+  zip64: boolean;
+  /**
+   * The "Version" field.
+   */
+  version: number;
+  /**
+   * The "Version made by" field.
+   */
+  versionMadeBy: number;
+  /**
+   * `true` if `internalFileAttributes` and `externalFileAttributes` are compatible with MS-DOS format.
+   */
+  msDosCompatible: boolean;
+  /**
+   * Note (MS-DOS / Unix attributes):
+   *
+   * - The single source of truth for on-disk metadata is the 32-bit `externalFileAttributes` value stored in
+   *   the ZIP headers. The upper 16 bits are commonly used for Unix `st_mode` (type/permissions/special bits)
+   *   and the low 8 bits for MS-DOS attribute flags.
+   *
+   * - Writer vs Reader:
+   *   - The writer composes `externalFileAttributes` from the provided options (`externalFileAttributes`,
+   *     `unixMode`/special flags, `msdosAttributesRaw`/`msdosAttributes`).
+   *   - The reader decodes the stored `externalFileAttributes` and exposes convenience fields such as
+   *     `msdosAttributesRaw`, `msdosAttributes`, `unixExternalUpper`, and `unixMode`.
+   *
+   * - Practical rule: treat `externalFileAttributes` as authoritative; other fields are conveniences derived
+   *   from it. If you need a specific on-disk value, set `externalFileAttributes` explicitly.
+   */
+  /**
+   * The MS-DOS attributes low byte (raw).
+   * This is the low 8 bits of {@link EntryMetaData#externalFileAttributes} when present.
+   */
+  msdosAttributesRaw?: number;
+  /**
+   * The MS-DOS attribute flags exposed as booleans.
+   */
+  msdosAttributes?: {
+    readOnly: boolean;
+    hidden: boolean;
+    system: boolean;
+    directory: boolean;
+    archive: boolean;
+  };
+  /**
+   * Unix owner id when available.
+   */
+  uid?: number;
+  /**
+   * Unix group id when available.
+   */
+  gid?: number;
+  /**
+   * Unix mode (st_mode) when available.
+   */
+  unixMode?: number;
+  /**
+   * `true` if the setuid bit is set on the entry.
+   */
+  setuid?: boolean;
+  /**
+   * `true` if the setgid bit is set on the entry.
+   */
+  setgid?: boolean;
+  /**
+   * `true` if the sticky bit is set on the entry.
+   */
+  sticky?: boolean;
+  /**
+   * The internal file attributes (raw).
+   */
+  internalFileAttributes: number;
+  /**
+   * The 32-bit `externalFileAttributes` field is the authoritative on-disk metadata for each entry.
+   * - Upper 16 bits: Unix mode/type (e.g., permissions, file type)
+   * - Low 8 bits: MS-DOS file attributes (e.g., directory, read-only)
+   *
+   * When writing, all provided options are merged into this field. When reading, convenience fields are decoded from it.
+   * For most use cases, prefer the high-level options and fields; only advanced users need to manipulate the raw value directly.
+   */
+  externalFileAttributes: number;
+  /**
+   * The upper 16-bit portion of {@link EntryMetaData#externalFileAttributes} when it represents Unix mode bits.
+   */
+  unixExternalUpper?: number;
+  /**
+   * The number of the disk where the entry data starts.
+   */
+  /**
+   * The internal file attribute (raw).
+   * @deprecated Use {@link EntryMetaData#internalFileAttributes} instead.
+   */
+  internalFileAttribute: number;
+  /**
+   * The external file attribute (raw).
+   * @deprecated Use {@link EntryMetaData#externalFileAttributes} instead.
+   */
+  externalFileAttribute: number;
+  /**
+   * The number of the disk where the entry data starts.
+   */
+  diskNumberStart: number;
+  /**
+   * The compression method.
+   */
+  compressionMethod: number;
+  /**
+   * The general purpose bit flag (raw).
+   */
+  rawBitFlag?: number;
+  /**
+   * The general purpose bit flag.
+   */
+  bitFlag?: EntryBitFlag;
+  /**
+   * The length of the filename in bytes.
+   */
+  filenameLength?: number;
+  /**
+   * The length of the extra field in bytes.
+   */
+  extraFieldLength?: number;
+  /**
+   * The Zip64 extra field.
+   */
+  extraFieldZip64?: EntryExtraField;
+  /**
+   * The AES extra field.
+   */
+  extraFieldAES?: EntryExtraFieldAES;
+  /**
+   * The NTFS extra field.
+   */
+  extraFieldNTFS?: EntryExtraField;
+  /**
+   * The Unix extra field.
+   */
+  extraFieldUnix?: EntryExtraField;
+  /**
+   * The Info-ZIP Unix extra field.
+   */
+  extraFieldInfoZip?: EntryExtraField;
+  /**
+   * The extended timestamp extra field.
+   */
+  extraFieldExtendedTimestamp?: EntryExtraField;
+  /**
+   * The Unicode path extra field.
+   */
+  extraFieldUnicodePath?: EntryExtraFieldUnicode;
+  /**
+   * The Unicode comment extra field.
+   */
+  extraFieldUnicodeComment?: EntryExtraFieldUnicode;
+  /**
+   * The USDZ extra field.
+   */
+  extraFieldUSDZ?: EntryExtraField;
+  /**
+   * The local file header fields, set when the entry data has been read.
+   */
+  localDirectory?: LocalDirectory;
+}
+export interface DirectoryEntry extends EntryMetaData {
+  /**
+   * `true` if the entry is a directory.
+   */
+  directory: true;
+}
+
+export interface FileEntry extends EntryMetaData {
+  /**
+   * `false` if the entry is a file.
+   */
+  directory: false;
+  /**
+   * Returns the content of the entry
+   *
+   * @param writer The {@link Writer} instance used to write the content of the entry.
+   * @param options The options.
+   * @returns A promise resolving to the type to data associated to `writer`.
+   */
+  getData<Type>(
+    writer:
+      | Writer<Type>
+      | WritableWriter
+      | WritableStream
+      | AsyncGenerator<
+          Writer<unknown> | WritableWriter | WritableStream,
+          boolean
+        >,
+    options?: EntryGetDataCheckPasswordOptions
+  ): Promise<Type>;
+  /**
+   * Retrieves the content of the entry as an `ArrayBuffer` instance
+   *
+   * @param options The options.
+   * @returns A promise resolving to an `ArrayBuffer` instance.
+   */
+  arrayBuffer(options?: EntryGetDataOptions): Promise<ArrayBuffer>;
+}
+
+/**
+ * Represents an entry with its data and metadata in a zip file (Core API).
+ * This is a union type of {@link DirectoryEntry} and {@link FileEntry}.
+ *
+ * Before using getData, you should check if the entry is a file.
+ *
+ * @example
+ *
+ * ```ts
+ * for await (const entry of reader.getEntriesGenerator()) {
+ *   if (entry.directory) continue;
+ *
+ *   // entry is a FileEntry
+ *   const plainTextData = await entry.getData(new TextWriter());
+ *
+ *   // Do something with the plainTextData
+ * }
+ * ```
+ */
+export type Entry = DirectoryEntry | FileEntry;
+
+/**
+ * Represents the options passed to {@link FileEntry#getData} and `{@link ZipFileEntry}.get*`.
+ */
+export interface EntryGetDataOptions
+  extends EntryDataOnprogressOptions,
+    ZipReaderOptions,
+    WorkerConfiguration {}
+
+/**
+ * Represents the options passed to {@link FileEntry#getData} and `{@link ZipFileEntry}.get*`.
+ */
+export interface EntryGetDataCheckPasswordOptions extends EntryGetDataOptions {}
+
+/**
+ * Represents an instance used to create a zipped stream.
+ *
+ * @example
+ * This example creates a zipped file called numbers.txt.zip containing the numbers 0 - 1000 each on their own line.
+ * ```
+ * const readable = ReadableStream.from((function* () {
+ *   for (let i = 0; i < 1000; ++i)
+ *     yield i + '\n'
+ * })())
+ *
+ * readable
+ *   .pipeThrough(new ZipWriterStream().transform('numbers.txt'))
+ *   .pipeTo((await Deno.create('numbers.txt.zip')).writable)
+ * ```
+ *
+ * @example
+ * This example creates a zipped file called Archive.zip containing two files called numbers.txt and letters.txt
+ * ```
+ * const readable1 = ReadableStream.from((function* () {
+ *   for (let i = 0; i < 1000; ++i)
+ *     yield i + '\n'
+ * })())
+ * const readable2 = ReadableStream.from((function* () {
+ *   const letters = 'abcdefghijklmnopqrstuvwxyz'.split('')
+ *   while (letters.length)
+ *     yield letters.shift() + '\n'
+ * })())
+ *
+ * const zipper = new ZipWriterStream()
+ * zipper.readable.pipeTo((await Deno.create('Archive.zip')).writable)
+ * readable1.pipeTo(zipper.writable('numbers.txt'))
+ * readable2.pipeTo(zipper.writable('letters.txt'))
+ * zipper.close()
+ * ```
+ */
+export class ZipWriterStream {
+  /**
+   * Creates the stream.
+   *
+   * @param options The options.
+   */
+  constructor(options?: ZipWriterConstructorOptions);
+
+  /**
+   * The readable stream.
+   */
+  readable: ReadableStream<Uint8Array>;
+
+  /**
+   * The ZipWriter property.
+   */
+  zipWriter: ZipWriter<unknown>;
+
+  /**
+   * Returns an object containing a readable and writable property for the .pipeThrough method
+   *
+   * @param path The name of the stream when unzipped. Paths must use forward slashes ("/") as
+   * separator (see {@link ZipWriter#add}).
+   * @returns An object containing readable and writable properties
+   */
+  transform<T>(path: string): {
+    readable: ReadableStream<T>;
+    writable: WritableStream<T>;
+  };
+
+  /**
+   * Returns a WritableStream for the .pipeTo method
+   *
+   * @param path The directory path of where the stream should exist in the zipped stream. Paths
+   * must use forward slashes ("/") as separator (see {@link ZipWriter#add}).
+   * @returns A WritableStream.
+   */
+  writable<T>(path: string): WritableStream<T>;
+
+  /**
+   * Writes the entries directory, writes the global comment, and returns the content of the zipped file.
+   *
+   * @param comment The global comment of the zip file.
+   * @param options The options.
+   * @returns The content of the zip file.
+   */
+  close(
+    comment?: Uint8Array,
+    options?: ZipWriterCloseOptions
+  ): Promise<unknown>;
+}
+
+/**
+ * Represents an instance used to create a zip file.
+ *
+ * @example
+ * Here is an example showing how to create a zip file containing a compressed text file:
+ * ```
+ * // use a BlobWriter to store with a ZipWriter the zip into a Blob object
+ * const blobWriter = new zip.BlobWriter("application/zip");
+ * const writer = new zip.ZipWriter(blobWriter);
+ *
+ * // use a TextReader to read the String to add
+ * await writer.add("filename.txt", new zip.TextReader("test!"));
+ *
+ * // close the ZipReader
+ * await writer.close();
+ *
+ * // get the zip file as a Blob
+ * const blob = await blobWriter.getData();
+ * ```
+ */
+export class ZipWriter<Type> {
+  /**
+   * Creates the {@link ZipWriter} instance
+   *
+   * @param writer The {@link Writer} instance where the zip content will be written.
+   * @param options The options.
+   */
+  constructor(
+    writer:
+      | Writer<Type>
+      | WritableWriter
+      | WritableStream
+      | AsyncGenerator<
+          Writer<unknown> | WritableWriter | WritableStream,
+          boolean
+        >,
+    options?: ZipWriterConstructorOptions
+  );
+  /**
+   * `true` if the zip contains at least one entry that has been partially written.
+   */
+  readonly hasCorruptedEntries?: boolean;
+
+  /**
+   * Adds an existing zip file at the beginning of the current zip. This method
+   * cannot be called after the first call to {@link ZipWriter#add}.
+   *
+   * @param reader The {@link Reader} instance used to read the content of the zip file.
+   * @returns A promise resolving when the zip file has been added.
+   */
+  prependZip<ReaderType>(
+    reader:
+      | Reader<ReaderType>
+      | ReadableReader
+      | ReadableStream
+      | Reader<unknown>[]
+      | ReadableReader[]
+      | ReadableStream[]
+  ): Promise<void>;
+
+  /**
+   * Adds an entry into the zip file
+   *
+   * @param filename The filename of the entry. Paths must use forward slashes ("/") as separator,
+   * as required by section 4.4.17.1 of the zip specification. The value is stored as-is; in
+   * particular, Windows path separators ("\\") are not converted and become part of the filename,
+   * which is interpreted inconsistently by zip tools.
+   * @param reader The  {@link Reader} instance used to read the content of the entry.
+   * @param options The options.
+   * @returns A promise resolving to an {@link EntryMetaData} instance.
+   */
+  add<ReaderType>(
+    filename: string,
+    reader?:
+      | Reader<ReaderType>
+      | ReadableReader
+      | ReadableStream
+      | Reader<unknown>[]
+      | ReadableReader[]
+      | ReadableStream[],
+    options?: ZipWriterAddDataOptions
+  ): Promise<EntryMetaData>;
+
+  /**
+   * 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.
+   * @returns `true` if the entry has been removed, `false` otherwise.
+   */
+  remove(entry: Entry | string): boolean;
+
+  /**
+   * Writes the entries directory, writes the global comment, and returns the content of the zip file
+   *
+   * @param comment The global comment of the zip file.
+   * @param options The options.
+   * @returns The content of the zip file.
+   */
+  close(comment?: Uint8Array, options?: ZipWriterCloseOptions): Promise<Type>;
+}
+
+/**
+ * Represents the options passed to {@link ZipWriter#add}.
+ */
+export interface ZipWriterAddDataOptions
+  extends ZipWriterConstructorOptions,
+    EntryDataOnprogressOptions,
+    WorkerConfiguration {
+  /**
+   * `true` if the entry is a directory.
+   *
+   * @defaultValue false
+   */
+  directory?: boolean;
+  /**
+   * `true` if the entry is an executable file.
+   *
+   * @defaultValue false
+   */
+  executable?: boolean;
+  /**
+   * The comment of the entry.
+   */
+  comment?: string;
+  /**
+   * The extra field of the entry.
+   */
+  extraField?: Map<number, Uint8Array>;
+  /**
+   * The uncompressed size of the entry. This option is ignored if the {@link ZipWriterConstructorOptions#passThrough} option is not set to `true`.
+   */
+  uncompressedSize?: number;
+  /**
+   * The signature (CRC32 checksum) of the content. This option is ignored if the {@link ZipWriterConstructorOptions#passThrough} option is not set to `true`.
+   */
+  signature?: number;
+}
+
+/**
+ * Represents the options passed to  {@link ZipWriter#close}.
+ */
+export interface ZipWriterCloseOptions extends EntryOnprogressOptions {
+  /**
+   * `true` to use Zip64 to write the entries directory.
+   *
+   * @defaultValue false
+   */
+  zip64?: boolean;
+  /**
+   * `true` to prevent closing of {@link WritableWriter#writable}.
+   *
+   * @defaultValue false
+   */
+  preventClose?: boolean;
+}
+
+/**
+ * Represents options passed to the constructor of {@link ZipWriter}, {@link ZipWriter#add} and `{@link ZipDirectoryEntry}#export*`.
+ */
+export interface ZipWriterConstructorOptions extends WorkerConfiguration {
+  /**
+   * `true` to use Zip64 to store the entry.
+   *
+   * `zip64` is automatically set to `true` when necessary (e.g. compressed data larger than 4GB or with unknown size).
+   *
+   * @defaultValue false
+   */
+  zip64?: boolean;
+  /**
+   * `true` to prevent closing of {@link WritableWriter#writable}.
+   *
+   * @defaultValue false
+   */
+  preventClose?: boolean;
+  /**
+   * The level of compression.
+   *
+   * The minimum value is 0 and means that no compression is applied. The maximum value is 9.
+   *
+   * @defaultValue 6
+   */
+  level?: number;
+  /**
+   * `true` to write entry data in a buffer before appending it to the zip file.
+   *
+   * `bufferedWrite` is automatically set to `true` when compressing more than one entry in parallel.
+   *
+   * @defaultValue false
+   */
+  bufferedWrite?: boolean;
+  /**
+   * An async factory function that returns a `TransformStream`-like object (`{ writable, readable }`) used as a temporary buffer when entries are written in parallel.
+   *
+   * When provided, this replaces the default in-memory `TransformStream` buffer, allowing data to be stored externally (e.g. filesystem, OPFS, network).
+   * The `writable` side receives compressed entry data. The `readable` side is consumed when the entry is replayed into the final zip stream.
+   * The optional `dispose` method is called once the entry has been processed (on success, error, or abort) so a resource-backed buffer can release its resource.
+   *
+   * See {@link createOPFSTempStream} for a ready-made OPFS-backed implementation.
+   */
+  createTempStream?: () => TempStream | Promise<TempStream>;
+  /**
+   * `true` to keep the order of the entry physically in the zip file.
+   *
+   * When set to `true`, the use of web workers will be improved.
+   *
+   * @defaultValue true
+   */
+  keepOrder?: boolean;
+  /**
+   * The password used to encrypt the content of the entry.
+   */
+  password?: string;
+  /**
+   * The password used to encrypt the content of the entry (raw).
+   */
+  rawPassword?: Uint8Array;
+  /**
+   * The encryption strength (AES):
+   * - 1: 128-bit encryption key
+   * - 2: 192-bit encryption key
+   * - 3: 256-bit encryption key
+   *
+   * @defaultValue 3
+   */
+  encryptionStrength?: 1 | 2 | 3;
+  /**
+   * The `AbortSignal` instance used to cancel the compression.
+   */
+  signal?: AbortSignal;
+  /**
+   * The last modification date.
+   *
+   * @defaultValue The current date.
+   */
+  lastModDate?: Date;
+  /**
+   * The last access date.
+   *
+   * This option is ignored if the {@link ZipWriterConstructorOptions#extendedTimestamp} option is set to `false`.
+   *
+   * @defaultValue The current date.
+   */
+  lastAccessDate?: Date;
+  /**
+   * The creation date.
+   *
+   * This option is ignored if the {@link ZipWriterConstructorOptions#extendedTimestamp} option is set to `false`.
+   *
+   * @defaultValue The current date.
+   */
+  creationDate?: Date;
+  /**
+   * `true` to store extended timestamp extra fields.
+   *
+   * When set to `false`, the maximum last modification date cannot exceed November 31, 2107 and the maximum accuracy is 2 seconds.
+   *
+   * @defaultValue true
+   */
+  extendedTimestamp?: boolean;
+  /**
+   * `true` to use the ZipCrypto algorithm to encrypt the content of the entry. Setting it to `true` will also
+   * set the {@link ZipWriterConstructorOptions#dataDescriptor} to `true`.
+   *
+   * It is not recommended to set `zipCrypto` to `true` because the ZipCrypto encryption can be easily broken.
+   *
+   * @defaultValue false
+   */
+  zipCrypto?: boolean;
+  /**
+   * The "Version" field.
+   */
+  version?: number;
+  /**
+   * The "Version made by" field.
+   *
+   * @defaultValue 20
+   */
+  versionMadeBy?: number;
+  /**
+   * `true` to mark the file names as UTF-8 setting the general purpose bit 11 in the header (see Appendix D -
+   * Language Encoding (EFS)), `false` to mark the names as compliant with the original IBM Code Page 437.
+   *
+   * Note that this does not ensure that the file names are in the correct encoding.
+   *
+   * @defaultValue true
+   */
+  useUnicodeFileNames?: boolean;
+  /**
+   * `true` to add a data descriptor.
+   *
+   * When set to `false`, the {@link ZipWriterConstructorOptions#bufferedWrite} option will automatically be
+   * set to `true`. It will be automatically set to `false` when it is `undefined` and the
+   * {@link ZipWriterConstructorOptions#bufferedWrite} option is set to `true`, or when the
+   * {@link ZipWriterConstructorOptions#zipCrypto} option is set to `true`. Otherwise, the default value is `true`.
+   */
+  dataDescriptor?: boolean;
+  /**
+   * `true` to add the signature of the data descriptor.
+   *
+   * @defaultValue true
+   */
+  dataDescriptorSignature?: boolean;
+  /**
+   * `true` to write {@link EntryMetaData#externalFileAttributes} in MS-DOS format for folder entries.
+   *
+   * @defaultValue false
+   */
+  msDosCompatible?: boolean;
+  /**
+   * The external file attribute.
+   *
+   * @defaultValue 0
+   */
+  externalFileAttributes?: number;
+  /**
+   * The Unix owner id to write in the Unix extra field or as part of the external attributes.
+   */
+  uid?: number;
+  /**
+   * The Unix group id to write in the Unix extra field or as part of the external attributes.
+   */
+  gid?: number;
+  /**
+   * The Unix mode (st_mode bits) to use when writing external attributes.
+   */
+  unixMode?: number;
+  /**
+   * `true` to set the setuid bit when writing the Unix mode.
+   */
+  setuid?: boolean;
+  /**
+   * `true` to set the setgid bit when writing the Unix mode.
+   */
+  setgid?: boolean;
+  /**
+   * `true` to set the sticky bit when writing the Unix mode.
+   */
+  sticky?: boolean;
+  /**
+   * 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.
+   */
+  unixExtraFieldType?: "infozip" | "unix";
+  /**
+   * The internal file attribute.
+   *
+   * @defaultValue 0
+   */
+  internalFileAttributes?: number;
+  /**
+   * When provided, the low 8-bit MS-DOS attributes to write into external file attributes.
+   * Must be an integer between 0 and 255.
+   */
+  msdosAttributesRaw?: number;
+  /**
+   * When provided, MS-DOS attribute flags (boolean object) to write into external file attributes low byte.
+   */
+  msdosAttributes?: {
+    readOnly?: boolean;
+    hidden?: boolean;
+    system?: boolean;
+    directory?: boolean;
+    archive?: boolean;
+  };
+  /**
+   * `false` to never write disk numbers in zip64 data.
+   *
+   * @defaultValue true
+   */
+  supportZip64SplitFile?: boolean;
+  /**
+   * `true`to produce zip files compatible with the USDZ specification.
+   *
+   * @defaultValue false
+   */
+  usdz?: boolean;
+  /**
+   * `true` to write the data as-is without compressing it and without crypting it.
+   */
+  passThrough?: boolean;
+  /**
+   * `true` to write encrypted data when `passThrough` is set to `true`.
+   */
+  encrypted?: boolean;
+  /**
+   * The offset of the first entry in the zip file.
+   */
+  offset?: number;
+  /**
+   * The compression method (e.g. 8 for DEFLATE, 0 for STORE).
+   */
+  compressionMethod?: number;
+  /**
+   * The function called for encoding the filename and the comment of the entry.
+   *
+   * @param text The text to encode.
+   * @returns The encoded text or `undefined` if the text should be encoded by zip.js.
+   */
+  encodeText?(text: string): Uint8Array | undefined;
+}
+
+/**
+ * Represents options passed to {@link FileEntry#getData}, {@link ZipWriter.add} and `{@link ZipDirectory}.export*`.
+ */
+export interface EntryDataOnprogressOptions {
+  /**
+   * The function called when starting compression/decompression.
+   *
+   * @param total The total number of bytes.
+   * @returns An empty promise or `undefined`.
+   */
+  onstart?(total: number): Promise<void> | void;
+  /**
+   * The function called during compression/decompression.
+   *
+   * @param progress The current progress in bytes.
+   * @param total The total number of bytes.
+   * @returns An empty promise or `undefined`.
+   */
+  onprogress?(progress: number, total: number): Promise<void> | void;
+  /**
+   * The function called when ending compression/decompression.
+   *
+   * @param computedSize The total number of bytes (computed).
+   * @returns An empty promise or `undefined`.
+   */
+  onend?(computedSize: number): Promise<void> | void;
+}
+
+/**
+ * Represents options passed to {@link ZipReader#getEntries}, {@link ZipReader#getEntriesGenerator}, and {@link ZipWriter#close}.
+ */
+export interface EntryOnprogressOptions {
+  /**
+   * The function called each time an entry is read/written.
+   *
+   * @param progress The entry index.
+   * @param total The total number of entries.
+   * @param entry The entry being read/written.
+   * @returns An empty promise or `undefined`.
+   */
+  onprogress?(
+    progress: number,
+    total: number,
+    entry: EntryMetaData
+  ): Promise<void> | void;
+}
+
+/**
+ * Represents an entry in a zip file (Filesystem API).
+ */
+declare class ZipEntry {
+  /**
+   * The relative filename of the entry.
+   */
+  name: string;
+  /**
+   * The underlying {@link EntryMetaData} instance.
+   */
+  data?: EntryMetaData;
+  /**
+   * The ID of the instance.
+   */
+  id: number;
+  /**
+   * The parent directory of the entry.
+   */
+  parent?: ZipEntry;
+  /**
+   * The uncompressed size of the content.
+   */
+  uncompressedSize: number;
+  /**
+   * The children of the entry.
+   */
+  children: ZipEntry[];
+  /**
+   * Clones the entry
+   *
+   * @param deepClone `true` to clone all the descendants.
+   */
+  clone(deepClone?: boolean): ZipEntry;
+  /**
+   * Returns the full filename of the entry
+   */
+  getFullname(): string;
+  /**
+   * Returns the filename of the entry relative to a parent directory
+   */
+  getRelativeName(ancestor: ZipDirectoryEntry): string;
+  /**
+   * Tests if a {@link ZipDirectoryEntry} instance is an ancestor of the entry
+   *
+   * @param ancestor The {@link ZipDirectoryEntry} instance.
+   */
+  isDescendantOf(ancestor: ZipDirectoryEntry): boolean;
+  /**
+   * Tests if the entry or any of its children is password protected
+   */
+  isPasswordProtected(): boolean;
+  /**
+   * Tests the password on the entry and all children if any, returns `true` if the entry is not password protected
+   */
+  checkPassword(
+    password: string,
+    options?: EntryGetDataOptions
+  ): Promise<boolean>;
+  /**
+   * Set the name of the entry
+   *
+   * @param name The new name of the entry.
+   */
+  rename(name: string): void;
+}
+
+/**
+ * Represents a file entry in the zip (Filesystem API).
+ */
+export class ZipFileEntry<ReaderType, WriterType> extends ZipEntry {
+  /**
+   * `void` for {@link ZipFileEntry} instances.
+   */
+  directory: void;
+  /**
+   * The {@link Reader} instance used to read the content of the entry.
+   */
+  reader:
+    | Reader<ReaderType>
+    | ReadableReader
+    | ReadableStream
+    | Reader<unknown>[]
+    | ReadableReader[]
+    | ReadableStream[];
+  /**
+   * The {@link Writer} instance used to write the content of the entry.
+   */
+  writer:
+    | Writer<WriterType>
+    | WritableWriter
+    | WritableStream
+    | AsyncGenerator<Writer<unknown> | WritableWriter | WritableStream>;
+  /**
+   * Retrieves the text content of the entry as a `string`
+   *
+   * @param encoding The encoding of the text.
+   * @param options The options.
+   * @returns A promise resolving to a `string`.
+   */
+  getText(encoding?: string, options?: EntryGetDataOptions): Promise<string>;
+  /**
+   * Retrieves the content of the entry as a `Blob` instance
+   *
+   * @param mimeType The MIME type of the content.
+   * @param options The options.
+   * @returns A promise resolving to a `Blob` instance.
+   */
+  getBlob(mimeType?: string, options?: EntryGetDataOptions): Promise<Blob>;
+  /**
+   * Retrieves the content of the entry as as a Data URI `string` encoded in Base64
+   *
+   * @param mimeType The MIME type of the content.
+   * @param options The options.
+   * @returns A promise resolving to a Data URI `string` encoded in Base64.
+   */
+  getData64URI(
+    mimeType?: string,
+    options?: EntryGetDataOptions
+  ): Promise<string>;
+  /**
+   * Retrieves the content of the entry as a `Uint8Array` instance
+   *
+   * @param options The options.
+   * @returns A promise resolving to a `Uint8Array` instance.
+   */
+  getUint8Array(options?: EntryGetDataOptions): Promise<Uint8Array>;
+  /**
+   * Retrieves the content of the entry via a `WritableStream` instance
+   *
+   * @param writable The `WritableStream` instance.
+   * @param options The options.
+   * @returns A promise resolving to the `WritableStream` instance.
+   */
+  getWritable(
+    writable?: WritableStream,
+    options?: EntryGetDataOptions
+  ): Promise<WritableStream>;
+  /**
+   * Retrieves the content of the entry via a {@link Writer} instance
+   *
+   * @param writer The {@link Writer} instance.
+   * @param options The options.
+   * @returns A promise resolving to data associated to the {@link Writer} instance.
+   */
+  getData<Type>(
+    writer:
+      | Writer<unknown>
+      | WritableWriter
+      | WritableStream
+      | AsyncGenerator<Writer<unknown> | WritableWriter | WritableStream>,
+    options?: EntryGetDataOptions
+  ): Promise<Type>;
+  /**
+   * Retrieves the content of the entry as an `ArrayBuffer` instance
+   *
+   * @param options The options.
+   * @returns A promise resolving to an `ArrayBuffer` instance.
+   */
+  getArrayBuffer(options?: EntryGetDataOptions): Promise<ArrayBuffer>;
+  /**
+   * Replaces the content of the entry with a `Blob` instance
+   *
+   * @param blob The `Blob` instance.
+   */
+  replaceBlob(blob: Blob): void;
+  /**
+   * Replaces the content of the entry with a `string`
+   *
+   * @param text The `string`.
+   */
+  replaceText(text: string): void;
+  /**
+   * Replaces the content of the entry with a Data URI `string` encoded in Base64
+   *
+   * @param dataURI The Data URI `string` encoded in Base64.
+   */
+  replaceData64URI(dataURI: string): void;
+  /**
+   * Replaces the content of the entry with a `Uint8Array` instance
+   *
+   * @param array The `Uint8Array` instance.
+   */
+  replaceUint8Array(array: Uint8Array): void;
+  /**
+   * Replaces the content of the entry with a `ReadableStream` instance
+   *
+   * @param readable The `ReadableStream` instance.
+   */
+  replaceReadable(readable: ReadableStream): void;
+}
+
+/**
+ * Represents a directory entry in the zip (Filesystem API).
+ */
+export class ZipDirectoryEntry extends ZipEntry {
+  /**
+   * `true` for  {@link ZipDirectoryEntry} instances.
+   */
+  directory: true;
+  /**
+   * Gets a {@link ZipEntry} child instance from its relative filename
+   *
+   * @param name The relative filename.
+   * @returns A {@link ZipFileEntry} or a {@link ZipDirectoryEntry} instance (use the {@link ZipFileEntry#directory} and {@link ZipDirectoryEntry#directory} properties to differentiate entries).
+   */
+  getChildByName(name: string): ZipEntry | undefined;
+  /**
+   * Adds a directory
+   *
+   * @param name The relative filename of the directory.
+   * @param options The options.
+   * @returns A {@link ZipDirectoryEntry} instance.
+   */
+  addDirectory(
+    name: string,
+    options?: ZipWriterAddDataOptions
+  ): ZipDirectoryEntry;
+  /**
+   * Adds an entry with content provided as text
+   *
+   * @param name The relative filename of the entry.
+   * @param text The text.
+   * @param options The options.
+   * @returns A {@link ZipFileEntry} instance.
+   */
+  addText(
+    name: string,
+    text: string,
+    options?: ZipWriterAddDataOptions
+  ): ZipFileEntry<string, string>;
+  /**
+   * Adds a entry entry with content provided as a `Blob` instance
+   *
+   * @param name The relative filename of the entry.
+   * @param blob The `Blob` instance.
+   * @param options The options.
+   * @returns A {@link ZipFileEntry} instance.
+   */
+  addBlob(
+    name: string,
+    blob: Blob,
+    options?: ZipWriterAddDataOptions
+  ): ZipFileEntry<Blob, Blob>;
+  /**
+   * Adds a entry entry with content provided as a Data URI `string` encoded in Base64
+   *
+   * @param name The relative filename of the entry.
+   * @param dataURI The Data URI `string` encoded in Base64.
+   * @param options The options.
+   * @returns A {@link ZipFileEntry} instance.
+   */
+  addData64URI(
+    name: string,
+    dataURI: string,
+    options?: ZipWriterAddDataOptions
+  ): ZipFileEntry<string, string>;
+  /**
+   * Adds an entry with content provided as a `Uint8Array` instance
+   *
+   * @param name The relative filename of the entry.
+   * @param array The `Uint8Array` instance.
+   * @param options The options.
+   * @returns A {@link ZipFileEntry} instance.
+   */
+  addUint8Array(
+    name: string,
+    array: Uint8Array,
+    options?: ZipWriterAddDataOptions
+  ): ZipFileEntry<Uint8Array, Uint8Array>;
+  /**
+   * Adds an entry with content fetched from a URL
+   *
+   * @param name The relative filename of the entry.
+   * @param url The URL.
+   * @param options The options.
+   * @returns A {@link ZipFileEntry} instance.
+   */
+  addHttpContent(
+    name: string,
+    url: string,
+    options?: HttpOptions & ZipWriterAddDataOptions
+  ): ZipFileEntry<string, void>;
+  /**
+   * Adds a entry entry with content provided via a `ReadableStream` instance
+   *
+   * @param name The relative filename of the entry.
+   * @param readable The `ReadableStream` instance.
+   * @param options The options.
+   * @returns A {@link ZipFileEntry} instance.
+   */
+  addReadable(
+    name: string,
+    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
+   *
+   * @param fileSystemEntry The `FileSystemEntry` instance.
+   * @param options The options.
+   * @returns A promise resolving to an array of {@link ZipFileEntry} or a {@link ZipDirectoryEntry} instances.
+   */
+  addFileSystemEntry(
+    fileSystemEntry: FileSystemEntryLike,
+    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 an array of {@link ZipFileEntry} or a {@link ZipDirectoryEntry} instances.
+   */
+  addFileSystemHandle(
+    fileSystemHandle: FileSystemHandleLike,
+    options?: ZipWriterAddDataOptions
+  ): Promise<ZipEntry[]>;
+  /**
+   * Extracts a zip file provided as a `Blob` instance into the entry
+   *
+   * @param blob The `Blob` instance.
+   * @param options  The options.
+   */
+  importBlob(
+    blob: Blob,
+    options?: ZipReaderConstructorOptions
+  ): Promise<[ZipEntry]>;
+  /**
+   * Extracts a zip file provided as a Data URI `string` encoded in Base64 into the entry
+   *
+   * @param dataURI The Data URI `string` encoded in Base64.
+   * @param options  The options.
+   */
+  importData64URI(
+    dataURI: string,
+    options?: ZipReaderConstructorOptions
+  ): Promise<[ZipEntry]>;
+  /**
+   * Extracts a zip file provided as a `Uint8Array` instance into the entry
+   *
+   * @param array The `Uint8Array` instance.
+   * @param options  The options.
+   */
+  importUint8Array(
+    array: Uint8Array,
+    options?: ZipReaderConstructorOptions
+  ): Promise<[ZipEntry]>;
+  /**
+   * Extracts a zip file fetched from a URL into the entry
+   *
+   * @param url The URL.
+   * @param options  The options.
+   */
+  importHttpContent(
+    url: string,
+    options?: ZipDirectoryEntryImportHttpOptions
+  ): Promise<[ZipEntry]>;
+  /**
+   * Extracts a zip file provided via a `ReadableStream` instance into the entry
+   *
+   * @param readable The `ReadableStream` instance.
+   * @param options  The options.
+   */
+  importReadable(
+    readable: ReadableStream,
+    options?: ZipReaderConstructorOptions
+  ): Promise<[ZipEntry]>;
+  /**
+   * Extracts a zip file provided via a custom {@link Reader} instance into the entry
+   *
+   * @param reader The {@link Reader} instance.
+   * @param options  The options.
+   */
+  importZip(
+    reader:
+      | Reader<unknown>
+      | ReadableReader
+      | ReadableStream
+      | Reader<unknown>[]
+      | ReadableReader[]
+      | ReadableStream[],
+    options?: ZipReaderConstructorOptions
+  ): Promise<[ZipEntry]>;
+  /**
+   * Returns a `Blob` instance containing a zip file of the entry and its descendants
+   *
+   * @param options  The options.
+   * @returns A promise resolving to the `Blob` instance.
+   */
+  exportBlob(options?: ZipDirectoryEntryExportOptions): Promise<Blob>;
+  /**
+   * Returns a Data URI `string` encoded in Base64 containing a zip file of the entry and its descendants
+   *
+   * @param options  The options.
+   * @returns A promise resolving to the Data URI `string` encoded in Base64.
+   */
+  exportData64URI(options?: ZipDirectoryEntryExportOptions): Promise<string>;
+  /**
+   * Returns a `Uint8Array` instance containing a zip file of the entry and its descendants
+   *
+   * @param options  The options.
+   * @returns A promise resolving to the `Uint8Array` instance.
+   */
+  exportUint8Array(
+    options?: ZipDirectoryEntryExportOptions
+  ): Promise<Uint8Array>;
+  /**
+   * Creates a zip file via a `WritableStream` instance containing the entry and its descendants
+   *
+   * @param writable The `WritableStream` instance.
+   * @param options  The options.
+   * @returns A promise resolving to the `Uint8Array` instance.
+   */
+  exportWritable(
+    writable?: WritableStream,
+    options?: ZipDirectoryEntryExportOptions
+  ): Promise<WritableStream>;
+  /**
+   * Writes the entry and its descendants into a directory as files and sub-directories via the File System Access API (e.g. the Origin Private File System). Files are streamed and directories are merged into the target; colliding files are overwritten. This is the inverse of {@link ZipDirectoryEntry#addFileSystemHandle}.
+   *
+   * @param directoryHandle The target `FileSystemDirectoryHandle` instance.
+   * @param options The options.
+   * @returns A promise resolving to the target `FileSystemDirectoryHandle` instance.
+   */
+  exportFileSystemHandle(
+    directoryHandle: FileSystemDirectoryHandle,
+    options?: ZipDirectoryEntryExportFileSystemHandleOptions
+  ): Promise<FileSystemDirectoryHandle>;
+  /**
+   * Creates a zip file via a custom {@link Writer} instance containing the entry and its descendants
+   *
+   * @param writer The {@link Writer} instance.
+   * @param options  The options.
+   * @returns A promise resolving to the data.
+   */
+  exportZip(
+    writer:
+      | Writer<unknown>
+      | WritableWriter
+      | WritableStream
+      | AsyncGenerator<Writer<unknown> | WritableWriter | WritableStream>,
+    options?: ZipDirectoryEntryExportOptions
+  ): Promise<unknown>;
+}
+
+/**
+ * Represents the options passed to {@link ZipDirectoryEntry#importHttpContent}.
+ */
+export interface ZipDirectoryEntryImportHttpOptions
+  extends ZipReaderConstructorOptions,
+    HttpOptions {}
+
+/**
+ * Represents the options passed to `{@link ZipDirectoryEntry}#export*()`.
+ */
+export interface ZipDirectoryEntryExportOptions
+  extends ZipWriterConstructorOptions,
+    EntryDataOnprogressOptions {
+  /**
+   * `true` to use filenames relative to the entry instead of full filenames.
+   */
+  relativePath?: boolean;
+  /**
+   * The MIME type of the exported data when relevant.
+   */
+  mimeType?: string;
+  /**
+   * The options passed to the Reader instances
+   */
+  readerOptions?: ZipReaderConstructorOptions;
+}
+
+/**
+ * Represents the options passed to {@link ZipDirectoryEntry#exportFileSystemHandle} and {@link FS#exportFileSystemHandle}.
+ */
+export interface ZipDirectoryEntryExportFileSystemHandleOptions
+  extends EntryGetDataOptions {
+  /**
+   * `true` to write independent files concurrently instead of one after another.
+   *
+   * @defaultValue false
+   */
+  concurrent?: boolean;
+}
+
+/**
+ * Represents a Filesystem instance.
+ *
+ * @example
+ * Here is an example showing how to create and read a zip file containing a compressed text file:
+ * ```
+ * const TEXT_CONTENT = "Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat.";
+ * const FILENAME = "lorem.txt";
+ * const BLOB = new Blob([TEXT_CONTENT], { type: zip.getMimeType(FILENAME) });
+ * let zipFs = new zip.fs.FS();
+ * zipFs.addBlob("lorem.txt", BLOB);
+ * const zippedBlob = await zipFs.exportBlob();
+ * zipFs = new zip.fs.FS();
+ * await zipFs.importBlob(zippedBlob);
+ * const firstEntry = zipFs.children[0];
+ * const unzippedBlob = await firstEntry.getBlob(zip.getMimeType(firstEntry.name));
+ * ```
+ */
+export interface FS
+  extends Pick<
+    ZipDirectoryEntry,
+    | "getChildByName"
+    | "addDirectory"
+    | "addText"
+    | "addBlob"
+    | "addData64URI"
+    | "addUint8Array"
+    | "addHttpContent"
+    | "addReadable"
+    | "addFile"
+    | "addFileSystemEntry"
+    | "addFileSystemHandle"
+    | "importBlob"
+    | "importData64URI"
+    | "importUint8Array"
+    | "importHttpContent"
+    | "importReadable"
+    | "importZip"
+    | "exportBlob"
+    | "exportData64URI"
+    | "exportUint8Array"
+    | "exportWritable"
+    | "exportFileSystemHandle"
+    | "exportZip"
+    | "isPasswordProtected"
+    | "checkPassword"
+  > {}
+
+export class FS {
+  /**
+   * The root directory.
+   */
+  root: ZipDirectoryEntry;
+  /**
+   * The array of all the {@link ZipEntry} instances indexed by {@link ZipEntry#id}.
+   */
+  entries: (ZipEntry | null)[];
+  /**
+   * The children of the root directory.
+   */
+  readonly children: ZipEntry[];
+  /**
+   * Removes a {@link ZipEntry} instance and its children
+   *
+   * @param entry The {@link ZipEntry} instance to remove.
+   */
+  remove(entry: ZipEntry): void;
+  /**
+   * Moves a {@link ZipEntry} instance and its children into a {@link ZipDirectoryEntry} instance
+   *
+   * @param entry The {@link ZipEntry} instance to move.
+   * @param destination The {@link ZipDirectoryEntry} instance.
+   */
+  move(entry: ZipEntry, destination: ZipDirectoryEntry): void;
+  /**
+   * Returns a {@link ZipEntry} instance from its full filename
+   *
+   * @param fullname The full filename.
+   * @returns The {@link ZipEntry} instance.
+   */
+  find(fullname: string): ZipEntry | undefined;
+  /**
+   * Returns a {@link ZipEntry} instance from the value of {@link ZipEntry#id}
+   *
+   * @param id The id of the {@link ZipEntry} instance.
+   * @returns The {@link ZipEntry} instance.
+   */
+  getById(id: number): ZipEntry | undefined;
+}
+
+/**
+ * The Filesystem API.
+ */
+export const fs: {
+  /**
+   * The Filesystem constructor.
+   *
+   * @defaultValue {@link FS}
+   */
+  FS: typeof FS;
+  /**
+   * The {@link ZipDirectoryEntry} constructor.
+   *
+   * @defaultValue {@link ZipDirectoryEntry}
+   */
+  ZipDirectoryEntry: typeof ZipDirectoryEntry;
+  /**
+   * The {@link ZipFileEntry} constructor.
+   *
+   * @defaultValue {@link ZipFileEntry}
+   */
+  ZipFileEntry: typeof ZipFileEntry;
+};
+
+// The error messages.
+/**
+ * HTTP range error
+ */
+export const ERR_HTTP_RANGE: string;
+/**
+ * Zip format error
+ */
+export const ERR_BAD_FORMAT: string;
+/**
+ * End of Central Directory Record not found error
+ */
+export const ERR_EOCDR_NOT_FOUND: string;
+/**
+ * Zip64 End of Central Directory Locator not found error
+ */
+export const ERR_EOCDR_LOCATOR_ZIP64_NOT_FOUND: string;
+/**
+ * Central Directory not found error
+ */
+export const ERR_CENTRAL_DIRECTORY_NOT_FOUND: string;
+/**
+ * Local file header not found error
+ */
+export const ERR_LOCAL_FILE_HEADER_NOT_FOUND: string;
+/**
+ * Extra field Zip64 not found error
+ */
+export const ERR_EXTRAFIELD_ZIP64_NOT_FOUND: string;
+/**
+ * Encrypted entry error
+ */
+export const ERR_ENCRYPTED: string;
+/**
+ * Unsupported encryption error
+ */
+export const ERR_UNSUPPORTED_ENCRYPTION: string;
+/**
+ * Unsupported compression error
+ */
+export const ERR_UNSUPPORTED_COMPRESSION: string;
+/**
+ * Invalid signature error
+ */
+export const ERR_INVALID_SIGNATURE: string;
+/**
+ * Invalid uncompressed size error
+ */
+export const ERR_INVALID_UNCOMPRESSED_SIZE: string;
+/**
+ * Invalid compressed data error
+ */
+export const ERR_INVALID_COMPRESSED_DATA: string;
+/**
+ * Invalid password error
+ */
+export const ERR_INVALID_PASSWORD: string;
+/**
+ * Duplicate entry error
+ */
+export const ERR_DUPLICATED_NAME: string;
+/**
+ * Invalid comment error
+ */
+export const ERR_INVALID_COMMENT: string;
+/**
+ * Invalid entry name error
+ */
+export const ERR_INVALID_ENTRY_NAME: string;
+/**
+ * Invalid entry comment error
+ */
+export const ERR_INVALID_ENTRY_COMMENT: string;
+/**
+ * Invalid version error
+ */
+export const ERR_INVALID_VERSION: string;
+/**
+ * Invalid extra field type error
+ */
+export const ERR_INVALID_EXTRAFIELD_TYPE: string;
+/**
+ * Invalid extra field data error
+ */
+export const ERR_INVALID_EXTRAFIELD_DATA: string;
+/**
+ * Invalid encryption strength error
+ */
+export const ERR_INVALID_ENCRYPTION_STRENGTH: string;
+/**
+ * Invalid format error
+ */
+export const ERR_UNSUPPORTED_FORMAT: string;
+/**
+ * Split zip file error
+ */
+export const ERR_SPLIT_ZIP_FILE: string;
+/**
+ * Overlapping entry error
+ */
+export const ERR_OVERLAPPING_ENTRY: string;
+/**
+ * Ambiguous archive error
+ *
+ * @remarks The thrown error carries a `reason` property describing the ambiguity: `"appended data"`, `"prepended data"`, `"trailing central directory data"`, `"mismatched zip64 end of central directory record"`, or `"duplicate filename"`.
+ */
+export const ERR_AMBIGUOUS_ARCHIVE: string;
+/**
+ * Iteration completed too soon error
+ */
+export const ERR_ITERATOR_COMPLETED_TOO_SOON: string;
+/**
+ * Undefined uncompressed size error
+ */
+export const ERR_UNDEFINED_UNCOMPRESSED_SIZE: string;
+/**
+ * Undefined reader error
+ */
+export const ERR_UNDEFINED_READER: string;
+/**
+ * Writer not initialized error
+ */
+export const ERR_WRITER_NOT_INITIALIZED: string;
+/**
+ * Zip file not empty error
+ */
+export const ERR_ZIP_NOT_EMPTY: string;