@roomle/embedding-lib 4.24.0 → 4.24.1-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 (34) hide show
  1. package/docs/api/.nojekyll +1 -0
  2. package/docs/api/classes/{exposed_analytics_callbacks.exposedanalyticscallbacks.md → exposed_analytics_callbacks.ExposedAnalyticsCallbacks.md} +11 -9
  3. package/docs/api/classes/exposed_api.ExposedApi.md +227 -0
  4. package/docs/api/classes/exposed_callbacks.ExposedCallbacks.md +171 -0
  5. package/docs/api/classes/roomle_configurator_api.default.md +78 -42
  6. package/docs/api/enums/types.UI_BUTTON.md +175 -0
  7. package/docs/api/interfaces/exposed_callbacks.Labels.md +32 -0
  8. package/docs/api/interfaces/exposed_callbacks.Price.md +32 -0
  9. package/docs/api/interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md +58 -0
  10. package/docs/api/interfaces/types.ConfiguratorSettings.md +150 -0
  11. package/docs/api/interfaces/types.EmbeddingSkin.md +65 -0
  12. package/docs/api/interfaces/types.UiInitData.md +1183 -0
  13. package/docs/api/interfaces/{types.variantsmap.md → types.VariantsMap.md} +1 -1
  14. package/docs/api/modules/exposed_analytics_callbacks.md +1 -1
  15. package/docs/api/modules/exposed_api.md +1 -1
  16. package/docs/api/modules/exposed_callbacks.md +3 -3
  17. package/docs/api/modules/roomle_configurator_api.md +13 -7
  18. package/docs/api/modules/types.md +5 -5
  19. package/docs/md/web/ui/EMBEDDING-CHANGELOG.md +8 -6
  20. package/package.json +1 -1
  21. package/roomle-configurator-api.cjs.js +1 -1
  22. package/roomle-configurator-api.cjs.min.js +1 -1
  23. package/roomle-configurator-api.es.js +1 -1
  24. package/roomle-configurator-api.es.min.js +1 -1
  25. package/roomle-configurator-api.js +1 -1
  26. package/docs/api/classes/exposed_api.exposedapi.md +0 -191
  27. package/docs/api/classes/exposed_callbacks.exposedcallbacks.md +0 -145
  28. package/docs/api/enums/types.ui_button.md +0 -145
  29. package/docs/api/interfaces/exposed_callbacks.labels.md +0 -28
  30. package/docs/api/interfaces/exposed_callbacks.price.md +0 -28
  31. package/docs/api/interfaces/roomle_configurator_api.roomleembeddingapikeys.md +0 -50
  32. package/docs/api/interfaces/types.configuratorsettings.md +0 -118
  33. package/docs/api/interfaces/types.embeddingskin.md +0 -55
  34. package/docs/api/interfaces/types.uiinitdata.md +0 -957
