@loaders.gl/tile-converter 3.1.8 → 3.2.0-alpha.3

package/dist/es5/lib/utils/file-utils.d.ts

@@ -1,43 +0,0 @@
-/**
- * Write a file with data and name fileName to path
- *
- * @param path - output path
- * @param data - file content
- * @param fileName - name of output file (default: index.json)
- */
-export function writeFile(path: string, data: string | Uint8Array | ArrayBuffer, fileName?: string);
-
-/**
- * Write a file with data and name fileName to path - specific one for further packaging into slpk
- *
- * @param path - output path
- * @param data - file content
- * @param fileName - name of output file (default: index.json)
- * @param compress - if need to compress file with gzip (default: true)
- */
-export function writeFileForSlpk(
-  path: string,
-  data: string | Uint8Array | ArrayBuffer,
-  fileName?: string,
-  compress?: boolean
-);
-
-/**
- * Remove dir with path
- *
- * @param path
- */
-export function removeDir(path: string): Promise<void>;
-
-/**
- * Remove file with path
- *
- * @param path
- */
-export function removeFile(path: string): Promise<void>;
-
-/**
- * Generates absolute file path
- * @param filePath
- */
-export function getAbsoluteFilePath(filePath: string): string;

package/dist/es5/lib/utils/lod-conversion-utils.d.ts

@@ -1,32 +0,0 @@
-/**
- * Convert LOD metric from "Screen Space Error" to "Screen Threshold"
- * 
- * @param tile - 3d-tiles tile Object
- * @param coordinates - node converted coordinates
- * @returns An array of LOD metrics in format compatible with i3s 3DNodeIndexDocument.lodSelection
- * @example 
- *  [
-        {
-            "metricType": "maxScreenThresholdSQ",
-            "maxError": 870638.071285568
-        },
-        {
-            "metricType": "maxScreenThreshold",
-            "maxError": 1052.8679031638949
-        }
-    ]
- */
-export function convertGeometricErrorToScreenThreshold(
-  tile: Object,
-  coordinates: {
-    mbs?: number[];
-  }
-): Array<{metricType: string; maxError: number}>;
-
-/**
- * Convert LOD metric from "Screen Threshold" to "Screen Space Error"
- * @param node - i3s node data
- * @returns lod metric in 3d-tiles format
- * @todo implement this function
- */
-export function convertScreenThresholdToGeometricError(node: Object): number;

package/dist/esm/deps-installer/deps-installer.d.ts

@@ -1,10 +0,0 @@
-/**
- * Install external dependencies for converter:
- * * PGM file (implemented);
- * * Draco library (not implemented);
- * * 7z archiver (not implemented);
- */
-export class DepsInstaller {
-  // Run installation
-  install(path?: string): Promise<void>;
-}

package/dist/esm/i3s-converter/helpers/geometry-converter.d.ts

@@ -1,44 +0,0 @@
-import {Vector3, Matrix4} from '@math.gl/core';
-import {GeoidHeightModel} from '../../lib/geoid-height-model';
-/**
- * Convert binary data from b3dm file to i3s resources
- *
- * @param tileContent - 3d tile content
- * @param options - converter options
- * @returns A promise that resolves to object with `geometry`, compressedGeometry`, `texture` and `sharedResources` appropriate
- *  for use  I3S tiles.
- */
-export default function convertB3dmToI3sGeometry(
-  tileContent: {
-    batchTableJson: {
-      id: [];
-    };
-    cartographicOrigin: Vector3;
-    cartesianModelMatrix: Matrix4;
-    gltf: {
-      scene: {
-        nodes: [];
-      };
-      images: [];
-      materials: [];
-    };
-  },
-  nodeId: number,
-  featuresHashArray: any,
-  attributeStorageInfo: any,
-  draco: boolean,
-  generateBoundingVolumes: boolean,
-  geoidHeightModel: GeoidHeightModel
-): Promise<
-  {
-    geometry: ArrayBuffer;
-    compressedGeometry: ArrayBuffer;
-    texture: any;
-    sharedResources: any;
-    meshMaterial: any;
-    vertexCount: number;
-    attributes: any;
-    featureCount: number;
-    boundingVolumes: any;
-  }[]
->;

package/dist/esm/lib/utils/compress-util.d.ts

