@roomle/embedding-lib 4.35.0 → 4.38.0

package/types/src/configurator/business-logic/sdk-connector.d.ts

@@ -18,6 +18,7 @@ import { RapiConfigurationEnhanced, RapiPlan } from '@roomle/web-sdk/lib/definit
 import RoomleConfigurator from '@roomle/web-sdk/lib/definitions/configurator-core/src/roomle-configurator';
 import { UiCallbacks } from '@/configurator/business-logic/ui-callback';
 import { Base64Image } from '@roomle/web-sdk/lib/definitions/common-core/src/common-interfaces';
+import RoomlePlannerUiCallback from '@roomle/web-sdk/lib/definitions/planner-core/src/roomle-planner-ui-callback';
 export declare enum SDK_MODULES {
     VIEWER = 0,
     CONFIGURATOR = 1,
@@ -34,11 +35,8 @@ export interface PartlistResponse {
     partList: KernelPartList;
 }
 export declare const getSelectableEntry: (selected: Selectable, data: Selectable[]) => Nullable<Selectable>;
-export declare const REGISTERED_CALLBACKS: Map<keyof ConfiguratorUiCallbacks, boolean>;
-export interface Connector {
-    readonly api: any;
-    init(sdkWrapper: RoomleSdkWrapper, element: HTMLElement, initData: UiInitData): Promise<void>;
-}
+export declare const REGISTERED_CALLBACKS: Map<keyof CallbackApi, boolean>;
+export declare type CallbackApi = ConfiguratorUiCallbacks & RoomlePlannerUiCallback;
 export declare class SdkConnector {
     protected loadInProgress: boolean;
     protected someLoadDone: boolean;
@@ -98,8 +96,7 @@ export declare class SdkConnector {
     }): Promise<null>;
     loadConfiguration(configurationId: string, initData?: UiInitData | undefined): Promise<Nullable<LoadResponse>>;
     loadComponent(componentId: string, initData?: UiInitData | undefined): Promise<Nullable<LoadResponse>>;
-    loadSelectedPlanObject(): Promise<Nullable<LoadResponse>>;
-    loadPlanObjectId(configurationId: string, planObjectId: number): Promise<Nullable<LoadResponse>>;
+    loadSelectedPlanObject(): Promise<void>;
     loadConfigurationString(configurationString: string, initData?: UiInitData | undefined): Promise<Nullable<LoadResponse>>;
     loadConfigurableItem(configurableItemId: string, initData?: UiInitData | undefined): Promise<Nullable<LoadResponse>>;
     isIdAGlb(id: string): Promise<boolean>;

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

@@ -7,9 +7,9 @@ import { StoreState } from '@/common/store';
 import { Nullable } from '@/common/utils/types';
 import { Analytics } from '@/common/plugins/analytics';
 import RoomleGLBViewer from '@roomle/web-sdk/lib/definitions/glb-viewer-core/src/roomle-glb-viewer';
-import RoomlePlanner from '@roomle/web-sdk/lib/definitions/planner-core/src/roomle-planner';
 import { GlobalCallback } from '@roomle/web-sdk/lib/definitions/common-core/src/services/global-callback';
 import { Position3 } from '@roomle/web-sdk/lib/definitions/common-core/src/common-interfaces';
+import RoomlePlanner from '@roomle/web-sdk/lib/definitions/planner-core/src/roomle-planner';
 export declare class ExposedApi {
     private _sdk;
     private _exposedCallbacks;
@@ -87,4 +87,5 @@ export declare class ExposedApi {
     private _websiteReady;
     private _handleMessage;
     private _forwardSdkCallbacks;
+    private _instanceOfRoomlePlanner;
 }

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

@@ -1,5 +1,5 @@
 import { Base64Image } from '@roomle/web-sdk/lib/definitions/common-core/src/common-interfaces';
-import { KernelPartList } from '@roomle/web-sdk/lib/definitions/typings/kernel';
+import { KernelPartList, UiPlanObject } from '@roomle/web-sdk/lib/definitions/typings/kernel';
 import { RapiConfigurationEnhanced } from '@roomle/web-sdk/lib/definitions/typings/rapi-types';
 import { UI_BUTTON } from '@/configurator/embedding/types';
 import { Nullable } from '@/common/utils/types';
@@ -37,4 +37,10 @@ export declare class ExposedCallbacks {
      */
     onButtonClicked: (name: UI_BUTTON) => Promise<boolean> | boolean | void;
     onRequestPlan: (planId: string, image: Base64Image, items: any[]) => void;
+    /**
+     * Gets called if a plan object gets added, changed or removed
+     * Only the move of plan object does NOT trigger this function
+     * @param objects
+     */
+    onPlanUpdate: (objects: UiPlanObject[]) => void;
 }

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

@@ -1,4 +1,3 @@
-import { Connector } from '@/configurator/business-logic/sdk-connector';
 import { Nullable } from '@/common/utils/types';
 import { Store } from 'vuex';
 import { StoreState } from '@/common/store';
@@ -8,7 +7,8 @@ import { UiInitData } from '@/configurator/embedding/types';
 import RoomlePlanner from '@roomle/web-sdk/lib/definitions/planner-core/src/roomle-planner';
 import { RapiId, RapiPlan } from '@roomle/web-sdk/lib/definitions/typings/rapi-types';
 import { Base64Image } from '@roomle/web-sdk/lib/definitions/common-core/src/common-interfaces';
-export declare class SdkConnectorPlanner implements Connector {
+import { Connector } from '@/common/business-logic/connector';
+export declare class SdkConnectorPlanner extends Connector {
     private _planner;
     private _initWaiters;
     private _store;
@@ -19,7 +19,7 @@ export declare class SdkConnectorPlanner implements Connector {
     constructor(store: Store<StoreState>, analytics?: Nullable<Analytics>);
     get api(): Promise<RoomlePlanner>;
     init(sdkWrapper: RoomleSdkWrapper, element: HTMLElement, initData: UiInitData): Promise<void>;
-    initPlanner(planner: RoomlePlanner): void;
+    initPlanner(planner: RoomlePlanner): Promise<void>;
     loadPlan(id: RapiId): Promise<void>;
     loadPlanBasedOnObjectId(id: RapiId): Promise<void>;
     onSelectionCancel(): void;

package/types/src/planner/store/planner-ui-state.d.ts

@@ -18,7 +18,6 @@ export interface PlannerUiState extends SharedUiState {
     lastWalls: KernelWall[];
 }
 export declare enum PLANNER_UI_STATE_MUTATIONS {
-    SET_SELECTION_PAYLOAD = "PLANNER_UI_STATE_setSelectionPayload",
     SET_SELECTION = "PLANNER_UI_STATE_setSelection",
     SET_IS_LANDSCAPE = "PLANNER_UI_STATE_setIsLandscape",
     SET_INTERACTIONS_EXPANDED = "PLANNER_UI_STATE_setInteractionsExpanded",
@@ -40,7 +39,9 @@ export declare enum PLANNER_UI_STATE_MUTATIONS {
 export declare enum PLANNER_UI_STATE_ACTIONS {
     SELECT_VIEW_MODE = "PLANNER_UI_STATE_SELECT_VIEW_MODE",
     SET_INTERACTIONS_EXPANDED = "PLANNER_UI_STATE_SET_INTERACTIONS_EXPANDED",
-    DESELECT_SIDEBAR_ACTION_BUTTONS = "DESELECT_SIDEBAR_ACTION_BUTTONS"
+    DESELECT_SIDEBAR_ACTION_BUTTONS = "DESELECT_SIDEBAR_ACTION_BUTTONS",
+    CLEAR_AND_CLOSE_SIDEBAR = "CLEAR_AND_CLOSE_SIDEBAR",
+    SET_SELECTION_PAYLOAD = "PLANNER_UI_STATE_setSelectionPayload"
 }
 export declare enum PLANNER_UI_STATE_GETTERS {
     CATALOG_ROOT_TAG = "PLANNER_UI_STATE_CATALOG_ROOT_TAG",

package/types/src/planner/utils/planner-sidebar.d.ts

@@ -4,7 +4,6 @@ import { StoreState } from '@/common/store';
 import { SdkConnector } from '@/configurator/business-logic/sdk-connector';
 import { RapiConfiguration, RapiItem } from '@roomle/web-sdk/lib/definitions/typings/rapi-types';
 export interface PlannerSidebarState {
-    welcome: boolean;
     catalog: boolean;
     productList: boolean;
     partList: boolean;

package/types/src/viewer/business-logic/sdk-connector-viewer.d.ts

@@ -1,4 +1,3 @@
-import { Connector } from '@/configurator/business-logic/sdk-connector';
 import { Nullable } from '@/common/utils/types';
 import { Store } from 'vuex';
 import { StoreState } from '@/common/store';
@@ -6,7 +5,8 @@ import { Analytics } from '@/common/plugins/analytics';
 import { RoomleSdkWrapper } from '@/configurator/business-logic/roomle-sdk-wrapper';
 import { UiInitData } from '@/configurator/embedding/types';
 import RoomleGLBViewer from '@roomle/web-sdk/lib/definitions/glb-viewer-core/src/roomle-glb-viewer';
-export declare class SdkConnectorViewer implements Connector {
+import { Connector } from '@/common/business-logic/connector';
+export declare class SdkConnectorViewer extends Connector {
     private _viewer;
     private _initWaiters;
     private _store;

package/types/tests/helpers/data/part-list.d.ts

@@ -108,3 +108,19 @@ export declare const USM_PART_LIST: ({
     currencySymbol: null;
     parameters: never[];
 })[];
+export declare const PART_LABEL_TESTING: {
+    id: string;
+    parameters: {
+        key: string;
+        label: string;
+        type: string;
+        enabled: boolean;
+        visible: boolean;
+        visibleInPartList: boolean;
+        value: string;
+        valueLabel: string;
+        valueObjects: {
+            value: boolean;
+        }[];
+    }[];
+};

package/types/tests/integration/planner/components/SelectionPreview.spec.d.ts

@@ -0,0 +1 @@
+export {};