@helloao/cli 0.0.10 → 0.0.11

package/node_modules/@zip.js/zip.js/index.d.ts

@@ -1,3 +1,163 @@
+/**
+ * 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 and data
+ * encryption.
+ *
+ * @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.
  *
@@ -394,7 +554,6 @@ export class SplitDataReader
 /**
  * Represents a URL stored into a `string`.
  */
-// deno-lint-ignore no-empty-interface
 interface URLString extends String { }
 
 /**
@@ -407,7 +566,7 @@ export class HttpReader extends Reader<URLString> {
    * @param url The URL of the data.
    * @param options The options.
    */
-  constructor(url: URLString, options?: HttpOptions);
+  constructor(url: URLString | URL, options?: HttpOptions);
 }
 
 /**
@@ -420,7 +579,7 @@ export class HttpRangeReader extends HttpReader {
    * @param url The URL of the data.
    * @param options The options.
    */
-  constructor(url: URLString, options?: HttpRangeOptions);
+  constructor(url: URLString | URL, options?: HttpRangeOptions);
 }
 
 /**
@@ -788,7 +947,7 @@ export interface GetEntriesOptions {
    */
   commentEncoding?: string;
   /**
-   * Decodes the filename and the comment of the entry.
+   * 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.
@@ -800,19 +959,13 @@ export interface GetEntriesOptions {
 /**
  * Represents options passed to the constructor of {@link ZipReader} and {@link Entry#getData}.
  */
-export interface ZipReaderCheckPasswordOptions {
+export interface ZipReaderOptions {
   /**
    * `true` to check only if the password is valid.
    *
    * @defaultValue false
    */
-  checkPasswordOnly: boolean;
-}
-
-/**
- * Represents options passed to the constructor of {@link ZipReader} and {@link Entry#getData}.
- */
-export interface ZipReaderOptions {
+  checkPasswordOnly?: boolean;
   /**
    * `true` to check the signature of the entry.
    *
@@ -823,6 +976,10 @@ export interface ZipReaderOptions {
    * 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).
    */
@@ -869,10 +1026,18 @@ export interface EntryMetaData {
    * `true` if the entry is a directory.
    */
   directory: 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.
    */
@@ -924,7 +1089,7 @@ export interface EntryMetaData {
   /**
    * The extra field.
    */
-  extraField?: Map<number, Uint8Array>;
+  extraField?: Map<number, { type: number, data: Uint8Array }>;
   /**
    * The extra field (raw).
    */
@@ -942,21 +1107,38 @@ export interface EntryMetaData {
    */
   versionMadeBy: number;
   /**
-   * `true` if `internalFileAttribute` and `externalFileAttribute` are compatible with MS-DOS format.
+   * `true` if `internalFileAttributes` and `externalFileAttributes` are compatible with MS-DOS format.
    */
   msDosCompatible: boolean;
+  /**
+   * The internal file attributes (raw).
+   */
+  internalFileAttributes: number;
+  /**
+   * The external file attributes (raw).
+   */
+  externalFileAttributes: 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;
 }
 
 /**
@@ -979,19 +1161,8 @@ export interface Entry extends EntryMetaData {
         Writer<unknown> | WritableWriter | WritableStream,
         boolean
       >,
-    options?: EntryGetDataOptions,
+    options?: EntryGetDataCheckPasswordOptions
   ): Promise<Type>;
-
-  /**
-   * Tests if the password is valid.
-   *
-   * @param writer `undefined` or `null`.
-   * @param options The options with `checkPasswordOnly` set to `true`.
-   */
-  getData?(
-    writer: undefined | null,
-    options: EntryGetDataCheckPasswordOptions,
-  ): Promise<void>;
 }
 
 /**
@@ -1004,7 +1175,7 @@ export interface EntryGetDataOptions
  * Represents the options passed to {@link Entry#getData} and `{@link ZipFileEntry}.get*`.
  */
 export interface EntryGetDataCheckPasswordOptions
-  extends EntryGetDataOptions, ZipReaderCheckPasswordOptions { }
+  extends EntryGetDataOptions { }
 
 /**
  * Represents an instance used to create a zipped stream.
@@ -1176,6 +1347,12 @@ export interface ZipWriterAddDataOptions
    * @defaultValue false
    */
   directory?: boolean;
+  /**
+   * `true` if the entry is an executable file.
+   *
+   * @defaultValue false
+   */
+  executable?: boolean;
   /**
    * The comment of the entry.
    */
@@ -1184,6 +1361,14 @@ export interface ZipWriterAddDataOptions
    * 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;
 }
 
 /**
@@ -1256,7 +1441,10 @@ export interface ZipWriterConstructorOptions {
    */
   rawPassword?: Uint8Array;
   /**
-   * The encryption strength (AES).
+   * The encryption strength (AES):
+   * - 1: 128-bit encryption key
+   * - 2: 192-bit encryption key
+   * - 3: 256-bit encryption key
    *
    * @defaultValue 3
    */
@@ -1314,7 +1502,15 @@ export interface ZipWriterConstructorOptions {
    */
   versionMadeBy?: number;
   /**
-   * `true` to to add a data descriptor.
+   * `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`.
    *
@@ -1328,9 +1524,9 @@ export interface ZipWriterConstructorOptions {
    */
   dataDescriptorSignature?: boolean;
   /**
-   * `true` to write {@link EntryMetaData#externalFileAttribute} in MS-DOS format for folder entries.
+   * `true` to write {@link EntryMetaData#externalFileAttributes} in MS-DOS format for folder entries.
    *
-   * @defaultValue true
+   * @defaultValue false
    */
   msDosCompatible?: boolean;
   /**
@@ -1338,13 +1534,13 @@ export interface ZipWriterConstructorOptions {
    *
    * @defaultValue 0
    */
-  externalFileAttribute?: number;
+  externalFileAttributes?: number;
   /**
    * The internal file attribute.
    *
    * @defaultValue 0
    */
-  internalFileAttribute?: number;
+  internalFileAttributes?: number;
   /**
    * `false` to never write disk numbers in zip64 data.
    *
@@ -1358,7 +1554,23 @@ export interface ZipWriterConstructorOptions {
    */
   usdz?: boolean;
   /**
-   * Encode the filename and the comment of the entry.
+   * `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.
@@ -2046,3 +2258,11 @@ export const ERR_SPLIT_ZIP_FILE: 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;
+/**
+ * Writer not initialized error
+ */
+export const ERR_WRITER_NOT_INITIALIZED: string;

package/node_modules/@zip.js/zip.js/index.js

@@ -81,7 +81,9 @@ export {
 	ERR_INVALID_EXTRAFIELD_DATA,
 	ERR_INVALID_ENCRYPTION_STRENGTH,
 	ERR_UNSUPPORTED_FORMAT,
+	ERR_UNDEFINED_UNCOMPRESSED_SIZE,
 	ERR_SPLIT_ZIP_FILE,
-	ERR_ITERATOR_COMPLETED_TOO_SOON
+	ERR_ITERATOR_COMPLETED_TOO_SOON,
+	ERR_WRITER_NOT_INITIALIZED
 } from "./lib/zip-fs.js";
 export { getMimeType, terminateWorkers };