@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
  1. package/docs/api/.nojekyll +1 -0
  2. package/docs/api/README.md +1 -1
  3. package/docs/api/classes/{exposed_analytics_callbacks.exposedanalyticscallbacks.md → exposed_analytics_callbacks.ExposedAnalyticsCallbacks.md} +11 -9
  4. package/docs/api/classes/exposed_api.ExposedApi.md +255 -0
  5. package/docs/api/classes/exposed_callbacks.ExposedCallbacks.md +171 -0
  6. package/docs/api/classes/roomle_configurator_api.default.md +78 -42
  7. package/docs/api/enums/types.UI_BUTTON.md +208 -0
  8. package/docs/api/interfaces/exposed_callbacks.Labels.md +32 -0
  9. package/docs/api/interfaces/exposed_callbacks.Price.md +32 -0
  10. package/docs/api/interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md +58 -0
  11. package/docs/api/interfaces/types.ConfiguratorSettings.md +150 -0
  12. package/docs/api/interfaces/types.EmbeddingSkin.md +65 -0
  13. package/docs/api/interfaces/types.UiInitData.md +1204 -0
  14. package/docs/api/interfaces/{types.variantsmap.md → types.VariantsMap.md} +1 -1
  15. package/docs/api/modules/exposed_analytics_callbacks.md +1 -1
  16. package/docs/api/modules/exposed_api.md +1 -1
  17. package/docs/api/modules/exposed_callbacks.md +3 -3
  18. package/docs/api/modules/roomle_configurator_api.md +13 -7
  19. package/docs/api/modules/types.md +5 -5
  20. package/docs/index.md +31 -0
  21. package/docs/md/web/ui/EMBEDDING-CHANGELOG.md +67 -7
  22. package/package.json +28 -1
  23. package/roomle-configurator-api.cjs.js +47 -3
  24. package/roomle-configurator-api.cjs.min.js +1 -1
  25. package/roomle-configurator-api.es.js +47 -3
  26. package/roomle-configurator-api.es.min.js +1 -1
  27. package/roomle-configurator-api.js +47 -3
  28. package/types/index.d.ts +190 -129
  29. package/types/src/common/store/collection-view-state.d.ts +2 -2
  30. package/types/src/common/store/index.d.ts +6 -0
  31. package/types/src/common/utils/helper.d.ts +3 -0
  32. package/types/src/common/utils/types.d.ts +3 -2
  33. package/types/src/configurator/business-logic/sdk-connector.d.ts +1 -0
  34. package/types/src/configurator/components/-utils/overlays.d.ts +8 -8
  35. package/types/src/configurator/components/grid-view/-utils/GridViewHelper.d.ts +3 -0
  36. package/types/src/configurator/embedding/exposed-api.d.ts +10 -0
  37. package/types/src/configurator/embedding/types.d.ts +7 -1
  38. package/types/src/configurator/store/ui-state.d.ts +19 -3
  39. package/types/tests/helpers/data/variants.d.ts +60 -0
  40. package/types/tests/helpers/mocks/sdk-connector-planner.d.ts +13 -0
  41. package/types/tests/helpers/mocks/sdk-connector.d.ts +5 -0
  42. package/types/tests/integration/configurator/components/{overlays/PartList.spec.d.ts → parameters/types/ProductVariant.spec.d.ts} +0 -0
  43. package/types/tests/integration/planner/components/BottomBar.spec.d.ts +1 -0
  44. package/docs/api/classes/exposed_api.exposedapi.md +0 -191
  45. package/docs/api/classes/exposed_callbacks.exposedcallbacks.md +0 -145
  46. package/docs/api/enums/types.ui_button.md +0 -145
  47. package/docs/api/interfaces/exposed_callbacks.labels.md +0 -28
  48. package/docs/api/interfaces/exposed_callbacks.price.md +0 -28
  49. package/docs/api/interfaces/roomle_configurator_api.roomleembeddingapikeys.md +0 -50
  50. package/docs/api/interfaces/types.configuratorsettings.md +0 -118
  51. package/docs/api/interfaces/types.embeddingskin.md +0 -55
  52. package/docs/api/interfaces/types.uiinitdata.md +0 -957
