@roomle/web-sdk 3.7.0-alpha.4 → 3.8.0-alpha.1

package/lib/roomle-headless.d.ts

@@ -22,6 +22,7 @@ import { Intersection } from 'three';
 import { Layers } from 'three';
 import { Light } from 'three';
 import { Material } from 'three';
+import { MaterialEventMap } from 'three';
 import { Mesh } from 'three';
 import { MeshPhysicalMaterial } from 'three';
 import { MeshStandardMaterial } from 'three';
@@ -79,6 +80,13 @@ export declare class AddOnSpotArray extends EmsArray<KernelAddOnSpot> {
 export declare class AddOnSpotArray_2 extends EmsArray<KernelAddOnSpot> {
 }
 
+export declare class AdjustableCameraControl3D extends CameraControl3D {
+    shouldIgnoreStandardBehavior: boolean;
+    adjust(bounds: Vector3, position: Vector3, yaw: number, pitch: number, _fov: number): void;
+    protected _update(overrideTarget?: Vector3): void;
+    animateCamera(delta: number): boolean;
+}
+
 export declare interface Anchor {
     value: ResizingAnchor;
 }
@@ -120,6 +128,7 @@ export declare class AnimationValueMap {
     setValueAndGetOldValue(animationName: string, value: string, level: number): string;
     getPriorAnimations(animationName: string, level: number): string[];
     getSequentAnimations(animationName: string, level: number): string[];
+    getValues(): string[];
 }
 
 /**
@@ -631,7 +640,7 @@ export declare class CeilingLight extends PointLight {
     private _shouldCastShadow;
     getContainer(): Mesh | null;
     get shouldCastShadow(): boolean;
-    constructor(debug: boolean, maxQualityLevel: QualityLevel);
+    constructor(debug: boolean | undefined, maxQualityLevel: QualityLevel);
     recalculatePower(amountOfLights: number): void;
     update(qualityLevel: QualityLevel): void;
     addDebugUI(ceilingLightsParameters: GenericGUIParamFolder): void;
@@ -875,6 +884,7 @@ export declare interface CommonInitData {
 
 export declare abstract class CommonKernelAccess implements LifeCycleCallbacks, Context {
     _creator_: string;
+    private _kernelCallbackGuard;
     protected _rapiAccess: RapiAccess;
     private _materialProvider;
     protected _scriptLoader: ScriptLoader;
@@ -1238,6 +1248,7 @@ export declare class ConfiguratorKernelAccess extends CommonKernelAccess {
     muteKernelCallbacks: boolean;
     constructor(creator: string);
     init(kernelType: KERNEL_TYPE): void;
+    protected _getScriptLoaderKernelId(_kernelType: KERNEL_TYPE): string;
     protected _loadSuccess(): void;
     protected _loadError(): void;
     selectedComponent(componentId: number): void;
@@ -1296,7 +1307,7 @@ export declare class ConfiguratorKernelAccess extends CommonKernelAccess {
     componentParameters(): void;
     requestComponentDimensions(): void;
     planObjectCreated(conversationId: number, planObjectId: number): void;
-    planObjectUpdated(planObjectId: number, pendingDocking: boolean): void;
+    planObjectUpdated(planObjectId: number, pendingDocking: boolean, automaticCalculationUpdate: boolean): void;
     planObjectConfigurationUpdated(planObjectId: number, configuration: ConfigurationString, hash: string, _rootPlanComponentId: number, _valid: boolean, pendingDocking: boolean): Promise<void>;
     private _onBoundsUpdate;
     planObjectDeleted(): void;
@@ -1352,6 +1363,9 @@ export declare class ConfiguratorKernelAccess extends CommonKernelAccess {
     listOfVariantsError(dbId: RapiId, error: string): void;
     addDebugClient(debugClient: DebugClient): void;
     configureExternalObjectApi(_externalObjectSetting?: ExternalObjectApiConfiguration): void;
+    evaluateJsScript(objectOrComponentId: number, name: string, argumentObject: any): void;
+    getComponentBounds(componentId: number, animationValueMap?: AnimationValueMap): KernelComponentBounds;
+    updateComponentBounds(component: RoomleComponent): void;
 }
 
 export declare interface ConfiguratorKernelAccessCallbackI extends KernelAccessCallbackI {
@@ -1361,7 +1375,7 @@ export declare interface ConfiguratorKernelAccessCallbackI extends KernelAccessC
 
 export declare interface ConfiguratorKernelCallbackI extends CommonConfiguratorKernelCallbackI {
     planObjectCreated(conversationId: number, planObjectId: number): void;
-    planObjectUpdated(planObject: PlanObjectKernel, pendingDocking: boolean): void;
+    planObjectUpdated(planObject: PlanObjectKernel, pendingDocking: boolean, automaticCalculationUpdate: boolean): void;
     planObjectConfigurationUpdated(planObjectId: number, configuration: ConfigurationString, hash: string, pendingDocking: boolean): void;
     configurationLoaded(conversationId: number, objectId: number, componentId: number, hash: string, errors: any, isFreeFlying: boolean): void;
     Editor3dAddDockPreview(componentId: number, previewId: number, componentType: KernelComponentType): void;
@@ -1410,7 +1424,7 @@ export declare interface ConfiguratorKernelClass {
     setPlanObjectParameter(planObjectId: number, parameterKey: string, value: string): void;
     dockComponent(childId: number, childDockId: number, parentId: number, parentDockId: number, position?: KernelVector3): void;
     getComponent(componentId: number): KernelComponent;
-    getComponentBounds(componentId: number, animationValues: string[]): KernelAssembledObjectBounds;
+    getComponentBounds(componentId: number, animationValues: string[]): KernelComponentBounds;
     getComponentId(componentId: number): RapiId;
     isExternalPlanObject(objectOrPlanComponentId: number): boolean;
     getComponentOrModuleInformation(objectOrPlanComponentId: number): KernelObjectInformation;
@@ -1443,6 +1457,10 @@ export declare interface ConfiguratorKernelClass {
     loadExternalAttributeDefinition(serializedDefinition: string): void;
     setExternalObjectConstructionProperties(serializedProperties: string): void;
     registerDebugClient(debugClient: DebugClient): void;
+    getGlobalParameterValue(objectOrComponentId: number, name: string): string;
+    getRuntimeIdOfRootComponent(objectOrComponentId: number): number;
+    getRuntimeIdsOfChildComponents(objectOrComponentId: number): number[];
+    getComponentParameterValue(objectOrComponentId: number, name: string): string;
 }
 
 export declare interface ConfiguratorKernelContainer {
@@ -1476,7 +1494,6 @@ export declare interface ConfiguratorKernelContainer {
 export declare class ConfiguratorPlanObjectViewModel extends PlanObjectViewModel {
     private _rootComponentRuntimeId;
     private _rootComponentId;
-    private _isExternalObject;
     constructor(planObject: PlanObject);
     addRootComponent(component: RoomleComponent): void;
     addChildEntityComponent(component: RoomleComponent): void;
@@ -1562,7 +1579,7 @@ export declare class ConfiguratorSceneManager extends SceneManager implements Co
     protected _configuratorUiCallbacks: ConfiguratorUiCallbacks;
     protected _plannerKernelAccess: PlannerKernelAccess;
     protected _globalInitData: GlobalInitData;
-    protected _viewModel: ConfiguratorViewModel;
+    _viewModel: ConfiguratorViewModel;
     private _componentFactory;
     protected _highlightHelper: HighlightHelper;
     private _dimensionHelper;
@@ -1582,7 +1599,7 @@ export declare class ConfiguratorSceneManager extends SceneManager implements Co
     enableEvents(): void;
     enableConfiguratorEvents(): void;
     disableConfiguratorEvents(): void;
-    protected _getViewModel(): ConfiguratorViewModel;
+    get viewModel(): ConfiguratorViewModel;
     protected _getKernelAccess(): PlannerKernelAccess;
     private _showDockings;
     cancelDockings(): void;
@@ -1592,6 +1609,7 @@ export declare class ConfiguratorSceneManager extends SceneManager implements Co
     private _onDimensionsAdded;
     private _onHoverOff;
     private _highlightComponent;
+    private _highlightSubModules;
     protected shouldClearShadowsAndAO(): boolean;
     resume(): void;
     private _materialLoaded;
@@ -1667,7 +1685,7 @@ export declare class ConfiguratorSceneManager extends SceneManager implements Co
     };
     private _permissionToDeleteComponent;
     componentUpdated(component: RoomleComponent, kernelComponent: KernelComponent): void;
-    planObjectUpdated(planObject: PlanObjectKernel, geometryChanged: boolean, pendingDocking: boolean): void;
+    planObjectUpdated(planObject: PlanObjectKernel, geometryChanged: boolean, pendingDocking: boolean, automaticCalculationUpdate: boolean): void;
     componentDeleted(component: RoomleComponent): void;
     previewConstructionDone(_component: RoomleComponent, hasPreviews: boolean): void;
     configurationLoaded(component: RoomleComponent, isFreeFlying: boolean): void;
@@ -1694,7 +1712,6 @@ export declare class ConfiguratorSceneManager extends SceneManager implements Co
     getComponent(componentRuntimeId: number): KernelComponent;
     cameraBehaviourChanged(updateDistance?: boolean): void;
     protected _setCameraControlListeners(): void;
-    protected _shouldRenderUi(): boolean;
     protected setEventHandlerObject(object: Object3D): void;
     protected _readyForRender(): void;
     getComponentFromRuntimeId(elementId: number): RoomleComponent | null;
@@ -1709,7 +1726,7 @@ export declare class ConfiguratorSceneManager extends SceneManager implements Co
     private _removeCustomComponentDimensions;
     clearHighlighting(): void;
     getExternalSubArticles(_id: number): PosArticle[];
-    protected _updateHighlightHelper(object?: Object3D | null): void;
+    protected _updateHighlightHelper(invalidate?: boolean, object?: Object3D | null): void;
 }
 
 export declare class ConfiguratorUiCallbacks extends UiCallback implements ConfiguratorDebugCallbacks {
@@ -2072,7 +2089,7 @@ export declare class ConfiguratorViewModel implements ConfiguratorKernelCallback
     finishParameterChange(resolve: () => void, _reject: () => void): void;
     planObjectConfigurationUpdated(planObjectId: number, _configuration: ConfigurationString, _hash: string, pendingDocking: boolean): void;
     planObjectCreated(_conversationId: number, configurationRuntimeId: number): void;
-    planObjectUpdated(planObject: PlanObjectKernel, pendingDocking: boolean): void;
+    planObjectUpdated(planObject: PlanObjectKernel, pendingDocking: boolean, automaticCalculationUpdate: boolean): void;
     sceneCleared(): void;
     setListener(listener: ConfiguratorViewModelCallbackI): void;
     getBoundingBox(excludeEnvironment?: boolean): Box3 | null;
@@ -2104,7 +2121,7 @@ export declare class ConfiguratorViewModel implements ConfiguratorKernelCallback
 export declare interface ConfiguratorViewModelCallbackI {
     componentUpdated(component: RoomleComponent, kernelComponent: KernelComponent): void;
     componentDeleted(component: RoomleComponent): void;
-    planObjectUpdated(planObject: PlanObjectKernel, geometryChanged: boolean, pendingDocking: boolean): void;
+    planObjectUpdated(planObject: PlanObjectKernel, geometryChanged: boolean, pendingDocking: boolean, automaticCalculationUpdate: boolean): void;
     planObjectConstructionDone(planObject: PlanObjectKernel): void;
     previewConstructionDone(component: RoomleComponent, hasPreviews: boolean): void;
     configurationLoaded(component: RoomleComponent, isFreeFlying: boolean): void;
@@ -2213,6 +2230,23 @@ export declare const CORE_DOCK_PAIR_TYPE: {
     readonly LINE: 1;
 };
 
+export declare const CORE_DRAWING_MODE: {
+    readonly WALL: 0;
+    readonly ROOM_CONTOUR: 1;
+    readonly CONTOUR: 2;
+};
+
+export declare const CORE_EDGE_TYPE: {
+    readonly WALL: 0;
+    readonly EDGE: 1;
+    readonly CONSTRUCTION: 2;
+};
+
+export declare const CORE_FLOOR_TYPE: {
+    readonly DEFAULT: 0;
+    readonly TERRAIN: 1;
+};
+
 export declare const CORE_HELP_LINE_TYPE: {
     readonly NONE: 0;
     readonly WALL_SNAP_LEVEL: 1;
@@ -2524,6 +2558,10 @@ export declare const DRAW_PREVIEW_MODES: {
     readonly VECTOR: "vector";
 };
 
+export declare interface DrawingMode {
+    value: Enumify_3<typeof CORE_DRAWING_MODE>;
+}
+
 export declare const enum DrawingType {
     CONTINOUS = 0,
     CLICK_PER_CLICK = 1
@@ -2566,6 +2604,10 @@ export declare interface DynamicLightSettingSource {
     ls?: PreDefinedLightSettings;
 }
 
+export declare interface EdgeType {
+    value: Enumify_3<typeof CORE_EDGE_TYPE>;
+}
+
 export declare interface Element_2 {
     id: string;
     label: string;
@@ -2947,12 +2989,14 @@ export declare interface ExternalObjectAPI {
     getExternalRoomInformation(): Promise<ExternalRoomInformation>;
     /**
      * It generates a snapshot of the external object in the plan without saving any data.
-     * The snapshot includes order data, room information, the plan XML, GLBs of the complete scene,
+     * By default, the snapshot includes order data, room information, the plan XML, GLBs of the complete scene,
      * and only the objects in the scene, as well as perspective images and a top image.
      * The complete XML plan is returned. The assets are returned as base64 strings.
+     * The `requestData` parameter can be used to control which parts of the snapshot are generated, returning only requested properties to improve performance. If `requestData` is passed, omitted properties will be `undefined`.
+     * @param requestData An optional filter object indicating which snapshot properties to generate.
      * @returns the snapshot of the external objects
      */
-    getExternalObjectSnapshot(): Promise<ExternalObjectSnapshotData | null>;
+    getExternalObjectSnapshot(requestData?: ExternalObjectSnapshotRequest): Promise<ExternalObjectSnapshotData | null>;
     /**
      * It generates a snapshot of the external object and saves the data and assets in the Roomle backend.
      * The snapshot includes order data, room information, the plan XML, GLBs of the complete scene,
@@ -3018,6 +3062,7 @@ export declare interface ExternalObjectLoadConfiguration {
     respondWithPositionInPlan: boolean;
     lockCallbacks: boolean;
     tryToMergeNewGroups: boolean;
+    calculationUpdate: boolean;
     moduleIdMap: ExternalObjectLoadingIdMap[];
 }
 
@@ -3060,13 +3105,23 @@ export declare interface ExternalObjectSegment {
 }
 
 export declare interface ExternalObjectSnapshotData {
-    orderData: HiOrderData | null | undefined;
-    planXML: string;
-    objectGlb: string | undefined;
-    perspectiveImage: string | undefined;
-    topImage: string | undefined;
-    perspectiveObjectImage: string | undefined;
-    topObjectImage: string | undefined;
+    orderData?: HiOrderData | null;
+    planXML?: string;
+    objectGlb?: string;
+    perspectiveImage?: string;
+    topImage?: string;
+    perspectiveObjectImage?: string;
+    topObjectImage?: string;
+}
+
+export declare interface ExternalObjectSnapshotRequest {
+    orderData?: boolean;
+    planXML?: boolean;
+    objectGlb?: boolean;
+    perspectiveImage?: boolean;
+    topImage?: boolean;
+    perspectiveObjectImage?: boolean;
+    topObjectImage?: boolean;
 }
 
 export declare interface ExternalObjectSnapshotSaveResult {
@@ -3166,6 +3221,7 @@ export declare interface FeatureFlags {
     /* Excluded from this release type: advancedDimensioning */
     /* Excluded from this release type: webGpu */
     /* Excluded from this release type: advancedHighlighting */
+    /* Excluded from this release type: fence */
 }
 
 export declare interface FetchOptions {
@@ -3205,7 +3261,7 @@ export declare interface FloorAreaData<Vector2Type = Vector3, Vector3Type = Vect
 
 export declare type FloorAreaDataTransferable = FloorAreaData<Position2, Position3>;
 
-export declare abstract class FloorMaterial extends BaseMaterial {
+export declare class FloorMaterial extends BaseMaterial {
     uvScale(): KernelVector3f;
     rotation(): KernelVector3f;
 }
@@ -3217,6 +3273,10 @@ export declare class FloorPlanElementViewModel extends PlanElementViewModel {
     private calculateTextVisibility;
 }
 
+export declare interface FloorType {
+    value: Enumify_3<typeof CORE_FLOOR_TYPE>;
+}
+
 /**
  * Minimal structural type that both dat.gui `GUI` folders (WebGL) and three.js
  * `ParametersGroup` (WebGPU) satisfy, this allows building
@@ -3251,6 +3311,12 @@ export declare class GeometryHelpLineArray extends EmsArray<GeometryHelpLine> {
 
 export declare const getCatalogIdFromConfigurationHash: (id: RapiId) => RapiId | null;
 
+export declare interface GLBRenderWorkerListener {
+    onStart(count: number): void;
+    onElementFinished(finishedElements: number): void;
+    onFinished(zip: any): void;
+}
+
 export declare class GlbViewer extends Main {
     private _viewer;
     protected setupGlobals(): void;
@@ -3262,6 +3328,39 @@ export declare class GlbViewer extends Main {
     protected getContextName(): string;
 }
 
+export declare class GlbViewerCameraBehaviour extends CameraBehaviour {
+    get cameraControl(): AdjustableCameraControl3D;
+    updateCameraOnItemLoaded(bounds: Box3): Promise<void>;
+    externalApiMoveCamera(cameraParameter: CameraParameter): Promise<void>;
+}
+
+export declare class GLBViewerSceneManager extends SceneManager implements GLBRenderWorkerListener {
+    private _glbInputManager;
+    private _rapiAccess;
+    private _currentGLB;
+    private _standardSceneBackgroundColor;
+    private _itemsCount;
+    constructor(creator: string, offset: CanvasOffset);
+    protected createCameraControl(_mode: Enumify_2<typeof CAMERA_TYPE>, _offset: CanvasOffset): void;
+    protected _getInputManager(): InputManager;
+    loadStaticItem(id: string, callback?: (percent: number) => void): Promise<void>;
+    loadGLB(url: string, automaticallyAdjustCamera?: boolean, scaling?: Vector3, callback?: (percent: number) => void): Promise<void>;
+    preparePerspectiveImage(options?: PrepareImageOptions, providedRenderer?: WebGLRenderer): Promise<Base64Image>;
+    adjustCamera(position: Vector3, yaw: number, pitch: number, fov: number): void;
+    onStart(count: number): void;
+    onElementFinished(itemsFinished: number): void;
+    onFinished(_zip: any): void;
+    clearScene(): void;
+    enableHD(): void;
+    sceneChanged(): void;
+    getBounds(): Box3 | null;
+    protected get glbViewerCameraBehaviour(): GlbViewerCameraBehaviour;
+    getGeometryBounds(): Box3 | null;
+    cameraBehaviourChanged(updateDistance?: boolean): void;
+    moveCamera(cameraParameter: CameraParameter): Promise<void>;
+    protected _readyForRender(): void;
+}
+
 export declare class GlbViewerUiCallbacks {
 }
 
@@ -3406,7 +3505,7 @@ export declare interface GlueLogic {
     getVerifiedGroupAttributeOptions(groupId: string, attributeIds?: string | string[]): Promise<Record<string, CheckDropDownResult> | undefined>;
     updateProperty(rootModuleId?: string, propertyName?: string, propertyValue?: string | number | boolean): void;
     findValidSubArticles(posGroupIds: string[] | string): PosArticle[];
-    getValidContainerModulesForSubArticle(posGroupIds: string[] | string, subArticleId: string): ExternalObjectValidContainerModules[];
+    getValidContainerModulesForSubArticle(posGroupIds: string[] | string, subArticleId: string): ValidContainerModules[];
     addSubArticle(articleId: string, rootModuleId: string, parentModuleId: string, insertPosition?: number[]): void;
     deleteSubArticles(groupId: string, subModuleId: string[] | string): Promise<void>;
     arrangeRootModulesOfGroup(changedGroup: ExternalObjectGroup): Promise<void>;
@@ -3450,25 +3549,179 @@ export declare class HeadlessRoomleSdk {
     private _plannerMain;
     private _configurator;
     private _configuratorMain;
+    private _glbViewer;
+    private _glbViewerMain;
     private _initialized;
+    private _configuratorReady;
+    private _plannerReady;
+    private _glbViewerReady;
+    private _loadedConfigurationId;
+    private _loadedPlanId;
+    private _loadedStaticItemId;
     private _width;
     private _height;
+    private _loaderQueue;
+    /**
+     * Create and initialize a headless SDK instance.
+     * @param initData Configurator id plus optional canvas size and global init fields.
+     * @returns Initialized SDK instance.
+     */
     static create(initData: HeadlessInitData): Promise<HeadlessRoomleSdk>;
     private _init;
     private _registerHeadlessServices;
+    private _makeStubElement;
+    /**
+     * Boot and initialize the configurator module ahead of first load.
+     * @param initData Optional per-module init overrides.
+     */
+    prewarmConfigurator(initData?: Partial<InitDataDefinition>): Promise<void>;
+    /**
+     * Boot and initialize the planner module ahead of first load.
+     * @param initData Optional per-module init overrides.
+     */
+    prewarmPlanner(initData?: Partial<InitDataDefinition>): Promise<void>;
+    /**
+     * Boot and initialize the GLB viewer module ahead of first load.
+     * @param initData Optional per-module init overrides.
+     */
+    prewarmGlbViewer(initData?: Partial<InitDataDefinition>): Promise<void>;
+    /**
+     * Load a saved configuration via the RAPI `/configurations/` endpoint.
+     * @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 configurable item via the RAPI `/items/` endpoint.
+     * @param itemId Single-segment id like `catalog:item`.
+     * @param initData Optional per-module init overrides for prewarm.
+     */
+    loadConfigurableItemById(itemId: RapiId, initData?: Partial<InitDataDefinition>): Promise<void>;
+    private _loadIntoConfigurator;
+    /**
+     * Load a static (non-configurable) item via the GLB viewer.
+     * @param staticItemId Catalog item id whose RAPI record has no `configuration`.
+     * @param initData Optional per-module init overrides for prewarm.
+     */
+    loadStaticItem(staticItemId: string, initData?: Partial<InitDataDefinition>): Promise<void>;
+    /**
+     * Temporary workaround:
+     * GLB-loaded scenes commonly contain hundreds of thousands of triangles
+     * (high-poly furniture/cars). With the default 1024² shadow map those
+     * triangles cast a self-shadow pattern back onto themselves that the
+     * shadow comparison can't resolve cleanly — it appears as a dense
+     * triangle/herringbone overlay covering every PBR-shaded surface
+     * (visible on flat-coloured car bodies, wood slats, etc.). The
+     * artifact is specific to headless's GL backend; in the browser the
+     * same scene renders fine.
+     *
+     * Walking the freshly-loaded scene and clearing `castShadow` on every
+     * mesh removes the cause of the acne while keeping `receiveShadow`,
+     * so static items still pick up shadows from external casters and
+     * full PBR direct-light shading is preserved.
+     */
+    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`:
+     *   - `component@…`           → not supported in headless, throws
+     *   - 0 colons (plan id)       → {@link loadPlan}
+     *   - 1 colon (item id)        → {@link loadStaticItem} if RAPI says the
+     *                                item has no `configuration`, otherwise
+     *                                {@link loadConfigurableItemById}
+     *   - 2+ colons (config id)    → {@link loadConfiguration}
+     *
+     * RAPI lookup failures during the item branch are propagated rather than
+     * swallowed — a transient 5xx routing the call to the wrong loader would
+     * surface as an unrelated downstream error.
+     */
+    loadObject(id: string, initData?: Partial<InitDataDefinition>): Promise<void>;
+    /**
+     * Load a plan into the planner.
+     * @param planId Plan id (no colons).
+     * @param initData Optional per-module init overrides for prewarm.
+     */
     loadPlan(planId: string, initData?: Partial<InitDataDefinition>): Promise<void>;
+    /**
+     * Serialises concurrent load operations using a promise-chain queue.
+     * Each call chains its task onto the previous queue tail so they run
+     * one at a time — listener mutations never overlap across an await.
+     * Errors in one task do not stall subsequent ones (the queue tail is
+     * always advanced in a settled state).
+     */
+    private _withLoader;
+    /**
+     * Wait for the active scene to fire its onReadyForRender callback —
+     * fired by each scene manager once `_itemsLoaded` (planner) /
+     * `loadConfiguration` (configurator) / `loadStaticItem` (GLB viewer)
+     * has finished constructing the scene and queued its materials. The
+     * callback is armed via {@link _armOnReadyForRender} *before* the load
+     * begins so synchronous firings (the GLB viewer does this) are still
+     * caught.
+     */
+    private _settleScene;
+    /**
+     * Pre-arms an onReadyForRender listener on the *global* callback (shared
+     * across configurator/planner/GLB viewer) so that it captures even
+     * synchronous firings during the upcoming load. Restores the previous
+     * callback after firing. Using the global callback rather than each
+     * module's api.callbacks is necessary because the GLB viewer only fires
+     * the global one ([glb-viewer-scene-manager.ts:355](packages/web-sdk/packages/glb-viewer-core/src/webgl/glb-viewer-scene-manager.ts:355)).
+     */
+    private _armOnReadyForRender;
+    private _onReadyForRenderArmed;
+    private _getPlannerListenerInfo;
+    private _getConfiguratorListenerInfo;
+    /**
+     * Export the active scene as GLB.
+     * @param outputPath Optional file path to write the buffer to.
+     * @returns The GLB bytes as an ArrayBuffer.
+     */
     exportGLB(outputPath?: string): Promise<ExportResult>;
+    /**
+     * Export the active scene as USDZ.
+     * @param outputPath Optional file path to write the buffer to.
+     * @returns The USDZ bytes as an ArrayBuffer.
+     */
     exportUSDZ(outputPath?: string): Promise<ExportResult>;
+    /**
+     * Returns the active top-level API (planner or configurator) based on what
+     * was last loaded. `loadPlan()` and `loadConfiguration()` are mutually
+     * exclusive — each one nulls the other's id — so this resolves cleanly.
+     */
+    private _getActiveApi;
+    /**
+     * Returns the scene manager of whichever module is active. All exporters
+     * route through here so plan-mode and config-mode share a single code path.
+     */
+    private _getActiveSceneManager;
     private _export;
+    /**
+     * Render a perspective screenshot preserving the scene background.
+     * @param outputPath Optional file path to write the PNG to.
+     * @param options ssaa, size, quality, rotationY.
+     * @returns Data URL of the rendered image.
+     */
     exportScreenshot(outputPath?: string, options?: ScreenshotExportOptions): Promise<{
         dataUrl: string;
     }>;
+    /**
+     * Render a framed perspective image of the scene.
+     * @param outputPath Optional file path to write the PNG to.
+     * @param options ssaa, size, showDimensions, rotationY.
+     * @returns Data URL plus final image dimensions.
+     */
     exportPerspectiveImage(outputPath?: string, options?: PerspectiveImageExportOptions): Promise<{
         dataUrl: string;
         width: number;
         height: number;
     }>;
+    /**
+     * Render a top-down image of the scene. Not supported for static items.
+     * @param outputPath Optional file path to write the PNG to.
+     * @param options ssaa, size, showDimensions.
+     * @returns Data URL plus final image dimensions.
+     */
     exportTopImage(outputPath?: string, options?: TopImageExportOptions): Promise<{
         dataUrl: string;
         width: number;
@@ -3478,6 +3731,7 @@ export declare class HeadlessRoomleSdk {
     private _ssaaDownscale;
     getConfiguratorApi(): RoomleConfigurator<readonly []>;
     getPlannerApi(): RoomlePlanner<readonly []>;
+    /** Destroy any prewarmed configurator, planner, and GLB viewer modules. */
     destroy(): Promise<void>;
     private _ensureInitialized;
 }
@@ -3539,6 +3793,7 @@ export declare interface HighlightHelper {
     checkPreviewVisibility(configuratorViewModel: ConfiguratorViewModel): void;
     areAllComponentsInFrustum(previews: RoomleComponent[]): boolean;
     onSelectionChanged(object: Object3D, componentIds: number[], callback?: () => void): void;
+    invalidate?(): void;
 }
 
 export declare type HiLoadObjectReason = (typeof HI_LOAD_OBJECT_REASON)[keyof typeof HI_LOAD_OBJECT_REASON];
@@ -3674,6 +3929,8 @@ export declare class IdbManager implements Context {
 export declare interface ImageExportOptions {
     /** Supersampling anti-aliasing factor. Defaults to 2. */
     ssaa?: number;
+    /** Output image size in pixels. Defaults to 1024. */
+    size?: number;
 }
 
 export declare type ImageKeysOnObject = 'perspectiveImage' | 'topImage';
@@ -3774,6 +4031,7 @@ export declare class InitData implements Context, Omit<InitDataDefinition, 'colo
     discardExternalObjectsWhenLoadingPlan?: boolean;
     featureFlags: FeatureFlags;
     meshRaycasting?: boolean;
+    defaultFloorMaterial?: number | string;
     mode?: Enumify_2<typeof CAMERA_TYPE>;
     edit?: boolean;
     moc?: boolean;
@@ -4056,6 +4314,11 @@ export declare interface KernelComponent {
     childAnimationTransformations: ComponentAnimationTransformation[];
 }
 
+export declare interface KernelComponentBounds {
+    boxForMeasurement: KernelCube;
+    geometryBounds: KernelAssembledObjectBounds;
+}
+
 export declare interface KernelComponentDocking {
     componentId: number;
     isRootComponent: boolean;
@@ -4125,6 +4388,7 @@ export declare interface KernelFloor extends KernelObject {
     area: number;
     material: KernelFloorMaterial;
     readonly parapetHeight: number;
+    readonly floorType: FloorType;
     getCenter: () => KernelVector3;
     getRandomPointInside: () => KernelVector3;
     getLabelPosition: () => KernelVector3;
@@ -4445,6 +4709,7 @@ export declare interface KernelWall extends KernelObject {
     readonly wallType: KernelEnum;
     readonly leftNormal: KernelVector3;
     readonly rightNormal: KernelVector3;
+    readonly edgeType: EdgeType;
     getAngle: () => number;
 }
 
@@ -4800,8 +5065,8 @@ export declare class MeasurementLinePlanElementViewModel extends PlanElementView
     private updatePointDraggableGeometry;
     getPoint1Draggable(): DraggableNode;
     getPoint2Draggable(): DraggableNode;
-    getPoint1DraggableBoundingBox(): Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material | Material[], Object3DEventMap>;
-    getPoint2DraggableBoundingBox(): Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material | Material[], Object3DEventMap>;
+    getPoint1DraggableBoundingBox(): Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material<MaterialEventMap> | Material<MaterialEventMap>[], Object3DEventMap>;
+    getPoint2DraggableBoundingBox(): Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material<MaterialEventMap> | Material<MaterialEventMap>[], Object3DEventMap>;
     hidePreviewBox(): void;
     selectPoint1Draggable(): void;
     selectPoint2Draggable(): void;
@@ -4865,7 +5130,7 @@ export declare class MeshGenerator implements Context {
     protected _assignItem(mesh: Mesh, catalogItemId: string): Promise<void>;
     setMaterialLoadedListener(fun: () => void): void;
     removeMaterialLoadedListener(): void;
-    protected _createMesh(runtimeComponentId: number, geometryId: string | null, geometry: BufferGeometry): Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material, Object3DEventMap>;
+    protected _createMesh(runtimeComponentId: number, geometryId: string | null, geometry: BufferGeometry): Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material<MaterialEventMap>, Object3DEventMap>;
     protected _getComponentMeshId(runtimeComponentId: number, geometryId: string): string;
 }
 
@@ -5091,11 +5356,8 @@ export declare class PartListParameterArray extends EmsArray<KernelPartListParam
 export declare class PartListParameterArray_2 extends EmsArray<KernelPartListParameter> {
 }
 
-export declare interface PerspectiveImageExportOptions extends ImageExportOptions {
-    /** Output image size in pixels. Defaults to 1024. */
-    size?: number;
+export declare interface PerspectiveImageExportOptions extends ImageExportOptions, RotatableImageExportOptions {
     showDimensions?: boolean;
-    rotationY?: number;
 }
 
 export declare interface PerspectiveOffsetCamera extends PerspectiveCamera, OffsetCamera {
@@ -5237,7 +5499,7 @@ export declare interface PlanInteractionHandler {
     addPlanObjects(list: KernelObjectPtrList, findFreeSpaceInPlan: boolean): PlanObject[];
     addPlanObjectFromItem(object: KernelObject, position: KernelVector3, type: number, findFreeSpaceInPlan: boolean): PlanObject;
     addOrUpdateExternalPlanObjects(serialzedConfiguration: string | string[], position: KernelVector3, rotationInRad: number, updateConfiguration: ExternalObjectLoadConfiguration, mergedGroupIds: string | string[]): PlanObject[];
-    createPreviewGeometryForAddOn(objectId: string, articleId: string, groupDefinitions: string, validContainerModules: ExternalValidContainerModule[]): void;
+    createPreviewGeometryForAddOn(objectId: string, objectConfiguration: string, articleId: string, groupDefinitions: string, validContainerModules: ExternalValidContainerModule[]): void;
     catalogItemLoaded(catalogItem: KernelCatalogItem): void;
     removeElement(planObject: KernelObject): void;
     removeObjectWithId(objectId: string): void;
@@ -5256,12 +5518,13 @@ export declare interface PlanInteractionHandler {
     undo(): void;
     redo(): void;
     isVectorPreviewModeEnabled(): boolean;
+    getDrawingMode(): DrawingMode;
     sCreateUnclosedSpaceEnabled(): boolean;
     beginDrawing(point: {
         x: number;
         y: number;
         z: number;
-    }, vectorPreviewMode: boolean, createUnclosedSpace: boolean): void;
+    }, drawingMode: DrawingMode, createUnclosedSpace: boolean): void;
     endDrawing(point: {
         x: number;
         y: number;
@@ -5310,6 +5573,8 @@ export declare interface PlanInteractionHandler {
     setWallRightMaterial(wall: KernelWall, material: KernelWallMaterial): void;
     setFloorMaterial(floor: KernelFloor, material: KernelFloorMaterial): void;
     setFloorLabelObject(floor: KernelFloor, serializedLabelObject: string): void;
+    setFloorType(floor: KernelFloor, floorType: FloorType): void;
+    setEdgeType(wall: KernelWall, edgeType: EdgeType): void;
     getContinuousDrawingManager(): ContinuousDrawingManager;
     setSnapFeedbackWhileDrawing(enabled: boolean): void;
     consistsOfMergedComponents(object: KernelObject): boolean;
@@ -5339,6 +5604,7 @@ export declare interface PlanInteractionHandler {
     objectToObjectSnapMode: SnapMode;
     dockWhenSnap: boolean;
     unDockOnMove: boolean;
+    enableTerrain: boolean;
 }
 
 export declare abstract class PlanMeasure extends PlanElement {
@@ -5457,6 +5723,11 @@ export declare class PlannerFpCameraBehaviour extends PlannerCameraBehaviour {
 }
 
 export declare interface PlannerInitData {
+    /**
+     * @description Sets the default floor material when creating a new plan or drawing.
+     * Can be a number (RGB color) or a string (material ID).
+     */
+    defaultFloorMaterial?: number | string;
     /**
      * @description Select with which camera mode to start initially.
      * usage: mode=2D
@@ -5475,14 +5746,17 @@ export declare interface PlannerInitData {
 }
 
 export declare class PlannerKernelAccess extends ConfiguratorKernelAccess {
-    private _kernelAccessCallback;
     private _roomlePlannerUiCallback;
     private _planInteractionHandler;
     private _plannerKernelCallbackListener;
+    private _plannerReadyListeners;
+    private _plannerReady;
+    addListener(listener: KernelAccessCallbackI): void;
+    removeListener(listener: KernelAccessCallbackI): void;
     private _homagIntelligence;
     get kernelContainer(): any;
     constructor(creator: string);
-    protected _loadSuccess(): void;
+    protected _loadSuccess(): Promise<void>;
     protected _loadError(): void;
     get homagIntelligence(): HomagIntelligence | null;
     setHomagIntelligence(homagIntelligence: HomagIntelligence | null): void;
@@ -5633,6 +5907,7 @@ export declare interface PlannerKernelContainer {
     WallMaterial: WallMaterial;
     Plan: Plan;
     DrawingType: DrawingType;
+    DrawingMode: DrawingMode;
     ResizingAnchor: ResizingAnchor;
     toResizingAnchor: (a: number) => ResizingAnchor;
     PlanInteractionHandler: PlanInteractionHandler;
@@ -5806,6 +6081,7 @@ export declare class PlannerSceneManager extends ConfiguratorSceneManager implem
     private _completelyLoaded;
     private _configurableItemGuard;
     private _planCompletelyLoadedGuard;
+    private _fullyReadyGuard;
     private _dragStartBounds;
     currentSelection: SelectionPayload | null;
     private _paperBackground;
@@ -5836,7 +6112,7 @@ export declare class PlannerSceneManager extends ConfiguratorSceneManager implem
     private _activateElement;
     planCleared(): void;
     planHistoryStateChanged(): void;
-    protected _getViewModel(): PlanViewModel;
+    get viewModel(): PlanViewModel;
     private _getDragPosition;
     private _hideAllMeasurementsNodeOnElementChange;
     private _onSelectionChange;
@@ -6588,6 +6864,7 @@ export declare interface PrepareImageOptions {
     showDimensions?: boolean;
     runtimeIds?: number[];
     rotationY?: number;
+    preserveSceneBackground?: boolean;
 }
 
 export declare interface PrepareImageOptionsPlanner extends PrepareImageOptions {
@@ -8265,6 +8542,7 @@ export declare class RoomleGLBViewer implements GlobalAPI, Context, ExternalEmbe
     getCameraOffset(): CanvasOffset;
     init(element: HTMLElement, initData?: InitDataDefinition): Promise<void>;
     private _initPromiseCallback;
+    getSceneManager(): GLBViewerSceneManager;
     /**
      * Remove the current glb from the scene if it exists
      */
@@ -8292,7 +8570,7 @@ export declare class RoomleGLBViewer implements GlobalAPI, Context, ExternalEmbe
      * @param sceneSettings
      */
     loadSceneSetting(sceneSettings: SceneSettings): Promise<void>;
-    preparePerspectiveImage(): Promise<Base64Image>;
+    preparePerspectiveImage(options?: PrepareImageOptions): Promise<Base64Image>;
     processRenderList(jsonString: string, width?: number, height?: number): void;
     setOverrides(initData: Partial<InitDataDefinition & GlobalInitDataDefinition> | InitData | undefined): void;
     updateSize(): void;
@@ -8467,7 +8745,6 @@ export declare class RoomlePlanner<P extends readonly PluginName[] = readonly []
     private _homagIntelligence;
     private _configuratorContext;
     private _domHelper;
-    private _kernelAccessCallback;
     private _plannerKernelAccess;
     private _rapiAccess;
     private _singlePromiseFactory;
@@ -8748,7 +9025,7 @@ export declare class RoomlePlanner<P extends readonly PluginName[] = readonly []
      * @param sceneEvents
      */
     setSceneEvents(sceneEvents: SceneEvents): void;
-    getExternalObjectSnapshot(): Promise<ExternalObjectSnapshotData | null>;
+    getExternalObjectSnapshot(requestData?: ExternalObjectSnapshotRequest): Promise<ExternalObjectSnapshotData | null>;
     saveExternalObjectSnapshot(parentPlanId?: RapiId): Promise<ExternalObjectSnapshotSaveResult | null>;
     private _getExternalObjectGroupsInPlan;
     private _savePlanSnapshotExternalObjects;
@@ -9276,9 +9553,12 @@ export declare class RoomleWebGPURenderer extends RoomleRenderer<WebGPURenderer>
     disableUiInteractionMode(): void;
     enableUiInteractionMode(): void;
     getQualityLevel(): QualityLevel;
+    setCameraType(cameraType: Enumify_2<typeof CAMERA_TYPE>): void;
+    switchToPlanner(renderMode: PlannerRenderMode): void;
     highlightObjects(selectedMeshes: Object3D[]): void;
     loadLutImages(_luts: LutImageDefinition[]): void;
     render(scene: Scene, camera: Camera): void;
+    private updateCameraProjectionMatrix;
     private assembleRenderPasses;
     setAutoQuality(_autoQuality: boolean): void;
     setCustomShadingParameters(_customShadingParameters: CustomShadingParameters | undefined, _customShadingParametersMoc: CustomShadingParameters | undefined): void;
@@ -9306,6 +9586,12 @@ export declare interface RoomLightSourceDistribution {
 export declare class RoomLightSourceDistributionArray extends EmsArray<RoomLightSourceDistribution> {
 }
 
+/** Mixin for image exports that frame the scene from a rotatable camera. */
+export declare interface RotatableImageExportOptions {
+    /** Camera rotation around the Y axis, in radians. */
+    rotationY?: number;
+}
+
 /**
  * Shared API between configurator and planner
  */
@@ -9436,7 +9722,7 @@ export declare abstract class SceneManager implements Context, LifeCycleCallback
     protected _orthographicOffsetCamera: OrthographicOffsetCamera | null;
     protected abstract createCameraControl(mode: Enumify_2<typeof CAMERA_TYPE>, offset: CanvasOffset): void;
     protected abstract _getInputManager(): InputManager;
-    protected get cameraBehaviour(): CameraBehaviour;
+    get cameraBehaviour(): CameraBehaviour;
     abstract sceneChanged(): void;
     abstract getBounds(): Box3 | null;
     abstract getGeometryBounds(): Box3 | null;
@@ -9465,7 +9751,7 @@ export declare abstract class SceneManager implements Context, LifeCycleCallback
     protected _renderWithoutShadowsAndAO(): void;
     protected _requestRender(): void;
     protected _shouldRenderUi(): boolean;
-    private _renderUi;
+    private _renderUiWithDepthPrepass;
     private _animateCamera;
     protected shouldClearShadowsAndAO(): boolean;
     protected _setupScene(_offset?: CanvasOffset, transparent?: boolean): Promise<void>;
@@ -9548,7 +9834,7 @@ export declare interface SceneSettings {
 
 export declare type SceneShadingType = Enumify<typeof SCENE_SHADING_TYPES>;
 
-export declare interface ScreenshotExportOptions extends ImageExportOptions {
+export declare interface ScreenshotExportOptions extends ImageExportOptions, RotatableImageExportOptions {
     /** JPEG quality (0–1). Defaults to 1. */
     quality?: number;
 }
@@ -9683,8 +9969,6 @@ export declare interface ToolsCoreContextCallback {
 }
 
 export declare interface TopImageExportOptions extends ImageExportOptions {
-    /** Output image size in pixels. Defaults to 1024. */
-    size?: number;
     showDimensions?: boolean;
 }
 
@@ -9897,6 +10181,11 @@ export declare interface UserAction {
     actionLabel: number;
 }
 
+export declare interface ValidContainerModules {
+    calculatedPosGroup: PosGroup;
+    validContainerModules: ExternalObjectValidContainerModules[];
+}
+
 export declare type ValuesFromObject<T> = T[keyof T];
 
 export declare class VariableArray extends EmsArray<KernelVariable> {
@@ -9970,7 +10259,7 @@ export declare interface WallExtensionType {
     ExtendBoth: EMSConstant;
 }
 
-export declare abstract class WallMaterial extends BaseMaterial {
+export declare class WallMaterial extends BaseMaterial {
 }
 
 export declare class WallPlanElementViewModel extends PlanElementViewModel {