npm - @roomle/embedding-lib - Versions diffs - 4.41.0 → 4.43.0-debug.1 - Mend

@roomle/embedding-lib 4.41.0 → 4.43.0-debug.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 (41) hide show

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

@@ -1,195 +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)
-- [onPlanUpdate](exposed_callbacks.ExposedCallbacks.md#onplanupdate)
-- [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**()
-## Methods
-### onBackToWebsite
-▸ **onBackToWebsite**(): `void`
-#### Returns
-`void`
-#### Defined in
-[src/configurator/embedding/exposed-callbacks.ts:40](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/exposed-callbacks.ts#L40)
-___
-### onButtonClicked
-▸ **onButtonClicked**(`name`): false \| true \| `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
-false \| true \| `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](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/exposed-callbacks.ts#L47)
-___
-### onPartListUpdate
-▸ **onPartListUpdate**(`partList`, `hash`): `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](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/exposed-callbacks.ts#L34)
-___
-### onPlanUpdate
-▸ **onPlanUpdate**(`objects`): `void`
-Gets called if a plan object gets added, changed or removed
-Only the move of plan object does NOT trigger this function
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `objects` | `UiPlanObject`[] |
-#### Returns
-`void`
-#### Defined in
-[src/configurator/embedding/exposed-callbacks.ts:56](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/exposed-callbacks.ts#L56)
-___
-### onRequestPlan
-▸ **onRequestPlan**(`planId`, `image`, `items`): `void`
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `planId` | `string` |
-| `image` | `Base64Image` |
-| `items` | `any`[] |
-#### Returns
-`void`
-#### Defined in
-[src/configurator/embedding/exposed-callbacks.ts:49](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/exposed-callbacks.ts#L49)
-___
-### onRequestProduct
-▸ **onRequestProduct**(`configurationId`, `image`, `partList`, `price`, `labels`, `configuration`): `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](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/exposed-callbacks.ts#L28)
-___
-### onResize
-▸ **onResize**(`isDesktop`): `void`
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `isDesktop` | `boolean` |
-#### Returns
-`void`
-#### Defined in
-[src/configurator/embedding/exposed-callbacks.ts:36](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/exposed-callbacks.ts#L36)
-___
-### onUseFullPage
-▸ **onUseFullPage**(): `void`
-#### Returns
-`void`
-#### Defined in
-[src/configurator/embedding/exposed-callbacks.ts:38](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/exposed-callbacks.ts#L38)

package/docs/api/classes/roomle_configurator_api.default.md DELETED Viewed

@@ -1,211 +0,0 @@
-[Embedding API Reference](../README.md) / [Modules](../modules.md) / [roomle-configurator-api](../modules/roomle_configurator_api.md) / default
-# Class: default<SdkType, SdkCallbacks\>
-[roomle-configurator-api](../modules/roomle_configurator_api.md).default
-## Type parameters
-| Name |
-| :------ |
-| `SdkType` |
-| `SdkCallbacks` |
-## Implements
-- [`RoomleEmbeddingApiKeys`](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md)
-## Table of contents
-### Properties
-- [analytics](roomle_configurator_api.default.md#analytics)
-- [extended](roomle_configurator_api.default.md#extended)
-- [global](roomle_configurator_api.default.md#global)
-- [ui](roomle_configurator_api.default.md#ui)
-### Methods
-- [teardown](roomle_configurator_api.default.md#teardown)
-- [create](roomle_configurator_api.default.md#create)
-- [createConfigurator](roomle_configurator_api.default.md#createconfigurator)
-- [createPlanner](roomle_configurator_api.default.md#createplanner)
-- [createViewer](roomle_configurator_api.default.md#createviewer)
-## Properties
-### analytics
-• **analytics**: `Object`
-#### Type declaration
-| Name | Type |
-| :------ | :------ |
-| `callbacks` | [`ExposedAnalyticsCallbacks`](exposed_analytics_callbacks.ExposedAnalyticsCallbacks.md) |
-#### Implementation of
-[RoomleEmbeddingApiKeys](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md).[analytics](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md#analytics)
-#### Defined in
-[src/configurator/embedding/roomle-configurator-api.ts:141](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/roomle-configurator-api.ts#L141)
-___
-### extended
-• **extended**: `SdkType`
-#### Implementation of
-[RoomleEmbeddingApiKeys](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md).[extended](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md#extended)
-#### Defined in
-[src/configurator/embedding/roomle-configurator-api.ts:137](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/roomle-configurator-api.ts#L137)
-___
-### global
-• **global**: `Object`
-#### Type declaration
-| Name | Type |
-| :------ | :------ |
-| `callbacks` | `GlobalCallback` |
-#### Implementation of
-[RoomleEmbeddingApiKeys](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md).[global](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md#global)
-#### Defined in
-[src/configurator/embedding/roomle-configurator-api.ts:145](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/roomle-configurator-api.ts#L145)
-___
-### ui
-• **ui**: [`ExposedApi`](exposed_api.ExposedApi.md)
-#### Implementation of
-[RoomleEmbeddingApiKeys](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md).[ui](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md#ui)
-#### Defined in
-[src/configurator/embedding/roomle-configurator-api.ts:133](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/roomle-configurator-api.ts#L133)
-## Methods
-### teardown
-▸ **teardown**(): `void`
-#### Returns
-`void`
-#### Defined in
-[src/configurator/embedding/roomle-configurator-api.ts:207](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/roomle-configurator-api.ts#L207)
-___
-### create
-▸ `Static` **create**(`configuratorId`, `container`, `initData`): `Promise`<[`RoomleConfiguratorApi`](../modules/roomle_configurator_api.md#roomleconfiguratorapi)\>
-Method to create a new instance of a Roomle Configurator
-**`deprecated`** please use "createConfigurator"
-#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `configuratorId` | `string` | the id which identifies your configurator, you will get this ID from your Roomle Contact Person |
-| `container` | `HTMLElement` | DOM container in which the configurator should be placed |
-| `initData` | [`UiInitData`](../interfaces/types.UiInitData.md) | settings with which the configurator should be started |
-#### Returns
-`Promise`<[`RoomleConfiguratorApi`](../modules/roomle_configurator_api.md#roomleconfiguratorapi)\>
-#### Defined in
-[src/configurator/embedding/roomle-configurator-api.ts:97](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/roomle-configurator-api.ts#L97)
-___
-### createConfigurator
-▸ `Static` **createConfigurator**(`configuratorId`, `container`, `initData`): `Promise`<[`RoomleConfiguratorApi`](../modules/roomle_configurator_api.md#roomleconfiguratorapi)\>
-Method to create a new instance of a Roomle Configurator
-#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `configuratorId` | `string` | the id which identifies your configurator, you will get this ID from your Roomle Contact Person |
-| `container` | `HTMLElement` | DOM container in which the configurator should be placed |
-| `initData` | [`UiInitData`](../interfaces/types.UiInitData.md) | settings with which the configurator should be started |
-#### Returns
-`Promise`<[`RoomleConfiguratorApi`](../modules/roomle_configurator_api.md#roomleconfiguratorapi)\>
-#### Defined in
-[src/configurator/embedding/roomle-configurator-api.ts:86](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/roomle-configurator-api.ts#L86)
-___
-### createPlanner
-▸ `Static` **createPlanner**(`configuratorId`, `container`, `initData`): `Promise`<[`RoomlePlannerApi`](../modules/roomle_configurator_api.md#roomleplannerapi)\>
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `configuratorId` | `string` |
-| `container` | `HTMLElement` |
-| `initData` | [`UiInitData`](../interfaces/types.UiInitData.md) |
-#### Returns
-`Promise`<[`RoomlePlannerApi`](../modules/roomle_configurator_api.md#roomleplannerapi)\>
-#### Defined in
-[src/configurator/embedding/roomle-configurator-api.ts:76](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/roomle-configurator-api.ts#L76)
-___
-### createViewer
-▸ `Static` **createViewer**(`configuratorId`, `container`, `initData`): `Promise`<[`RoomleViewerApi`](../modules/roomle_configurator_api.md#roomleviewerapi)\>
-Method to create a new instance of a Roomle Viewer
-#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `configuratorId` | `string` | the id which identifies your configurator, you will get this ID from your Roomle Contact Person |
-| `container` | `HTMLElement` | DOM container in which the configurator should be placed |
-| `initData` | [`UiInitData`](../interfaces/types.UiInitData.md) | settings with which the configurator should be started |
-#### Returns
-`Promise`<[`RoomleViewerApi`](../modules/roomle_configurator_api.md#roomleviewerapi)\>
-#### Defined in
-[src/configurator/embedding/roomle-configurator-api.ts:107](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/roomle-configurator-api.ts#L107)

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

@@ -1,263 +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)
-- [ADD\_ROOM](types.UI_BUTTON.md#add_room)
-- [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)
-- [PARTLIST\_PLANNER](types.UI_BUTTON.md#partlist_planner)
-- [PAUSECONFIGURE](types.UI_BUTTON.md#pauseconfigure)
-- [PRODUCTLIST](types.UI_BUTTON.md#productlist)
-- [REDO](types.UI_BUTTON.md#redo)
-- [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)
-- [SNAPPING](types.UI_BUTTON.md#snapping)
-- [STARTCONFIGURE](types.UI_BUTTON.md#startconfigure)
-- [STARTPLANNER](types.UI_BUTTON.md#startplanner)
-- [TWO\_D\_VIEW](types.UI_BUTTON.md#two_d_view)
-- [UNDO](types.UI_BUTTON.md#undo)
-## Enumeration members
-### ADDONS
-• **ADDONS** = `"addons"`
-#### Defined in
-[src/configurator/embedding/types.ts:12](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L12)
-___
-### ADD\_ROOM
-• **ADD\_ROOM** = `"add_room"`
-#### Defined in
-[src/configurator/embedding/types.ts:26](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L26)
-___
-### AR
-• **AR** = `"ar"`
-#### Defined in
-[src/configurator/embedding/types.ts:5](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L5)
-___
-### DIMENSIONS
-• **DIMENSIONS** = `"dimensions"`
-#### Defined in
-[src/configurator/embedding/types.ts:8](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L8)
-___
-### EXPORT\_3D
-• **EXPORT\_3D** = `"export3d"`
-#### Defined in
-[src/configurator/embedding/types.ts:18](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L18)
-___
-### FULLSCREEN
-• **FULLSCREEN** = `"fullscreen"`
-#### Defined in
-[src/configurator/embedding/types.ts:9](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L9)
-___
-### MULTISELECT
-• **MULTISELECT** = `"multiselect"`
-#### Defined in
-[src/configurator/embedding/types.ts:7](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L7)
-___
-### PARTLIST
-• **PARTLIST** = `"partlist"`
-#### Defined in
-[src/configurator/embedding/types.ts:6](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L6)
-___
-### PARTLIST\_PLANNER
-• **PARTLIST\_PLANNER** = `"partlist_planner"`
-#### Defined in
-[src/configurator/embedding/types.ts:23](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L23)
-___
-### PAUSECONFIGURE
-• **PAUSECONFIGURE** = `"pauseconfigure"`
-#### Defined in
-[src/configurator/embedding/types.ts:17](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L17)
-___
-### PRODUCTLIST
-• **PRODUCTLIST** = `"productlist"`
-#### Defined in
-[src/configurator/embedding/types.ts:24](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L24)
-___
-### REDO
-• **REDO** = `"redo"`
-#### Defined in
-[src/configurator/embedding/types.ts:22](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L22)
-___
-### RENDERIMAGE
-• **RENDERIMAGE** = `"renderimage"`
-#### Defined in
-[src/configurator/embedding/types.ts:11](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L11)
-___
-### REQUESTPLAN
-• **REQUESTPLAN** = `"requestplan"`
-#### Defined in
-[src/configurator/embedding/types.ts:14](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L14)
-___
-### REQUESTPRODUCT
-• **REQUESTPRODUCT** = `"requestproduct"`
-#### Defined in
-[src/configurator/embedding/types.ts:13](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L13)
-___
-### RESETCAMERA
-• **RESETCAMERA** = `"resetcamera"`
-#### Defined in
-[src/configurator/embedding/types.ts:10](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L10)
-___
-### ROTATE
-• **ROTATE** = `"rotate"`
-#### Defined in
-[src/configurator/embedding/types.ts:19](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L19)
-___
-### SAVEDRAFT
-• **SAVEDRAFT** = `"savedraft"`
-#### Defined in
-[src/configurator/embedding/types.ts:15](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L15)
-___
-### SNAPPING
-• **SNAPPING** = `"snapping"`
-#### Defined in
-[src/configurator/embedding/types.ts:20](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L20)
-___
-### STARTCONFIGURE
-• **STARTCONFIGURE** = `"startconfigure"`
-#### Defined in
-[src/configurator/embedding/types.ts:16](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L16)
-___
-### STARTPLANNER
-• **STARTPLANNER** = `"startPlanner"`
-#### Defined in
-[src/configurator/embedding/types.ts:27](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L27)
-___
-### TWO\_D\_VIEW
-• **TWO\_D\_VIEW** = `"2dview"`
-#### Defined in
-[src/configurator/embedding/types.ts:25](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L25)
-___
-### UNDO
-• **UNDO** = `"undo"`
-#### Defined in
-[src/configurator/embedding/types.ts:21](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/types.ts#L21)

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

@@ -1,32 +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](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/exposed-callbacks.ts#L14)
-___
-### label
-• **label**: `Nullable`<`string`\>
-#### Defined in
-[src/configurator/embedding/exposed-callbacks.ts:15](https://gitlab.com/roomle/web/roomle-ui/-/blob/e62175ee/src/configurator/embedding/exposed-callbacks.ts#L15)