@loaders.gl/tile-converter 3.2.0-alpha.1 → 3.2.0-alpha.4

package/dist/i3s-converter/types.d.ts

@@ -1,39 +1,114 @@
-import { BoundingVolumes, I3SMaterialDefinition, SharedResources } from '@loaders.gl/i3s';
+import { BoundingVolumes, I3SMaterialDefinition, MaterialDefinitionInfo, TextureDefinitionInfo } from '@loaders.gl/i3s';
+import { ImageDataType } from '@loaders.gl/images';
+/** Converted resources for specific node */
 export declare type I3SConvertedResources = {
+    /** Non-compressed geometry buffer that have structure met
+     * https://github.com/Esri/i3s-spec/blob/master/docs/1.8/defaultGeometrySchema.cmn.md
+     * (Geometry buffer)
+     */
     geometry: ArrayBuffer | null;
-    compressedGeometry?: ArrayBuffer | null;
+    /**
+     * Draco compressed geometry
+     */
+    compressedGeometry?: Promise<ArrayBuffer> | null;
+    /**
+     * Texture image content
+     */
     texture: any | null;
-    sharedResources: SharedResources | null;
+    /**
+     * Shared resources built from GLTF material
+     */
+    sharedResources: SharedResourcesArrays | null;
+    /**
+     * Material definition of the node
+     */
     meshMaterial?: I3SMaterialDefinition | null;
+    /**
+     * Number of vertices in the node
+     */
     vertexCount: number | null;
-    attributes: any | null;
+    /**
+     * Feature attributes contents
+     */
+    attributes: ArrayBuffer[] | null;
+    /**
+     * Number of features in the node
+     */
     featureCount: number | null;
-    geometryBuffer?: ArrayBuffer;
+    /**
+     * MBS and/or OBB bounding volumes of the node
+     */
     boundingVolumes: BoundingVolumes | null;
 };
