@loaders.gl/zip 4.2.0-alpha.4 → 4.2.0-alpha.5

package/dist/filesystems/zip-filesystem.js

@@ -1,3 +1,6 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 import { isBrowser } from '@loaders.gl/loader-utils';
 import { isFileProvider } from '@loaders.gl/loader-utils';
 import { FileHandleFile } from '@loaders.gl/loader-utils';
@@ -5,101 +8,131 @@ import { makeZipCDHeaderIterator } from "../parse-zip/cd-file-header.js";
 import { parseZipLocalFileHeader } from "../parse-zip/local-file-header.js";
 import { DeflateCompression } from '@loaders.gl/compression';
 import { IndexedArchive } from "./IndexedArchive.js";
+/** Handling different compression types in zip */
 export const ZIP_COMPRESSION_HANDLERS = {
-  0: async compressedFile => compressedFile,
-  8: async compressedFile => {
-    const compression = new DeflateCompression({
-      raw: true
-    });
-    const decompressedData = await compression.decompress(compressedFile);
-    return decompressedData;
-  }
+    /** 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 {
-  constructor(file) {
-    this.fileProvider = null;
-    this.fileName = void 0;
-    this.archive = null;
-    if (typeof file === 'string') {
-      this.fileName = file;
-      if (!isBrowser) {
-        this.fileProvider = new FileHandleFile(file);
-      } else {
-        throw new Error('Cannot open file for random access in a WEB browser');
-      }
-    } else if (file instanceof IndexedArchive) {
-      this.fileProvider = file.fileProvider;
-      this.archive = file;
-      this.fileName = file.fileName;
-    } else if (isFileProvider(file)) {
-      this.fileProvider = file;
-    }
-  }
-  async destroy() {
-    if (this.fileProvider) {
-      await this.fileProvider.destroy();
-    }
-  }
-  async readdir() {
-    if (!this.fileProvider) {
-      throw new Error('No data detected in the zip archive');
+    /**
+     * Constructor
+     * @param file - instance of FileProvider or file path string
+     */
+    constructor(file) {
+        /** FileProvider instance promise */
+        this.fileProvider = null;
+        this.archive = null;
+        // Try to open file in NodeJS
+        if (typeof file === 'string') {
+            this.fileName = file;
+            if (!isBrowser) {
+                this.fileProvider = new FileHandleFile(file);
+            }
+            else {
+                throw new Error('Cannot open file for random access in a WEB browser');
+            }
+        }
+        else if (file instanceof IndexedArchive) {
+            this.fileProvider = file.fileProvider;
+            this.archive = file;
+            this.fileName = file.fileName;
+        }
+        else if (isFileProvider(file)) {
+            this.fileProvider = file;
+        }
     }
-    const fileNames = [];
-    const zipCDIterator = makeZipCDHeaderIterator(this.fileProvider);
-    for await (const cdHeader of zipCDIterator) {
-      fileNames.push(cdHeader.fileName);
+    /** Clean up resources */
+    async destroy() {
+        if (this.fileProvider) {
+            await this.fileProvider.destroy();
+        }
     }
-    return fileNames;
-  }
-  async stat(filename) {
-    const cdFileHeader = await this.getCDFileHeader(filename);
-    return {
-      ...cdFileHeader,
-      size: Number(cdFileHeader.uncompressedSize)
-    };
-  }
-  async fetch(filename) {
-    let uncompressedFile;
-    if (this.archive) {
-      uncompressedFile = await this.archive.getFile(filename, 'http');
-    } else {
-      if (!this.fileProvider) {
-        throw new Error('No data detected in the zip archive');
-      }
-      const cdFileHeader = await this.getCDFileHeader(filename);
-      const localFileHeader = await parseZipLocalFileHeader(cdFileHeader.localHeaderOffset, this.fileProvider);
-      if (!localFileHeader) {
-        throw new Error('Local file header has not been found in the zip archive`');
-      }
-      const compressionHandler = ZIP_COMPRESSION_HANDLERS[localFileHeader.compressionMethod.toString()];
-      if (!compressionHandler) {
-        throw Error('Only Deflation compression is supported');
-      }
-      const compressedFile = await this.fileProvider.slice(localFileHeader.fileDataOffset, localFileHeader.fileDataOffset + localFileHeader.compressedSize);
-      uncompressedFile = await compressionHandler(compressedFile);
+    /**
+     * Get file names list from zip archive
+     * @returns array of file names
+     */
+    async readdir() {
+        if (!this.fileProvider) {
+            throw new Error('No data detected in the zip archive');
+        }
+        const fileNames = [];
+        const zipCDIterator = makeZipCDHeaderIterator(this.fileProvider);
+        for await (const cdHeader of zipCDIterator) {
+            fileNames.push(cdHeader.fileName);
+        }
+        return fileNames;
     }
-    const response = new Response(uncompressedFile);
-    Object.defineProperty(response, 'url', {
-      value: filename ? `${this.fileName || ''}/${filename}` : this.fileName || ''
-    });
-    return response;
-  }
-  async getCDFileHeader(filename) {
-    if (!this.fileProvider) {
-      throw new Error('No data detected in the zip archive');
+    /**
+     * 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) };
     }
-    const zipCDIterator = makeZipCDHeaderIterator(this.fileProvider);
-    let result = null;
-    for await (const cdHeader of zipCDIterator) {
-      if (cdHeader.fileName === filename) {
-        result = cdHeader;
-        break;
-      }
+    /**
+     * Implementation of fetch against this file system
+     * @param filename - name of a file
+     * @returns - Response with file data
+     */
+    async fetch(filename) {
+        let uncompressedFile;
+        if (this.archive) {
+            uncompressedFile = await this.archive.getFile(filename, 'http');
+        }
+        else {
+            if (!this.fileProvider) {
+                throw new Error('No data detected in the zip archive');
+            }
+            const cdFileHeader = await this.getCDFileHeader(filename);
+            const localFileHeader = await parseZipLocalFileHeader(cdFileHeader.localHeaderOffset, this.fileProvider);
+            if (!localFileHeader) {
+                throw new Error('Local file header has not been found in the zip archive`');
+            }
+            const compressionHandler = ZIP_COMPRESSION_HANDLERS[localFileHeader.compressionMethod.toString()];
+            if (!compressionHandler) {
+                throw Error('Only Deflation compression is supported');
+            }
+            const compressedFile = await this.fileProvider.slice(localFileHeader.fileDataOffset, localFileHeader.fileDataOffset + localFileHeader.compressedSize);
+            uncompressedFile = await compressionHandler(compressedFile);
+        }
+        const response = new Response(uncompressedFile);
+        Object.defineProperty(response, 'url', {
+            value: filename ? `${this.fileName || ''}/${filename}` : this.fileName || ''
+        });
+        return response;
     }
-    if (!result) {
-      throw new Error('File has not been found in the zip archive');
+    /**
+     * Get central directory file header
+     * @param filename - name of a file
+     * @returns central directory file header
+     */
+    async getCDFileHeader(filename) {
+        if (!this.fileProvider) {
+            throw new Error('No data detected in the zip archive');
+        }
+        const zipCDIterator = makeZipCDHeaderIterator(this.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;
     }
-    return result;
-  }
 }
-//# sourceMappingURL=zip-filesystem.js.map

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

@@ -1,5 +1,5 @@
 import { FileProvider } from '@loaders.gl/loader-utils';
-import { ZipCDFileHeader } from './parse-zip/cd-file-header';
+import { ZipCDFileHeader } from "./parse-zip/cd-file-header.js";
 /**
  * Reads hash file from buffer and returns it in ready-to-use form
  * @param arrayBuffer - buffer containing hash file

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":"AAKA,OAAO,EACL,YAAY,EAGb,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAC,eAAe,EAA0B,MAAM,4BAA4B,CAAC;AAEpF;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAY/E;AASD;;;;GAIG;AACH,wBAAsB,2BAA2B,CAC/C,YAAY,EAAE,YAAY,GACzB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAGjC;AAED;;;;GAIG;AACH,wBAAsB,YAAY,CAChC,aAAa,EAAE,aAAa,CAAC,eAAe,CAAC,GAC5C,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAcjC;AAED,mCAAmC;AACnC,KAAK,YAAY,GAAG;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF;;;;GAIG;AACH,wBAAsB,eAAe,CACnC,aAAa,EAAE,aAAa,CAAC,YAAY,CAAC,GAAG,QAAQ,CAAC,YAAY,CAAC,GAClE,OAAO,CAAC,WAAW,CAAC,CAwBtB"}
+{"version":3,"file":"hash-file-utility.d.ts","sourceRoot":"","sources":["../src/hash-file-utility.ts"],"names":[],"mappings":"AAKA,OAAO,EACL,YAAY,EAGb,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAC,eAAe,EAA0B,sCAAmC;AAEpF;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAY/E;AASD;;;;GAIG;AACH,wBAAsB,2BAA2B,CAC/C,YAAY,EAAE,YAAY,GACzB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAGjC;AAED;;;;GAIG;AACH,wBAAsB,YAAY,CAChC,aAAa,EAAE,aAAa,CAAC,eAAe,CAAC,GAC5C,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAcjC;AAED,mCAAmC;AACnC,KAAK,YAAY,GAAG;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF;;;;GAIG;AACH,wBAAsB,eAAe,CACnC,aAAa,EAAE,aAAa,CAAC,YAAY,CAAC,GAAG,QAAQ,CAAC,YAAY,CAAC,GAClE,OAAO,CAAC,WAAW,CAAC,CAwBtB"}

package/dist/hash-file-utility.js

@@ -1,62 +1,105 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 import { MD5Hash } from '@loaders.gl/crypto';
 import { concatenateArrayBuffers, concatenateArrayBuffersFromArray } from '@loaders.gl/loader-utils';
 import { makeZipCDHeaderIterator } from "./parse-zip/cd-file-header.js";
+/**
+ * Reads hash file from buffer and returns it in ready-to-use form
+ * @param arrayBuffer - buffer containing hash file
+ * @returns Map containing hash and offset
+ */
 export function parseHashTable(arrayBuffer) {
-  const dataView = new DataView(arrayBuffer);
-  const hashMap = {};
-  for (let i = 0; i < arrayBuffer.byteLength; i = i + 24) {
-    const offset = dataView.getBigUint64(i + 16, true);
-    const hash = bufferToHex(arrayBuffer, i, 16);
-    hashMap[hash] = offset;
-  }
-  return hashMap;
+    const dataView = new DataView(arrayBuffer);
+    const hashMap = {};
+    for (let i = 0; i < arrayBuffer.byteLength; i = i + 24) {
+        const offset = dataView.getBigUint64(i + 16, true);
+        const hash = bufferToHex(arrayBuffer, i, 16);
+        hashMap[hash] = offset;
+    }
+    return hashMap;
 }
 function bufferToHex(buffer, start, length) {
-  return [...new Uint8Array(buffer, start, length)].map(x => x.toString(16).padStart(2, '0')).join('');
+    // buffer is an ArrayBuffer
+    return [...new Uint8Array(buffer, start, length)]
+        .map((x) => x.toString(16).padStart(2, '0'))
+        .join('');
 }
+/**
+ * generates hash info from zip files "central directory"
+ * @param fileProvider - provider of the archive
+ * @returns ready to use hash info
+ */
 export async function makeHashTableFromZipHeaders(fileProvider) {
-  const zipCDIterator = makeZipCDHeaderIterator(fileProvider);
-  return getHashTable(zipCDIterator);
+    const zipCDIterator = makeZipCDHeaderIterator(fileProvider);
+    return getHashTable(zipCDIterator);
 }
+/**
+ * creates hash table from file offset iterator
+ * @param zipCDIterator iterator to use
+ * @returns hash table
+ */
 export async function getHashTable(zipCDIterator) {
-  const md5Hash = new MD5Hash();
-  const textEncoder = new TextEncoder();
-  const hashTable = {};
-  for await (const cdHeader of zipCDIterator) {
-    const filename = cdHeader.fileName.split('\\').join('/').toLocaleLowerCase();
-    const arrayBuffer = textEncoder.encode(filename).buffer;
-    const md5 = await md5Hash.hash(arrayBuffer, 'hex');
-    hashTable[md5] = cdHeader.localHeaderOffset;
-  }
-  return hashTable;
+    const md5Hash = new MD5Hash();
+    const textEncoder = new TextEncoder();
+    const hashTable = {};
+    for await (const cdHeader of zipCDIterator) {
+        const filename = cdHeader.fileName.split('\\').join('/').toLocaleLowerCase();
+        const arrayBuffer = textEncoder.encode(filename).buffer;
+        const md5 = await md5Hash.hash(arrayBuffer, 'hex');
+        hashTable[md5] = cdHeader.localHeaderOffset;
+    }
+    return hashTable;
 }
+/**
+ * creates hash file that later can be added to the SLPK archive
+ * @param zipCDIterator iterator to use
+ * @returns ArrayBuffer containing hash file
+ */
 export async function composeHashFile(zipCDIterator) {
-  const md5Hash = new MD5Hash();
-  const textEncoder = new TextEncoder();
-  const hashArray = [];
-  for await (const cdHeader of zipCDIterator) {
-    let filename = cdHeader.fileName.split('\\').join('/');
-    if (filename !== '3dSceneLayer.json.gz') {
-      filename = filename.toLocaleLowerCase();
+    const md5Hash = new MD5Hash();
+    const textEncoder = new TextEncoder();
+    const hashArray = [];
+    for await (const cdHeader of zipCDIterator) {
+        let filename = cdHeader.fileName.split('\\').join('/');
+        // I3S edge case. All files should be lower case by spec. However, ArcGIS
+        // and official i3s_converter https://github.com/Esri/i3s-spec/blob/master/i3s_converter/i3s_converter_ReadMe.md
+        // expect `3dSceneLayer.json.gz` in camel case
+        if (filename !== '3dSceneLayer.json.gz') {
+            filename = filename.toLocaleLowerCase();
+        }
+        const arrayBuffer = textEncoder.encode(filename).buffer;
+        const md5 = await md5Hash.hash(arrayBuffer, 'hex');
+        hashArray.push(concatenateArrayBuffers(hexStringToBuffer(md5), bigintToBuffer(cdHeader.localHeaderOffset)));
     }
-    const arrayBuffer = textEncoder.encode(filename).buffer;
-    const md5 = await md5Hash.hash(arrayBuffer, 'hex');
-    hashArray.push(concatenateArrayBuffers(hexStringToBuffer(md5), bigintToBuffer(cdHeader.localHeaderOffset)));
-  }
-  const bufferArray = hashArray.sort(compareHashes);
-  return concatenateArrayBuffersFromArray(bufferArray);
+    const bufferArray = hashArray.sort(compareHashes);
+    return concatenateArrayBuffersFromArray(bufferArray);
 }
+/**
+ * Function to compare md5 hashes according to https://github.com/Esri/i3s-spec/blob/master/docs/2.0/slpk_hashtable.pcsl.md
+ * @param arrA first hash to compare
+ * @param arrB second hash to compare
+ * @returns 0 if equal, negative number if a<b, pozitive if a>b
+ */
 function compareHashes(arrA, arrB) {
-  const a = new BigUint64Array(arrA);
-  const b = new BigUint64Array(arrB);
-  return Number(a[0] === b[0] ? a[1] - b[1] : a[0] - b[0]);
+    const a = new BigUint64Array(arrA);
+    const b = new BigUint64Array(arrB);
+    return Number(a[0] === b[0] ? a[1] - b[1] : a[0] - b[0]);
 }
+/**
+ * converts hex string to buffer
+ * @param str hex string to convert
+ * @returns conversion result
+ */
 function hexStringToBuffer(str) {
-  var _str$match;
-  const byteArray = (_str$match = str.match(/../g)) === null || _str$match === void 0 ? void 0 : _str$match.map(h => parseInt(h, 16));
-  return new Uint8Array(byteArray !== null && byteArray !== void 0 ? byteArray : new Array(16)).buffer;
+    const byteArray = str.match(/../g)?.map((h) => parseInt(h, 16));
+    return new Uint8Array(byteArray ?? new Array(16)).buffer;
 }
+/**
+ * converts bigint to buffer
+ * @param n bigint to convert
+ * @returns convertion result
+ */
 function bigintToBuffer(n) {
-  return new BigUint64Array([n]).buffer;
+    return new BigUint64Array([n]).buffer;
 }
-//# sourceMappingURL=hash-file-utility.js.map