@@ -1,53 +0,0 @@
-/**
- * Compress file to gzip file
- *
- * @param pathFile - the path to the file
- * @return the path to the gzip file
- */
-export function compressFileWithGzip(pathFile: string): Promise<string>;
-
-/**
- * Compress files from map into slpk file
- *
- * @param fileMap - map with file paths (key: output path, value: input path)
- * @param outputFile - output slpk file
- * @param level - compression level
- */
-export function compressFilesWithZip(
-  fileMap: object,
-  outputFile: string,
-  level: number
-): Promise<void>;
-
-/**
- * Compress files using external tool 'zip'
- *
- * @param inputFolder - folder to archive
- * @param outputFile - output slpk file
- * @param level - compression level
- */
-export function compressWithChildProcess(
-  inputFolder: string,
-  outputFile: string,
-  level: number,
-  sevenZipExe: string
-): Promise<void>;
-
-/**
- * Generate hash file from zip archive
- * https://github.com/Esri/i3s-spec/blob/master/docs/1.7/slpk_hashtable.cmn.md
- *
- * @param inputZipFile
- * @param outputFile
- */
-export function generateHash128FromZip(inputZipFile, outputFile): Promise<void>;
-
-/**
- * Add file to zip archive
- *
- * @param inputFile
- * @param fileName
- * @param zipFile
- * @param sevenZipExe
- */
-export function addFileToZip(inputFile, fileName, zipFile, sevenZipExe);

package/dist/esm/lib/utils/lod-conversion-utils.d.ts

@@ -1,32 +0,0 @@
-/**
- * Convert LOD metric from "Screen Space Error" to "Screen Threshold"
- * 
- * @param tile - 3d-tiles tile Object
- * @param coordinates - node converted coordinates
- * @returns An array of LOD metrics in format compatible with i3s 3DNodeIndexDocument.lodSelection
- * @example 
- *  [
-        {
-            "metricType": "maxScreenThresholdSQ",
-            "maxError": 870638.071285568
-        },
-        {
-            "metricType": "maxScreenThreshold",
-            "maxError": 1052.8679031638949
-        }
-    ]
- */
-export function convertGeometricErrorToScreenThreshold(
-  tile: Object,
-  coordinates: {
-    mbs?: number[];
-  }
-): Array<{metricType: string; maxError: number}>;
-
-/**
- * Convert LOD metric from "Screen Threshold" to "Screen Space Error"
- * @param node - i3s node data
- * @returns lod metric in 3d-tiles format
- * @todo implement this function
- */
-export function convertScreenThresholdToGeometricError(node: Object): number;

package/src/deps-installer/deps-installer.d.ts

@@ -1,10 +0,0 @@
-/**
- * Install external dependencies for converter:
- * * PGM file (implemented);
- * * Draco library (not implemented);
- * * 7z archiver (not implemented);
- */
-export class DepsInstaller {
-  // Run installation
-  install(path?: string): Promise<void>;
-}

package/src/i3s-converter/helpers/geometry-converter.d.ts

@@ -1,44 +0,0 @@
-import {Vector3, Matrix4} from '@math.gl/core';
-import {GeoidHeightModel} from '../../lib/geoid-height-model';
-/**
- * Convert binary data from b3dm file to i3s resources
- *
- * @param tileContent - 3d tile content
- * @param options - converter options
- * @returns A promise that resolves to object with `geometry`, compressedGeometry`, `texture` and `sharedResources` appropriate
- *  for use  I3S tiles.
- */
-export default function convertB3dmToI3sGeometry(
-  tileContent: {
-    batchTableJson: {
-      id: [];
-    };
-    cartographicOrigin: Vector3;
-    cartesianModelMatrix: Matrix4;
-    gltf: {
-      scene: {
-        nodes: [];
-      };
-      images: [];
-      materials: [];
-    };
-  },
-  nodeId: number,
-  featuresHashArray: any,
-  attributeStorageInfo: any,
-  draco: boolean,
-  generateBoundingVolumes: boolean,
-  geoidHeightModel: GeoidHeightModel
-): Promise<
-  {
-    geometry: ArrayBuffer;
-    compressedGeometry: ArrayBuffer;
-    texture: any;
-    sharedResources: any;
-    meshMaterial: any;
-    vertexCount: number;
-    attributes: any;
-    featureCount: number;
-    boundingVolumes: any;
-  }[]
->;

package/src/lib/utils/compress-util.d.ts

