@loaders.gl/tile-converter 5.0.0-alpha.11 → 5.0.0-alpha.14

package/src/v4/i3s-converter/json-templates/node.ts

@@ -1,45 +1,56 @@
-import transform from 'json-map-transform';
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 
-const COORDINATES = () => ({
-  mbs: {
-    path: 'mbs'
-  },
-  obb: {
-    path: 'obb'
-  }
-});
+import type {BuilderInput} from '../../lib/utils/builder-input';
 
-const HREF = () => ({
-  href: {
-    path: 'href'
-  }
-});
+import type {BoundingVolumes, NodeReference, Node3DIndexDocument} from '@loaders.gl/tiles-3d/i3s';
 
-const PARENT_NODE = () => ({
-  id: {
-    path: 'id'
-  },
-  ...HREF(),
-  ...COORDINATES()
-});
+/** Legacy node documents may include a path in addition to the typed I3S fields. */
+type NodeBuilderRecord = Node3DIndexDocument & {
+  /** Legacy document path. */
+  path?: string;
+};
 
-export const NODE = () => ({
-  version: {
-    path: 'version'
-  },
-  id: {
-    path: 'id'
-  },
-  path: {
-    path: 'path'
-  },
-  level: {
-    path: 'level'
-  },
-  ...COORDINATES(),
-  lodSelection: {
-    path: 'lodSelection',
-    default: [
+/** Builds coordinates with the legacy field selection and defaults. */
+function createCoordinates(input: BuilderInput<BoundingVolumes> | null | undefined) {
+  const source = input ?? {};
+  return {
+    mbs: source.mbs ?? undefined,
+    obb: source.obb ?? undefined
+  };
+}
+
+/** Builds href with the legacy field selection and defaults. */
+function createHref(input: BuilderInput<Pick<NodeReference, 'href'>> | null | undefined) {
+  const source = input ?? {};
+  return {
+    href: source.href ?? undefined
+  };
+}
+
+/** Builds parent node with the legacy field selection and defaults. */
+function createParentNode(input: BuilderInput<NodeReference> | null | undefined): NodeReference {
+  const source = input ?? {};
+  return {
+    id: source.id ?? undefined,
+    ...createHref(source),
+    ...createCoordinates(source)
+  } as NodeReference;
+}
+
+/** Builds node with the legacy field selection and defaults. */
+export function createNode(
+  input: BuilderInput<NodeBuilderRecord> | null | undefined
+): NodeBuilderRecord {
+  const source = input ?? {};
+  return {
+    version: source.version ?? undefined,
+    id: source.id ?? undefined,
+    path: source.path ?? undefined,
+    level: source.level ?? undefined,
+    ...createCoordinates(source),
+    lodSelection: source.lodSelection ?? [
       {
         metricType: 'maxScreenThresholdSQ',
         maxError: 196349.54374999998
@@ -48,39 +59,14 @@ export const NODE = () => ({
         metricType: 'maxScreenThreshold',
         maxError: 999.9999999999999
       }
-    ]
-  },
-  children: {
-    path: 'children',
-    default: null
-  },
-  neighbors: {
-    path: 'neighbors',
-    default: null
-  },
-  parentNode: {
-    path: 'parentNode',
-    transform: val => transform(val, PARENT_NODE()),
-    default: null
-  },
-  sharedResource: {
-    path: 'sharedResource',
-    default: null
-  },
-  featureData: {
-    path: 'featureData',
-    default: null
-  },
-  geometryData: {
-    path: 'geometryData',
-    default: null
-  },
-  textureData: {
-    path: 'textureData',
-    default: null
-  },
-  attributeData: {
-    path: 'attributeData',
-    default: null
-  }
-});
+    ],
+    children: source.children ?? undefined,
+    neighbors: source.neighbors ?? undefined,
+    parentNode: createParentNode(source.parentNode) ?? undefined,
+    sharedResource: source.sharedResource ?? undefined,
+    featureData: source.featureData ?? undefined,
+    geometryData: source.geometryData ?? undefined,
+    textureData: source.textureData ?? undefined,
+    attributeData: source.attributeData ?? undefined
+  } as NodeBuilderRecord;
+}

package/src/v4/i3s-converter/json-templates/scene-server.ts

@@ -1,27 +1,36 @@
-export const SCENE_SERVER = () => ({
-  serviceItemId: {
-    path: 'serviceItemId'
-  },
-  serviceName: {
-    path: 'layerName'
-  },
-  name: {
-    path: 'layerName'
-  },
-  currentVersion: {
-    path: 'currentVersion',
-    default: 10.7
-  },
-  serviceVersion: {
-    path: 'serviceVersion',
-    default: '1.8'
-  },
-  supportedBindings: {
-    path: 'supportedBindings',
-    default: ['REST']
-  },
-  layers: {
-    path: 'layers0',
-    transform: layers0 => [layers0]
-  }
-});
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+import type {BuilderInput} from '../../lib/utils/builder-input';
+
+import type {SceneLayer3D} from '@loaders.gl/tiles-3d/i3s';
+/** Legacy scene service input and output fields. */
+export type SceneServerRecord = {
+  /** Service identifier. */
+  serviceItemId?: string;
+  /** Input layer name. */
+  layerName?: string;
+  /** Layer document. */
+  layers0?: SceneLayer3D;
+  /** Server version. */
+  currentVersion: number;
+  /** Service version. */
+  serviceVersion: string;
+  /** Supported protocols. */
+  supportedBindings: string[];
+};
+
+/** Builds scene server with the legacy field selection and defaults. */
+export function createSceneServer(input: BuilderInput<SceneServerRecord> | null | undefined) {
+  const source = input ?? {};
+  return {
+    serviceItemId: source.serviceItemId ?? undefined,
+    serviceName: source.layerName ?? undefined,
+    name: source.layerName ?? undefined,
+    currentVersion: source.currentVersion ?? 10.7,
+    serviceVersion: source.serviceVersion ?? '1.8',
+    supportedBindings: source.supportedBindings ?? ['REST'],
+    layers: [source.layers0 ?? undefined]
+  };
+}

package/src/v4/i3s-converter/json-templates/shared-resources.ts

@@ -1,134 +1,73 @@
-import transform from 'json-map-transform';
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 
-const MATERIAL_DEFINITION_INFO_PARAMS = () => ({
-  renderMode: {
-    path: 'renderMode',
-    default: 'solid'
-  },
-  shininess: {
-    path: 'shininess',
-    default: 1
-  },
-  reflectivity: {
-    path: 'reflectivity',
-    default: 0
-  },
-  ambient: {
-    path: 'ambient',
-    default: [1, 1, 1]
-  },
-  diffuse: {
-    path: 'diffuse',
-    default: [1, 1, 1]
-  },
-  specular: {
-    path: 'specular',
-    default: [0, 0, 0]
-  },
-  useVertexColorAlpha: {
-    path: 'useVertexColorAlpha',
-    default: false
-  },
-  vertexRegions: {
-    path: 'vertexRegions',
-    default: false
-  },
-  vertexColors: {
-    path: 'vertexColors',
-    default: true
-  }
-});
+import type {BuilderInput} from '../../lib/utils/builder-input';
 
-const MATERIAL_DEFINITION_INFO = () => ({
-  name: {
-    path: 'name',
-    default: 'standard'
-  },
-  type: {
-    path: 'type',
-    default: 'standard'
-  },
-  params: {
-    path: 'params',
-    transform: (val, thisObject, originalObject) =>
-      transform(originalObject, MATERIAL_DEFINITION_INFO_PARAMS())
-  }
-});
+import type {MaterialDefinitionInfo, TextureDefinitionInfo} from '@loaders.gl/tiles-3d/i3s';
+import type {SharedResourcesArrays} from '../types';
 
-const TEXTURE_DEFINITION_IMAGE = () => ({
-  id: {
-    path: 'id'
-  },
-  size: {
-    path: 'size'
-  },
-  href: {
-    path: 'href',
-    default: ['../textures/0']
-  },
-  length: {
-    path: 'length'
-  }
-});
+/** Legacy material fields are selected from the material record, rather than its params field. */
+/** Legacy texture records receive the generated image index as an annotation. */
+type IndexedTexture = TextureDefinitionInfo & {
+  /** Generated legacy image index. */
+  imageIndex?: string;
+};
 
-const TEXTURE_DEFINITION_INFO = () => ({
-  encoding: {
-    path: 'encoding'
-  },
-  wrap: {
-    path: 'wrap',
-    default: ['none']
-  },
-  atlas: {
-    path: 'atlas',
-    default: false
-  },
-  uvSet: {
-    path: 'uvSet',
-    default: 'uv0'
-  },
-  channels: {
-    path: 'channels',
-    default: 'rgb'
-  },
-  images: {
-    path: 'images',
-    transform: (val, thisObject, originalObject) =>
-      val.map(image => transform(image, TEXTURE_DEFINITION_IMAGE()))
-  }
-});
+/** Material parameters are selected from the root record. */
+type MaterialInput = BuilderInput<MaterialDefinitionInfo> &
+  BuilderInput<MaterialDefinitionInfo['params']>;
 
-export const SHARED_RESOURCES = () => ({
-  materialDefinitions: {
-    path: 'materialDefinitionInfos',
-    transform: transfromMaterialDefinitions
-  },
-  textureDefinitions: {
-    path: 'textureDefinitionInfos',
-    transform: transfromTextureDefinitions
-  }
-});
+/** Builds one material while retaining the legacy root-level parameter selection. */
+function createMaterial(input: MaterialInput) {
+  return {
+    name: input.name ?? 'standard',
+    type: input.type ?? 'standard',
+    params: {
+      renderMode: input.renderMode ?? 'solid',
+      shininess: input.shininess ?? 1,
+      reflectivity: input.reflectivity ?? 0,
+      ambient: input.ambient ?? [1, 1, 1],
+      diffuse: input.diffuse ?? [1, 1, 1],
+      specular: input.specular ?? [0, 0, 0],
+      useVertexColorAlpha: input.useVertexColorAlpha ?? false,
+      vertexRegions: input.vertexRegions ?? false,
+      vertexColors: input.vertexColors ?? true
+    }
+  };
+}
 
-function transfromMaterialDefinitions(materialDefinitionInfos, thisObject, originalObject) {
-  const result = {};
-  for (const [index, materialDefinitionInfo] of materialDefinitionInfos.entries()) {
-    result[`Mat${originalObject.nodePath}${index}`] = transform(
-      materialDefinitionInfo,
-      MATERIAL_DEFINITION_INFO()
-    );
-  }
-  return result;
+/** Builds a texture record with the historical image fields and defaults. */
+function createTexture(input: BuilderInput<TextureDefinitionInfo>) {
+  return {
+    encoding: input.encoding ?? undefined,
+    wrap: input.wrap ?? ['none'],
+    atlas: input.atlas ?? false,
+    uvSet: input.uvSet ?? 'uv0',
+    channels: input.channels ?? 'rgb',
+    images: input.images!.map(image => ({
+      id: image.id ?? undefined,
+      size: image.size ?? undefined,
+      href: image.href ?? ['../textures/0'],
+      length: image.length ?? undefined
+    }))
+  };
 }
 
-function transfromTextureDefinitions(textureDefinitionInfos, thisObject, originalObject) {
-  if (!textureDefinitionInfos) {
-    return null;
+/** Builds shared resources, preserving generated keys and the legacy image-index annotation. */
+export function createSharedResources(input: SharedResourcesArrays) {
+  const materialDefinitions: Record<string, ReturnType<typeof createMaterial>> = {};
+  for (const [index, material] of input.materialDefinitionInfos!.entries()) {
+    materialDefinitions[`Mat${input.nodePath}${index}`] = createMaterial(material);
   }
-  const result = {};
-  for (const [index, textureDefinitionInfo] of textureDefinitionInfos.entries()) {
-    const imageIndex = `${originalObject.nodePath}${index}`;
-    textureDefinitionInfo.imageIndex = imageIndex;
-    result[imageIndex] = transform(textureDefinitionInfo, TEXTURE_DEFINITION_INFO());
+  const textureDefinitions: Record<string, ReturnType<typeof createTexture>> | null =
+    input.textureDefinitionInfos ? {} : null;
+  if (textureDefinitions) {
+    for (const [index, texture] of input.textureDefinitionInfos!.entries()) {
+      const imageIndex = `${input.nodePath}${index}`;
+      (texture as IndexedTexture).imageIndex = imageIndex;
+      textureDefinitions[imageIndex] = createTexture(texture);
+    }
   }
-  return result;
+  return {materialDefinitions, textureDefinitions};
 }

package/src/v4/i3s-converter/json-templates/store.ts

@@ -1,58 +1,40 @@
-export const STORE = {
-  id: {
-    path: 'id',
-    transform: val => val.toUpperCase()
-  },
-  profile: {
-    path: 'profile',
-    default: 'meshpyramids'
-  },
-  version: {
-    path: 'version',
-    default: '1.8'
-  },
-  resourcePattern: {
-    path: 'resourcePattern',
-    default: ['3dNodeIndexDocument', 'Attributes', 'SharedResource', 'Geometry']
-  },
-  rootNode: {
-    path: 'rootNode',
-    default: './nodes/root'
-  },
-  extent: {
-    path: 'extent'
-  },
-  indexCRS: {
-    path: 'indexCRS',
-    default: 'http://www.opengis.net/def/crs/EPSG/0/4326'
-  },
-  vertexCRS: {
-    path: 'vertexCRS',
-    default: 'http://www.opengis.net/def/crs/EPSG/0/4326'
-  },
-  normalReferenceFrame: {
-    path: 'normalReferenceFrame',
-    default: 'east-north-up'
-  },
-  attributeEncoding: {
-    path: 'attributeEncoding',
-    default: 'application/octet-stream; version=1.6'
-  },
-  textureEncoding: {
-    path: 'textureEncoding',
-    default: ['image/jpeg', 'image/ktx2']
-  },
-  lodType: {
-    path: 'lodType',
-    default: 'MeshPyramid'
-  },
-  lodModel: {
-    path: 'lodModel',
-    default: 'node-switching'
-  },
-  defaultGeometrySchema: {
-    path: 'defaultGeometrySchema',
-    default: {
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+import type {BuilderInput} from '../../lib/utils/builder-input';
+
+import type {Store} from '@loaders.gl/tiles-3d/i3s';
+
+/** Converter stores use the legacy uppercase string identifier. */
+export type StoreBuilderRecord = Omit<Store, 'id'> & {
+  /** Store identifier before uppercase normalization. */
+  id: string;
+};
+
+/** Builds store with the legacy field selection and defaults. */
+export function createStore(input: BuilderInput<StoreBuilderRecord> | null | undefined): Store {
+  const source = input ?? {};
+  return {
+    id: source.id!.toUpperCase(),
+    profile: source.profile ?? 'meshpyramids',
+    version: source.version ?? '1.8',
+    resourcePattern: source.resourcePattern ?? [
+      '3dNodeIndexDocument',
+      'Attributes',
+      'SharedResource',
+      'Geometry'
+    ],
+    rootNode: source.rootNode ?? './nodes/root',
+    extent: source.extent ?? undefined,
+    indexCRS: source.indexCRS ?? 'http://www.opengis.net/def/crs/EPSG/0/4326',
+    vertexCRS: source.vertexCRS ?? 'http://www.opengis.net/def/crs/EPSG/0/4326',
+    normalReferenceFrame: source.normalReferenceFrame ?? 'earth-centered',
+    attributeEncoding: source.attributeEncoding ?? 'application/octet-stream; version=1.6',
+    textureEncoding: source.textureEncoding ?? ['image/jpeg', 'image/ktx2'],
+    lodType: source.lodType ?? 'MeshPyramid',
+    lodModel: source.lodModel ?? 'node-switching',
+    defaultGeometrySchema: source.defaultGeometrySchema ?? {
       geometryType: 'triangles',
       header: [
         {
@@ -96,5 +78,5 @@ export const STORE = {
         }
       }
     }
-  }
-};
+  } as Store;
+}

package/src/v4/i3s-converter/types.ts

@@ -1,10 +1,10 @@
-import {GLTFImagePostprocessed, GLTFNodePostprocessed} from '@loaders.gl/gltf';
+import type {ConversionNode, ConversionImage} from './helpers/conversion-gltf';
 import {
   BoundingVolumes,
   I3SMaterialDefinition,
   MaterialDefinitionInfo,
   TextureDefinitionInfo
-} from '@loaders.gl/i3s';
+} from '@loaders.gl/tiles-3d/i3s';
 import {Matrix4, Vector3} from '@math.gl/core';
 
 /** Converted resources for specific node */
@@ -141,7 +141,7 @@ export type I3SMaterialWithTexture = {
   /** Material definition https://github.com/Esri/i3s-spec/blob/master/docs/1.8/materialDefinitions.cmn.md */
   material: I3SMaterialDefinition;
   /** Texture content (image) */
-  texture?: GLTFImagePostprocessed;
+  texture?: ConversionImage;
   /** Metadata of all merged materials */
   mergedMaterials: MergedMaterial[];
 };
@@ -217,7 +217,7 @@ export type GLTFAttributesData = {
   /** glTF PBR materials (only id is required) */
   gltfMaterials?: {id: string}[];
   /** glTF geometry nodes */
-  nodes: GLTFNodePostprocessed[];
+  nodes: ConversionNode[];
   /** glTF texture images (set to null for compressed textures) */
   images: (null | TextureImageProperties)[];
   /** Source tile origin coordinates in cartographic coordinate system */

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

@@ -1,6 +1,6 @@
-import '@loaders.gl/polyfills';
-import {parseSLPKArchive, SLPKArchive} from '@loaders.gl/i3s';
-import {NodeFile} from '@loaders.gl/loader-utils';
+import '@loaders.gl/core/polyfills';
+import {parseSLPKArchive, SLPKArchive} from '@loaders.gl/tiles-3d/i3s';
+import {NodeFile} from '@loaders.gl/core/loader-utils';
 
 let slpkArchive: SLPKArchive;
 

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

@@ -1,5 +1,5 @@
-import {SceneLayer3D} from '@loaders.gl/i3s';
-import {v4 as uuidv4} from 'uuid';
+import {SceneLayer3D} from '@loaders.gl/tiles-3d/i3s';
+import {randomUUID} from 'node:crypto';
 
 /**
  * Create `/SceneServer` response
@@ -9,7 +9,7 @@ import {v4 as uuidv4} from 'uuid';
  */
 export const createSceneServer = (name: string, layer: SceneLayer3D) => {
   return {
-    serviceItemId: uuidv4().replace(/-/gi, ''),
+    serviceItemId: randomUUID().replace(/-/gi, ''),
     serviceName: name,
     name,
     currentVersion: '10.7',

package/src/v4/lib/utils/builder-input.ts

@@ -0,0 +1,8 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+/** Partial converter input; missing and null fields both select legacy defaults. */
+export type BuilderInput<T> = {
+  [Property in keyof T]?: T[Property] | null;
+};

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

@@ -2,7 +2,11 @@ import {isDeepStrictEqual} from 'util';
 import {DUMP_FILE_SUFFIX} from '../../constants';
 import {isFileExists, openJson, removeFile, renameFile, writeFile} from './file-utils';
 import {join} from 'path';
-import {BoundingVolumes, I3SMaterialDefinition, TextureSetDefinitionFormats} from '@loaders.gl/i3s';
+import {
+  BoundingVolumes,
+  I3SMaterialDefinition,
+  TextureSetDefinitionFormats
+} from '@loaders.gl/tiles-3d/i3s';
 import {AttributeMetadataInfoObject} from '../../i3s-converter/helpers/attribute-metadata-info';
 import process from 'process';
 import Ajv from 'ajv';

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

@@ -1,5 +1,5 @@
 import {load} from '@loaders.gl/core';
-import {JSONLoader} from '@loaders.gl/loader-utils';
+import {JSONLoader} from '@loaders.gl/core/loader-utils';
 import {promises as fs} from 'fs';
 import {isAbsolute, join} from 'path';
 import {compressFileWithGzip} from './compress-util';

package/src/v4/lib/utils/hash-string.ts

@@ -0,0 +1,21 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+import {MD5Hash} from '@loaders.gl/crypto';
+
+/** Shared synchronous calculator for converter identifiers. */
+const md5Hash = new MD5Hash();
+/** Encodes converter identifiers as UTF-8. */
+const textEncoder = new TextEncoder();
+
+/**
+ * Computes the legacy lowercase MD5 identifier from a UTF-8 converter string.
+ * @throws URIError when the input contains an unpaired surrogate, matching the legacy encoder.
+ */
+export function hashString(value: string): string {
+  if (/[\uD800-\uDBFF](?![\uDC00-\uDFFF])|(?<![\uD800-\uDBFF])[\uDC00-\uDFFF]/u.test(value)) {
+    throw new URIError('URI malformed');
+  }
+  return md5Hash.hashSync(textEncoder.encode(value).buffer, 'hex');
+}

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

@@ -1,6 +1,6 @@
-import {Tiles3DTileJSONPostprocessed} from '@loaders.gl/3d-tiles';
-import {BoundingVolumes} from '@loaders.gl/i3s';
-import {I3STileHeader} from '@loaders.gl/i3s/src/types';
+import {Tiles3DTileJSONPostprocessed} from '@loaders.gl/tiles-3d/3d-tiles';
+import {BoundingVolumes} from '@loaders.gl/tiles-3d/i3s';
+import type {I3STileHeader} from '@loaders.gl/tiles-3d/i3s';
 
 // https://cesium.com/docs/cesiumjs-ref-doc/Cesium3DTileset.html
 const DEFAULT_MAXIMUM_SCREEN_SPACE_ERROR = 16;

package/src/v4/pgm-loader.ts

@@ -1,5 +1,5 @@
-import type {LoaderWithParser, LoaderOptions} from '@loaders.gl/loader-utils';
-import {Geoid, parsePGM} from '@math.gl/geoid';
+import type {LoaderWithParser, LoaderOptions} from '@loaders.gl/core/loader-utils';
+import {Geoid, parsePGM} from '@math.gl/earth/geoid';
 
 // __VERSION__ is injected by babel-plugin-version-inline
 // @ts-ignore TS2304: Cannot find name '__VERSION__'.