@loaders.gl/tile-converter 4.3.0-alpha.4 → 4.3.0-alpha.6

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

@@ -0,0 +1,20 @@
+/**
+ * Converts time value to string.
+ * @param time - high-resolution real time in a [seconds, nanoseconds] tuple Array, or a value on milliseconds.
+ * @returns string representation of the time
+ */
+export declare function timeConverter(time: number | [number, number]): string;
+/**
+ * Calculates overall datatset size
+ * @param params - params object
+ * @param params.slpk - if dataset is in slpk format
+ * @param params.outputPath - path to the folder containing the dataset
+ * @param params.tilesetName - tileset name
+ * @returns dataset size in bytes
+ */
+export declare function calculateDatasetSize(params: {
+    slpk?: boolean;
+    outputPath: string;
+    tilesetName: string;
+}): Promise<number | null>;
+//# sourceMappingURL=statistic-utils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"statistic-utils.d.ts","sourceRoot":"","sources":["../../../src/lib/utils/statistic-utils.ts"],"names":[],"mappings":"AAIA;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,CAarE;AA6BD;;;;;;;GAOG;AACH,wBAAsB,oBAAoB,CAAC,MAAM,EAAE;IACjD,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;CACrB,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAkBzB"}

package/dist/lib/utils/{statistic-utills.js → statistic-utils.js}

@@ -41,7 +41,15 @@ function timeConverterFromSecondsAndMilliseconds(timeInSeconds, milliseconds) {
     }
     return result;
 }
