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

package/docs/api/interfaces/types.VariantsMap.md

@@ -0,0 +1,9 @@
+[Embedding API Reference](../README.md) / [Modules](../modules.md) / [types](../modules/types.md) / VariantsMap
+
+# Interface: VariantsMap
+
+[types](../modules/types.md).VariantsMap
+
+## Indexable
+
+▪ [key: `string`]: `RapiId`

package/docs/api/modules/exposed_analytics_callbacks.md

@@ -0,0 +1,9 @@
+[Embedding API Reference](../README.md) / [Modules](../modules.md) / exposed-analytics-callbacks
+
+# Module: exposed-analytics-callbacks
+
+## Table of contents
+
+### Classes
+
+- [ExposedAnalyticsCallbacks](../classes/exposed_analytics_callbacks.ExposedAnalyticsCallbacks.md)

package/docs/api/modules/exposed_api.md

@@ -0,0 +1,9 @@
+[Embedding API Reference](../README.md) / [Modules](../modules.md) / exposed-api
+
+# Module: exposed-api
+
+## Table of contents
+
+### Classes
+
+- [ExposedApi](../classes/exposed_api.ExposedApi.md)

package/docs/api/modules/exposed_callbacks.md

@@ -0,0 +1,14 @@
+[Embedding API Reference](../README.md) / [Modules](../modules.md) / exposed-callbacks
+
+# Module: exposed-callbacks
+
+## Table of contents
+
+### Classes
+
+- [ExposedCallbacks](../classes/exposed_callbacks.ExposedCallbacks.md)
+
+### Interfaces
+
+- [Labels](../interfaces/exposed_callbacks.Labels.md)
+- [Price](../interfaces/exposed_callbacks.Price.md)

package/docs/api/modules/roomle_configurator_api.md

