@loaders.gl/i3s 4.2.0-alpha.4 → 4.2.0-alpha.5

package/dist/lib/parsers/parse-arcgis-webscene.js

@@ -1,77 +1,97 @@
 import { JSONLoader, load } from '@loaders.gl/core';
+/**
+ * WKID, or Well-Known ID, of the CRS. Specify either WKID or WKT of the CRS.
+ * Spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.8/spatialReference.cmn.md
+ */
 const SUPPORTED_WKID = 4326;
 const ARCGIS_SCENE_SERVER_LAYER_TYPE = 'ArcGISSceneServiceLayer';
 const BUILDING_SCENE_LAYER = 'BuildingSceneLayer';
 const INTEGRATED_MESH_LAYER = 'IntegratedMeshLayer';
 const GROUP_LAYER = 'GroupLayer';
-const SUPPORTED_LAYERS_TYPES = [ARCGIS_SCENE_SERVER_LAYER_TYPE, INTEGRATED_MESH_LAYER, BUILDING_SCENE_LAYER, GROUP_LAYER];
+/**
+ * Supported layers list
+ * Possible operational layers in WebScene: https://developers.arcgis.com/web-scene-specification/objects/operationalLayers/
+ */
+const SUPPORTED_LAYERS_TYPES = [
+    ARCGIS_SCENE_SERVER_LAYER_TYPE,
+    INTEGRATED_MESH_LAYER,
+    BUILDING_SCENE_LAYER,
+    GROUP_LAYER
+];
 const NO_AVAILABLE_SUPPORTED_LAYERS_ERROR = 'NO_AVAILABLE_SUPPORTED_LAYERS_ERROR';
 const NOT_SUPPORTED_CRS_ERROR = 'NOT_SUPPORTED_CRS_ERROR';
+/**
+ * Provides additional information in the exception Error object, e.g. unsupported layer types.
+ * @param message - message used in the Error object
+ * @param details - additional information that can be used to handle the exception.
+ * @example throw new LayerError(NO_AVAILABLE_SUPPORTED_LAYERS_ERROR, unsupportedLayers);
+ */
 export class LayerError extends Error {
-  constructor(message, details) {
-    super(message);
-    this.details = details;
-    this.name = 'LayerError';
-  }
+    constructor(message, details) {
+        super(message);
+        this.details = details;
+        this.name = 'LayerError';
+    }
 }
+/**
+ * Parses ArcGIS WebScene
+ * @param data
+ */
 export async function parseWebscene(data) {
-  const layer0 = JSON.parse(new TextDecoder().decode(data));
-  const {
-    operationalLayers
-  } = layer0;
-  const {
-    layers,
-    unsupportedLayers
-  } = await parseOperationalLayers(operationalLayers, true);
-  if (!layers.length) {
-    throw new LayerError(NO_AVAILABLE_SUPPORTED_LAYERS_ERROR, unsupportedLayers);
-  }
-  return {
-    header: layer0,
-    layers,
-    unsupportedLayers
-  };
+    const layer0 = JSON.parse(new TextDecoder().decode(data));
+    const { operationalLayers } = layer0;
+    const { layers, unsupportedLayers } = await parseOperationalLayers(operationalLayers, true);
+    if (!layers.length) {
+        throw new LayerError(NO_AVAILABLE_SUPPORTED_LAYERS_ERROR, unsupportedLayers);
+    }
+    return {
+        header: layer0,
+        layers,
+        unsupportedLayers
+    };
 }
