@loaders.gl/tile-converter 4.0.0-beta.2 → 4.0.0-beta.4

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@loaders.gl/tile-converter",
-  "version": "4.0.0-beta.2",
+  "version": "4.0.0-beta.4",
   "description": "Converter",
   "license": "MIT",
+  "type": "module",
   "publishConfig": {
     "access": "public"
   },
@@ -16,8 +17,15 @@
     "i3s"
   ],
   "types": "dist/index.d.ts",
-  "main": "dist/es5/index.js",
-  "module": "dist/esm/index.js",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs",
+      "types": "./dist/index.d.ts"
+    }
+  },
   "sideEffects": false,
   "bin": {
     "tile-converter": "./bin/converter.js",
@@ -38,29 +46,28 @@
     "join-images": false
   },
   "scripts": {
-    "pre-build": "npm run build-bundle && npm run build-converter-bundle && npm run build-slpk-extractor-bundle && npm run build-i3s-server-bundle",
-    "build-bundle": "esbuild ./src/index.ts --bundle --outfile=dist/dist.min.js --platform=node  --external:join-images",
-    "build-converter-bundle": "esbuild src/converter-cli.ts --outfile=dist/converter.min.js --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.js --platform=node --target=esnext,node14 --external:join-images --minify --bundle --define:__VERSION__=\\\"$npm_package_version\\\"",
-    "build-i3s-server-bundle": "esbuild src/i3s-server/bin/www.ts --outfile=dist/esm/i3s-server/bin/i3s-server.min.js --platform=node --target=esnext,node14 --external:join-images --minify --bundle --define:__VERSION__=\\\"$npm_package_version\\\""
+    "pre-build": "npm run build-converter-bundle && npm run build-slpk-extractor-bundle && npm run build-i3s-server-bundle",
+    "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\\\""
   },
   "dependencies": {
-    "@loaders.gl/3d-tiles": "4.0.0-beta.2",
-    "@loaders.gl/crypto": "4.0.0-beta.2",
-    "@loaders.gl/draco": "4.0.0-beta.2",
-    "@loaders.gl/gltf": "4.0.0-beta.2",
-    "@loaders.gl/i3s": "4.0.0-beta.2",
-    "@loaders.gl/images": "4.0.0-beta.2",
-    "@loaders.gl/loader-utils": "4.0.0-beta.2",
-    "@loaders.gl/polyfills": "4.0.0-beta.2",
-    "@loaders.gl/textures": "4.0.0-beta.2",
-    "@loaders.gl/tiles": "4.0.0-beta.2",
-    "@loaders.gl/worker-utils": "4.0.0-beta.2",
-    "@loaders.gl/zip": "4.0.0-beta.2",
-    "@math.gl/core": "^3.5.1",
-    "@math.gl/culling": "^3.5.1",
-    "@math.gl/geoid": "^3.5.1",
-    "@math.gl/geospatial": "^3.5.1",
+    "@loaders.gl/3d-tiles": "4.0.0-beta.4",
+    "@loaders.gl/crypto": "4.0.0-beta.4",
+    "@loaders.gl/draco": "4.0.0-beta.4",
+    "@loaders.gl/gltf": "4.0.0-beta.4",
+    "@loaders.gl/i3s": "4.0.0-beta.4",
+    "@loaders.gl/images": "4.0.0-beta.4",
+    "@loaders.gl/loader-utils": "4.0.0-beta.4",
+    "@loaders.gl/polyfills": "4.0.0-beta.4",
+    "@loaders.gl/textures": "4.0.0-beta.4",
+    "@loaders.gl/tiles": "4.0.0-beta.4",
+    "@loaders.gl/worker-utils": "4.0.0-beta.4",
+    "@loaders.gl/zip": "4.0.0-beta.4",
+    "@math.gl/core": "^4.0.0",
+    "@math.gl/culling": "^4.0.0",
+    "@math.gl/geoid": "^4.0.0",
+    "@math.gl/geospatial": "^4.0.0",
     "archiver": "^5.0.0",
     "cors": "^2.8.5",
     "crypt": "^0.0.2",
@@ -74,13 +81,13 @@
     "uuid": "^9.0.0"
   },
   "peerDependencies": {
-    "@loaders.gl/core": "^4.0.0-alpha.8"
+    "@loaders.gl/core": "4.0.0-beta.3"
   },
   "quarantinedDependencies": {
     "join-images": "^1.1.3",
     "sharp": "^0.31.3"
   },
