@loaders.gl/zip 4.0.0-alpha.9 → 4.0.0-beta.1

package/dist/esm/zip-writer.js

@@ -11,17 +11,20 @@ async function encodeZipAsync(fileMap) {
   const jsZip = new JSZip();
   for (const subFileName in fileMap) {
     const subFileData = fileMap[subFileName];
-    jsZip.file(subFileName, subFileData, options);
+    jsZip.file(subFileName, subFileData, (options === null || options === void 0 ? void 0 : options.jszip) || {});
   }
-  options = Object.assign({}, options, {
+  const jszipOptions = {
+    ...(options === null || options === void 0 ? void 0 : options.jszip),
     type: 'arraybuffer'
-  });
+  };
   const {
     onUpdate = () => {}
   } = options;
-  return jsZip.generateAsync(options, onUpdate).catch(error => {
+  try {
+    return await jsZip.generateAsync(jszipOptions, onUpdate);
+  } catch (error) {
     options.log.error("Unable to write zip archive: ".concat(error));
     throw error;
-  });
+  }
 }
 //# sourceMappingURL=zip-writer.js.map

package/dist/esm/zip-writer.js.map

@@ -1 +1 @@
-{"version":3,"file":"zip-writer.js","names":["JSZip","ZipWriter","name","extensions","category","mimeTypes","encode","encodeZipAsync","fileMap","options","arguments","length","undefined","jsZip","subFileName","subFileData","file","Object","assign","type","onUpdate","generateAsync","catch","error","log","concat"],"sources":["../../src/zip-writer.ts"],"sourcesContent":["import type {Writer} from '@loaders.gl/loader-utils';\nimport JSZip from 'jszip';\n\n/**\n * Zip exporter\n */\nexport const ZipWriter: Writer = {\n  name: 'Zip Archive',\n  extensions: ['zip'],\n  category: 'archive',\n  mimeTypes: ['application/zip'],\n  // @ts-ignore\n  encode: encodeZipAsync\n};\n\nasync function encodeZipAsync(fileMap: any, options: any = {}) {\n  const jsZip = new JSZip();\n  // add files to the zip\n  for (const subFileName in fileMap) {\n    const subFileData = fileMap[subFileName];\n\n    // jszip supports both arraybuffer and string data (the main loaders.gl types)\n    // https://stuk.github.io/jszip/documentation/api_zipobject/async.html\n    jsZip.file(subFileName, subFileData, options);\n  }\n\n  // always generate the full zip as an arraybuffer\n  options = Object.assign({}, options, {\n    type: 'arraybuffer'\n  });\n  const {onUpdate = () => {}} = options;\n\n  return jsZip.generateAsync(options, onUpdate).catch((error) => {\n    options.log.error(`Unable to write zip archive: ${error}`);\n    throw error;\n  });\n}\n"],"mappings":"AACA,OAAOA,KAAK,MAAM,OAAO;AAKzB,OAAO,MAAMC,SAAiB,GAAG;EAC/BC,IAAI,EAAE,aAAa;EACnBC,UAAU,EAAE,CAAC,KAAK,CAAC;EACnBC,QAAQ,EAAE,SAAS;EACnBC,SAAS,EAAE,CAAC,iBAAiB,CAAC;EAE9BC,MAAM,EAAEC;AACV,CAAC;AAED,eAAeA,cAAcA,CAACC,OAAY,EAAqB;EAAA,IAAnBC,OAAY,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,CAAC,CAAC;EAC3D,MAAMG,KAAK,GAAG,IAAIb,KAAK,CAAC,CAAC;EAEzB,KAAK,MAAMc,WAAW,IAAIN,OAAO,EAAE;IACjC,MAAMO,WAAW,GAAGP,OAAO,CAACM,WAAW,CAAC;IAIxCD,KAAK,CAACG,IAAI,CAACF,WAAW,EAAEC,WAAW,EAAEN,OAAO,CAAC;EAC/C;EAGAA,OAAO,GAAGQ,MAAM,CAACC,MAAM,CAAC,CAAC,CAAC,EAAET,OAAO,EAAE;IACnCU,IAAI,EAAE;EACR,CAAC,CAAC;EACF,MAAM;IAACC,QAAQ,GAAGA,CAAA,KAAM,CAAC;EAAC,CAAC,GAAGX,OAAO;EAErC,OAAOI,KAAK,CAACQ,aAAa,CAACZ,OAAO,EAAEW,QAAQ,CAAC,CAACE,KAAK,CAAEC,KAAK,IAAK;IAC7Dd,OAAO,CAACe,GAAG,CAACD,KAAK,iCAAAE,MAAA,CAAiCF,KAAK,CAAE,CAAC;IAC1D,MAAMA,KAAK;EACb,CAAC,CAAC;AACJ"}
+{"version":3,"file":"zip-writer.js","names":["JSZip","ZipWriter","name","extensions","category","mimeTypes","encode","encodeZipAsync","fileMap","options","arguments","length","undefined","jsZip","subFileName","subFileData","file","jszip","jszipOptions","type","onUpdate","generateAsync","error","log","concat"],"sources":["../../src/zip-writer.ts"],"sourcesContent":["// loaders.gl, MIT license\n\nimport type {Writer, WriterOptions} from '@loaders.gl/loader-utils';\nimport JSZip, {JSZipGeneratorOptions} from 'jszip';\n\nexport type ZipWriterOptions = WriterOptions & {\n  zip?: {\n    onUpdate?: (metadata: {percent: number}) => void;\n  };\n  /** Passthrough options to jszip */\n  jszip?: JSZipGeneratorOptions;\n};\n\n/**\n * Zip exporter\n */\nexport const ZipWriter: Writer<FileReaderEventMap, never, ZipWriterOptions> = {\n  name: 'Zip Archive',\n  extensions: ['zip'],\n  category: 'archive',\n  mimeTypes: ['application/zip'],\n  // @ts-ignore\n  encode: encodeZipAsync\n};\n\nasync function encodeZipAsync(\n  fileMap: Record<string, ArrayBuffer>,\n  options: ZipWriterOptions = {}\n) {\n  const jsZip = new JSZip();\n  // add files to the zip\n  for (const subFileName in fileMap) {\n    const subFileData = fileMap[subFileName];\n\n    // jszip supports both arraybuffer and string data (the main loaders.gl types)\n    // https://stuk.github.io/jszip/documentation/api_zipobject/async.html\n    jsZip.file(subFileName, subFileData, options?.jszip || {});\n  }\n\n  // always generate the full zip as an arraybuffer\n  const jszipOptions: JSZipGeneratorOptions = {...options?.jszip, type: 'arraybuffer'};\n  const {onUpdate = () => {}} = options;\n\n  try {\n    return await jsZip.generateAsync(jszipOptions, onUpdate);\n  } catch (error) {\n    options.log.error(`Unable to write zip archive: ${error}`);\n    throw error;\n  }\n}\n"],"mappings":"AAGA,OAAOA,KAAK,MAA+B,OAAO;AAalD,OAAO,MAAMC,SAA8D,GAAG;EAC5EC,IAAI,EAAE,aAAa;EACnBC,UAAU,EAAE,CAAC,KAAK,CAAC;EACnBC,QAAQ,EAAE,SAAS;EACnBC,SAAS,EAAE,CAAC,iBAAiB,CAAC;EAE9BC,MAAM,EAAEC;AACV,CAAC;AAED,eAAeA,cAAcA,CAC3BC,OAAoC,EAEpC;EAAA,IADAC,OAAyB,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,CAAC,CAAC;EAE9B,MAAMG,KAAK,GAAG,IAAIb,KAAK,CAAC,CAAC;EAEzB,KAAK,MAAMc,WAAW,IAAIN,OAAO,EAAE;IACjC,MAAMO,WAAW,GAAGP,OAAO,CAACM,WAAW,CAAC;IAIxCD,KAAK,CAACG,IAAI,CAACF,WAAW,EAAEC,WAAW,EAAE,CAAAN,OAAO,aAAPA,OAAO,uBAAPA,OAAO,CAAEQ,KAAK,KAAI,CAAC,CAAC,CAAC;EAC5D;EAGA,MAAMC,YAAmC,GAAG;IAAC,IAAGT,OAAO,aAAPA,OAAO,uBAAPA,OAAO,CAAEQ,KAAK;IAAEE,IAAI,EAAE;EAAa,CAAC;EACpF,MAAM;IAACC,QAAQ,GAAGA,CAAA,KAAM,CAAC;EAAC,CAAC,GAAGX,OAAO;EAErC,IAAI;IACF,OAAO,MAAMI,KAAK,CAACQ,aAAa,CAACH,YAAY,EAAEE,QAAQ,CAAC;EAC1D,CAAC,CAAC,OAAOE,KAAK,EAAE;IACdb,OAAO,CAACc,GAAG,CAACD,KAAK,iCAAAE,MAAA,CAAiCF,KAAK,CAAE,CAAC;IAC1D,MAAMA,KAAK;EACb;AACF"}

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

