@loaders.gl/zip 4.0.0-alpha.20 → 4.0.0-alpha.22

package/dist/file-provider/file-handle-file.js

@@ -0,0 +1,90 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileHandleFile = void 0;
+const file_handle_1 = require("./file-handle");
+/**
+ * Provides file data using node fs library
+ */
+class FileHandleFile {
+    /**
+     * Returns a new copy of FileHandleFile
+     * @param path The path to the file in file system
+     */
+    static async from(path) {
+        const fileDescriptor = await file_handle_1.FileHandle.open(path);
+        return new FileHandleFile(fileDescriptor, fileDescriptor.stat.size);
+    }
+    constructor(fileDescriptor, size) {
+        this.fileDescriptor = fileDescriptor;
+        this.size = size;
+    }
+    /** Close file */
+    async destroy() {
+        await this.fileDescriptor.close();
+    }
+    /**
+     * Gets an unsigned 8-bit integer at the specified byte offset from the start of the file.
+     * @param offset The offset, in bytes, from the start of the file where to read the data.
+     */
+    async getUint8(offset) {
+        const val = new Uint8Array((await this.fileDescriptor.read(Buffer.alloc(1), 0, 1, offset)).buffer.buffer).at(0);
+        if (val === undefined) {
+            throw new Error('something went wrong');
+        }
+        return val;
+    }
+    /**
+     * Gets an unsigned 16-bit integer at the specified byte offset from the start of the file.
+     * @param offset The offset, in bytes, from the start of the file where to read the data.
+     */
+    async getUint16(offset) {
+        const val = new Uint16Array((await this.fileDescriptor.read(Buffer.alloc(2), 0, 2, offset)).buffer.buffer).at(0);
+        if (val === undefined) {
+            throw new Error('something went wrong');
+        }
+        return val;
+    }
+    /**
+     * Gets an unsigned 32-bit integer at the specified byte offset from the start of the file.
+     * @param offset The offset, in bytes, from the start of the file where to read the data.
+     */
+    async getUint32(offset) {
+        const val = new Uint32Array((await this.fileDescriptor.read(Buffer.alloc(4), 0, 4, offset)).buffer.buffer).at(0);
+        if (val === undefined) {
+            throw new Error('something went wrong');
+        }
+        return val;
+    }
+    /**
+     * Gets an unsigned 32-bit integer at the specified byte offset from the start of the file.
+     * @param offset The offset, in bytes, from the start of the file where to read the data.
+     */
+    async getBigUint64(offset) {
+        const val = new BigInt64Array((await this.fileDescriptor.read(Buffer.alloc(8), 0, 8, offset)).buffer.buffer).at(0);
+        if (val === undefined) {
+            throw new Error('something went wrong');
+        }
+        return val;
+    }
+    /**
+     * returns an ArrayBuffer whose contents are a copy of this file bytes from startOffset, inclusive, up to endOffset, exclusive.
+     * @param startOffsset The offset, in byte, from the start of the file where to start reading the data.
+     * @param endOffset The offset, in bytes, from the start of the file where to end reading the data.
+     */
+    async slice(startOffsset, endOffset) {
+        const bigLength = endOffset - startOffsset;
+        if (bigLength > Number.MAX_SAFE_INTEGER) {
+            throw new Error('too big slice');
+        }
+        const length = Number(bigLength);
+        return (await this.fileDescriptor.read(Buffer.alloc(length), 0, length, startOffsset)).buffer
+            .buffer;
+    }
+    /**
+     * the length (in bytes) of the data.
+     */
+    get length() {
+        return this.size;
+    }
+}
+exports.FileHandleFile = FileHandleFile;

package/dist/file-provider/file-handle.d.ts

@@ -0,0 +1,40 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { BigIntStats } from 'fs';
+/** file reading result */
+export type FileReadResult = {
+    /** amount of the bytes read */
+    bytesRead: number;
+    /** the buffer filled with data from file*/
+    buffer: Buffer;
+};
+/** Object handling file info */
+export declare class FileHandle {
+    private fileDescriptor;
+    private stats;
+    private constructor();
+    /**
+     * Opens a `FileHandle`.
+     *
+     * @param path path to the file
+     * @return Fulfills with a {FileHandle} object.
+     */
+    static open: (path: string) => Promise<FileHandle>;
+    /** Close file */
+    close(): Promise<void>;
+    /**
+     * Reads data from the file and stores that in the given buffer.
+     *
+     * If the file is not modified concurrently, the end-of-file is reached when the
+     * number of bytes read is zero.
+     * @param buffer A buffer that will be filled with the file data read.
+     * @param offset The location in the buffer at which to start filling.
+     * @param length The number of bytes to read.
+     * @param position The location where to begin reading data from the file. If `null`, data will be read from the current file position, and the position will be updated. If `position` is an
+     * integer, the current file position will remain unchanged.
+     * @return Fulfills upon success with a FileReadResult object
+     */
+    read: (buffer: Buffer, offset: number, length: number, position: number | bigint) => Promise<FileReadResult>;
+    get stat(): BigIntStats;
+}
+//# sourceMappingURL=file-handle.d.ts.map

