@zip.js/zip.js 2.7.73 → 2.8.0

package/index.d.ts

@@ -214,75 +214,56 @@ export interface Configuration extends WorkerConfiguration {
    */
   terminateWorkerTimeout?: number;
   /**
-   * The URIs of the compression/decompression scripts run in web workers.
+   * 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 Blob URI.
-   * The properties `deflate` and `inflate` must specify arrays of URLs to import the deflate/inflate web workers, respectively.
-   * The first URL is relative to the base URI of the document. The other URLs are relative to the URL of the first script. Scripts in the array are executed in order.
-   * If you only use deflation or inflation, the unused `deflate`/`inflate` property can be omitted.
+   * 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:
    * ```
    * configure({
-   *   workerScripts: {
-   *     deflate: ["library_path/custom-worker.js", "./custom-deflate.js"],
-   *     inflate: ["library_path/custom-worker.js", "./custom-inflate.js"]
-   *   }
+   *   workerURI: "./custom-deflate.js"
    * });
    * ```
    *
-   * If the CSP of the page blocks scripts imported from a Blob URI you can use `z-worker.js` from https://github.com/gildas-lormeau/zip.js/tree/master/dist and specify the URL where it can be found.
+   * @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:
-   * ```
-   * configure({
-   *   workerScripts: {
-   *     deflate: ["library_path/z-worker.js"],
-   *     inflate: ["library_path/z-worker.js"]
-   *   }
-   * });
-   * ```
+   * @defaultValue "./core/streams/zlib/zlib-streams.wasm"
    */
-  workerScripts?: {
-    /**
-     * The URIs of the scripts implementing used for compression.
-     */
-    deflate?: string[];
-    /**
-     * The URIs of the scripts implementing used for decompression.
-     */
-    inflate?: string[];
-  };
+  wasmURI?: string;
   /**
    * The size of the chunks in bytes during data compression/decompression.
    *
-   * @defaultValue 524288
+   * @defaultValue 65536
    */
   chunkSize?: number;
   /**
-   * The codec implementation used to compress data.
+   * The stream implementation used to compress data when `useCompressionStream` is set to `true`.
    *
-   * @defaultValue {@link ZipDeflate}
+   * @defaultValue {@link CodecStream}
    */
-  Deflate?: typeof ZipDeflate;
+  CompressionStream?: typeof TransformStreamLike;
   /**
-   * The codec implementation used to decompress data.
+   * The stream implementation used to decompress data when `useCompressionStream` is set to `true`.
    *
-   * @defaultValue {@link ZipInflate}
+   * @defaultValue {@link CodecStream}
    */
-  Inflate?: typeof ZipInflate;
+  DecompressionStream?: typeof TransformStreamLike;
   /**
    * The stream implementation used to compress data when `useCompressionStream` is set to `false`.
    *
    * @defaultValue {@link CodecStream}
    */
-  CompressionStream?: typeof TransformStreamLike;
+  CompressionStreamZlib?: typeof TransformStreamLike;
   /**
    * The stream implementation used to decompress data when `useCompressionStream` is set to `false`.
    *
    * @defaultValue {@link CodecStream}
    */
-  DecompressionStream?: typeof TransformStreamLike;
+  DecompressionStreamZlib?: typeof TransformStreamLike;
 }
 
 /**
@@ -303,128 +284,11 @@ export interface WorkerConfiguration {
   useCompressionStream?: boolean;
 }
 
-/**
- * Transforms event-based third-party codec implementations into implementations compatible with zip.js
- *
- * @param library The third-party codec implementations.
- * @param constructorOptions The options passed to the third-party implementations when building instances.
- * @param registerDataHandler The function called to handle the `data` events triggered by a third-party codec implementation.
- * @returns An instance containing classes compatible with {@link ZipDeflate} and {@link ZipInflate}.
- */
-export function initShimAsyncCodec(
-  library: EventBasedZipLibrary,
-  constructorOptions: unknown | null,
-  registerDataHandler: registerDataHandler
-): ZipLibrary;
-
-/**
- * Represents the callback function used to register the `data` event handler.
- */
-export interface registerDataHandler {
-  /**
-   * @param codec The third-party codec instance.
-   * @param onData The `data` event handler.
-   */
-  (codec: EventBasedCodec, onData: dataHandler): void;
-}
-
-/**
- * Represents the callback function used to handle `data` events.
- */
-export interface dataHandler {
-  /**
-   * @param data The processed chunk of data.
-   */
-  (data: Uint8Array): void;
-}
-
 /**
  * Terminates all the web workers
  */
 export function terminateWorkers(): Promise<void>;
 
