@roomle/embedding-lib 4.23.0 → 4.24.0-alpha.4
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.
- package/docs/api/.nojekyll +1 -0
- package/docs/api/classes/{exposed_analytics_callbacks.exposedanalyticscallbacks.md → exposed_analytics_callbacks.ExposedAnalyticsCallbacks.md} +11 -9
- package/docs/api/classes/exposed_api.ExposedApi.md +227 -0
- package/docs/api/classes/exposed_callbacks.ExposedCallbacks.md +171 -0
- package/docs/api/classes/roomle_configurator_api.default.md +78 -42
- package/docs/api/enums/types.UI_BUTTON.md +175 -0
- package/docs/api/interfaces/exposed_callbacks.Labels.md +32 -0
- package/docs/api/interfaces/exposed_callbacks.Price.md +32 -0
- package/docs/api/interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md +58 -0
- package/docs/api/interfaces/types.ConfiguratorSettings.md +150 -0
- package/docs/api/interfaces/types.EmbeddingSkin.md +65 -0
- package/docs/api/interfaces/types.UiInitData.md +1183 -0
- package/docs/api/interfaces/{types.variantsmap.md → types.VariantsMap.md} +1 -1
- package/docs/api/modules/exposed_analytics_callbacks.md +1 -1
- package/docs/api/modules/exposed_api.md +1 -1
- package/docs/api/modules/exposed_callbacks.md +3 -3
- package/docs/api/modules/roomle_configurator_api.md +13 -7
- package/docs/api/modules/types.md +5 -5
- package/docs/index.md +1 -1
- package/docs/md/web/ui/EMBEDDING-CHANGELOG.md +2 -12
- package/package.json +1 -1
- package/roomle-configurator-api.cjs.js +1 -1
- package/roomle-configurator-api.cjs.min.js +1 -1
- package/roomle-configurator-api.es.js +2 -2
- package/roomle-configurator-api.es.min.js +1 -1
- package/roomle-configurator-api.js +2 -2
- package/docs/api/classes/exposed_api.exposedapi.md +0 -191
- package/docs/api/classes/exposed_callbacks.exposedcallbacks.md +0 -141
- package/docs/api/enums/types.ui_button.md +0 -154
- package/docs/api/interfaces/exposed_callbacks.labels.md +0 -28
- package/docs/api/interfaces/exposed_callbacks.price.md +0 -28
- package/docs/api/interfaces/roomle_configurator_api.roomleembeddingapikeys.md +0 -50
- package/docs/api/interfaces/types.configuratorsettings.md +0 -118
- package/docs/api/interfaces/types.embeddingskin.md +0 -55
- package/docs/api/interfaces/types.uiinitdata.md +0 -957
|
@@ -1,154 +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
|
-
- [VARIANTS](types.ui_button.md#variants)
|
|
27
|
-
|
|
28
|
-
## Enumeration members
|
|
29
|
-
|
|
30
|
-
### ADDONS
|
|
31
|
-
|
|
32
|
-
• **ADDONS**: = "addons"
|
|
33
|
-
|
|
34
|
-
Defined in: src/configurator/embedding/types.ts:15
|
|
35
|
-
|
|
36
|
-
___
|
|
37
|
-
|
|
38
|
-
### AR
|
|
39
|
-
|
|
40
|
-
• **AR**: = "ar"
|
|
41
|
-
|
|
42
|
-
Defined in: src/configurator/embedding/types.ts:8
|
|
43
|
-
|
|
44
|
-
___
|
|
45
|
-
|
|
46
|
-
### DIMENSIONS
|
|
47
|
-
|
|
48
|
-
• **DIMENSIONS**: = "dimensions"
|
|
49
|
-
|
|
50
|
-
Defined in: src/configurator/embedding/types.ts:11
|
|
51
|
-
|
|
52
|
-
___
|
|
53
|
-
|
|
54
|
-
### EXPORT\_3D
|
|
55
|
-
|
|
56
|
-
• **EXPORT\_3D**: = "export3d"
|
|
57
|
-
|
|
58
|
-
Defined in: src/configurator/embedding/types.ts:22
|
|
59
|
-
|
|
60
|
-
___
|
|
61
|
-
|
|
62
|
-
### FULLSCREEN
|
|
63
|
-
|
|
64
|
-
• **FULLSCREEN**: = "fullscreen"
|
|
65
|
-
|
|
66
|
-
Defined in: src/configurator/embedding/types.ts:12
|
|
67
|
-
|
|
68
|
-
___
|
|
69
|
-
|
|
70
|
-
### MULTISELECT
|
|
71
|
-
|
|
72
|
-
• **MULTISELECT**: = "multiselect"
|
|
73
|
-
|
|
74
|
-
Defined in: src/configurator/embedding/types.ts:10
|
|
75
|
-
|
|
76
|
-
___
|
|
77
|
-
|
|
78
|
-
### PARTLIST
|
|
79
|
-
|
|
80
|
-
• **PARTLIST**: = "partlist"
|
|
81
|
-
|
|
82
|
-
Defined in: src/configurator/embedding/types.ts:9
|
|
83
|
-
|
|
84
|
-
___
|
|
85
|
-
|
|
86
|
-
### PAUSECONFIGURE
|
|
87
|
-
|
|
88
|
-
• **PAUSECONFIGURE**: = "pauseconfigure"
|
|
89
|
-
|
|
90
|
-
Defined in: src/configurator/embedding/types.ts:20
|
|
91
|
-
|
|
92
|
-
___
|
|
93
|
-
|
|
94
|
-
### RENDERIMAGE
|
|
95
|
-
|
|
96
|
-
• **RENDERIMAGE**: = "renderimage"
|
|
97
|
-
|
|
98
|
-
Defined in: src/configurator/embedding/types.ts:14
|
|
99
|
-
|
|
100
|
-
___
|
|
101
|
-
|
|
102
|
-
### REQUESTPLAN
|
|
103
|
-
|
|
104
|
-
• **REQUESTPLAN**: = "requestplan"
|
|
105
|
-
|
|
106
|
-
Defined in: src/configurator/embedding/types.ts:17
|
|
107
|
-
|
|
108
|
-
___
|
|
109
|
-
|
|
110
|
-
### REQUESTPRODUCT
|
|
111
|
-
|
|
112
|
-
• **REQUESTPRODUCT**: = "requestproduct"
|
|
113
|
-
|
|
114
|
-
Defined in: src/configurator/embedding/types.ts:16
|
|
115
|
-
|
|
116
|
-
___
|
|
117
|
-
|
|
118
|
-
### RESETCAMERA
|
|
119
|
-
|
|
120
|
-
• **RESETCAMERA**: = "resetcamera"
|
|
121
|
-
|
|
122
|
-
Defined in: src/configurator/embedding/types.ts:13
|
|
123
|
-
|
|
124
|
-
___
|
|
125
|
-
|
|
126
|
-
### ROTATE
|
|
127
|
-
|
|
128
|
-
• **ROTATE**: = "rotate"
|
|
129
|
-
|
|
130
|
-
Defined in: src/configurator/embedding/types.ts:23
|
|
131
|
-
|
|
132
|
-
___
|
|
133
|
-
|
|
134
|
-
### SAVEDRAFT
|
|
135
|
-
|
|
136
|
-
• **SAVEDRAFT**: = "savedraft"
|
|
137
|
-
|
|
138
|
-
Defined in: src/configurator/embedding/types.ts:18
|
|
139
|
-
|
|
140
|
-
___
|
|
141
|
-
|
|
142
|
-
### STARTCONFIGURE
|
|
143
|
-
|
|
144
|
-
• **STARTCONFIGURE**: = "startconfigure"
|
|
145
|
-
|
|
146
|
-
Defined in: src/configurator/embedding/types.ts:19
|
|
147
|
-
|
|
148
|
-
___
|
|
149
|
-
|
|
150
|
-
### VARIANTS
|
|
151
|
-
|
|
152
|
-
• **VARIANTS**: = "variants"
|
|
153
|
-
|
|
154
|
-
Defined in: src/configurator/embedding/types.ts:21
|
|
@@ -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:141
|
|
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:140
|
|
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:144
|
|
93
|
-
|
|
94
|
-
___
|
|
95
|
-
|
|
96
|
-
### tenant
|
|
97
|
-
|
|
98
|
-
• **tenant**: *number*
|
|
99
|
-
|
|
100
|
-
Defined in: src/configurator/embedding/types.ts:142
|
|
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:143
|
|
@@ -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:135
|
|
24
|
-
|
|
25
|
-
___
|
|
26
|
-
|
|
27
|
-
### color-on-primary
|
|
28
|
-
|
|
29
|
-
• `Optional` **color-on-primary**: *string*
|
|
30
|
-
|
|
31
|
-
Defined in: src/configurator/embedding/types.ts:133
|
|
32
|
-
|
|
33
|
-
___
|
|
34
|
-
|
|
35
|
-
### cta-color
|
|
36
|
-
|
|
37
|
-
• `Optional` **cta-color**: *string*
|
|
38
|
-
|
|
39
|
-
Defined in: src/configurator/embedding/types.ts:134
|
|
40
|
-
|
|
41
|
-
___
|
|
42
|
-
|
|
43
|
-
### primary-color
|
|
44
|
-
|
|
45
|
-
• `Optional` **primary-color**: *string*
|
|
46
|
-
|
|
47
|
-
Defined in: src/configurator/embedding/types.ts:131
|
|
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:132
|