@@ -1,145 +0,0 @@
1
- [Embedding API Reference](../README.md) / [Modules](../modules.md) / [types](../modules/types.md) / UI_BUTTON
2
-
3
- # Enumeration: UI\_BUTTON
4
-
5
- [types](../modules/types.md).UI_BUTTON
6
-
7
- ## Table of contents
8
-
9
- ### Enumeration members
10
-
11
- - [ADDONS](types.ui_button.md#addons)
12
- - [AR](types.ui_button.md#ar)
13
- - [DIMENSIONS](types.ui_button.md#dimensions)
14
- - [EXPORT\_3D](types.ui_button.md#export_3d)
15
- - [FULLSCREEN](types.ui_button.md#fullscreen)
16
- - [MULTISELECT](types.ui_button.md#multiselect)
17
- - [PARTLIST](types.ui_button.md#partlist)
18
- - [PAUSECONFIGURE](types.ui_button.md#pauseconfigure)
19
- - [RENDERIMAGE](types.ui_button.md#renderimage)
20
- - [REQUESTPLAN](types.ui_button.md#requestplan)
21
- - [REQUESTPRODUCT](types.ui_button.md#requestproduct)
22
- - [RESETCAMERA](types.ui_button.md#resetcamera)
23
- - [ROTATE](types.ui_button.md#rotate)
24
- - [SAVEDRAFT](types.ui_button.md#savedraft)
25
- - [STARTCONFIGURE](types.ui_button.md#startconfigure)
26
-
27
- ## Enumeration members
28
-
29
- ### ADDONS
30
-
31
- • **ADDONS**: = "addons"
32
-
33
- Defined in: src/configurator/embedding/types.ts:15
34
-
35
- ___
36
-
37
- ### AR
38
-
39
- • **AR**: = "ar"
40
-
41
- Defined in: src/configurator/embedding/types.ts:8
42
-
43
- ___
44
-
45
- ### DIMENSIONS
46
-
47
- • **DIMENSIONS**: = "dimensions"
48
-
49
- Defined in: src/configurator/embedding/types.ts:11
50
-
51
- ___
52
-
53
- ### EXPORT\_3D
54
-
55
- • **EXPORT\_3D**: = "export3d"
56
-
57
- Defined in: src/configurator/embedding/types.ts:21
58
-
59
- ___
60
-
61
- ### FULLSCREEN
62
-
63
- • **FULLSCREEN**: = "fullscreen"
64
-
65
- Defined in: src/configurator/embedding/types.ts:12
66
-
67
- ___
68
-
69
- ### MULTISELECT
70
-
71
- • **MULTISELECT**: = "multiselect"
72
-
73
- Defined in: src/configurator/embedding/types.ts:10
74
-
75
- ___
76
-
77
- ### PARTLIST
78
-
79
- • **PARTLIST**: = "partlist"
80
-
81
- Defined in: src/configurator/embedding/types.ts:9
82
-
83
- ___
84
-
85
- ### PAUSECONFIGURE
86
-
87
- • **PAUSECONFIGURE**: = "pauseconfigure"
88
-
89
- Defined in: src/configurator/embedding/types.ts:20
90
-
91
- ___
92
-
93
- ### RENDERIMAGE
94
-
95
- • **RENDERIMAGE**: = "renderimage"
96
-
97
- Defined in: src/configurator/embedding/types.ts:14
98
-
99
- ___
100
-
101
- ### REQUESTPLAN
102
-
103
- • **REQUESTPLAN**: = "requestplan"
104
-
105
- Defined in: src/configurator/embedding/types.ts:17
106
-
107
- ___
108
-
109
- ### REQUESTPRODUCT
110
-
111
- • **REQUESTPRODUCT**: = "requestproduct"
112
-
113
- Defined in: src/configurator/embedding/types.ts:16
114
-
115
- ___
116
-
117
- ### RESETCAMERA
118
-
119
- • **RESETCAMERA**: = "resetcamera"
120
-
121
- Defined in: src/configurator/embedding/types.ts:13
122
-
123
- ___
124
-
125
- ### ROTATE
126
-
127
- • **ROTATE**: = "rotate"
128
-
129
- Defined in: src/configurator/embedding/types.ts:22
130
-
131
- ___
132
-
133
- ### SAVEDRAFT
134
-
135
- • **SAVEDRAFT**: = "savedraft"
136
-
137
- Defined in: src/configurator/embedding/types.ts:18
138
-
139
- ___
140
-
141
- ### STARTCONFIGURE
142
-
143
- • **STARTCONFIGURE**: = "startconfigure"
144
-
145
- Defined in: src/configurator/embedding/types.ts:19
@@ -1,28 +0,0 @@
1
- [Embedding API Reference](../README.md) / [Modules](../modules.md) / [exposed-callbacks](../modules/exposed_callbacks.md) / Labels
2
-
3
- # Interface: Labels
4
-
5
- [exposed-callbacks](../modules/exposed_callbacks.md).Labels
6
-
7
- ## Table of contents
8
-
9
- ### Properties
10
-
11
- - [catalogLabel](exposed_callbacks.labels.md#cataloglabel)
12
- - [label](exposed_callbacks.labels.md#label)
13
-
14
- ## Properties
15
-
16
- ### catalogLabel
17
-
18
- • **catalogLabel**: *Nullable*<string\>
19
-
20
- Defined in: src/configurator/embedding/exposed-callbacks.ts:14
21
-
22
- ___
23
-
24
- ### label
25
-
26
- • **label**: *Nullable*<string\>
27
-
28
- Defined in: src/configurator/embedding/exposed-callbacks.ts:15
@@ -1,28 +0,0 @@
1
- [Embedding API Reference](../README.md) / [Modules](../modules.md) / [exposed-callbacks](../modules/exposed_callbacks.md) / Price
2
-
3
- # Interface: Price
4
-
5
- [exposed-callbacks](../modules/exposed_callbacks.md).Price
6
-
7
- ## Table of contents
8
-
9
- ### Properties
10
-
11
- - [currencySymbol](exposed_callbacks.price.md#currencysymbol)
12
- - [price](exposed_callbacks.price.md#price)
13
-
14
- ## Properties
15
-
16
- ### currencySymbol
17
-
18
- • **currencySymbol**: *Nullable*<string\>
19
-
20
- Defined in: src/configurator/embedding/exposed-callbacks.ts:9
21
-
22
- ___
23
-
24
- ### price
25
-
26
- • **price**: *Nullable*<number\>
27
-
28
- Defined in: src/configurator/embedding/exposed-callbacks.ts:10
@@ -1,50 +0,0 @@
1
- [Embedding API Reference](../README.md) / [Modules](../modules.md) / [roomle-configurator-api](../modules/roomle_configurator_api.md) / RoomleEmbeddingApiKeys
2
-
3
- # Interface: RoomleEmbeddingApiKeys
4
-
5
- [roomle-configurator-api](../modules/roomle_configurator_api.md).RoomleEmbeddingApiKeys
6
-
7
- ## Implemented by
8
-
9
- - [*default*](../classes/roomle_configurator_api.default.md)
10
-
11
- ## Table of contents
12
-
13
- ### Properties
14
-
15
- - [analytics](roomle_configurator_api.roomleembeddingapikeys.md#analytics)
16
- - [extended](roomle_configurator_api.roomleembeddingapikeys.md#extended)
17
- - [global](roomle_configurator_api.roomleembeddingapikeys.md#global)
18
- - [ui](roomle_configurator_api.roomleembeddingapikeys.md#ui)
19
-
20
- ## Properties
21
-
22
- ### analytics
23
-
24
- • **analytics**: *any*
25
-
26
- Defined in: src/configurator/embedding/roomle-configurator-api.ts:65
27
-
28
- ___
29
-
30
- ### extended
31
-
32
- • **extended**: *any*
33
-
34
- Defined in: src/configurator/embedding/roomle-configurator-api.ts:63
35
-
36
- ___
37
-
38
- ### global
39
-
40
- • **global**: *any*
41
-
42
- Defined in: src/configurator/embedding/roomle-configurator-api.ts:66
43
-
44
- ___
45
-
46
- ### ui
47
-
48
- • **ui**: *any*
49
-
50
- Defined in: src/configurator/embedding/roomle-configurator-api.ts:64
@@ -1,118 +0,0 @@
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: RapiConfiguratorSettings.\_\_rapi\_path\_\_
35
-
36
- Defined in: node_modules/@roomle/web-sdk/lib/definitions/typings/rapi-types.d.ts:28
37
-
38
- ___
39
-
40
- ### allowedHost
41
-
42
- • **allowedHost**: *string*
43
-
44
- Defined in: src/configurator/embedding/types.ts:140
45
-
46
- ___
47
-
48
- ### allowedHosts
49
-
50
- • **allowedHosts**: *string*[]
51
-
52
- Inherited from: RapiConfiguratorSettings.allowedHosts
53
-
54
- Defined in: node_modules/@roomle/web-sdk/lib/definitions/typings/rapi-types.d.ts:422
55
-
56
- ___
57
-
58
- ### id
59
-
60
- • **id**: *string*
61
-
62
- Overrides: RapiConfiguratorSettings.id
63
-
64
- Defined in: src/configurator/embedding/types.ts:139
65
-
66
- ___
67
-
68
- ### isLocally
69
-
70
- • `Optional` **isLocally**: *boolean*
71
-
72
- Inherited from: RapiConfiguratorSettings.isLocally
73
-
74
- Defined in: node_modules/@roomle/web-sdk/lib/definitions/typings/rapi-types.d.ts:27
75
-
76
- ___
77
-
78
- ### links
79
-
80
- • `Optional` **links**: LinksCollection
81
-
82
- Inherited from: RapiConfiguratorSettings.links
83
-
84
- Defined in: node_modules/@roomle/web-sdk/lib/definitions/typings/rapi-types.d.ts:30
85
-
86
- ___
87
-
88
- ### settings
89
-
90
- • **settings**: [*UiInitData*](types.uiinitdata.md)
91
-
92
- Defined in: src/configurator/embedding/types.ts:143
93
-
94
- ___
95
-
96
- ### tenant
97
-
98
- • **tenant**: *number*
99
-
100
- Defined in: src/configurator/embedding/types.ts:141
101
-
102
- ___
103
-
104
- ### tenant\_id
105
-
106
- • **tenant\_id**: *string*
107
-
108
- Inherited from: RapiConfiguratorSettings.tenant\_id
109
-
110
- Defined in: node_modules/@roomle/web-sdk/lib/definitions/typings/rapi-types.d.ts:423
111
-
112
- ___
113
-
114
- ### url
115
-
116
- • **url**: *string*
117
-
118
- Defined in: src/configurator/embedding/types.ts:142
@@ -1,55 +0,0 @@
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: src/configurator/embedding/types.ts:134
24
-
25
- ___
26
-
27
- ### color-on-primary
28
-
29
- • `Optional` **color-on-primary**: *string*
30
-
31
- Defined in: src/configurator/embedding/types.ts:132
32
-
33
- ___
34
-
35
- ### cta-color
36
-
37
- • `Optional` **cta-color**: *string*
38
-
39
- Defined in: src/configurator/embedding/types.ts:133
40
-
41
- ___
42
-
43
- ### primary-color
44
-
45
- • `Optional` **primary-color**: *string*
46
-
47
- Defined in: src/configurator/embedding/types.ts:130
48
-
49
- ___
50
-
51
- ### primary-color-in-rgb
52
-
53
- • `Optional` **primary-color-in-rgb**: *string*
54
-
55
- Defined in: src/configurator/embedding/types.ts:131