package/dist/file-provider/file-handle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-handle.d.ts","sourceRoot":"","sources":["../../src/file-provider/file-handle.ts"],"names":[],"mappings":";;AAAA,OAAO,EAA0B,WAAW,EAAC,MAAM,IAAI,CAAC;AAExD,0BAA0B;AAC1B,MAAM,MAAM,cAAc,GAAG;IAC3B,+BAA+B;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,2CAA2C;IAC3C,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,gCAAgC;AAChC,qBAAa,UAAU;IACrB,OAAO,CAAC,cAAc,CAAS;IAC/B,OAAO,CAAC,KAAK,CAAc;IAC3B,OAAO;IAIP;;;;;OAKG;IAEH,MAAM,CAAC,IAAI,SAAgB,MAAM,KAAG,QAAQ,UAAU,CAAC,CAUrD;IAEF,iBAAiB;IACX,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAM5B;;;;;;;;;;;OAWG;IACH,IAAI,WACM,MAAM,UACN,MAAM,UACN,MAAM,YACJ,MAAM,GAAG,MAAM,KACxB,QAAQ,cAAc,CAAC,CAMxB;IAEF,IAAI,IAAI,IAAI,WAAW,CAEtB;CACF"}

package/dist/file-provider/file-handle.js

@@ -0,0 +1,57 @@
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileHandle = void 0;
+const fs_1 = require("fs");
+/** Object handling file info */
+class FileHandle {
+    constructor(fileDescriptor, stats) {
+        /**
+         * Reads data from the file and stores that in the given buffer.
+         *
+         * If the file is not modified concurrently, the end-of-file is reached when the
+         * number of bytes read is zero.
+         * @param buffer A buffer that will be filled with the file data read.
+         * @param offset The location in the buffer at which to start filling.
+         * @param length The number of bytes to read.
+         * @param position The location where to begin reading data from the file. If `null`, data will be read from the current file position, and the position will be updated. If `position` is an
+         * integer, the current file position will remain unchanged.
+         * @return Fulfills upon success with a FileReadResult object
+         */
+        this.read = (buffer, offset, length, position) => {
+            return new Promise((s) => {
+                (0, fs_1.read)(this.fileDescriptor, buffer, offset, length, position, (_err, bytesRead, buffer) => s({ bytesRead, buffer }));
+            });
+        };
+        this.fileDescriptor = fileDescriptor;
+        this.stats = stats;
+    }
+    /** Close file */
+    async close() {
+        return new Promise((resolve) => {
+            (0, fs_1.close)(this.fileDescriptor, (_err) => resolve());
+        });
+    }
+    get stat() {
+        return this.stats;
+    }
+}
+exports.FileHandle = FileHandle;
+_a = FileHandle;
+/**
+ * Opens a `FileHandle`.
+ *
+ * @param path path to the file
+ * @return Fulfills with a {FileHandle} object.
+ */
+FileHandle.open = async (path) => {
+    const [fd, stats] = await Promise.all([
+        new Promise((s) => {
+            (0, fs_1.open)(path, undefined, undefined, (_err, fd) => s(fd));
+        }),
+        new Promise((s) => {
+            (0, fs_1.stat)(path, { bigint: true }, (_err, stats) => s(stats));
+        })
+    ]);
+    return new FileHandle(fd, stats);
+};

package/dist/{parse-zip → file-provider}/file-provider.d.ts

@@ -2,6 +2,10 @@
  * Interface for providing file data
  */
 export interface FileProvider {
+    /**
+     * Cleanup class data
+     */
+    destroy(): Promise<void>;
     /**
      * Gets an unsigned 8-bit integer at the specified byte offset from the start of the file.
      * @param offset The offset, in bytes, from the start of the file where to read the data.
@@ -33,4 +37,9 @@ export interface FileProvider {
      */
     length: bigint;
 }
+/**
+ * Check is the object has FileProvider members
+ * @param fileProvider - tested object
+ */
+export declare const isFileProvider: (fileProvider: unknown) => bigint;
 //# sourceMappingURL=file-provider.d.ts.map

package/dist/file-provider/file-provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-provider.d.ts","sourceRoot":"","sources":["../../src/file-provider/file-provider.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACzB;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE1C;;;OAGG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE3C;;;OAGG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE3C;;;OAGG;IACH,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE9C;;;;OAIG;IACH,KAAK,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAEpE;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,eAAO,MAAM,cAAc,iBAAkB,OAAO,WAMnD,CAAC"}