-export async function calculateFilesSize(params) {
+/**
+ * Calculates overall datatset size
+ * @param params - params object
+ * @param params.slpk - if dataset is in slpk format
+ * @param params.outputPath - path to the folder containing the dataset
+ * @param params.tilesetName - tileset name
+ * @returns dataset size in bytes
+ */
+export async function calculateDatasetSize(params) {
     const { slpk, outputPath, tilesetName } = params;
     const fullOutputPath = getAbsoluteFilePath(outputPath);
     try {
@@ -51,7 +59,7 @@ export async function calculateFilesSize(params) {
             return stat.size;
         }
         const directoryPath = join(fullOutputPath, tilesetName);
-        const totalSize = await getTotalFilesSize(directoryPath);
+        const totalSize = await getDirectorySize(directoryPath);
         return totalSize;
     }
     catch (error) {
@@ -59,13 +67,18 @@ export async function calculateFilesSize(params) {
         return null;
     }
 }
-async function getTotalFilesSize(dirPath) {
+/**
+ * Calculates directory size
+ * @param dirPath - path to the directory
+ * @returns directory size in bytes
+ */
+async function getDirectorySize(dirPath) {
     let totalFileSize = 0;
     const files = await fs.readdir(dirPath);
     for (const file of files) {
         const fileStat = await fs.stat(join(dirPath, file));
         if (fileStat.isDirectory()) {
-            totalFileSize += await getTotalFilesSize(join(dirPath, file));
+            totalFileSize += await getDirectorySize(join(dirPath, file));
         }
         else {
             totalFileSize += fileStat.size;

package/dist/pgm-loader.js

@@ -1,7 +1,7 @@
 import { Geoid, parsePGM } from '@math.gl/geoid';
 // __VERSION__ is injected by babel-plugin-version-inline
 // @ts-ignore TS2304: Cannot find name '__VERSION__'.
-const VERSION = typeof "4.3.0-alpha.3" !== 'undefined' ? "4.3.0-alpha.3" : 'latest';
+const VERSION = typeof "4.3.0-alpha.5" !== 'undefined' ? "4.3.0-alpha.5" : 'latest';
 export { Geoid };
 /**
  * Loader for PGM - Netpbm grayscale image format

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loaders.gl/tile-converter",
-  "version": "4.3.0-alpha.4",
+  "version": "4.3.0-alpha.6",
   "description": "Converter",
   "license": "MIT",
   "type": "module",
@@ -29,7 +29,6 @@
   "sideEffects": false,
   "bin": {
     "i3s-server": "./bin/i3s-server.js",
-    "slpk-extractor": "./bin/slpk-extractor.js",
     "tile-converter": "./bin/converter.js"
   },
   "files": [
@@ -46,27 +45,26 @@
     "process": false
   },
   "scripts": {
-    "pre-build": "npm run build-converter-bundle && npm run build-slpk-extractor-bundle && npm run build-i3s-server-bundle && npm run copy-certificates",
+    "pre-build": "npm run build-converter-bundle && npm run build-i3s-server-bundle && npm run copy-certificates",
     "build-converter-bundle": "esbuild src/converter-cli.ts --outfile=dist/converter.min.cjs --platform=node --target=esnext,node14 --external:join-images --minify --bundle --define:__VERSION__=\\\"$npm_package_version\\\"",
-    "build-slpk-extractor-bundle": "esbuild src/slpk-extractor-cli.ts --outfile=dist/slpk-extractor.min.cjs --platform=node --target=esnext,node14 --minify --bundle --define:__VERSION__=\\\"$npm_package_version\\\"",
     "build-i3s-server-bundle": "esbuild src/i3s-server/bin/www.ts --outfile=dist/i3s-server/bin/i3s-server.min.cjs --platform=node --target=esnext,node14 --minify --bundle --define:__VERSION__=\\\"$npm_package_version\\\"",
     "copy-certificates": "cp -R src/i3s-server/certs dist/i3s-server"
   },
   "dependencies": {
-    "@loaders.gl/3d-tiles": "4.3.0-alpha.4",
-    "@loaders.gl/compression": "4.3.0-alpha.4",
-    "@loaders.gl/crypto": "4.3.0-alpha.4",
-    "@loaders.gl/draco": "4.3.0-alpha.4",
-    "@loaders.gl/gltf": "4.3.0-alpha.4",
-    "@loaders.gl/i3s": "4.3.0-alpha.4",
-    "@loaders.gl/images": "4.3.0-alpha.4",
-    "@loaders.gl/loader-utils": "4.3.0-alpha.4",
-    "@loaders.gl/math": "4.3.0-alpha.4",
-    "@loaders.gl/polyfills": "4.3.0-alpha.4",
-    "@loaders.gl/textures": "4.3.0-alpha.4",
-    "@loaders.gl/tiles": "4.3.0-alpha.4",
-    "@loaders.gl/worker-utils": "4.3.0-alpha.4",
-    "@loaders.gl/zip": "4.3.0-alpha.4",
+    "@loaders.gl/3d-tiles": "4.3.0-alpha.6",
+    "@loaders.gl/compression": "4.3.0-alpha.6",
+    "@loaders.gl/crypto": "4.3.0-alpha.6",
+    "@loaders.gl/draco": "4.3.0-alpha.6",
+    "@loaders.gl/gltf": "4.3.0-alpha.6",
+    "@loaders.gl/i3s": "4.3.0-alpha.6",
+    "@loaders.gl/images": "4.3.0-alpha.6",
+    "@loaders.gl/loader-utils": "4.3.0-alpha.6",
+    "@loaders.gl/math": "4.3.0-alpha.6",
+    "@loaders.gl/polyfills": "4.3.0-alpha.6",
+    "@loaders.gl/textures": "4.3.0-alpha.6",
+    "@loaders.gl/tiles": "4.3.0-alpha.6",
+    "@loaders.gl/worker-utils": "4.3.0-alpha.6",
+    "@loaders.gl/zip": "4.3.0-alpha.6",
     "@math.gl/core": "^4.0.0",
     "@math.gl/culling": "^4.0.0",
     "@math.gl/geoid": "^4.0.0",
@@ -89,10 +87,11 @@
     "sharp": "^0.31.3"
   },
   "devDependencies": {
-    "@types/express": "^4.17.17"
+    "@types/express": "^4.17.17",
+    "@types/inquirer": "^9.0.7"
   },
   "peerDependencies": {
     "@loaders.gl/core": "^4.0.0"
   },
-  "gitHead": "4900ac4c4de20366c050b80cef04dc5b52d167af"
+  "gitHead": "315f2e232fc4e6a477c41de800a54d3e3d957e8c"
 }

package/src/3d-tiles-converter/3d-tiles-converter.ts

@@ -17,7 +17,7 @@ import {PGMLoader} from '../pgm-loader';
 import {i3sObbTo3dTilesObb} from './helpers/i3s-obb-to-3d-tiles-obb';
 import {convertScreenThresholdToGeometricError} from '../lib/utils/lod-conversion-utils';
 import {writeFile, removeDir} from '../lib/utils/file-utils';
-import {calculateFilesSize, timeConverter} from '../lib/utils/statistic-utills';
+import {calculateDatasetSize, timeConverter} from '../lib/utils/statistic-utils';
 import {TILESET as tilesetTemplate} from './json-templates/tileset';
 import {createObbFromMbs} from '../i3s-converter/helpers/coordinate-converter';
 import {WorkerFarm} from '@loaders.gl/worker-utils';
@@ -29,6 +29,7 @@ import {I3SLoaderOptions} from '@loaders.gl/i3s/src/i3s-loader';
 import {ZipFileSystem} from '../../../zip/src';
 import {ConversionDump, ConversionDumpOptions} from '../lib/utils/conversion-dump';
 import {Progress} from '../i3s-converter/helpers/progress';
+import {PromptModule} from 'inquirer';
 
 const I3S = 'I3S';
 
@@ -88,7 +89,7 @@ export default class Tiles3DConverter {
     tilesetName: string;
     maxDepth?: number;
     egmFilePath: string;
-    inquirer?: Promise<unknown>;
+    inquirer?: {prompt: PromptModule};
     analyze?: boolean;
   }): Promise<string | undefined> {
     if (isBrowser) {
@@ -474,7 +475,7 @@ export default class Tiles3DConverter {
     outputPath: string;
     tilesetName: string;
   }): Promise<void> {
-    const filesSize = await calculateFilesSize(params);
+    const filesSize = await calculateDatasetSize(params);
     const diff = process.hrtime(this.conversionStartTime);
     const conversionTime = timeConverter(diff);
 

package/src/3d-tiles-converter/helpers/load-i3s.ts

@@ -115,13 +115,14 @@ export async function getNodeCount(fileSystem: ZipFileSystem | null): Promise<nu
   if (!fileSystem?.fileProvider) {
     return 0;
   }
-  let count = 0;
+  const nodeSet = new Set();
   const filesIterator = makeZipCDHeaderIterator(fileSystem.fileProvider);
   for await (const file of filesIterator) {
     const filename = file.fileName;
-    if (filename.indexOf('3dNodeIndexDocument.json.gz') >= 0) {
-      count++;
+    const nodeNumberSearchResult = /^nodes\/(\d+)\//.exec(filename);
+    if (nodeNumberSearchResult) {
+      nodeSet.add(nodeNumberSearchResult[1]);
     }
   }
-  return count;
+  return nodeSet.size;
 }

package/src/converter-cli.ts

@@ -30,14 +30,11 @@ type TileConversionOptions = {
   instantNodeWriting: boolean;
   /** Try to merge similar materials to be able to merge meshes into one node (I3S to 3DTiles conversion only) */
   mergeMaterials: boolean;
-  /** 3DTiles->I3S only. location of 7z.exe archiver to create slpk on Windows OS, default: "C:\Program Files\7-Zip\7z.exe" */
-  sevenZipExe: string;
   /** location of the Earth Gravity Model (*.pgm) file to convert heights from ellipsoidal to gravity-related format,
+   * "None" for not using Earth Gravity Model (*.pgm)
    * default: "./deps/egm2008-5.pgm". A model file can be loaded from GeographicLib
    * https://geographiclib.sourceforge.io/html/geoid.html */
   egm: string;
-  /** 3DTiles->I3S only. Whether the converter uses Earth Gravity Model (*.pgm) */
-  noEgm: boolean;
   /** 3DTile->I3S only. Token for Cesium ION tileset authentication. */
   token?: string;
   /** 3DTiles->I3S only. Enable draco compression for geometry. Default: true */
@@ -54,8 +51,6 @@ type TileConversionOptions = {
   validate: boolean;
   /** Maximal depth of the hierarchical tiles tree traversal, default: infinite */
   maxDepth?: number;
-  /** 3DTiles->I3S only. Whether the converter generates *.slpk (Scene Layer Package) I3S output file */
-  slpk: boolean;
   /** adds hash file to the slpk if there's no one */
   addHash: boolean;
   /** Feature metadata class from EXT_FEATURE_METADATA or EXT_STRUCTURAL_METADATA extensions  */
@@ -178,18 +173,13 @@ function printHelp(): void {
   console.log(
     '--split-nodes [Prevent to merge similar materials that could lead to incorrect visualization (I3S to 3DTiles conversion only)]'
   );
-  console.log('--slpk [Generate slpk (Scene Layer Packages) I3S output file]');
   console.log(
     '--tileset [tileset.json file (3DTiles) / http://..../SceneServer/layers/0 resource (I3S)]'
   );
   console.log('--input-type [tileset input type: I3S or 3DTILES]');
   console.log(
-    '--7zExe [location of 7z.exe archiver to create slpk on Windows, default: "C:\\Program Files\\7-Zip\\7z.exe"]'
+    '--egm [location of Earth Gravity Model *.pgm file to convert heights from ellipsoidal to gravity-related format or "None" to not use it. A model file can be loaded from GeographicLib https://geographiclib.sourceforge.io/html/geoid.html], default: "./deps/egm2008-5.zip"'
   );
-  console.log(
-    '--egm [location of Earth Gravity Model *.pgm file to convert heights from ellipsoidal to gravity-related format. A model file can be loaded from GeographicLib https://geographiclib.sourceforge.io/html/geoid.html], default: "./deps/egm2008-5.zip"'
-  );
-  console.log('--no-egm [Disable Geod transformation via the EGM file]');
   console.log('--token [Token for Cesium ION tilesets authentication]');
   console.log('--no-draco [Disable draco compression for geometry]');
   console.log(
@@ -236,8 +226,6 @@ async function convert(options: ValidatedTileConversionOptions) {
         outputPath: options.output,
         tilesetName: options.name,
         maxDepth: options.maxDepth,
-        slpk: options.slpk,
-        sevenZipExe: options.sevenZipExe,
         egmFilePath: options.egm,
         token: options.token,
         draco: options.draco,
@@ -277,7 +265,6 @@ function validateOptions(
       condition: (value: any) => addHash || Boolean(value) || Boolean(options.analyze)
     },
     output: {getMessage: () => console.log('Missed: --output [Output path name]')},
-    sevenZipExe: {getMessage: () => console.log('Missed: --7zExe [7z archiver executable path]')},
     egm: {getMessage: () => console.log('Missed: --egm [*.pgm earth gravity model file path]')},
     tileset: {getMessage: () => console.log('Missed: --tileset [tileset.json file]')},
     inputType: {
@@ -315,17 +302,14 @@ function parseOptions(args: string[]): TileConversionOptions {
     output: 'data',
     instantNodeWriting: false,
     mergeMaterials: true,
-    sevenZipExe: 'C:\\Program Files\\7-Zip\\7z.exe',
     egm: join(process.cwd(), 'deps', 'egm2008-5.pgm'),
     draco: true,
     installDependencies: false,
     generateTextures: false,
     generateBoundingVolumes: false,
     validate: false,
-    slpk: false,
     addHash: false,
-    quiet: false,
-    noEgm: false
+    quiet: false
   };
 
   // eslint-disable-next-line complexity
@@ -353,21 +337,12 @@ function parseOptions(args: string[]): TileConversionOptions {
         case '--max-depth':
           opts.maxDepth = getIntegerValue(index, args);
           break;
-        case '--slpk':
-          opts.slpk = getBooleanValue(index, args);
-          break;
         case '--add-hash':
           opts.addHash = getBooleanValue(index, args);
           break;
-        case '--7zExe':
-          opts.sevenZipExe = getStringValue(index, args);
-          break;
         case '--egm':
           opts.egm = getStringValue(index, args);
           break;
-        case '--no-egm':
-          opts.noEgm = getBooleanValue(index, args);
-          break;
         case '--token':
           opts.token = getStringValue(index, args);
           break;

package/src/i3s-converter/helpers/node-index-document.ts

@@ -8,7 +8,7 @@ import {
 } from '@loaders.gl/i3s';
 import transform from 'json-map-transform';
 import {v4 as uuidv4} from 'uuid';
-import {openJson, writeFile, writeFileForSlpk} from '../../lib/utils/file-utils';
+import {openJson, writeFileForSlpk} from '../../lib/utils/file-utils';
 import I3SConverter from '../i3s-converter';
 import {NODE as nodeTemplate} from '../json-templates/node';
 import {I3SConvertedResources} from '../types';
@@ -155,27 +155,20 @@ export class NodeIndexDocument {
    */
   private async write(node: Node3DIndexDocument): Promise<void> {
     const path = join(this.converter.layers0Path, 'nodes', this.id);
-    if (this.converter.options.slpk) {
-      await this.converter.writeQueue.enqueue(
-        {
-          archiveKey: `nodes/${this.id}/3dNodeIndexDocument.json.gz`,
-          writePromise: () =>
-            writeFileForSlpk(
-              path,
-              JSON.stringify(node),
-              '3dNodeIndexDocument.json',
-              true,
-              this.converter.compressList
-            )
-        },
-        true
-      );
-    } else {
-      await this.converter.writeQueue.enqueue(
-        {writePromise: () => writeFile(path, JSON.stringify(node))},
-        true
-      );
-    }
+    await this.converter.writeQueue.enqueue(
+      {
+        archiveKey: `nodes/${this.id}/3dNodeIndexDocument.json.gz`,
+        writePromise: () =>
+          writeFileForSlpk(
+            path,
+            JSON.stringify(node),
+            '3dNodeIndexDocument.json',
+            true,
+            this.converter.compressList
+          )
+      },
+      true
+    );
   }
 
   /**
@@ -188,10 +181,7 @@ export class NodeIndexDocument {
     }
     const path = this.id;
     const parentNodePath = join(this.converter.layers0Path, 'nodes', path);
-    let parentNodeFileName = 'index.json';
-    if (this.converter.options.slpk) {
-      parentNodeFileName = '3dNodeIndexDocument.json';
-    }
+    const parentNodeFileName = '3dNodeIndexDocument.json';
     return (await openJson(parentNodePath, parentNodeFileName)) as Node3DIndexDocument;
   }
 

package/src/i3s-converter/helpers/node-pages.ts

@@ -51,7 +51,7 @@ export default class NodePages {
    * @param writeFileFunc - function to save one nodePage into a file
    * @param nodesPerPage - length limit for one nodePage. An additional nodePage is created when this limit is met
    */
-  constructor(writeFileFunc, nodesPerPage, converter: I3SConverter) {
+  constructor(writeFileFunc, nodesPerPage: number, converter: I3SConverter) {
     this.nodesPerPage = nodesPerPage;
     this.nodesCounter = 0;
     // @ts-expect-error
@@ -75,16 +75,9 @@ export default class NodePages {
    * @param nodePageId - node page id
    * @returns file path and file name
    */
-  private getNodePageFileName(nodePageId): {filePath: string; fileName: string} {
-    let filePath;
-    let fileName;
-    if (this.converter.options.slpk) {
-      filePath = join(this.converter.layers0Path, 'nodepages');
-      fileName = `${nodePageId.toString()}.json`;
-    } else {
-      filePath = join(this.converter.layers0Path, 'nodepages', nodePageId.toString());
-      fileName = 'index.json';
-    }
+  private getNodePageFileName(nodePageId: number): {filePath: string; fileName: string} {
+    const filePath = join(this.converter.layers0Path, 'nodepages');
+    const fileName = `${nodePageId.toString()}.json`;
     return {filePath, fileName};
   }
 
@@ -190,23 +183,14 @@ export default class NodePages {
       nodePage.nodes.push(node);
     }
     const nodePageStr = JSON.stringify(nodePage);
-    if (this.converter.options.slpk) {
-      await this.converter.writeQueue.enqueue(
-        {
-          archiveKey: `nodePages/${nodePageIndex.toString()}.json.gz`,
-          writePromise: () =>
-            this.writeFile(filePath, nodePageStr, fileName, true, this.converter.compressList)
-        },
-        true
-      );
-    } else {
-      await this.converter.writeQueue.enqueue(
-        {
-          writePromise: () => this.writeFile(filePath, nodePageStr)
-        },
-        true
-      );
-    }
+    await this.converter.writeQueue.enqueue(
+      {
+        archiveKey: `nodePages/${nodePageIndex.toString()}.json.gz`,
+        writePromise: () =>
+          this.writeFile(filePath, nodePageStr, fileName, true, this.converter.compressList)
+      },
+      true
+    );
   }
 
   /**
@@ -236,25 +220,15 @@ export default class NodePages {
       await this.saveMetadata();
       return;
     }
-    if (this.converter.options.slpk) {
-      for (const [index, nodePage] of this.nodePages.entries()) {
-        const nodePageStr = JSON.stringify(nodePage);
-        const slpkPath = join(this.converter.layers0Path, 'nodepages');
-        await this.converter.writeQueue.enqueue({
-          archiveKey: `nodePages/${index.toString()}.json.gz`,
-          writePromise: () => this.writeFile(slpkPath, nodePageStr, `${index.toString()}.json`)
-        });
-      }
-      await this.saveMetadata();
-    } else {
-      for (const [index, nodePage] of this.nodePages.entries()) {
-        const nodePageStr = JSON.stringify(nodePage);
-        const nodePagePath = join(this.converter.layers0Path, 'nodepages', index.toString());
-        await this.converter.writeQueue.enqueue({
-          writePromise: () => this.writeFile(nodePagePath, nodePageStr)
-        });
-      }
+    for (const [index, nodePage] of this.nodePages.entries()) {
+      const nodePageStr = JSON.stringify(nodePage);
+      const slpkPath = join(this.converter.layers0Path, 'nodepages');
+      await this.converter.writeQueue.enqueue({
+        archiveKey: `nodePages/${index.toString()}.json.gz`,
+        writePromise: () => this.writeFile(slpkPath, nodePageStr, `${index.toString()}.json`)
+      });
     }
+    await this.saveMetadata();
   }
 
   /**

package/src/i3s-converter/helpers/progress.ts

@@ -1,5 +1,5 @@
 import process from 'process';
-import {timeConverter} from '../../lib/utils/statistic-utills';
+import {timeConverter} from '../../lib/utils/statistic-utils';
 
 /** Defines a threshold that is used to check if the process velocity can be consifered trust. */
 const THRESHOLD_DEFAULT = 0.2;