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

package/dist/types.js

@@ -1,2 +1,21 @@
-export {};
+export let DATA_TYPE;
+
+(function (DATA_TYPE) {
+  DATA_TYPE["UInt8"] = "UInt8";
+  DATA_TYPE["UInt16"] = "UInt16";
+  DATA_TYPE["UInt32"] = "UInt32";
+  DATA_TYPE["UInt64"] = "UInt64";
+  DATA_TYPE["Int16"] = "Int16";
+  DATA_TYPE["Int32"] = "Int32";
+  DATA_TYPE["Int64"] = "Int64";
+  DATA_TYPE["Float32"] = "Float32";
+  DATA_TYPE["Float64"] = "Float64";
+})(DATA_TYPE || (DATA_TYPE = {}));
+
+export let HeaderAttributeProperty;
+
+(function (HeaderAttributeProperty) {
+  HeaderAttributeProperty["vertexCount"] = "vertexCount";
+  HeaderAttributeProperty["featureCount"] = "featureCount";
+})(HeaderAttributeProperty || (HeaderAttributeProperty = {}));
 //# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"sources":[],"names":[],"mappings":"","sourcesContent":[],"file":"types.js"}
+{"version":3,"sources":["../src/types.ts"],"names":["DATA_TYPE","HeaderAttributeProperty"],"mappings":"AAIA,WAAYA,SAAZ;;WAAYA,S;AAAAA,EAAAA,S;AAAAA,EAAAA,S;AAAAA,EAAAA,S;AAAAA,EAAAA,S;AAAAA,EAAAA,S;AAAAA,EAAAA,S;AAAAA,EAAAA,S;AAAAA,EAAAA,S;AAAAA,EAAAA,S;GAAAA,S,KAAAA,S;;AAmmBZ,WAAYC,uBAAZ;;WAAYA,uB;AAAAA,EAAAA,uB;AAAAA,EAAAA,uB;GAAAA,uB,KAAAA,uB","sourcesContent":["import type {GLTFMaterial} from '@loaders.gl/gltf';\nimport type {Matrix4, Quaternion, Vector3} from '@math.gl/core';\nimport type {TypedArray, MeshAttribute, TextureLevel} from '@loaders.gl/schema';\n\nexport enum DATA_TYPE {\n  UInt8 = 'UInt8',\n  UInt16 = 'UInt16',\n  UInt32 = 'UInt32',\n  UInt64 = 'UInt64',\n  Int16 = 'Int16',\n  Int32 = 'Int32',\n  Int64 = 'Int64',\n  Float32 = 'Float32',\n  Float64 = 'Float64'\n}\n/**\n * spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.8/3DSceneLayer.cmn.md\n */\n// TODO Replace \"[key: string]: any\" with actual defenition\nexport interface I3STilesetHeader extends SceneLayer3D {\n  /** Not in spec, but is necessary for woking */\n  url?: string;\n  [key: string]: any;\n}\n/** https://github.com/Esri/i3s-spec/blob/master/docs/1.8/nodePage.cmn.md */\nexport type NodePage = {\n  /** Array of nodes. */\n  nodes: NodeInPage[];\n};\n/**\n * Spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.8/mesh.cmn.md\n */\ntype NodeMesh = {\n  /**\n   * The material definition.\n   */\n  material: MeshMaterial;\n  /** The geometry definition. */\n  geometry: MeshGeometry;\n  /** The attribute set definition. */\n  attribute: meshAttribute;\n};\n/** Spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.8/meshMaterial.cmn.md */\nexport type MeshMaterial = {\n  /** The index in layer.materialDefinitions array. */\n  definition: number;\n  /** Resource id for the material textures. i.e: layers/0/nodes/{material.resource}/textures/{tex_name}. Is required if material declares any textures. */\n  resource?: number;\n  /** Estimated number of texel for the highest resolution base color texture. */\n  texelCountHint?: number;\n};\n/** Spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.8/meshGeometry.cmn.md */\nexport type MeshGeometry = {\n  /** The index in layer.geometryDefinitions array */\n  definition: number;\n  /** The resource locator to be used to query geometry resources: layers/0/nodes/{this.resource}/geometries/{layer.geometryDefinitions[this.definition].geometryBuffers[0 or 1]}. */\n  resource: number;\n  /** Number of vertices in the geometry buffer of this mesh for the umcompressed mesh buffer. Please note that Draco compressed meshes may have less vertices due to de-duplication (actual number of vertices is part of the Draco binary blob). Default=0 */\n  vertexCount?: number;\n  /** Number of features for this mesh. Default=0. (Must omit or set to 0 if mesh doesn't use features.) */\n  featureCount?: number;\n};\n/** https://github.com/Esri/i3s-spec/blob/master/docs/1.8/meshAttribute.cmn.md */\ntype meshAttribute = {\n  /** The resource identifier to be used to locate attribute resources of this mesh. i.e. layers/0/nodes/<resource id>/attributes/... */\n  resource: number;\n};\n\nexport type I3STextureFormat = 'jpg' | 'png' | 'ktx-etc2' | 'dds' | 'ktx2';\n\n// TODO Replace \"[key: string]: any\" with actual defenition\nexport type I3STileHeader = {\n  isDracoGeometry: boolean;\n  textureUrl?: string;\n  url?: string;\n  textureFormat?: I3STextureFormat;\n  textureLoaderOptions?: any;\n  materialDefinition?: I3SMaterialDefinition;\n  mbs: Mbs;\n  obb?: Obb;\n  lodSelection?: LodSelection[];\n  [key: string]: any;\n};\n// TODO Replace \"[key: string]: any\" with actual defenition\nexport type I3STileContent = {\n  attributes: I3SMeshAttributes;\n  indices: TypedArray | null;\n  featureIds: number[] | TypedArray;\n  vertexCount: number;\n  modelMatrix: Matrix4;\n  coordinateSystem: number;\n  byteLength: number;\n  texture: TileContentTexture;\n  [key: string]: any;\n};\n\nexport type TileContentTexture =\n  | ArrayBuffer\n  | {\n      compressed: boolean;\n      mipmaps: boolean;\n      width: number;\n      height: number;\n      data: TextureLevel[];\n    }\n  | null;\n\nexport type BoundingVolumes = {\n  mbs: Mbs;\n  obb: Obb;\n};\n\nexport type Obb = {\n  center: number[] | Vector3;\n  halfSize: number[] | Vector3;\n  quaternion: Quaternion;\n};\n\nexport type Mbs = [number, number, number, number];\n\n/** SceneLayer3D based on I3S specification - https://github.com/Esri/i3s-spec/blob/master/docs/1.8/3DSceneLayer.cmn.md */\nexport type SceneLayer3D = {\n  /** Unique numeric ID of the layer. */\n  id: number;\n  /** The relative URL to the 3DSceneLayerResource. Only present as part of the SceneServiceInfo resource. */\n  href?: string;\n  /** The user-visible layer type */\n  layerType: '3DObject' | 'IntegratedMesh';\n  /** The spatialReference of the layer including the vertical coordinate reference system (CRS). Well Known Text (WKT) for CRS is included to support custom CRS. */\n  spatialReference?: SpatialReference;\n  /** Enables consuming clients to quickly determine whether this layer is compatible (with respect to its horizontal and vertical coordinate system) with existing content. */\n  heightModelInfo?: HeightModelInfo;\n  /** The ID of the last update session in which any resource belonging to this layer has been updated. */\n  version: string;\n  /** The name of this layer. */\n  name?: string;\n  /** The time of the last update. */\n  serviceUpdateTimeStamp?: {lastUpdate: number};\n  /** The display alias to be used for this layer. */\n  alias?: string;\n  /** Description string for this layer. */\n  description?: string;\n  /** Copyright and usage information for the data in this layer. */\n  copyrightText?: string;\n  /** Capabilities supported by this layer. */\n  capabilities: string[];\n  /** ZFactor to define conversion factor for elevation unit. */\n  ZFactor?: number;\n  /** Indicates if any styling information represented as drawingInfo is captured as part of the binary mesh representation. */\n  cachedDrawingInfo?: CachedDrawingInfo;\n  /** An object containing drawing information. */\n  drawingInfo?: DrawingInfo;\n  /** An object containing elevation drawing information. If absent, any content of the scene layer is drawn at its z coordinate. */\n  elevationInfo?: ElevationInfo;\n  /** PopupInfo of the scene layer. */\n  popupInfo?: PopupInfo;\n  /** Indicates if client application will show the popup information. Default is FALSE. */\n  disablePopup: boolean;\n  /**\n   * The store object describes the exact physical storage of a layer and\n   * enables the client to detect when multiple layers are served from\n   * the same store.\n   */\n  store: Store;\n  /** A collection of objects that describe each attribute field regarding its field name, datatype, and a user friendly name {name,type,alias}. */\n  fields?: Field[];\n  /** Provides the schema and layout used for storing attribute content in binary format in I3S. */\n  attributeStorageInfo?: AttributeStorageInfo[];\n  /** Contains the statistical information for a layer. */\n  statisticsInfo?: StatisticsInfo[];\n  /** The paged-access index description. */\n  nodePages?: NodePageDefinition;\n  /** List of materials classes used in this layer. */\n  materialDefinitions?: I3SMaterialDefinition[];\n  /** Defines the set of textures that can be referenced by meshes. */\n  textureSetDefinitions?: TextureSetDefinition[];\n  /** Define the layouts of mesh geometry and its attributes */\n  geometryDefinitions?: GeometryDefinition[];\n  /** 3D extent. */\n  fullExtent?: FullExtent;\n};\n/** Spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.8/cachedDrawingInfo.cmn.md */\nexport type CachedDrawingInfo = {\n  /** If true, the drawingInfo is captured as part of the binary scene layer representation. */\n  color: boolean;\n};\n/** Spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.8/drawingInfo.cmn.md */\nexport type DrawingInfo = {\n  /** An object defining the symbology for the layer. See more information about supported renderer types in ArcGIS clients. */\n  renderer: any;\n  /** Scale symbols for the layer. */\n  scaleSymbols: boolean;\n};\n/** Spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.8/elevationInfo.cmn.md */\nexport type ElevationInfo = {\n  mode: 'relativeToGround' | 'absoluteHeight' | 'onTheGround' | 'relativeToScene';\n  /** Offset is always added to the result of the above logic except for onTheGround where offset is ignored. */\n  offset: number;\n  /** A string value indicating the unit for the values in elevationInfo */\n  unit: string;\n};\n/** Spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.8/statisticsInfo.cmn.md */\nexport type StatisticsInfo = {\n  /** Key indicating the resource of the statistics. */\n  key: string;\n  /** Name of the field of the statistical information. */\n  name: string;\n  /** The URL to the statistics information. */\n  href: string;\n};\n/** Spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.8/nodePageDefinition.cmn.md */\nexport type NodePageDefinition = {\n  /** Number of nodes per page for this layer. Must be a power-of-two less than 4096 */\n  nodesPerPage: number;\n  /** Index of the root node. Default = 0. */\n  rootIndex?: number;\n  /** Defines the meaning of nodes[].lodThreshold for this layer. */\n  lodSelectionMetricType: 'maxScreenThresholdSQ';\n};\n/** Spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.8/materialDefinitions.cmn.md */\nexport type I3SMaterialDefinition = {\n  /** A set of parameter values that are used to define the metallic-roughness material model from Physically-Based Rendering (PBR) methodology. When not specified, all the default values of pbrMetallicRoughness apply. */\n  pbrMetallicRoughness: I3SPbrMetallicRoughness;\n  /** The normal texture map. */\n  normalTexture: I3SMaterialTexture;\n  /** The occlusion texture map. */\n  occlusionTexture: I3SMaterialTexture;\n  /** The emissive texture map. */\n  emissiveTexture: I3SMaterialTexture;\n  /** The emissive color of the material. */\n  emissiveFactor: [number, number, number];\n  /** Defines the meaning of the alpha-channel/alpha-mask. */\n  alphaMode: 'opaque' | 'mask' | 'blend';\n  /** The alpha cutoff value of the material. */\n  alphaCutoff: number;\n  /** Specifies whether the material is double sided. */\n  doubleSided: boolean;\n  /** Winding order is counterclockwise. */\n  cullFace: 'none' | 'front' | 'back';\n};\n/** Spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.8/pbrMetallicRoughness.cmn.md */\nexport type I3SPbrMetallicRoughness = {\n  /** The material's base color factor. default=[1,1,1,1] */\n  baseColorFactor: [number, number, number, number];\n  /** The base color texture. */\n  baseColorTexture: I3SMaterialTexture;\n  /** the metalness of the material. default=1.0 */\n  metallicFactor: number;\n  /** the roughness of the material. default=1.0 */\n  roughnessFactor: number;\n  /** the metallic-roughness texture. */\n  metallicRoughnessTexture: I3SMaterialTexture;\n};\n/** Spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.8/materialTexture.cmn.md */\nexport type I3SMaterialTexture = {\n  /** The index in layer.textureSetDefinitions. */\n  textureSetDefinitionId: number;\n  /** The set index of texture's TEXCOORD attribute used for texture coordinate mapping. Default is 0. Deprecated. */\n  texCoord?: number;\n  /** The normal texture: scalar multiplier applied to each normal vector of the normal texture. For occlusion texture,scalar multiplier controlling the amount of occlusion applied. Default=1 */\n  factor?: number;\n};\n/** Spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.8/attributeStorageInfo.cmn.md */\nexport type AttributeStorageInfo = {\n  key: string;\n  name: string;\n  header: {property: string; valueType: string}[];\n  ordering?: string[];\n  attributeValues?: AttributeValue;\n  attributeByteCounts?: AttributeValue;\n  objectIds?: AttributeValue;\n};\n\n/** Spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.8/field.cmn.md */\nexport type Field = {\n  name: string;\n  type: ESRIField;\n  alias?: string;\n  domain?: Domain;\n};\n\nexport type ESRIField =\n  | 'esriFieldTypeDate'\n  | 'esriFieldTypeSingle'\n  | 'esriFieldTypeDouble'\n  | 'esriFieldTypeGUID'\n  | 'esriFieldTypeGlobalID'\n  | 'esriFieldTypeInteger'\n  | 'esriFieldTypeOID'\n  | 'esriFieldTypeSmallInteger'\n  | 'esriFieldTypeString';\n\n/** Spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.8/popupInfo.cmn.md */\nexport type PopupInfo = {\n  title?: string;\n  description?: string;\n  expressionInfos?: any[];\n  fieldInfos?: FieldInfo[];\n  mediaInfos?: any[];\n  popupElements?: {text?: string; type?: string; fieldInfos?: FieldInfo[]}[];\n};\n\n/**\n * Spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.7/3DNodeIndexDocument.cmn.md\n */\nexport type Node3DIndexDocument = {\n  id: string;\n  version?: string;\n  path?: string;\n  level?: number;\n  mbs?: Mbs;\n  obb?: Obb;\n  lodSelection?: LodSelection[];\n  children?: NodeReference[];\n  neighbors?: NodeReference[];\n  parentNode?: NodeReference;\n  sharedResource?: Resource;\n  featureData?: Resource[];\n  geometryData?: Resource[];\n  textureData?: Resource[];\n  attributeData?: Resource[];\n  created?: string;\n  expires?: string;\n};\n\n/**\n * Minimal I3S node data is needed for loading\n */\nexport type I3SMinimalNodeData = {\n  id: string;\n  url?: string;\n  transform?: number[];\n  lodSelection?: LodSelection[];\n  obb?: Obb;\n  mbs?: Mbs;\n  contentUrl?: string;\n  textureUrl?: string;\n  attributeUrls?: string[];\n  materialDefinition?: I3SMaterialDefinition;\n  textureFormat?: I3STextureFormat;\n  textureLoaderOptions?: {[key: string]: any};\n  children?: NodeReference[];\n  isDracoGeometry: boolean;\n};\n\nexport type LodSelection = {\n  metricType?: string;\n  maxError: number;\n};\n\nexport type NodeReference = {\n  id: string;\n  version?: string;\n  mbs?: Mbs;\n  obb?: Obb;\n  href?: string;\n};\n\nexport type Resource = {\n  href: string;\n  layerContent?: string[];\n  featureRange?: number[];\n  multiTextureBundle?: string;\n  vertexElements?: number[];\n  faceElements?: number[];\n  nodePath?: string;\n};\n\nexport type MaxScreenThresholdSQ = {\n  maxError: number;\n};\n\n/** Spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.8/node.cmn.md */\nexport type NodeInPage = {\n  /**\n   * The index in the node array. May be different than material, geometry and attribute resource id. See mesh for more information.\n   */\n  index: number;\n  /**\n   * The index of the parent node in the node array.\n   */\n  parentIndex?: number;\n  /**\n   * When to switch LoD. See https://github.com/Esri/i3s-spec/blob/master/docs/1.8/nodePageDefinition.cmn.md for more information.\n   */\n  lodThreshold?: number;\n  /**\n   * Oriented bounding box for this node.\n   */\n  obb: Obb;\n  /**\n   * index of the children nodes indices.\n   */\n  children?: number[];\n  /**\n   * The mesh for this node. WARNING: only SINGLE mesh is supported at version 1.7 (i.e. length must be 0 or 1).\n   */\n  mesh?: NodeMesh;\n};\n\nexport type SharedResources = {\n  materialDefinitions?: GLTFMaterial[];\n  textureDefinitions?: TextureDefinitionInfo[];\n  nodePath: string;\n};\n\ntype TextureImage = {\n  id: string;\n  size?: number;\n  pixelInWorldUnits?: number;\n  href?: string[];\n  byteOffset?: string[];\n  length?: number[];\n  mimeType?: string;\n  bufferView?: {\n    data: ArrayBuffer;\n  };\n  image?: {\n    height: number;\n    width: number;\n  };\n};\n\nexport type Attribute = 'OBJECTID' | 'string' | 'double' | 'Int32' | string;\n\nexport type Extent = [number, number, number, number];\n\nexport type FeatureAttribute = {\n  id: AttributeValue;\n  faceRange: AttributeValue;\n};\n\nexport type BuildingSceneLayerTileset = {\n  header: BuildingSceneLayer;\n  sublayers: BuildingSceneSublayer[];\n};\n\nexport type BuildingSceneLayer = {\n  id: number;\n  name: string;\n  version: string;\n  alias?: string;\n  layerType: 'Building';\n  description?: string;\n  copyrightText?: string;\n  fullExtent: FullExtent;\n  spatialReference: SpatialReference;\n  heightModelInfo?: HeightModelInfo;\n  sublayers: BuildingSceneSublayer[];\n  filters?: Filter[];\n  activeFilterID?: string;\n  statisticsHRef?: string;\n};\n\nexport type BuildingSceneSublayer = {\n  id: number;\n  name: string;\n  alias?: string;\n  discipline?: 'Mechanical' | 'Architectural' | 'Piping' | 'Electrical' | 'Structural';\n  modelName?: string;\n  layerType: 'group' | '3DObject' | 'Point';\n  visibility?: boolean;\n  sublayers?: BuildingSceneSublayer[];\n  isEmpty?: boolean;\n  url?: string;\n};\n\ntype Filter = {\n  id: string;\n  name: string;\n  description: string;\n  isDefaultFilter?: boolean;\n  isVisible?: boolean;\n  filterBlocks: FilterBlock[];\n  filterAuthoringInfo?: FilterAuthoringInfo;\n};\n\ntype FilterAuthoringInfo = {\n  type: string;\n  filterBlocks: FilterBlockAuthoringInfo[];\n};\n\ntype FilterBlockAuthoringInfo = {\n  filterTypes: FilterType[];\n};\n\ntype FilterType = {\n  filterType: string;\n  filterValues: string[];\n};\n\ntype FilterBlock = {\n  title: string;\n  filterMode: FilterModeSolid | FilterModeWireFrame;\n  filterExpression: string;\n};\n\ntype Edges = {\n  type: string;\n  color: number[];\n  size: number;\n  transparency: number;\n  extensionLength: number;\n};\n\ntype FilterModeSolid = {\n  type: 'solid';\n};\n\ntype FilterModeWireFrame = {\n  type: 'wireFrame';\n  edges: Edges;\n};\n\n/** Spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.8/spatialReference.cmn.md */\nexport type SpatialReference = {\n  /** The current WKID value of the vertical coordinate system. */\n  latestVcsWkid: number;\n  /** dentifies the current WKID value associated with the same spatial reference. */\n  latestWkid: number;\n  /** The WKID value of the vertical coordinate system. */\n  vcsWkid: number;\n  /** WKID, or Well-Known ID, of the CRS. Specify either WKID or WKT of the CRS. */\n  wkid: number;\n  /** WKT, or Well-Known Text, of the CRS. Specify either WKT or WKID of the CRS but not both. */\n  wkt?: string;\n};\n\n/** Spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.8/fullExtent.cmn.md */\ntype FullExtent = {\n  /** left */\n  xmin: number;\n  /** right */\n  xmax: number;\n  /** bottom */\n  ymin: number;\n  /** top */\n  ymax: number;\n  /** lowest elevation */\n  zmin: number;\n  /** highest elevation */\n  zmax: number;\n  spatialReference?: SpatialReference;\n};\n\ntype TextureDefinitionInfo = {\n  encoding: string[];\n  wrap?: string[];\n  atlas?: boolean;\n  uvSet?: string;\n  channels?: 'rbg' | 'rgba' | string;\n  images: TextureImage[];\n};\n\n/** Spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.8/domain.cmn.md */\ntype Domain = {\n  type: string;\n  name: string;\n  description?: string;\n  fieldType?: string;\n  range?: [number, number];\n  codedValues?: {name: string; code: string | number}[];\n  mergePolicy?: string;\n  splitPolicy?: string;\n};\n/**\n * spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.8/store.cmn.md\n */\ntype Store = {\n  id: string | number;\n  profile: string;\n  version: number | string;\n  resourcePattern: string[];\n  rootNode: string;\n  extent: number[];\n  indexCRS: string;\n  vertexCRS: string;\n  normalReferenceFrame: string;\n  attributeEncoding: string;\n  textureEncoding: string[];\n  lodType: string;\n  lodModel: string;\n  defaultGeometrySchema: DefaultGeometrySchema;\n};\n/**\n * Spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.8/defaultGeometrySchema.cmn.md\n */\ntype DefaultGeometrySchema = {\n  geometryType?: 'triangles';\n  topology: 'PerAttributeArray' | 'Indexed';\n  header: HeaderAttribute[];\n  ordering: string[];\n  vertexAttributes: VertexAttribute;\n  faces?: VertexAttribute;\n  featureAttributeOrder: string[];\n  featureAttributes: FeatureAttribute;\n  // TODO Do we realy need this Property?\n  attributesOrder?: string[];\n};\n/**\n * spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.8/headerAttribute.cmn.md\n */\nexport type HeaderAttribute = {\n  property: HeaderAttributeProperty.vertexCount | HeaderAttributeProperty.featureCount | string;\n  type:\n    | DATA_TYPE.UInt8\n    | DATA_TYPE.UInt16\n    | DATA_TYPE.UInt32\n    | DATA_TYPE.UInt64\n    | DATA_TYPE.Int16\n    | DATA_TYPE.Int32\n    | DATA_TYPE.Int64\n    | DATA_TYPE.Float32\n    | DATA_TYPE.Float64;\n};\nexport enum HeaderAttributeProperty {\n  vertexCount = 'vertexCount',\n  featureCount = 'featureCount'\n}\nexport type VertexAttribute = {\n  position: GeometryAttribute;\n  normal: GeometryAttribute;\n  uv0: GeometryAttribute;\n  color: GeometryAttribute;\n  region?: GeometryAttribute;\n};\nexport type GeometryAttribute = {\n  byteOffset?: number;\n  valueType:\n    | DATA_TYPE.UInt8\n    | DATA_TYPE.UInt16\n    | DATA_TYPE.Int16\n    | DATA_TYPE.Int32\n    | DATA_TYPE.Int64\n    | DATA_TYPE.Float32\n    | DATA_TYPE.Float64;\n  valuesPerElement: number;\n};\nexport type I3SMeshAttributes = {\n  [key: string]: I3SMeshAttribute;\n};\nexport interface I3SMeshAttribute extends MeshAttribute {\n  type?: number;\n  metadata?: any;\n}\n/** https://github.com/Esri/i3s-spec/blob/master/docs/1.8/heightModelInfo.cmn.md */\ntype HeightModelInfo = {\n  heightModel: 'gravity_related_height' | 'ellipsoidal';\n  vertCRS: string;\n  heightUnit:\n    | 'meter'\n    | 'us-foot'\n    | 'foot'\n    | 'clarke-foot'\n    | 'clarke-yard'\n    | 'clarke-link'\n    | 'sears-yard'\n    | 'sears-foot'\n    | 'sears-chain'\n    | 'benoit-1895-b-chain'\n    | 'indian-yard'\n    | 'indian-1937-yard'\n    | 'gold-coast-foot'\n    | 'sears-1922-truncated-chain'\n    | 'us-inch'\n    | 'us-mile'\n    | 'us-yard'\n    | 'millimeter'\n    | 'decimeter'\n    | 'centimeter'\n    | 'kilometer';\n};\n\nexport type TextureSetDefinitionFormats = {name: string; format: I3STextureFormat}[];\n\n/** Spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.8/textureSetDefinition.cmn.md */\ntype TextureSetDefinition = {\n  formats: TextureSetDefinitionFormats;\n  atlas?: boolean;\n};\n\n/** Spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.8/geometryDefinition.cmn.md */\ntype GeometryDefinition = {\n  topology: 'triangle' | string;\n  geometryBuffers: GeometryBuffer[];\n};\n/** Spec - https://github.com/Esri/i3s-spec/blob/master/docs/1.8/geometryBuffer.cmn.md */\ntype GeometryBuffer = {\n  offset?: number;\n  position?: GeometryBufferItem;\n  normal?: GeometryBufferItem;\n  uv0?: GeometryBufferItem;\n  color?: GeometryBufferItem;\n  uvRegion?: GeometryBufferItem;\n  featureId?: GeometryBufferItem;\n  faceRange?: GeometryBufferItem;\n  compressedAttributes?: {encoding: string; attributes: string[]};\n};\n\ntype GeometryBufferItem = {type: string; component: number; encoding?: string; binding: string};\n\ntype AttributeValue = {valueType: string; encoding?: string; valuesPerElement?: number};\n\nexport type FieldInfo = {\n  fieldName: string;\n  visible: boolean;\n  isEditable: boolean;\n  label: string;\n};\n"],"file":"types.js"}