package/dist/file-provider/file-provider.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isFileProvider = void 0;
+/**
+ * Check is the object has FileProvider members
+ * @param fileProvider - tested object
+ */
+const isFileProvider = (fileProvider) => {
+    return (fileProvider?.getUint8 &&
+        fileProvider?.slice &&
+        fileProvider?.length);
+};
+exports.isFileProvider = isFileProvider;

package/dist/filesystems/zip-filesystem.d.ts

@@ -0,0 +1,45 @@
+import { FileSystem } from '@loaders.gl/core';
+import { FileProvider } from '../file-provider/file-provider';
+import { ZipCDFileHeader } from '../parse-zip/cd-file-header';
+/**
+ * FileSystem adapter for a ZIP file
+ * Holds FileProvider object that provides random access to archived files
+ */
+export declare class ZipFileSystem implements FileSystem {
+    /** FileProvider instance promise */
+    protected fileProvider: Promise<FileProvider | null>;
+    fileName?: string;
+    /**
+     * Constructor
+     * @param file - instance of FileProvider or file path string
+     */
+    constructor(file: FileProvider | string);
+    /** Clean up resources */
+    destroy(): Promise<void>;
+    /**
+     * Get file names list from zip archive
+     * @returns array of file names
+     */
+    readdir(): Promise<string[]>;
+    /**
+     * Get file metadata
+     * @param filename - name of a file
+     * @returns central directory data
+     */
+    stat(filename: string): Promise<ZipCDFileHeader & {
+        size: number;
+    }>;
+    /**
+     * Implementation of fetch against this file system
+     * @param filename - name of a file
+     * @returns - Response with file data
+     */
+    fetch(filename: string): Promise<Response>;
+    /**
+     * Get central directory file header
+     * @param filename - name of a file
+     * @returns central directory file header
+     */
+    private getCDFileHeader;
+}
+//# sourceMappingURL=zip-filesystem.d.ts.map

package/dist/filesystems/zip-filesystem.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"zip-filesystem.d.ts","sourceRoot":"","sources":["../../src/filesystems/zip-filesystem.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAY,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAAC,YAAY,EAAiB,MAAM,gCAAgC,CAAC;AAE5E,OAAO,EAAC,eAAe,EAA2B,MAAM,6BAA6B,CAAC;AAiBtF;;;GAGG;AACH,qBAAa,aAAc,YAAW,UAAU;IAC9C,oCAAoC;IACpC,SAAS,CAAC,YAAY,EAAE,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,CAAyB;IACtE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;gBACS,IAAI,EAAE,YAAY,GAAG,MAAM;IAcvC,yBAAyB;IACnB,OAAO;IAOb;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAalC;;;;OAIG;IACG,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,GAAG;QAAC,IAAI,EAAE,MAAM,CAAA;KAAC,CAAC;IAKvE;;;;OAIG;IACG,KAAK,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IA+BhD;;;;OAIG;YACW,eAAe;CAkB9B"}

package/dist/filesystems/zip-filesystem.js

