@roomle/embedding-lib 4.36.0 → 4.39.0

package/types/index.d.ts

@@ -197,7 +197,7 @@ declare module "configurator/embedding/types" {
 }
 declare module "configurator/embedding/exposed-callbacks" {
     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";
@@ -235,6 +235,12 @@ declare module "configurator/embedding/exposed-callbacks" {
          */
         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;
     }
 }
 declare module "configurator/store/core-state" {
@@ -453,7 +459,6 @@ declare module "planner/utils/planner-sidebar" {
     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;
@@ -490,7 +495,6 @@ declare module "planner/store/planner-ui-state" {
         lastWalls: KernelWall[];
     }
     export 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",
@@ -512,7 +516,9 @@ declare module "planner/store/planner-ui-state" {
     export 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 enum PLANNER_UI_STATE_GETTERS {
         CATALOG_ROOT_TAG = "PLANNER_UI_STATE_CATALOG_ROOT_TAG",
@@ -528,11 +534,13 @@ declare module "common/store/collection-view-state" {
     import { Nullable } from "common/utils/types";
     import { CollectionViewElement } from "common/components/collection-view/-utils/types";
     import { StoreState } from "common/store/index";
+    export type ViewTypeState = 'listView' | 'gridViewSmall' | 'gridViewBig';
     export interface GridViewUiState {
         filter: string[];
-        showAllAsList: boolean;
         search: Nullable<string>;
         userInitiatedSearch: boolean;
+        viewType: ViewTypeState;
+        hasGroupLabel: boolean;
     }
     export interface CollectionViewUiState {
         selected: Nullable<CollectionViewElement>;
@@ -540,6 +548,7 @@ declare module "common/store/collection-view-state" {
         gridView: GridViewUiState;
     }
     export const getInitialCollectionViewState: () => CollectionViewUiState;
+    export const getInitialViewType: () => ViewTypeState;
     export enum COLLECTION_VIEW_STATE_MUTATIONS {
         ELEMENT_EXPANDED = "CV_ELEMENT_EXPANDED",
         SET_SELECTED_ELEMENT = "CV_SET_SELECTED_ELEMENT",
@@ -547,9 +556,10 @@ declare module "common/store/collection-view-state" {
     }
     export enum GRID_VIEW_STATE_MUTATIONS {
         SET_SEARCH = "GV_SET_SEARCH",
-        TOGGLE_LIST_DISPLAY_TYPE = "GV_TOGGLE_LIST_DISPLAY_TYPE",
         TOGGLE_FILTER = "GV_TOGGLE_FILTER",
-        SET_USER_INITIATED_SEARCH = "GV_SET_USER_INITIATED_SEARCH"
+        SET_USER_INITIATED_SEARCH = "GV_SET_USER_INITIATED_SEARCH",
+        SET_VIEW_TYPE = "SET_VIEW_TYPE",
+        SET_HAS_GROUP_LABEL = "SET_HAS_GROUP_LABEL"
     }
     interface MuationPayload<T, V> {
         state: T;
@@ -741,7 +751,6 @@ declare module "common/store/index" {
         SET_IS_IN_IFRAME: COMMON_UI_STATE_MUTATIONS.SET_IS_IN_IFRAME;
         SET_IS_VIEW_ONLY: COMMON_UI_STATE_MUTATIONS.SET_IS_VIEW_ONLY;
         SET_LAST_REQUESTED_ID: COMMON_UI_STATE_MUTATIONS.SET_LAST_REQUESTED_ID;
-        SET_SELECTION_PAYLOAD: PLANNER_UI_STATE_MUTATIONS.SET_SELECTION_PAYLOAD;
         SET_SELECTION: PLANNER_UI_STATE_MUTATIONS.SET_SELECTION;
         SET_IS_LANDSCAPE: PLANNER_UI_STATE_MUTATIONS.SET_IS_LANDSCAPE;
         SET_INTERACTIONS_EXPANDED: PLANNER_UI_STATE_MUTATIONS.SET_INTERACTIONS_EXPANDED;
@@ -942,6 +951,7 @@ declare module "configurator/business-logic/roomle-sdk-wrapper" {
     import { GlobalInitDataDefinition } from '@roomle/web-sdk/lib/definitions/common-core/src/utils/shims';
     import { Planner } from '@roomle/web-sdk/lib/definitions/planner-core/src/planner';
     import { GlobalCallback } from '@roomle/web-sdk/lib/definitions/common-core/src/services/global-callback';
+    import RoomleConfigurator from '@roomle/web-sdk/lib/definitions/configurator-core/src/roomle-configurator';
     /**
      * We use this class in a plugin so we
      * can rely on DI to change it during testing
@@ -953,6 +963,7 @@ declare module "configurator/business-logic/roomle-sdk-wrapper" {
         private _currentInstance;
         get hasPlanner(): boolean;
         getConfigurator(element: HTMLElement, initData?: UiInitData): Promise<Configurator>;
+        getConfiguratorApi(element: HTMLElement, initData?: UiInitData): Promise<RoomleConfigurator>;
         getGlbViewer(element: HTMLElement, initData?: UiInitData): Promise<GlbViewer>;
         getPlanner(element: HTMLElement, initData?: UiInitData): Promise<Planner>;
         getRapiAccess(): Promise<RapiAccess>;
@@ -988,19 +999,28 @@ declare module "configurator/business-logic/ui-callback" {
         onSelectionCancel: () => any;
     }
 }
+declare module "common/business-logic/connector" {
+    import { RoomleSdkWrapper } from "configurator/business-logic/roomle-sdk-wrapper";
+    import { UiInitData } from "configurator/embedding/types";
+    import { CallbackApi } from "configurator/business-logic/sdk-connector";
+    export abstract class Connector {
+        abstract readonly api: Promise<any>;
+        abstract init(sdkWrapper: RoomleSdkWrapper, element: HTMLElement, initData: UiInitData): Promise<void>;
+        addCallback<K extends keyof CallbackApi>(key: K, fun: CallbackApi[K], allowMultiple?: boolean): Promise<void>;
+    }
+}
 declare module "configurator/business-logic/sdk-connector-configurator" {
     import RoomleConfigurator from '@roomle/web-sdk/lib/definitions/configurator-core/src/roomle-configurator';
     import { Nullable } from "common/utils/types";
-    import { Connector } from "configurator/business-logic/sdk-connector";
     import { UiInitData } from "configurator/embedding/types";
     import { StoreState } from "common/store/index";
     import { KernelParameter } from '@roomle/web-sdk/lib/definitions/typings/kernel';
-    import ConfiguratorUiCallbacks from '@roomle/web-sdk/lib/definitions/configurator-core/src/services/configurator-ui-callback';
     import { Store } from 'vuex';
     import { RoomleSdkWrapper } from "configurator/business-logic/roomle-sdk-wrapper";
     import { Analytics } from "common/plugins/analytics";
     import { UiCallbacks } from "configurator/business-logic/ui-callback";
-    export class SdkConnectorConfigurator implements Connector {
+    import { Connector } from "common/business-logic/connector";
+    export class SdkConnectorConfigurator extends Connector {
         private _configurator;
         private _initWaiters;
         private _store;
@@ -1009,8 +1029,7 @@ declare module "configurator/business-logic/sdk-connector-configurator" {
         constructor(store: Store<StoreState>, analytics?: Nullable<Analytics>);
         get api(): Promise<RoomleConfigurator>;
         init(sdkWrapper: RoomleSdkWrapper, element: HTMLElement, initData: UiInitData): Promise<void>;
-        initConfigurator(configurator: RoomleConfigurator): void;
-        addCallback<K extends keyof ConfiguratorUiCallbacks>(key: K, fun: ConfiguratorUiCallbacks[K], allowMultiple?: boolean): void;
+        initConfigurator(configurator: RoomleConfigurator): Promise<void>;
         setParameter(parameter: KernelParameter, value: string, isRaw?: boolean): Promise<void>;
         setPrice(currencySymbol: string, price: number): void;
         addUiCallback(listener: UiCallbacks): void;
@@ -1022,7 +1041,6 @@ declare module "configurator/business-logic/sdk-connector-configurator" {
     }
 }
 declare module "viewer/business-logic/sdk-connector-viewer" {
-    import { Connector } from "configurator/business-logic/sdk-connector";
     import { Nullable } from "common/utils/types";
     import { Store } from 'vuex';
     import { StoreState } from "common/store/index";
@@ -1030,7 +1048,8 @@ declare module "viewer/business-logic/sdk-connector-viewer" {
     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 class SdkConnectorViewer implements Connector {
+    import { Connector } from "common/business-logic/connector";
+    export class SdkConnectorViewer extends Connector {
         private _viewer;
         private _initWaiters;
         private _store;
@@ -1050,7 +1069,6 @@ declare module "common/utils/plan" {
     export const EMPTY_PLAN = "<plan version=\"2\"><walls><nodes/><edges/></walls><planobjects/><texters/><measures/><floors/><transparency><layers/></transparency></plan>";
 }
 declare module "planner/business-logic/sdk-connector-planner" {
-    import { Connector } from "configurator/business-logic/sdk-connector";
     import { Nullable } from "common/utils/types";
     import { Store } from 'vuex';
     import { StoreState } from "common/store/index";
@@ -1060,7 +1078,8 @@ declare module "planner/business-logic/sdk-connector-planner" {
     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 class SdkConnectorPlanner implements Connector {
+    import { Connector } from "common/business-logic/connector";
+    export class SdkConnectorPlanner extends Connector {
         private _planner;
         private _initWaiters;
         private _store;
@@ -1071,7 +1090,7 @@ declare module "planner/business-logic/sdk-connector-planner" {
         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;
@@ -1100,6 +1119,7 @@ declare module "configurator/business-logic/sdk-connector" {
     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 enum SDK_MODULES {
         VIEWER = 0,
         CONFIGURATOR = 1,
@@ -1116,11 +1136,8 @@ declare module "configurator/business-logic/sdk-connector" {
         partList: KernelPartList;
     }
     export const getSelectableEntry: (selected: Selectable, data: Selectable[]) => Nullable<Selectable>;
-    export const REGISTERED_CALLBACKS: Map<keyof ConfiguratorUiCallbacks, boolean>;
-    export interface Connector {
-        readonly api: any;
-        init(sdkWrapper: RoomleSdkWrapper, element: HTMLElement, initData: UiInitData): Promise<void>;
-    }
+    export const REGISTERED_CALLBACKS: Map<keyof CallbackApi, boolean>;
+    export type CallbackApi = ConfiguratorUiCallbacks & RoomlePlannerUiCallback;
     export class SdkConnector {
         protected loadInProgress: boolean;
         protected someLoadDone: boolean;
@@ -1180,8 +1197,7 @@ declare module "configurator/business-logic/sdk-connector" {
         }): Promise<null>;
         loadConfiguration(configurationId: string, initData?: UiInitData | undefined): Promise<Nullable<LoadResponse>>;
         loadComponent(componentId: string, initData?: UiInitData | undefined): Promise<Nullable<LoadResponse>>;
-        loadSelectedPlanObject(): Promise<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>;
@@ -1234,9 +1250,9 @@ declare module "configurator/embedding/exposed-api" {
     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 class ExposedApi {
         private _sdk;
         private _exposedCallbacks;
@@ -1314,6 +1330,7 @@ declare module "configurator/embedding/exposed-api" {
         private _websiteReady;
         private _handleMessage;
         private _forwardSdkCallbacks;
+        private _instanceOfRoomlePlanner;
     }
 }
 declare module "common/utils/merge" {

package/types/src/common/business-logic/connector.d.ts

@@ -0,0 +1,8 @@
+import { RoomleSdkWrapper } from '@/configurator/business-logic/roomle-sdk-wrapper';
+import { UiInitData } from '@/configurator/embedding/types';
+import { CallbackApi } from '@/configurator/business-logic/sdk-connector';
+export declare abstract class Connector {
+    abstract readonly api: Promise<any>;
+    abstract init(sdkWrapper: RoomleSdkWrapper, element: HTMLElement, initData: UiInitData): Promise<void>;
+    addCallback<K extends keyof CallbackApi>(key: K, fun: CallbackApi[K], allowMultiple?: boolean): Promise<void>;
+}

package/types/src/common/store/collection-view-state.d.ts

@@ -2,11 +2,13 @@ import { Module } from 'vuex';
 import { Nullable } from '@/common/utils/types';
 import { CollectionViewElement } from '@/common/components/collection-view/-utils/types';
 import { StoreState } from '@/common/store';
+export declare type ViewTypeState = 'listView' | 'gridViewSmall' | 'gridViewBig';
 export interface GridViewUiState {
     filter: string[];
-    showAllAsList: boolean;
     search: Nullable<string>;
     userInitiatedSearch: boolean;
+    viewType: ViewTypeState;
+    hasGroupLabel: boolean;
 }
 export interface CollectionViewUiState {
     selected: Nullable<CollectionViewElement>;
@@ -14,6 +16,7 @@ export interface CollectionViewUiState {
     gridView: GridViewUiState;
 }
 export declare const getInitialCollectionViewState: () => CollectionViewUiState;
+export declare const getInitialViewType: () => ViewTypeState;
 export declare enum COLLECTION_VIEW_STATE_MUTATIONS {
     ELEMENT_EXPANDED = "CV_ELEMENT_EXPANDED",
     SET_SELECTED_ELEMENT = "CV_SET_SELECTED_ELEMENT",
@@ -21,9 +24,10 @@ export declare enum COLLECTION_VIEW_STATE_MUTATIONS {
 }
 export declare enum GRID_VIEW_STATE_MUTATIONS {
     SET_SEARCH = "GV_SET_SEARCH",
-    TOGGLE_LIST_DISPLAY_TYPE = "GV_TOGGLE_LIST_DISPLAY_TYPE",
     TOGGLE_FILTER = "GV_TOGGLE_FILTER",
-    SET_USER_INITIATED_SEARCH = "GV_SET_USER_INITIATED_SEARCH"
+    SET_USER_INITIATED_SEARCH = "GV_SET_USER_INITIATED_SEARCH",
+    SET_VIEW_TYPE = "SET_VIEW_TYPE",
+    SET_HAS_GROUP_LABEL = "SET_HAS_GROUP_LABEL"
 }
 interface MuationPayload<T, V> {
     state: T;

package/types/src/common/store/index.d.ts

@@ -26,7 +26,6 @@ export declare const MUTATIONS: {
     SET_IS_IN_IFRAME: COMMON_UI_STATE_MUTATIONS.SET_IS_IN_IFRAME;
     SET_IS_VIEW_ONLY: COMMON_UI_STATE_MUTATIONS.SET_IS_VIEW_ONLY;
     SET_LAST_REQUESTED_ID: COMMON_UI_STATE_MUTATIONS.SET_LAST_REQUESTED_ID;
-    SET_SELECTION_PAYLOAD: PLANNER_UI_STATE_MUTATIONS.SET_SELECTION_PAYLOAD;
     SET_SELECTION: PLANNER_UI_STATE_MUTATIONS.SET_SELECTION;
     SET_IS_LANDSCAPE: PLANNER_UI_STATE_MUTATIONS.SET_IS_LANDSCAPE;
     SET_INTERACTIONS_EXPANDED: PLANNER_UI_STATE_MUTATIONS.SET_INTERACTIONS_EXPANDED;

package/types/src/common/utils/touch-drag.d.ts

@@ -1,5 +1,7 @@
 import { Nullable } from '@/common/utils/types';
 export declare const TOUCH_DRAG_TIMEOUT = 500;
+export declare const TOUCH_DRAG_DELAY = 75;
+export declare const TOUCH_DRAG_EPSILON = 10;
 export interface TouchDragCallbacks {
     onTouchDragStart: (payload: Nullable<any>, event: TouchEvent) => void;
 }
@@ -8,12 +10,15 @@ export declare class TouchDrag<Payload> {
     private _onTouchDragStart;
     private _payload;
     private _delay;
+    private _firstTouch;
+    private _lastTouch;
     constructor(payload: Payload, { onTouchDragStart }: TouchDragCallbacks, options?: {
         delay?: number;
     });
     onTouchStart(event: TouchEvent): void;
     onTouchEnd(): void;
-    onTouchMove(_event: TouchEvent): void;
+    onTouchMove(event: TouchEvent): void;
     private _clearTimeout;
     private _resetTouches;
+    private _checkXDistance;
 }

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

@@ -6,6 +6,7 @@ import { UiInitData } from '@/configurator/embedding/types';
 import { GlobalInitDataDefinition } from '@roomle/web-sdk/lib/definitions/common-core/src/utils/shims';
 import { Planner } from '@roomle/web-sdk/lib/definitions/planner-core/src/planner';
 import { GlobalCallback } from '@roomle/web-sdk/lib/definitions/common-core/src/services/global-callback';
+import RoomleConfigurator from '@roomle/web-sdk/lib/definitions/configurator-core/src/roomle-configurator';
 /**
  * We use this class in a plugin so we
  * can rely on DI to change it during testing
@@ -17,6 +18,7 @@ export declare class RoomleSdkWrapper {
     private _currentInstance;
     get hasPlanner(): boolean;
     getConfigurator(element: HTMLElement, initData?: UiInitData): Promise<Configurator>;
+    getConfiguratorApi(element: HTMLElement, initData?: UiInitData): Promise<RoomleConfigurator>;
     getGlbViewer(element: HTMLElement, initData?: UiInitData): Promise<GlbViewer>;
     getPlanner(element: HTMLElement, initData?: UiInitData): Promise<Planner>;
     getRapiAccess(): Promise<RapiAccess>;

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

@@ -1,15 +1,14 @@
 import RoomleConfigurator from '@roomle/web-sdk/lib/definitions/configurator-core/src/roomle-configurator';
 import { Nullable } from '@/common/utils/types';
-import { Connector } from '@/configurator/business-logic/sdk-connector';
 import { UiInitData } from '@/configurator/embedding/types';
 import { StoreState } from '@/common/store';
 import { KernelParameter } from '@roomle/web-sdk/lib/definitions/typings/kernel';
-import ConfiguratorUiCallbacks from '@roomle/web-sdk/lib/definitions/configurator-core/src/services/configurator-ui-callback';
 import { Store } from 'vuex';
 import { RoomleSdkWrapper } from '@/configurator/business-logic/roomle-sdk-wrapper';
 import { Analytics } from '@/common/plugins/analytics';
 import { UiCallbacks } from '@/configurator/business-logic/ui-callback';
-export declare class SdkConnectorConfigurator implements Connector {
+import { Connector } from '@/common/business-logic/connector';
+export declare class SdkConnectorConfigurator extends Connector {
     private _configurator;
     private _initWaiters;
     private _store;
@@ -18,8 +17,7 @@ export declare class SdkConnectorConfigurator implements Connector {
     constructor(store: Store<StoreState>, analytics?: Nullable<Analytics>);
     get api(): Promise<RoomleConfigurator>;
     init(sdkWrapper: RoomleSdkWrapper, element: HTMLElement, initData: UiInitData): Promise<void>;
-    initConfigurator(configurator: RoomleConfigurator): void;
-    addCallback<K extends keyof ConfiguratorUiCallbacks>(key: K, fun: ConfiguratorUiCallbacks[K], allowMultiple?: boolean): void;
+    initConfigurator(configurator: RoomleConfigurator): Promise<void>;
     setParameter(parameter: KernelParameter, value: string, isRaw?: boolean): Promise<void>;
     setPrice(currencySymbol: string, price: number): void;
     addUiCallback(listener: UiCallbacks): void;

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/helpers/mocks/sdk-connector.d.ts

@@ -8,6 +8,7 @@ export interface MockSdkConnectorOverrides {
     loadInProgress?: boolean;
     someLoadDone?: boolean;
     rapiAccess?: object;
+    hasPlanner?: boolean;
 }
 export declare const FAKE_STORE: {
     commit: () => undefined;