@@ -0,0 +1,45 @@
+import { FileSystem } from '@loaders.gl/loader-utils';
+import { FileProvider } from '@loaders.gl/loader-utils';
+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,0BAA0B,CAAC;AAC/D,OAAO,EAAC,YAAY,EAAiB,MAAM,0BAA0B,CAAC;AAEtE,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/hash-file-utility.d.ts

@@ -0,0 +1,35 @@
+/// <reference types="node" />
+import { FileProvider } from '@loaders.gl/loader-utils';
+/** Element of hash array */
+export type HashElement = {
+    /** File name hash */
+    hash: Buffer;
+    /** File offset in the archive */
+    offset: bigint;
+};
+/**
+ * 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
+ * @param hash2 hash to compare
+ * @returns -1 if hash1 < hash2, 0 of hash1 === hash2, 1 if hash1 > hash2
+ */
+export declare const compareHashes: (hash1: Buffer, hash2: Buffer) => number;
+/**
+ * Reads hash file from buffer and returns it in ready-to-use form
+ * @param hashFile - bufer containing hash file
+ * @returns Array containing file info
+ */
+export declare const parseHashFile: (hashFile: ArrayBuffer) => HashElement[];
+/**
+ * Binary search in the hash info
+ * @param hashToSearch hash that we need to find
+ * @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

@@ -0,0 +1 @@
+{"version":3,"file":"hash-file-utility.d.ts","sourceRoot":"","sources":["../src/hash-file-utility.ts"],"names":[],"mappings":";AACA,OAAO,EAAC,YAAY,EAAC,MAAM,0BAA0B,CAAC;AAGtD,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/index.d.ts

@@ -1,4 +1,11 @@
 export { ZipLoader } from './zip-loader';
 export { ZipWriter } from './zip-writer';
-export { default as TarBuilder } from './tar-builder';
+export { TarBuilder } from './tar-builder';
+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 type { HashElement } 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"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,SAAS,EAAC,MAAM,cAAc,CAAC;AACvC,OAAO,EAAC,SAAS,EAAC,MAAM,cAAc,CAAC;AACvC,OAAO,EAAC,UAAU,EAAC,MAAM,eAAe,CAAC;AAEzC,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/parse-zip/cd-file-header.d.ts

@@ -0,0 +1,36 @@
+import { FileProvider } from '@loaders.gl/loader-utils';
+import { ZipSignature } from './search-from-the-end';
+/**
+ * zip central directory file header info
+ * according to https://en.wikipedia.org/wiki/ZIP_(file_format)
+ */
+export type ZipCDFileHeader = {
+    /** Compressed size */
+    compressedSize: bigint;
+    /** Uncompressed size */
+    uncompressedSize: bigint;
+    /** Extra field size */
+    extraFieldLength: number;
+    /** File name length */
+    fileNameLength: number;
+    /** File name */
+    fileName: string;
+    /** Extra field offset */
+    extraOffset: bigint;
+    /** Relative offset of local file header */
+    localHeaderOffset: bigint;
+};
+export declare const signature: ZipSignature;
+/**
+ * Parses central directory file header of zip file
+ * @param headerOffset - offset in the archive where header starts
+ * @param buffer - buffer containing whole array
+ * @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

@@ -0,0 +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,0BAA0B,CAAC;AAEtD,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/end-of-central-directory.d.ts

@@ -0,0 +1,18 @@
+import { FileProvider } from '@loaders.gl/loader-utils';
+/**
+ * End of central directory info
+ * according to https://en.wikipedia.org/wiki/ZIP_(file_format)
+ */
+export type ZipEoCDRecord = {
+    /** Relative offset of local file header */
+    cdStartOffset: bigint;
+    /** Relative offset of local file header */
+    cdRecordsNumber: bigint;
+};
+/**
+ * Parses end of central directory record of zip file
+ * @param fileProvider - FileProvider instance
+ * @returns Info from the header
+ */
+export declare const parseEoCDRecord: (fileProvider: FileProvider) => Promise<ZipEoCDRecord>;
+//# sourceMappingURL=end-of-central-directory.d.ts.map

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