@@ -0,0 +1,128 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ZipFileSystem = void 0;
+const core_1 = require("@loaders.gl/core");
+const file_provider_1 = require("../file-provider/file-provider");
+const file_handle_file_1 = require("../file-provider/file-handle-file");
+const cd_file_header_1 = require("../parse-zip/cd-file-header");
+const local_file_header_1 = require("../parse-zip/local-file-header");
+const compression_1 = require("@loaders.gl/compression");
+/** Handling different compression types in zip */
+const COMPRESSION_METHODS = {
+    /** No compression */
+    0: async (compressedFile) => compressedFile,
+    /** Deflation */
+    8: async (compressedFile) => {
+        const compression = new compression_1.DeflateCompression({ raw: true });
+        const decompressedData = await compression.decompress(compressedFile);
+        return decompressedData;
+    }
+};
+/**
+ * FileSystem adapter for a ZIP file
+ * Holds FileProvider object that provides random access to archived files
+ */
+class ZipFileSystem {
+    /**
+     * Constructor
+     * @param file - instance of FileProvider or file path string
+     */
+    constructor(file) {
+        /** FileProvider instance promise */
+        this.fileProvider = Promise.resolve(null);
+        // Try to open file in NodeJS
+        if (typeof file === 'string') {
+            this.fileName = file;
+            if (!core_1.isBrowser) {
+                this.fileProvider = file_handle_file_1.FileHandleFile.from(file);
+            }
+            else {
+                throw new Error('Cannot open file for random access in a WEB browser');
+            }
+        }
+        else if ((0, file_provider_1.isFileProvider)(file)) {
+            this.fileProvider = Promise.resolve(file);
+        }
+    }
+    /** Clean up resources */
+    async destroy() {
+        const fileProvider = await this.fileProvider;
+        if (fileProvider) {
+            await fileProvider.destroy();
+        }
+    }
+    /**
+     * Get file names list from zip archive
+     * @returns array of file names
+     */
+    async readdir() {
+        const fileProvider = await this.fileProvider;
+        if (!fileProvider) {
+            throw new Error('No data detected in the zip archive');
+        }
+        const fileNames = [];
+        const zipCDIterator = (0, cd_file_header_1.zipCDFileHeaderGenerator)(fileProvider);
+        for await (const cdHeader of zipCDIterator) {
+            fileNames.push(cdHeader.fileName);
+        }
+        return fileNames;
+    }
+    /**
+     * Get file metadata
+     * @param filename - name of a file
+     * @returns central directory data
+     */
+    async stat(filename) {
+        const cdFileHeader = await this.getCDFileHeader(filename);
+        return { ...cdFileHeader, size: Number(cdFileHeader.uncompressedSize) };
+    }
+    /**
+     * Implementation of fetch against this file system
+     * @param filename - name of a file
+     * @returns - Response with file data
+     */
+    async fetch(filename) {
+        const fileProvider = await this.fileProvider;
+        if (!fileProvider) {
+            throw new Error('No data detected in the zip archive');
+        }
+        const cdFileHeader = await this.getCDFileHeader(filename);
+        const localFileHeader = await (0, local_file_header_1.parseZipLocalFileHeader)(cdFileHeader.localHeaderOffset, fileProvider);
+        if (!localFileHeader) {
+            throw new Error('Local file header has not been found in the zip archive`');
+        }
+        const compressionHandler = COMPRESSION_METHODS[localFileHeader.compressionMethod.toString()];
+        if (!compressionHandler) {
+            throw Error('Only Deflation compression is supported');
+        }
+        const compressedFile = await fileProvider.slice(localFileHeader.fileDataOffset, localFileHeader.fileDataOffset + localFileHeader.compressedSize);
+        const uncompressedFile = await compressionHandler(compressedFile);
+        const response = new Response(uncompressedFile);
+        Object.defineProperty(response, 'url', { value: `${this.fileName || ''}/${filename}` });
+        return response;
+    }
+    /**
+     * Get central directory file header
+     * @param filename - name of a file
+     * @returns central directory file header
+     */
+    async getCDFileHeader(filename) {
+        const fileProvider = await this.fileProvider;
+        if (!fileProvider) {
+            throw new Error('No data detected in the zip archive');
+        }
+        const zipCDIterator = (0, cd_file_header_1.zipCDFileHeaderGenerator)(fileProvider);
+        let result = null;
+        for await (const cdHeader of zipCDIterator) {
+            if (cdHeader.fileName === filename) {
+                result = cdHeader;
+                break;
+            }
+        }
+        if (!result) {
+            throw new Error('File has not been found in the zip archive');
+        }
+        return result;
+    }
+}
+exports.ZipFileSystem = ZipFileSystem;

package/dist/hash-file-utility.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+import { FileProvider } from './file-provider/file-provider';
 /** Element of hash array */
 export type HashElement = {
     /** File name hash */
@@ -25,4 +26,10 @@ export declare const parseHashFile: (hashFile: ArrayBuffer) => HashElement[];
  * @returns required hash element or undefined if not found
  */
 export declare const findBin: (hashToSearch: Buffer, hashArray: HashElement[]) => HashElement | undefined;
+/**
+ * generates hash info from central directory
+ * @param fileProvider - provider of the archive
+ * @returns ready to use hash info
+ */
+export declare const generateHashInfo: (fileProvider: FileProvider) => Promise<HashElement[]>;
 //# sourceMappingURL=hash-file-utility.d.ts.map

package/dist/hash-file-utility.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"hash-file-utility.d.ts","sourceRoot":"","sources":["../src/hash-file-utility.ts"],"names":[],"mappings":";AAAA,4BAA4B;AAC5B,MAAM,MAAM,WAAW,GAAG;IACxB,qBAAqB;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,iCAAiC;IACjC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,aAAa,UAAW,MAAM,SAAS,MAAM,KAAG,MAY5D,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,aAAa,aAAc,WAAW,KAAG,WAAW,EAmBhE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,OAAO,iBACJ,MAAM,aACT,WAAW,EAAE,KACvB,WAAW,GAAG,SAgBhB,CAAC"}
+{"version":3,"file":"hash-file-utility.d.ts","sourceRoot":"","sources":["../src/hash-file-utility.ts"],"names":[],"mappings":";AAEA,OAAO,EAAC,YAAY,EAAC,MAAM,+BAA+B,CAAC;AAE3D,4BAA4B;AAC5B,MAAM,MAAM,WAAW,GAAG;IACxB,qBAAqB;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,iCAAiC;IACjC,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,aAAa,UAAW,MAAM,SAAS,MAAM,KAAG,MAY5D,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,aAAa,aAAc,WAAW,KAAG,WAAW,EAmBhE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,OAAO,iBACJ,MAAM,aACT,WAAW,EAAE,KACvB,WAAW,GAAG,SAgBhB,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,iBAAwB,YAAY,KAAG,QAAQ,WAAW,EAAE,CAWxF,CAAC"}