-export declare type AttributesData = {
+/**
+ * Geometry and feature attributes converted from GLTF primitives
+ */
+export declare type ConvertedAttributes = {
+    /** POSITION attribute value */
     positions: Float32Array;
+    /** NORMAL attribute value */
     normals: Float32Array;
+    /** TEXCOORD_0 attribute value */
     texCoords: Float32Array;
+    /** COLOR_0 attribute value */
     colors: Uint8Array;
+    /** Feature indices grouped by ...
+     * converted from "batch ids" of GLTF
+     */
+    featureIndicesGroups?: number[][];
+    /** Feature indices converted from "batch ids" */
     featureIndices: number[];
-    triangleCount: number;
-    boundingVolumes?: BoundingVolumes | null;
+    /**
+     * MBS and/or OBB bounding volumes of the node
+     */
+    boundingVolumes: null | BoundingVolumes;
 };
+/** Postprocessed geometry and feature attributes
+ * https://github.com/Esri/i3s-spec/blob/master/docs/1.8/defaultGeometrySchema.cmn.md
+ */
 export declare type GeometryAttributes = {
+    /** POSITION attribute value */
     positions: Float32Array;
+    /** NORMAL attribute value */
     normals: Float32Array;
+    /** TEXCOORD_0 attribute value */
     texCoords: Float32Array;
+    /** COLOR_0 attribute value */
     colors: Uint8Array;
+    /** faceRanges attribute value  */
     faceRange: Uint32Array;
+    /** feature Ids attribute value */
     featureIds: number[];
+    /** number of features in the node */
     featureCount: number;
 };
+/** Geometry attributes specific for the particular feature */
 export declare type GroupedByFeatureIdAttributes = {
+    /** Feature Id */
     featureId: number;
+    /** POSITION attribute value */
     positions: Float32Array;
+    /** NORMAL attribute value */
     normals: Float32Array;
+    /** COLOR_0 attribute value */
     colors: Uint8Array;
+    /** TEXCOORD_0 attribute value */
     texCoords: Float32Array;
 };
+/** Shared resources made from GLTF material */
+export declare type SharedResourcesArrays = {
+    /** material definitions list https://github.com/Esri/i3s-spec/blob/master/docs/1.8/materialDefinitionInfo.cmn.md */
+    materialDefinitionInfos?: MaterialDefinitionInfo[];
+    /** texture definitions list  https://github.com/Esri/i3s-spec/blob/master/docs/1.8/textureDefinitionInfo.cmn.md*/
+    textureDefinitionInfos?: TextureDefinitionInfo[];
+    /** node id to make unique SharedResource ids */
+    nodePath?: string;
+};
+/** I3S material definition and texture content taken from GLTF material */
+export declare type I3SMaterialWithTexture = {
+    /** Material definition https://github.com/Esri/i3s-spec/blob/master/docs/1.8/materialDefinitions.cmn.md */
+    material: I3SMaterialDefinition;
+    /** Texture content (image) */
+    texture?: ImageDataType;
+};
 //# sourceMappingURL=types.d.ts.map

package/dist/i3s-converter/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/i3s-converter/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,eAAe,EAAE,qBAAqB,EAAE,eAAe,EAAC,MAAM,iBAAiB,CAAC;AAExF,oBAAY,qBAAqB,GAAG;IAClC,QAAQ,EAAE,WAAW,GAAG,IAAI,CAAC;IAC7B,kBAAkB,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IACxC,OAAO,EAAE,GAAG,GAAG,IAAI,CAAC;IACpB,eAAe,EAAE,eAAe,GAAG,IAAI,CAAC;IACxC,YAAY,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAC5C,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,UAAU,EAAE,GAAG,GAAG,IAAI,CAAC;IACvB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,cAAc,CAAC,EAAE,WAAW,CAAC;IAC7B,eAAe,EAAE,eAAe,GAAG,IAAI,CAAC;CACzC,CAAC;AAEF,oBAAY,cAAc,GAAG;IAC3B,SAAS,EAAE,YAAY,CAAC;IACxB,OAAO,EAAE,YAAY,CAAC;IACtB,SAAS,EAAE,YAAY,CAAC;IACxB,MAAM,EAAE,UAAU,CAAC;IACnB,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;CAC1C,CAAC;AAEF,oBAAY,kBAAkB,GAAG;IAC/B,SAAS,EAAE,YAAY,CAAC;IACxB,OAAO,EAAE,YAAY,CAAC;IACtB,SAAS,EAAE,YAAY,CAAC;IACxB,MAAM,EAAE,UAAU,CAAC;IACnB,SAAS,EAAE,WAAW,CAAC;IACvB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,oBAAY,4BAA4B,GAAG;IACzC,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,YAAY,CAAC;IACxB,OAAO,EAAE,YAAY,CAAC;IACtB,MAAM,EAAE,UAAU,CAAC;IACnB,SAAS,EAAE,YAAY,CAAC;CACzB,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/i3s-converter/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EACf,qBAAqB,EACrB,sBAAsB,EACtB,qBAAqB,EACtB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAC,aAAa,EAAC,MAAM,oBAAoB,CAAC;AAEjD,4CAA4C;AAC5C,oBAAY,qBAAqB,GAAG;IAClC;;;OAGG;IACH,QAAQ,EAAE,WAAW,GAAG,IAAI,CAAC;IAC7B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;IACjD;;OAEG;IACH,OAAO,EAAE,GAAG,GAAG,IAAI,CAAC;IACpB;;OAEG;IACH,eAAe,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAC9C;;OAEG;IACH,YAAY,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAC5C;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B;;OAEG;IACH,UAAU,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;IACjC;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B;;OAEG;IACH,eAAe,EAAE,eAAe,GAAG,IAAI,CAAC;CACzC,CAAC;AAEF;;GAEG;AACH,oBAAY,mBAAmB,GAAG;IAChC,+BAA+B;IAC/B,SAAS,EAAE,YAAY,CAAC;IACxB,6BAA6B;IAC7B,OAAO,EAAE,YAAY,CAAC;IACtB,iCAAiC;IACjC,SAAS,EAAE,YAAY,CAAC;IACxB,8BAA8B;IAC9B,MAAM,EAAE,UAAU,CAAC;IACnB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC;IAClC,iDAAiD;IACjD,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB;;OAEG;IACH,eAAe,EAAE,IAAI,GAAG,eAAe,CAAC;CACzC,CAAC;AAEF;;GAEG;AACH,oBAAY,kBAAkB,GAAG;IAC/B,+BAA+B;IAC/B,SAAS,EAAE,YAAY,CAAC;IACxB,6BAA6B;IAC7B,OAAO,EAAE,YAAY,CAAC;IACtB,iCAAiC;IACjC,SAAS,EAAE,YAAY,CAAC;IACxB,8BAA8B;IAC9B,MAAM,EAAE,UAAU,CAAC;IACnB,kCAAkC;IAClC,SAAS,EAAE,WAAW,CAAC;IACvB,kCAAkC;IAClC,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,qCAAqC;IACrC,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,8DAA8D;AAC9D,oBAAY,4BAA4B,GAAG;IACzC,iBAAiB;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,+BAA+B;IAC/B,SAAS,EAAE,YAAY,CAAC;IACxB,6BAA6B;IAC7B,OAAO,EAAE,YAAY,CAAC;IACtB,8BAA8B;IAC9B,MAAM,EAAE,UAAU,CAAC;IACnB,iCAAiC;IACjC,SAAS,EAAE,YAAY,CAAC;CACzB,CAAC;AAEF,+CAA+C;AAC/C,oBAAY,qBAAqB,GAAG;IAClC,oHAAoH;IACpH,uBAAuB,CAAC,EAAE,sBAAsB,EAAE,CAAC;IACnD,kHAAkH;IAClH,sBAAsB,CAAC,EAAE,qBAAqB,EAAE,CAAC;IACjD,gDAAgD;IAChD,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,2EAA2E;AAC3E,oBAAY,sBAAsB,GAAG;IACnC,2GAA2G;IAC3G,QAAQ,EAAE,qBAAqB,CAAC;IAChC,8BAA8B;IAC9B,OAAO,CAAC,EAAE,aAAa,CAAC;CACzB,CAAC"}

package/dist/index.d.ts

@@ -1,5 +1,3 @@
 export { default as I3SConverter } from './i3s-converter/i3s-converter';
-export { default as NodePages } from './i3s-converter/helpers/node-pages';
 export { default as Tiles3DConverter } from './3d-tiles-converter/3d-tiles-converter';
-export { DepsInstaller } from './deps-installer/deps-installer';
 //# 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,OAAO,IAAI,YAAY,EAAC,MAAM,+BAA+B,CAAC;AACtE,OAAO,EAAC,OAAO,IAAI,SAAS,EAAC,MAAM,oCAAoC,CAAC;AAExE,OAAO,EAAC,OAAO,IAAI,gBAAgB,EAAC,MAAM,yCAAyC,CAAC;AAEpF,OAAO,EAAC,aAAa,EAAC,MAAM,iCAAiC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,IAAI,YAAY,EAAC,MAAM,+BAA+B,CAAC;AACtE,OAAO,EAAC,OAAO,IAAI,gBAAgB,EAAC,MAAM,yCAAyC,CAAC"}

package/dist/index.js

@@ -3,12 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DepsInstaller = exports.Tiles3DConverter = exports.NodePages = exports.I3SConverter = void 0;
+exports.Tiles3DConverter = exports.I3SConverter = void 0;
 var i3s_converter_1 = require("./i3s-converter/i3s-converter");
 Object.defineProperty(exports, "I3SConverter", { enumerable: true, get: function () { return __importDefault(i3s_converter_1).default; } });
-var node_pages_1 = require("./i3s-converter/helpers/node-pages");
-Object.defineProperty(exports, "NodePages", { enumerable: true, get: function () { return __importDefault(node_pages_1).default; } });
 var _3d_tiles_converter_1 = require("./3d-tiles-converter/3d-tiles-converter");
 Object.defineProperty(exports, "Tiles3DConverter", { enumerable: true, get: function () { return __importDefault(_3d_tiles_converter_1).default; } });
-var deps_installer_1 = require("./deps-installer/deps-installer");
-Object.defineProperty(exports, "DepsInstaller", { enumerable: true, get: function () { return deps_installer_1.DepsInstaller; } });

package/dist/lib/utils/compress-util.d.ts

@@ -1,6 +1,45 @@
-export function compressFileWithGzip(pathFile: any): Promise<any>;
-export function compressFilesWithZip(fileMap: any, outputFile: any, level?: number): Promise<any>;
-export function compressWithChildProcess(...args: any[]): Promise<void>;
-export function generateHash128FromZip(inputZipFile: any, outputFile: any): Promise<any>;
-export function addFileToZip(inputFolder: any, fileName: any, zipFile: any, sevenZipExe: any): Promise<void>;
+/**
+ * Compress file to gzip file
+ *
+ * @param pathFile - the path to the file
+ * @return the path to the gzip file
+ */
+export declare function compressFileWithGzip(pathFile: string): Promise<string>;
+/**
+ * Compress files from map into slpk file
+ *
+ * @param fileMap - map with file paths (key: output path, value: input path)
+ * @param outputFile - output slpk file
+ * @param level - compression level
+ */
+export declare function compressFilesWithZip(fileMap: {
+    [key: string]: string;
+}, outputFile: string, level?: number): Promise<unknown>;
+/**
+ * Compress files using external tool 'zip'/'7z'
+ *
+ * @param inputFolder - folder to archive - for cwd option
+ * @param outputFile - output slpk file
+ * @param level - compression level
+ * @param inputFiles - input files path to pass to the executable as option
+ * @param sevenZipExe - path to 7z.exe executable
+ */
+export declare function compressWithChildProcess(inputFolder: string, outputFile: string, level: number, inputFiles: string, sevenZipExe: string): Promise<void>;
+/**
+ * Generate hash file from zip archive
+ * https://github.com/Esri/i3s-spec/blob/master/docs/1.7/slpk_hashtable.cmn.md
+ *
+ * @param inputZipFile
+ * @param outputFile
+ */
+export declare function generateHash128FromZip(inputZipFile: string, outputFile: string): Promise<unknown>;
+/**
+ * Add file to zip archive
+ *
+ * @param inputFile
+ * @param fileName
+ * @param zipFile
+ * @param sevenZipExe
+ */
+export declare function addFileToZip(inputFolder: string, fileName: string, zipFile: string, sevenZipExe: string): Promise<void>;
 //# sourceMappingURL=compress-util.d.ts.map

package/dist/lib/utils/compress-util.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"compress-util.d.ts","sourceRoot":"","sources":["../../../src/lib/utils/compress-util.js"],"names":[],"mappings":"AAWA,kEAiBC;AAED,kGAoDC;AAED,wEAOC;AA0CD,yFA6CC;AASD,6GAGC"}
+{"version":3,"file":"compress-util.d.ts","sourceRoot":"","sources":["../../../src/lib/utils/compress-util.ts"],"names":[],"mappings":"AAWA;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAiBtE;AAED;;;;;;GAMG;AACH,wBAAsB,oBAAoB,CACxC,OAAO,EAAE;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAC,EAChC,UAAU,EAAE,MAAM,EAClB,KAAK,GAAE,MAAU,oBAqDlB;AAED;;;;;;;;GAQG;AACH,wBAAsB,wBAAwB,CAC5C,WAAW,EAAE,MAAM,EACnB,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,MAAM,EAClB,WAAW,EAAE,MAAM,iBAQpB;AAgED;;;;;;GAMG;AACH,wBAAsB,sBAAsB,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,oBA6CpF;AAeD;;;;;;;GAOG;AACH,wBAAsB,YAAY,CAChC,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,MAAM,iBAIpB"}

