@roomle/embedding-lib 4.24.1-alpha.2 → 4.25.0-alpha.3

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

@@ -3,7 +3,7 @@ import { Nullable } from '@/common/utils/types';
 import { CollectionViewElement } from '@/configurator/components/collection-view/-utils/types';
 import { StoreState } from '@/common/store';
 export interface GridViewUiState {
-    filter: Nullable<string>;
+    filter: string[];
     showAllAsList: boolean;
     search: Nullable<string>;
     userInitiatedSearch: boolean;
@@ -21,7 +21,7 @@ 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",
-    SET_FILTER = "GV_SET_FILTER",
+    TOGGLE_FILTER = "GV_TOGGLE_FILTER",
     SET_USER_INITIATED_SEARCH = "GV_SET_USER_INITIATED_SEARCH"
 }
 interface MuationPayload<T, V> {

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

@@ -48,6 +48,11 @@ export declare const MUTATIONS: {
     SET_SHOW_VARIANTS: UI_STATE_MUTATIONS.SET_SHOW_VARIANTS;
     SET_EMAIL: UI_STATE_MUTATIONS.SET_EMAIL;
     RESET_UI: UI_STATE_MUTATIONS.RESET_UI;
+    SET_LAST_SELECTED_VARIANT: UI_STATE_MUTATIONS.SET_LAST_SELECTED_VARIANT;
+    SET_UNDO: UI_STATE_MUTATIONS.SET_UNDO;
+    SET_REDO: UI_STATE_MUTATIONS.SET_REDO;
+    SET_UNDO_PLANNER: UI_STATE_MUTATIONS.SET_UNDO_PLANNER;
+    SET_REDO_PLANNER: UI_STATE_MUTATIONS.SET_REDO_PLANNER;
     UPDATE_GROUPS: CORE_DATA_MUTATIONS.UPDATE_GROUPS;
     UPDATE_PARAMETERS: CORE_DATA_MUTATIONS.UPDATE_PARAMETERS;
     UPDATE_ADDONS: CORE_DATA_MUTATIONS.UPDATE_ADDONS;
@@ -72,6 +77,7 @@ export declare const ACTIONS: {
     USE_VIEWER: UI_STATE_ACTIONS.USE_VIEWER;
     USE_PLANNER: UI_STATE_ACTIONS.USE_PLANNER;
     USE_CONFIGURATOR: UI_STATE_ACTIONS.USE_CONFIGURATOR;
+    SHOW_PARAMS: UI_STATE_ACTIONS.SHOW_PARAMS;
     UPDATE_PRICE: CORE_DATA_ACTIONS.UPDATE_PRICE;
     SET_LABEL: CORE_STATE_ACTIONS.SET_LABEL;
     SET_COMPONENT_HAS_CHILDREN: CORE_STATE_ACTIONS.SET_COMPONENT_HAS_CHILDREN;

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

@@ -1,5 +1,7 @@
 import { Nullable } from '@/common/utils/types';
 import { RapiConfiguration, RapiItem, RapiTenant } from '@roomle/web-sdk/lib/definitions/typings/rapi-types';
+import { Analytics } from '@/common/plugins/analytics';
+import { SdkConnector } from '@/configurator/business-logic/sdk-connector';
 export declare const throttle: <T extends (...args: any[]) => any>(func: T, delay?: number) => (...funcArgs: Parameters<T>) => void;
 export declare const round: (float: number, precision: number) => number;
 export declare const isIdAnItem: (id: string) => boolean;
@@ -58,3 +60,4 @@ export declare const oneTimeInterval: (callback: () => void, delay: number) => n
 export declare const runOnIdle: any;
 export declare const createShareLinkFromUrl: (url: string) => string;
 export declare const isLocationJestTest: () => boolean;
+export declare const loadVariant: (id: string, applyCurrentGlobalParameters: boolean, sdkConnector: SdkConnector, analytics?: Analytics | undefined) => Promise<void>;

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

@@ -6,7 +6,8 @@ export interface CssHash {
 export declare const enum USER_ACTION_MODULE {
     CONFIGURATOR = 3
 }
-export declare const enum USER_ACTION {
+export declare enum USER_ACTION {
     CONVERSION = 11,
-    SHARE_AR = 301
+    SHARE_AR = 301,
+    SAVE_DRAFT = 302
 }

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

@@ -117,4 +117,5 @@ export declare class SdkConnector {
     private _execLoadingConfiguratorProcess;
     private _startLoading;
     private _finishLoading;
+    private _showGenericError;
 }

package/types/src/configurator/components/-utils/overlays.d.ts

@@ -1,12 +1,12 @@
 export declare enum OVERLAYS {
-    PART_LIST = 0,
-    NO_DOCKING = 1,
-    SAVE_DRAFT = 2,
-    VARIANT_WARNING = 3,
-    OPEN_AR = 4,
-    EXPORT_3D = 5,
-    ELEMENT_DISABLED = 6,
-    DELETE_WARNING = 7
+    NO_DOCKING = 0,
+    SAVE_DRAFT = 1,
+    VARIANT_WARNING = 2,
+    OPEN_AR = 3,
+    EXPORT_3D = 4,
+    ELEMENT_DISABLED = 5,
+    DELETE_WARNING = 6,
+    GENERIC_ERROR = 7
 }
 export interface OverlayState {
     open: boolean;

package/types/src/configurator/components/grid-view/-utils/GridViewHelper.d.ts

@@ -5,6 +5,9 @@ export interface GridViewElement {
     key: string;
     payload: RapiMaterial | KernelValue | UiPossibleChild | RapiItem;
 }
+export interface GridViewVariantElement extends GridViewElement {
+    hash: string;
+}
 export interface GridViewGroup {
     id: string;
     label: Nullable<string>;

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

@@ -9,6 +9,7 @@ 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';
 export declare class ExposedApi {
     private _sdk;
     private _exposedCallbacks;
@@ -27,6 +28,7 @@ export declare class ExposedApi {
     /**
      * call this method to load the configuration string you want into the 3d Scene
      * @param configurationString string of the configuration, starts with `{` and ends with `}`
+     * @returns null if configuration can not be loaded
      */
     loadConfigurationString(configurationString: string): Promise<Nullable<LoadResponse>>;
     /**
@@ -74,6 +76,14 @@ export declare class ExposedApi {
      * call this method if consent of Google Analytics is given later and not already in init-data on boot
      */
     giveGaConsent(): void;
+    /**
+     * Insert an object into the current MOC/planner scene
+     * If no position or rotation is set then it will be placed automatically (without overlapping other objects) with rotation 0
+     * @param id
+     * @param position as x (left/right), y (up/down) and z (front/back)
+     * @param rotation in radians
+     */
+    insertObject(id: string, position?: Position3, rotation?: number): Promise<void>;
     private _websiteReady;
     private _handleMessage;
     private _forwardSdkCallbacks;

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

@@ -15,7 +15,10 @@ export declare enum UI_BUTTON {
     STARTCONFIGURE = "startconfigure",
     PAUSECONFIGURE = "pauseconfigure",
     EXPORT_3D = "export3d",
-    ROTATE = "rotate"
+    ROTATE = "rotate",
+    SNAPPING = "snapping",
+    UNDO = "undo",
+    REDO = "redo"
 }
 interface FeatureFlags {
     realPartList?: boolean;
@@ -39,6 +42,9 @@ export interface UiInitData extends InitDataDefinition, GlobalInitDataDefinition
         [UI_BUTTON.STARTCONFIGURE]?: boolean;
         [UI_BUTTON.PAUSECONFIGURE]?: boolean;
         [UI_BUTTON.EXPORT_3D]?: boolean;
+        [UI_BUTTON.SNAPPING]?: boolean;
+        [UI_BUTTON.UNDO]?: boolean;
+        [UI_BUTTON.REDO]?: boolean;
     };
     skin?: EmbeddingSkin;
     zIndex?: number;

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

@@ -6,6 +6,7 @@ import { KernelComponent, UiPossibleChild } from '@roomle/web-sdk/lib/definition
 import { OverlaysOpenState } from '@/configurator/components/-utils/overlays';
 import { UiInitData } from '@/configurator/embedding/types';
 import { RapiTagForUi } from '@roomle/web-sdk/lib/definitions/typings/rapi-types';
+import { GridViewVariantElement } from '@/configurator/components/grid-view/-utils/GridViewHelper';
 export declare enum BUTTON_ACTIONS {
     AR = 0,
     PARTLIST = 1,
@@ -14,7 +15,10 @@ export declare enum BUTTON_ACTIONS {
     FULLSCREEN = 4,
     RESET_CAMERA = 5,
     RENDER_IMAGE = 6,
-    ROTATE = 7
+    ROTATE = 7,
+    SNAPPING = 8,
+    UNDO = 9,
+    REDO = 10
 }
 export interface SceneSelection {
     selectionMode: string;
@@ -38,6 +42,11 @@ export interface UiState extends SharedUiState {
     isConfigurator: boolean;
     isPlanner: boolean;
     email: Nullable<string>;
+    lastSelectedVariant: Nullable<GridViewVariantElement>;
+    undoEnabled: boolean;
+    redoEnabled: boolean;
+    undoEnabledPlanner: boolean;
+    redoEnabledPlanner: boolean;
 }
 export declare enum UI_STATE_MUTATIONS {
     SET_SELECTED_GROUP = "setSelectedGroup",
@@ -61,7 +70,12 @@ export declare enum UI_STATE_MUTATIONS {
     SET_CURRENT_VARIANTS = "SET_CURRENT_VARIANTS",
     SET_SHOW_VARIANTS = "SET_SHOW_VARIANTS",
     SET_EMAIL = "SET_EMAIL",
-    RESET_UI = "RESET_UI"
+    RESET_UI = "RESET_UI",
+    SET_LAST_SELECTED_VARIANT = "SET_LAST_SELECTED_VARIANT",
+    SET_UNDO = "SET_UNDO",
+    SET_REDO = "SET_REDO",
+    SET_UNDO_PLANNER = "SET_UNDO_PLANNER",
+    SET_REDO_PLANNER = "SET_REDO_PLANNER"
 }
 export declare enum UI_STATE_ACTIONS {
     SELECT_GROUP = "SELECT_GROUP",
@@ -73,10 +87,12 @@ export declare enum UI_STATE_ACTIONS {
     PAUSE_CONFIGURING = "PAUSE_CONFIGURING",
     USE_VIEWER = "USE_VIEWER",
     USE_PLANNER = "USE_PLANNER",
-    USE_CONFIGURATOR = "USE_CONFIGURATOR"
+    USE_CONFIGURATOR = "USE_CONFIGURATOR",
+    SHOW_PARAMS = "SHOW_PARAMS"
 }
 export declare enum UI_STATE_GETTERS {
     USE_REGULAR_LAYOUT = "USE_REGULAR_LAYOUT",
+    PART_LIST_SHOWN = "PART_LIST_SHOWN",
     COLLECTION_VIEW_ELEMENTS = "COLLECTION_VIEW_ELEMENTS",
     COLLECTION_VIEW_ADDON_ELEMENTS = "COLLECTION_VIEW_ADDON_ELEMENTS",
     COLLECTION_VIEW_VARIANTS = "COLLECTION_VIEW_VARIANTS",

package/types/tests/helpers/data/variants.d.ts

@@ -0,0 +1,60 @@
+export declare const ROLF_BENZ_VARIANTS: {
+    id: string;
+    global: boolean;
+    created: string;
+    updated: string;
+    links: {
+        items: string;
+        materials: string;
+    };
+    catalog: string;
+    label: string;
+    language: string;
+    items: {
+        height: number;
+        width: number;
+        depth: number;
+        displayedHeight: number;
+        displayedWidth: number;
+        displayedDepth: number;
+        perspectiveImage: string;
+        topImage: string;
+        assets: {};
+        externalIdentifier: string;
+        manufacturerSKU: string;
+        configuration: string;
+        rootComponentId: string;
+        hidden: boolean;
+        visibilityStatus: number;
+        created: string;
+        updated: string;
+        flipable: boolean;
+        scaleable: boolean;
+        colorable: boolean;
+        layer: number;
+        sort: number;
+        basecolor: string;
+        orderable: boolean;
+        requestable: boolean;
+        retailPriceAllowed: boolean;
+        label: string;
+        language: string;
+        catalog: string;
+        id: string;
+        tags: string[];
+        links: {
+            tags: string;
+            similarItems: string;
+            perfectFit: string;
+            additionalContents: string;
+        };
+        attributes: never[];
+        version: number;
+        __rapi_path__: string;
+        sketch: string;
+    }[];
+    parents: string[];
+    hidden: boolean;
+    __rapi_path__: string;
+    materials: never[];
+};

package/types/tests/helpers/mocks/sdk-connector-planner.d.ts

@@ -0,0 +1,13 @@
+import { SdkConnectorPlanner } from '@/planner/business-logic/sdk-connector-planner';
+export interface MockSdkConnectorPlannerOverrides {
+    planner?: object;
+    api?: object;
+    store?: object;
+    analytics?: object;
+}
+export declare class MockSdkConnectorPlanner extends SdkConnectorPlanner {
+    overrides: MockSdkConnectorPlannerOverrides;
+    constructor(overrides?: MockSdkConnectorPlannerOverrides);
+    get api(): Promise<any>;
+    setParameter: () => Promise<void>;
+}

package/types/tests/helpers/mocks/sdk-connector.d.ts

@@ -2,7 +2,9 @@ import { SdkConnector } from '@/configurator/business-logic/sdk-connector';
 import { RapiTenant } from '@roomle/web-sdk/lib/definitions/typings/rapi-types';
 export interface MockSdkConnectorOverrides {
     configurator?: object;
+    planner?: object;
     configuratorConnector?: object;
+    plannerConnector?: object;
     loadInProgress?: boolean;
     someLoadDone?: boolean;
     rapiAccess?: object;
@@ -23,7 +25,10 @@ export declare class MockSdkConnector extends SdkConnector {
     constructor(overrides?: MockSdkConnectorOverrides);
     getTenant(): Promise<RapiTenant>;
     initConfigurator(): void;
+    initPlanner(): void;
     get configuratorApi(): Promise<any>;
+    get plannerApi(): Promise<any>;
     get configuratorConnector(): Promise<any>;
+    get plannerConnector(): Promise<any>;
     setParameter: () => Promise<void>;
 }

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

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