@fgv/ts-extras 5.0.0-14 → 5.0.0-16

package/dist/ts-extras.d.ts

@@ -523,9 +523,9 @@ export { ZipFileTree }
  */
 declare class ZipFileTreeAccessors implements FileTree.IFileTreeAccessors {
     /**
-     * The AdmZip instance containing the archive.
+     * The unzipped file data.
      */
-    private readonly _zip;
+    private readonly _files;
     /**
      * Optional prefix to prepend to paths.
      */
@@ -536,17 +536,24 @@ declare class ZipFileTreeAccessors implements FileTree.IFileTreeAccessors {
     private readonly _itemCache;
     /**
      * Constructor for ZipFileTreeAccessors.
-     * @param zip - The AdmZip instance.
+     * @param files - The unzipped file data from fflate.
      * @param prefix - Optional prefix to prepend to paths.
      */
     private constructor();
     /**
-     * Creates a new ZipFileTreeAccessors instance from a ZIP file buffer.
+     * Creates a new ZipFileTreeAccessors instance from a ZIP file buffer (synchronous).
      * @param zipBuffer - The ZIP file as an ArrayBuffer or Uint8Array.
      * @param prefix - Optional prefix to prepend to paths.
      * @returns Result containing the ZipFileTreeAccessors instance.
      */
     static fromBuffer(zipBuffer: ArrayBuffer | Uint8Array, prefix?: string): Result<ZipFileTreeAccessors>;
+    /**
+     * Creates a new ZipFileTreeAccessors instance from a ZIP file buffer (asynchronous).
+     * @param zipBuffer - The ZIP file as an ArrayBuffer or Uint8Array.
+     * @param prefix - Optional prefix to prepend to paths.
+     * @returns Promise containing Result with the ZipFileTreeAccessors instance.
+     */
+    static fromBufferAsync(zipBuffer: ArrayBuffer | Uint8Array, prefix?: string): Promise<Result<ZipFileTreeAccessors>>;
     /**
      * Creates a new ZipFileTreeAccessors instance from a File object (browser environment).
      * @param file - The File object containing ZIP data.

package/lib/packlets/zip-file-tree/zipFileTreeAccessors.d.ts

@@ -87,9 +87,9 @@ export declare class ZipDirectoryItem implements FileTree.IFileTreeDirectoryItem
  */
 export declare class ZipFileTreeAccessors implements FileTree.IFileTreeAccessors {
     /**
-     * The AdmZip instance containing the archive.
+     * The unzipped file data.
      */
-    private readonly _zip;
+    private readonly _files;
     /**
      * Optional prefix to prepend to paths.
      */
@@ -100,17 +100,24 @@ export declare class ZipFileTreeAccessors implements FileTree.IFileTreeAccessors
     private readonly _itemCache;
     /**
      * Constructor for ZipFileTreeAccessors.
-     * @param zip - The AdmZip instance.
+     * @param files - The unzipped file data from fflate.
      * @param prefix - Optional prefix to prepend to paths.
      */
     private constructor();
     /**
-     * Creates a new ZipFileTreeAccessors instance from a ZIP file buffer.
+     * Creates a new ZipFileTreeAccessors instance from a ZIP file buffer (synchronous).
      * @param zipBuffer - The ZIP file as an ArrayBuffer or Uint8Array.
      * @param prefix - Optional prefix to prepend to paths.
      * @returns Result containing the ZipFileTreeAccessors instance.
      */
     static fromBuffer(zipBuffer: ArrayBuffer | Uint8Array, prefix?: string): Result<ZipFileTreeAccessors>;
+    /**
+     * Creates a new ZipFileTreeAccessors instance from a ZIP file buffer (asynchronous).
+     * @param zipBuffer - The ZIP file as an ArrayBuffer or Uint8Array.
+     * @param prefix - Optional prefix to prepend to paths.
+     * @returns Promise containing Result with the ZipFileTreeAccessors instance.
+     */
+    static fromBufferAsync(zipBuffer: ArrayBuffer | Uint8Array, prefix?: string): Promise<Result<ZipFileTreeAccessors>>;
     /**
      * Creates a new ZipFileTreeAccessors instance from a File object (browser environment).
      * @param file - The File object containing ZIP data.

package/lib/packlets/zip-file-tree/zipFileTreeAccessors.js

@@ -20,12 +20,9 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ZipFileTreeAccessors = exports.ZipDirectoryItem = exports.ZipFileItem = void 0;
-const adm_zip_1 = __importDefault(require("adm-zip"));
+const fflate_1 = require("fflate");
 const ts_utils_1 = require("@fgv/ts-utils");
 /**
  * Implementation of `FileTree.IFileTreeFileItem` for files in a ZIP archive.
@@ -114,35 +111,62 @@ exports.ZipDirectoryItem = ZipDirectoryItem;
 class ZipFileTreeAccessors {
     /**
      * Constructor for ZipFileTreeAccessors.
-     * @param zip - The AdmZip instance.
+     * @param files - The unzipped file data from fflate.
      * @param prefix - Optional prefix to prepend to paths.
      */
-    constructor(zip, prefix) {
+    constructor(files, prefix) {
         /**
          * Cache of all items in the ZIP for efficient lookups.
          */
         this._itemCache = new Map();
-        this._zip = zip;
+        this._files = files;
         this._prefix = prefix || '';
         this._buildItemCache();
     }
     /**
-     * Creates a new ZipFileTreeAccessors instance from a ZIP file buffer.
+     * Creates a new ZipFileTreeAccessors instance from a ZIP file buffer (synchronous).
      * @param zipBuffer - The ZIP file as an ArrayBuffer or Uint8Array.
      * @param prefix - Optional prefix to prepend to paths.
      * @returns Result containing the ZipFileTreeAccessors instance.
      */
     static fromBuffer(zipBuffer, prefix) {
         try {
-            const buffer = Buffer.from(zipBuffer);
-            const zip = new adm_zip_1.default(buffer);
-            return (0, ts_utils_1.succeed)(new ZipFileTreeAccessors(zip, prefix));
+            /* c8 ignore next 1 - defense in depth */
+            const uint8Buffer = zipBuffer instanceof Uint8Array ? zipBuffer : new Uint8Array(zipBuffer);
+            const files = (0, fflate_1.unzipSync)(uint8Buffer);
+            return (0, ts_utils_1.succeed)(new ZipFileTreeAccessors(files, prefix));
         }
         catch (error) {
-            /* c8 ignore next 1 - defensive coding: AdmZip always throws Error objects in practice */
+            /* c8 ignore next 1 - defensive coding: fflate always throws Error objects in practice */
             return (0, ts_utils_1.fail)(`Failed to load ZIP archive: ${error instanceof Error ? error.message : String(error)}`);
         }
     }
+    /**
+     * Creates a new ZipFileTreeAccessors instance from a ZIP file buffer (asynchronous).
+     * @param zipBuffer - The ZIP file as an ArrayBuffer or Uint8Array.
+     * @param prefix - Optional prefix to prepend to paths.
+     * @returns Promise containing Result with the ZipFileTreeAccessors instance.
+     */
+    static async fromBufferAsync(zipBuffer, prefix) {
+        return new Promise((resolve) => {
+            try {
+                /* c8 ignore next 1 - defense in depth */
+                const uint8Buffer = zipBuffer instanceof Uint8Array ? zipBuffer : new Uint8Array(zipBuffer);
+                (0, fflate_1.unzip)(uint8Buffer, (err, files) => {
+                    if (err) {
+                        resolve((0, ts_utils_1.fail)(`Failed to load ZIP archive: ${err.message}`));
+                    }
+                    else {
+                        resolve((0, ts_utils_1.succeed)(new ZipFileTreeAccessors(files, prefix)));
+                    }
+                });
+            }
+            catch (error) {
+                /* c8 ignore next 5 - defensive coding: fflate always throws Error objects in practice */
+                resolve((0, ts_utils_1.fail)(`Failed to load ZIP archive: ${error instanceof Error ? error.message : String(error)}`));
+            }
+        });
+    }
     /**
      * Creates a new ZipFileTreeAccessors instance from a File object (browser environment).
      * @param file - The File object containing ZIP data.
@@ -152,7 +176,7 @@ class ZipFileTreeAccessors {
     static async fromFile(file, prefix) {
         try {
             const arrayBuffer = await file.arrayBuffer();
-            return ZipFileTreeAccessors.fromBuffer(new Uint8Array(arrayBuffer), prefix);
+            return await ZipFileTreeAccessors.fromBufferAsync(new Uint8Array(arrayBuffer), prefix);
         }
         catch (error) {
             return (0, ts_utils_1.fail)(`Failed to read file: ${error instanceof Error ? error.message : String(error)}`);
@@ -163,40 +187,38 @@ class ZipFileTreeAccessors {
      */
     _buildItemCache() {
         const directories = new Set();
-        const entries = this._zip.getEntries();
-        // First pass: collect all directories from file paths
-        entries.forEach((entry) => {
-            if (!entry.isDirectory) {
-                // Extract directory path from file path
-                const pathParts = entry.entryName.split('/');
-                for (let i = 1; i < pathParts.length; i++) {
-                    const dirPath = pathParts.slice(0, i).join('/');
+        // Process all files and collect directory paths
+        for (const [relativePath, fileData] of Object.entries(this._files)) {
+            // Skip directories in fflate output (they have null data)
+            /* c8 ignore next 5 - handles explicit directory entries from external ZIP tools (fflate doesn't create these) */
+            if (fileData === null || fileData === undefined) {
+                const dirPath = relativePath.replace(/\/$/, '');
+                if (dirPath) {
                     directories.add(dirPath);
                 }
             }
             else {
-                // Also add explicit directories
-                const dirPath = entry.entryName.replace(/\/$/, ''); // Remove trailing slash
-                if (dirPath) {
-                    directories.add(dirPath);
+                // Extract directory paths from file paths
+                const pathParts = relativePath.split('/');
+                for (let i = 1; i < pathParts.length; i++) {
+                    const dirPath = pathParts.slice(0, i).join('/');
+                    if (dirPath) {
+                        directories.add(dirPath);
+                    }
                 }
+                // Add the file item with its contents
+                const absolutePath = this.resolveAbsolutePath(relativePath);
+                const contents = new TextDecoder().decode(fileData);
+                const item = new ZipFileItem(relativePath, contents, this);
+                this._itemCache.set(absolutePath, item);
             }
-        });
+        }
         // Add directory items to cache
         directories.forEach((dirPath) => {
             const absolutePath = this.resolveAbsolutePath(dirPath);
             const item = new ZipDirectoryItem(dirPath, this);
             this._itemCache.set(absolutePath, item);
         });
-        // Add file items to cache
-        entries.forEach((entry) => {
-            if (!entry.isDirectory) {
-                const absolutePath = this.resolveAbsolutePath(entry.entryName);
-                const contents = entry.getData().toString('utf8');
-                const item = new ZipFileItem(entry.entryName, contents, this);
-                this._itemCache.set(absolutePath, item);
-            }
-        });
     }
     /**
      * Resolves paths to an absolute path.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fgv/ts-extras",
-  "version": "5.0.0-14",
+  "version": "5.0.0-16",
   "description": "Assorted Typescript Utilities",
   "main": "lib/index.js",
   "types": "dist/ts-extras.d.ts",
@@ -45,18 +45,17 @@
     "@types/heft-jest": "1.0.6",
     "@rushstack/heft-jest-plugin": "~0.16.11",
     "eslint-plugin-tsdoc": "~0.4.0",
-    "@fgv/ts-utils-jest": "5.0.0-14",
-    "@fgv/ts-utils": "5.0.0-14"
+    "@fgv/ts-utils-jest": "5.0.0-16",
+    "@fgv/ts-utils": "5.0.0-16"
   },
   "dependencies": {
     "luxon": "^3.7.1",
     "mustache": "^4.2.0",
     "papaparse": "^5.4.1",
-    "@types/adm-zip": "~0.5.7",
-    "adm-zip": "~0.5.16"
+    "fflate": "~0.8.2"
   },
   "peerDependencies": {
-    "@fgv/ts-utils": "5.0.0-14"
+    "@fgv/ts-utils": "5.0.0-16"
   },
   "scripts": {
     "build": "heft test --clean",

package/src/packlets/zip-file-tree/zipFileTreeAccessors.ts

@@ -20,7 +20,7 @@
  * SOFTWARE.
  */
 
-import AdmZip from 'adm-zip';
+import { unzipSync, unzip, Unzipped } from 'fflate';
 import { Result, succeed, fail, captureResult, Converter, Validator, FileTree } from '@fgv/ts-utils';
 
 /**
@@ -163,9 +163,9 @@ export class ZipDirectoryItem implements FileTree.IFileTreeDirectoryItem {
  */
 export class ZipFileTreeAccessors implements FileTree.IFileTreeAccessors {
   /**
-   * The AdmZip instance containing the archive.
+   * The unzipped file data.
    */
-  private readonly _zip: AdmZip;
+  private readonly _files: Unzipped;
 
   /**
    * Optional prefix to prepend to paths.
@@ -179,17 +179,17 @@ export class ZipFileTreeAccessors implements FileTree.IFileTreeAccessors {
 
   /**
    * Constructor for ZipFileTreeAccessors.
-   * @param zip - The AdmZip instance.
+   * @param files - The unzipped file data from fflate.
    * @param prefix - Optional prefix to prepend to paths.
    */
-  private constructor(zip: AdmZip, prefix?: string) {
-    this._zip = zip;
+  private constructor(files: Unzipped, prefix?: string) {
+    this._files = files;
     this._prefix = prefix || '';
     this._buildItemCache();
   }
 
   /**
-   * Creates a new ZipFileTreeAccessors instance from a ZIP file buffer.
+   * Creates a new ZipFileTreeAccessors instance from a ZIP file buffer (synchronous).
    * @param zipBuffer - The ZIP file as an ArrayBuffer or Uint8Array.
    * @param prefix - Optional prefix to prepend to paths.
    * @returns Result containing the ZipFileTreeAccessors instance.
@@ -199,15 +199,46 @@ export class ZipFileTreeAccessors implements FileTree.IFileTreeAccessors {
     prefix?: string
   ): Result<ZipFileTreeAccessors> {
     try {
-      const buffer = Buffer.from(zipBuffer);
-      const zip = new AdmZip(buffer);
-      return succeed(new ZipFileTreeAccessors(zip, prefix));
+      /* c8 ignore next 1 - defense in depth */
+      const uint8Buffer = zipBuffer instanceof Uint8Array ? zipBuffer : new Uint8Array(zipBuffer);
+      const files = unzipSync(uint8Buffer);
+      return succeed(new ZipFileTreeAccessors(files, prefix));
     } catch (error) {
-      /* c8 ignore next 1 - defensive coding: AdmZip always throws Error objects in practice */
+      /* c8 ignore next 1 - defensive coding: fflate always throws Error objects in practice */
       return fail(`Failed to load ZIP archive: ${error instanceof Error ? error.message : String(error)}`);
     }
   }
 
+  /**
+   * Creates a new ZipFileTreeAccessors instance from a ZIP file buffer (asynchronous).
+   * @param zipBuffer - The ZIP file as an ArrayBuffer or Uint8Array.
+   * @param prefix - Optional prefix to prepend to paths.
+   * @returns Promise containing Result with the ZipFileTreeAccessors instance.
+   */
+  public static async fromBufferAsync(
+    zipBuffer: ArrayBuffer | Uint8Array,
+    prefix?: string
+  ): Promise<Result<ZipFileTreeAccessors>> {
+    return new Promise((resolve) => {
+      try {
+        /* c8 ignore next 1 - defense in depth */
+        const uint8Buffer = zipBuffer instanceof Uint8Array ? zipBuffer : new Uint8Array(zipBuffer);
+        unzip(uint8Buffer, (err, files) => {
+          if (err) {
+            resolve(fail(`Failed to load ZIP archive: ${err.message}`));
+          } else {
+            resolve(succeed(new ZipFileTreeAccessors(files, prefix)));
+          }
+        });
+      } catch (error) {
+        /* c8 ignore next 5 - defensive coding: fflate always throws Error objects in practice */
+        resolve(
+          fail(`Failed to load ZIP archive: ${error instanceof Error ? error.message : String(error)}`)
+        );
+      }
+    });
+  }
+
   /**
    * Creates a new ZipFileTreeAccessors instance from a File object (browser environment).
    * @param file - The File object containing ZIP data.
@@ -217,7 +248,7 @@ export class ZipFileTreeAccessors implements FileTree.IFileTreeAccessors {
   public static async fromFile(file: File, prefix?: string): Promise<Result<ZipFileTreeAccessors>> {
     try {
       const arrayBuffer = await file.arrayBuffer();
-      return ZipFileTreeAccessors.fromBuffer(new Uint8Array(arrayBuffer), prefix);
+      return await ZipFileTreeAccessors.fromBufferAsync(new Uint8Array(arrayBuffer), prefix);
     } catch (error) {
       return fail(`Failed to read file: ${error instanceof Error ? error.message : String(error)}`);
     }
@@ -228,25 +259,33 @@ export class ZipFileTreeAccessors implements FileTree.IFileTreeAccessors {
    */
   private _buildItemCache(): void {
     const directories = new Set<string>();
-    const entries = this._zip.getEntries();
 
-    // First pass: collect all directories from file paths
-    entries.forEach((entry) => {
-      if (!entry.isDirectory) {
-        // Extract directory path from file path
-        const pathParts = entry.entryName.split('/');
-        for (let i = 1; i < pathParts.length; i++) {
-          const dirPath = pathParts.slice(0, i).join('/');
+    // Process all files and collect directory paths
+    for (const [relativePath, fileData] of Object.entries(this._files)) {
+      // Skip directories in fflate output (they have null data)
+      /* c8 ignore next 5 - handles explicit directory entries from external ZIP tools (fflate doesn't create these) */
+      if (fileData === null || fileData === undefined) {
+        const dirPath = relativePath.replace(/\/$/, '');
+        if (dirPath) {
           directories.add(dirPath);
         }
       } else {
-        // Also add explicit directories
-        const dirPath = entry.entryName.replace(/\/$/, ''); // Remove trailing slash
-        if (dirPath) {
-          directories.add(dirPath);
+        // Extract directory paths from file paths
+        const pathParts = relativePath.split('/');
+        for (let i = 1; i < pathParts.length; i++) {
+          const dirPath = pathParts.slice(0, i).join('/');
+          if (dirPath) {
+            directories.add(dirPath);
+          }
         }
+
+        // Add the file item with its contents
+        const absolutePath = this.resolveAbsolutePath(relativePath);
+        const contents = new TextDecoder().decode(fileData);
+        const item = new ZipFileItem(relativePath, contents, this);
+        this._itemCache.set(absolutePath, item);
       }
-    });
+    }
 
     // Add directory items to cache
     directories.forEach((dirPath) => {
@@ -254,16 +293,6 @@ export class ZipFileTreeAccessors implements FileTree.IFileTreeAccessors {
       const item = new ZipDirectoryItem(dirPath, this);
       this._itemCache.set(absolutePath, item);
     });
-
-    // Add file items to cache
-    entries.forEach((entry) => {
-      if (!entry.isDirectory) {
-        const absolutePath = this.resolveAbsolutePath(entry.entryName);
-        const contents = entry.getData().toString('utf8');
-        const item = new ZipFileItem(entry.entryName, contents, this);
-        this._itemCache.set(absolutePath, item);
-      }
-    });
   }
 
   /**