package/dist/workers/i3s-content-worker.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=i3s-content-worker.d.ts.map

package/dist/workers/i3s-content-worker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"i3s-content-worker.d.ts","sourceRoot":"","sources":["../../src/workers/i3s-content-worker.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loaders.gl/i3s",
-  "version": "4.0.0-alpha.4",
+  "version": "4.0.0-alpha.5",
   "description": "i3s .",
   "license": "MIT",
   "publishConfig": {
@@ -17,7 +17,7 @@
     "tile",
     "mesh"
   ],
-  "types": "src/index.ts",
+  "types": "dist/index.d.ts",
   "main": "dist/index.js",
   "module": "dist/index.js",
   "sideEffects": false,
@@ -28,16 +28,16 @@
   ],
   "scripts": {
     "pre-build": "npm run build-bundle && npm run build-worker",
-    "build-bundle": "esbuild src/bundle.ts --bundle --outfile=dist/bundle.js",
-    "build-worker": "esbuild src/workers/i3s-content-worker.ts --bundle --outfile=dist/i3s-content-worker.js"
+    "build-bundle": "esbuild src/bundle.ts --bundle --outfile=dist/dist.min.js",
+    "build-worker": "esbuild src/workers/i3s-content-worker.ts --bundle --outfile=dist/i3s-content-worker.js --define:__VERSION__=\\\"$npm_package_version\\\""
   },
   "dependencies": {
-    "@loaders.gl/draco": "4.0.0-alpha.4",
-    "@loaders.gl/images": "4.0.0-alpha.4",
-    "@loaders.gl/loader-utils": "4.0.0-alpha.4",
-    "@loaders.gl/schema": "4.0.0-alpha.4",
-    "@loaders.gl/textures": "4.0.0-alpha.4",
-    "@loaders.gl/tiles": "4.0.0-alpha.4",
+    "@loaders.gl/draco": "4.0.0-alpha.5",
+    "@loaders.gl/images": "4.0.0-alpha.5",
+    "@loaders.gl/loader-utils": "4.0.0-alpha.5",
+    "@loaders.gl/schema": "4.0.0-alpha.5",
+    "@loaders.gl/textures": "4.0.0-alpha.5",
+    "@loaders.gl/tiles": "4.0.0-alpha.5",
     "@luma.gl/constants": "^8.5.4",
     "@math.gl/core": "^3.5.1",
     "@math.gl/culling": "^3.5.1",
@@ -45,7 +45,7 @@
     "probe.gl": "^3.4.0"
   },
   "peerDependencies": {
-    "@loaders.gl/core": "^3.0.0"
+    "@loaders.gl/core": "4.0.0-alpha.4"
   },
