@roomle/web-sdk 3.10.1-alpha.3 → 4.0.0

package/lib/roomle-headless.d.ts

@@ -19,6 +19,11 @@ import { HiCallbacks } from '../../../../common/src/hi/hi-types';
 import { HiOrderData } from '../../../../common/src/hi/hi-types';
 import { HiOrderHeader } from '../../../../common/src/hi/hi-types';
 import { Intersection } from 'three';
+import { isIdAComponent } from '../../common/src/utils/id-inferrer';
+import { isIdAConfigurationString } from '../../common/src/utils/id-inferrer';
+import { isIdAnItem } from '../../common/src/utils/id-inferrer';
+import { isIdAPlan } from '../../common/src/utils/id-inferrer';
+import { isPlanSnapshotId } from '../../common/src/utils/id-inferrer';
 import { Layers } from 'three';
 import { Light } from 'three';
 import { Material } from 'three';
@@ -718,12 +723,6 @@ export declare interface CommonInitData {
      * @groups scene-settings
      */
     colors?: ColorsIn3dScene;
-    /**
-     * @deprecated
-     * @description Set if the currently loaded id is an item or a configuration.
-     * In the new configurator UI this is determined automatically based on the id.
-     */
-    isItem?: boolean;
     /**
      * @description The item id or configuration id of the item which should be loaded.
      * Examples:
@@ -731,13 +730,6 @@ export declare interface CommonInitData {
      * Item id: usm:frame
      */
     id?: RapiId;
-    /* Excluded from this release type: preloadId */
-    /**
-     * @deprecated
-     * @description Set if the AR button should be shown.
-     * In the new configurator UI this is in the configurator settings object called buttons.
-     */
-    showArButton?: boolean;
     /* Excluded from this release type: useRoomlePrice */
     /**
      * @description Set how many positions after the decimal point should be shown.
@@ -768,24 +760,6 @@ export declare interface CommonInitData {
      *   - 'short': Short unit string, for example '200 m'
      */
     unitStringType?: string;
-    /**
-     * @description Add a tag id which is used to show different variations for the current item/configuration
-     * @deprecated
-     */
-    typeChangeTag?: RapiId;
-    /* Excluded from this release type: preloadHint */
-    /**
-     * @deprecated
-     * @description Change the offset of the camera. For example if you add a margin left (0.1 means 10%) then
-     * the item moves to the right.
-     * This value is overridden in the new configurator UI.
-     * */
-    offset?: CanvasOffset;
-    /**
-     * @deprecated
-     * @description Add a tag id which is used to show different variations when opening the configurator
-     */
-    startTag?: RapiId;
     /**
      * @description When mesh selection is enabled, the meshes of the object are used directly for highlighting.
      * Setting it to false could be useful for square/rectangular (shelf) items.
@@ -795,7 +769,6 @@ export declare interface CommonInitData {
      * @description if set to true it shows a little overlay with performance stats
      */
     stats?: boolean;
-    /* Excluded from this release type: _measureTraffic */
     /**
      * @description This flag enables:
      *   - Scripter debug logs (e.g. which parameter is not assigned to a parameter group)
@@ -817,7 +790,6 @@ export declare interface CommonInitData {
      * For more information ask your Roomle contact.
      */
     usePriceService?: boolean;
-    /* Excluded from this release type: disableEnvMap */
     /**
      * @description Url to an exr or hdr env map
      * @groups scene-settings
@@ -1106,11 +1078,6 @@ export declare interface ConfiguratorDebugCallbacks {
 }
 
 export declare interface ConfiguratorInitData {
-    /**
-     * @deprecated
-     * @description Download all necessary files to run the configurator in offline mode
-     */
-    offlineSync?: string;
     /**
      * @description Sets the behavior of the highlighting of a hovered component.
      * usage: highlighting=smart
@@ -1127,11 +1094,6 @@ export declare interface ConfiguratorInitData {
      * @groups scene-settings
      */
     ls?: string;
-    /**
-     * @deprecated
-     * @description define which floors to load
-     */
-    floorMaterialsTag?: RapiId;
     /**
      * @description Set the distance to which the user can zoom (in centimeters).
      * default: object size divided by 10 or 10 cm
@@ -1208,16 +1170,6 @@ export declare interface ConfiguratorInitData {
      * @groups scene-settings
      */
     transparentBackground?: boolean;
-    /**
-     * @deprecated
-     * @description Shows partlist if there are no prices
-     */
-    showInfos?: boolean;
-    /**
-     * @deprecated
-     * @description Show price label using prices from configuration script
-     */
-    showPrice?: boolean;
     /**
      * @description If set to true it will try to apply all current global parameters to the loaded object
      */
@@ -1233,6 +1185,7 @@ export declare interface ConfiguratorInitData {
     cameraSpacing?: number;
     /* Excluded from this release type: ssr */
     /* Excluded from this release type: featureFlags */
+    /* Excluded from this release type: webGpuConfig */
     /**
      * @description if true, the meshes of the component will be used, in addition to the bounding box, for raycasting (selecting)
      * Warning: this will decrease performance when hovering over components with complex meshes
@@ -3347,7 +3300,6 @@ export declare interface FeatureFlags {
     /* Excluded from this release type: interiorLights */
     /* Excluded from this release type: advancedDimensioning */
     /* Excluded from this release type: webGpu */
-    /* Excluded from this release type: webGpuConfig */
     /* Excluded from this release type: advancedHighlighting */
     /* Excluded from this release type: fence */
     /* Excluded from this release type: awaitConfigurationSavesBeforeRequestPlan */
@@ -3363,7 +3315,6 @@ export declare class FeatureFlagsImplementation implements FeatureFlags {
     advancedDimensioning: boolean;
     enableSnapping: boolean;
     webGpu: boolean;
-    webGpuConfig: WebGpuConfig;
     forceSaveThumbnails: boolean;
     advancedHighlighting: boolean;
     fence: boolean;
@@ -3593,7 +3544,6 @@ export declare class GlobalInitData implements Context, GlobalInitDataDefinition
     overrideCountry: string | null;
     configuratorId?: string;
     overrideRapi?: RapiServerUrlType;
-    alwaysUseCache: boolean;
     customApiUrl?: string;
     e2e: boolean;
     e2eRoomleRendererForImages: boolean;
@@ -3620,11 +3570,6 @@ export declare interface GlobalInitDataDefinition {
      * @description The id which should be used for this embedding instance. When this id is set all InitData parameter can be set and changed in Rubens Admin. This is the way we recommend to set init data params. Ask your Roomle contact for your configuratorId.
      */
     configuratorId?: string;
-    /**
-     * @deprecated
-     * @description when set to true and assets were precached by the asset loader they are returned from cache. Otherwise we always return a fresh copy from network usage: alwaysUseCache=true default: not set -> assets fetched from url, set -> assets from cache
-     */
-    alwaysUseCache?: boolean;
     /**
      * @description Set which RAPI (Roomle API) backend should be used usage: customApiUrl=https://www.roomle.com/api/v2
      */
@@ -3881,11 +3826,18 @@ export declare class HeadlessRoomleSdk {
      */
     prewarmGlbViewer(initData?: Partial<InitDataDefinition>): Promise<void>;
     /**
-     * Load a saved configuration via the RAPI `/configurations/` endpoint.
+     * Load a saved configuration by **id**, via the RAPI `/configurations/`
+     * endpoint. For an inline configuration string use
+     * {@link loadConfigurationString} instead.
      * @param configurationId Multi-segment id like `catalog:item:HASH`.
      * @param initData Optional per-module init overrides for prewarm.
      */
     loadConfiguration(configurationId: RapiId, initData?: Partial<InitDataDefinition>): Promise<void>;
+    /**
+     * Load a configuration string directly without querying the RAPI (`{"componentId":"catalog:item",…}`)
+     * To load a configuration by ID, use {@link loadConfiguration}
+     */
+    loadConfigurationString(configuration: string, initData?: Partial<InitDataDefinition>): Promise<void>;
     /**
      * Load a configurable item via the RAPI `/items/` endpoint.
      * @param itemId Single-segment id like `catalog:item`.
@@ -3917,9 +3869,10 @@ export declare class HeadlessRoomleSdk {
      */
     private _suppressGlbSelfShadowing;
     /**
-     * Auto-dispatch by id shape using the shared id-inferrer utilities so
-     * detection stays in lock-step with the UI's `SdkConnector.loadObject`:
+     * Auto-dispatch by id shape using the shared id-inferrer utilities, closely
+     * following the UI's `SdkConnector.loadObject`:
      *   - `component@…`           → not supported in headless, throws
+     *   - `{…}` (config string)    → {@link loadConfigurationString}
      *   - 0 colons (plan id)       → {@link loadPlan}
      *   - 1 colon (item id)        → {@link loadStaticItem} if RAPI says the
      *                                item has no `configuration`, otherwise
@@ -3937,6 +3890,14 @@ export declare class HeadlessRoomleSdk {
      * @param initData Optional per-module init overrides for prewarm.
      */
     loadPlan(planId: string, initData?: Partial<InitDataDefinition>): Promise<void>;
+    /**
+     * Load plan XML string directly in the planner.
+     * @param xml Plan XML (`<plan version="2">…</plan>`).
+     * @param initData Optional per-module init overrides for prewarm.
+     */
+    loadPlanXml(xml: string, initData?: Partial<InitDataDefinition>): Promise<void>;
+    private _loadIntoPlanner;
+    private _inlineSceneId;
     /**
      * Serialises concurrent load operations using a promise-chain queue.
      * Each call chains its task onto the previous queue tail so they run
@@ -4271,30 +4232,21 @@ export declare class InitData implements Context, Omit<InitDataDefinition, 'colo
     _creator_: string;
     autoQuality: boolean;
     colors: ThreeJsColorsIn3dScene;
-    isItem: boolean;
     id?: RapiId;
-    preloadId?: RapiId;
-    showArButton: boolean;
     useRoomlePrice: boolean;
     precisionInch?: number;
     precisionCm?: number;
     unit?: string;
     unitStringType?: string;
-    typeChangeTag?: RapiId;
-    preloadHint?: RapiId;
-    offset?: CanvasOffset;
-    startTag?: RapiId;
     measurementSystem?: Enumify_2<typeof MEASUREMENT_SYSTEM_STRING>;
     meshSelection: boolean;
     stats: boolean;
-    _measureTraffic: boolean;
     debug: boolean;
     debugGeometry: boolean;
     debugLines: boolean;
     debugBoundingBox: boolean;
     usePriceService: boolean;
     disableDebugGUI: boolean;
-    disableEnvMap: boolean;
     envMapUrl: string;
     envMapIntensity: number;
     envMapRotation: number;
@@ -4308,12 +4260,10 @@ export declare class InitData implements Context, Omit<InitDataDefinition, 'colo
     restrictionLevel: number;
     hi?: HomagIntelligenceInitData;
     disableDefaultLabelStyles: boolean;
-    offlineSync?: string;
     highlighting: Enumify_2<typeof ROOMLE_HIGHLIGHTNG>;
     initialFloorMaterial?: string;
     dls?: string;
     ls?: string;
-    floorMaterialsTag?: RapiId;
     zoomDistance?: number;
     cameraSpacing: number;
     cameraRestriction?: number;
@@ -4328,13 +4278,12 @@ export declare class InitData implements Context, Omit<InitDataDefinition, 'colo
     transparentHighlighting: boolean;
     transparentBackground: boolean;
     snappingEnabled: boolean;
-    showInfos: boolean;
-    showPrice: boolean;
     applyCurrentGlobalParameters: boolean;
     configureInRoom: boolean;
     dockInRoom: boolean;
     discardExternalObjectsWhenLoadingPlan: boolean;
     featureFlags: FeatureFlagsImplementation;
+    webGpuConfig: WebGpuConfig;
     meshRaycasting: boolean;
     defaultFloorMaterial?: number | string;
     mode: Enumify_2<typeof CAMERA_TYPE>;
@@ -4520,6 +4469,16 @@ export declare const isExtObjId: (id: unknown) => id is ExtObjId_2;
 
 export declare const isFirefox: () => boolean;
 
+export { isIdAComponent }
+
+export { isIdAConfigurationString }
+
+export { isIdAnItem }
+
+export { isIdAPlan }
+
+export { isPlanSnapshotId }
+
 export declare const isSafari: () => boolean;
 
 export declare const KERNEL_MESSAGE_TYPE: {
@@ -5167,12 +5126,6 @@ export declare interface LogMessageScope {
 export declare class LongArray extends EmsArray<number> {
 }
 
-export declare interface LutImageDefinition {
-    name: string;
-    url: string;
-    type: string;
-}
-
 export declare const enum MAIL_TYPE {
     STANDARD = 1,
     AUGMENTED_REALITY = 2,
@@ -5466,6 +5419,24 @@ export declare interface MessageObject {
     type: string;
 }
 
+/**
+ * Options for the model exports (GLB/USDZ).
+ *
+ * Example:
+ * ```
+ * {
+ *     filename: 'my-sofa' // downloads as my-sofa.glb / my-sofa.usdz
+ * }
+ * ```
+ */
+export declare interface ModelExportOptions {
+    /**
+     * Name of the downloaded file. The matching extension is appended if it is
+     * not part of the given name. Defaults to `roomle-export`.
+     */
+    filename?: string;
+}
+
 export declare abstract class Node_2 extends PlanElement {
     readonly nodeType: NodeType;
     getNumberOfConnectedWalls(): number;
@@ -6462,8 +6433,8 @@ export declare class PlannerSceneManager extends ConfiguratorSceneManager implem
     private _recycleLights;
     removePlanObjectFromScene(planViewModel: PlanElementViewModel | undefined): void;
     planElementChanged(plan: Plan_2, planElementViewModel: PlanElementViewModel): void;
-    exportGLB(): Promise<void>;
-    exportUSDZ(): Promise<void>;
+    exportGLB(options?: ModelExportOptions): Promise<void>;
+    exportUSDZ(options?: ModelExportOptions): Promise<void>;
     importGLB(url: string): void;
     clearScene(): void;
     private _addSky;
@@ -8260,12 +8231,12 @@ export declare class RoomleConfigurator<P extends readonly PluginName[] = readon
      *
      * @returns the elevation plans, containing one plan with its SVG markup
      */
-    create2DElevationPlan(): ElevationPlans;
+    create2DElevationPlan(): Promise<ElevationPlans>;
     /**
      * Creates the 2D elevation plan of the current configuration (see
      * {@link create2DElevationPlan}) and downloads it as an SVG file.
      */
-    download2DElevationPlan(): void;
+    download2DElevationPlan(): Promise<void>;
     private createCameraForElevationPlan;
     exportCanvasScreenshot(quality?: number): Promise<string>;
     initSceneManager(sceneManager?: ConfiguratorSceneManager): void;
@@ -8914,12 +8885,16 @@ export declare class RoomleConfigurator<P extends readonly PluginName[] = readon
     updateComponentParameter(runtimeId: number, parameterKey: string, value: string): void;
     /**
      * Downloads the current configuration model in GLTF .GLB model file.
+     *
+     * @param options Optional export options, e.g. `{ filename: 'my-sofa' }`.
      */
-    exportGLB(): Promise<void>;
+    exportGLB(options?: ModelExportOptions): Promise<void>;
     /**
      * Downloads the current configuration model to Universal Scene Descriptor Zip .USDZ model file.
+     *
+     * @param options Optional export options, e.g. `{ filename: 'my-sofa' }`.
      */
-    exportUSDZ(): Promise<void>;
+    exportUSDZ(options?: ModelExportOptions): Promise<void>;
 }
 
 export declare type RoomleConfiguratorType = RoomleConfigurator | RoomleConfiguratorWithExtObjs;
@@ -9219,12 +9194,12 @@ export declare class RoomlePlanner<P extends readonly PluginName[] = readonly []
      *
      * @returns the elevation plans, each containing its SVG markup
      */
-    create2DElevationPlan(): ElevationPlans;
+    create2DElevationPlan(): Promise<ElevationPlans>;
     /**
      * Creates the 2D elevation plans of the current plan (see
      * {@link create2DElevationPlan}) and downloads each plan as an SVG file.
      */
-    download2DElevationPlan(): void;
+    download2DElevationPlan(): Promise<void>;
     loadPlan(id: string, options?: InitDataDefinition & GlobalInitDataDefinition): Promise<RapiPlan | RapiPlanSnapshotGetData>;
     /**
      * Set general configuration parameter
@@ -9238,12 +9213,16 @@ export declare class RoomlePlanner<P extends readonly PluginName[] = readonly []
     resetCameraPosition(): void;
     /**
      * Downloads the current plan/scene to a GLTF .GLB model file.
+     *
+     * @param options Optional export options, e.g. `{ filename: 'my-plan' }`.
      */
-    exportGLB(): void;
+    exportGLB(options?: ModelExportOptions): void;
     /**
      * Downloads the current plan/scene to a Universal Scene Descriptor Zip .USDZ model file.
+     *
+     * @param options Optional export options, e.g. `{ filename: 'my-plan' }`.
      */
-    exportUSDZ(): Promise<void>;
+    exportUSDZ(options?: ModelExportOptions): Promise<void>;
     importGLB(url: string): void;
     private _initPromiseCallback;
     isReady(): void;
@@ -9922,7 +9901,6 @@ export declare abstract class RoomleRenderer<RendererType extends WebGLRenderer
     switchToPlanner(_renderMode: PlannerRenderMode): void;
     abstract setShadingType(shadingType: SceneShadingType): void;
     abstract setCustomOutlineParameters(outlineCustomParameters: OutlineCustomParameters): void;
-    abstract loadLutImages(luts: LutImageDefinition[]): void;
     abstract render(scene: Scene, camera: Camera): void;
     abstract showGUI(updateCallback: () => void): void;
     abstract clearCache(): void;
@@ -10006,7 +9984,7 @@ export declare class RoomleWebGPURenderer extends RoomleRenderer<WebGPURenderer>
     private _webGpuGroundShadowReflection;
     private _initData;
     constructor(creator: string, renderer: WebGPURenderer, enableSSGI: boolean, outlineColors?: OutlineColors);
-    private enableRenderPasses;
+    private enableDefaultRenderPasses;
     addGroundShadowLightAndFloor(scene: Scene): Promise<void>;
     private addRenderPass;
     clearCache(): void;
@@ -10016,7 +9994,6 @@ export declare class RoomleWebGPURenderer extends RoomleRenderer<WebGPURenderer>
     switchToConfigurator(): void;
     switchToPlanner(renderMode: PlannerRenderMode): void;
     highlightObjects(selectedMeshes: Object3D[]): void;
-    loadLutImages(_luts: LutImageDefinition[]): void;
     render(scene: Scene, camera: Camera): void;
     private renderToFreezeTarget;
     private updateCameraProjectionMatrix;
@@ -10027,11 +10004,14 @@ export declare class RoomleWebGPURenderer extends RoomleRenderer<WebGPURenderer>
     private getOutlinePassOrUndefined;
     private enableSsgiPass;
     private enableTraaPass;
+    private enableFogPass;
+    private disableFogPass;
     private applyQualityParameters;
     private getSsgiPassOrUndefined;
     setShadingType(shadingType: SceneShadingType): void;
     showGUI(updateCallback: () => void): void;
     private addDebugGUI;
+    private applyToneMappingConfig;
     private addToneMappingSettings;
     getOrCreateGUIParameters(name: string): ParametersGroup;
     private createAndCacheGUIParameters;
@@ -10276,9 +10256,9 @@ export declare abstract class SceneManager implements Context, LifeCycleCallback
     protected _getCameraControl2D(): CameraControl2D;
     protected _getCameraControlFirstPerson(): CameraControlFirstPerson;
     createUSDZExport(): Promise<Uint8Array<ArrayBuffer> | undefined>;
-    exportUSDZ(): Promise<void>;
+    exportUSDZ(options?: ModelExportOptions): Promise<void>;
     createExportGLB(objectFilter?: (object: Object3D) => boolean): Promise<ArrayBuffer | null>;
-    exportGLB(): Promise<void>;
+    exportGLB(options?: ModelExportOptions): Promise<void>;
 }
 
 export declare interface ScenePlugin extends ScenePluginHooks, Context {
@@ -11072,12 +11052,25 @@ export declare interface WallSide {
     value: Enumify_3<typeof WALL_SIDES>;
 }
 
+export declare const WEBGPU_TONE_MAPPINGS: {
+    readonly NONE: "none";
+    readonly LINEAR: "linear";
+    readonly REINHARD: "reinhard";
+    readonly CINEON: "cineon";
+    readonly ACES_FILMIC: "acesFilmic";
+    readonly AGX: "agx";
+    readonly NEUTRAL: "neutral";
+};
+
 export declare class WebGpuConfig implements WebGpuConfigDefinition {
     autoDetectQualityLevel: boolean;
     autoQualityMinFps: number;
     autoQualityMaxFps: number;
     topLight: WebGpuTopLightConfig;
     groundReflection: WebGpuGroundReflectionConfig;
+    fog: WebGpuFogConfig;
+    toneMapping: WebGpuToneMapping;
+    toneMappingExposure: number;
 }
 
 export declare interface WebGpuConfigDefinition {
@@ -11110,6 +11103,55 @@ export declare interface WebGpuConfigDefinition {
      * @description Visual configuration for the WebGPU ground reflection.
      */
     groundReflection?: WebGpuGroundReflectionConfigDefinition;
+    /**
+     * @description Visual configuration for the WebGPU fog.
+     */
+    fog?: WebGpuFogConfigDefinition;
+    /**
+     * @description Tone mapping operator applied by the WebGPU renderer.
+     * @default 'none'
+     */
+    toneMapping?: WebGpuToneMapping;
+    /**
+     * @description Exposure (intensity) of the tone mapping applied by the
+     * WebGPU renderer. Higher values produce a brighter image.
+     * @default 1
+     */
+    toneMappingExposure?: number;
+}
+
+export declare class WebGpuFogConfig implements WebGpuFogConfigDefinition {
+    enabled: boolean;
+    nearBlend: number;
+    farBlend: number;
+}
+
+export declare interface WebGpuFogConfigDefinition {
+    /**
+     * @description If true, a fog is added to the scene in webGPU mode.
+     * This is mainly so you cant see the outer edge of the
+     * floor (which makes it blends smoothly into the background).
+     * This fog exists in a cylindrical shape around the origin and the
+     * farBlend and nearBlend parameters indirectly control the radius
+     * at which the fog starts and ends.
+     * @default true
+     */
+    enabled?: boolean;
+    /**
+     * @description Radial distance from the start of the fog to the end of the fog.
+     * This creates a smooth transition from full fog to no fog.
+     * Larger values produce a softer, more gradual fog transition.
+     * @default 7
+     */
+    nearBlend?: number;
+    /**
+     * @description Distance from the far end of the camera view/floor boundaries
+     * at which the fully opaque fog should start to appear.
+     * Larger values move the fully opaque(/end of the) fog
+     * closer to the center of the scene.
+     * @default 10
+     */
+    farBlend?: number;
 }
 
 export declare class WebGpuGroundReflectionConfig implements WebGpuGroundReflectionConfigDefinition {
@@ -11145,6 +11187,8 @@ export declare interface WebGpuGroundReflectionConfigDefinition {
     endFadeout?: number;
 }
 
+export declare type WebGpuToneMapping = Enumify_2<typeof WEBGPU_TONE_MAPPINGS>;
+
 export declare class WebGpuTopLightConfig implements WebGpuTopLightConfigDefinition {
     intensity: number;
     shadowIntensity: number;