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

package/dist/generated/smplr.d.ts

@@ -1,5 +1,7 @@
 import { ArcRotateCamera } from '@babylonjs/core/Cameras/arcRotateCamera';
+import { CSSProperties } from 'react';
 import { Dispatch } from 'react';
+import { FC } from 'react';
 import { Reducer } from 'react';
 import { ReducerAction } from 'react';
 import { RefObject } from 'react';
@@ -20,11 +22,34 @@ declare interface BaseDataLayer<T, D extends UnknownData> {
 
 declare type CameraMode = '2d' | '3d'
 
+declare const categoryScale: <C extends string>({ categories, nodata, }: CategoryScaleOptions<C>) => (category: C) => string;
+
+declare interface CategoryScaleOptions<C extends string> {
+    categories: Record<C, string>;
+    nodata?: string;
+}
+
 declare interface ClientOptions {
     organizationId: string;
     clientToken: string;
 }
 
+declare namespace Color {
+    export {
+        drawLegend,
+        Legend,
+        NumericScale,
+        numericScale,
+        categoryScale,
+        ragScale,
+        cssToSmplrColor,
+        smplrToCssColor
+    }
+}
+export { Color }
+
+declare const cssToSmplrColor: (c: string) => string;
+
 declare interface CubeOptions<D> {
     shape: 'cube';
     size?: number;
@@ -99,6 +124,10 @@ declare interface DottedPolylineDataLayer<D extends UnknownData = NoData> extend
     waves?: number;
 }
 
+declare const drawLegend: ({ containerId, ...legendProps }: LegendProps & {
+    containerId: string;
+}) => void;
+
 declare type EventEmitter = ReturnType<typeof useEventEmitter>;
 
 declare type EventHandler = () => void;
@@ -278,6 +307,17 @@ declare interface IconDataLayer<D extends UnknownData = NoData> extends BaseData
     }) => void;
 }
 
+declare const Legend: FC<LegendProps>;
+
+declare interface LegendProps {
+    colorScale: (n: number | null | undefined) => string;
+    domain?: [number, number];
+    ticks?: Record<number, number | string>;
+    barStyle?: CSSProperties;
+    labelStyle?: CSSProperties;
+    correctColor?: boolean;
+}
+
 declare interface Listener {
     event: EventType;
     handler: EventHandler;
@@ -289,6 +329,51 @@ declare type NoData = Record<string, never>;
 declare interface NonInteractiveDataLayer<T, D extends UnknownData> {
 }
 
+declare enum NumericScale {
+    OrRd = "OrRd",
+    PuBu = "PuBu",
+    BuPu = "BuPu",
+    Oranges = "Oranges",
+    BuGn = "BuGn",
+    YlOrBr = "YlOrBr",
+    YlGn = "YlGn",
+    Reds = "Reds",
+    RdPu = "RdPu",
+    Greens = "Greens",
+    YlGnBu = "YlGnBu",
+    Purples = "Purples",
+    GnBu = "GnBu",
+    Greys = "Greys",
+    YlOrRd = "YlOrRd",
+    PuRd = "PuRd",
+    Blues = "Blues",
+    PuBuGn = "PuBuGn",
+    Viridis = "Viridis",
+    Spectral = "Spectral",
+    RdYlGn = "RdYlGn",
+    RdBu = "RdBu",
+    PiYG = "PiYG",
+    PRGn = "PRGn",
+    RdYlBu = "RdYlBu",
+    BrBG = "BrBG",
+    RdGy = "RdGy",
+    PuOr = "PuOr"
+}
+
+declare const numericScale: ({ name, domain, invert, padding, gamma, brighten, saturate, nodata, classes, }: NumericScaleOptions) => (n: number | null | undefined) => string;
+
+declare interface NumericScaleOptions {
+    name: NumericScale | string;
+    domain?: [number, number];
+    invert?: boolean;
+    padding?: number | [number, number];
+    gamma?: number;
+    brighten?: number;
+    saturate?: number;
+    nodata?: string;
+    classes?: number | number[];
+}
+
 declare type OnPickFn = (args: { coordinates: SmplrCoord3d; furnitureId?: string }) => void
 
 declare interface OrbitCamera extends ArcRotateCamera {
@@ -471,6 +556,18 @@ export declare class QueryClient {
     }): SmplrCoord2d[];
 }
 
+declare const ragScale: <C extends string>({ categories, colors, nodata, }: RAGScaleOptions<C>) => (category: C) => string;
+
+declare interface RAGScaleOptions<C extends string> {
+    categories?: Partial<Record<'red' | 'amber' | 'green', C>>;
+    colors?: {
+        red?: string;
+        amber?: string;
+        green?: string;
+    };
+    nodata?: string;
+}
+
 declare interface RenderOptions {
     compass?: boolean
     annotations?: boolean
@@ -529,6 +626,8 @@ declare interface SmplrScene extends Scene {
     cameras: SmplrCamera[];
 }
 
+declare const smplrToCssColor: (c: string) => string;
+
 export declare class Space {
     private options;
     private viewerStarted;
@@ -610,7 +709,7 @@ declare interface Vector3Coord extends Vector2Coord {
     z: number;
 }
 
-export declare const version = "2.14.2-beta.1";
+export declare const version = "2.14.2-beta.4";
 
 declare interface ViewerOptions {
     mode?: CameraMode;

package/dist/types.d.ts

@@ -5,8 +5,10 @@ export {}
 
 export interface Smplr {
   version: typeof smplr.version
+  toString: typeof smplr.toString
   Space: typeof smplr.Space
   QueryClient: typeof smplr.QueryClient
+  Color: typeof smplr.Color
 }
 
 declare global {

package/package.json

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