@loaders.gl/tile-converter 4.3.0-alpha.3 → 4.3.0-alpha.5

package/dist/i3s-converter/i3s-converter.js

@@ -125,8 +125,6 @@ export default class I3SConverter {
      * @param options.outputPath the output filename
      * @param options.tilesetName the output name of the tileset
      * @param options.maxDepth The max tree depth of conversion
-     * @param options.slpk Generate slpk (Scene Layer Packages) output file
-     * @param options.sevenZipExe Location of 7z.exe archiver to create slpk on Windows
      * @param options.egmFilePath location of *.pgm file to convert heights from ellipsoidal to gravity-related format
      * @param options.token Token for Cesium ION tilesets authentication
      * @param options.draco Generate I3S 1.7 draco compressed geometries
@@ -142,13 +140,11 @@ export default class I3SConverter {
             return BROWSER_ERROR_MESSAGE;
         }
         this.conversionStartTime = process.hrtime();
-        const { tilesetName, slpk, egmFilePath, inputUrl, validate, outputPath, draco = true, sevenZipExe, maxDepth, token, generateTextures, generateBoundingVolumes, instantNodeWriting = false, mergeMaterials = true, inquirer, metadataClass, analyze = false } = options;
+        const { tilesetName, egmFilePath, inputUrl, validate, outputPath, draco = true, maxDepth, token, generateTextures, generateBoundingVolumes, instantNodeWriting = false, mergeMaterials = true, inquirer, metadataClass, analyze = false, noEgm = false } = options;
         this.options = {
             outputPath,
             tilesetName,
             maxDepth,
-            slpk,
-            sevenZipExe,
             egmFilePath,
             draco,
             token,
@@ -166,12 +162,15 @@ export default class I3SConverter {
         this.generateBoundingVolumes = Boolean(generateBoundingVolumes);
         this.writeQueue = new WriteQueue(this.conversionDump);
         this.writeQueue.startListening();
-        console.log('Loading egm file...'); // eslint-disable-line
-        this.geoidHeightModel = await load(egmFilePath, PGMLoader);
-        console.log('Loading egm file completed!'); // eslint-disable-line
-        if (slpk) {
-            this.nodePages.useWriteFunction(writeFileForSlpk);
+        if (!noEgm) {
+            console.log('--no-egm option selected, skip loading egm file'); // eslint-disable-line
         }
+        else {
+            console.log('Loading egm file...'); // eslint-disable-line
+            this.geoidHeightModel = await load(egmFilePath, PGMLoader);
+            console.log('Loading egm file completed!'); // eslint-disable-line
+        }
+        this.nodePages.useWriteFunction(writeFileForSlpk);
         try {
             const preloadOptions = await this._fetchPreloadOptions();
             let tilesetUrl = inputUrl;
@@ -187,7 +186,7 @@ export default class I3SConverter {
                 const selectMetadataClassResult = await this.selectMetadataClass();
                 if (selectMetadataClassResult) {
                     await this._createAndSaveTileset(outputPath, tilesetName);
-                    await this._finishConversion({ slpk: Boolean(slpk), outputPath, tilesetName });
+                    await this._finishConversion({ outputPath, tilesetName });
                 }
             }
         }
@@ -445,17 +444,10 @@ export default class I3SConverter {
      * Write 3DSceneLayer https://github.com/Esri/i3s-spec/blob/master/docs/1.7/3DSceneLayer.cmn.md in file
      */
     async _writeLayers0() {
-        if (this.options.slpk) {
-            await this.writeQueue.enqueue({
-                archiveKey: '3dSceneLayer.json.gz',
-                writePromise: () => writeFileForSlpk(this.layers0Path, JSON.stringify(this.layers0), '3dSceneLayer.json')
-            });
-        }
-        else {
-            await this.writeQueue.enqueue({
-                writePromise: () => writeFile(this.layers0Path, JSON.stringify(this.layers0))
-            });
-        }
+        await this.writeQueue.enqueue({
+            archiveKey: '3dSceneLayer.json.gz',
+            writePromise: () => writeFileForSlpk(this.layers0Path, JSON.stringify(this.layers0), '3dSceneLayer.json')
+        });
     }
     /**
      * Pack files into *.slpk archive
@@ -463,19 +455,17 @@ export default class I3SConverter {
      */
     async _createSlpk(tilesetPath) {
         await this.conversionDump.deleteDumpFile();
-        if (this.options.slpk) {
-            const slpkTilesetPath = join(tilesetPath, 'SceneServer', 'layers', '0');
-            const slpkFileName = `${tilesetPath}.slpk`;
-            await createZip(slpkTilesetPath, slpkFileName, async (fileList) => ({
-                path: '@specialIndexFileHASH128@',
-                file: await composeHashFile(fileList)
-            }));
-            try {
-                await removeDir(tilesetPath);
-            }
-            catch (e) {
-                // do nothing
-            }
+        const slpkTilesetPath = join(tilesetPath, 'SceneServer', 'layers', '0');
+        const slpkFileName = `${tilesetPath}.slpk`;
+        await createZip(slpkTilesetPath, slpkFileName, async (fileList) => ({
+            path: '@specialIndexFileHASH128@',
+            file: await composeHashFile(fileList)
+        }));
+        try {
+            await removeDir(tilesetPath);
+        }
+        catch (e) {
+            // do nothing
         }
     }
     /**
@@ -723,9 +713,9 @@ export default class I3SConverter {
             propertyTable,
             featuresHashArray: this.featuresHashArray,
             attributeStorageInfo: this.attributeMetadataInfo.attributeStorageInfo,
-            draco: this.options.draco,
+            draco: this.options.draco ?? false,
             generateBoundingVolumes: this.generateBoundingVolumes,
-            shouldMergeMaterials: this.options.mergeMaterials,
+            shouldMergeMaterials: this.options.mergeMaterials ?? false,
             geoidHeightModel: this.geoidHeightModel,
             libraries: this.loadOptions.modules,
             metadataClass: this.options.metadataClass
@@ -857,47 +847,25 @@ export default class I3SConverter {
             return;
         }
         this.conversionDump.updateDoneStatus(sourceId, nodeId, ResourceType.GEOMETRY, false);
-        if (this.options.slpk) {
-            const slpkGeometryPath = join(childPath, 'geometries');
-            await this.writeQueue.enqueue({
-                archiveKey: `${slpkChildPath}/geometries/0.bin.gz`,
-                sourceId,
-                outputId: nodeId,
-                resourceType: ResourceType.GEOMETRY,
-                writePromise: () => writeFileForSlpk(slpkGeometryPath, geometryBuffer, '0.bin')
-            });
-        }
-        else {
-            const geometryPath = join(childPath, 'geometries/0/');
+        const slpkGeometryPath = join(childPath, 'geometries');
+        await this.writeQueue.enqueue({
+            archiveKey: `${slpkChildPath}/geometries/0.bin.gz`,
+            sourceId,
+            outputId: nodeId,
+            resourceType: ResourceType.GEOMETRY,
+            writePromise: () => writeFileForSlpk(slpkGeometryPath, geometryBuffer, '0.bin')
+        });
+        if (this.options.draco && compressedGeometry) {
+            this.conversionDump.updateDoneStatus(sourceId, nodeId, ResourceType.DRACO_GEOMETRY, false);
+            const slpkCompressedGeometryPath = join(childPath, 'geometries');
             await this.writeQueue.enqueue({
+                archiveKey: `${slpkChildPath}/geometries/1.bin.gz`,
                 sourceId,
                 outputId: nodeId,
-                resourceType: ResourceType.GEOMETRY,
-                writePromise: () => writeFile(geometryPath, geometryBuffer, 'index.bin')
+                resourceType: ResourceType.DRACO_GEOMETRY,
+                writePromise: () => writeFileForSlpk(slpkCompressedGeometryPath, compressedGeometry, '1.bin')
             });
         }
-        if (this.options.draco && compressedGeometry) {
-            this.conversionDump.updateDoneStatus(sourceId, nodeId, ResourceType.DRACO_GEOMETRY, false);
-            if (this.options.slpk) {
-                const slpkCompressedGeometryPath = join(childPath, 'geometries');
-                await this.writeQueue.enqueue({
-                    archiveKey: `${slpkChildPath}/geometries/1.bin.gz`,
-                    sourceId,
-                    outputId: nodeId,
-                    resourceType: ResourceType.DRACO_GEOMETRY,
-                    writePromise: () => writeFileForSlpk(slpkCompressedGeometryPath, compressedGeometry, '1.bin')
-                });
-            }
-            else {
-                const compressedGeometryPath = join(childPath, 'geometries/1/');
-                await this.writeQueue.enqueue({
-                    sourceId,
-                    outputId: nodeId,
-                    resourceType: ResourceType.DRACO_GEOMETRY,
-                    writePromise: () => writeFile(compressedGeometryPath, compressedGeometry, 'index.bin')
-                });
-            }
-        }
     }
     /**
      * Write shared resources in a file
@@ -916,25 +884,14 @@ export default class I3SConverter {
         const sharedData = transform(sharedResources, sharedResourcesTemplate());
         const sharedDataStr = JSON.stringify(sharedData);
         this.conversionDump.updateDoneStatus(sourceId, nodeId, ResourceType.SHARED, false);
-        if (this.options.slpk) {
-            const slpkSharedPath = join(childPath, 'shared');
-            await this.writeQueue.enqueue({
-                archiveKey: `${slpkChildPath}/shared/sharedResource.json.gz`,
-                sourceId,
-                outputId: nodeId,
-                resourceType: ResourceType.SHARED,
-                writePromise: () => writeFileForSlpk(slpkSharedPath, sharedDataStr, 'sharedResource.json')
-            });
-        }
-        else {
-            const sharedPath = join(childPath, 'shared/');
-            await this.writeQueue.enqueue({
-                sourceId,
-                outputId: nodeId,
-                resourceType: ResourceType.SHARED,
-                writePromise: () => writeFile(sharedPath, sharedDataStr)
-            });
-        }
+        const slpkSharedPath = join(childPath, 'shared');
+        await this.writeQueue.enqueue({
+            archiveKey: `${slpkChildPath}/shared/sharedResource.json.gz`,
+            sourceId,
+            outputId: nodeId,
+            resourceType: ResourceType.SHARED,
+            writePromise: () => writeFileForSlpk(slpkSharedPath, sharedDataStr, 'sharedResource.json')
+        });
     }
     /**
      * Generates textures based on texture mime type and fill in textureSetDefinitions data.
@@ -1044,26 +1001,15 @@ export default class I3SConverter {
      * @param nodeId
      */
     async writeTextureFile({ textureData, name, format, childPath, slpkChildPath, sourceId, nodeId }) {
-        if (this.options.slpk) {
-            const slpkTexturePath = join(childPath, 'textures');
-            const compress = false;
-            await this.writeQueue.enqueue({
-                archiveKey: `${slpkChildPath}/textures/${name}.${format}`,
-                sourceId,
-                outputId: nodeId,
-                resourceType: `${ResourceType.TEXTURE}/${format}`,
-                writePromise: () => writeFileForSlpk(slpkTexturePath, textureData, `${name}.${format}`, compress)
-            });
-        }
-        else {
-            const texturePath = join(childPath, `textures/${name}/`);
-            await this.writeQueue.enqueue({
-                sourceId,
-                outputId: nodeId,
-                resourceType: `${ResourceType.TEXTURE}/${format}`,
-                writePromise: () => writeFile(texturePath, textureData, `index.${format}`)
-            });
-        }
+        const slpkTexturePath = join(childPath, 'textures');
+        const compress = false;
+        await this.writeQueue.enqueue({
+            archiveKey: `${slpkChildPath}/textures/${name}.${format}`,
+            sourceId,
+            outputId: nodeId,
+            resourceType: `${ResourceType.TEXTURE}/${format}`,
+            writePromise: () => writeFileForSlpk(slpkTexturePath, textureData, `${name}.${format}`, compress)
+        });
     }
     /**
      * Write feature attributes in files
@@ -1082,25 +1028,14 @@ export default class I3SConverter {
                 const folderName = this.attributeMetadataInfo.attributeStorageInfo[index].key;
                 const fileBuffer = new Uint8Array(attributes[index]);
                 this.conversionDump.updateDoneStatus(sourceId, nodeId, `${ResourceType.ATTRIBUTES}/${folderName}`, false);
-                if (this.options.slpk) {
-                    const slpkAttributesPath = join(childPath, 'attributes', folderName);
-                    await this.writeQueue.enqueue({
-                        archiveKey: `${slpkChildPath}/attributes/${folderName}.bin.gz`,
-                        sourceId,
-                        outputId: nodeId,
-                        resourceType: `${ResourceType.ATTRIBUTES}/${folderName}`,
-                        writePromise: () => writeFileForSlpk(slpkAttributesPath, fileBuffer, '0.bin')
-                    });
-                }
-                else {
-                    const attributesPath = join(childPath, `attributes/${folderName}/0`);
-                    await this.writeQueue.enqueue({
-                        sourceId,
-                        outputId: nodeId,
-                        resourceType: `${ResourceType.ATTRIBUTES}/${folderName}`,
-                        writePromise: () => writeFile(attributesPath, fileBuffer, 'index.bin')
-                    });
-                }
+                const slpkAttributesPath = join(childPath, 'attributes', folderName);
+                await this.writeQueue.enqueue({
+                    archiveKey: `${slpkChildPath}/attributes/${folderName}.bin.gz`,
+                    sourceId,
+                    outputId: nodeId,
+                    resourceType: `${ResourceType.ATTRIBUTES}/${folderName}`,
+                    writePromise: () => writeFileForSlpk(slpkAttributesPath, fileBuffer, '0.bin')
+                });
             }
         }
     }
@@ -1207,7 +1142,7 @@ export default class I3SConverter {
         const options = {
             'cesium-ion': { accessToken: this.options.token || ION_DEFAULT_TOKEN }
         };
-        const preloadOptions = await this.Loader.preload(this.options.inputUrl, options);
+        const preloadOptions = await this.Loader.preload(this.options.inputUrl ?? '', options);
         this.refreshTokenTime = process.hrtime();
         return { ...options, ...preloadOptions };
     }

package/dist/i3s-server/app.d.ts

@@ -1,2 +1,3 @@
-export declare const app: import("express-serve-static-core").Express;
+import express from 'express';
+export declare let app: ReturnType<typeof express> | undefined;
 //# sourceMappingURL=app.d.ts.map

package/dist/i3s-server/app.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../../src/i3s-server/app.ts"],"names":[],"mappings":"AAiBA,eAAO,MAAM,GAAG,6CAAY,CAAC"}
+{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../../src/i3s-server/app.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAC;AAgB9B,eAAO,IAAI,GAAG,EAAE,UAAU,CAAC,OAAO,OAAO,CAAC,GAAG,SAAS,CAAC"}

package/dist/i3s-server/app.js

@@ -5,20 +5,20 @@ import cors from 'cors';
 // For local debug
 // import {fileURLToPath} from 'url';
 import { loadArchive } from "./controllers/slpk-controller.js";
-import { router as indexRouter } from "./routes.js";
 import { sceneServerRouter, router } from "./routes/slpk-router.js";
 // For local debug
 // const __filename = fileURLToPath(import.meta.url);
 // const __dirname = path.dirname(__filename);
 const I3S_LAYER_PATH = process.env.I3sLayerPath || ''; // eslint-disable-line no-process-env, no-undef
 const FULL_LAYER_PATH = path.join(process.cwd(), I3S_LAYER_PATH); // eslint-disable-line no-undef
-export const app = express();
-app.use(logger('dev'));
-app.use(express.json());
-app.use(express.urlencoded({ extended: false }));
-app.use(express.static(path.join(__dirname, 'public')));
-app.use(cors());
+export let app;
 if (/\.slpk$/.test(I3S_LAYER_PATH)) {
+    app = express();
+    app.use(logger('dev'));
+    app.use(express.json());
+    app.use(express.urlencoded({ extended: false }));
+    app.use(express.static(path.join(__dirname, 'public')));
+    app.use(cors());
     let filePath = FULL_LAYER_PATH;
     // Checks if the first character is not a point to indicate absolute path
     const absolutePath = /^[^.]/.exec(I3S_LAYER_PATH);
@@ -29,6 +29,3 @@ if (/\.slpk$/.test(I3S_LAYER_PATH)) {
     app.use('/SceneServer/layers/0', router);
     app.use('/SceneServer', sceneServerRouter);
 }
-else {
-    app.use('/', indexRouter);
-}