-  "gitHead": "79c2033f755e88e11bc30a04428e3666b177b8fc",
+  "gitHead": "848c20b474532d301f2c3f8d4e1fb9bf262b86d4",
   "devDependencies": {
     "@types/express": "^4.17.17",
     "@types/node": "^20.4.2"

package/src/converter-cli.ts

@@ -52,6 +52,8 @@ type TileConversionOptions = {
   slpk: boolean;
   /** Feature metadata class from EXT_FEATURE_METADATA or EXT_STRUCTURAL_METADATA extensions  */
   metadataClass?: string;
+  /** With this options the tileset content will be analyzed without conversion */
+  analyze?: boolean;
 };
 
 /* During validation we check that particular options are defined so they can't be undefined */
@@ -136,6 +138,7 @@ function printHelp(): void {
     '--generate-textures [Enable KTX2 textures generation if only one of (JPG, PNG) texture is provided or generate JPG texture if only KTX2 is provided]'
   );
   console.log('--generate-bounding-volumes [Generate obb and mbs bounding volumes from geometry]');
+  console.log('--analyze [Analyze the input tileset content without conversion, default: false]');
   console.log(
     '--metadata-class [One of the list of feature metadata classes, detected by converter on "analyze" stage, default: not set]'
   );
@@ -180,6 +183,8 @@ async function convert(options: ValidatedTileConversionOptions) {
         generateBoundingVolumes: options.generateBoundingVolumes,
         validate: options.validate,
         instantNodeWriting: options.instantNodeWriting,
+        metadataClass: options.metadataClass,
+        analyze: options.analyze,
         inquirer
       });
       break;