-  "gitHead": "53026061b3c8871f7e96d3a5826125cc6613bddc"
+  "gitHead": "7a71a54bdf1ddf985cc3af3db90b82e7fa97d025"
 }

package/src/index.ts

@@ -15,13 +15,13 @@ export type {
   LodSelection,
   NodeReference,
   Resource,
-  I3SGeometry,
   MaxScreenThresholdSQ,
   NodeInPage,
   SharedResources,
-  TextureImage,
   Attribute,
   Extent,
-  FeatureAttribute
+  FeatureAttribute,
+  FieldInfo,
+  I3SMaterialDefinition
 } from './types';
 export {COORDINATE_SYSTEM} from './lib/parsers/constants';

package/src/lib/helpers/i3s-nodepages-tiles.ts

@@ -1,21 +1,33 @@
 import {load} from '@loaders.gl/core';
 import {getSupportedGPUTextureFormats, selectSupportedBasisFormat} from '@loaders.gl/textures';
-import {Tileset, NodePage} from '../../types';
 import {I3SNodePageLoader} from '../../i3s-node-page-loader';
 import {normalizeTileNonUrlData} from '../parsers/parse-i3s';
 import {getUrlWithToken, generateTilesetAttributeUrls} from '../utils/url-utils';
+import type {LoaderOptions} from '@loaders.gl/loader-utils';
+import {
+  I3STilesetHeader,
+  LodSelection,
+  NodePage,
+  NodeInPage,
+  Obb,
+  MeshMaterial,
+  I3SMaterialDefinition,
+  I3STextureFormat,
+  MeshGeometry,
+  I3STileHeader
+} from '../../types';
 
 /**
  * class I3SNodePagesTiles - loads nodePages and form i3s tiles from them
  */
 export default class I3SNodePagesTiles {
-  tileset: Tileset;
+  tileset: I3STilesetHeader;
   nodePages: NodePage[] = [];
   pendingNodePages: {promise: Promise<NodePage>; status: 'Pending' | 'Done'}[] = [];
   nodesPerPage: number;
-  options: {[key: string]: any};
-  lodSelectionMetricType: any;
-  textureDefinitionsSelectedFormats: any[] = [];
+  options: LoaderOptions;
+  lodSelectionMetricType?: string;
+  textureDefinitionsSelectedFormats: ({format: I3STextureFormat; name: string} | null)[] = [];
   private textureLoaderOptions: {[key: string]: any} = {};
 
   /**
@@ -24,10 +36,10 @@ export default class I3SNodePagesTiles {
    * @param tileset - i3s tileset header ('layers/0')
    * @param options - i3s loader options
    */
-  constructor(tileset: Tileset, options: object) {
+  constructor(tileset: I3STilesetHeader, options: LoaderOptions) {
     this.tileset = {...tileset}; // spread the tileset to avoid circular reference
-    this.nodesPerPage = tileset.nodePages.nodesPerPage;
-    this.lodSelectionMetricType = tileset.nodePages.lodSelectionMetricType;
+    this.nodesPerPage = tileset.nodePages?.nodesPerPage || 64;
+    this.lodSelectionMetricType = tileset.nodePages?.lodSelectionMetricType;
     this.options = options;
 
     this.initSelectedFormatsForTextureDefinitions(tileset);
@@ -37,7 +49,7 @@ export default class I3SNodePagesTiles {
    * Loads some nodePage and return a particular node from it
    * @param id - id of node through all node pages
    */
-  async getNodeById(id: number) {
+  async getNodeById(id: number): Promise<NodeInPage> {
     const pageIndex = Math.floor(id / this.nodesPerPage);
     if (!this.nodePages[pageIndex] && !this.pendingNodePages[pageIndex]) {
       const nodePageUrl = getUrlWithToken(
@@ -63,34 +75,33 @@ export default class I3SNodePagesTiles {
    * @param id - id of node through all node pages
    */
   // eslint-disable-next-line complexity
-  async formTileFromNodePages(id: number) {
-    const node = await this.getNodeById(id);
-    const children: any[] = [];
+  async formTileFromNodePages(id: number): Promise<I3STileHeader> {
+    const node: NodeInPage = await this.getNodeById(id);
+    const children: {id: string; obb: Obb}[] = [];
     for (const child of node.children || []) {
       const childNode = await this.getNodeById(child);
       children.push({
-        id: child,
+        id: child.toString(),
         obb: childNode.obb
       });
     }
 
-    let contentUrl = null;
-    let textureUrl: string | null = null;
-    let materialDefinition = null;
-    let textureFormat = 'jpeg';
+    let contentUrl: string | undefined;
+    let textureUrl: string | undefined;
+    let materialDefinition: I3SMaterialDefinition | undefined;
+    let textureFormat: I3STextureFormat = 'jpg';
     let attributeUrls: string[] = [];
-    let isDracoGeometry = false;
+    let isDracoGeometry: boolean = false;
 
     if (node && node.mesh) {
       // Get geometry resource URL and type (compressed / non-compressed)
       const {url, isDracoGeometry: isDracoGeometryResult} = (node.mesh.geometry &&
-        this.getContentUrl(node.mesh.geometry)) || {url: null, isDracoGeometry: null};
+        this.getContentUrl(node.mesh.geometry)) || {isDracoGeometry: false};
       contentUrl = url;
       isDracoGeometry = isDracoGeometryResult;
 
-      const [textureData, nodeMaterialDefinition] = this.getInformationFromMaterial(
-        node.mesh.material
-      );
+      const {textureData, materialDefinition: nodeMaterialDefinition} =
+        this.getInformationFromMaterial(node.mesh.material);
       materialDefinition = nodeMaterialDefinition;
       textureFormat = textureData.format || textureFormat;
       if (textureData.name) {
@@ -105,7 +116,7 @@ export default class I3SNodePagesTiles {
     const lodSelection = this.getLodSelection(node);
 
     return normalizeTileNonUrlData({
-      id,
+      id: id.toString(),
       lodSelection,
       obb: node.obb,
       contentUrl,
@@ -121,13 +132,14 @@ export default class I3SNodePagesTiles {
 
   /**
    * Forms url and type of geometry resource by nodepage's data and `geometryDefinitions` in the tileset
-   * @param {Object} meshGeometryData - data about the node's mesh from the nodepage
-   * @returns {Object} -
+   * @param - data about the node's mesh from the nodepage
+   * @returns -
    *   {string} url - url to the geometry resource
    *   {boolean} isDracoGeometry - whether the geometry resource contain DRACO compressed geometry
    */
-  private getContentUrl(meshGeometryData) {
-    let result = {};
+  private getContentUrl(meshGeometryData: MeshGeometry) {
+    let result: {url: string; isDracoGeometry: boolean} | null = null;
+    // @ts-ignore
     const geometryDefinition = this.tileset.geometryDefinitions[meshGeometryData.definition];
     let geometryIndex = -1;
     // Try to find DRACO geometryDefinition of `useDracoGeometry` option is set
@@ -156,21 +168,21 @@ export default class I3SNodePagesTiles {
 
   /**
    * Forms 1.6 compatible LOD selection object from a nodepage's node data
-   * @param {Object} node - a node from nodepage
-   * @returns {Object[]} - Array of object of following properties:
-   *   {string} metricType - the label of the LOD metric
-   *   {number} maxError - the value of the metric
+   * @param node - a node from nodepage
+   * @returns- Array of LodSelection
    */
-  private getLodSelection(node): object[] {
-    const lodSelection: object[] = [];
+  private getLodSelection(node: NodeInPage): LodSelection[] {
+    const lodSelection: LodSelection[] = [];
     if (this.lodSelectionMetricType === 'maxScreenThresholdSQ') {
       lodSelection.push({
         metricType: 'maxScreenThreshold',
+        // @ts-ignore
         maxError: Math.sqrt(node.lodThreshold / (Math.PI * 0.25))
       });
     }
     lodSelection.push({
       metricType: this.lodSelectionMetricType,
+      // @ts-ignore
       maxError: node.lodThreshold
     });
     return lodSelection;
@@ -178,43 +190,47 @@ export default class I3SNodePagesTiles {
 
   /**
    * Returns information about texture and material from `materialDefinitions`
-   * @param {Object} material - material data from nodepage
-   * @returns {Object[]} - Couple [textureData, materialDefinition]
+   * @param material - material data from nodepage
+   * @returns - Couple {textureData, materialDefinition}
    * {string} textureData.name - path name of the texture
    * {string} textureData.format - format of the texture
    * materialDefinition - PBR-like material definition from `materialDefinitions`
    */
-  private getInformationFromMaterial(material) {
-    const textureDataDefault = {name: null, format: null};
+  private getInformationFromMaterial(material: MeshMaterial) {
+    const informationFromMaterial: {
+      textureData: {name: string | null; format?: I3STextureFormat};
+      materialDefinition?: I3SMaterialDefinition;
+    } = {textureData: {name: null}};
+
     if (material) {
-      const materialDefinition = this.tileset.materialDefinitions[material.definition];
-      const textureSetDefinitionIndex =
-        materialDefinition &&
-        materialDefinition.pbrMetallicRoughness &&
-        materialDefinition.pbrMetallicRoughness.baseColorTexture &&
-        materialDefinition.pbrMetallicRoughness.baseColorTexture.textureSetDefinitionId;
-      if (textureSetDefinitionIndex || textureSetDefinitionIndex === 0) {
-        const textureData =
-          this.textureDefinitionsSelectedFormats[textureSetDefinitionIndex] || textureDataDefault;
-        return [textureData, materialDefinition];
+      const materialDefinition = this.tileset.materialDefinitions?.[material.definition];
+      if (materialDefinition) {
+        informationFromMaterial.materialDefinition = materialDefinition;
+        const textureSetDefinitionIndex =
+          materialDefinition?.pbrMetallicRoughness?.baseColorTexture?.textureSetDefinitionId;
+
+        if (typeof textureSetDefinitionIndex === 'number') {
+          informationFromMaterial.textureData =
+            this.textureDefinitionsSelectedFormats[textureSetDefinitionIndex] ||
+            informationFromMaterial.textureData;
+        }
       }
-      return [textureDataDefault, materialDefinition];
     }
-    return [textureDataDefault, null];
+    return informationFromMaterial;
   }
 
   /**
    * Sets preferable and supported format for each textureDefinition of the tileset
-   * @param {Object} tileset - I3S layer data
-   * @returns {void}
+   * @param tileset - I3S layer data
+   * @returns
    */
-  private initSelectedFormatsForTextureDefinitions(tileset) {
+  private initSelectedFormatsForTextureDefinitions(tileset: I3STilesetHeader): void {
     this.textureDefinitionsSelectedFormats = [];
     const possibleI3sFormats = this.getSupportedTextureFormats();
     const textureSetDefinitions = tileset.textureSetDefinitions || [];
     for (const textureSetDefinition of textureSetDefinitions) {
       const formats = (textureSetDefinition && textureSetDefinition.formats) || [];
-      let selectedFormat: {format: string; name: string} | null = null;
+      let selectedFormat: {name: string; format: I3STextureFormat} | null = null;
       for (const i3sFormat of possibleI3sFormats) {
         const format = formats.find((value) => value.format === i3sFormat);
         if (format) {
@@ -239,8 +255,8 @@ export default class I3SNodePagesTiles {
    * Returns the array of supported texture format
    * @returns list of format strings
    */
-  private getSupportedTextureFormats(): string[] {
-    const formats: string[] = [];
+  private getSupportedTextureFormats(): I3STextureFormat[] {
+    const formats: I3STextureFormat[] = [];
     if (!this.options.i3s || this.options.i3s.useCompressedTextures) {
       // I3S 1.7 selection
       const supportedCompressedFormats = getSupportedGPUTextureFormats();

package/src/lib/parsers/constants.ts

@@ -1,48 +1,54 @@
 import GL from '@luma.gl/constants';
+import {DATA_TYPE} from '../../types';
 
-export const TYPE_ARRAY_MAP = {
-  UInt8: Uint8Array,
-  UInt16: Uint16Array,
-  UInt32: Uint32Array,
-  Float32: Float32Array,
-  UInt64: Float64Array
-};
+export function getConstructorForDataFormat(dataType: string) {
+  switch (dataType) {
+    case DATA_TYPE.UInt8:
+      return Uint8Array;
+    case DATA_TYPE.UInt16:
+      return Uint16Array;
+    case DATA_TYPE.UInt32:
+      return Uint32Array;
+    case DATA_TYPE.Float32:
+      return Float32Array;
+    case DATA_TYPE.UInt64:
+      return Float64Array;
+    default:
+      throw new Error(`parse i3s tile content: unknown type of data: ${dataType}`);
+  }
+}
 
-export const GL_TYPE_MAP = {
+export const GL_TYPE_MAP: {[key: string]: number} = {
   UInt8: GL.UNSIGNED_BYTE,
   UInt16: GL.UNSIGNED_INT,
   Float32: GL.FLOAT,
   UInt32: GL.UNSIGNED_INT,
   UInt64: GL.DOUBLE
 };
-
-export const I3S_NAMED_VERTEX_ATTRIBUTES = {
-  position: 'position',
-  normal: 'normal',
-  uv0: 'uv0',
-  color: 'color',
-  region: 'region'
-};
-
-export const I3S_NAMED_GEOMETRY_ATTRIBUTES = {
-  vertexAttributes: 'vertexAttributes',
-  featureAttributeOrder: 'featureAttributeOrder',
-  featureAttributes: 'featureAttributes'
-};
-
-export const I3S_NAMED_HEADER_ATTRIBUTES = {
-  header: 'header',
-  vertexCount: 'vertexCount',
-  featureCount: 'featureCount'
-};
-
-export const SIZEOF = {
-  UInt8: 1,
-  UInt16: 2,
-  UInt32: 4,
-  Float32: 4,
-  UInt64: 8
-};
+/**
+ * Returns how many bytes a type occupies
+ * @param dataType
+ * @returns
+ */
+export function sizeOf(dataType: string): number {
+  switch (dataType) {
+    case DATA_TYPE.UInt8:
+      return 1;
+    case DATA_TYPE.UInt16:
+    case DATA_TYPE.Int16:
+      return 2;
+    case DATA_TYPE.UInt32:
+    case DATA_TYPE.Int32:
+    case DATA_TYPE.Float32:
+      return 4;
+    case DATA_TYPE.UInt64:
+    case DATA_TYPE.Int64:
+    case DATA_TYPE.Float64:
+      return 8;
+    default:
+      throw new Error(`parse i3s tile content: unknown size of data: ${dataType}`);
+  }
+}
 
 export const STRING_ATTRIBUTE_TYPE = 'String';
 export const OBJECT_ID_ATTRIBUTE_TYPE = 'Oid32';
@@ -51,21 +57,28 @@ export const INT_16_ATTRIBUTE_TYPE = 'Int16';
 
 // https://github.com/visgl/deck.gl/blob/9548f43cba2234a1f4877b6b17f6c88eb35b2e08/modules/core/src/lib/constants.js#L27
 // Describes the format of positions
-export const COORDINATE_SYSTEM = {
-  // `LNGLAT` if rendering into a geospatial viewport, `CARTESIAN` otherwise
-  DEFAULT: -1,
-  // Positions are interpreted as [lng, lat, elevation]
-  // lng lat are degrees, elevation is meters. distances as meters.
-  LNGLAT: 1,
-
-  // Positions are interpreted as meter offsets, distances as meters
-  METER_OFFSETS: 2,
-
-  // Positions are interpreted as lng lat offsets: [deltaLng, deltaLat, elevation]
-  // deltaLng, deltaLat are delta degrees, elevation is meters.
-  // distances as meters.
-  LNGLAT_OFFSETS: 3,
-
-  // Non-geospatial
-  CARTESIAN: 0
-};
+export enum COORDINATE_SYSTEM {
+  /**
+   * `LNGLAT` if rendering into a geospatial viewport, `CARTESIAN` otherwise
+   */
+  DEFAULT = -1,
+  /**
+   * Positions are interpreted as [lng, lat, elevation]
+   * lng lat are degrees, elevation is meters. distances as meters.
+   */
+  LNGLAT = 1,
+  /**
+   * Positions are interpreted as meter offsets, distances as meters
+   */
+  METER_OFFSETS = 2,
+  /**
+   * Positions are interpreted as lng lat offsets: [deltaLng, deltaLat, elevation]
+   * deltaLng, deltaLat are delta degrees, elevation is meters.
+   * distances as meters.
+   */
+  LNGLAT_OFFSETS = 3,
+  /**
+   * Non-geospatial
+   */
+  CARTESIAN = 0
+}

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

@@ -34,7 +34,7 @@ function parseSublayersTree(
 
   for (let index = 0; index < sublayers.length; index++) {
     const subLayer = sublayers[index];
-    const {id, layerType, ...rest} = subLayer;
+    const {id, layerType, visibility = true, ...rest} = subLayer;
 
     // Add support only for 3DObject layer type for I3S purposes.
     if (layerType === OBJECT_3D_LAYER_TYPE) {
@@ -44,6 +44,7 @@ function parseSublayersTree(
         url: sublayerUrl,
         id,
         layerType,
+        visibility,
         ...rest
       });
     }