@zip.js/zip.js 2.7.34 → 2.7.35

package/index.cjs

@@ -8919,8 +8919,8 @@ class SplitDataWriter extends Stream {
 
 	constructor(writerGenerator, maxSize = 4294967295) {
 		super();
-		const zipWriter = this;
-		Object.assign(zipWriter, {
+		const writer = this;
+		Object.assign(writer, {
 			diskNumber: 0,
 			diskOffset: 0,
 			size: 0,
@@ -8930,7 +8930,7 @@ class SplitDataWriter extends Stream {
 		let diskSourceWriter, diskWritable, diskWriter;
 		const writable = new WritableStream({
 			async write(chunk) {
-				const { availableSize } = zipWriter;
+				const { availableSize } = writer;
 				if (!diskWriter) {
 					const { value, done } = await writerGenerator.next();
 					if (done && !value) {
@@ -8939,9 +8939,9 @@ class SplitDataWriter extends Stream {
 						diskSourceWriter = value;
 						diskSourceWriter.size = 0;
 						if (diskSourceWriter.maxSize) {
-							zipWriter.maxSize = diskSourceWriter.maxSize;
+							writer.maxSize = diskSourceWriter.maxSize;
 						}
-						zipWriter.availableSize = zipWriter.maxSize;
+						writer.availableSize = writer.maxSize;
 						await initStream(diskSourceWriter);
 						diskWritable = value.writable;
 						diskWriter = diskWritable.getWriter();
@@ -8950,8 +8950,8 @@ class SplitDataWriter extends Stream {
 				} else if (chunk.length >= availableSize) {
 					await writeChunk(chunk.slice(0, availableSize));
 					await closeDisk();
-					zipWriter.diskOffset += diskSourceWriter.size;
-					zipWriter.diskNumber++;
+					writer.diskOffset += diskSourceWriter.size;
+					writer.diskNumber++;
 					diskWriter = null;
 					await this.write(chunk.slice(availableSize));
 				} else {
@@ -8963,7 +8963,7 @@ class SplitDataWriter extends Stream {
 				await closeDisk();
 			}
 		});
-		Object.defineProperty(zipWriter, PROPERTY_NAME_WRITABLE, {
+		Object.defineProperty(writer, PROPERTY_NAME_WRITABLE, {
 			get() {
 				return writable;
 			}
@@ -8975,8 +8975,8 @@ class SplitDataWriter extends Stream {
 				await diskWriter.ready;
 				await diskWriter.write(chunk);
 				diskSourceWriter.size += chunkLength;
-				zipWriter.size += chunkLength;
-				zipWriter.availableSize -= chunkLength;
+				writer.size += chunkLength;
+				writer.availableSize -= chunkLength;
 			}
 		}
 
@@ -8996,6 +8996,8 @@ function isHttpFamily(url) {
 async function initStream(stream, initSize) {
 	if (stream.init && !stream.initialized) {
 		await stream.init(initSize);
+	} else {
+		return Promise.resolve();
 	}
 }
 
@@ -9197,8 +9199,8 @@ class Entry {
  1. Redistributions of source code must retain the above copyright notice,
  this list of conditions and the following disclaimer.
 
- 2. Redistributions in binary form must reproduce the above copyright 
- notice, this list of conditions and the following disclaimer in 
+ 2. Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in
  the documentation and/or other materials provided with the distribution.
 
  3. The names of the authors may not be used to endorse or promote products
@@ -9327,7 +9329,7 @@ class ZipReader {
 		}
 		if (directoryDataOffset >= reader.size) {
 			prependedDataLength = reader.size - directoryDataOffset - directoryDataLength - END_OF_CENTRAL_DIR_LENGTH;
-			directoryDataOffset = reader.size - directoryDataLength - END_OF_CENTRAL_DIR_LENGTH;	
+			directoryDataOffset = reader.size - directoryDataLength - END_OF_CENTRAL_DIR_LENGTH;
 		}
 		if (expectedLastDiskNumber != lastDiskNumber) {
 			throw new Error(ERR_SPLIT_ZIP_FILE);
@@ -9444,6 +9446,34 @@ class ZipReader {
 	}
 }
 
+class ZipReaderStream {
+
+	constructor(options = {}) {
+		const { readable, writable } = new TransformStream();
+		const gen = new ZipReader(readable, options).getEntriesGenerator();
+		this.readable = new ReadableStream({
+			async pull(controller) {
+				const { done, value } = await gen.next();
+				if (done)
+					return controller.close();
+				const chunk = {
+					...value,
+					readable: (function () {
+						const { readable, writable } = new TransformStream();
+						if (value.getData) {
+							value.getData(writable);
+							return readable;
+						}
+					})()
+				};
+				delete chunk.getData;
+				controller.enqueue(chunk);
+			}
+		});
+		this.writable = writable;
+	}
+}
+
 class ZipEntry$1 {
 
 	constructor(reader, config, options) {
@@ -9833,8 +9863,8 @@ function getDataView$1(array) {
  1. Redistributions of source code must retain the above copyright notice,
  this list of conditions and the following disclaimer.
 
- 2. Redistributions in binary form must reproduce the above copyright 
- notice, this list of conditions and the following disclaimer in 
+ 2. Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in
  the documentation and/or other materials provided with the distribution.
 
  3. The names of the authors may not be used to endorse or promote products
@@ -9871,9 +9901,12 @@ class ZipWriter {
 
 	constructor(writer, options = {}) {
 		writer = initWriter(writer);
+		const addSplitZipSignature =
+			writer.availableSize !== UNDEFINED_VALUE && writer.availableSize > 0 && writer.availableSize !== Infinity &&
+			writer.maxSize !== UNDEFINED_VALUE && writer.maxSize > 0 && writer.maxSize !== Infinity;
 		Object.assign(this, {
 			writer,
-			addSplitZipSignature: writer instanceof SplitDataWriter,
+			addSplitZipSignature,
 			options,
 			config: getConfiguration(),
 			files: new Map(),
@@ -9936,6 +9969,33 @@ class ZipWriter {
 	}
 }
 
+class ZipWriterStream {
+
+	constructor(options = {}) {
+		const { readable, writable } = new TransformStream();
+		this.readable = readable;
+		this.zipWriter = new ZipWriter(writable, options);
+	}
+
+	transform(path) {
+		const { readable, writable } = new TransformStream({
+			flush: () => { this.zipWriter.close(); }
+		});
+		this.zipWriter.add(path, readable);
+		return { readable: this.readable, writable };
+	}
+
+	writable(path) {
+		const { readable, writable } = new TransformStream();
+		this.zipWriter.add(path, readable);
+		return writable;
+	}
+
+	close(comment = undefined, options = {}) {
+		return this.zipWriter.close(comment, options);
+	}
+}
+
 async function addFile(zipWriter, name, reader, options) {
 	name = name.trim();
 	if (options.directory && (!name.endsWith(DIRECTORY_SIGNATURE))) {
@@ -10106,6 +10166,7 @@ async function getFileEntry(zipWriter, name, reader, entryInfo, options) {
 	let writingBufferedEntryData;
 	let writingEntryData;
 	let fileWriter;
+	let blobPromise;
 	files.set(name, fileEntry);
 	try {
 		let lockPreviousFileEntry;
@@ -10114,7 +10175,8 @@ async function getFileEntry(zipWriter, name, reader, entryInfo, options) {
 			requestLockCurrentFileEntry();
 		}
 		if ((options.bufferedWrite || zipWriter.writerLocked || (zipWriter.bufferedWrites && keepOrder) || !dataDescriptor) && !usdz) {
-			fileWriter = new BlobWriter();
+			fileWriter = new TransformStream();
+			blobPromise = new Response(fileWriter.readable).blob();
 			fileWriter.writable.size = 0;
 			bufferedWrite = true;
 			zipWriter.bufferedWrites++;
@@ -10150,7 +10212,7 @@ async function getFileEntry(zipWriter, name, reader, entryInfo, options) {
 		fileEntry.filename = name;
 		if (bufferedWrite) {
 			await fileWriter.writable.getWriter().close();
-			let blob = await fileWriter.getData();
+			let blob = await blobPromise;
 			await lockPreviousFileEntry;
 			await requestLockWriter();
 			writingBufferedEntryData = true;
@@ -11741,8 +11803,8 @@ function addChild(parent, name, params, directory) {
  1. Redistributions of source code must retain the above copyright notice,
  this list of conditions and the following disclaimer.
 
- 2. Redistributions in binary form must reproduce the above copyright 
- notice, this list of conditions and the following disclaimer in 
+ 2. Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in
  the documentation and/or other materials provided with the distribution.
 
  3. The names of the authors may not be used to endorse or promote products
@@ -11814,7 +11876,9 @@ exports.Uint8ArrayReader = Uint8ArrayReader;
 exports.Uint8ArrayWriter = Uint8ArrayWriter;
 exports.Writer = Writer;
 exports.ZipReader = ZipReader;
+exports.ZipReaderStream = ZipReaderStream;
 exports.ZipWriter = ZipWriter;
+exports.ZipWriterStream = ZipWriterStream;
 exports.configure = configure;
 exports.fs = fs;
 exports.getMimeType = getMimeType;

package/index.d.ts

@@ -242,7 +242,7 @@ declare class SyncCodec {
 }
 
 /**
- * Represents an intance used to compress data.
+ * Represents an instance used to compress data.
  */
 declare class ZipDeflate extends SyncCodec {
   /**
@@ -599,7 +599,7 @@ export class SplitDataWriter implements Initializable, WritableWriter {
   /**
    * Creates the {@link SplitDataWriter} instance
    *
-   * @param writerGenerator A generator of Writer isntances.
+   * @param writerGenerator A generator of Writer instances.
    * @param maxSize The maximum size of the data written into {@link Writer} instances (default: 4GB).
    */
   constructor(
@@ -616,6 +616,40 @@ export class SplitDataWriter implements Initializable, WritableWriter {
  */
 export class Uint8ArrayWriter extends Writer<Uint8Array> {}
 
+/**
+ * Represents an instance used to create an unzipped stream.
+ *
+ * @example
+ * This example will take a zip file, decompress it and then recompress each file in it, saving it to disk.
+ * ```
+ * for await (const entry of (await fetch(urlToZippedFile)).body.pipeThrough(new ZipWriterStream()))
+ *   if (entry.readable) {
+ *     console.log(entry.filename)
+ *     entry.readable
+ *       .pipeThrough(ZipReaderStream().transform(entry.filename))
+ *       .pipeTo((await Deno.create(entry.filename + '.zip')).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.
  *
@@ -688,7 +722,7 @@ export class ZipReader<Type> {
    * Returns a generator used to iterate on all the entries in the zip file
    *
    * @param options The options.
-   * @returns An asynchrounous generator of {@link Entry} instances.
+   * @returns An asynchronous generator of {@link Entry} instances.
    */
   getEntriesGenerator(
     options?: ZipReaderGetEntriesOptions,
@@ -947,6 +981,86 @@ interface EntryGetDataOptions
 interface EntryGetDataCheckPasswordOptions
   extends EntryGetDataOptions, ZipReaderCheckPasswordOptions {}
 
+/**
+ * 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.
+	 * @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.
+	 * @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.
  *
@@ -1324,7 +1438,7 @@ declare class ZipEntry {
   /**
    * Set the name of the entry
    *
-   * @param name The new name of the netry.
+   * @param name The new name of the entry.
    */
   rename(name: string): void;
 }
@@ -1487,7 +1601,7 @@ export class ZipDirectoryEntry extends ZipEntry {
     options?: ZipWriterAddDataOptions,
   ): ZipFileEntry<string, string>;
   /**
-   * Adds aentry entry with content provided as a `Blob` instance
+   * Adds a entry entry with content provided as a `Blob` instance
    *
    * @param name The relative filename of the entry.
    * @param blob The `Blob` instance.
@@ -1500,7 +1614,7 @@ export class ZipDirectoryEntry extends ZipEntry {
     options?: ZipWriterAddDataOptions,
   ): ZipFileEntry<Blob, Blob>;
   /**
-   * Adds aentry entry with content provided as a Data URI `string` encoded in Base64
+   * 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.
@@ -1539,7 +1653,7 @@ export class ZipDirectoryEntry extends ZipEntry {
     options?: HttpOptions & ZipWriterAddDataOptions,
   ): ZipFileEntry<string, void>;
   /**
-   * Adds aentry entry with content provided via a `ReadableStream` instance
+   * Adds a entry entry with content provided via a `ReadableStream` instance
    *
    * @param name The relative filename of the entry.
    * @param readable The `ReadableStream` instance.

package/index.js

@@ -9,8 +9,8 @@
  1. Redistributions of source code must retain the above copyright notice,
  this list of conditions and the following disclaimer.
 
- 2. Redistributions in binary form must reproduce the above copyright 
- notice, this list of conditions and the following disclaimer in 
+ 2. Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in
  the documentation and/or other materials provided with the distribution.
 
  3. The names of the authors may not be used to endorse or promote products
@@ -42,6 +42,8 @@ export {
 	initShimAsyncCodec,
 	ZipReader,
 	ZipWriter,
+	ZipReaderStream,
+	ZipWriterStream,
 	Reader,
 	Writer,
 	TextReader,
@@ -83,4 +85,4 @@ export {
 	ERR_SPLIT_ZIP_FILE,
 	ERR_ITERATOR_COMPLETED_TOO_SOON
 } from "./lib/zip-fs.js";
-export { getMimeType, terminateWorkers };
+export { getMimeType, terminateWorkers };