package/docs/api/interfaces/types.ConfiguratorSettings.md ADDED
@@ -0,0 +1,150 @@
1
+ [Embedding API Reference](../README.md) / [Modules](../modules.md) / [types](../modules/types.md) / ConfiguratorSettings
2
+
3
+ # Interface: ConfiguratorSettings
4
+
5
+ [types](../modules/types.md).ConfiguratorSettings
6
+
7
+ ## Hierarchy
8
+
9
+ - `RapiConfiguratorSettings`
10
+
11
+ ↳ **`ConfiguratorSettings`**
12
+
13
+ ## Table of contents
14
+
15
+ ### Properties
16
+
17
+ - [\_\_rapi\_path\_\_](types.ConfiguratorSettings.md#__rapi_path__)
18
+ - [allowedHost](types.ConfiguratorSettings.md#allowedhost)
19
+ - [allowedHosts](types.ConfiguratorSettings.md#allowedhosts)
20
+ - [id](types.ConfiguratorSettings.md#id)
21
+ - [isLocally](types.ConfiguratorSettings.md#islocally)
22
+ - [links](types.ConfiguratorSettings.md#links)
23
+ - [settings](types.ConfiguratorSettings.md#settings)
24
+ - [tenant](types.ConfiguratorSettings.md#tenant)
25
+ - [tenant\_id](types.ConfiguratorSettings.md#tenant_id)
26
+ - [url](types.ConfiguratorSettings.md#url)
27
+
28
+ ## Properties
29
+
30
+ ### \_\_rapi\_path\_\_
31
+
32
+ • `Optional` **\_\_rapi\_path\_\_**: `string`
33
+
34
+ #### Inherited from
35
+
36
+ RapiConfiguratorSettings.\_\_rapi\_path\_\_
37
+
38
+ #### Defined in
39
+
40
+ node_modules/@roomle/web-sdk/lib/definitions/typings/rapi-types.d.ts:28
41
+
42
+ ___
43
+
44
+ ### allowedHost
45
+
46
+ • **allowedHost**: `string`
47
+
48
+ #### Defined in
49
+
50
+ [src/configurator/embedding/types.ts:146](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L146)
51
+
52
+ ___
53
+
54
+ ### allowedHosts
55
+
56
+ • **allowedHosts**: `string`[]
57
+
58
+ #### Inherited from
59
+
60
+ RapiConfiguratorSettings.allowedHosts
61
+
62
+ #### Defined in
63
+
64
+ node_modules/@roomle/web-sdk/lib/definitions/typings/rapi-types.d.ts:422
65
+
66
+ ___
67
+
68
+ ### id
69
+
70
+ • **id**: `string`
71
+
72
+ #### Overrides
73
+
74
+ RapiConfiguratorSettings.id
75
+
76
+ #### Defined in
77
+
78
+ [src/configurator/embedding/types.ts:145](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L145)
79
+
80
+ ___
81
+
82
+ ### isLocally
83
+
84
+ • `Optional` **isLocally**: false \| true
85
+
86
+ #### Inherited from
87
+
88
+ RapiConfiguratorSettings.isLocally
89
+
90
+ #### Defined in
91
+
92
+ node_modules/@roomle/web-sdk/lib/definitions/typings/rapi-types.d.ts:27
93
+
94
+ ___
95
+
96
+ ### links
97
+
98
+ • `Optional` **links**: `LinksCollection`
99
+
100
+ #### Inherited from
101
+
102
+ RapiConfiguratorSettings.links
103
+
104
+ #### Defined in
105
+
106
+ node_modules/@roomle/web-sdk/lib/definitions/typings/rapi-types.d.ts:30
107
+
108
+ ___
109
+
110
+ ### settings
111
+
112
+ • **settings**: [`UiInitData`](types.UiInitData.md)
113
+
114
+ #### Defined in
115
+
116
+ [src/configurator/embedding/types.ts:149](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L149)
117
+
118
+ ___
119
+
120
+ ### tenant
121
+
122
+ • **tenant**: `number`
123
+
124
+ #### Defined in
125
+
126
+ [src/configurator/embedding/types.ts:147](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L147)
127
+
128
+ ___
129
+
130
+ ### tenant\_id
131
+
132
+ • **tenant\_id**: `string`
133
+
134
+ #### Inherited from
135
+
136
+ RapiConfiguratorSettings.tenant\_id
137
+
138
+ #### Defined in
139
+
140
+ node_modules/@roomle/web-sdk/lib/definitions/typings/rapi-types.d.ts:423
141
+
142
+ ___
143
+
144
+ ### url
145
+
146
+ • **url**: `string`
147
+
148
+ #### Defined in
149
+
150
+ [src/configurator/embedding/types.ts:148](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L148)
package/docs/api/interfaces/types.EmbeddingSkin.md ADDED
@@ -0,0 +1,65 @@
1
+ [Embedding API Reference](../README.md) / [Modules](../modules.md) / [types](../modules/types.md) / EmbeddingSkin
2
+
3
+ # Interface: EmbeddingSkin
4
+
5
+ [types](../modules/types.md).EmbeddingSkin
6
+
7
+ ## Table of contents
8
+
9
+ ### Properties
10
+
11
+ - [color-on-cta](types.EmbeddingSkin.md#color-on-cta)
12
+ - [color-on-primary](types.EmbeddingSkin.md#color-on-primary)
13
+ - [cta-color](types.EmbeddingSkin.md#cta-color)
14
+ - [primary-color](types.EmbeddingSkin.md#primary-color)
15
+ - [primary-color-in-rgb](types.EmbeddingSkin.md#primary-color-in-rgb)
16
+
17
+ ## Properties
18
+
19
+ ### color-on-cta
20
+
21
+ • `Optional` **color-on-cta**: `string`
22
+
23
+ #### Defined in
24
+
25
+ [src/configurator/embedding/types.ts:141](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L141)
26
+
27
+ ___
28
+
29
+ ### color-on-primary
30
+
31
+ • `Optional` **color-on-primary**: `string`
32
+
33
+ #### Defined in
34
+
35
+ [src/configurator/embedding/types.ts:139](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L139)
36
+
37
+ ___
38
+
39
+ ### cta-color
40
+
41
+ • `Optional` **cta-color**: `string`
42
+
43
+ #### Defined in
44
+
45
+ [src/configurator/embedding/types.ts:140](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L140)
46
+
47
+ ___
48
+
49
+ ### primary-color
50
+
51
+ • `Optional` **primary-color**: `string`
52
+
53
+ #### Defined in
54
+
55
+ [src/configurator/embedding/types.ts:137](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L137)
56
+
57
+ ___
58
+
59
+ ### primary-color-in-rgb
60
+
61
+ • `Optional` **primary-color-in-rgb**: `string`
62
+
63
+ #### Defined in
64
+
65
+ [src/configurator/embedding/types.ts:138](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L138)