package/dist/hash-file-utility.js

@@ -1,6 +1,11 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.findBin = exports.parseHashFile = exports.compareHashes = void 0;
+exports.generateHashInfo = exports.findBin = exports.parseHashFile = exports.compareHashes = void 0;
+const md5_1 = __importDefault(require("md5"));
+const cd_file_header_1 = require("./parse-zip/cd-file-header");
 /**
  * Comparing md5 hashes according to https://github.com/Esri/i3s-spec/blob/master/docs/2.0/slpk_hashtable.pcsl.md step 5
  * @param hash1 hash to compare
@@ -63,3 +68,21 @@ const findBin = (hashToSearch, hashArray) => {
     return undefined;
 };
 exports.findBin = findBin;
+/**
+ * generates hash info from central directory
+ * @param fileProvider - provider of the archive
+ * @returns ready to use hash info
+ */
+const generateHashInfo = async (fileProvider) => {
+    const zipCDIterator = (0, cd_file_header_1.zipCDFileHeaderGenerator)(fileProvider);
+    const hashInfo = [];
+    for await (const cdHeader of zipCDIterator) {
+        hashInfo.push({
+            hash: Buffer.from((0, md5_1.default)(cdHeader.fileName.split('\\').join('/').toLocaleLowerCase()), 'hex'),
+            offset: cdHeader.localHeaderOffset
+        });
+    }
+    hashInfo.sort((a, b) => (0, exports.compareHashes)(a.hash, b.hash));
+    return hashInfo;
+};
+exports.generateHashInfo = generateHashInfo;

package/dist/index.d.ts

@@ -1,12 +1,14 @@
 export { ZipLoader } from './zip-loader';
 export { ZipWriter } from './zip-writer';
 export { default as TarBuilder } from './tar-builder';
-export type { FileProvider } from './parse-zip/file-provider';
-export { parseZipCDFileHeader, signature as cdSignature } from './parse-zip/cd-file-header';
+export type { FileProvider } from './file-provider/file-provider';
+export { FileHandleFile } from './file-provider/file-handle-file';
+export { DataViewFile } from './file-provider/data-view-file';
+export { parseZipCDFileHeader, zipCDFileHeaderGenerator, signature as cdSignature } from './parse-zip/cd-file-header';
 export { parseZipLocalFileHeader, signature as localHeaderSignature } from './parse-zip/local-file-header';
 export { parseEoCDRecord } from './parse-zip/end-of-central-directory';
 export { searchFromTheEnd } from './parse-zip/search-from-the-end';
-export { DataViewFile } from './parse-zip/data-view-file';
 export type { HashElement } from './hash-file-utility';
-export { compareHashes, parseHashFile, findBin } from './hash-file-utility';
+export { compareHashes, parseHashFile, findBin, generateHashInfo } from './hash-file-utility';
+export { ZipFileSystem } from './filesystems/zip-filesystem';
 //# 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":"AAAA,OAAO,EAAC,SAAS,EAAC,MAAM,cAAc,CAAC;AACvC,OAAO,EAAC,SAAS,EAAC,MAAM,cAAc,CAAC;AACvC,OAAO,EAAC,OAAO,IAAI,UAAU,EAAC,MAAM,eAAe,CAAC;AAEpD,YAAY,EAAC,YAAY,EAAC,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAC,oBAAoB,EAAE,SAAS,IAAI,WAAW,EAAC,MAAM,4BAA4B,CAAC;AAC1F,OAAO,EACL,uBAAuB,EACvB,SAAS,IAAI,oBAAoB,EAClC,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAC,eAAe,EAAC,MAAM,sCAAsC,CAAC;AACrE,OAAO,EAAC,gBAAgB,EAAC,MAAM,iCAAiC,CAAC;AACjE,OAAO,EAAC,YAAY,EAAC,MAAM,4BAA4B,CAAC;AAExD,YAAY,EAAC,WAAW,EAAC,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAC,aAAa,EAAE,aAAa,EAAE,OAAO,EAAC,MAAM,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,SAAS,EAAC,MAAM,cAAc,CAAC;AACvC,OAAO,EAAC,SAAS,EAAC,MAAM,cAAc,CAAC;AACvC,OAAO,EAAC,OAAO,IAAI,UAAU,EAAC,MAAM,eAAe,CAAC;AAEpD,YAAY,EAAC,YAAY,EAAC,MAAM,+BAA+B,CAAC;AAChE,OAAO,EAAC,cAAc,EAAC,MAAM,kCAAkC,CAAC;AAChE,OAAO,EAAC,YAAY,EAAC,MAAM,gCAAgC,CAAC;AAE5D,OAAO,EACL,oBAAoB,EACpB,wBAAwB,EACxB,SAAS,IAAI,WAAW,EACzB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACL,uBAAuB,EACvB,SAAS,IAAI,oBAAoB,EAClC,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAC,eAAe,EAAC,MAAM,sCAAsC,CAAC;AACrE,OAAO,EAAC,gBAAgB,EAAC,MAAM,iCAAiC,CAAC;AAEjE,YAAY,EAAC,WAAW,EAAC,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAC,aAAa,EAAE,aAAa,EAAE,OAAO,EAAE,gBAAgB,EAAC,MAAM,qBAAqB,CAAC;AAE5F,OAAO,EAAC,aAAa,EAAC,MAAM,8BAA8B,CAAC"}

