@loaders.gl/tile-converter 4.0.0-alpha.15 → 4.0.0-alpha.16

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loaders.gl/tile-converter",
-  "version": "4.0.0-alpha.15",
+  "version": "4.0.0-alpha.16",
   "description": "Converter",
   "license": "MIT",
   "publishConfig": {
@@ -42,21 +42,21 @@
     "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.js --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\\\""
+    "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\\\""
   },
   "dependencies": {
-    "@loaders.gl/3d-tiles": "4.0.0-alpha.15",
-    "@loaders.gl/crypto": "4.0.0-alpha.15",
-    "@loaders.gl/draco": "4.0.0-alpha.15",
-    "@loaders.gl/gltf": "4.0.0-alpha.15",
-    "@loaders.gl/i3s": "4.0.0-alpha.15",
-    "@loaders.gl/images": "4.0.0-alpha.15",
-    "@loaders.gl/loader-utils": "4.0.0-alpha.15",
-    "@loaders.gl/polyfills": "4.0.0-alpha.15",
-    "@loaders.gl/textures": "4.0.0-alpha.15",
-    "@loaders.gl/tiles": "4.0.0-alpha.15",
-    "@loaders.gl/worker-utils": "4.0.0-alpha.15",
-    "@loaders.gl/zip": "4.0.0-alpha.15",
+    "@loaders.gl/3d-tiles": "4.0.0-alpha.16",
+    "@loaders.gl/crypto": "4.0.0-alpha.16",
+    "@loaders.gl/draco": "4.0.0-alpha.16",
+    "@loaders.gl/gltf": "4.0.0-alpha.16",
+    "@loaders.gl/i3s": "4.0.0-alpha.16",
+    "@loaders.gl/images": "4.0.0-alpha.16",
+    "@loaders.gl/loader-utils": "4.0.0-alpha.16",
+    "@loaders.gl/polyfills": "4.0.0-alpha.16",
+    "@loaders.gl/textures": "4.0.0-alpha.16",
+    "@loaders.gl/tiles": "4.0.0-alpha.16",
+    "@loaders.gl/worker-utils": "4.0.0-alpha.16",
+    "@loaders.gl/zip": "4.0.0-alpha.16",
     "@math.gl/core": "^3.5.1",
     "@math.gl/culling": "^3.5.1",
     "@math.gl/geoid": "^3.5.1",
@@ -79,5 +79,9 @@
     "join-images": "^1.1.3",
     "sharp": "^0.31.3"
   },
-  "gitHead": "47467ab23c65917e4642730e99b5d005af333c76"
+  "gitHead": "87e9714165c3ce143a04ac45bbd9d922006f1b63",
+  "devDependencies": {
+    "@types/express": "^4.17.17",
+    "@types/node": "^20.4.2"
+  }
 }

package/src/i3s-server/{app.js → app.ts}

@@ -1,12 +1,16 @@
-const express = require('express');
-const path = require('path');
-const logger = require('morgan');
-const cors = require('cors');
+import express from 'express';
+import path from 'path';
+import logger from 'morgan';
+import cors from 'cors';
+import {loadArchive} from './controllers/slpk-controller';
+
+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
+loadArchive(FULL_LAYER_PATH);
 
 const indexRouter = require('./routes/index');
 
-const I3S_LAYER_PATH = process.env.I3sLayerPath || ''; // eslint-disable-line no-process-env, no-undef
-const app = express();
+export const app = express();
 
 app.use(logger('dev'));
 app.use(express.json());
@@ -21,5 +25,3 @@ if (/\.slpk$/.test(I3S_LAYER_PATH)) {
 } else {
   app.use('/', indexRouter);
 }
-
-module.exports = app;

package/src/i3s-server/bin/www.ts

