@smplrspace/smplr-loader 2.25.3-beta.9 → 2.26.0

package/dist/generated/smplr.d.ts

@@ -30,7 +30,7 @@ declare interface BaseDataLayer<T, D extends UnknownData> {
     legend?: LegendConfig;
 }
 
-declare type CameraMode = '2d' | '3d'
+export declare type CameraMode = '2d' | '3d'
 
 declare const categoryScale: <C extends string>({ categories, nodata, }: CategoryScaleOptions<C>) => (category: C) => string;
 
@@ -47,22 +47,23 @@ declare const categorySwatches: <C extends string>({ categories, nodata, exclude
     label: string;
 }[];
 
-declare interface ClientOptions {
-    organizationId: string;
-    clientToken: string;
-}
-
 declare namespace Color {
     export {
         drawColorSwatches,
         drawIconsSwatches,
         drawLegend,
+        ColorSwatchesProps,
+        IconsSwatchesProps,
+        LegendProps,
         cssToSmplrColor,
         smplrToCssColor,
         NumericScale,
+        NumericScaleOptions,
         numericScale,
+        CategoryScaleOptions,
         categoryScale,
         categorySwatches,
+        RAGScaleOptions,
         ragScale,
         ragSwatches
     }
@@ -99,9 +100,9 @@ declare interface CubeOptions<D> {
     };
 }
 
-declare type DataLayer<D extends UnknownData = NoData> = PointDataLayer<D> | IconDataLayer<D> | PolygonDataLayer<D> | PolylineDataLayer<D> | DottedPolylineDataLayer<D> | FurnitureDataLayer<D> | HeatmapDataLayer<D>;
+export 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> {
+export declare class DataLayerController<D extends UnknownData> {
     private dataLayer;
     private scene;
     private dispatchDataLayersDefinition;
@@ -145,7 +146,7 @@ declare interface Dimensions {
 
 declare type DispatchDataLayersDefinitionFn = Dispatch<ReducerAction<DataLayersDefinitionReducer>>;
 
-declare interface DottedPolylineDataLayer<D extends UnknownData = NoData> extends BaseDataLayer<PolylineData, D> {
+export declare interface DottedPolylineDataLayer<D extends UnknownData = NoData> extends BaseDataLayer<PolylineData, D> {
     id: string;
     type: 'dotted-polyline';
     data: (PolylineData & D)[];
@@ -183,9 +184,9 @@ export declare class Editor {
     startSession(options?: SessionOptions): void;
 }
 
-declare interface EditorOptions {
+export declare interface EditorOptions {
     spaceId: string;
-    user: EmbeddedUser;
+    user: EmbeddedEditorUser;
     clientToken: string;
     containerId: string;
     disableErrorReporting?: boolean;
@@ -193,7 +194,7 @@ declare interface EditorOptions {
     internal?: boolean;
 }
 
-declare interface EmbeddedUser {
+export declare interface EmbeddedEditorUser {
     id: string;
     name?: string;
     picture?: string;
@@ -246,7 +247,7 @@ declare interface Filter {
     };
 }
 
-declare interface Furniture {
+export declare interface Furniture {
     catalogId: string;
     id: string;
     name: string;
@@ -261,18 +262,18 @@ declare interface Furniture {
     configuration?: object;
 }
 
-declare type FurnitureData = BaseData & {
+export declare type FurnitureData = BaseData & {
     furnitureId: string | string[];
 };
 
-declare interface FurnitureDataLayer<D extends UnknownData = NoData> extends BaseDataLayer<FurnitureData, D> {
+export declare interface FurnitureDataLayer<D extends UnknownData = NoData> extends BaseDataLayer<FurnitureData, D> {
     id: string;
     type: 'furniture';
     data: (FurnitureData & D)[];
     color?: string | ((dataElement: FurnitureData & D) => string);
 }
 
-declare interface GeojsonSpace {
+export declare interface GeojsonSpace {
     id: string;
     name: string;
     definition?: object | null;
@@ -284,11 +285,11 @@ declare interface HeatmapBarChartOptions {
     height: (interpolatedValue: number) => number;
 }
 
-declare type HeatmapData = BaseData & {
+export declare type HeatmapData = BaseData & {
     position: SmplrCoord2d;
 };
 
-declare type HeatmapDataLayer<D extends UnknownData = NoData> = NonInteractiveDataLayer<HeatmapData, D> & {
+export declare type HeatmapDataLayer<D extends UnknownData = NoData> = NonInteractiveDataLayer<HeatmapData, D> & {
     id: string;
     type: 'heatmap';
     data: (HeatmapData & D)[];
@@ -316,11 +317,11 @@ declare interface HeatmapSpheresOptions {
 
 declare type HeatmapStyleOptions = HeatmapSpheresOptions | HeatmapGridOptions | HeatmapBarChartOptions;
 
-declare type IconData = BaseData & {
+export declare type IconData = BaseData & {
     position: SmplrCoord3d;
 };
 
-declare interface IconDataLayer<D extends UnknownData = NoData> extends BaseDataLayer<IconData, D> {
+export declare interface IconDataLayer<D extends UnknownData = NoData> extends BaseDataLayer<IconData, D> {
     id: string;
     type: 'icon';
     data: (IconData & D)[];
@@ -402,14 +403,14 @@ declare class Map_2 {
 }
 export { Map_2 as Map }
 
-declare interface MapOptions {
+export declare interface MapOptions {
     clientToken: string;
     containerId: string;
     disableErrorReporting?: boolean;
     internal?: boolean;
 }
 
-declare interface MapViewerOptions {
+export declare interface MapViewerOptions {
     spaceIds?: string[];
     spaces?: GeojsonSpace[];
     osmBuildings?: boolean;
@@ -435,7 +436,7 @@ declare interface Material {
     layerOffset?: number;
 }
 
-declare type NoData = Record<string, never>;
+export declare type NoData = Record<string, never>;
 
 declare interface NonInteractiveDataLayer<T, D extends UnknownData> {
     legend?: LegendConfig;
@@ -491,9 +492,9 @@ declare interface NumericScaleOptions {
     zeroAsNoData?: boolean;
 }
 
-declare type OnPickFn = (args: { coordinates: SmplrCoord3d; furnitureId?: string }) => void | Promise<void>
+export declare type OnPickFn = (args: { coordinates: SmplrCoord3d; furnitureId?: string }) => void | Promise<void>
 
-declare interface Opening {
+export declare interface Opening {
     id: string;
     name: string;
     type: OpeningType;
@@ -526,7 +527,7 @@ declare interface OrbitCamera extends ArcRotateCamera {
     setMode: (mode: CameraMode) => void;
 }
 
-declare interface OrbitCameraPlacement {
+export declare interface OrbitCameraPlacement {
     alpha: number;
     beta: number;
     radius: number;
@@ -540,11 +541,11 @@ declare interface PartialOrbitCameraPlacement {
     target: Partial<Vector3Coord>;
 }
 
-declare type PointData = BaseData & {
+export declare type PointData = BaseData & {
     position: SmplrCoord3d;
 };
 
-declare type PointDataLayer<D extends UnknownData = NoData> = BaseDataLayer<PointData, D> & {
+export declare type PointDataLayer<D extends UnknownData = NoData> = BaseDataLayer<PointData, D> & {
     id: string;
     type: 'point';
     data: (PointData & D)[];
@@ -563,11 +564,11 @@ declare type PointDataLayer<D extends UnknownData = NoData> = BaseDataLayer<Poin
 
 declare type PointShapeOptions<D> = SphereOptions<D> | CubeOptions<D>;
 
-declare type PolygonData = BaseData & {
+export declare type PolygonData = BaseData & {
     coordinates: SmplrCoord2d[] | SmplrCoord2d[][];
 };
 
-declare interface PolygonDataLayer<D extends UnknownData = NoData> extends BaseDataLayer<PolygonData, D> {
+export declare interface PolygonDataLayer<D extends UnknownData = NoData> extends BaseDataLayer<PolygonData, D> {
     id: string;
     type: 'polygon';
     data: (PolygonData & D)[];
@@ -587,11 +588,11 @@ declare interface PolygonDataLayer<D extends UnknownData = NoData> extends BaseD
     disableElevationCorrection?: boolean;
 }
 
-declare type PolylineData = BaseData & {
+export declare type PolylineData = BaseData & {
     coordinates: SmplrCoord3d[];
 };
 
-declare interface PolylineDataLayer<D extends UnknownData = NoData> extends BaseDataLayer<PolylineData, D> {
+export declare interface PolylineDataLayer<D extends UnknownData = NoData> extends BaseDataLayer<PolylineData, D> {
     id: string;
     type: 'polyline';
     data: (PolylineData & D)[];
@@ -621,7 +622,7 @@ export declare class QueryClient {
     private options;
     private client;
     private cache;
-    constructor(options: ClientOptions);
+    constructor(options: QueryClientOptions);
     private checkOptions;
     checkApiConnection(): Promise<string>;
     getApiVersion(): Promise<string>;
@@ -785,6 +786,11 @@ export declare class QueryClient {
     }): Opening[];
 }
 
+export declare interface QueryClientOptions {
+    organizationId: string;
+    clientToken: string;
+}
+
 declare const ragScale: <C extends string>({ categories, colors, nodata, }: RAGScaleOptions<C>) => (category: C) => string;
 
 declare interface RAGScaleOptions<C extends string> {
@@ -805,35 +811,7 @@ declare const ragSwatches: <C extends string>({ categories, colors, nodata, excl
     label: string;
 }[];
 
-declare interface RenderOptions {
-    compass?: boolean
-    annotations?: boolean
-    skybox?: boolean
-    backgroundColor?: string
-    filter?: Partial<Filter>
-    walls?: {
-        render?: boolean
-        alpha?: number
-        maxHeightCm?: number
-        showStructuralWalls?: boolean
-    }
-    grounds?: {
-        render?: boolean
-    }
-    doors?: boolean
-    windows?: boolean
-    openings?: boolean
-    flip?: boolean
-    objects?: boolean
-    facade?: boolean
-    floorplan?: {
-        render?: boolean
-        alpha?: number
-        elevationInCm?: number
-    }
-}
-
-declare interface RoomWithHoles {
+export declare interface RoomWithHoles {
     room: SmplrCoord2d[];
     holes: SmplrCoord2d[][];
     coordinates: SmplrCoord2d[][];
@@ -844,7 +822,7 @@ declare interface ScreenXY {
     screenY: number;
 }
 
-declare interface SessionOptions {
+export declare interface SessionOptions {
     loadingMessage?: string;
     onReady?: () => void;
     onError?: (errorMessage: string) => void;
@@ -852,13 +830,13 @@ declare interface SessionOptions {
 
 declare type SmplrCamera = OrbitCamera | UniversalCamera | VrCamera;
 
-declare interface SmplrCoord2d {
+export declare interface SmplrCoord2d {
     levelIndex: number;
     x: number;
     z: number;
 }
 
-declare interface SmplrCoord3d extends SmplrCoord2d {
+export declare interface SmplrCoord3d extends SmplrCoord2d {
     elevation: number;
 }
 
@@ -897,8 +875,15 @@ export declare class Space {
     private checkOptions;
     private prepareContainer;
     remove: () => void;
-    startViewer(options: ViewerOptions): Promise<void>;
+    startViewer(options: SpaceViewerOptions): Promise<void>;
     addDataLayer<D extends UnknownData>(dataLayer: DataLayer<D>): DataLayerController<D>;
+    addPointDataLayer<D extends UnknownData>(dataLayer: PointDataLayer<D>): DataLayerController<D>;
+    addIconDataLayer<D extends UnknownData>(dataLayer: IconDataLayer<D>): DataLayerController<D>;
+    addPolylineDataLayer<D extends UnknownData>(dataLayer: PolylineDataLayer<D>): DataLayerController<D>;
+    addDottedPolylineDataLayer<D extends UnknownData>(dataLayer: DottedPolylineDataLayer<D>): DataLayerController<D>;
+    addPolygonDataLayer<D extends UnknownData>(dataLayer: PolygonDataLayer<D>): DataLayerController<D>;
+    addFurnitureDataLayer<D extends UnknownData>(dataLayer: FurnitureDataLayer<D>): DataLayerController<D>;
+    addHeatmapDataLayer<D extends UnknownData>(dataLayer: HeatmapDataLayer<D>): DataLayerController<D>;
     getDataLayer<D extends UnknownData>(id: string): DataLayerController<D> | undefined;
     updateDataLayer<D extends UnknownData>(dataLayerUpdates: Partial<DataLayer<D>>): void;
     removeDataLayer(id: string): void;
@@ -927,14 +912,14 @@ export declare class Space {
     showUpToLevel(levelIndex: number): void;
     showAllLevels(): void;
     setMode(mode: CameraMode): void;
-    updateRenderOptions(options: RenderOptions): void;
+    updateRenderOptions(options: SpaceRenderOptions): void;
     hideLevelPicker(): void;
     showLevelPicker(): void;
     hideNavigationButtons(): void;
     showNavigationButtons(): void;
 }
 
-declare interface SpaceOptions {
+export declare interface SpaceOptions {
     spaceId: string;
     clientToken: string;
     containerId: string;
@@ -943,6 +928,60 @@ declare interface SpaceOptions {
     internal?: boolean;
 }
 
+export declare interface SpaceRenderOptions {
+    compass?: boolean
+    annotations?: boolean
+    skybox?: boolean
+    backgroundColor?: string
+    filter?: Partial<Filter>
+    walls?: {
+        render?: boolean
+        alpha?: number
+        maxHeightCm?: number
+        showStructuralWalls?: boolean
+    }
+    grounds?: {
+        render?: boolean
+    }
+    doors?: boolean
+    windows?: boolean
+    openings?: boolean
+    flip?: boolean
+    objects?: boolean
+    facade?: boolean
+    floorplan?: {
+        render?: boolean
+        alpha?: number
+        elevationInCm?: number
+    }
+}
+
+export declare interface SpaceViewerOptions {
+    mode?: CameraMode;
+    preview?: boolean;
+    allowModeChange?: boolean;
+    cameraPlacement?: OrbitCameraPlacement;
+    disableCameraControls?: boolean;
+    disableCameraRotation?: boolean;
+    autoRotate?: boolean;
+    hideNavigationButtons?: boolean;
+    hideLevelPicker?: boolean;
+    legendPosition?: 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
+    compass?: boolean;
+    annotations?: boolean;
+    renderOptions?: SpaceRenderOptions;
+    includeLevels?: number[];
+    topShownLevel?: number;
+    onReady?: () => void;
+    onError?: (errorMessage: string) => void;
+    onResize?: (containerRect: DOMRect) => void;
+    onVisibleLevelsChanged?: (visibleLevels: number[]) => void;
+    onModeChange?: (mode: CameraMode) => void;
+    loadingMessage?: string;
+    renderingMessage?: string;
+    experimentalFacadeBasedPerformance?: boolean;
+}
+
 declare interface SphereOptions<D> {
     shape: 'sphere';
     diameter?: number | ((dataElement: PointData & D) => number | {
@@ -955,7 +994,7 @@ declare interface SphereOptions<D> {
 declare const toString_2: () => string;
 export { toString_2 as toString }
 
-declare type UnknownData = Record<string, unknown>;
+export declare type UnknownData = Record<string, unknown>;
 
 declare const useEventEmitter: () => {
     addListener: (listener: Listener) => number;
@@ -976,33 +1015,7 @@ declare interface Vector3Coord extends Vector2Coord {
     z: number;
 }
 
-export declare const version = "2.25.3-beta.9";
-
-declare interface ViewerOptions {
-    mode?: CameraMode;
-    preview?: boolean;
-    allowModeChange?: boolean;
-    cameraPlacement?: OrbitCameraPlacement;
-    disableCameraControls?: boolean;
-    disableCameraRotation?: boolean;
-    autoRotate?: boolean;
-    hideNavigationButtons?: boolean;
-    hideLevelPicker?: boolean;
-    legendPosition?: 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
-    compass?: boolean;
-    annotations?: boolean;
-    renderOptions?: RenderOptions;
-    includeLevels?: number[];
-    topShownLevel?: number;
-    onReady?: () => void;
-    onError?: (errorMessage: string) => void;
-    onResize?: (containerRect: DOMRect) => void;
-    onVisibleLevelsChanged?: (visibleLevels: number[]) => void;
-    onModeChange?: (mode: CameraMode) => void;
-    loadingMessage?: string;
-    renderingMessage?: string;
-    experimentalFacadeBasedPerformance?: boolean;
-}
+export declare const version = "2.26.0";
 
 declare interface ViewerRendererHandle {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -1016,7 +1029,7 @@ declare interface ViewerRendererHandle {
     showAllLevels: () => void
     getMode: () => CameraMode
     setMode: (mode: CameraMode) => void
-    updateRenderOptions: (options: RenderOptions) => void
+    updateRenderOptions: (options: SpaceRenderOptions) => void
     setHideLevelPicker: (value: boolean) => void
     setHideNavigationButtons: (value: boolean) => void
     // eslint-disable-next-line @typescript-eslint/no-explicit-any

package/dist/index.d.ts

@@ -1,5 +1,3 @@
 import { Smplr } from './types';
-export type { Smplr } from './types';
-declare type BundleType = 'esm' | 'umd';
-declare type Env = 'prod' | 'dev' | 'local';
-export declare function loadSmplrJs(bundle?: BundleType, env?: Env): Promise<Smplr>;
+export declare function loadSmplrJs(bundle?: 'esm' | 'umd', env?: 'prod' | 'dev' | 'local'): Promise<Smplr>;
+export * from './types';

package/dist/types.d.ts

@@ -1,16 +1,25 @@
-// eslint-disable-next-line import/no-unresolved
-import * as smplr from './generated/smplr'
+/*
+  IMPORTANT NOTE
+  These types are generated at build time, the last deployed version can be
+  copied from https://www.npmjs.com/package/@smplrspace/smplr-loader?activeTab=code
+  👉 we use a .d.ts to avoid TS and linting errors on content generated in CI
+*/
 
-export {}
+/* eslint-disable import/no-unresolved */
+import { Color, Editor, Map, QueryClient, Space, toString, version } from './generated/smplr'
+
+export * from './generated/smplr'
+/* eslint-enable import/no-unresolved */
 
+/* EXPOSED IN SMPLR.JS */
 export interface Smplr {
-  version: typeof smplr.version
-  toString: typeof smplr.toString
-  Space: typeof smplr.Space
-  Map: typeof smplr.Map
-  Editor: typeof smplr.Editor
-  QueryClient: typeof smplr.QueryClient
-  Color: typeof smplr.Color
+  version: typeof version
+  toString: typeof toString
+  Space: typeof Space
+  Map: typeof Map
+  Editor: typeof Editor
+  QueryClient: typeof QueryClient
+  Color: typeof Color
 }
 
 declare global {
@@ -18,3 +27,5 @@ declare global {
     smplr?: Smplr
   }
 }
+
+export {}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smplrspace/smplr-loader",
-  "version": "2.25.3-beta.9",
+  "version": "2.26.0",
   "description": "NPM package to load a typed Smplr.js from CDN easily",
   "type": "module",
   "files": [
@@ -16,7 +16,7 @@
   },
   "types": "./dist/index.d.ts",
   "scripts": {
-    "build": "yarn tsc && vite build",
+    "build": "yarn tsc && vite build && echo \"export * from './types';\" >> dist/index.d.ts",
     "dev": "echo 'No dev'",
     "serve": "echo 'No serve'",
     "libtest": "echo 'No libtest'",