@@ -0,0 +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,0BAA0B,CAAC;AAGtD;;;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"}

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

@@ -0,0 +1,28 @@
+import { FileProvider } from '@loaders.gl/loader-utils';
+/**
+ * zip local file header info
+ * according to https://en.wikipedia.org/wiki/ZIP_(file_format)
+ */
+export type ZipLocalFileHeader = {
+    /** File name length */
+    fileNameLength: number;
+    /** File name */
+    fileName: string;
+    /** Extra field length */
+    extraFieldLength: number;
+    /** Offset of the file data */
+    fileDataOffset: bigint;
+    /** Compressed size */
+    compressedSize: bigint;
+    /** Compression method */
+    compressionMethod: number;
+};
+export declare const signature: number[];
+/**
+ * Parses local file header of zip file
+ * @param headerOffset - offset in the archive where header starts
+ * @param buffer - buffer containing whole array
+ * @returns Info from the header
+ */
+export declare const parseZipLocalFileHeader: (headerOffset: bigint, buffer: FileProvider) => Promise<ZipLocalFileHeader | null>;
+//# sourceMappingURL=local-file-header.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"local-file-header.d.ts","sourceRoot":"","sources":["../../src/parse-zip/local-file-header.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAC,MAAM,0BAA0B,CAAC;AAEtD;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,uBAAuB;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,gBAAgB;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,yBAAyB;IACzB,gBAAgB,EAAE,MAAM,CAAC;IACzB,8BAA8B;IAC9B,cAAc,EAAE,MAAM,CAAC;IACvB,sBAAsB;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,yBAAyB;IACzB,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC;AAUF,eAAO,MAAM,SAAS,UAA2B,CAAC;AAElD;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB,iBACpB,MAAM,UACZ,YAAY,KACnB,QAAQ,kBAAkB,GAAG,IAAI,CAsDnC,CAAC"}

