@loaders.gl/tile-converter 4.0.0-alpha.14 → 4.0.0-alpha.15

package/dist/slpk-extractor/helpers/file-handle-provider.d.ts

@@ -1,6 +1,4 @@
-/// <reference types="node" />
 import { FileProvider } from '@loaders.gl/i3s';
-import { PathLike } from 'fs';
 /**
  * Provides file data using node fs library
  */
@@ -9,7 +7,7 @@ export declare class FileHandleProvider implements FileProvider {
      * Returns a new copy of FileHandleProvider
      * @param path The path to the file in file system
      */
-    static from(path: PathLike): Promise<FileHandleProvider>;
+    static from(path: string): Promise<FileHandleProvider>;
     /**
      * The FileHandle from which data is provided
      */
@@ -20,29 +18,34 @@ export declare class FileHandleProvider implements FileProvider {
     private size;
     private constructor();
     /**
-     * Gets an unsigned 8-bit integer (unsigned byte) at the specified byte offset from the start of the file.
+     * 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.
      */
-    getUint8(offset: number): Promise<number>;
+    getUint8(offset: bigint): Promise<number>;
     /**
-     * Gets an unsigned 16-bit integer (unsigned byte) at the specified byte offset from the start of the file.
+     * 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.
      */
-    getUint16(offset: number): Promise<number>;
+    getUint16(offset: bigint): Promise<number>;
     /**
-     * Gets an unsigned 32-bit integer (unsigned byte) at the specified byte offset from the start of the file.
+     * 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.
      */
-    getUint32(offset: number): Promise<number>;
+    getUint32(offset: bigint): Promise<number>;
+    /**
+     * 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.
+     */
+    getBigUint64(offset: bigint): Promise<bigint>;
     /**
      * returns an ArrayBuffer whose contents are a copy of this file bytes from startOffset, inclusive, up to endOffset, exclusive.
-     * @param startOffset The offset, in bytes, from the start of the file where to start reading the data.
+     * @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.
      */
-    slice(startOffset: number, endOffset: number): Promise<ArrayBuffer>;
+    slice(startOffsset: bigint, endOffset: bigint): Promise<ArrayBuffer>;
     /**
      * the length (in bytes) of the data.
      */
-    get length(): number;
+    get length(): bigint;
 }
 //# sourceMappingURL=file-handle-provider.d.ts.map

package/dist/slpk-extractor/helpers/file-handle-provider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"file-handle-provider.d.ts","sourceRoot":"","sources":["../../../src/slpk-extractor/helpers/file-handle-provider.ts"],"names":[],"mappings":";AAAA,OAAO,EAAC,YAAY,EAAC,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAyB,QAAQ,EAAC,MAAM,IAAI,CAAC;AAEpD;;GAEG;AACH,qBAAa,kBAAmB,YAAW,YAAY;IACrD;;;OAGG;WACU,IAAI,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAK9D;;OAEG;IACH,OAAO,CAAC,cAAc,CAAwB;IAE9C;;OAEG;IACH,OAAO,CAAC,IAAI,CAAS;IAErB,OAAO;IAKP;;;OAGG;IACG,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAU/C;;;OAGG;IACG,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAUhD;;;OAGG;IACG,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAUhD;;;;OAIG;IACG,KAAK,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAMzE;;OAEG;IACH,IAAI,MAAM,IAAI,MAAM,CAEnB;CACF"}
+{"version":3,"file":"file-handle-provider.d.ts","sourceRoot":"","sources":["../../../src/slpk-extractor/helpers/file-handle-provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAC,MAAM,iBAAiB,CAAC;AAG7C;;GAEG;AACH,qBAAa,kBAAmB,YAAW,YAAY;IACrD;;;OAGG;WACU,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAK5D;;OAEG;IACH,OAAO,CAAC,cAAc,CAAa;IAEnC;;OAEG;IACH,OAAO,CAAC,IAAI,CAAS;IAErB,OAAO;IAKP;;;OAGG;IACG,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAU/C;;;OAGG;IACG,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAUhD;;;OAGG;IACG,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAUhD;;;OAGG;IACG,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAUnD;;;;OAIG;IACG,KAAK,CAAC,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAU1E;;OAEG;IACH,IAAI,MAAM,IAAI,MAAM,CAEnB;CACF"}

package/dist/slpk-extractor/helpers/file-handle-provider.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FileHandleProvider = void 0;
-const fs_1 = require("fs");
+const fs_promises_1 = require("./fs-promises");
 /**
  * Provides file data using node fs library
  */
@@ -11,15 +11,15 @@ class FileHandleProvider {
      * @param path The path to the file in file system
      */
     static async from(path) {
-        const fileDescriptor = await fs_1.promises.open(path);
-        return new FileHandleProvider(fileDescriptor, (await fileDescriptor.stat()).size);
+        const fileDescriptor = await fs_promises_1.FileHandle.open(path);
+        return new FileHandleProvider(fileDescriptor, fileDescriptor.stat.size);
     }
     constructor(fileDescriptor, size) {
         this.fileDescriptor = fileDescriptor;
         this.size = size;
     }
     /**
-     * Gets an unsigned 8-bit integer (unsigned byte) at the specified byte offset from the start of the file.
+     * 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) {
@@ -30,7 +30,7 @@ class FileHandleProvider {
         return val;
     }
     /**
-     * Gets an unsigned 16-bit integer (unsigned byte) at the specified byte offset from the start of the file.
+     * 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) {
@@ -41,7 +41,7 @@ class FileHandleProvider {
         return val;
     }
     /**
-     * Gets an unsigned 32-bit integer (unsigned byte) at the specified byte offset from the start of the file.
+     * 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) {
@@ -51,14 +51,29 @@ class FileHandleProvider {
         }
         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, 4, 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 startOffset The offset, in bytes, from the start of the file where to start reading the data.
+     * @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(startOffset, endOffset) {
-        const length = endOffset - startOffset;
-        return (await this.fileDescriptor.read(Buffer.alloc(length), 0, length, startOffset)).buffer
+    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;
     }
     /**

package/dist/slpk-extractor/helpers/fs-promises.d.ts

@@ -0,0 +1,38 @@
+/// <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>;
+    /**
+     * 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=fs-promises.d.ts.map

package/dist/slpk-extractor/helpers/fs-promises.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fs-promises.d.ts","sourceRoot":"","sources":["../../../src/slpk-extractor/helpers/fs-promises.ts"],"names":[],"mappings":";;AAAA,OAAO,EAAmB,WAAW,EAAC,MAAM,IAAI,CAAC;AAEjD,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;;;;;;;;;;;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/slpk-extractor/helpers/fs-promises.js

@@ -0,0 +1,51 @@
+"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;
+    }
+    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/slpk-extractor/slpk-extractor.d.ts

@@ -1,9 +1,9 @@
 /**
  * Converter from slpk to i3s
  */
-export default class SLPKExtractor {
+export default class SLPKConverter {
     /**
-     * extract slpk to i3s
+     * Extract slpk to i3s
      * @param options
      * @param options.inputUrl the url to read SLPK file
      * @param options.outputPath the output filename

package/dist/slpk-extractor/slpk-extractor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"slpk-extractor.d.ts","sourceRoot":"","sources":["../../src/slpk-extractor/slpk-extractor.ts"],"names":[],"mappings":"AA0BA;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,aAAa;IAChC;;;;;OAKG;IACU,OAAO,CAAC,OAAO,EAAE;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IA8BtF;;;OAGG;IACH,OAAO,CAAC,iBAAiB;YAYX,MAAM;YAUN,SAAS;CASxB"}
+{"version":3,"file":"slpk-extractor.d.ts","sourceRoot":"","sources":["../../src/slpk-extractor/slpk-extractor.ts"],"names":[],"mappings":"AAuBA;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,aAAa;IAChC;;;;;OAKG;IACU,OAAO,CAAC,OAAO,EAAE;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IA8BtF;;;OAGG;IAEH,OAAO,CAAC,iBAAiB;YAYX,MAAM;YAWN,SAAS;CASxB"}

package/dist/slpk-extractor/slpk-extractor.js

@@ -7,9 +7,6 @@ const i3s_1 = require("@loaders.gl/i3s");
 const loader_utils_1 = require("@loaders.gl/loader-utils");
 const compression_1 = require("@loaders.gl/compression");
 const file_utils_1 = require("../lib/utils/file-utils");
-/**
- * names of files that should be changed to index
- */
 const indexNames = [
     '3dSceneLayer.json.gz',
     '3dNodeIndexDocument.json.gz',
@@ -18,9 +15,9 @@ const indexNames = [
 /**
  * Converter from slpk to i3s
  */
-class SLPKExtractor {
+class SLPKConverter {
     /**
-     * extract slpk to i3s
+     * Extract slpk to i3s
      * @param options
      * @param options.inputUrl the url to read SLPK file
      * @param options.outputPath the output filename
@@ -32,7 +29,7 @@ class SLPKExtractor {
         }
         const { inputUrl } = options;
         const provider = await file_handle_provider_1.FileHandleProvider.from(inputUrl);
-        let localHeader = await (0, i3s_1.parseZipLocalFileHeader)(0, provider);
+        let localHeader = await (0, i3s_1.parseZipLocalFileHeader)(0n, provider);
         while (localHeader) {
             await this.writeFile(await this.unGzip({
                 name: this.correctIndexNames(localHeader.fileName),
@@ -75,4 +72,4 @@ class SLPKExtractor {
         await (0, file_utils_1.writeFile)(dirName, options.data, fileName);
     }
 }
-exports.default = SLPKExtractor;
+exports.default = SLPKConverter;