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

package/docs/api/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

package/docs/api/README.md

@@ -0,0 +1,9 @@
+Embedding API Reference / [Modules](modules.md)
+
+# Overview
+
+The Embedding API reference does not contain every file/class used, but the interfaces used to communicate with the modules.
+
+## Init Data / Settings
+
+You can find all possible settings (init data) for the Embedding API in the [UiInitData](interfaces/types.uiinitdata.md)

package/docs/api/classes/exposed_analytics_callbacks.ExposedAnalyticsCallbacks.md

@@ -0,0 +1,47 @@
+[Embedding API Reference](../README.md) / [Modules](../modules.md) / [exposed-analytics-callbacks](../modules/exposed_analytics_callbacks.md) / ExposedAnalyticsCallbacks
+
+# Class: ExposedAnalyticsCallbacks
+
+[exposed-analytics-callbacks](../modules/exposed_analytics_callbacks.md).ExposedAnalyticsCallbacks
+
+## Table of contents
+
+### Constructors
+
+- [constructor](exposed_analytics_callbacks.ExposedAnalyticsCallbacks.md#constructor)
+
+### Methods
+
+- [onGATracking](exposed_analytics_callbacks.ExposedAnalyticsCallbacks.md#ongatracking)
+
+## Constructors
+
+### constructor
+
+• **new ExposedAnalyticsCallbacks**()
+
+## Methods
+
+### onGATracking
+
+▸ **onGATracking**(...`_args`): `void`
+
+Is called whenever something is sent to google analytics
+Possible parameters are everything which is possible in gtag.js
+If you need further details about gtag.js: https://developers.google.com/gtagjs
+Currently we use Google Analytics in combination with gtag.js so
+you can intercept events and send them to your own analytics tool
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `..._args` | `any`[] |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[src/configurator/embedding/exposed-analytics-callbacks.ts:9](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/exposed-analytics-callbacks.ts#L9)

package/docs/api/classes/exposed_api.ExposedApi.md

@@ -0,0 +1,227 @@
+[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`, `messageHandler`, `sdk`, `exposedCallbacks`, `store`, `analytics`, `globalCallback`)
+
+#### 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` |
+
+#### Defined in
+
+[src/configurator/embedding/exposed-api.ts:29](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/exposed-api.ts#L29)
+
+## Accessors
+
+### callbacks
+
+• `get` **callbacks**(): [`ExposedCallbacks`](exposed_callbacks.ExposedCallbacks.md)
+
+#### Returns
+
+[`ExposedCallbacks`](exposed_callbacks.ExposedCallbacks.md)
+
+#### Defined in
+
+[src/configurator/embedding/exposed-api.ts:117](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/exposed-api.ts#L117)
+
+## 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](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/exposed-api.ts#L205)
+
+___
+
+### loadConfigurationString
+
+▸ **loadConfigurationString**(`configurationString`): `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](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/exposed-api.ts#L136)
+
+___
+
+### loadObject
+
+▸ **loadObject**(`id`): `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](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/exposed-api.ts#L125)
+
+___
+
+### 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](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/exposed-api.ts#L173)
+
+___
+
+### setPrice
+
+▸ **setPrice**(`currencySymbol`, `price`): `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](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/exposed-api.ts#L150)
+
+___
+
+### 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](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/exposed-api.ts#L162)
+
+___
+
+### 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](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/exposed-api.ts#L198)
+
+___
+
+### 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](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/exposed-api.ts#L187)

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

@@ -0,0 +1,171 @@
+[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**()
+
+## Methods
+
+### onBackToWebsite
+
+▸ **onBackToWebsite**(): `void`
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[src/configurator/embedding/exposed-callbacks.ts:40](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/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/5c482b70/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/5c482b70/src/configurator/embedding/exposed-callbacks.ts#L34)
+
+___
+
+### 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/5c482b70/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/5c482b70/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/5c482b70/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/5c482b70/src/configurator/embedding/exposed-callbacks.ts#L38)

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

@@ -0,0 +1,211 @@
+[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:140](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/roomle-configurator-api.ts#L140)
+
+___
+
+### 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:136](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/roomle-configurator-api.ts#L136)
+
+___
+
+### 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:144](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/roomle-configurator-api.ts#L144)
+
+___
+
+### 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:132](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/roomle-configurator-api.ts#L132)
+
+## Methods
+
+### teardown
+
+▸ **teardown**(): `void`
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[src/configurator/embedding/roomle-configurator-api.ts:206](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/roomle-configurator-api.ts#L206)
+
+___
+
+### 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:96](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/roomle-configurator-api.ts#L96)
+
+___
+
+### 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:85](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/roomle-configurator-api.ts#L85)
+
+___
+
+### 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:75](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/roomle-configurator-api.ts#L75)
+
+___
+
+### 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:106](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/roomle-configurator-api.ts#L106)