@loaders.gl/tile-converter 4.2.0-alpha.5 → 4.2.0-beta.1

package/src/i3s-server/routes/slpk-router.ts

@@ -5,25 +5,31 @@ import {createSceneServer} from '../utils/create-scene-server';
 const textDecoder = new TextDecoder();
 
 export const sceneServerRouter = express.Router();
-sceneServerRouter.get('*', async function (req, res, next) {
-  const file = await getFileByUrl('/');
-  if (file) {
-    const layer = JSON.parse(textDecoder.decode(file));
-    const sceneServerResponse = createSceneServer(layer.name, layer);
-    res.send(sceneServerResponse);
-  } else {
-    res.status(404);
-    res.send('File not found');
+sceneServerRouter.get('*', (req, res, next) => {
+  async function routerCallback(req, res, next) {
+    const file = await getFileByUrl('/');
+    if (file) {
+      const layer = JSON.parse(textDecoder.decode(file));
+      const sceneServerResponse = createSceneServer(layer.name, layer);
+      res.send(sceneServerResponse);
+    } else {
+      res.status(404);
+      res.send('File not found');
+    }
   }
+  routerCallback(req, res, next);
 });
 
 export const router = express.Router();
-router.get('*', async function (req, res, next) {
-  const file = await getFileByUrl(req.path.replace(/\/+$/, ''));
-  if (file) {
-    res.send(Buffer.from(file));
-  } else {
-    res.status(404);
-    res.send('File not found');
+router.get('*', (req, res, next) => {
+  async function routerCallback(req, res, next) {
+    const file = await getFileByUrl(req.path.replace(/\/+$/, ''));
+    if (file) {
+      res.send(Buffer.from(file));
+    } else {
+      res.status(404);
+      res.send('File not found');
+    }
   }
+  routerCallback(req, res, next);
 });

package/src/i3s-server/utils/server-utils.ts

@@ -32,7 +32,9 @@ export function normalizePort(val: string): number | string | false {
  */
 export function formErrorHandler(
   optionalPort: string | number
+  // eslint-disable-next-line no-undef
 ): (error: NodeJS.ErrnoException) => void {
+  // eslint-disable-next-line no-undef
   return function onError(error: NodeJS.ErrnoException) {
     if (error.syscall !== 'listen') {
       throw error;
@@ -43,12 +45,12 @@ export function formErrorHandler(
     // handle specific listen errors with friendly messages
     switch (error.code) {
       case 'EACCES':
-        console.error(`${bind} requires elevated privileges`); // eslint-disable-line no-console, no-undef
-        process.exit(1); // eslint-disable-line no-process-exit, no-undef
+        console.error(`${bind} requires elevated privileges`); // eslint-disable-line no-console
+        process.exit(1); // eslint-disable-line no-process-exit
         break;
       case 'EADDRINUSE':
-        console.error(`${bind} is already in use`); // eslint-disable-line no-console, no-undef
-        process.exit(1); // eslint-disable-line no-process-exit, no-undef
+        console.error(`${bind} is already in use`); // eslint-disable-line no-console
+        process.exit(1); // eslint-disable-line no-process-exit
         break;
       default:
         throw error;

package/src/lib/utils/cli-utils.ts

@@ -25,7 +25,9 @@ export function getStringValue(index: number, args: string[]): string {
  */
 export function getURLValue(index: number, args: string[]): string {
   const value = getStringValue(index, args);
+  // eslint-disable-next-line no-console
   console.log(`Input tileset value: ${value}`);
+  // eslint-disable-next-line no-console
   console.log(`Modified tileset value: ${value.replace(/\\/g, '/')}`);
   return value.replace(/\\/g, '/');
 }

package/src/lib/utils/conversion-dump.ts

@@ -52,7 +52,7 @@ export type TextureSetDefinition = {
 };
 
 export class ConversionDump {
-  /**Restored/resumed dump indicator */
+  /** Restored/resumed dump indicator */
   restored: boolean = false;
   /** Conversion options */
   private options?: ConversionDumpOptions;
@@ -138,7 +138,8 @@ export class ConversionDump {
           return;
         }
       } catch (error) {
-        console.log("Can't open dump file", error);
+        // prettier-ignore
+        console.log('Can\'t open dump file', error); // eslint-disable-line no-console
       }
     }
     await this.deleteDumpFile();
@@ -192,7 +193,8 @@ export class ConversionDump {
           )
         );
       } catch (error) {
-        console.log("Can't update dump file", error);
+        // prettier-ignore
+        console.log('Can\'t update dump file', error); // eslint-disable-line no-console
       }
     }
   }
@@ -305,30 +307,43 @@ export class ConversionDump {
   async updateConvertedTilesDump(
     changedRecords: {outputId?: number | string; sourceId?: string; resourceType?: string}[],
     writeResults: PromiseSettledResult<string | null>[]
-  ) {
+  ): Promise<void> {
     for (let i = 0; i < changedRecords.length; i++) {
       if (changedRecords[i] && 'value' in writeResults[i]) {
         const {sourceId, resourceType, outputId} = changedRecords[i];
-        if (!sourceId || !resourceType || !outputId) continue;
-        for (const node of this.tilesConverted[sourceId].nodes) {
-          if (node.nodeId === outputId && node.progress) {
-            node.progress[resourceType] = true;
+        this.updateNodes(sourceId, outputId, resourceType);
+      }
+    }
+    await this.updateDumpFile();
+  }
 
-            let done = false;
-            for (const key in node.progress) {
-              done = node.progress[key];
-              if (!done) break;
-            }
-            node.done = done;
-            if (node.done) {
-              delete node.progress;
-            }
-            break;
-          }
+  /**
+   * Update done status for a node
+   * @param sourceId - source resource Id
+   * @param outputId - output node/tile Id
+   * @param resourceType - type of resource
+   * @returns void
+   */
+  private updateNodes(sourceId?: string, outputId?: string | number, resourceType?: string) {
+    if (!sourceId || !resourceType || !outputId) {
+      return;
+    }
+    for (const node of this.tilesConverted[sourceId].nodes) {
+      if (node.nodeId === outputId && node.progress) {
+        node.progress[resourceType] = true;
+
+        let done = false;
+        for (const key in node.progress) {
+          done = node.progress[key];
+          if (!done) break;
         }
+        node.done = done;
+        if (node.done) {
+          delete node.progress;
+        }
+        break;
       }
     }
-    await this.updateDumpFile();
   }
 
   /**

package/src/lib/utils/file-utils.ts

@@ -20,7 +20,7 @@ export async function writeFile(
   if (data instanceof Promise) {
     toWriteData = new Uint8Array(await data);
   } else if (data instanceof ArrayBuffer) {
-    toWriteData = new Uint8Array(data as ArrayBuffer);
+    toWriteData = new Uint8Array(data);
   } else {
     toWriteData = data;
   }
@@ -31,7 +31,7 @@ export async function writeFile(
   } catch (err) {
     throw err;
   }
-  console.log(`${pathFile} saved.`); // eslint-disable-line
+  console.log(`${pathFile} saved.`); // eslint-disable-line no-console
   return pathFile;
 }
 
@@ -57,15 +57,13 @@ export async function writeFileForSlpk(
       if (!compressList.includes(pathFile)) {
         compressList.push(pathFile);
         return `${pathFile}.gz`;
-      } else {
-        return null;
       }
-    } else {
-      const pathGzFile = await compressFileWithGzip(pathFile);
-      // After compression, we don't need an uncompressed file
-      await removeFile(pathFile);
-      return pathGzFile;
+      return null;
     }
+    const pathGzFile = await compressFileWithGzip(pathFile);
+    // After compression, we don't need an uncompressed file
+    await removeFile(pathFile);
+    return pathGzFile;
   }
   return pathFile;
 }
@@ -79,7 +77,7 @@ export async function writeFileForSlpk(
 export async function openJson(path: string, fileName: string): Promise<{[key: string]: any}> {
   return new Promise((resolve, reject) => {
     let count = 0;
-    console.log(`load ${path}/${fileName}.`); // eslint-disable-line
+    console.log(`load ${path}/${fileName}.`); // eslint-disable-line no-console
     const intervalId = setInterval(() => {
       const pathFile = join(path, fileName);
       load(pathFile, JSONLoader)
@@ -119,6 +117,7 @@ export async function isFileExists(fileName: string): Promise<boolean> {
  */
 export function removeDir(path: string) {
   // (node:35607) [DEP0147] DeprecationWarning: In future versions of Node.js, fs.rmdir(path, { recursive: true }) will be removed. Use fs.rm(path, { recursive: true }) instead
+  // @ts-ignore
   return fs.rm(path, {recursive: true});
 }
 
@@ -148,6 +147,7 @@ export async function renameFile(oldPath: string, newPath: string): Promise<void
   try {
     await fs.rename(oldPath, newPath);
   } catch (err) {
-    console.log("Can't rename file", err);
+    // prettier-ignore
+    console.log('Can\'t rename file', err); // eslint-disable-line no-console
   }
 }

package/src/lib/utils/statistic-utills.ts

@@ -14,13 +14,12 @@ export function timeConverter(time: number | [number, number]): string {
     const timeInSeconds = Math.floor(time / milliSecondsInSecond);
     const milliseconds = time - timeInSeconds * milliSecondsInSecond;
     return timeConverterFromSecondsAndMilliseconds(timeInSeconds, milliseconds);
-  } else {
-    // time - high-resolution real time in a [seconds, nanoseconds] tuple Array
-    const nanoSecondsInMillisecond = 1e6;
-    const timeInSeconds = time[0];
-    const milliseconds = time[1] / nanoSecondsInMillisecond;
-    return timeConverterFromSecondsAndMilliseconds(timeInSeconds, milliseconds);
   }
+  // time - high-resolution real time in a [seconds, nanoseconds] tuple Array
+  const nanoSecondsInMillisecond = 1e6;
+  const timeInSeconds = time[0];
+  const milliseconds = time[1] / nanoSecondsInMillisecond;
+  return timeConverterFromSecondsAndMilliseconds(timeInSeconds, milliseconds);
 }
 
 function timeConverterFromSecondsAndMilliseconds(timeInSeconds: number, milliseconds: number) {

package/src/lib/utils/write-queue.ts

@@ -30,7 +30,7 @@ export type WriteQueueItem = {
 };
 
 export default class WriteQueue<T extends WriteQueueItem> extends Queue<T> {
-  private intervalId?: NodeJS.Timeout;
+  private intervalId?: NodeJS.Timer; // eslint-disable-line no-undef
   private conversionDump: ConversionDump;
   public writePromise: Promise<void> | null = null;
   public fileMap: {[key: string]: string} = {};
@@ -65,7 +65,7 @@ export default class WriteQueue<T extends WriteQueueItem> extends Queue<T> {
   }
 
   startListening() {
-    this.intervalId = setInterval(this.startWrite.bind(this), this.listeningInterval);
+    this.intervalId = setInterval(() => this.startWrite.bind(this), this.listeningInterval);
   }
 
   stopListening() {

package/src/pgm-loader.ts

@@ -16,7 +16,10 @@ export type PGMLoaderOptions = LoaderOptions & {
 /**
  * Loader for PGM - Netpbm grayscale image format
  */
-export const PGMLoader: LoaderWithParser<Geoid, never, PGMLoaderOptions> = {
+export const PGMLoader = {
+  dataType: null as unknown as Geoid,
+  batchType: null as never,
+
   name: 'PGM - Netpbm grayscale image format',
   id: 'pgm',
   module: 'tile-converter',
@@ -29,4 +32,4 @@ export const PGMLoader: LoaderWithParser<Geoid, never, PGMLoaderOptions> = {
       cubic: false
     }
   }
-};
+} as const satisfies LoaderWithParser<Geoid, never, PGMLoaderOptions>;

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

@@ -33,6 +33,7 @@ export default class SLPKExtractor {
    */
   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;
     }
@@ -71,7 +72,7 @@ export default class SLPKExtractor {
       return path.join(path.dirname(fileName), 'index.json.gz');
     }
     // finds path with name part and extention part
-    let parts = /^(.*\/[^\/\.]*)(\..+)$/.exec(fileName);
+    const parts = /^(.*\/[^\/\.]*)(\..+)$/.exec(fileName);
     if (!parts) {
       return null;
     }

package/src/slpk-extractor-cli.ts

@@ -1,4 +1,3 @@
-/* eslint-disable no-console */
 import '@loaders.gl/polyfills';
 import SLPKExtractor from './slpk-extractor/slpk-extractor';
 import {getURLValue, validateOptionsWithEqual} from './lib/utils/cli-utils';
@@ -41,18 +40,21 @@ async function main() {
 }
 
 main().catch((error) => {
-  console.log(error);
-  process.exit(1); // eslint-disable-line
+  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
+  process.exit(0); // eslint-disable-line no-process-exit
 }
 
 /**
@@ -60,9 +62,12 @@ function printHelp(): void {
  * @param options validated slpk-extractor options
  */
 async function convert(options: ValidatedSLPKExtractionOptions) {
-  console.log(`------------------------------------------------`); // eslint-disable-line
-  console.log(`Starting conversion of SLPK`); // eslint-disable-line
-  console.log(`------------------------------------------------`); // eslint-disable-line
+  // 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,
@@ -80,7 +85,9 @@ function validateOptions(options: SLPKExtractionOptions): ValidatedSLPKExtractio
   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)[] = [];
@@ -92,7 +99,7 @@ function validateOptions(options: SLPKExtractionOptions): ValidatedSLPKExtractio
   }
   if (exceptions.length) {
     exceptions.forEach((exeption) => exeption());
-    process.exit(1);
+    process.exit(1); // eslint-disable-line no-process-exit
   }
   return <ValidatedSLPKExtractionOptions>options;
 }
@@ -119,6 +126,7 @@ function parseOptions(args: string[]): SLPKExtractionOptions {
           printHelp();
           break;
         default:
+          // eslint-disable-next-line no-console
           console.warn(`Unknown option ${arg}`);
           process.exit(0); // eslint-disable-line
       }

package/src/lib/utils/statistic-utills.d.ts

@@ -1,25 +0,0 @@
-/**
- * Do milliseconds time conversion to readable time string.
- * @param tile - 3d-tiles tile Object
- * @param coordinates - node converted coordinates
- * @returns String which characterizes conversion time period
- */
-export function timeConverter(time: [number, number]): String;
-
-/**
- * Calculate files sizes after conversion.
- * @param params - Object with params of conversion.
- * @returns Promise with generated files size in bytes.
- */
-export function calculateFilesSize(params: {
-  slpk: boolean;
-  outputPath: string;
-  tilesetName: string;
-}): Number;
-
-/**
- * Reqursivelly calculate files sizes in directory.
- * @param dirPath - Directory path.
- * @returns Promise with files size in directory.
- */
-export function getTotalFilesSize(dirPath: string): Number;