package/dist/lib/utils/compress-util.js

@@ -14,6 +14,12 @@ const jszip_1 = __importDefault(require("jszip"));
 const crypto_1 = require("@loaders.gl/crypto");
 const crypt_1 = __importDefault(require("crypt"));
 const file_utils_2 = require("./file-utils");
+/**
+ * Compress file to gzip file
+ *
+ * @param pathFile - the path to the file
+ * @return the path to the gzip file
+ */
 function compressFileWithGzip(pathFile) {
     const compressedPathFile = `${pathFile}.gz`;
     const gzip = (0, zlib_1.createGzip)();
@@ -32,6 +38,13 @@ function compressFileWithGzip(pathFile) {
     });
 }
 exports.compressFileWithGzip = compressFileWithGzip;
+/**
+ * Compress files from map into slpk file
+ *
+ * @param fileMap - map with file paths (key: output path, value: input path)
+ * @param outputFile - output slpk file
+ * @param level - compression level
+ */
 async function compressFilesWithZip(fileMap, outputFile, level = 0) {
     // Before creating a new file, we need to delete the old file
     try {
@@ -79,16 +92,33 @@ async function compressFilesWithZip(fileMap, outputFile, level = 0) {
     });
 }
 exports.compressFilesWithZip = compressFilesWithZip;
