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

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

@@ -1,73 +0,0 @@
-import { isBrowser } from '@loaders.gl/core';
-import { BROWSER_ERROR_MESSAGE } from "../constants.js";
-import { path } from '@loaders.gl/loader-utils';
-import { FileHandleFile } from '@loaders.gl/loader-utils';
-import { parseZipLocalFileHeader } from '@loaders.gl/zip';
-import { GZipCompression } from '@loaders.gl/compression';
-import { writeFile } from "../lib/utils/file-utils.js";
-const indexNames = [
-    '3dSceneLayer.json.gz',
-    '3dNodeIndexDocument.json.gz',
-    'sharedResource.json.gz'
-];
-/**
- * Converter from slpk to i3s
- */
-export default class SLPKExtractor {
-    /**
-     * Extract slpk to i3s
-     * @param options
-     * @param options.inputUrl the url to read SLPK file
-     * @param options.outputPath the output filename
-     */
-    async extract(options) {
-        if (isBrowser) {
-            // eslint-disable-next-line no-console
-            console.log(BROWSER_ERROR_MESSAGE);
-            return BROWSER_ERROR_MESSAGE;
-        }
-        const { inputUrl } = options;
-        const provider = new FileHandleFile(inputUrl);
-        let localHeader = await parseZipLocalFileHeader(0n, provider);
-        while (localHeader) {
-            await this.writeFile(await this.unGzip({
-                name: this.correctIndexNames(localHeader.fileName),
-                data: await provider.slice(localHeader.fileDataOffset, localHeader.fileDataOffset + localHeader.compressedSize)
-            }), options.outputPath);
-            localHeader = await parseZipLocalFileHeader(localHeader.fileDataOffset + localHeader?.compressedSize, provider);
-        }
-        return 'success';
-    }
-    /**
-     * Defines file name and path for i3s format
-     * @param fileName initial file name and path
-     */
-    correctIndexNames(fileName) {
-        if (indexNames.includes(path.filename(path.join('/', fileName)))) {
-            return path.join(path.dirname(fileName), 'index.json.gz');
-        }
-        // finds path with name part and extention part
-        const parts = /^(.*\/[^\/\.]*)(\..+)$/.exec(fileName);
-        if (!parts) {
-            return null;
-        }
-        return `${parts?.at(1)}/index${parts?.at(2)}`;
-    }
-    async unGzip(file) {
-        if (/\.gz$/.test(file.name ?? '')) {
-            const compression = new GZipCompression();
-            const decompressedData = await compression.decompress(file.data);
-            return { data: decompressedData, name: (file.name ?? '').slice(0, -3) };
-        }
-        return Promise.resolve(file);
-    }
-    async writeFile(options, outputPath) {
-        if (!options.name) {
-            return;
-        }
-        const finalPath = path.join(outputPath, options.name);
-        const dirName = path.dirname(finalPath);
-        const fileName = path.filename(finalPath);
-        await writeFile(dirName, options.data, fileName);
-    }
-}

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

@@ -1,17 +0,0 @@
-import '@loaders.gl/polyfills';
-type SLPKExtractionOptions = {
-    /** "tileset.json" file (3DTiles) / "http://..../SceneServer/layers/0" resource (I3S) */
-    tileset?: string;
-    /** Output folder. This folder will be created by converter if doesn't exist. It is relative to the converter path.
-     * Default: "data" folder */
-    output?: string;
-};
-export type ValidatedSLPKExtractionOptions = SLPKExtractionOptions & {
-    /** slpk file */
-    tileset: string;
-    /** Output folder. This folder will be created by converter if doesn't exist. It is relative to the converter path.
-     * Default: "data" folder */
-    output: string;
-};
-export {};
-//# sourceMappingURL=slpk-extractor-cli.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"slpk-extractor-cli.d.ts","sourceRoot":"","sources":["../src/slpk-extractor-cli.ts"],"names":[],"mappings":"AAAA,OAAO,uBAAuB,CAAC;AAI/B,KAAK,qBAAqB,GAAG;IAC3B,wFAAwF;IACxF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;gCAC4B;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAGF,MAAM,MAAM,8BAA8B,GAAG,qBAAqB,GAAG;IACnE,gBAAgB;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB;gCAC4B;IAC5B,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}

