zip-writer 1.0.1 → 1.1.1

package/README.md

@@ -0,0 +1,427 @@
+# zip-writable
+
+A modern streaming ZIP archive writer for JavaScript that uses the
+[Web Streams API](https://developer.mozilla.org/en-US/docs/Web/API/Streams_API)
+and
+[Compression Streams API](https://developer.mozilla.org/en-US/docs/Web/API/Compression_Streams_API).
+
+## Features
+
+- **Streaming API** - Write ZIP archives using Web Streams
+- **Memory efficient** - Process large files without loading them entirely into
+  memory
+- **ZIP64 support** - Automatic handling of large files and archives
+- **Modern JavaScript** - Built with TypeScript, uses native Web Streams API
+- **Flexible** - Reorder, rename, or remove entries before finalizing
+
+## Installation
+
+```bash
+npm install zip-writable
+```
+
+## Basic Usage
+
+```ts
+import { ZipWriter } from "zip-writable";
+
+const zipWriter = new ZipWriter();
+
+// Pipe the ZIP output somewhere
+zipWriter.readable.pipeTo(writableStream);
+
+// Add entries to the ZIP
+const entryWriter = zipWriter.createEntryStream({ name: "hello.txt" });
+const writer = entryWriter.writable.getWriter();
+await writer.write(new TextEncoder().encode("Hello, World!"));
+await writer.close();
+
+// Get entry info after writing
+const info = await entryWriter.getEntryInfo();
+console.log(info);
+
+// Finalize the ZIP archive
+await zipWriter.finalize();
+```
+
+## API Reference
+
+### `ZipWriter`
+
+The main class for creating ZIP archives.
+
+#### Constructor
+
+##### `new ZipWriter(options?)`
+
+**Parameters:**
+
+- `options.crc32?: (data: Uint8Array, value?: number) => number` - Optional
+  CRC32 function to use. Defaults to `zlib.crc32` on Node.js and a pure
+  JavaScript implementation in browsers.
+
+#### Properties
+
+##### `readable: ReadableStream<Uint8Array>`
+
+The readable stream containing the ZIP archive data. Pipe this to a file, HTTP
+response, or any other writable destination.
+
+```ts
+// Save to file (Node.js with fs/promises)
+import { createWriteStream } from "fs";
+import { Writable } from "stream";
+
+zipWriter.readable.pipeTo(Writable.toWeb(createWriteStream("archive.zip")));
+
+// Send as HTTP response (in a web server)
+return new Response(zipWriter.readable, {
+  headers: {
+    "Content-Type": "application/zip",
+    "Content-Disposition": 'attachment; filename="archive.zip"',
+  },
+});
+```
+
+##### `entries: ReadonlyArray<Readonly<EntryInfo>>`
+
+Array of all entries that have been written to the archive. Each entry contains
+metadata like size, CRC32, compression info, etc.
+
+#### Methods
+
+##### `createEntry(data: Uint8Array, options: EntryOptions): Promise<EntryInfo>`
+
+Convenience method to add a buffer as an entry to the zip archive. Returns a
+promise that resolves to the entry info once written. For more efficient
+streaming writes, use `createEntryStream()`.
+
+**Parameters:**
+
+- `data: Uint8Array` - Entry data to write
+- `options.name: string` - Entry name including internal path (required)
+- `options.comment?: string` - Entry comment
+- `options.date?: Date` - Entry date (defaults to current date)
+- `options.mode?: number` - Entry permissions (Unix-style mode)
+- `options.store?: boolean` - Set to `true` to disable compression (defaults to
+  `false`, using DEFLATE compression)
+
+**Example:**
+
+```ts
+const data = new TextEncoder().encode("Hello, World!");
+const entryInfo = await zipWriter.createEntry(data, { name: "hello.txt" });
+console.log(entryInfo);
+```
+
+##### `createEntryStream(options: EntryOptions): EntryWriter`
+
+Create a new entry in the ZIP archive. Returns an `EntryWriter` that you can
+write data to via streams.
+
+**Parameters:**
+
+- `options.name: string` - Entry name including internal path (required)
+- `options.comment?: string` - Entry comment
+- `options.date?: Date` - Entry date (defaults to current date)
+- `options.mode?: number` - Entry permissions (Unix-style mode)
+- `options.store?: boolean` - Set to `true` to disable compression (defaults to
+  `false`, using DEFLATE compression)
+
+**Examples:**
+
+```ts
+// Simple text file
+const entry = zipWriter.createEntryStream({ name: "readme.txt" });
+const writer = entry.writable.getWriter();
+await writer.write(new TextEncoder().encode("Hello!"));
+await writer.close();
+
+// Stream a fetch response
+const response = await fetch(imageUrl);
+response.body.pipeTo(
+  zipWriter.createEntryStream({ name: "images/photo.jpg" }).writable,
+);
+
+// With custom date and permissions
+zipWriter.createEntryStream({
+  name: "script.sh",
+  date: new Date("2024-01-01"),
+  mode: 0o755, // executable
+}).writable;
+
+// Disable compression for already-compressed files
+zipWriter.createEntryStream({
+  name: "video.mp4",
+  store: true, // no compression
+}).writable;
+```
+
+##### `onceQueueEmpty(): Promise<void>`
+
+Wait until all currently queued entries have been written. Useful when you need
+to ensure entries are complete before continuing.
+
+```ts
+// Add multiple entries
+zipWriter.createEntryStream({ name: "file1.txt" }).writable;
+zipWriter.createEntryStream({ name: "file2.txt" }).writable;
+
+// Wait for all to complete
+await zipWriter.onceQueueEmpty();
+console.log(`Wrote ${zipWriter.entries.length} entries`);
+```
+
+##### `finalize(options?): Promise<{ zip64: boolean, uncompressedEntriesSize: bigint, compressedEntriesSize: bigint, fileSize: bigint }>`
+
+Finalize the ZIP archive by writing the central directory and end of central
+directory records. This must be called after all entries have been added. This
+will await any pending entries to finish writing before finalizing.
+
+**Parameters:**
+
+- `options.entries?: ReadonlyArray<Readonly<EntryInfo>>` - (Advanced) Override
+  the entries to write in the central directory. This can be used to reorder,
+  remove, or rename entries before finalizing the archive. You cannot change the
+  offset, CRC32, compressed size, or uncompressed size of entries - only the
+  name, comment, date, and order.
+
+**Returns:**
+
+- `zip64: boolean` - Whether the archive uses ZIP64 format
+- `uncompressedEntriesSize: bigint` - Total uncompressed size of all entries
+- `compressedEntriesSize: bigint` - Total compressed size of all entries
+- `fileSize: bigint` - Total size of the ZIP file
+
+```ts
+const result = await zipWriter.finalize();
+console.log(`Created ${result.zip64 ? "ZIP64" : "standard"} archive`);
+console.log(`File size: ${result.fileSize} bytes`);
+console.log(
+  `Compression ratio: ${Number(result.compressedEntriesSize) / Number(result.uncompressedEntriesSize)}`,
+);
+```
+
+**Example with entries option:**
+
+```ts
+// Wait for all entries to be written
+await zipWriter.onceQueueEmpty();
+
+// Get current entries and modify them
+const entries = [...zipWriter.entries];
+
+// Remove an entry
+const filtered = entries.filter((e) => e.name !== "temp.txt");
+
+// Rename entries
+const renamed = entries.map((e) => ({
+  ...e,
+  name: e.name.replace(/^old\//, "new/"),
+}));
+
+// Sort entries alphabetically
+const sorted = [...entries].sort((a, b) => a.name.localeCompare(b.name));
+
+// Finalize with modified entries
+await zipWriter.finalize({ entries: sorted });
+```
+
+### `EntryWriter`
+
+Returned by `ZipWriter.createEntryStream()`. Provides a writable stream to write
+entry data.
+
+#### Properties
+
+##### `writable: WritableStream<Uint8Array>`
+
+The writable stream to write entry data to. Close this stream when done writing.
+
+```ts
+const entryWriter = zipWriter.createEntryStream({ name: "data.txt" });
+
+// Using a writer
+const writer = entryWriter.writable.getWriter();
+await writer.write(new TextEncoder().encode("chunk 1"));
+await writer.write(new TextEncoder().encode("chunk 2"));
+await writer.close();
+
+// Using pipeTo
+someReadableStream.pipeTo(entryWriter.writable);
+```
+
+#### Methods
+
+##### `getEntryInfo(): Promise<EntryInfo>`
+
+Get entry info. Resolves once all data has been written to the ZIP stream.
+
+**Returns `EntryInfo`:**
+
+- `name: string` - Entry name
+- `comment?: string` - Entry comment
+- `date?: Date` - Entry date
+- `mode?: number` - Entry permissions
+- `store?: boolean` - Whether compression was disabled
+- `startOffset: bigint | number` - Byte offset in the archive
+- `crc32: number` - CRC32 checksum
+- `uncompressedSize: bigint | number` - Uncompressed size in bytes
+- `compressedSize: bigint | number` - Compressed size in bytes
+- `zip64: boolean` - Whether this entry uses ZIP64 format
+
+```ts
+const entryWriter = zipWriter.createEntryStream({ name: "test.txt" });
+await someStream.pipeTo(entryWriter.writable);
+
+const info = await entryWriter.getEntryInfo();
+console.log(
+  `Wrote ${info.name}: ${info.uncompressedSize} bytes (compressed to ${info.compressedSize})`,
+);
+```
+
+## Complete Example
+
+```ts
+import { ZipWriter } from "zip-writable";
+import { createWriteStream } from "fs";
+import { Writable } from "stream";
+
+async function createZip() {
+  const zipWriter = new ZipWriter();
+
+  // Pipe output to file
+  const fileStream = Writable.toWeb(createWriteStream("output.zip"));
+  zipWriter.readable.pipeTo(fileStream);
+
+  // Add a text file using createEntry
+  const data1 = new TextEncoder().encode("This is a readme");
+  await zipWriter.createEntry(data1, { name: "readme.txt" });
+
+  // Add files from URLs using createEntryStream
+  const imageResponse = await fetch("https://example.com/image.png");
+  await imageResponse.body.pipeTo(
+    zipWriter.createEntryStream({ name: "images/photo.png" }).writable,
+  );
+
+  // Add a JSON file using createEntry
+  const data = { hello: "world" };
+  const jsonData = new TextEncoder().encode(JSON.stringify(data, null, 2));
+  await zipWriter.createEntry(jsonData, { name: "data.json" });
+
+  // Wait for all entries and check results
+  await zipWriter.onceQueueEmpty();
+  console.log(`Added ${zipWriter.entries.length} entries`);
+
+  // Finalize the archive
+  const result = await zipWriter.finalize();
+  console.log(`Created archive: ${result.fileSize} bytes`);
+}
+
+createZip().catch(console.error);
+```
+
+## Browser Usage
+
+```ts
+// Create a ZIP and trigger download
+const zipWriter = new ZipWriter();
+
+// Add entries...
+const data = new TextEncoder().encode("Hello");
+zipWriter
+  .createEntry(data, { name: "file.txt" })
+  .then(() => zipWriter.finalize());
+
+// Create download link
+const blob = await new Response(zipWriter.readable).blob();
+const url = URL.createObjectURL(blob);
+const a = document.createElement("a");
+a.href = url;
+a.download = "archive.zip";
+a.click();
+URL.revokeObjectURL(url);
+```
+
+## Benchmarks
+
+Run using `npm run bench`. On a MacBook Pro (M2 Pro, 2023), Node.js 20.19.0:
+
+### Small files (10 × 10KB)
+
+| Library                       | ops/sec | Relative Speed |
+| ----------------------------- | ------- | -------------- |
+| zip-writable (@node-rs/crc32) | 721.94  | **fastest**    |
+| zip-writable                  | 674.57  | 1.07x slower   |
+| zip-writable (js crc32)       | 659.90  | 1.09x slower   |
+| fflate                        | 553.00  | 1.31x slower   |
+| archiver                      | 338.14  | 2.14x slower   |
+| @zip.js/zip.js                | 279.19  | 2.59x slower   |
+
+### Medium files (100 × 100KB)
+
+| Library                       | ops/sec | Relative Speed |
+| ----------------------------- | ------- | -------------- |
+| zip-writable                  | 23.91   | **fastest**    |
+| zip-writable (@node-rs/crc32) | 22.91   | 1.04x slower   |
+| zip-writable (js crc32)       | 18.93   | 1.26x slower   |
+| archiver                      | 18.10   | 1.32x slower   |
+| @zip.js/zip.js                | 11.65   | 2.05x slower   |
+| fflate                        | 10.27   | 2.33x slower   |
+
+### Large files (5 × 10MB)
+
+| Library                       | ops/sec | Relative Speed |
+| ----------------------------- | ------- | -------------- |
+| zip-writable                  | 7.22    | **fastest**    |
+| zip-writable (@node-rs/crc32) | 6.78    | 1.06x slower   |
+| archiver                      | 5.65    | 1.28x slower   |
+| zip-writable (js crc32)       | 4.82    | 1.50x slower   |
+| fflate                        | 4.20    | 1.72x slower   |
+| @zip.js/zip.js                | 4.00    | 1.81x slower   |
+
+### Many files (1000 × 1KB)
+
+| Library                       | ops/sec | Relative Speed |
+| ----------------------------- | ------- | -------------- |
+| fflate                        | 10.08   | **fastest**    |
+| zip-writable                  | 6.89    | 1.46x slower   |
+| zip-writable (@node-rs/crc32) | 5.94    | 1.70x slower   |
+| zip-writable (js crc32)       | 5.63    | 1.79x slower   |
+| archiver                      | 4.98    | 2.02x slower   |
+| @zip.js/zip.js                | 2.93    | 3.44x slower   |
+
+Note: These benchmarks vary quite a bit, and they aren't an indication that any
+library is "better" than any other. For ZipWriter, these exist as a check to
+ensure that performance isn't significantly worse than other libraries.
+
+## ZIP64 Support
+
+The library automatically uses ZIP64 format when needed:
+
+- Archives with more than 65,535 entries
+- Files larger than 4GB
+- Central directory larger than 4GB
+- Central directory offset greater than 4GB
+
+No special configuration is needed - it's handled automatically.
+
+## Error Handling
+
+```ts
+try {
+  const entryWriter = zipWriter.entry({ name: "test.txt" });
+  await someStream.pipeTo(entryWriter.writable);
+  await entryWriter.getEntryInfo();
+} catch (error) {
+  console.error("Failed to write entry:", error);
+  // The ZIP stream is aborted on error - cannot add more entries
+}
+```
+
+Once an error occurs during entry writing, the ZIP stream is corrupted and
+cannot be recovered. You must create a new `ZipWriter` instance.
+
+## License
+
+MIT

package/dist/constants.d.ts

@@ -18,4 +18,8 @@ export declare const EOCD_SIZE = 22;
 export declare const EOCD64_SIZE = 56;
 export declare const EOCD64_LOCATOR_SIZE = 20;
 export declare const ZIP64_LIMIT: bigint;
+/** Little-endian for DataView methods */
+export declare const LITTLE_ENDIAN = true;
+/** Big-endian for DataView methods */
+export declare const BIG_ENDIAN = false;
 //# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,2BAA2B,aAAa,CAAC;AACtD,eAAO,MAAM,yBAAyB,aAAa,CAAC;AACpD,eAAO,MAAM,2BAA2B,aAAa,CAAC;AACtD,eAAO,MAAM,4BAA4B,aAAa,CAAC;AACvD,eAAO,MAAM,kCAAkC,aAAa,CAAC;AAC7D,eAAO,MAAM,0CAA0C,aAAa,CAAC;AAGrE,eAAO,MAAM,eAAe,KAAK,CAAC;AAClC,eAAO,MAAM,uBAAuB,KAAK,CAAC;AAC1C,eAAO,MAAM,oBAAoB,KAAK,CAAC;AAGvC,eAAO,MAAM,qBAAqB,OAAwB,CAAC;AAG3D,eAAO,MAAM,wBAAwB,IAAI,CAAC;AAC1C,eAAO,MAAM,0BAA0B,IAAI,CAAC;AAG5C,eAAO,MAAM,sBAAsB,KAAK,CAAC;AACzC,eAAO,MAAM,6BAA6B,KAAK,CAAC;AAChD,eAAO,MAAM,oBAAoB,KAAK,CAAC;AACvC,eAAO,MAAM,0BAA0B,KAAK,CAAC;AAC7C,eAAO,MAAM,SAAS,KAAK,CAAC;AAC5B,eAAO,MAAM,WAAW,KAAK,CAAC;AAC9B,eAAO,MAAM,mBAAmB,KAAK,CAAC;AAGtC,eAAO,MAAM,WAAW,QAAqB,CAAC"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,2BAA2B,aAAa,CAAC;AACtD,eAAO,MAAM,yBAAyB,aAAa,CAAC;AACpD,eAAO,MAAM,2BAA2B,aAAa,CAAC;AACtD,eAAO,MAAM,4BAA4B,aAAa,CAAC;AACvD,eAAO,MAAM,kCAAkC,aAAa,CAAC;AAC7D,eAAO,MAAM,0CAA0C,aAAa,CAAC;AAGrE,eAAO,MAAM,eAAe,KAAK,CAAC;AAClC,eAAO,MAAM,uBAAuB,KAAK,CAAC;AAC1C,eAAO,MAAM,oBAAoB,KAAK,CAAC;AAGvC,eAAO,MAAM,qBAAqB,OAAwB,CAAC;AAG3D,eAAO,MAAM,wBAAwB,IAAI,CAAC;AAC1C,eAAO,MAAM,0BAA0B,IAAI,CAAC;AAG5C,eAAO,MAAM,sBAAsB,KAAK,CAAC;AACzC,eAAO,MAAM,6BAA6B,KAAK,CAAC;AAChD,eAAO,MAAM,oBAAoB,KAAK,CAAC;AACvC,eAAO,MAAM,0BAA0B,KAAK,CAAC;AAC7C,eAAO,MAAM,SAAS,KAAK,CAAC;AAC5B,eAAO,MAAM,WAAW,KAAK,CAAC;AAC9B,eAAO,MAAM,mBAAmB,KAAK,CAAC;AAGtC,eAAO,MAAM,WAAW,QAAqB,CAAC;AAE9C,yCAAyC;AACzC,eAAO,MAAM,aAAa,OAAO,CAAC;AAClC,sCAAsC;AACtC,eAAO,MAAM,UAAU,QAAQ,CAAC"}

package/dist/constants.js

@@ -24,4 +24,8 @@ export const EOCD64_SIZE = 56;
 export const EOCD64_LOCATOR_SIZE = 20;
 // Limits
 export const ZIP64_LIMIT = BigInt(0xffffffff);
+/** Little-endian for DataView methods */
+export const LITTLE_ENDIAN = true;
+/** Big-endian for DataView methods */
+export const BIG_ENDIAN = false;
 //# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,mDAAmD;AACnD,MAAM,CAAC,MAAM,2BAA2B,GAAG,UAAU,CAAC,CAAC,eAAe;AACtE,MAAM,CAAC,MAAM,yBAAyB,GAAG,UAAU,CAAC,CAAC,eAAe;AACpE,MAAM,CAAC,MAAM,2BAA2B,GAAG,UAAU,CAAC,CAAC,eAAe;AACtE,MAAM,CAAC,MAAM,4BAA4B,GAAG,UAAU,CAAC,CAAC,eAAe;AACvE,MAAM,CAAC,MAAM,kCAAkC,GAAG,UAAU,CAAC,CAAC,eAAe;AAC7E,MAAM,CAAC,MAAM,0CAA0C,GAAG,UAAU,CAAC,CAAC,eAAe;AAErF,oBAAoB;AACpB,MAAM,CAAC,MAAM,eAAe,GAAG,EAAE,CAAC,CAAC,8BAA8B;AACjE,MAAM,CAAC,MAAM,uBAAuB,GAAG,EAAE,CAAC,CAAC,cAAc;AACzD,MAAM,CAAC,MAAM,oBAAoB,GAAG,EAAE,CAAC,CAAC,wBAAwB;AAEhE,QAAQ;AACR,MAAM,CAAC,MAAM,qBAAqB,GAAG,qBAAqB,CAAC,CAAC,wCAAwC;AAEpG,sBAAsB;AACtB,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC;AAC1C,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC;AAE5C,iBAAiB;AACjB,MAAM,CAAC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AACzC,MAAM,CAAC,MAAM,6BAA6B,GAAG,EAAE,CAAC;AAChD,MAAM,CAAC,MAAM,oBAAoB,GAAG,EAAE,CAAC;AACvC,MAAM,CAAC,MAAM,0BAA0B,GAAG,EAAE,CAAC;AAC7C,MAAM,CAAC,MAAM,SAAS,GAAG,EAAE,CAAC;AAC5B,MAAM,CAAC,MAAM,WAAW,GAAG,EAAE,CAAC;AAC9B,MAAM,CAAC,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAEtC,SAAS;AACT,MAAM,CAAC,MAAM,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC"}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,mDAAmD;AACnD,MAAM,CAAC,MAAM,2BAA2B,GAAG,UAAU,CAAC,CAAC,eAAe;AACtE,MAAM,CAAC,MAAM,yBAAyB,GAAG,UAAU,CAAC,CAAC,eAAe;AACpE,MAAM,CAAC,MAAM,2BAA2B,GAAG,UAAU,CAAC,CAAC,eAAe;AACtE,MAAM,CAAC,MAAM,4BAA4B,GAAG,UAAU,CAAC,CAAC,eAAe;AACvE,MAAM,CAAC,MAAM,kCAAkC,GAAG,UAAU,CAAC,CAAC,eAAe;AAC7E,MAAM,CAAC,MAAM,0CAA0C,GAAG,UAAU,CAAC,CAAC,eAAe;AAErF,oBAAoB;AACpB,MAAM,CAAC,MAAM,eAAe,GAAG,EAAE,CAAC,CAAC,8BAA8B;AACjE,MAAM,CAAC,MAAM,uBAAuB,GAAG,EAAE,CAAC,CAAC,cAAc;AACzD,MAAM,CAAC,MAAM,oBAAoB,GAAG,EAAE,CAAC,CAAC,wBAAwB;AAEhE,QAAQ;AACR,MAAM,CAAC,MAAM,qBAAqB,GAAG,qBAAqB,CAAC,CAAC,wCAAwC;AAEpG,sBAAsB;AACtB,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC;AAC1C,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC;AAE5C,iBAAiB;AACjB,MAAM,CAAC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AACzC,MAAM,CAAC,MAAM,6BAA6B,GAAG,EAAE,CAAC;AAChD,MAAM,CAAC,MAAM,oBAAoB,GAAG,EAAE,CAAC;AACvC,MAAM,CAAC,MAAM,0BAA0B,GAAG,EAAE,CAAC;AAC7C,MAAM,CAAC,MAAM,SAAS,GAAG,EAAE,CAAC;AAC5B,MAAM,CAAC,MAAM,WAAW,GAAG,EAAE,CAAC;AAC9B,MAAM,CAAC,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAEtC,SAAS;AACT,MAAM,CAAC,MAAM,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;AAE9C,yCAAyC;AACzC,MAAM,CAAC,MAAM,aAAa,GAAG,IAAI,CAAC;AAClC,sCAAsC;AACtC,MAAM,CAAC,MAAM,UAAU,GAAG,KAAK,CAAC"}

package/dist/{crc.d.ts → crc-browser.d.ts}

@@ -30,4 +30,4 @@
  * @returns The computed CRC32 checksum.
  */
 export declare function crc32(data: Uint8Array<ArrayBuffer>, value?: number): number;
-//# sourceMappingURL=crc.d.ts.map
+//# sourceMappingURL=crc-browser.d.ts.map

package/dist/crc-browser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"crc-browser.d.ts","sourceRoot":"","sources":["../src/crc-browser.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AA8BH;;;;;;;;GAQG;AACH,wBAAgB,KAAK,CACnB,IAAI,EAAE,UAAU,CAAC,WAAW,CAAC,EAC7B,KAAK,GAAE,MAAU,GAChB,MAAM,CAgCR"}

package/dist/{crc.js → crc-browser.js}

@@ -20,7 +20,27 @@
  *    misrepresented as being the original software.
  * 3. This notice may not be removed or altered from any source distribution.
  */
-import { lookup } from "./crc-lookup.js";
+/**
+ * From https://github.com/holepunchto/crc-universal/blob/main/lookup.js
+ * Licensed under Apache-2.0
+ */
+const lookup = new Array(16);
+for (let i = 0; i < 16; i++) {
+    lookup[i] = new Uint32Array(0x100);
+}
+for (let i = 0; i <= 0xff; i++) {
+    let crc = i;
+    for (let j = 0; j < 8; j++) {
+        crc = (crc >>> 1) ^ ((crc & 1) * 0xedb88320);
+    }
+    lookup[0][i] = crc;
+}
+for (let i = 0; i <= 0xff; i++) {
+    for (let j = 1; j < 16; j++) {
+        lookup[j][i] =
+            (lookup[j - 1][i] >>> 8) ^ lookup[0][lookup[j - 1][i] & 0xff];
+    }
+}
 /**
  * Computes a 32-bit Cyclic Redundancy Check checksum of data. If value is
  * specified, it is used as the starting value of the checksum, otherwise, 0 is
@@ -59,4 +79,4 @@ export function crc32(data, value = 0) {
     }
     return ~crc >>> 0;
 }
-//# sourceMappingURL=crc.js.map
+//# sourceMappingURL=crc-browser.js.map

package/dist/crc-browser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"crc-browser.js","sourceRoot":"","sources":["../src/crc-browser.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH;;;GAGG;AAEH,MAAM,MAAM,GAAG,IAAI,KAAK,CAAC,EAAE,CAA+B,CAAC;AAE3D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC;IAC5B,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,WAAW,CAAC,KAAK,CAAC,CAAC;AACrC,CAAC;AAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC;IAC/B,IAAI,GAAG,GAAG,CAAC,CAAC;IAEZ,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QAC3B,GAAG,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC;IAC/C,CAAC;IAED,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC;AACrB,CAAC;AAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC;IAC/B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC;QAC5B,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACV,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IAClE,CAAC;AACH,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,KAAK,CACnB,IAA6B,EAC7B,QAAgB,CAAC;IAEjB,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC;IACjB,IAAI,CAAC,GAAG,CAAC,CAAC;IACV,IAAI,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC;IAE7B,OAAO,MAAM,IAAI,EAAE,EAAE,CAAC;QACpB,GAAG;YACD,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,GAAG,IAAI,CAAC,CAAC;gBACpC,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;gBAC5C,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;gBAC7C,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,EAAE,CAAC,CAAC;gBACpC,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;gBACrB,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;gBACrB,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;gBACpB,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;gBACpB,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;gBACpB,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;gBACpB,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;gBACpB,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;gBACpB,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;gBACpB,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;gBACpB,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;gBACpB,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAEvB,MAAM,IAAI,EAAE,CAAC;IACf,CAAC;IAED,OAAO,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC;QACpB,GAAG,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC1D,CAAC;IAED,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC;AACpB,CAAC"}

package/dist/crc-node.d.ts

@@ -0,0 +1,2 @@
+export { crc32 } from "node:zlib";
+//# sourceMappingURL=crc-node.d.ts.map

package/dist/crc-node.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"crc-node.d.ts","sourceRoot":"","sources":["../src/crc-node.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC"}

package/dist/crc-node.js

@@ -0,0 +1,3 @@
+// @ts-nocheck
+export { crc32 } from "node:zlib";
+//# sourceMappingURL=crc-node.js.map

package/dist/crc-node.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"crc-node.js","sourceRoot":"","sources":["../src/crc-node.ts"],"names":[],"mappings":"AAAA,cAAc;AACd,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC"}

package/dist/index.d.ts

@@ -28,16 +28,40 @@ export type EntryInfoStandard = {
 export type EntryInfo = EntryInfoZip64 | EntryInfoStandard;
 export declare class ZipWriter<TIsZip64 extends boolean = false> {
     #private;
+    /**
+     * @param crc Optional CRC32 function to use. Defaults to zlib.crc32 on Node and a pure JS implementation in browsers.
+     */
+    constructor({ crc32, }?: {
+        crc32?: (data: Uint8Array<ArrayBuffer>, value?: number) => number;
+    });
     get readable(): ReadableStream<ArrayBufferView<ArrayBufferLike>>;
     get entries(): ReadonlyArray<Readonly<EntryInfo>>;
     /**
      * Wait until all currently queued entries have been written.
      */
     onceQueueEmpty(): Promise<void>;
+    /**
+     * Convenience wrapper around `createEntryStream` to write all data at once.
+     * Use `createEntryStream` for more efficient streaming writes. Calls to
+     * createEntry() will be queued internally and each will resolve once it's
+     * written to the archive.
+     *
+     * @example
+     * ```ts
+     * const data = new TextEncoder().encode("Hello, World!");
+     * const entryInfo = await zipWriter.createEntry(data, { name: "hello.txt" });
+     * console.log(entryInfo);
+     * ```
+     *
+     * @param data Entry data
+     * @param options Entry filename, comment, compression method, etc.
+     * @returns Entry information once the entry has been written.
+     */
+    createEntry(data: Uint8Array<ArrayBuffer>, options: EntryOptions): Promise<EntryInfo>;
     /**
      * Create a new entry in the Zip archive. Use the returned
      * entryWriter.writable to write data to the entry. You can await
-     * entryWriter.entry() to get the entry info once all data has been written.
+     * entryWriter.getEntryInfo() to get the entry info once all data has been written.
      *
      * @example
      * ```ts
@@ -55,20 +79,30 @@ export declare class ZipWriter<TIsZip64 extends boolean = false> {
      *   new TextEncoder().encode("Hello, World!")
      * );
      * await writer.close();
-     * console.log(await entryWriter.entry()); // Entry info
+     * console.log(await entryWriter.getEntryInfo()); // Entry info
      * ```
      *
      * @param options Entry options
      */
-    entry(options: EntryOptions): EntryWriter;
+    createEntryStream(options: EntryOptions): EntryWriter;
     /**
-     * Set the entries of the Zip archive. This can be used to reorder,
-     * remove, or rename entries before finalizing the archive.
+     * Finalize the ZIP archive by writing the central directory and end of
+     * central directory records. You may not add any more entries after calling
+     * this method. This will await any pending entries to finish writing before
+     * finalizing.
+     *
+     * @param options.entries (Advanced) Optionally override the entries to write
+     * in the central directory. This can be used to reorder, remove, or rename
+     * entries before finalizing the archive, however you cannot add invalid
+     * entries, add additional entries, or modify their crc32, offsets or sizes.
+     * Use zipWriter.entries or entryWriter.getEntryInfo() to get the current
+     * entries for sorting or filtering.
      *
-     * @param entries New entries array
+     * @returns Information about the finalized archive.
      */
-    setEntries(entries: ReadonlyArray<Readonly<EntryInfo>>): void;
-    finalize(): Promise<{
+    finalize({ entries, }?: {
+        entries?: ReadonlyArray<Readonly<EntryInfo>>;
+    }): Promise<{
         /** Does the archive use ZIP64 format? */
         zip64: boolean;
         /** Total uncompressed size of all entries */
@@ -94,11 +128,11 @@ declare class EntryWriter {
      *   .pipeTo(entryWriter.writable);
      * ```
      */
-    get writable(): WritableStream<any>;
+    get writable(): WritableStream<Uint8Array<ArrayBuffer>>;
     /**
      * Get entry info. Resolves once all data has been written to the Zip stream.
      */
-    entry(): Promise<EntryInfo>;
+    getEntryInfo(): Promise<EntryInfo>;
 }
 export {};
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAeA,MAAM,WAAW,YAAY;IAC3B,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,oBAAoB;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iBAAiB;IACjB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,wBAAwB;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,4DAA4D;IAC5D,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,cAAe,SAAQ,YAAY;IAClD,kEAAkE;IAClE,WAAW,EAAE,MAAM,CAAC;IACpB,8CAA8C;IAC9C,KAAK,EAAE,MAAM,CAAC;IACd,iCAAiC;IACjC,gBAAgB,EAAE,MAAM,CAAC;IACzB,+BAA+B;IAC/B,cAAc,EAAE,MAAM,CAAC;IACvB,2CAA2C;IAC3C,KAAK,EAAE,IAAI,CAAC;CACb;AAED,MAAM,MAAM,iBAAiB,GAAG;KAC7B,CAAC,IAAI,MAAM,cAAc,GAAG,cAAc,CAAC,CAAC,CAAC,SAAS,MAAM,GACzD,MAAM,GACN,CAAC,SAAS,OAAO,GACf,KAAK,GACL,cAAc,CAAC,CAAC,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG,cAAc,GAAG,iBAAiB,CAAC;AAE3D,qBAAa,SAAS,CAAC,QAAQ,SAAS,OAAO,GAAG,KAAK;;IAoBrD,IAAI,QAAQ,qDAEX;IAED,IAAI,OAAO,IAAI,aAAa,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAEhD;IAED;;OAEG;IACG,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAMrC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,KAAK,CAAC,OAAO,EAAE,YAAY;IAqD3B;;;;;OAKG;IACH,UAAU,CAAC,OAAO,EAAE,aAAa,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;IAoChD,QAAQ,IAAI,OAAO,CAAC;QACxB,yCAAyC;QACzC,KAAK,EAAE,OAAO,CAAC;QACf,6CAA6C;QAC7C,uBAAuB,EAAE,MAAM,CAAC;QAChC,2CAA2C;QAC3C,qBAAqB,EAAE,MAAM,CAAC;QAC9B,iCAAiC;QACjC,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;CA0EH;AAED,cAAM,WAAW;;IASf;;OAEG;gBAED,cAAc,EAAE,CACd,QAAQ,EAAE,cAAc,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,KAC9C,OAAO,CAAC,SAAS,CAAC;IAazB;;;;;;;;OAQG;IACH,IAAI,QAAQ,wBAEX;IAED;;OAEG;IACG,KAAK,IAAI,OAAO,CAAC,SAAS,CAAC;CAGlC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAeA,MAAM,WAAW,YAAY;IAC3B,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,oBAAoB;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iBAAiB;IACjB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,wBAAwB;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,4DAA4D;IAC5D,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,cAAe,SAAQ,YAAY;IAClD,kEAAkE;IAClE,WAAW,EAAE,MAAM,CAAC;IACpB,8CAA8C;IAC9C,KAAK,EAAE,MAAM,CAAC;IACd,iCAAiC;IACjC,gBAAgB,EAAE,MAAM,CAAC;IACzB,+BAA+B;IAC/B,cAAc,EAAE,MAAM,CAAC;IACvB,2CAA2C;IAC3C,KAAK,EAAE,IAAI,CAAC;CACb;AAED,MAAM,MAAM,iBAAiB,GAAG;KAC7B,CAAC,IAAI,MAAM,cAAc,GAAG,cAAc,CAAC,CAAC,CAAC,SAAS,MAAM,GACzD,MAAM,GACN,CAAC,SAAS,OAAO,GACf,KAAK,GACL,cAAc,CAAC,CAAC,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG,cAAc,GAAG,iBAAiB,CAAC;AAE3D,qBAAa,SAAS,CAAC,QAAQ,SAAS,OAAO,GAAG,KAAK;;IAqBrD;;OAEG;gBACS,EACV,KAAoB,GACrB,GAAE;QACD,KAAK,CAAC,EAAE,CAAC,IAAI,EAAE,UAAU,CAAC,WAAW,CAAC,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC;KAC9D;IAIN,IAAI,QAAQ,qDAEX;IAED,IAAI,OAAO,IAAI,aAAa,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAEhD;IAED;;OAEG;IACG,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAMrC;;;;;;;;;;;;;;;;OAgBG;IACG,WAAW,CAAC,IAAI,EAAE,UAAU,CAAC,WAAW,CAAC,EAAE,OAAO,EAAE,YAAY;IAWtE;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,iBAAiB,CAAC,OAAO,EAAE,YAAY;IAgGvC;;;;;;;;;;;;;;OAcG;IACG,QAAQ,CAAC,EACb,OAAO,GACR,GAAE;QAAE,OAAO,CAAC,EAAE,aAAa,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAA;KAAO,GAAG,OAAO,CAAC;QACjE,yCAAyC;QACzC,KAAK,EAAE,OAAO,CAAC;QACf,6CAA6C;QAC7C,uBAAuB,EAAE,MAAM,CAAC;QAChC,2CAA2C;QAC3C,qBAAqB,EAAE,MAAM,CAAC;QAC9B,iCAAiC;QACjC,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;CA6EH;AAED,cAAM,WAAW;;IAQf;;OAEG;gBAED,cAAc,EAAE,CACd,QAAQ,EAAE,cAAc,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,KAC9C,OAAO,CAAC,SAAS,CAAC;IAazB;;;;;;;;OAQG;IACH,IAAI,QAAQ,4CAEX;IAED;;OAEG;IACG,YAAY,IAAI,OAAO,CAAC,SAAS,CAAC;CAGzC"}