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

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

@@ -1,32 +0,0 @@
-import path from 'path';
-import fs from 'fs';
-
-const {promises} = fs;
-
-/**
- * Get local file name by input HTTP URL
- * @param url - I3S HTTP service url
- * @param i3sLayerPath - I3S layer path
- * @returns - local file name
- */
-export async function getFileNameByUrl(url: string, i3sLayerPath = ''): Promise<string | null> {
-  i3sLayerPath = i3sLayerPath || process.env.I3sLayerPath || '';
-  const extensions = ['json', 'bin', 'jpg', 'jpeg', 'png', 'bin.dds', 'ktx2'];
-  let filePath = process.cwd();
-  // Checks if the first character is not a point to indicate absolute path
-  const absolutePath = /^[^.]/.exec(i3sLayerPath);
-  if (absolutePath) {
-    filePath = '';
-  }
-  const FULL_LAYER_PATH = path.join(filePath, i3sLayerPath, url);
-  for (const ext of extensions) {
-    const fileName = `${FULL_LAYER_PATH}/index.${ext}`;
-    try {
-      await promises.access(fileName);
-      return fileName;
-    } catch {
-      continue; // eslint-disable-line no-continue
-    }
-  }
-  return null;
-}

package/src/i3s-server/routes/index.ts

@@ -1,18 +0,0 @@
-import express from 'express';
-import {getFileNameByUrl} from '../controllers/index-controller';
-
-export const router = express.Router();
-
-/* GET home page. */
-router.get('*', (req, res, next) => {
-  async function routerCallback(req, res, next) {
-    const fileName = await getFileNameByUrl(req.path);
-    if (fileName) {
-      res.sendFile(fileName);
-    } else {
-      res.status(404);
-      res.send('File not found');
-    }
-  }
-  routerCallback(req, res, next);
-});

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

@@ -1,102 +0,0 @@
-import {isBrowser} from '@loaders.gl/core';
-
-import {BROWSER_ERROR_MESSAGE} from '../constants';
-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';
-
-const indexNames = [
-  '3dSceneLayer.json.gz',
-  '3dNodeIndexDocument.json.gz',
-  'sharedResource.json.gz'
-];
-
-/**
- * Description of the file in the SLPK
- */
-type File = {
-  name: string | null;
-  data: ArrayBuffer;
-};
-
-/**
- * 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
-   */
-  public async extract(options: {inputUrl: string; outputPath: string}): Promise<string> {
-    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
-   */
-
-  private correctIndexNames(fileName: string): string | null {
-    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)}`;
-  }
-
-  private async unGzip(file: File): Promise<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);
-  }
-
-  private async writeFile(options: File, outputPath: string): Promise<void> {
-    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/src/slpk-extractor-cli.ts

@@ -1,136 +0,0 @@
-import '@loaders.gl/polyfills';
-import SLPKExtractor from './slpk-extractor/slpk-extractor';
-import {getURLValue, validateOptionsWithEqual} from './lib/utils/cli-utils';
-
-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;
-};
-
-/* During validation we check that particular options are defined so they can't be undefined */
-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;
-};
-
-/**
- * CLI entry
- * @returns
- */
-async function main() {
-  const [, , ...args] = process.argv;
-
-  if (args.length === 0) {
-    printHelp();
-  }
-
-  const validatedOptionsArr = validateOptionsWithEqual(args);
-
-  const options: SLPKExtractionOptions = parseOptions(validatedOptionsArr);
-
-  const validatedOptions: ValidatedSLPKExtractionOptions = 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(): void {
-  // 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: ValidatedSLPKExtractionOptions) {
-  // 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: SLPKExtractionOptions): ValidatedSLPKExtractionOptions {
-  const mandatoryOptionsWithExceptions: {
-    [key: string]: () => void;
-  } = {
-    // 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: (() => void)[] = [];
-  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 <ValidatedSLPKExtractionOptions>options;
-}
-
-/**
- * Parse option from the cli arguments array
- * @param args
- * @returns
- */
-function parseOptions(args: string[]): SLPKExtractionOptions {
-  const opts: SLPKExtractionOptions = {};
-
-  // 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;
-}