@@ -0,0 +1,49 @@
+[Embedding API Reference](../README.md) / [Modules](../modules.md) / roomle-configurator-api
+
+# Module: roomle-configurator-api
+
+## Table of contents
+
+### Classes
+
+- [default](../classes/roomle_configurator_api.default.md)
+
+### Interfaces
+
+- [RoomleEmbeddingApiKeys](../interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md)
+
+### Type aliases
+
+- [RoomleConfiguratorApi](roomle_configurator_api.md#roomleconfiguratorapi)
+- [RoomlePlannerApi](roomle_configurator_api.md#roomleplannerapi)
+- [RoomleViewerApi](roomle_configurator_api.md#roomleviewerapi)
+
+## Type aliases
+
+### RoomleConfiguratorApi
+
+Ƭ **RoomleConfiguratorApi**: [`default`](../classes/roomle_configurator_api.default.md)<`RoomleConfigurator`, `ConfiguratorUiCallbacks`\>
+
+#### Defined in
+
+[src/configurator/embedding/roomle-configurator-api.ts:69](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/roomle-configurator-api.ts#L69)
+
+___
+
+### RoomlePlannerApi
+
+Ƭ **RoomlePlannerApi**: [`default`](../classes/roomle_configurator_api.default.md)<`RoomlePlanner`, `ConfiguratorUiCallbacks`\>
+
+#### Defined in
+
+[src/configurator/embedding/roomle-configurator-api.ts:71](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/roomle-configurator-api.ts#L71)
+
+___
+
+### RoomleViewerApi
+
+Ƭ **RoomleViewerApi**: [`default`](../classes/roomle_configurator_api.default.md)<`RoomleGLBViewer`, `ConfiguratorUiCallbacks`\>
+
+#### Defined in
+
+[src/configurator/embedding/roomle-configurator-api.ts:70](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/roomle-configurator-api.ts#L70)

package/docs/api/modules/types.md

@@ -0,0 +1,16 @@
+[Embedding API Reference](../README.md) / [Modules](../modules.md) / types
+
+# Module: types
+
+## Table of contents
+
+### Enumerations
+
+- [UI\_BUTTON](../enums/types.UI_BUTTON.md)
+
+### Interfaces
+
+- [ConfiguratorSettings](../interfaces/types.ConfiguratorSettings.md)
+- [EmbeddingSkin](../interfaces/types.EmbeddingSkin.md)
+- [UiInitData](../interfaces/types.UiInitData.md)
+- [VariantsMap](../interfaces/types.VariantsMap.md)

package/docs/api/modules.md

@@ -0,0 +1,13 @@
+[Embedding API Reference](README.md) / Modules
+
+# Embedding API Reference
+
+## Table of contents
+
+### Modules
+
+- [exposed-analytics-callbacks](modules/exposed_analytics_callbacks.md)
+- [exposed-api](modules/exposed_api.md)
+- [exposed-callbacks](modules/exposed_callbacks.md)
+- [roomle-configurator-api](modules/roomle_configurator_api.md)
+- [types](modules/types.md)

package/docs/index.md

@@ -206,9 +206,9 @@ Here you will find some recipes for how you could implement certain use cases. T
 
 ### Instantiation
 
-We provide now two convenient ways to load a product into the configurator. Either you instantiate the Roomle Configurator without a product and use `loadObject` later or you pass in an ID as init-option. Both ways have their pros and cons. Let's review them quickly.
+We provide now two convenient ways to load a product into the configurator. Either you instantiate the Roomle Configurator without a product and use `loadObject` later or you pass in the `Roomle unique product ID` as init-option. Both ways have their pros and cons. Let's review them quickly.
 
-When you have a detail-page of a product in your webshop or website it makes sense to pass the ID as init-option (because you know which product your customer wants to see). This makes it possible that everything is loaded in parallel, the code of the configurator, and the content of your product. This speeds up the loading process. On the other hand, it makes no sense if you load some product when you do not know which product your customer wants to see in the configurator. This could be the case if the Roomle Configurator is opened on a list-view page where several products are listed. Here it makes sense to only instantiate the configurator. This only loads the code of the configurator. When the user then selects a product you can use the `loadObject` method to load this specific product.
+When you have a detail-page of a product in your webshop or website it makes sense to pass the `Roomle unique product ID` as init-option (because you know which product your customer wants to see). This makes it possible that everything is loaded in parallel, the code of the configurator, and the content of your product. This speeds up the loading process. On the other hand, it makes no sense if you load some product when you do not know which product your customer wants to see in the configurator. This could be the case if the Roomle Configurator is opened on a list-view page where several products are listed. Here it makes sense to only instantiate the configurator. This only loads the code of the configurator. When the user then selects a product you can use the `loadObject` method to load this specific product.
 
 ```JavaScript
 const objectToLoadId = 'usm:frame:BB3BB3E7951BC15109B1FF86D78C95DE3FB46E9F78714C46FFA2DE91866A2C2B';
@@ -778,7 +778,7 @@ const options = {
 };
 ```
 
-To see which labels exist you can take a look at the [API documentation](./api/interfaces/types.uiinitdata.html#translations)
+To see which labels exist you can take a look at the [API documentation](./api/interfaces/types.UiInitData.html#translations).
 
 You can test and play around with those settings in this CodeSandbox:
 [![Edit intelligent-merkle-s589m](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/intelligent-merkle-s589m?fontsize=14&hidenavigation=1&theme=dark)

package/docs/md/web/ui/EMBEDDING-CHANGELOG.md

@@ -1,6 +1,6 @@
-## [4.24.0-alpha.1](https://gitlab.com/roomle/web/roomle-ui/compare/embedding-v4.23.0...embedding-v4.24.0-alpha.1) (2021-11-03)
+## [4.24.0-alpha.5](https://gitlab.com/roomle/web/roomle-ui/compare/embedding-v4.24.0-alpha.4...embedding-v4.24.0-alpha.5) (2021-11-23)
 
 
 ### Features
 
-* upgrade SDK to version 2.19.0-alpha.1 ([f9e573f](https://gitlab.com/roomle/web/roomle-ui/commit/f9e573f08bb9718c1597ad4bc53198f87117e63f))
+* upgrade SDK to version 2.19.0 ([34c7760](https://gitlab.com/roomle/web/roomle-ui/commit/34c7760ec4877beef0e6645f9e12e466de185f08))

package/package.json

@@ -1 +1 @@
-{"name":"@roomle/embedding-lib","version":"4.24.0-alpha.1","main":"roomle-configurator-api.es.min.js","types":"types/index.d.ts","author":"Roomle Development","dependencies":{"@roomle/web-sdk":"2.19.0-alpha.1"},"devDependencies":{"@semantic-release/changelog":"^5.0.1","@semantic-release/exec":"^5.0.0","conventional-changelog-conventionalcommits":"^4.2.3","semantic-release":"^17.0.7"},"scripts":{"release":"semantic-release"},"description":"This is a small library which can be used to communicate with the Roomle Configurator","repository":{"type":"git","url":"git+https://github.com/roomle-build/npm-packages.git"},"publishConfig":{"access":"public"},"license":"MIT"}
+{"name":"@roomle/embedding-lib","version":"4.24.0-alpha.5","main":"roomle-configurator-api.es.min.js","types":"types/index.d.ts","author":"Roomle Development","dependencies":{"@roomle/web-sdk":"2.19.0"},"devDependencies":{"@semantic-release/changelog":"^5.0.1","@semantic-release/exec":"^5.0.0","conventional-changelog-conventionalcommits":"^4.2.3","semantic-release":"^17.0.7"},"scripts":{"release":"semantic-release"},"description":"This is a small library which can be used to communicate with the Roomle Configurator","repository":{"type":"git","url":"git+https://github.com/roomle-build/npm-packages.git"},"publishConfig":{"access":"public"},"license":"MIT"}