@@ -0,0 +1,38 @@
+#!/usr/bin/env node
+
+import {app} from '../app';
+import https from 'https';
+import http from 'http';
+import fs from 'fs';
+import path from 'path';
+import {formErrorHandler, formListeningHandler, normalizePort} from '../utils/server-utils';
+
+/** Get port from environment and store in Express. */
+const httpPort = normalizePort(process.env.PORT || '80');
+if (httpPort === false) {
+  console.error(`Incorrect HTTP port`);
+  process.exit(1);
+}
+const httpsPort = normalizePort(process.env.HTTPS_PORT || '443');
+if (httpsPort === false) {
+  console.error(`Incorrect HTTPs port`);
+  process.exit(1);
+}
+
+/** Create HTTP server. */
+const options = {
+  key: fs.readFileSync(path.join(__dirname, '../certs/key.pem')),
+  cert: fs.readFileSync(path.join(__dirname, '../certs/cert.pem'))
+};
+
+const httpServer = http.createServer(app);
+const httpsServer = https.createServer(options, app);
+
+/** Listen on provided port, on all network interfaces. */
+httpServer.listen(httpPort);
+httpServer.on('error', formErrorHandler(httpPort));
+httpServer.on('listening', formListeningHandler(httpServer));
+
+httpsServer.listen(httpsPort);
+httpsServer.on('error', formErrorHandler(httpsPort));
+httpsServer.on('listening', formListeningHandler(httpsServer));

package/src/i3s-server/controllers/{index-controller.js → index-controller.ts}

@@ -1,13 +1,18 @@
-const path = require('path');
-const fs = require('fs');
+import path from 'path';
+import fs from 'fs';
 
 const {promises} = fs;
 
-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
+const I3S_LAYER_PATH = process.env.I3sLayerPath || '';
 