package/dist/parse-zip/search-from-the-end.d.ts

@@ -0,0 +1,11 @@
+import { FileProvider } from '@loaders.gl/loader-utils';
+/** Description of zip signature type */
+export type ZipSignature = [number, number, number, number];
+/**
+ * looking for the last occurrence of the provided
+ * @param file
+ * @param target
+ * @returns
+ */
+export declare const searchFromTheEnd: (file: FileProvider, target: ZipSignature) => Promise<bigint>;
+//# sourceMappingURL=search-from-the-end.d.ts.map

package/dist/parse-zip/search-from-the-end.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"search-from-the-end.d.ts","sourceRoot":"","sources":["../../src/parse-zip/search-from-the-end.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAC,MAAM,0BAA0B,CAAC;AAEtD,wCAAwC;AACxC,MAAM,MAAM,YAAY,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;AAE5D;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,SACrB,YAAY,2BAEjB,QAAQ,MAAM,CAuBhB,CAAC"}

package/dist/tar-builder.d.ts

@@ -5,13 +5,13 @@ type TarBuilderOptions = {
 /**
  * Build a tar file by adding files
  */
-export default class TARBuilder {
+export declare class TarBuilder {
     static get properties(): {
         id: string;
         name: string;
         extensions: string[];
         mimeTypes: string[];
-        builder: typeof TARBuilder;
+        builder: typeof TarBuilder;
         options: {
             recordsPerBlock: number;
         };

package/dist/tar-builder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tar-builder.d.ts","sourceRoot":"","sources":["../src/tar-builder.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,eAAe,CAAC;AAMhC,KAAK,iBAAiB,GAAG;IACvB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,UAAU;IAC7B,MAAM,KAAK,UAAU;;;;;;;;;MASpB;IAED,OAAO,EAAE,iBAAiB,CAAC;IAC3B,IAAI,EAAE,GAAG,CAAC;IACV,KAAK,EAAE,MAAM,CAAK;gBAEN,OAAO,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC;IAIhD,kCAAkC;IAClC,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW;IAKvC,KAAK,IAAI,OAAO,CAAC,WAAW,CAAC;CAGpC"}
+{"version":3,"file":"tar-builder.d.ts","sourceRoot":"","sources":["../src/tar-builder.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,eAAe,CAAC;AAMhC,KAAK,iBAAiB,GAAG;IACvB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF;;GAEG;AACH,qBAAa,UAAU;IACrB,MAAM,KAAK,UAAU;;;;;;;;;MASpB;IAED,OAAO,EAAE,iBAAiB,CAAC;IAC3B,IAAI,EAAE,GAAG,CAAC;IACV,KAAK,EAAE,MAAM,CAAK;gBAEN,OAAO,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC;IAIhD,kCAAkC;IAClC,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW;IAKvC,KAAK,IAAI,OAAO,CAAC,WAAW,CAAC;CAGpC"}

package/dist/zip-loader.d.ts

@@ -1,6 +1,5 @@
 import type { LoaderWithParser, LoaderOptions } from '@loaders.gl/loader-utils';
 type FileMap = Record<string, ArrayBuffer>;
 export declare const ZipLoader: LoaderWithParser<FileMap, never, LoaderOptions>;
-export declare const _typecheckZipLoader: LoaderWithParser;
 export {};
 //# sourceMappingURL=zip-loader.d.ts.map

package/dist/zip-loader.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"zip-loader.d.ts","sourceRoot":"","sources":["../src/zip-loader.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,gBAAgB,EAAE,aAAa,EAAC,MAAM,0BAA0B,CAAC;AAO9E,KAAK,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;AAE3C,eAAO,MAAM,SAAS,EAAE,gBAAgB,CAAC,OAAO,EAAE,KAAK,EAAE,aAAa,CAWrE,CAAC;AA8CF,eAAO,MAAM,mBAAmB,EAAE,gBAA4B,CAAC"}
+{"version":3,"file":"zip-loader.d.ts","sourceRoot":"","sources":["../src/zip-loader.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAC,gBAAgB,EAAE,aAAa,EAAC,MAAM,0BAA0B,CAAC;AAO9E,KAAK,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;AAE3C,eAAO,MAAM,SAAS,EAAE,gBAAgB,CAAC,OAAO,EAAE,KAAK,EAAE,aAAa,CAWrE,CAAC"}

package/dist/zip-writer.d.ts

@@ -1,6 +1,16 @@
-import type { Writer } from '@loaders.gl/loader-utils';
+import type { Writer, WriterOptions } from '@loaders.gl/loader-utils';
+import { JSZipGeneratorOptions } from 'jszip';
+export type ZipWriterOptions = WriterOptions & {
+    zip?: {
+        onUpdate?: (metadata: {
+            percent: number;
+        }) => void;
+    };
+    /** Passthrough options to jszip */
+    jszip?: JSZipGeneratorOptions;
+};
 /**
  * Zip exporter
  */
-export declare const ZipWriter: Writer;
+export declare const ZipWriter: Writer<FileReaderEventMap, never, ZipWriterOptions>;
 //# sourceMappingURL=zip-writer.d.ts.map

package/dist/zip-writer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"zip-writer.d.ts","sourceRoot":"","sources":["../src/zip-writer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,0BAA0B,CAAC;AAGrD;;GAEG;AACH,eAAO,MAAM,SAAS,EAAE,MAOvB,CAAC"}
+{"version":3,"file":"zip-writer.d.ts","sourceRoot":"","sources":["../src/zip-writer.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAC,MAAM,EAAE,aAAa,EAAC,MAAM,0BAA0B,CAAC;AACpE,OAAc,EAAC,qBAAqB,EAAC,MAAM,OAAO,CAAC;AAEnD,MAAM,MAAM,gBAAgB,GAAG,aAAa,GAAG;IAC7C,GAAG,CAAC,EAAE;QACJ,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE;YAAC,OAAO,EAAE,MAAM,CAAA;SAAC,KAAK,IAAI,CAAC;KAClD,CAAC;IACF,mCAAmC;IACnC,KAAK,CAAC,EAAE,qBAAqB,CAAC;CAC/B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,SAAS,EAAE,MAAM,CAAC,kBAAkB,EAAE,KAAK,EAAE,gBAAgB,CAOzE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loaders.gl/zip",
-  "version": "4.0.0-alpha.9",
+  "version": "4.0.0-beta.1",
   "description": "Zip Archive Loader",
   "license": "MIT",
   "publishConfig": {
@@ -30,7 +30,10 @@
     "build-bundle": "esbuild src/bundle.ts --bundle --outfile=dist/dist.min.js"
   },
   "dependencies": {
-    "jszip": "^3.1.5"
+    "@loaders.gl/compression": "4.0.0-beta.1",
+    "@loaders.gl/loader-utils": "4.0.0-beta.1",
+    "jszip": "^3.1.5",
+    "md5": "^2.3.0"
   },
-  "gitHead": "03ff81ab468f20f3bddeec787aa88d477a7e1c72"
+  "gitHead": "35c625e67132b0784e597d9ddabae8aefea29ff2"
 }

package/src/filesystems/zip-filesystem.ts

@@ -0,0 +1,142 @@
+import {FileSystem, isBrowser} from '@loaders.gl/loader-utils';
+import {FileProvider, isFileProvider} from '@loaders.gl/loader-utils';
+import {FileHandleFile} from '@loaders.gl/loader-utils';
+import {ZipCDFileHeader, zipCDFileHeaderGenerator} from '../parse-zip/cd-file-header';
+import {parseZipLocalFileHeader} from '../parse-zip/local-file-header';
+import {DeflateCompression} from '@loaders.gl/compression';
+
+type CompressionHandler = (compressedFile: ArrayBuffer) => Promise<ArrayBuffer>;
+/** Handling different compression types in zip */
+const COMPRESSION_METHODS: {[key: number]: CompressionHandler} = {
+  /** No compression */
+  0: async (compressedFile) => compressedFile,
+  /** Deflation */
+  8: async (compressedFile) => {
+    const compression = new 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
+ */
+export class ZipFileSystem implements FileSystem {
+  /** FileProvider instance promise */
+  protected fileProvider: Promise<FileProvider | null> = Promise.resolve(null);
+  public fileName?: string;
+
+  /**
+   * Constructor
+   * @param file - instance of FileProvider or file path string
+   */
+  constructor(file: FileProvider | string) {
+    // Try to open file in NodeJS
+    if (typeof file === 'string') {
+      this.fileName = file;
+      if (!isBrowser) {
+        this.fileProvider = FileHandleFile.from(file);
+      } else {
+        throw new Error('Cannot open file for random access in a WEB browser');
+      }
+    } else if (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(): Promise<string[]> {
+    const fileProvider = await this.fileProvider;
+    if (!fileProvider) {
+      throw new Error('No data detected in the zip archive');
+    }
+    const fileNames: string[] = [];
+    const zipCDIterator = 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: string): Promise<ZipCDFileHeader & {size: number}> {
+    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: string): Promise<Response> {
+    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 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
+   */
+  private async getCDFileHeader(filename: string): Promise<ZipCDFileHeader> {
+    const fileProvider = await this.fileProvider;
+    if (!fileProvider) {
+      throw new Error('No data detected in the zip archive');
+    }
+    const zipCDIterator = zipCDFileHeaderGenerator(fileProvider);
+    let result: ZipCDFileHeader | null = 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;
+  }
+}

package/src/hash-file-utility.ts

@@ -0,0 +1,101 @@
+import md5 from 'md5';
+import {FileProvider} from '@loaders.gl/loader-utils';
+import {zipCDFileHeaderGenerator} from './parse-zip/cd-file-header';
+
+/** Element of hash array */
+export type HashElement = {
+  /** File name hash */
+  hash: Buffer;
+  /** File offset in the archive */
+  offset: bigint;
+};
+
+/**
+ * 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
+ * @param hash2 hash to compare
+ * @returns -1 if hash1 < hash2, 0 of hash1 === hash2, 1 if hash1 > hash2
+ */
+export const compareHashes = (hash1: Buffer, hash2: Buffer): number => {
+  const h1 = new BigUint64Array(hash1.buffer, hash1.byteOffset, 2);
+  const h2 = new BigUint64Array(hash2.buffer, hash2.byteOffset, 2);
+
+  const diff = h1[0] === h2[0] ? h1[1] - h2[1] : h1[0] - h2[0];
+
+  if (diff < 0n) {
+    return -1;
+  } else if (diff === 0n) {
+    return 0;
+  }
+  return 1;
+};
+
+/**
+ * Reads hash file from buffer and returns it in ready-to-use form
+ * @param hashFile - bufer containing hash file
+ * @returns Array containing file info
+ */
+export const parseHashFile = (hashFile: ArrayBuffer): HashElement[] => {
+  const hashFileBuffer = Buffer.from(hashFile);
+  const hashArray: HashElement[] = [];
+  for (let i = 0; i < hashFileBuffer.buffer.byteLength; i = i + 24) {
+    const offsetBuffer = new DataView(
+      hashFileBuffer.buffer.slice(
+        hashFileBuffer.byteOffset + i + 16,
+        hashFileBuffer.byteOffset + i + 24
+      )
+    );
+    const offset = offsetBuffer.getBigUint64(offsetBuffer.byteOffset, true);
+    hashArray.push({
+      hash: Buffer.from(
+        hashFileBuffer.subarray(hashFileBuffer.byteOffset + i, hashFileBuffer.byteOffset + i + 16)
+      ),
+      offset
+    });
+  }
+  return hashArray;
+};
+
+/**
+ * Binary search in the hash info
+ * @param hashToSearch hash that we need to find
+ * @returns required hash element or undefined if not found
+ */
+export const findBin = (
+  hashToSearch: Buffer,
+  hashArray: HashElement[]
+): HashElement | undefined => {
+  let lowerBorder = 0;
+  let upperBorder = hashArray.length;
+
+  while (upperBorder - lowerBorder > 1) {
+    const middle = lowerBorder + Math.floor((upperBorder - lowerBorder) / 2);
+    const value = compareHashes(hashArray[middle].hash, hashToSearch);
+    if (value === 0) {
+      return hashArray[middle];
+    } else if (value < 0) {
+      lowerBorder = middle;
+    } else {
+      upperBorder = middle;
+    }
+  }
+  return undefined;
+};
+
+/**
+ * generates hash info from central directory
+ * @param fileProvider - provider of the archive
+ * @returns ready to use hash info
+ */
+export const generateHashInfo = async (fileProvider: FileProvider): Promise<HashElement[]> => {
+  const zipCDIterator = zipCDFileHeaderGenerator(fileProvider);
+  const hashInfo: HashElement[] = [];
+  for await (const cdHeader of zipCDIterator) {
+    hashInfo.push({
+      hash: Buffer.from(md5(cdHeader.fileName.split('\\').join('/').toLocaleLowerCase()), 'hex'),
+      offset: cdHeader.localHeaderOffset
+    });
+  }
+  hashInfo.sort((a, b) => compareHashes(a.hash, b.hash));
+  return hashInfo;
+};

package/src/index.ts

@@ -1,3 +1,22 @@
+// loaders.gl, MIT license
+
 export {ZipLoader} from './zip-loader';
 export {ZipWriter} from './zip-writer';
-export {default as TarBuilder} from './tar-builder';
+export {TarBuilder} from './tar-builder';
+
+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 type {HashElement} from './hash-file-utility';
+export {compareHashes, parseHashFile, findBin, generateHashInfo} from './hash-file-utility';
+
+export {ZipFileSystem} from './filesystems/zip-filesystem';