package/dist/slpk-extractor-cli.js

@@ -1,105 +0,0 @@
-import '@loaders.gl/polyfills';
-import SLPKExtractor from "./slpk-extractor/slpk-extractor.js";
-import { getURLValue, validateOptionsWithEqual } from "./lib/utils/cli-utils.js";
-/**
- * CLI entry
- * @returns
- */
-async function main() {
-    const [, , ...args] = process.argv;
-    if (args.length === 0) {
-        printHelp();
-    }
-    const validatedOptionsArr = validateOptionsWithEqual(args);
-    const options = parseOptions(validatedOptionsArr);
-    const validatedOptions = validateOptions(options);
-    await convert(validatedOptions);
-}
-main().catch((error) => {
-    console.log(error); // eslint-disable-line no-console
-    process.exit(1); // eslint-disable-line no-process-exit
-});
-/**
- * Output for `npx slpk-extractor --help`
- */
-function printHelp() {
-    // eslint-disable-next-line no-console
-    console.log('cli: converter slpk to I3S...');
-    // eslint-disable-next-line no-console
-    console.log('--output [Output folder, default: "data" folder]');
-    // eslint-disable-next-line no-console
-    console.log('--tileset [SLPK file]');
-    process.exit(0); // eslint-disable-line no-process-exit
-}
-/**
- * Run extraction process
- * @param options validated slpk-extractor options
- */
-async function convert(options) {
-    // eslint-disable-next-line no-console
-    console.log('------------------------------------------------');
-    // eslint-disable-next-line no-console
-    console.log('Starting conversion of SLPK');
-    // eslint-disable-next-line no-console
-    console.log('------------------------------------------------');
-    const slpkExtractor = new SLPKExtractor();
-    slpkExtractor.extract({
-        inputUrl: options.tileset,
-        outputPath: options.output
-    });
-}
-// OPTIONS
-/**
- * Validate input options of the CLI command
- * @param options - input options of the CLI command
- * @returns validated options
- */
-function validateOptions(options) {
-    const mandatoryOptionsWithExceptions = {
-        // eslint-disable-next-line no-console
-        output: () => console.log('Missed: --output [Output path name]'),
-        // eslint-disable-next-line no-console
-        tileset: () => console.log('Missed: --tileset [SLPK file]')
-    };
-    const exceptions = [];
-    for (const mandatoryOption in mandatoryOptionsWithExceptions) {
-        const optionValue = options[mandatoryOption];
-        if (!optionValue) {
-            exceptions.push(mandatoryOptionsWithExceptions[mandatoryOption]);
-        }
-    }
-    if (exceptions.length) {
-        exceptions.forEach((exeption) => exeption());
-        process.exit(1); // eslint-disable-line no-process-exit
-    }
-    return options;
-}
-/**
- * Parse option from the cli arguments array
- * @param args
- * @returns
- */
-function parseOptions(args) {
-    const opts = {};
-    // eslint-disable-next-line complexity
-    args.forEach((arg, index) => {
-        if (arg.indexOf('--') === 0) {
-            switch (arg) {
-                case '--tileset':
-                    opts.tileset = getURLValue(index, args);
-                    break;
-                case '--output':
-                    opts.output = getURLValue(index, args);
-                    break;
-                case '--help':
-                    printHelp();
-                    break;
-                default:
-                    // eslint-disable-next-line no-console
-                    console.warn(`Unknown option ${arg}`);
-                    process.exit(0); // eslint-disable-line
-            }
-        }
-    });
-    return opts;
-}