package/dist/index.js

@@ -3,15 +3,20 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.findBin = exports.parseHashFile = exports.compareHashes = exports.DataViewFile = exports.searchFromTheEnd = exports.parseEoCDRecord = exports.localHeaderSignature = exports.parseZipLocalFileHeader = exports.cdSignature = exports.parseZipCDFileHeader = exports.TarBuilder = exports.ZipWriter = exports.ZipLoader = void 0;
+exports.ZipFileSystem = exports.generateHashInfo = exports.findBin = exports.parseHashFile = exports.compareHashes = exports.searchFromTheEnd = exports.parseEoCDRecord = exports.localHeaderSignature = exports.parseZipLocalFileHeader = exports.cdSignature = exports.zipCDFileHeaderGenerator = exports.parseZipCDFileHeader = exports.DataViewFile = exports.FileHandleFile = exports.TarBuilder = exports.ZipWriter = exports.ZipLoader = void 0;
 var zip_loader_1 = require("./zip-loader");
 Object.defineProperty(exports, "ZipLoader", { enumerable: true, get: function () { return zip_loader_1.ZipLoader; } });
 var zip_writer_1 = require("./zip-writer");
 Object.defineProperty(exports, "ZipWriter", { enumerable: true, get: function () { return zip_writer_1.ZipWriter; } });
 var tar_builder_1 = require("./tar-builder");
 Object.defineProperty(exports, "TarBuilder", { enumerable: true, get: function () { return __importDefault(tar_builder_1).default; } });
+var file_handle_file_1 = require("./file-provider/file-handle-file");
+Object.defineProperty(exports, "FileHandleFile", { enumerable: true, get: function () { return file_handle_file_1.FileHandleFile; } });
+var data_view_file_1 = require("./file-provider/data-view-file");
+Object.defineProperty(exports, "DataViewFile", { enumerable: true, get: function () { return data_view_file_1.DataViewFile; } });
 var cd_file_header_1 = require("./parse-zip/cd-file-header");
 Object.defineProperty(exports, "parseZipCDFileHeader", { enumerable: true, get: function () { return cd_file_header_1.parseZipCDFileHeader; } });
+Object.defineProperty(exports, "zipCDFileHeaderGenerator", { enumerable: true, get: function () { return cd_file_header_1.zipCDFileHeaderGenerator; } });
 Object.defineProperty(exports, "cdSignature", { enumerable: true, get: function () { return cd_file_header_1.signature; } });
 var local_file_header_1 = require("./parse-zip/local-file-header");
 Object.defineProperty(exports, "parseZipLocalFileHeader", { enumerable: true, get: function () { return local_file_header_1.parseZipLocalFileHeader; } });
@@ -20,9 +25,10 @@ var end_of_central_directory_1 = require("./parse-zip/end-of-central-directory")
 Object.defineProperty(exports, "parseEoCDRecord", { enumerable: true, get: function () { return end_of_central_directory_1.parseEoCDRecord; } });
 var search_from_the_end_1 = require("./parse-zip/search-from-the-end");
 Object.defineProperty(exports, "searchFromTheEnd", { enumerable: true, get: function () { return search_from_the_end_1.searchFromTheEnd; } });
-var data_view_file_1 = require("./parse-zip/data-view-file");
-Object.defineProperty(exports, "DataViewFile", { enumerable: true, get: function () { return data_view_file_1.DataViewFile; } });
 var hash_file_utility_1 = require("./hash-file-utility");
 Object.defineProperty(exports, "compareHashes", { enumerable: true, get: function () { return hash_file_utility_1.compareHashes; } });
 Object.defineProperty(exports, "parseHashFile", { enumerable: true, get: function () { return hash_file_utility_1.parseHashFile; } });
 Object.defineProperty(exports, "findBin", { enumerable: true, get: function () { return hash_file_utility_1.findBin; } });