-async function compressWithChildProcess() {
+/**
+ * Compress files using external tool 'zip'/'7z'
+ *
+ * @param inputFolder - folder to archive - for cwd option
+ * @param outputFile - output slpk file
+ * @param level - compression level
+ * @param inputFiles - input files path to pass to the executable as option
+ * @param sevenZipExe - path to 7z.exe executable
+ */
+async function compressWithChildProcess(inputFolder, outputFile, level, inputFiles, sevenZipExe) {
     // eslint-disable-next-line no-undef
     if (process.platform === 'win32') {
-        await compressWithChildProcessWindows(...arguments);
+        await compressWithChildProcessWindows(inputFolder, outputFile, level, inputFiles, sevenZipExe);
     }
     else {
-        await compressWithChildProcessUnix(...arguments);
+        await compressWithChildProcessUnix(inputFolder, outputFile, level, inputFiles);
     }
 }
 exports.compressWithChildProcess = compressWithChildProcess;
+/**
+ * Compress files using external linux tool 'zip'
+ *
+ * @param inputFolder - folder to archive - for cwd option
+ * @param outputFile - output slpk file
+ * @param level - compression level
+ * @param inputFiles - input files path to pass to the executable as option
+ */
 async function compressWithChildProcessUnix(inputFolder, outputFile, level = 0, inputFiles = '.') {
     const fullOutputFile = (0, file_utils_2.getAbsoluteFilePath)(outputFile);
     const args = [`-${level}`, '-r', fullOutputFile, inputFiles];
@@ -102,6 +132,15 @@ async function compressWithChildProcessUnix(inputFolder, outputFile, level = 0,
         wait: 0
     });
 }
