@smplrspace/smplr-loader 2.25.3-beta.10 → 2.25.3-beta.13

package/dist/generated/smplr.d.ts

@@ -805,34 +805,6 @@ 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 {
     room: SmplrCoord2d[];
     holes: SmplrCoord2d[][];
@@ -897,7 +869,7 @@ 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>;
     getDataLayer<D extends UnknownData>(id: string): DataLayerController<D> | undefined;
     updateDataLayer<D extends UnknownData>(dataLayerUpdates: Partial<DataLayer<D>>): void;
@@ -927,14 +899,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 +915,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 | {
@@ -976,33 +1002,7 @@ declare interface Vector3Coord extends Vector2Coord {
     z: number;
 }
 
-export declare const version = "2.25.3-beta.10";
-
-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.25.3-beta.13";
 
 declare interface ViewerRendererHandle {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -1016,7 +1016,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 type { Editor, Map, QueryClient, Space } from './generated/smplr'
+import { Color, toString, version } from './generated/smplr'
+
+export * from './generated/smplr'
+/* eslint-enable import/no-unresolved */
 
 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: Space
+  Map: Map
+  Editor: Editor
+  QueryClient: 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.10",
+  "version": "2.25.3-beta.13",
   "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'",