-/**
- * Represents event-based implementations used to compress/decompress data.
- */
-export interface EventBasedZipLibrary {
-  /**
-   * The class used to compress data.
-   */
-  Deflate: typeof EventBasedCodec;
-  /**
-   * The class used to decompress data.
-   */
-  Inflate: typeof EventBasedCodec;
-}
-
-/**
- * Represents an event-based implementation of a third-party codec.
- */
-declare class EventBasedCodec {
-  /**
-   * Appends a chunk of data to compress/decompress
-   *
-   * @param data The chunk of data to append.
-   */
-  push(data: Uint8Array): void;
-  /**
-   * The function called when a chunk of data has been compressed/decompressed.
-   *
-   * @param data The chunk of compressed/decompressed data.
-   */
-  ondata(data?: Uint8Array): void;
-}
-
-/**
- * Represents the implementations zip.js uses to compress/decompress data.
- */
-export interface ZipLibrary {
-  /**
-   * The class used to compress data.
-   *
-   * @defaultValue {@link ZipDeflate}
-   */
-  Deflate: typeof ZipDeflate;
-  /**
-   * The class used to decompress data.
-   *
-   * @defaultValue {@link ZipInflate}
-   */
-  Inflate: typeof ZipInflate;
-}
-
-declare class SyncCodec {
-  /**
-   * Appends a chunk of decompressed data to compress
-   *
-   * @param data The chunk of decompressed data to append.
-   * @returns A chunk of compressed data.
-   */
-  append(data: Uint8Array): Uint8Array;
-}
-
-/**
- * Represents an instance used to compress data.
- */
-declare class ZipDeflate extends SyncCodec {
-  /**
-   * Flushes the data
-   *
-   * @returns A chunk of compressed data.
-   */
-  flush(): Uint8Array;
-}
-
-/**
- * Represents a codec used to decompress data.
- */
-declare class ZipInflate extends SyncCodec {
-  /**
-   * Flushes the data
-   */
-  flush(): void;
-}
-
 /**
  * Represents a class implementing `CompressionStream` or `DecompressionStream` interfaces.
  */
@@ -538,13 +402,6 @@ export class Data64URIReader extends Reader<string> {}
  */
 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).
- *
- * @deprecated Use {@link SplitDataReader} instead.
- */
-export class SplitZipReader extends SplitDataReader {}
-
 /**
  * Represents a {@link Reader} instance used to read data provided as an array of {@link ReadableReader} instances (e.g. split zip files).
  */
@@ -748,13 +605,6 @@ export class Data64URIWriter extends Writer<string> {
   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).
- *
- * @deprecated Use {@link SplitDataWriter} instead.
- */
-export class SplitZipWriter extends SplitDataWriter {}
-
 /**
  * Represents a {@link Writer}  instance used to retrieve the written data from a generator of {@link WritableWriter}  instances  (i.e. split zip files).
  */