+/**
+ * Compress files using windows external tool '7z'
+ *
+ * @param inputFolder - folder to archive - for cwd option
+ * @param outputFile - output slpk file
+ * @param level - compression level
+ * @param inputFiles - input files path to pass to the executable as option
+ * @param sevenZipExe - path to 7z.exe executable
+ */
 async function compressWithChildProcessWindows(inputFolder, outputFile, level = 0, inputFiles = (0, path_1.join)('.', '*'), sevenZipExe) {
     // Workaround for @listfile issue. In 7z.exe @-leading files are handled as listfiles
     // https://sevenzip.osdn.jp/chm/cmdline/syntax.htm
@@ -120,6 +159,13 @@ async function compressWithChildProcessWindows(inputFolder, outputFile, level =
         wait: 0
     });
 }
+/**
+ * Generate hash file from zip archive
+ * https://github.com/Esri/i3s-spec/blob/master/docs/1.7/slpk_hashtable.cmn.md
+ *
+ * @param inputZipFile
+ * @param outputFile
+ */
 async function generateHash128FromZip(inputZipFile, outputFile) {
     const input = await fs_1.promises.readFile(inputZipFile);
     const zip = await jszip_1.default.loadAsync(input);
@@ -157,7 +203,7 @@ async function generateHash128FromZip(inputZipFile, outputFile) {
         });
         for (const key in hashTable) {
             const item = hashTable[key];
-            const value = _longToByteArray(item.value);
+            const value = longToByteArray(item.value);
             // TODO: perhaps you need to wait for the 'drain' event if the write returns 'false'
             // eslint-disable-next-line no-undef
             output.write(Buffer.from(crypt_1.default.hexToBytes(item.key).concat(value)));
@@ -166,17 +212,38 @@ async function generateHash128FromZip(inputZipFile, outputFile) {
     });
 }
 exports.generateHash128FromZip = generateHash128FromZip;
