npm - @roomle/embedding-lib - Versions diffs - 4.24.0 → 4.25.0-alpha.1 - Mend

@roomle/embedding-lib 4.24.0 → 4.25.0-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (52) hide show

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

@@ -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 ADDED Viewed

@@ -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 ADDED Viewed

@@ -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 CHANGED Viewed

@@ -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/configurator/components/{overlays/PartList.spec.d.ts → parameters/types/ProductVariant.spec.d.ts} RENAMED Viewed

File without changes

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

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

package/docs/api/classes/exposed_api.exposedapi.md DELETED Viewed

@@ -1,191 +0,0 @@
-[Embedding API Reference](../README.md) / [Modules](../modules.md) / [exposed-api](../modules/exposed_api.md) / ExposedApi
-# Class: ExposedApi
-[exposed-api](../modules/exposed_api.md).ExposedApi
-## Table of contents
-### Constructors
-- [constructor](exposed_api.exposedapi.md#constructor)
-### Accessors
-- [callbacks](exposed_api.exposedapi.md#callbacks)
-### Methods
-- [giveGaConsent](exposed_api.exposedapi.md#givegaconsent)
-- [loadConfigurationString](exposed_api.exposedapi.md#loadconfigurationstring)
-- [loadObject](exposed_api.exposedapi.md#loadobject)
-- [pauseConfiguring](exposed_api.exposedapi.md#pauseconfiguring)
-- [setPrice](exposed_api.exposedapi.md#setprice)
-- [startConfiguring](exposed_api.exposedapi.md#startconfiguring)
-- [triggerRequestPlan](exposed_api.exposedapi.md#triggerrequestplan)
-- [triggerRequestProduct](exposed_api.exposedapi.md#triggerrequestproduct)
-## Constructors
-### constructor
-\+ **new ExposedApi**(`sdkConnector`: *SdkConnector*, `messageHandler`: ``null`` \| *MessageHandler*, `sdk`: *default* \| *default* \| *default*, `exposedCallbacks`: [*ExposedCallbacks*](exposed_callbacks.exposedcallbacks.md), `store`: *Store*<StoreState\>, `analytics`: Analytics, `globalCallback`: *GlobalCallback*): [*ExposedApi*](exposed_api.exposedapi.md)
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `sdkConnector` | *SdkConnector* |
-| `messageHandler` | ``null`` \| *MessageHandler* |
-| `sdk` | *default* \| *default* \| *default* |
-| `exposedCallbacks` | [*ExposedCallbacks*](exposed_callbacks.exposedcallbacks.md) |
-| `store` | *Store*<StoreState\> |
-| `analytics` | Analytics |
-| `globalCallback` | *GlobalCallback* |
-**Returns:** [*ExposedApi*](exposed_api.exposedapi.md)
-Defined in: src/configurator/embedding/exposed-api.ts:27
-## Accessors
-### callbacks
-• get **callbacks**(): [*ExposedCallbacks*](exposed_callbacks.exposedcallbacks.md)
-**Returns:** [*ExposedCallbacks*](exposed_callbacks.exposedcallbacks.md)
-Defined in: src/configurator/embedding/exposed-api.ts:117
-## Methods
-### giveGaConsent
-▸ **giveGaConsent**(): *void*
-call this method if consent of Google Analytics is given later and not already in init-data on boot
-**Returns:** *void*
-Defined in: src/configurator/embedding/exposed-api.ts:205
-___
-### loadConfigurationString
-▸ **loadConfigurationString**(`configurationString`: *string*): *Promise*<Nullable<LoadResponse\>\>
-call this method to load the configuration string you want into the 3d Scene
-#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `configurationString` | *string* | string of the configuration, starts with `{` and ends with `}` |
-**Returns:** *Promise*<Nullable<LoadResponse\>\>
-Defined in: src/configurator/embedding/exposed-api.ts:136
-___
-### loadObject
-▸ **loadObject**(`id`: *string*): *Promise*<Nullable<LoadResponse\>\>
-call this method to load the object you want into the 3d Scene
-#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `id` | *string* | database ID of the object you want to load |
-**Returns:** *Promise*<Nullable<LoadResponse\>\>
-Defined in: src/configurator/embedding/exposed-api.ts:125
-___
-### pauseConfiguring
-▸ **pauseConfiguring**(): *void*
-This method can be used to pause configuration
-If the configurator was called in view-only mode
-this method triggers the onBackToWebsite callback.
-To know when the view-only mode is activated see the
-description of the startConfiguring method
-**Returns:** *void*
-Defined in: src/configurator/embedding/exposed-api.ts:173
-___
-### setPrice
-▸ **setPrice**(`currencySymbol`: *string*, `price`: *number*): *void*
-set the price for the UI to show
-most likely needed when implementing your own price service
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `currencySymbol` | *string* |
-| `price` | *number* |
-**Returns:** *void*
-Defined in: src/configurator/embedding/exposed-api.ts:150
-___
-### startConfiguring
-▸ **startConfiguring**(): *void*
-This method can be used to start configuration when
-3d scene is only initialized as viewer first, the
-configurator is automatically instantiated as viewer
-if the container where the configurator is placed is
-smaller than 1024px (this breakpoint could change in future)
-so do not rely on this exact pixel setting
-**Returns:** *void*
-Defined in: src/configurator/embedding/exposed-api.ts:162
-___
-### triggerRequestPlan
-▸ **triggerRequestPlan**(): *Promise*<void\>
-call this method to trigger the onRequestPlan event from
-outside of the iframe. When this method is called the same
-process is kicked off as if the user would have clicked on
-request plan. Therefore you can just use the same callback
-to react on the response
-**Returns:** *Promise*<void\>
-Defined in: src/configurator/embedding/exposed-api.ts:198
-___
-### triggerRequestProduct
-▸ **triggerRequestProduct**(): *Promise*<void\>
-call this method to trigger the onRequestProduct event from
-outside of the iframe. When this method is called the same
-process is kicked off as if the user would have clicked on
-request product. Therefore you can just use the same callback
-to react on the response
-**Returns:** *Promise*<void\>
-Defined in: src/configurator/embedding/exposed-api.ts:187

package/docs/api/classes/exposed_callbacks.exposedcallbacks.md DELETED Viewed

@@ -1,145 +0,0 @@
-[Embedding API Reference](../README.md) / [Modules](../modules.md) / [exposed-callbacks](../modules/exposed_callbacks.md) / ExposedCallbacks
-# Class: ExposedCallbacks
-[exposed-callbacks](../modules/exposed_callbacks.md).ExposedCallbacks
-## Table of contents
-### Constructors
-- [constructor](exposed_callbacks.exposedcallbacks.md#constructor)
-### Methods
-- [onBackToWebsite](exposed_callbacks.exposedcallbacks.md#onbacktowebsite)
-- [onButtonClicked](exposed_callbacks.exposedcallbacks.md#onbuttonclicked)
-- [onPartListUpdate](exposed_callbacks.exposedcallbacks.md#onpartlistupdate)
-- [onRequestPlan](exposed_callbacks.exposedcallbacks.md#onrequestplan)
-- [onRequestProduct](exposed_callbacks.exposedcallbacks.md#onrequestproduct)
-- [onResize](exposed_callbacks.exposedcallbacks.md#onresize)
-- [onUseFullPage](exposed_callbacks.exposedcallbacks.md#onusefullpage)
-## Constructors
-### constructor
-\+ **new ExposedCallbacks**(): [*ExposedCallbacks*](exposed_callbacks.exposedcallbacks.md)
-**Returns:** [*ExposedCallbacks*](exposed_callbacks.exposedcallbacks.md)
-## Methods
-### onBackToWebsite
-▸ **onBackToWebsite**(): *void*
-**Returns:** *void*
-Defined in: src/configurator/embedding/exposed-callbacks.ts:40
-___
-### onButtonClicked
-▸ **onButtonClicked**(`name`: [*UI\_BUTTON*](../enums/types.ui_button.md)): *boolean* \| *void* \| *Promise*<boolean\>
-Gets called when a button in the UI is clicked
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `name` | [*UI\_BUTTON*](../enums/types.ui_button.md) |
-**Returns:** *boolean* \| *void* \| *Promise*<boolean\>
-overrideEventBehaviour true if the event has been consumed and it should not trigger default behaviour, undefined or false otherwise
-Defined in: src/configurator/embedding/exposed-callbacks.ts:47
-___
-### onPartListUpdate
-▸ **onPartListUpdate**(`partList`: KernelPartList, `hash`: *string*): *void*
-fullList fullList (needed for price calculation) of the current configuration
-#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `partList` | KernelPartList | the part list with all details, grouped, etc |
-| `hash` | *string* | - |
-**Returns:** *void*
-Defined in: src/configurator/embedding/exposed-callbacks.ts:34
-___
-### onRequestPlan
-▸ **onRequestPlan**(`planId`: *string*, `image`: Base64Image, `items`: *any*[]): *void*
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `planId` | *string* |
-| `image` | Base64Image |
-| `items` | *any*[] |
-**Returns:** *void*
-Defined in: src/configurator/embedding/exposed-callbacks.ts:49
-___
-### onRequestProduct
-▸ **onRequestProduct**(`configurationId`: *string*, `image`: Base64Image, `partList`: KernelPartList, `price`: [*Price*](../interfaces/exposed_callbacks.price.md), `labels`: [*Labels*](../interfaces/exposed_callbacks.labels.md), `configuration`: RapiConfigurationEnhanced): *void*
-Returns all necessary params when 'Request Product'/'Checkout' button has pressed
-#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `configurationId` | *string* | id of the current configuration |
-| `image` | Base64Image | image of the current configuration |
-| `partList` | KernelPartList | the part list with all details, grouped, etc |
-| `price` | [*Price*](../interfaces/exposed_callbacks.price.md) | price of the current configuration, either set via setPrice or from Roomle price service |
-| `labels` | [*Labels*](../interfaces/exposed_callbacks.labels.md) | the label of the catalog and the furniture system |
-| `configuration` | RapiConfigurationEnhanced | the data returned from the Roomle backend |
-**Returns:** *void*
-Defined in: src/configurator/embedding/exposed-callbacks.ts:28
-___
-### onResize
-▸ **onResize**(`isDesktop`: *boolean*): *void*
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `isDesktop` | *boolean* |
-**Returns:** *void*
-Defined in: src/configurator/embedding/exposed-callbacks.ts:36
-___
-### onUseFullPage
-▸ **onUseFullPage**(): *void*
-**Returns:** *void*
-Defined in: src/configurator/embedding/exposed-callbacks.ts:38

package/docs/api/enums/types.ui_button.md DELETED Viewed

@@ -1,145 +0,0 @@
-[Embedding API Reference](../README.md) / [Modules](../modules.md) / [types](../modules/types.md) / UI_BUTTON
-# Enumeration: UI\_BUTTON
-[types](../modules/types.md).UI_BUTTON
-## Table of contents
-### Enumeration members
-- [ADDONS](types.ui_button.md#addons)
-- [AR](types.ui_button.md#ar)
-- [DIMENSIONS](types.ui_button.md#dimensions)
-- [EXPORT\_3D](types.ui_button.md#export_3d)
-- [FULLSCREEN](types.ui_button.md#fullscreen)
-- [MULTISELECT](types.ui_button.md#multiselect)
-- [PARTLIST](types.ui_button.md#partlist)
-- [PAUSECONFIGURE](types.ui_button.md#pauseconfigure)
-- [RENDERIMAGE](types.ui_button.md#renderimage)
-- [REQUESTPLAN](types.ui_button.md#requestplan)
-- [REQUESTPRODUCT](types.ui_button.md#requestproduct)
-- [RESETCAMERA](types.ui_button.md#resetcamera)
-- [ROTATE](types.ui_button.md#rotate)
-- [SAVEDRAFT](types.ui_button.md#savedraft)
-- [STARTCONFIGURE](types.ui_button.md#startconfigure)
-## Enumeration members
-### ADDONS
-• **ADDONS**: = "addons"
-Defined in: src/configurator/embedding/types.ts:15
-___
-### AR
-• **AR**: = "ar"
-Defined in: src/configurator/embedding/types.ts:8
-___
-### DIMENSIONS
-• **DIMENSIONS**: = "dimensions"
-Defined in: src/configurator/embedding/types.ts:11
-___
-### EXPORT\_3D
-• **EXPORT\_3D**: = "export3d"
-Defined in: src/configurator/embedding/types.ts:21
-___
-### FULLSCREEN
-• **FULLSCREEN**: = "fullscreen"
-Defined in: src/configurator/embedding/types.ts:12
-___
-### MULTISELECT
-• **MULTISELECT**: = "multiselect"
-Defined in: src/configurator/embedding/types.ts:10
-___
-### PARTLIST
-• **PARTLIST**: = "partlist"
-Defined in: src/configurator/embedding/types.ts:9
-___
-### PAUSECONFIGURE
-• **PAUSECONFIGURE**: = "pauseconfigure"
-Defined in: src/configurator/embedding/types.ts:20
-___
-### RENDERIMAGE
-• **RENDERIMAGE**: = "renderimage"
-Defined in: src/configurator/embedding/types.ts:14
-___
-### REQUESTPLAN
-• **REQUESTPLAN**: = "requestplan"
-Defined in: src/configurator/embedding/types.ts:17
-___
-### REQUESTPRODUCT
-• **REQUESTPRODUCT**: = "requestproduct"
-Defined in: src/configurator/embedding/types.ts:16
-___
-### RESETCAMERA
-• **RESETCAMERA**: = "resetcamera"
-Defined in: src/configurator/embedding/types.ts:13
-___
-### ROTATE
-• **ROTATE**: = "rotate"
-Defined in: src/configurator/embedding/types.ts:22
-___
-### SAVEDRAFT
-• **SAVEDRAFT**: = "savedraft"
-Defined in: src/configurator/embedding/types.ts:18
-___
-### STARTCONFIGURE
-• **STARTCONFIGURE**: = "startconfigure"
-Defined in: src/configurator/embedding/types.ts:19

package/docs/api/interfaces/exposed_callbacks.labels.md DELETED Viewed

@@ -1,28 +0,0 @@
-[Embedding API Reference](../README.md) / [Modules](../modules.md) / [exposed-callbacks](../modules/exposed_callbacks.md) / Labels
-# Interface: Labels
-[exposed-callbacks](../modules/exposed_callbacks.md).Labels
-## Table of contents
-### Properties
-- [catalogLabel](exposed_callbacks.labels.md#cataloglabel)
-- [label](exposed_callbacks.labels.md#label)
-## Properties
-### catalogLabel
-• **catalogLabel**: *Nullable*<string\>
-Defined in: src/configurator/embedding/exposed-callbacks.ts:14
-___
-### label
-• **label**: *Nullable*<string\>
-Defined in: src/configurator/embedding/exposed-callbacks.ts:15

package/docs/api/interfaces/exposed_callbacks.price.md DELETED Viewed

@@ -1,28 +0,0 @@
-[Embedding API Reference](../README.md) / [Modules](../modules.md) / [exposed-callbacks](../modules/exposed_callbacks.md) / Price
-# Interface: Price
-[exposed-callbacks](../modules/exposed_callbacks.md).Price
-## Table of contents
-### Properties
-- [currencySymbol](exposed_callbacks.price.md#currencysymbol)
-- [price](exposed_callbacks.price.md#price)
-## Properties
-### currencySymbol
-• **currencySymbol**: *Nullable*<string\>
-Defined in: src/configurator/embedding/exposed-callbacks.ts:9
-___
-### price
-• **price**: *Nullable*<number\>
-Defined in: src/configurator/embedding/exposed-callbacks.ts:10