@roomle/embedding-lib 5.12.0-alpha.2 → 5.12.0-alpha.4

package/docs/md/web/embedding/CHANGELOG.md

@@ -1,13 +1,7 @@
-## [5.12.0-alpha.2](https://github.com/roomle-dev/roomle-ui/compare/embedding-lib-v5.12.0-alpha.1...embedding-lib-v5.12.0-alpha.2) (2025-02-19)
-
-
-### Features
-
-* Construction elements adaptions "Switch product" ([5467043](https://github.com/roomle-dev/roomle-ui/commit/5467043bb66b97d6359b1b3bdf000ce9fb9c74f1))
-* **SDK:** upgrade to version 2.94.0-alpha.2 ([#1481](https://github.com/roomle-dev/roomle-ui/issues/1481)) ([26e115a](https://github.com/roomle-dev/roomle-ui/commit/26e115a0f75015620df66664ad63a5f521486fe1))
-* **SDK:** upgrade to version 2.94.0-alpha.3 ([#1485](https://github.com/roomle-dev/roomle-ui/issues/1485)) ([9f7d8d7](https://github.com/roomle-dev/roomle-ui/commit/9f7d8d7670daaa859527f4a5dfeaa88ffe1e53e8))
+## [5.12.0-alpha.4](https://github.com/roomle-dev/roomle-ui/compare/embedding-lib-v5.12.0-alpha.3...embedding-lib-v5.12.0-alpha.4) (2025-02-26)
 
 
 ### Bug Fixes
 
-* limit the left/right scroll amounts ([b22e679](https://github.com/roomle-dev/roomle-ui/commit/b22e67955356e00551932a250f41d0a4b2614a1c))
+* Trash icon is misplaced ([99a171e](https://github.com/roomle-dev/roomle-ui/commit/99a171e15318c3bf436aa06697693dffa2e3f8ad))
+* use sdk alpha version 2.94.0-alpha.13 ([7cb107d](https://github.com/roomle-dev/roomle-ui/commit/7cb107d927551f2cebb77706262ee8b7325d5858))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@roomle/embedding-lib",
-  "version": "5.12.0-alpha.2",
+  "version": "5.12.0-alpha.4",
   "description": "This is a small library which can be used to communicate with the Roomle Configurator",
   "type": "module",
   "main": "./roomle-embedding-lib.umd.js",
@@ -29,7 +29,7 @@
     "npm": "8.3.1"
   },
   "devDependencies": {
-    "@roomle/web-sdk": "2.94.0-alpha.3"
+    "@roomle/web-sdk": "2.94.0-alpha.13"
   },
   "repository": {
     "type": "git",

package/packages/common/src/utils/configurations.d.ts

@@ -0,0 +1,4 @@
+import { Nullable } from '../../../../src/common/utils/types';
+import { SelectionType } from '../../../../src/planner/store/planner-ui-state';
+
+export declare const isConfigurationSelected: (selectionType: Nullable<SelectionType>) => boolean;

package/src/common/components/drawer-layout/DrawerElement.vue.d.ts

@@ -67,8 +67,8 @@ declare const _default: __VLS_WithTemplateSlots<import('vue').DefineComponent<im
     element: any;
 }>>> & Readonly<{}>, {
     label: string;
-    element: CollectionViewElement<CollectionViewElementPossibleTypes>;
     type: string;
+    element: CollectionViewElement<CollectionViewElementPossibleTypes>;
     isLast: boolean;
     elemKey: string;
     hideBottomBorder: boolean;

package/src/common/composables/use-event-emitter-listener.d.ts

@@ -23,11 +23,13 @@ export declare const SIDEBAR_EVENTS: {
     readonly SET_SIDEBAR: "set-sidebar";
     readonly POP_SIDEBAR: "pop-sidebar";
     readonly TOGGLE_SIDEBAR: "toggle-sidebar";
+    readonly ACTIVATE_SIDEBAR: "activate-sidebar";
 };
 export interface SidebarEventTypes {
     [SIDEBAR_EVENTS.SET_SIDEBAR]: SidebarType;
     [SIDEBAR_EVENTS.POP_SIDEBAR]: void;
     [SIDEBAR_EVENTS.TOGGLE_SIDEBAR]: void;
+    [SIDEBAR_EVENTS.ACTIVATE_SIDEBAR]: SidebarType;
 }
 export declare const NOTIFICATION_EVENTS: {
     readonly SET_NOTIFICATION_STATE: "set-notification-state";

package/src/common/utils/types.d.ts

@@ -51,6 +51,7 @@ export declare const DEMO_SCOPES: Record<string, CustomTutorialScope>;
 export declare const DEMO_PLATFORMS: Record<string, CustomTutorialPlatform>;
 export declare const PLAN_OBJECT_TYPES: {
     readonly CONFIGURATION: "configuration";
+    readonly EXTERNAL_CONFIGURATION: "external-configuration";
     readonly STATIC: "static";
     readonly WALL: "wall";
     readonly WINDOW: "window";

package/src/configurator/embedding/exposed-api.d.ts

@@ -16,6 +16,7 @@ import { Libs } from '../plugins/libs-plugin';
 import { ExposedOverlays } from '../../common/components/utils/-utils/overlays';
 import { default as EventEmitter } from '../../common/business-logic/event-emitter';
 import { DragInOptions } from '../../../packages/embedding-lib/src/plugins/types';
+import { CustomViewSettingsForIframe, PossibleCustomViews } from './types';
 
 export declare class ExposedApi {
     private _sdk;
@@ -163,6 +164,8 @@ export declare class ExposedApi {
     disableEvents(): void;
     enableEvents(): void;
     toggleDrawer(): void;
+    activateCustomView(viewName: PossibleCustomViews, options: CustomViewSettingsForIframe<any>): void;
+    deactivateCustomView(viewName: PossibleCustomViews, options: CustomViewSettingsForIframe<any>): void;
     private _websiteReady;
     private _handleMessage;
     private _forwardSdkCallbacks;

package/src/configurator/embedding/exposed-callbacks.d.ts

@@ -80,4 +80,5 @@ export declare class ExposedCallbacks {
     onHideCustomView: (...[viewName, data]: CustomViewCallbackInfo) => void;
     onCollapseDrawer: () => void;
     onExpandDrawer: () => void;
+    onSidebarEvent: (...[type, params]: SidebarEventCallbackInfo) => void;
 }

package/src/configurator/embedding/types.d.ts

@@ -4,6 +4,7 @@ import { Enumify, MEASUREMENT_UNIT, MEASUREMENT_SYSTEM, Nullable, TutorialData }
 import { ViewTypeState } from '../../common/store/collection-view-state';
 import { KernelPartList } from '@roomle/web-sdk/lib/definitions/typings/kernel';
 import { INTERACTION_NOTIFICATIONS, NOTIFICATIONS } from '../../common/components/utils/-utils/notifications';
+import { SidebarEventTypes } from '../../common/composables/use-event-emitter-listener';
 
 export interface ThumbnailsSettings {
     collapsed: {
@@ -48,7 +49,8 @@ export declare enum UI_BUTTON {
     ADD_MEASUREMENT_LINE = "add_measurement_line",
     HELP_CENTER = "help_center",
     LOAD_PRODUCT = "load_product",
-    CONFIGURE_IN_ROOM = "configure_in_room"
+    CONFIGURE_IN_ROOM = "configure_in_room",
+    SWAP_PRODUCT = "swap_product"
 }
 export declare enum UI_ELEMENTS {
     BOTTOM_BAR = "bottom_bar",
@@ -118,6 +120,7 @@ export interface UiInitData extends InitDataDefinition, GlobalInitDataDefinition
         [UI_BUTTON.ADD_MEASUREMENT_LINE]?: boolean;
         [UI_BUTTON.HELP_CENTER]?: boolean;
         [UI_BUTTON.CONFIGURE_IN_ROOM]?: boolean;
+        [UI_BUTTON.SWAP_PRODUCT]?: boolean;
         [key: string]: boolean | undefined;
     };
     /**
@@ -520,4 +523,7 @@ export type CustomViewCallbackInfo = {
 export type PossibleCustomViewSettings = CustomViews[keyof CustomViews];
 export type PossibleCustomViews = keyof CustomViews;
 export type PossibleCustomViewsAndMain = PossibleCustomViews | 'main';
+export type SidebarEventCallbackInfo = {
+    [K in keyof SidebarEventTypes]: SidebarEventTypes[K] extends void ? [viewName: K] | [viewName: K, viewArgs: void] : [viewName: K, viewArgs: SidebarEventTypes[K]];
+}[keyof SidebarEventTypes];
 export {};

package/src/planner/business-logic/sdk-connector-planner.d.ts

@@ -47,7 +47,7 @@ export declare class SdkConnectorPlanner extends Connector {
     switch3D(): Promise<void>;
     switchFp(): Promise<void>;
     confirmRoom(switchTo2D: boolean): Promise<void>;
-    cancelSelection(): Promise<void>;
+    cancelSelection(reason: CancelSelectionReasons): Promise<void>;
     private _toggleFirstPersonControlsNotification;
     private popSidebar;
     onSelectionChange(_mode: string, objectType: Enumify<typeof PLAN_OBJECT_TYPES>, payload: SelectionPayload, payloadPromise: Promise<SelectionPayload>, planElementViewModel: PlanElementViewModel): void;

package/src/planner/components/overlays/rooms/DoorParametersSetting.vue.d.ts

@@ -2386,14 +2386,14 @@ declare const _default: import('vue').DefineComponent<import('vue').ExtractPropT
             isDesktop: {
                 type: PropType<boolean>;
             };
-            element: {
-                type: PropType<import('../../../../common/components/collection-view/-utils/types').CollectionViewElement<import('../../../../common/components/collection-view/-utils/types').CollectionViewElementPossibleTypes>>;
-                default: any;
-            };
             type: {
                 type: PropType<string>;
                 default: string;
             };
+            element: {
+                type: PropType<import('../../../../common/components/collection-view/-utils/types').CollectionViewElement<import('../../../../common/components/collection-view/-utils/types').CollectionViewElementPossibleTypes>>;
+                default: any;
+            };
             onSelect: {
                 type: PropType<(element: import('../../../../common/components/collection-view/-utils/types').CollectionViewElement<import('../../../../common/components/collection-view/-utils/types').CollectionViewElementPossibleTypes>) => void>;
             };
@@ -2465,14 +2465,14 @@ declare const _default: import('vue').DefineComponent<import('vue').ExtractPropT
             isDesktop: {
                 type: PropType<boolean>;
             };
-            element: {
-                type: PropType<import('../../../../common/components/collection-view/-utils/types').CollectionViewElement<import('../../../../common/components/collection-view/-utils/types').CollectionViewElementPossibleTypes>>;
-                default: any;
-            };
             type: {
                 type: PropType<string>;
                 default: string;
             };
+            element: {
+                type: PropType<import('../../../../common/components/collection-view/-utils/types').CollectionViewElement<import('../../../../common/components/collection-view/-utils/types').CollectionViewElementPossibleTypes>>;
+                default: any;
+            };
             onSelect: {
                 type: PropType<(element: import('../../../../common/components/collection-view/-utils/types').CollectionViewElement<import('../../../../common/components/collection-view/-utils/types').CollectionViewElementPossibleTypes>) => void>;
             };
@@ -2532,8 +2532,8 @@ declare const _default: import('vue').DefineComponent<import('vue').ExtractPropT
             };
         }>> & Readonly<{}>, {
             label: string;
-            element: import('../../../../common/components/collection-view/-utils/types').CollectionViewElement<import('../../../../common/components/collection-view/-utils/types').CollectionViewElementPossibleTypes>;
             type: string;
+            element: import('../../../../common/components/collection-view/-utils/types').CollectionViewElement<import('../../../../common/components/collection-view/-utils/types').CollectionViewElementPossibleTypes>;
             isLast: boolean;
             elemKey: string;
             hideBottomBorder: boolean;
@@ -2558,14 +2558,14 @@ declare const _default: import('vue').DefineComponent<import('vue').ExtractPropT
             isDesktop: {
                 type: PropType<boolean>;
             };
-            element: {
-                type: PropType<import('../../../../common/components/collection-view/-utils/types').CollectionViewElement<import('../../../../common/components/collection-view/-utils/types').CollectionViewElementPossibleTypes>>;
-                default: any;
-            };
             type: {
                 type: PropType<string>;
                 default: string;
             };
+            element: {
+                type: PropType<import('../../../../common/components/collection-view/-utils/types').CollectionViewElement<import('../../../../common/components/collection-view/-utils/types').CollectionViewElementPossibleTypes>>;
+                default: any;
+            };
             onSelect: {
                 type: PropType<(element: import('../../../../common/components/collection-view/-utils/types').CollectionViewElement<import('../../../../common/components/collection-view/-utils/types').CollectionViewElementPossibleTypes>) => void>;
             };
@@ -2625,8 +2625,8 @@ declare const _default: import('vue').DefineComponent<import('vue').ExtractPropT
             };
         }>> & Readonly<{}>, {}, {}, {}, {}, {
             label: string;
-            element: import('../../../../common/components/collection-view/-utils/types').CollectionViewElement<import('../../../../common/components/collection-view/-utils/types').CollectionViewElementPossibleTypes>;
             type: string;
+            element: import('../../../../common/components/collection-view/-utils/types').CollectionViewElement<import('../../../../common/components/collection-view/-utils/types').CollectionViewElementPossibleTypes>;
             isLast: boolean;
             elemKey: string;
             hideBottomBorder: boolean;
@@ -2648,14 +2648,14 @@ declare const _default: import('vue').DefineComponent<import('vue').ExtractPropT
         isDesktop: {
             type: PropType<boolean>;
         };
-        element: {
-            type: PropType<import('../../../../common/components/collection-view/-utils/types').CollectionViewElement<import('../../../../common/components/collection-view/-utils/types').CollectionViewElementPossibleTypes>>;
-            default: any;
-        };
         type: {
             type: PropType<string>;
             default: string;
         };
+        element: {
+            type: PropType<import('../../../../common/components/collection-view/-utils/types').CollectionViewElement<import('../../../../common/components/collection-view/-utils/types').CollectionViewElementPossibleTypes>>;
+            default: any;
+        };
         onSelect: {
             type: PropType<(element: import('../../../../common/components/collection-view/-utils/types').CollectionViewElement<import('../../../../common/components/collection-view/-utils/types').CollectionViewElementPossibleTypes>) => void>;
         };
@@ -2715,8 +2715,8 @@ declare const _default: import('vue').DefineComponent<import('vue').ExtractPropT
         };
     }>> & Readonly<{}>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, {
         label: string;
-        element: import('../../../../common/components/collection-view/-utils/types').CollectionViewElement<import('../../../../common/components/collection-view/-utils/types').CollectionViewElementPossibleTypes>;
         type: string;
+        element: import('../../../../common/components/collection-view/-utils/types').CollectionViewElement<import('../../../../common/components/collection-view/-utils/types').CollectionViewElementPossibleTypes>;
         isLast: boolean;
         elemKey: string;
         hideBottomBorder: boolean;

package/src/planner/components/overlays/rooms/FloorColor.vue.d.ts

@@ -1258,14 +1258,14 @@ declare const _default: import('vue').DefineComponent<import('vue').ExtractPropT
             isDesktop: {
                 type: PropType<boolean>;
             };
-            element: {
-                type: PropType<import('../../../../common/components/collection-view/-utils/types').CollectionViewElement<import('../../../../common/components/collection-view/-utils/types').CollectionViewElementPossibleTypes>>;
-                default: any;
-            };
             type: {
                 type: PropType<string>;
                 default: string;
             };
+            element: {
+                type: PropType<import('../../../../common/components/collection-view/-utils/types').CollectionViewElement<import('../../../../common/components/collection-view/-utils/types').CollectionViewElementPossibleTypes>>;
+                default: any;
+            };
             onSelect: {
                 type: PropType<(element: import('../../../../common/components/collection-view/-utils/types').CollectionViewElement<import('../../../../common/components/collection-view/-utils/types').CollectionViewElementPossibleTypes>) => void>;
             };
@@ -1337,14 +1337,14 @@ declare const _default: import('vue').DefineComponent<import('vue').ExtractPropT
             isDesktop: {
                 type: PropType<boolean>;
             };
-            element: {
-                type: PropType<import('../../../../common/components/collection-view/-utils/types').CollectionViewElement<import('../../../../common/components/collection-view/-utils/types').CollectionViewElementPossibleTypes>>;
-                default: any;
-            };
             type: {
                 type: PropType<string>;
                 default: string;
             };
+            element: {
+                type: PropType<import('../../../../common/components/collection-view/-utils/types').CollectionViewElement<import('../../../../common/components/collection-view/-utils/types').CollectionViewElementPossibleTypes>>;
+                default: any;
+            };
             onSelect: {
                 type: PropType<(element: import('../../../../common/components/collection-view/-utils/types').CollectionViewElement<import('../../../../common/components/collection-view/-utils/types').CollectionViewElementPossibleTypes>) => void>;
             };
@@ -1404,8 +1404,8 @@ declare const _default: import('vue').DefineComponent<import('vue').ExtractPropT
             };
         }>> & Readonly<{}>, {
             label: string;
-            element: import('../../../../common/components/collection-view/-utils/types').CollectionViewElement<import('../../../../common/components/collection-view/-utils/types').CollectionViewElementPossibleTypes>;
             type: string;
+            element: import('../../../../common/components/collection-view/-utils/types').CollectionViewElement<import('../../../../common/components/collection-view/-utils/types').CollectionViewElementPossibleTypes>;
             isLast: boolean;
             elemKey: string;
             hideBottomBorder: boolean;
@@ -1430,14 +1430,14 @@ declare const _default: import('vue').DefineComponent<import('vue').ExtractPropT
             isDesktop: {
                 type: PropType<boolean>;
             };
-            element: {
-                type: PropType<import('../../../../common/components/collection-view/-utils/types').CollectionViewElement<import('../../../../common/components/collection-view/-utils/types').CollectionViewElementPossibleTypes>>;
-                default: any;
-            };
             type: {
                 type: PropType<string>;
                 default: string;
             };
+            element: {
+                type: PropType<import('../../../../common/components/collection-view/-utils/types').CollectionViewElement<import('../../../../common/components/collection-view/-utils/types').CollectionViewElementPossibleTypes>>;
+                default: any;
+            };
             onSelect: {
                 type: PropType<(element: import('../../../../common/components/collection-view/-utils/types').CollectionViewElement<import('../../../../common/components/collection-view/-utils/types').CollectionViewElementPossibleTypes>) => void>;
             };
@@ -1497,8 +1497,8 @@ declare const _default: import('vue').DefineComponent<import('vue').ExtractPropT
             };
         }>> & Readonly<{}>, {}, {}, {}, {}, {
             label: string;
-            element: import('../../../../common/components/collection-view/-utils/types').CollectionViewElement<import('../../../../common/components/collection-view/-utils/types').CollectionViewElementPossibleTypes>;
             type: string;
+            element: import('../../../../common/components/collection-view/-utils/types').CollectionViewElement<import('../../../../common/components/collection-view/-utils/types').CollectionViewElementPossibleTypes>;
             isLast: boolean;
             elemKey: string;
             hideBottomBorder: boolean;
@@ -1520,14 +1520,14 @@ declare const _default: import('vue').DefineComponent<import('vue').ExtractPropT
         isDesktop: {
             type: PropType<boolean>;
         };
-        element: {
-            type: PropType<import('../../../../common/components/collection-view/-utils/types').CollectionViewElement<import('../../../../common/components/collection-view/-utils/types').CollectionViewElementPossibleTypes>>;
-            default: any;
-        };
         type: {
             type: PropType<string>;
             default: string;
         };
+        element: {
+            type: PropType<import('../../../../common/components/collection-view/-utils/types').CollectionViewElement<import('../../../../common/components/collection-view/-utils/types').CollectionViewElementPossibleTypes>>;
+            default: any;
+        };
         onSelect: {
             type: PropType<(element: import('../../../../common/components/collection-view/-utils/types').CollectionViewElement<import('../../../../common/components/collection-view/-utils/types').CollectionViewElementPossibleTypes>) => void>;
         };
@@ -1587,8 +1587,8 @@ declare const _default: import('vue').DefineComponent<import('vue').ExtractPropT
         };
     }>> & Readonly<{}>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, {
         label: string;
-        element: import('../../../../common/components/collection-view/-utils/types').CollectionViewElement<import('../../../../common/components/collection-view/-utils/types').CollectionViewElementPossibleTypes>;
         type: string;
+        element: import('../../../../common/components/collection-view/-utils/types').CollectionViewElement<import('../../../../common/components/collection-view/-utils/types').CollectionViewElementPossibleTypes>;
         isLast: boolean;
         elemKey: string;
         hideBottomBorder: boolean;