@smplrspace/smplr-loader 2.14.1 → 2.14.2-beta.1

package/dist/generated/smplr.d.ts

@@ -25,7 +25,20 @@ declare interface ClientOptions {
     clientToken: string;
 }
 
-declare type DataLayer<D extends UnknownData = NoData> = PointDataLayer<D> | IconDataLayer<D> | PolygonDataLayer<D> | PolylineDataLayer<D> | DottedPolylineDataLayer<D> | FurnitureDataLayer<D>;
+declare interface CubeOptions<D> {
+    shape: 'cube';
+    size?: number;
+    width?: number;
+    height?: number;
+    depth?: number;
+    scale?: (dataElement: PointData & D) => number | {
+        x: number;
+        y: number;
+        z: number;
+    };
+}
+
+declare type DataLayer<D extends UnknownData = NoData> = PointDataLayer<D> | IconDataLayer<D> | PolygonDataLayer<D> | PolylineDataLayer<D> | DottedPolylineDataLayer<D> | FurnitureDataLayer<D> | HeatmapDataLayer<D>;
 
 declare class DataLayerController<D extends UnknownData> {
     private dataLayer;
@@ -206,6 +219,42 @@ declare interface FurnitureDataLayer<D extends UnknownData = NoData> extends Bas
     color?: string | ((dataElement: FurnitureData & D) => string);
 }
 
+declare interface HeatmapBarChartOptions {
+    style: 'bar-chart';
+    height: (interpolatedValue: number) => number;
+}
+
+declare type HeatmapData = BaseData & {
+    position: SmplrCoord2d;
+};
+
+declare type HeatmapDataLayer<D extends UnknownData = NoData> = NonInteractiveDataLayer<HeatmapData, D> & {
+    id: string;
+    type: 'heatmap';
+    data: (HeatmapData & D)[];
+    value: (dataElement: HeatmapData & D) => number;
+    gridSize?: number;
+    gridFill?: number;
+    alpha?: number;
+    mask?: SmplrCoord2d[] | Record<number, SmplrCoord2d[]>;
+    color: (interpolatedValue: number) => string;
+    confidenceRadius?: number;
+} & HeatmapStyleOptions;
+
+declare interface HeatmapGridOptions {
+    style: 'grid';
+    elevation?: number;
+    thickness?: number;
+}
+
+declare interface HeatmapSpheresOptions {
+    style: 'spheres';
+    elevation?: number;
+    squishFactor?: number;
+}
+
+declare type HeatmapStyleOptions = HeatmapSpheresOptions | HeatmapGridOptions | HeatmapBarChartOptions;
+
 declare type IconData = BaseData & {
     position: SmplrCoord3d;
 };
@@ -237,6 +286,9 @@ declare interface Listener {
 
 declare type NoData = Record<string, never>;
 
+declare interface NonInteractiveDataLayer<T, D extends UnknownData> {
+}
+
 declare type OnPickFn = (args: { coordinates: SmplrCoord3d; furnitureId?: string }) => void
 
 declare interface OrbitCamera extends ArcRotateCamera {
@@ -272,11 +324,10 @@ declare type PointData = BaseData & {
     position: SmplrCoord3d;
 };
 
-declare interface PointDataLayer<D extends UnknownData = NoData> extends BaseDataLayer<PointData, D> {
+declare type PointDataLayer<D extends UnknownData = NoData> = BaseDataLayer<PointData, D> & {
     id: string;
     type: 'point';
     data: (PointData & D)[];
-    diameter?: number | ((dataElement: PointData & D) => number);
     anchor?: 'bottom' | 'center' | 'top';
     color?: string | ((dataElement: PointData & D) => string);
     alpha?: number;
@@ -287,7 +338,9 @@ declare interface PointDataLayer<D extends UnknownData = NoData> extends BaseDat
         data: PointData & D;
         position: SmplrCoord3d;
     }) => void;
-}
+} & PointShapeOptions<D>;
+
+declare type PointShapeOptions<D> = SphereOptions<D> | CubeOptions<D>;
 
 declare type PolygonData = BaseData & {
     coordinates: SmplrCoord2d[];
@@ -392,7 +445,7 @@ export declare class QueryClient {
         spaceId: string;
         levelIndex: number;
         padding?: number;
-    }): Promise<SmplrCoord2d[] | null>;
+    }): Promise<SmplrCoord2d[]>;
     isPointInPolygon({ point, polygon }: {
         point: SmplrCoord2d;
         polygon: SmplrCoord2d[];
@@ -524,6 +577,15 @@ declare interface SpaceOptions {
     internal?: boolean;
 }
 
+declare interface SphereOptions<D> {
+    shape: 'sphere';
+    diameter?: number | ((dataElement: PointData & D) => number | {
+        x: number;
+        y: number;
+        z: number;
+    });
+}
+
 declare const toString_2: () => string;
 export { toString_2 as toString }
 
@@ -548,7 +610,7 @@ declare interface Vector3Coord extends Vector2Coord {
     z: number;
 }
 
-export declare const version = "2.14.1";
+export declare const version = "2.14.2-beta.1";
 
 declare interface ViewerOptions {
     mode?: CameraMode;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smplrspace/smplr-loader",
-  "version": "2.14.1",
+  "version": "2.14.2-beta.1",
   "description": "NPM package to load a typed Smplr.js from CDN easily",
   "type": "module",
   "files": [