@@ -1,53 +0,0 @@
-/**
- * Compress file to gzip file
- *
- * @param pathFile - the path to the file
- * @return the path to the gzip file
- */
-export function compressFileWithGzip(pathFile: string): Promise<string>;
-
-/**
- * Compress files from map into slpk file
- *
- * @param fileMap - map with file paths (key: output path, value: input path)
- * @param outputFile - output slpk file
- * @param level - compression level
- */
-export function compressFilesWithZip(
-  fileMap: object,
-  outputFile: string,
-  level: number
-): Promise<void>;
-
-/**
- * Compress files using external tool 'zip'
- *
- * @param inputFolder - folder to archive
- * @param outputFile - output slpk file
- * @param level - compression level
- */
-export function compressWithChildProcess(
-  inputFolder: string,
-  outputFile: string,
-  level: number,
-  sevenZipExe: string
-): Promise<void>;
-
-/**
- * Generate hash file from zip archive
- * https://github.com/Esri/i3s-spec/blob/master/docs/1.7/slpk_hashtable.cmn.md
- *
- * @param inputZipFile
- * @param outputFile
- */
-export function generateHash128FromZip(inputZipFile, outputFile): Promise<void>;
-
-/**
- * Add file to zip archive
- *
- * @param inputFile
- * @param fileName
- * @param zipFile
- * @param sevenZipExe
- */
-export function addFileToZip(inputFile, fileName, zipFile, sevenZipExe);

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

@@ -1,43 +0,0 @@
-/**
- * Write a file with data and name fileName to path
- *
- * @param path - output path
- * @param data - file content
- * @param fileName - name of output file (default: index.json)
- */
-export function writeFile(path: string, data: string | Uint8Array | ArrayBuffer, fileName?: string);
-
-/**
- * Write a file with data and name fileName to path - specific one for further packaging into slpk
- *
- * @param path - output path
- * @param data - file content
- * @param fileName - name of output file (default: index.json)
- * @param compress - if need to compress file with gzip (default: true)
- */
-export function writeFileForSlpk(
-  path: string,
-  data: string | Uint8Array | ArrayBuffer,
-  fileName?: string,
-  compress?: boolean
-);
-
-/**
- * Remove dir with path
- *
- * @param path
- */
-export function removeDir(path: string): Promise<void>;
-
-/**
- * Remove file with path
- *
- * @param path
- */
-export function removeFile(path: string): Promise<void>;
-
-/**
- * Generates absolute file path
- * @param filePath
- */
-export function getAbsoluteFilePath(filePath: string): string;

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

@@ -1,38 +0,0 @@
-import {promises as fs} from 'fs';
-import {isAbsolute, join} from 'path';
-import {compressFileWithGzip} from './compress-util';
-
-export async function writeFile(path, data, fileName = 'index.json') {
-  await fs.mkdir(path, {recursive: true});
-  const pathFile = join(path, fileName);
-  try {
-    await fs.writeFile(pathFile, data);
-  } catch (err) {
-    throw err;
-  }
-  console.log(`${pathFile} saved.`); // eslint-disable-line
-  return pathFile;
-}
-
-export async function writeFileForSlpk(path, data, fileName = 'index.json', compress = true) {
-  const pathFile = await writeFile(path, data, fileName);
-  if (compress) {
-    const pathGzFile = await compressFileWithGzip(pathFile);
-    // After compression, we don't need an uncompressed file
-    await removeFile(pathFile);
-    return pathGzFile;
-  }
-  return pathFile;
-}
-
-export function removeDir(path) {
-  return fs.rmdir(path, {recursive: true});
-}
-
-export function removeFile(path) {
-  return fs.unlink(path);
-}
-
-export function getAbsoluteFilePath(filePath) {
-  return isAbsolute(filePath) ? filePath : join(process.cwd(), filePath); // eslint-disable-line no-undef
-}

package/src/lib/utils/lod-conversion-utils.d.ts

@@ -1,32 +0,0 @@
-/**
- * Convert LOD metric from "Screen Space Error" to "Screen Threshold"
- * 
- * @param tile - 3d-tiles tile Object
- * @param coordinates - node converted coordinates
- * @returns An array of LOD metrics in format compatible with i3s 3DNodeIndexDocument.lodSelection
- * @example 
- *  [
-        {
-            "metricType": "maxScreenThresholdSQ",
-            "maxError": 870638.071285568
-        },
-        {
-            "metricType": "maxScreenThreshold",
-            "maxError": 1052.8679031638949
-        }
-    ]
- */
-export function convertGeometricErrorToScreenThreshold(
-  tile: Object,
-  coordinates: {
-    mbs?: number[];
-  }
-): Array<{metricType: string; maxError: number}>;
-
-/**
- * Convert LOD metric from "Screen Threshold" to "Screen Space Error"
- * @param node - i3s node data
- * @returns lod metric in 3d-tiles format
- * @todo implement this function
- */
-export function convertScreenThresholdToGeometricError(node: Object): number;