+/**
+ * Recursively parses WebScene operational layers.
+ * @param layersList
+ */
 async function parseOperationalLayers(layersList, needToCheckCRS) {
-  const layers = [];
-  let unsupportedLayers = [];
-  for (let index = 0; index < layersList.length; index++) {
-    var _layer$layers;
-    const layer = layersList[index];
-    const isLayerSupported = SUPPORTED_LAYERS_TYPES.includes(layer.layerType);
-    if (isLayerSupported) {
-      if (needToCheckCRS && layer.layerType !== GROUP_LAYER) {
-        await checkSupportedIndexCRS(layer);
-        needToCheckCRS = false;
-      }
-      layers.push(layer);
-    } else {
-      unsupportedLayers.push(layer);
+    const layers = [];
+    let unsupportedLayers = [];
+    for (let index = 0; index < layersList.length; index++) {
+        const layer = layersList[index];
+        const isLayerSupported = SUPPORTED_LAYERS_TYPES.includes(layer.layerType);
+        if (isLayerSupported) {
+            if (needToCheckCRS && layer.layerType !== GROUP_LAYER) {
+                await checkSupportedIndexCRS(layer);
+                needToCheckCRS = false;
+            }
+            layers.push(layer);
+        }
+        else {
+            unsupportedLayers.push(layer);
+        }
+        if (layer.layers?.length) {
+            const { layers: childLayers, unsupportedLayers: childUnsupportedLayers } = await parseOperationalLayers(layer.layers, needToCheckCRS);
+            layer.layers = childLayers;
+            unsupportedLayers = [...unsupportedLayers, ...childUnsupportedLayers];
+        }
     }
-    if ((_layer$layers = layer.layers) !== null && _layer$layers !== void 0 && _layer$layers.length) {
-      const {
-        layers: childLayers,
-        unsupportedLayers: childUnsupportedLayers
-      } = await parseOperationalLayers(layer.layers, needToCheckCRS);
-      layer.layers = childLayers;
-      unsupportedLayers = [...unsupportedLayers, ...childUnsupportedLayers];
-    }
-  }
-  return {
-    layers,
-    unsupportedLayers
-  };
+    return { layers, unsupportedLayers };
 }
+/**
+ * Check if layer has supported CRS
+ * @param layer
+ */
 async function checkSupportedIndexCRS(layer) {
-  try {
-    var _layerJson$spatialRef;
-    const layerJson = await load(layer.url, JSONLoader);
-    const wkid = layerJson === null || layerJson === void 0 ? void 0 : (_layerJson$spatialRef = layerJson.spatialReference) === null || _layerJson$spatialRef === void 0 ? void 0 : _layerJson$spatialRef.wkid;
-    if (wkid !== SUPPORTED_WKID) {
-      throw new Error(NOT_SUPPORTED_CRS_ERROR);
+    try {
+        const layerJson = await load(layer.url, JSONLoader);
+        // @ts-expect-error
+        const wkid = layerJson?.spatialReference?.wkid;
+        if (wkid !== SUPPORTED_WKID) {
+            throw new Error(NOT_SUPPORTED_CRS_ERROR);
+        }
+    }
+    catch (error) {
+        throw error;
     }
-  } catch (error) {
-    throw error;
-  }
 }
-//# sourceMappingURL=parse-arcgis-webscene.js.map

package/dist/lib/parsers/parse-i3s-attribute.js

@@ -1,60 +1,97 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 import { STRING_ATTRIBUTE_TYPE, OBJECT_ID_ATTRIBUTE_TYPE, FLOAT_64_TYPE, INT_16_ATTRIBUTE_TYPE } from "./constants.js";
+/**
+ * Get particular tile and creates attribute object inside.
+ * @param  arrayBuffer
+ * @param {Object} options
+ * @returns {Promise<object>}
+ */
 export function parseI3STileAttribute(arrayBuffer, options) {
-  const {
-    attributeName,
-    attributeType
-  } = options;
-  if (!attributeName) {
-    return {};
-  }
-  return {
-    [attributeName]: attributeType ? parseAttribute(attributeType, arrayBuffer) : null
-  };
+    const { attributeName, attributeType } = options;
+    if (!attributeName) {
+        return {};
+    }
+    return {
+        [attributeName]: attributeType ? parseAttribute(attributeType, arrayBuffer) : null
+    };
 }
+/**
+ * Parse attributes based on attribute type.
+ * @param {String} attributeType
+ * @param  arrayBuffer
+ * @returns
+ */
 function parseAttribute(attributeType, arrayBuffer) {
-  switch (attributeType) {
-    case STRING_ATTRIBUTE_TYPE:
-      return parseStringsAttribute(arrayBuffer);
-    case OBJECT_ID_ATTRIBUTE_TYPE:
-      return parseShortNumberAttribute(arrayBuffer);
-    case FLOAT_64_TYPE:
-      return parseFloatAttribute(arrayBuffer);
-    case INT_16_ATTRIBUTE_TYPE:
-      return parseInt16ShortNumberAttribute(arrayBuffer);
-    default:
-      return parseShortNumberAttribute(arrayBuffer);
-  }
+    switch (attributeType) {
+        case STRING_ATTRIBUTE_TYPE:
+            return parseStringsAttribute(arrayBuffer);
+        case OBJECT_ID_ATTRIBUTE_TYPE:
+            return parseShortNumberAttribute(arrayBuffer);
+        case FLOAT_64_TYPE:
+            return parseFloatAttribute(arrayBuffer);
+        case INT_16_ATTRIBUTE_TYPE:
+            return parseInt16ShortNumberAttribute(arrayBuffer);
+        default:
+            return parseShortNumberAttribute(arrayBuffer);
+    }
 }
+/**
+ * Parse short number attribute.
+ * Short Integer spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.7/attributeStorageInfo.cmn.md
+ * @param  arrayBuffer
+ * @returns
+ */
 function parseShortNumberAttribute(arrayBuffer) {
-  const countOffset = 4;
-  return new Uint32Array(arrayBuffer, countOffset);
+    const countOffset = 4;
+    return new Uint32Array(arrayBuffer, countOffset);
 }
+/**
+ * Parse Int16 short number attribute.
+ * Parsing of such data is not documented. Added to handle Building Scene Layer Tileset attributes data.
+ * @param  arrayBuffer
+ * @returns
+ */
 function parseInt16ShortNumberAttribute(arrayBuffer) {
-  const countOffset = 4;
-  return new Int16Array(arrayBuffer, countOffset);
+    const countOffset = 4;
+    return new Int16Array(arrayBuffer, countOffset);
 }
+/**
+ * Parse float attribute.
+ * Double Spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.7/attributeStorageInfo.cmn.md
+ * @param  arrayBuffer
+ * @returns
+ */
 function parseFloatAttribute(arrayBuffer) {
-  const countOffset = 8;
-  return new Float64Array(arrayBuffer, countOffset);
+    const countOffset = 8;
+    return new Float64Array(arrayBuffer, countOffset);
 }
+/**
+ * Parse string attribute.
+ * String spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.7/attributeStorageInfo.cmn.md
+ * @param arrayBuffer
+ * @returns list of strings
+ */
 function parseStringsAttribute(arrayBuffer) {
-  const stringsCountOffset = 0;
-  const dataOffset = 8;
-  const bytesPerStringSize = 4;
-  const stringsArray = [];
-  try {
-    const stringsCount = new DataView(arrayBuffer, stringsCountOffset, bytesPerStringSize).getUint32(stringsCountOffset, true);
-    const stringSizes = new Uint32Array(arrayBuffer, dataOffset, stringsCount);
-    let stringOffset = dataOffset + stringsCount * bytesPerStringSize;
-    for (const stringByteSize of stringSizes) {
-      const textDecoder = new TextDecoder('utf-8');
-      const stringAttribute = new Uint8Array(arrayBuffer, stringOffset, stringByteSize);
-      stringsArray.push(textDecoder.decode(stringAttribute));
-      stringOffset += stringByteSize;
+    const stringsCountOffset = 0;
+    const dataOffset = 8;
+    const bytesPerStringSize = 4;
+    const stringsArray = [];
+    try {
+        // Use DataView to avoid multiple of 4 error on Uint32Array constructor
+        const stringsCount = new DataView(arrayBuffer, stringsCountOffset, bytesPerStringSize).getUint32(stringsCountOffset, true);
+        const stringSizes = new Uint32Array(arrayBuffer, dataOffset, stringsCount);
+        let stringOffset = dataOffset + stringsCount * bytesPerStringSize;
+        for (const stringByteSize of stringSizes) {
+            const textDecoder = new TextDecoder('utf-8');
+            const stringAttribute = new Uint8Array(arrayBuffer, stringOffset, stringByteSize);
+            stringsArray.push(textDecoder.decode(stringAttribute));
+            stringOffset += stringByteSize;
+        }
+    }
+    catch (error) {
+        console.error('Parse string attribute error: ', error.message); // eslint-disable-line
     }
-  } catch (error) {
-    console.error('Parse string attribute error: ', error.message);
-  }
-  return stringsArray;
+    return stringsArray;
 }
-//# sourceMappingURL=parse-i3s-attribute.js.map

package/dist/lib/parsers/parse-i3s-building-scene-layer.d.ts

@@ -1,4 +1,4 @@
-import type { BuildingSceneLayerTileset } from '../../types';
+import type { BuildingSceneLayerTileset } from "../../types.js";
 /**
  * Parses Builiding Scene Layer and creates tileset
  * @param data

package/dist/lib/parsers/parse-i3s-building-scene-layer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parse-i3s-building-scene-layer.d.ts","sourceRoot":"","sources":["../../../src/lib/parsers/parse-i3s-building-scene-layer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,yBAAyB,EAAwB,MAAM,aAAa,CAAC;AAIlF;;;;;GAKG;AACH,wBAAsB,uBAAuB,CAC3C,IAAI,EAAE,WAAW,EACjB,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,yBAAyB,CAAC,CAQpC"}
+{"version":3,"file":"parse-i3s-building-scene-layer.d.ts","sourceRoot":"","sources":["../../../src/lib/parsers/parse-i3s-building-scene-layer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,yBAAyB,EAAwB,uBAAoB;AAIlF;;;;;GAKG;AACH,wBAAsB,uBAAuB,CAC3C,IAAI,EAAE,WAAW,EACjB,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,yBAAyB,CAAC,CAQpC"}

package/dist/lib/parsers/parse-i3s-building-scene-layer.js

@@ -1,39 +1,42 @@
 const OBJECT_3D_LAYER_TYPE = '3DObject';
+/**
+ * Parses Builiding Scene Layer and creates tileset
+ * @param data
+ * @param options
+ * @param context
+ */
 export async function parseBuildingSceneLayer(data, url) {
-  const layer0 = JSON.parse(new TextDecoder().decode(data));
-  const {
-    sublayers
-  } = layer0;
-  return {
-    header: layer0,
-    sublayers: parseSublayersTree(sublayers, url)
-  };
+    const layer0 = JSON.parse(new TextDecoder().decode(data));
+    const { sublayers } = layer0;
+    return {
+        header: layer0,
+        sublayers: parseSublayersTree(sublayers, url)
+    };
 }
+/**
+ * Recursively parses Building Scene Layer sublayers.
+ * @param sublayers
+ * @param url
+ */
 function parseSublayersTree(sublayers, url) {
-  let layers = [];
-  for (let index = 0; index < sublayers.length; index++) {
-    var _subLayer$sublayers;
-    const subLayer = sublayers[index];
-    const {
-      id,
-      layerType,
-      visibility = true,
-      ...rest
-    } = subLayer;
-    if (layerType === OBJECT_3D_LAYER_TYPE) {
-      const sublayerUrl = `${url}/sublayers/${id}`;
-      layers.push({
-        url: sublayerUrl,
-        id,
-        layerType,
-        visibility,
-        ...rest
-      });
+    let layers = [];
+    for (let index = 0; index < sublayers.length; index++) {
+        const subLayer = sublayers[index];
+        const { id, layerType, visibility = true, ...rest } = subLayer;
+        // Add support only for 3DObject layer type for I3S purposes.
+        if (layerType === OBJECT_3D_LAYER_TYPE) {
+            const sublayerUrl = `${url}/sublayers/${id}`;
+            layers.push({
+                url: sublayerUrl,
+                id,
+                layerType,
+                visibility,
+                ...rest
+            });
+        }
+        if (subLayer?.sublayers?.length) {
+            layers = [...layers, ...parseSublayersTree(subLayer.sublayers, url)];
+        }
     }
-    if (subLayer !== null && subLayer !== void 0 && (_subLayer$sublayers = subLayer.sublayers) !== null && _subLayer$sublayers !== void 0 && _subLayer$sublayers.length) {
-      layers = [...layers, ...parseSublayersTree(subLayer.sublayers, url)];
-    }
-  }
-  return layers;
+    return layers;
 }
-//# sourceMappingURL=parse-i3s-building-scene-layer.js.map

package/dist/lib/parsers/parse-i3s-tile-content.d.ts

@@ -1,4 +1,4 @@
 import { LoaderOptions, LoaderContext } from '@loaders.gl/loader-utils';
-import { I3STileContent, I3STileOptions, I3STilesetOptions } from '../../types';
+import { I3STileContent, I3STileOptions, I3STilesetOptions } from "../../types.js";
 export declare function parseI3STileContent(arrayBuffer: ArrayBuffer, tileOptions: I3STileOptions, tilesetOptions: I3STilesetOptions, options?: LoaderOptions, context?: LoaderContext): Promise<I3STileContent>;
 //# sourceMappingURL=parse-i3s-tile-content.d.ts.map

package/dist/lib/parsers/parse-i3s-tile-content.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parse-i3s-tile-content.d.ts","sourceRoot":"","sources":["../../../src/lib/parsers/parse-i3s-tile-content.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,aAAa,EAAE,aAAa,EAAmB,MAAM,0BAA0B,CAAC;AAKxF,OAAO,EAQL,cAAc,EACd,cAAc,EACd,iBAAiB,EAClB,MAAM,aAAa,CAAC;AAwBrB,wBAAsB,mBAAmB,CACvC,WAAW,EAAE,WAAW,EACxB,WAAW,EAAE,cAAc,EAC3B,cAAc,EAAE,iBAAiB,EACjC,OAAO,CAAC,EAAE,aAAa,EACvB,OAAO,CAAC,EAAE,aAAa,GACtB,OAAO,CAAC,cAAc,CAAC,CAgEzB"}
+{"version":3,"file":"parse-i3s-tile-content.d.ts","sourceRoot":"","sources":["../../../src/lib/parsers/parse-i3s-tile-content.ts"],"names":[],"mappings":"AAIA,OAAO,EAAC,aAAa,EAAE,aAAa,EAAmB,MAAM,0BAA0B,CAAC;AAKxF,OAAO,EAQL,cAAc,EACd,cAAc,EACd,iBAAiB,EAClB,uBAAoB;AAwBrB,wBAAsB,mBAAmB,CACvC,WAAW,EAAE,WAAW,EACxB,WAAW,EAAE,cAAc,EAC3B,cAAc,EAAE,iBAAiB,EACjC,OAAO,CAAC,EAAE,aAAa,EACvB,OAAO,CAAC,EAAE,aAAa,GACtB,OAAO,CAAC,cAAc,CAAC,CAgEzB"}