@zip.js/zip.js 2.7.33 → 2.7.35

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,
@@ -764,6 +798,10 @@ interface ZipReaderOptions {
    * The password used to decrypt the content of the entry.
    */
   password?: string;
+  /**
+   * The password used to encrypt the content of the entry (raw).
+   */
+  rawPassword?: Uint8Array;
   /**
    * The `AbortSignal` instance used to cancel the decompression.
    */
@@ -943,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.
  *
@@ -1103,6 +1221,10 @@ interface ZipWriterConstructorOptions {
    * 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).
    *
@@ -1201,7 +1323,7 @@ interface ZipWriterConstructorOptions {
   supportZip64SplitFile?: boolean;
   /**
    * `true`to produce zip files compatible with the USDZ specification.
-   * 
+   *
    * @defaultValue false
    */
   usdz?: boolean;
@@ -1316,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;
 }
@@ -1479,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.
@@ -1492,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.
@@ -1531,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.
@@ -1573,7 +1695,7 @@ export class ZipDirectoryEntry extends ZipEntry {
    * @returns A promise resolving to an array of {@link ZipFileEntry} or a {@link ZipDirectoryEntry} instances.
    */
   addFileSystemHandle(
-    fileSystemEntry: FileSystemHandle,
+    fileSystemHandle: FileSystemHandle,
     options?: ZipWriterAddDataOptions,
   ): Promise<ZipEntry[]>;
   /**

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 };