@@ -1045,10 +895,6 @@ export interface EntryMetaData {
    * `true` if the filename is encoded in UTF-8.
    */
   filenameUTF8: boolean;
-  /**
-   * `true` if the entry is a directory.
-   */
-  directory: boolean;
   /**
    * `true` if the entry is an executable file
    */
@@ -1163,12 +1009,17 @@ export interface EntryMetaData {
    */
   compressionMethod: number;
 }
-export interface DirectoryEntry extends Omit<EntryMetaData, "directory"> {
+export interface DirectoryEntry extends EntryMetaData {
+  /**
+   * `true` if the entry is a directory.
+   */
   directory: true;
-  getData?: undefined;
 }
 
-export interface FileEntry extends Omit<EntryMetaData, "directory"> {
+export interface FileEntry extends EntryMetaData {
+  /**
+   * `false` if the entry is a file.
+   */
   directory: false;
   /**
    * Returns the content of the entry

package/index.js

@@ -1,7 +1,7 @@
 /// <reference types="./index.d.ts" />
 
 /*
- Copyright (c) 2022 Gildas Lormeau. All rights reserved.
+ Copyright (c) 2025 Gildas Lormeau. All rights reserved.
 
  Redistribution and use in source and binary forms, with or without
  modification, are permitted provided that the following conditions are met:
@@ -28,65 +28,4 @@
  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-import { Deflate } from "./lib/core/streams/codecs/deflate.js";
-import { Inflate } from "./lib/core/streams/codecs/inflate.js";
-import { configure } from "./lib/core/configuration.js";
-import { getMimeType } from "./lib/core/util/mime-type.js";
-import { terminateWorkers } from "./lib/core/codec-pool.js";
-
-configure({ Deflate, Inflate });
-
-export {
-	fs,
-	configure,
-	initShimAsyncCodec,
-	ZipReader,
-	ZipWriter,
-	ZipReaderStream,
-	ZipWriterStream,
-	Reader,
-	Writer,
-	TextReader,
-	TextWriter,
-	Data64URIReader,
-	Data64URIWriter,
-	BlobReader,
-	BlobWriter,
-	HttpReader,
-	HttpRangeReader,
-	Uint8ArrayWriter,
-	Uint8ArrayReader,
-	SplitZipReader,
-	SplitZipWriter,
-	SplitDataReader,
-	SplitDataWriter,
-	ERR_HTTP_RANGE,
-	ERR_BAD_FORMAT,
-	ERR_EOCDR_NOT_FOUND,
-	ERR_EOCDR_LOCATOR_ZIP64_NOT_FOUND,
-	ERR_CENTRAL_DIRECTORY_NOT_FOUND,
-	ERR_LOCAL_FILE_HEADER_NOT_FOUND,
-	ERR_EXTRAFIELD_ZIP64_NOT_FOUND,
-	ERR_ENCRYPTED,
-	ERR_UNSUPPORTED_ENCRYPTION,
-	ERR_UNSUPPORTED_COMPRESSION,
-	ERR_INVALID_SIGNATURE,
-	ERR_INVALID_UNCOMPRESSED_SIZE,
-	ERR_INVALID_PASSWORD,
-	ERR_DUPLICATED_NAME,
-	ERR_INVALID_COMMENT,
-	ERR_INVALID_ENTRY_NAME,
-	ERR_INVALID_ENTRY_COMMENT,
-	ERR_INVALID_VERSION,
-	ERR_INVALID_EXTRAFIELD_TYPE,
-	ERR_INVALID_EXTRAFIELD_DATA,
-	ERR_INVALID_ENCRYPTION_STRENGTH,
-	ERR_UNSUPPORTED_FORMAT,
-	ERR_UNDEFINED_UNCOMPRESSED_SIZE,
-	ERR_ZIP_NOT_EMPTY,
-	ERR_SPLIT_ZIP_FILE,
-	ERR_OVERLAPPING_ENTRY,
-	ERR_ITERATOR_COMPLETED_TOO_SOON,
-	ERR_WRITER_NOT_INITIALIZED
-} from "./lib/zip-fs.js";
-export { getMimeType, terminateWorkers };
+export * from "./lib/zip-fs.js";