-function _longToByteArray(long) {
+/**
+ * Encode 64 bit value to byte array
+ *
+ * @param long - stringified number
+ * @returns
+ */
+function longToByteArray(long) {
     const buffer = new ArrayBuffer(8); // JS numbers are 8 bytes long, or 64 bits
     const longNum = new Float64Array(buffer); // so equivalent to Float64
-    longNum[0] = long;
+    longNum[0] = parseInt(long);
     return Array.from(new Uint8Array(buffer)).reverse(); // reverse to get little endian
 }
+/**
+ * Add file to zip archive
+ *
+ * @param inputFile
+ * @param fileName
+ * @param zipFile
+ * @param sevenZipExe
+ */
 async function addFileToZip(inputFolder, fileName, zipFile, sevenZipExe) {
     await compressWithChildProcess(inputFolder, zipFile, 0, fileName, sevenZipExe);
     console.log(`${fileName} added to ${zipFile}.`); // eslint-disable-line
 }
 exports.addFileToZip = addFileToZip;
+/**
+ *
+ * @param archive zip archive instance
+ * @param subFileName file path inside archive
+ * @param subFileData source file path
+ * @returns
+ */
 function appendFileToArchive(archive, subFileName, subFileData) {
     return new Promise((resolve) => {
         const fileStream = (0, fs_1.createReadStream)(subFileData);

package/dist/lib/utils/file-utils.d.ts

@@ -1,6 +1,35 @@
-export function writeFile(path: any, data: any, fileName?: string): Promise<string>;
-export function writeFileForSlpk(path: any, data: any, fileName?: string, compress?: boolean): Promise<string>;
-export function removeDir(path: any): Promise<void>;
-export function removeFile(path: any): Promise<void>;
-export function getAbsoluteFilePath(filePath: any): any;
+/**
+ * Write a file with data and name fileName to path
+ *
+ * @param path - output path
+ * @param data - file content
+ * @param fileName - name of output file (default: index.json)
+ */
+export declare function writeFile(path: string, data: string | Uint8Array | ArrayBuffer | Promise<ArrayBuffer>, fileName?: string): Promise<string>;
+/**
+ * Write a file with data and name fileName to path - specific one for further packaging into slpk
+ *
+ * @param path - output path
+ * @param data - file content
+ * @param fileName - name of output file (default: index.json)
+ * @param compress - if need to compress file with gzip (default: true)
+ */
+export declare function writeFileForSlpk(path: string, data: string | Uint8Array | ArrayBuffer | Promise<ArrayBuffer>, fileName?: string, compress?: boolean): Promise<string>;
+/**
+ * Remove dir with path
+ *
+ * @param path
+ */
+export declare function removeDir(path: string): Promise<void>;
+/**
+ * Remove file with path
+ *
+ * @param path
+ */
+export declare function removeFile(path: string): Promise<void>;
+/**
+ * Generates absolute file path
+ * @param filePath
+ */
+export declare function getAbsoluteFilePath(filePath: string): string;
 //# sourceMappingURL=file-utils.d.ts.map

package/dist/lib/utils/file-utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"file-utils.d.ts","sourceRoot":"","sources":["../../../src/lib/utils/file-utils.js"],"names":[],"mappings":"AAIA,oFAUC;AAED,+GASC;AAED,oDAEC;AAED,qDAEC;AAED,wDAEC"}
+{"version":3,"file":"file-utils.d.ts","sourceRoot":"","sources":["../../../src/lib/utils/file-utils.ts"],"names":[],"mappings":"AAIA;;;;;;GAMG;AACH,wBAAsB,SAAS,CAC7B,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,EAC9D,QAAQ,GAAE,MAAqB,GAC9B,OAAO,CAAC,MAAM,CAAC,CAkBjB;AAED;;;;;;;GAOG;AACH,wBAAsB,gBAAgB,CACpC,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,EAC9D,QAAQ,GAAE,MAAqB,EAC/B,QAAQ,GAAE,OAAc,GACvB,OAAO,CAAC,MAAM,CAAC,CASjB;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,iBAErC;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,iBAEtC;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,UAEnD"}

package/dist/lib/utils/file-utils.js

@@ -4,11 +4,28 @@ exports.getAbsoluteFilePath = exports.removeFile = exports.removeDir = exports.w
 const fs_1 = require("fs");
 const path_1 = require("path");
 const compress_util_1 = require("./compress-util");
+/**
+ * Write a file with data and name fileName to path
+ *
+ * @param path - output path
+ * @param data - file content
+ * @param fileName - name of output file (default: index.json)
+ */
 async function writeFile(path, data, fileName = 'index.json') {
+    let toWriteData;
+    if (data instanceof Promise) {
+        toWriteData = new Uint8Array(await data);
+    }
+    else if (data instanceof ArrayBuffer) {
+        toWriteData = new Uint8Array(data);
+    }
+    else {
+        toWriteData = data;
+    }
     await fs_1.promises.mkdir(path, { recursive: true });
     const pathFile = (0, path_1.join)(path, fileName);
     try {
-        await fs_1.promises.writeFile(pathFile, data);
+        await fs_1.promises.writeFile(pathFile, toWriteData);
     }
     catch (err) {
         throw err;
@@ -17,6 +34,14 @@ async function writeFile(path, data, fileName = 'index.json') {
     return pathFile;
 }
 exports.writeFile = writeFile;
+/**
+ * Write a file with data and name fileName to path - specific one for further packaging into slpk
+ *
+ * @param path - output path
+ * @param data - file content
+ * @param fileName - name of output file (default: index.json)
+ * @param compress - if need to compress file with gzip (default: true)
+ */
 async function writeFileForSlpk(path, data, fileName = 'index.json', compress = true) {
     const pathFile = await writeFile(path, data, fileName);
     if (compress) {
@@ -28,14 +53,28 @@ async function writeFileForSlpk(path, data, fileName = 'index.json', compress =
     return pathFile;
 }
 exports.writeFileForSlpk = writeFileForSlpk;
+/**
+ * Remove dir with path
+ *
+ * @param path
+ */
 function removeDir(path) {
     return fs_1.promises.rmdir(path, { recursive: true });
 }
 exports.removeDir = removeDir;
+/**
+ * Remove file with path
+ *
+ * @param path
+ */
 function removeFile(path) {
     return fs_1.promises.unlink(path);
 }
 exports.removeFile = removeFile;
+/**
+ * Generates absolute file path
+ * @param filePath
+ */
 function getAbsoluteFilePath(filePath) {
     return (0, path_1.isAbsolute)(filePath) ? filePath : (0, path_1.join)(process.cwd(), filePath); // eslint-disable-line no-undef
 }

package/dist/lib/utils/lod-conversion-utils.d.ts

@@ -1,7 +1,8 @@
+import { BoundingVolumes } from '@loaders.gl/i3s';
+import { Tile3D } from '@loaders.gl/tiles';
 /**
  * Do conversion from geometric error to screen threshold
- * @param {Object} tile
- * @param {Object} coordinates
+ *
  * In 3DTiles we have HLOD logic and parent tile also has bigger lodMetric value then its children.
  * In I3s we have reverse logic related to maxError. Parent has lower maxError than its child.
  * In nodes where are no children tile.lodMetricValue is 0. This is because of logic of HLOD in 3DTiles
@@ -11,10 +12,30 @@
  * https://github.com/Esri/i3s-spec/blob/master/docs/1.7/lodSelection.cmn.md
  * To avoid infinity values when we do calculations of maxError we shold replace 0 with value which allows us
  * to make child maxError bigger than his parent maxError.
+ *
+ * @param tile - 3d-tiles tile Object
+ * @param coordinates - node converted coordinates
+ * @returns An array of LOD metrics in format compatible with i3s 3DNodeIndexDocument.lodSelection
+ * @example
+ *  [
+        {
+            "metricType": "maxScreenThresholdSQ",
+            "maxError": 870638.071285568
+        },
+        {
+            "metricType": "maxScreenThreshold",
+            "maxError": 1052.8679031638949
+        }
+    ]
  */
-export function convertGeometricErrorToScreenThreshold(tile: any, coordinates: any): {
+export declare function convertGeometricErrorToScreenThreshold(tile: Tile3D, coordinates: BoundingVolumes): {
     metricType: string;
     maxError: number;
 }[];
-export function convertScreenThresholdToGeometricError(node: any): number;
+/**
+ * Convert LOD metric from "Screen Threshold" to "Screen Space Error"
+ * @param node - i3s node data
+ * @returns lod metric in 3d-tiles format
+ */
+export declare function convertScreenThresholdToGeometricError(node: Tile3D): number;
 //# sourceMappingURL=lod-conversion-utils.d.ts.map

package/dist/lib/utils/lod-conversion-utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"lod-conversion-utils.d.ts","sourceRoot":"","sources":["../../../src/lib/utils/lod-conversion-utils.js"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;GAaG;AACH;;;IAsBC;AAED,0EAeC"}
+{"version":3,"file":"lod-conversion-utils.d.ts","sourceRoot":"","sources":["../../../src/lib/utils/lod-conversion-utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,eAAe,EAAC,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAC,MAAM,EAAC,MAAM,mBAAmB,CAAC;AAIzC;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,sCAAsC,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,eAAe;gBAC9D,MAAM;cAAY,MAAM;IAqB1D;AAED;;;;GAIG;AACH,wBAAgB,sCAAsC,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAe3E"}

package/dist/lib/utils/lod-conversion-utils.js

@@ -5,8 +5,7 @@ exports.convertScreenThresholdToGeometricError = exports.convertGeometricErrorTo
 const DEFAULT_MAXIMUM_SCREEN_SPACE_ERROR = 16;
 /**
  * Do conversion from geometric error to screen threshold
- * @param {Object} tile
- * @param {Object} coordinates
+ *
  * In 3DTiles we have HLOD logic and parent tile also has bigger lodMetric value then its children.
  * In I3s we have reverse logic related to maxError. Parent has lower maxError than its child.
  * In nodes where are no children tile.lodMetricValue is 0. This is because of logic of HLOD in 3DTiles
@@ -16,6 +15,21 @@ const DEFAULT_MAXIMUM_SCREEN_SPACE_ERROR = 16;
  * https://github.com/Esri/i3s-spec/blob/master/docs/1.7/lodSelection.cmn.md
  * To avoid infinity values when we do calculations of maxError we shold replace 0 with value which allows us
  * to make child maxError bigger than his parent maxError.
+ *
+ * @param tile - 3d-tiles tile Object
+ * @param coordinates - node converted coordinates
+ * @returns An array of LOD metrics in format compatible with i3s 3DNodeIndexDocument.lodSelection
+ * @example
+ *  [
+        {
+            "metricType": "maxScreenThresholdSQ",
+            "maxError": 870638.071285568
+        },
+        {
+            "metricType": "maxScreenThreshold",
+            "maxError": 1052.8679031638949
+        }
+    ]
  */
 function convertGeometricErrorToScreenThreshold(tile, coordinates) {
     const lodSelection = [];
@@ -40,6 +54,11 @@ function convertGeometricErrorToScreenThreshold(tile, coordinates) {
     return lodSelection;
 }
 exports.convertGeometricErrorToScreenThreshold = convertGeometricErrorToScreenThreshold;
+/**
+ * Convert LOD metric from "Screen Threshold" to "Screen Space Error"
+ * @param node - i3s node data
+ * @returns lod metric in 3d-tiles format
+ */
 function convertScreenThresholdToGeometricError(node) {
     const metricData = node.header.lodSelection.maxScreenThreshold || {};
     let maxError = metricData.maxError;

package/dist/lib/utils/queue.d.ts

@@ -0,0 +1,7 @@
+export declare class Queue<T> extends Array<T> {
+    enqueue(val: T): void;
+    dequeue(): T | undefined;
+    peek(): T;
+    isEmpty(): boolean;
+}
+//# sourceMappingURL=queue.d.ts.map

package/dist/lib/utils/queue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"queue.d.ts","sourceRoot":"","sources":["../../../src/lib/utils/queue.ts"],"names":[],"mappings":"AAAA,qBAAa,KAAK,CAAC,CAAC,CAAE,SAAQ,KAAK,CAAC,CAAC,CAAC;IACpC,OAAO,CAAC,GAAG,EAAE,CAAC;IAId,OAAO,IAAI,CAAC,GAAG,SAAS;IAIxB,IAAI,IAAI,CAAC;IAIT,OAAO;CAGR"}

package/dist/lib/utils/queue.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Queue = void 0;
+class Queue extends Array {
+    enqueue(val) {
+        this.push(val);
+    }
+    dequeue() {
+        return this.shift();
+    }
+    peek() {
+        return this[0];
+    }
+    isEmpty() {
+        return this.length === 0;
+    }
+}
+exports.Queue = Queue;

package/dist/lib/utils/statistic-utills.d.ts

@@ -1,3 +1,3 @@
-export function timeConverter(time: any): string;
-export function calculateFilesSize(params: any): Promise<number | null>;
+export declare function timeConverter(time: any): string;
+export declare function calculateFilesSize(params: any): Promise<number | null>;
 //# sourceMappingURL=statistic-utills.d.ts.map

package/dist/lib/utils/statistic-utills.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"statistic-utills.d.ts","sourceRoot":"","sources":["../../../src/lib/utils/statistic-utills.js"],"names":[],"mappings":"AAIA,iDA4BC;AAED,wEAkBC"}
+{"version":3,"file":"statistic-utills.d.ts","sourceRoot":"","sources":["../../../src/lib/utils/statistic-utills.ts"],"names":[],"mappings":"AAIA,wBAAgB,aAAa,CAAC,IAAI,KAAA,UA4BjC;AAED,wBAAsB,kBAAkB,CAAC,MAAM,KAAA,0BAkB9C"}

package/dist/lib/utils/write-queue.d.ts

@@ -0,0 +1,22 @@
+import { Queue } from './queue';
+export declare type WriteQueueItem = {
+    archiveKey?: string;
+    writePromise: Promise<string>;
+};
+export default class WriteQueue<T extends WriteQueueItem> extends Queue<T> {
+    private intervalId?;
+    writePromise: Promise<void> | null;
+    fileMap: {
+        [key: string]: string;
+    };
+    listeningInterval: number;
+    writeConcurrency: number;
+    constructor(listeningInterval?: number, writeConcurrency?: number);
+    startListening(): void;
+    stopListening(): void;
+    startWrite(): Promise<void>;
+    finalize(): Promise<void>;
+    private doWrite;
+    private updateFileMap;
+}
+//# sourceMappingURL=write-queue.d.ts.map

package/dist/lib/utils/write-queue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"write-queue.d.ts","sourceRoot":"","sources":["../../../src/lib/utils/write-queue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,EAAC,MAAM,SAAS,CAAC;AAE9B,oBAAY,cAAc,GAAG;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;CAC/B,CAAC;AAEF,MAAM,CAAC,OAAO,OAAO,UAAU,CAAC,CAAC,SAAS,cAAc,CAAE,SAAQ,KAAK,CAAC,CAAC,CAAC;IACxE,OAAO,CAAC,UAAU,CAAC,CAAiB;IAC7B,YAAY,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAQ;IAC1C,OAAO,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAC,CAAM;IACtC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,gBAAgB,EAAE,MAAM,CAAC;gBAEpB,iBAAiB,GAAE,MAAa,EAAE,gBAAgB,GAAE,MAAY;IAM5E,cAAc;IAId,aAAa;IAMP,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAW3B,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;YAKjB,OAAO;IAmBrB,OAAO,CAAC,aAAa;CAStB"}