@@ -196,26 +201,35 @@ async function convert(options: ValidatedTileConversionOptions) {
  */
 function validateOptions(options: TileConversionOptions): ValidatedTileConversionOptions {
   const mandatoryOptionsWithExceptions: {
-    [key: string]: () => void;
+    [key: string]: {
+      getMessage: () => void;
+      condition?: (optionValue: any) => boolean;
+    };
   } = {
-    name: () => console.log('Missed: --name [Tileset name]'),
-    output: () => console.log('Missed: --output [Output path name]'),
-    sevenZipExe: () => console.log('Missed: --7zExe [7z archiver executable path]'),
-    egm: () => console.log('Missed: --egm [*.pgm earth gravity model file path]'),
-    tileset: () => console.log('Missed: --tileset [tileset.json file]'),
-    inputType: () =>
-      console.log('Missed/Incorrect: --input-type [tileset input type: I3S or 3DTILES]')
+    name: {
+      getMessage: () => console.log('Missed: --name [Tileset name]'),
+      condition: (value: any) => 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: {
+      getMessage: () =>
+        console.log('Missed/Incorrect: --input-type [tileset input type: I3S or 3DTILES]'),
+      condition: (value) =>
+        Boolean(value) && Object.values(TILESET_TYPE).includes(value.toUpperCase())
+    }
   };
   const exceptions: (() => void)[] = [];
   for (const mandatoryOption in mandatoryOptionsWithExceptions) {
     const optionValue = options[mandatoryOption];
-    const isWrongInputType =
-      Boolean(optionValue) &&
-      mandatoryOption === 'inputType' &&
-      !Object.values(TILESET_TYPE).includes(optionValue.toUpperCase());
 
-    if (!optionValue || isWrongInputType) {
-      exceptions.push(mandatoryOptionsWithExceptions[mandatoryOption]);
+    const conditionFunc = mandatoryOptionsWithExceptions[mandatoryOption].condition;
+    const testValue = conditionFunc ? conditionFunc(optionValue) : optionValue;
+
+    if (!testValue) {
+      exceptions.push(mandatoryOptionsWithExceptions[mandatoryOption].getMessage);
     }
   }
   if (exceptions.length) {
@@ -297,8 +311,12 @@ function parseOptions(args: string[]): TileConversionOptions {
         case '--generate-bounding-volumes':
           opts.generateBoundingVolumes = getBooleanValue(index, args);
           break;
+        case '--analyze':
+          opts.analyze = getBooleanValue(index, args);
+          break;
         case '--metadata-class':
           opts.metadataClass = getStringValue(index, args);
+          break;
         case '--help':
           printHelp();
           break;

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

@@ -194,6 +194,7 @@ export default class I3SConverter {
     instantNodeWriting?: boolean;
     inquirer?: Promise<unknown>;
     metadataClass?: string;
+    analyze?: boolean;
   }): Promise<string> {
     if (isBrowser) {
       console.log(BROWSER_ERROR_MESSAGE);
@@ -216,7 +217,8 @@ export default class I3SConverter {
       instantNodeWriting = false,
       mergeMaterials = true,
       inquirer,
-      metadataClass
+      metadataClass,
+      analyze = false
     } = options;
     this.options = {
       maxDepth,
@@ -259,11 +261,15 @@ export default class I3SConverter {
       }
       this.sourceTileset = await loadFromArchive(tilesetUrl, this.Loader, this.loadOptions);
 
-      const preprocessResult = await this.preprocessConversion();
+      const preprocessResult =
+        this.Loader === Tiles3DLoader || analyze ? await this.preprocessConversion() : true;
 
-      if (preprocessResult) {
-        await this._createAndSaveTileset(outputPath, tilesetName);
-        await this._finishConversion({slpk: Boolean(slpk), outputPath, tilesetName});
+      if (preprocessResult && !analyze) {
+        const selectMetadataClassResult = await this.selectMetadataClass();
+        if (selectMetadataClassResult) {
+          await this._createAndSaveTileset(outputPath, tilesetName);
+          await this._finishConversion({slpk: Boolean(slpk), outputPath, tilesetName});
+        }
       }
     } catch (error) {
       throw error;
@@ -317,31 +323,6 @@ export default class I3SConverter {
       return false;
     }
 
-    if (metadataClasses.size > 1) {
-      if (this.options.metadataClass?.length) {
-        console.log(`${this.options.metadataClass} has been selected`);
-      } else if (this.options.inquirer) {
-        const result = await this.options.inquirer.prompt([
-          {
-            name: 'metadataClass',
-            type: 'list',
-            message: 'Select feature metadata data class to convert...',
-            choices: Array.from(metadataClasses)
-          }
-        ]);
-        this.options.metadataClass = result.metadataClass;
-        console.log(`${result.metadataClass} has been selected`);
-      } else {
-        console.log(
-          `A feature metadata class has not been selected. Start the converter with option "--metadata-class". For example, "npx tile-converter ... --metadata-class ${
-            Array.from(metadataClasses)[0]
-          }"`
-        );
-        console.log(`------------------------------------------------`);
-        return false;
-      }
-    }
-
     return true;
   }
 
@@ -381,6 +362,39 @@ export default class I3SConverter {
     return null;
   }
 
+  /**
+   * Select metadata class associated with the set of feature attributes
+   * @returns true if the metadata class has been successfully selected
+   */
+  private async selectMetadataClass() {
+    const {metadataClasses} = this.preprocessData;
+    if (metadataClasses.size > 1) {
+      if (this.options.metadataClass?.length) {
+        console.log(`${this.options.metadataClass} has been selected`);
+      } else if (this.options.inquirer) {
+        const result = await this.options.inquirer.prompt([
+          {
+            name: 'metadataClass',
+            type: 'list',
+            message: 'Select feature metadata data class to convert...',
+            choices: Array.from(metadataClasses)
+          }
+        ]);
+        this.options.metadataClass = result.metadataClass;
+        console.log(`${result.metadataClass} has been selected`);
+      } else {
+        console.log(
+          `A feature metadata class has not been selected. Start the converter with option "--metadata-class". For example, "npx tile-converter ... --metadata-class ${
+            Array.from(metadataClasses)[0]
+          }"`
+        );
+        console.log(`------------------------------------------------`);
+        return false;
+      }
+    }
+    return true;
+  }
+
   /**
    * Convert and save the layer and embedded tiles
    * @param outputPath - path to save output data

package/src/i3s-server/controllers/slpk-controller.ts

@@ -1,32 +1,34 @@
 import '@loaders.gl/polyfills';
-import {parseSLPK} from '@loaders.gl/i3s';
+import {parseSLPKArchive, SLPKArchive} from '@loaders.gl/i3s';
 import {FileHandleFile} from '@loaders.gl/loader-utils';
 
-let slpkArchive;
+let slpkArchive: SLPKArchive;
 
 /**
  * Open SLPK file for reading and load HASH file
  * @param fullLayerPath - full path to SLPK file
  */
-export const loadArchive = async (fullLayerPath: string): Promise<void> => {
-  slpkArchive = await parseSLPK(await FileHandleFile.from(fullLayerPath), (msg) =>
+export async function loadArchive(fullLayerPath: string): Promise<void> {
+  slpkArchive = await parseSLPKArchive(new FileHandleFile(fullLayerPath), (msg) =>
     console.log(msg)
   );
   console.log('The server is ready to use');
-};
+}
 
 /**
  * Get a file from SLPK
  * @param url - I3S HTTP URL
  * @returns  - file content
  */
-export async function getFileByUrl(url: string) {
+export async function getFileByUrl(url: string): Promise<ArrayBuffer | null> {
   const trimmedPath = /^\/?(.*)\/?$/.exec(url);
-  let uncompressedFile: Buffer | null = null;
   if (trimmedPath) {
     try {
-      uncompressedFile = Buffer.from(await slpkArchive.getFile(trimmedPath[1], 'http'));
-    } catch (e) {}
+      const uncompressedFile = await slpkArchive.getFile(trimmedPath[1], 'http');
+      return uncompressedFile;
+    } catch {
+      // TODO - log error?
+    }
   }
-  return uncompressedFile;
+  return null;
 }

package/src/slpk-extractor/slpk-extractor.ts

@@ -38,7 +38,7 @@ export default class SLPKExtractor {
     }
     const {inputUrl} = options;
 
-    const provider = await FileHandleFile.from(inputUrl);
+    const provider = new FileHandleFile(inputUrl);
 
     let localHeader = await parseZipLocalFileHeader(0n, provider);
     while (localHeader) {

package/dist/bundle.d.ts

@@ -1,2 +0,0 @@
-declare const moduleExports: any;
-//# sourceMappingURL=bundle.d.ts.map

package/dist/bundle.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"bundle.d.ts","sourceRoot":"","sources":["../src/bundle.ts"],"names":[],"mappings":"AACA,QAAA,MAAM,aAAa,KAAqB,CAAC"}