+Object.defineProperty(exports, "generateHashInfo", { enumerable: true, get: function () { return hash_file_utility_1.generateHashInfo; } });
+var zip_filesystem_1 = require("./filesystems/zip-filesystem");
+Object.defineProperty(exports, "ZipFileSystem", { enumerable: true, get: function () { return zip_filesystem_1.ZipFileSystem; } });

package/dist/parse-zip/cd-file-header.d.ts

@@ -1,4 +1,4 @@
-import { FileProvider } from './file-provider';
+import { FileProvider } from '../file-provider/file-provider';
 import { ZipSignature } from './search-from-the-end';
 /**
  * zip central directory file header info
@@ -28,4 +28,9 @@ export declare const signature: ZipSignature;
  * @returns Info from the header
  */
 export declare const parseZipCDFileHeader: (headerOffset: bigint, buffer: FileProvider) => Promise<ZipCDFileHeader | null>;
+/**
+ * Create iterator over files of zip archive
+ * @param fileProvider - file provider that provider random access to the file
+ */
+export declare function zipCDFileHeaderGenerator(fileProvider: FileProvider): AsyncGenerator<ZipCDFileHeader, void, unknown>;
 //# sourceMappingURL=cd-file-header.d.ts.map

package/dist/parse-zip/cd-file-header.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cd-file-header.d.ts","sourceRoot":"","sources":["../../src/parse-zip/cd-file-header.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAC,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAC,YAAY,EAAC,MAAM,uBAAuB,CAAC;AAEnD;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,sBAAsB;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,wBAAwB;IACxB,gBAAgB,EAAE,MAAM,CAAC;IACzB,uBAAuB;IACvB,gBAAgB,EAAE,MAAM,CAAC;IACzB,uBAAuB;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,gBAAgB;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,yBAAyB;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,2CAA2C;IAC3C,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC;AAWF,eAAO,MAAM,SAAS,EAAE,YAAuC,CAAC;AAEhE;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,iBACjB,MAAM,UACZ,YAAY,KACnB,QAAQ,eAAe,GAAG,IAAI,CA6DhC,CAAC"}
+{"version":3,"file":"cd-file-header.d.ts","sourceRoot":"","sources":["../../src/parse-zip/cd-file-header.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAC,MAAM,gCAAgC,CAAC;AAE5D,OAAO,EAAC,YAAY,EAAC,MAAM,uBAAuB,CAAC;AAEnD;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,sBAAsB;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,wBAAwB;IACxB,gBAAgB,EAAE,MAAM,CAAC;IACzB,uBAAuB;IACvB,gBAAgB,EAAE,MAAM,CAAC;IACzB,uBAAuB;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,gBAAgB;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,yBAAyB;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,2CAA2C;IAC3C,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC;AAUF,eAAO,MAAM,SAAS,EAAE,YAAuC,CAAC;AAEhE;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,iBACjB,MAAM,UACZ,YAAY,KACnB,QAAQ,eAAe,GAAG,IAAI,CAqDhC,CAAC;AAEF;;;GAGG;AACH,wBAAuB,wBAAwB,CAAC,YAAY,EAAE,YAAY,kDAUzE"}

package/dist/parse-zip/cd-file-header.js

@@ -1,14 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseZipCDFileHeader = exports.signature = void 0;
-const offsets = {
-    CD_COMPRESSED_SIZE_OFFSET: 20n,
-    CD_UNCOMPRESSED_SIZE_OFFSET: 24n,
-    CD_FILE_NAME_LENGTH_OFFSET: 28n,
-    CD_EXTRA_FIELD_LENGTH_OFFSET: 30n,
-    CD_LOCAL_HEADER_OFFSET_OFFSET: 42n,
-    CD_FILE_NAME_OFFSET: 46n
-};
+exports.zipCDFileHeaderGenerator = exports.parseZipCDFileHeader = exports.signature = void 0;
+const end_of_central_directory_1 = require("./end-of-central-directory");
+// offsets accroding to https://en.wikipedia.org/wiki/ZIP_(file_format)
+const CD_COMPRESSED_SIZE_OFFSET = 20n;
+const CD_UNCOMPRESSED_SIZE_OFFSET = 24n;
+const CD_FILE_NAME_LENGTH_OFFSET = 28n;
+const CD_EXTRA_FIELD_LENGTH_OFFSET = 30n;
+const CD_LOCAL_HEADER_OFFSET_OFFSET = 42n;
+const CD_FILE_NAME_OFFSET = 46n;
 exports.signature = [0x50, 0x4b, 0x01, 0x02];
 /**
  * Parses central directory file header of zip file
@@ -20,13 +20,13 @@ const parseZipCDFileHeader = async (headerOffset, buffer) => {
     if (Buffer.from(await buffer.slice(headerOffset, headerOffset + 4n)).compare(Buffer.from(exports.signature)) !== 0) {
         return null;
     }
-    let compressedSize = BigInt(await buffer.getUint32(headerOffset + offsets.CD_COMPRESSED_SIZE_OFFSET));
-    let uncompressedSize = BigInt(await buffer.getUint32(headerOffset + offsets.CD_UNCOMPRESSED_SIZE_OFFSET));
-    const extraFieldLength = await buffer.getUint16(headerOffset + offsets.CD_EXTRA_FIELD_LENGTH_OFFSET);
-    const fileNameLength = await buffer.getUint16(headerOffset + offsets.CD_FILE_NAME_LENGTH_OFFSET);
-    const fileName = new TextDecoder().decode(await buffer.slice(headerOffset + offsets.CD_FILE_NAME_OFFSET, headerOffset + offsets.CD_FILE_NAME_OFFSET + BigInt(fileNameLength)));
-    const extraOffset = headerOffset + offsets.CD_FILE_NAME_OFFSET + BigInt(fileNameLength);
-    const oldFormatOffset = await buffer.getUint32(headerOffset + offsets.CD_LOCAL_HEADER_OFFSET_OFFSET);
+    let compressedSize = BigInt(await buffer.getUint32(headerOffset + CD_COMPRESSED_SIZE_OFFSET));
+    let uncompressedSize = BigInt(await buffer.getUint32(headerOffset + CD_UNCOMPRESSED_SIZE_OFFSET));
+    const extraFieldLength = await buffer.getUint16(headerOffset + CD_EXTRA_FIELD_LENGTH_OFFSET);
+    const fileNameLength = await buffer.getUint16(headerOffset + CD_FILE_NAME_LENGTH_OFFSET);
+    const fileName = new TextDecoder().decode(await buffer.slice(headerOffset + CD_FILE_NAME_OFFSET, headerOffset + CD_FILE_NAME_OFFSET + BigInt(fileNameLength)));
+    const extraOffset = headerOffset + CD_FILE_NAME_OFFSET + BigInt(fileNameLength);
+    const oldFormatOffset = await buffer.getUint32(headerOffset + CD_LOCAL_HEADER_OFFSET_OFFSET);
     let fileDataOffset = BigInt(oldFormatOffset);
     let offsetInZip64Data = 4n;
     // looking for info that might be also be in zip64 extra field
@@ -53,3 +53,16 @@ const parseZipCDFileHeader = async (headerOffset, buffer) => {
     };
 };
 exports.parseZipCDFileHeader = parseZipCDFileHeader;
+/**
+ * Create iterator over files of zip archive
+ * @param fileProvider - file provider that provider random access to the file
+ */
+async function* zipCDFileHeaderGenerator(fileProvider) {
+    const { cdStartOffset } = await (0, end_of_central_directory_1.parseEoCDRecord)(fileProvider);
+    let cdHeader = await (0, exports.parseZipCDFileHeader)(cdStartOffset, fileProvider);
+    while (cdHeader) {
+        yield cdHeader;
+        cdHeader = await (0, exports.parseZipCDFileHeader)(cdHeader.extraOffset + BigInt(cdHeader.extraFieldLength), fileProvider);
+    }
+}
+exports.zipCDFileHeaderGenerator = zipCDFileHeaderGenerator;

package/dist/parse-zip/end-of-central-directory.d.ts

@@ -1,4 +1,4 @@
-import { FileProvider } from './file-provider';
+import { FileProvider } from '../file-provider/file-provider';
 /**
  * End of central directory info
  * according to https://en.wikipedia.org/wiki/ZIP_(file_format)

package/dist/parse-zip/end-of-central-directory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"end-of-central-directory.d.ts","sourceRoot":"","sources":["../../src/parse-zip/end-of-central-directory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAC,MAAM,iBAAiB,CAAC;AAG7C;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,2CAA2C;IAC3C,aAAa,EAAE,MAAM,CAAC;IACtB,2CAA2C;IAC3C,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC;AAgBF;;;;GAIG;AACH,eAAO,MAAM,eAAe,iBAAwB,YAAY,KAAG,QAAQ,aAAa,CA4CvF,CAAC"}
+{"version":3,"file":"end-of-central-directory.d.ts","sourceRoot":"","sources":["../../src/parse-zip/end-of-central-directory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAC,MAAM,gCAAgC,CAAC;AAG5D;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,2CAA2C;IAC3C,aAAa,EAAE,MAAM,CAAC;IACtB,2CAA2C;IAC3C,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC;AAaF;;;;GAIG;AACH,eAAO,MAAM,eAAe,iBAAwB,YAAY,KAAG,QAAQ,aAAa,CAwCvF,CAAC"}