-async function getFileNameByUrl(url) {
+/**
+ * Get local file name by input HTTP URL
+ * @param url - I3S HTTP service url
+ * @returns - local file name
+ */
+export async function getFileNameByUrl(url: string): Promise<string | null> {
   const extensions = ['json', 'bin', 'jpg', 'jpeg', 'png', 'bin.dds', 'ktx2'];
+  const FULL_LAYER_PATH = path.join(process.cwd(), I3S_LAYER_PATH);
   for (const ext of extensions) {
     const fileName = `${FULL_LAYER_PATH}${url}/index.${ext}`;
     try {
@@ -19,7 +24,3 @@ async function getFileNameByUrl(url) {
   }
   return null;
 }
-
-module.exports = {
-  getFileNameByUrl
-};

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

@@ -0,0 +1,32 @@
+import '@loaders.gl/polyfills';
+import {parseSLPK} from '@loaders.gl/i3s';
+import {FileHandleProvider} from '@loaders.gl/tile-converter';
+
+let 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 FileHandleProvider.from(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) {
+  const trimmedPath = /^\/?(.*)\/?$/.exec(url);
+  let uncompressedFile: Buffer | null = null;
+  if (trimmedPath) {
+    try {
+      uncompressedFile = Buffer.from(await slpkArchive.getFile(trimmedPath[1], 'http'));
+    } catch (e) {}
+  }
+  return uncompressedFile;
+}

package/src/i3s-server/routes/{index.js → index.ts}

@@ -1,4 +1,5 @@
-const express = require('express');
+import express from 'express';
+
 const router = express.Router();
 const {getFileNameByUrl} = require('../controllers/index-controller');
 

package/src/i3s-server/routes/{slpk-router.js → slpk-router.ts}

@@ -1,8 +1,8 @@
-const express = require('express');
-const {getFileByUrl} = require('../controllers/slpk-controller');
-const createSceneServer = require('../utils/create-scene-server');
+import express from 'express';
+import {getFileByUrl} from '../controllers/slpk-controller';
+import {createSceneServer} from '../utils/create-scene-server';
 
-const sceneServerRouter = express.Router();
+export const sceneServerRouter = express.Router();
 sceneServerRouter.get('*', async function (req, res, next) {
   const file = await getFileByUrl('/');
   if (file) {
@@ -15,7 +15,7 @@ sceneServerRouter.get('*', async function (req, res, next) {
   }
 });
 
-const router = express.Router();
+export const router = express.Router();
 router.get('*', async function (req, res, next) {
   console.log(req.path);
   const file = await getFileByUrl(req.path);
@@ -26,8 +26,3 @@ router.get('*', async function (req, res, next) {
     res.send('File not found');
   }
 });
-
-module.exports = {
-  sceneServerRouter,
-  router
-};

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

@@ -0,0 +1,20 @@
+import {SceneLayer3D} from '@loaders.gl/i3s';
+import {v4 as uuidv4} from 'uuid';
+
+/**
+ * Create `/SceneServer` response
+ * @param name - service name, custom user-friendly name of the service
+ * @param layer - I3S layer JSON
+ * @returns reponse JSON for `/SceneServer` route
+ */
+export const createSceneServer = (name: string, layer: SceneLayer3D) => {
+  return {
+    serviceItemId: uuidv4().replace(/-/gi, ''),
+    serviceName: name,
+    name,
+    currentVersion: '10.7',
+    serviceVersion: '1.8',
+    supportedBindings: ['REST'],
+    layers: [layer]
+  };
+};

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

@@ -0,0 +1,70 @@
+import type {Server as HttpsServer} from 'https';
+import type {Server as HttpServer} from 'http';
+
+import debugFactory from 'debug';
+const debug = debugFactory('i3s-server:server');
+
+/**
+ * Normalize a port into a number, string, or false.
+ * @param val - port value from env variables
+ * @returns - `number` for port, `string` for a named pipe, or `false` if the port number is not correct
+ */
+export function normalizePort(val: string): number | string | false {
+  const chkPort = parseInt(val, 10);
+
+  if (Number.isNaN(chkPort)) {
+    // named pipe
+    return val;
+  }
+
+  if (chkPort >= 0) {
+    // port number
+    return chkPort;
+  }
+
+  return false;
+}
+
+/**
+ * Event listener creator for HTTP/HTTPS server "error" event.
+ * @param optionalPort - the port/named pipe the server is started on
+ * @return callback to handle server errors
+ */
+export function formErrorHandler(
+  optionalPort: string | number
+): (error: NodeJS.ErrnoException) => void {
+  return function onError(error: NodeJS.ErrnoException) {
+    if (error.syscall !== 'listen') {
+      throw error;
+    }
+
+    const bind = typeof optionalPort === 'string' ? `Pipe ${optionalPort}` : `Port ${optionalPort}`;
+
+    // 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
+        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
+        break;
+      default:
+        throw error;
+    }
+  };
+}
+
+/**
+ * Event listener for HTTP/HTTPS server "listening" event.
+ * @param optionalServer - http or https NodeJS server
+ * @return callback that is triggered when the server has started
+ */
+export function formListeningHandler(optionalServer: HttpsServer | HttpServer): () => void {
+  return function onListening() {
+    const addr = optionalServer.address();
+    const bind = typeof addr === 'string' ? `pipe ${addr}` : `port ${addr?.port}`;
+    debug(`Listening on ${bind}`);
+  };
+}

package/src/slpk-extractor/helpers/file-handle-provider.ts

@@ -77,7 +77,7 @@ export class FileHandleProvider implements FileProvider {
    */
   async getBigUint64(offset: bigint): Promise<bigint> {
     const val = new BigInt64Array(
-      (await this.fileDescriptor.read(Buffer.alloc(8), 0, 4, offset)).buffer.buffer
+      (await this.fileDescriptor.read(Buffer.alloc(8), 0, 8, offset)).buffer.buffer
     ).at(0);
     if (val === undefined) {
       throw new Error('something went wrong');

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

@@ -53,7 +53,7 @@ export default class SLPKConverter {
         options.outputPath
       );
       localHeader = await parseZipLocalFileHeader(
-        localHeader?.fileDataOffset + localHeader?.compressedSize,
+        localHeader.fileDataOffset + localHeader?.compressedSize,
         provider
       );
     }

package/src/i3s-server/bin/www.js

@@ -1,102 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * Module dependencies.
- */
-
-const app = require('../app');
-const debug = require('debug')('i3s-server:server');
-const https = require('https');
-const http = require('http');
-const fs = require('fs');
-const path = require('path');
-
-/**
- * Get port from environment and store in Express.
- */
-
-const httpPort = normalizePort(process.env.PORT || '80'); // eslint-disable-line no-process-env, no-undef
-const httpsPort = normalizePort(process.env.HTTPS_PORT || '443'); // eslint-disable-line no-process-env, no-undef
-
-/**
- * Create HTTP server.
- */
-
-const options = {
-  key: fs.readFileSync(path.join(__dirname, '../certs/key.pem')),
-  cert: fs.readFileSync(path.join(__dirname, '../certs/cert.pem'))
-};
-
-const httpServer = http.createServer(app);
-const httpsServer = https.createServer(options, app);
-
-/**
- * Listen on provided port, on all network interfaces.
- */
-
-httpServer.listen(httpPort);
-httpServer.on('error', formErrorHandler(httpPort));
-httpServer.on('listening', formListeningHandler(httpServer));
-
-httpsServer.listen(httpsPort);
-httpsServer.on('error', formErrorHandler(httpsPort));
-httpsServer.on('listening', formListeningHandler(httpsServer));
-
-/**
- * Normalize a port into a number, string, or false.
- */
-
-function normalizePort(val) {
-  const chkPort = parseInt(val, 10);
-
-  if (isNaN(chkPort)) {
-    // named pipe
-    return val;
-  }
-
-  if (chkPort >= 0) {
-    // port number
-    return chkPort;
-  }
-
-  return false;
-}
-
-/**
- * Event listener for HTTP/HTTPS server "error" event.
- */
-
-function formErrorHandler(optionalPort) {
-  return function onError(error) {
-    if (error.syscall !== 'listen') {
-      throw error;
-    }
-
-    const bind = typeof global.port === 'string' ? `Pipe ${optionalPort}` : `Port ${optionalPort}`;
-
-    // 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
-        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
-        break;
-      default:
-        throw error;
-    }
-  };
-}
-
-/**
- * Event listener for HTTP/HTTPS server "listening" event.
- */
-function formListeningHandler(optionalServer) {
-  return function onListening() {
-    const addr = optionalServer.address();
-    const bind = typeof addr === 'string' ? `pipe ${addr}` : `port ${addr.port}`;
-    debug(`Listening on ${bind}`);
-  };
-}

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

@@ -1,31 +0,0 @@
-require('@loaders.gl/polyfills');
-const {parseSLPK} = require('@loaders.gl/i3s');
-const path = require('path');
-const {FileHandleProvider} = require('@loaders.gl/tile-converter');
-
-let slpkArchive;
-
-const loadArchive = async (fullLayerPath) => {
-  slpkArchive = await parseSLPK(await FileHandleProvider.from(fullLayerPath));
-};
-
-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
-
-loadArchive(FULL_LAYER_PATH);
-
-async function getFileByUrl(url) {
-  const trimmedPath = /^\/?(.*)\/?$/.exec(url);
-  let uncompressedFile;
-  if (trimmedPath) {
-    try {
-      uncompressedFile = Buffer.from(await slpkArchive.getFile(trimmedPath[1], 'http'));
-    } catch (e) {}
-  }
-  return uncompressedFile;
-}
-
-module.exports = {
-  loadArchive,
-  getFileByUrl
-};

package/src/i3s-server/utils/create-scene-server.js

@@ -1,15 +0,0 @@
-const {v4: uuidv4} = require('uuid');
-
-const createSceneServer = (name, layer) => {
-  return {
-    serviceItemId: uuidv4().replace(/-/gi, ''),
-    serviceName: name,
-    name,
-    currentVersion: '10.7',
-    serviceVersion: '1.8',
-    supportedBindings: ['REST'],
-    layers: [layer]
-  };
-};
-
-module.exports = createSceneServer;