@roomle/embedding-lib 4.38.0 → 4.39.0

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 (19) hide show
  1. package/docs/api/classes/exposed_analytics_callbacks.ExposedAnalyticsCallbacks.md +1 -1
  2. package/docs/api/classes/exposed_api.ExposedApi.md +11 -11
  3. package/docs/api/classes/exposed_callbacks.ExposedCallbacks.md +8 -8
  4. package/docs/api/classes/roomle_configurator_api.default.md +9 -9
  5. package/docs/api/enums/types.UI_BUTTON.md +22 -22
  6. package/docs/api/interfaces/exposed_callbacks.Labels.md +2 -2
  7. package/docs/api/interfaces/exposed_callbacks.Price.md +2 -2
  8. package/docs/api/interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md +4 -4
  9. package/docs/api/interfaces/types.ConfiguratorSettings.md +5 -5
  10. package/docs/api/interfaces/types.EmbeddingSkin.md +5 -5
  11. package/docs/api/interfaces/types.UiInitData.md +16 -16
  12. package/docs/api/modules/roomle_configurator_api.md +3 -3
  13. package/docs/examples/11_light_settings.html +89 -62
  14. package/docs/examples/roomle-configurator-api.es.min.js +254 -58
  15. package/docs/md/web/ui/EMBEDDING-CHANGELOG.md +21 -37
  16. package/package.json +2 -2
  17. package/types/index.d.ts +7 -3
  18. package/types/src/common/store/collection-view-state.d.ts +7 -3
  19. package/types/tests/helpers/mocks/sdk-connector.d.ts +1 -0
package/docs/api/interfaces/types.UiInitData.md CHANGED
@@ -127,7 +127,7 @@ to view 3d content. Imagine it then as a <img> tag for 3d content
127
127
 
128
128
  #### Defined in
129
129
 
130
- [src/configurator/embedding/types.ts:90](https://gitlab.com/roomle/web/roomle-ui/-/blob/69e35fbb/src/configurator/embedding/types.ts#L90)
130
+ [src/configurator/embedding/types.ts:90](https://gitlab.com/roomle/web/roomle-ui/-/blob/10155475/src/configurator/embedding/types.ts#L90)
131
131
 
132
132
  ___
133
133
 
@@ -144,7 +144,7 @@ InitDataDefinition.applyCurrentGlobalParameters
144
144
 
145
145
  #### Defined in
146
146
 
147
- [src/configurator/embedding/types.ts:137](https://gitlab.com/roomle/web/roomle-ui/-/blob/69e35fbb/src/configurator/embedding/types.ts#L137)
147
+ [src/configurator/embedding/types.ts:137](https://gitlab.com/roomle/web/roomle-ui/-/blob/10155475/src/configurator/embedding/types.ts#L137)
148
148
 
149
149
  ___
150
150
 
@@ -214,7 +214,7 @@ ___
214
214
 
215
215
  #### Defined in
216
216
 
217
- [src/configurator/embedding/types.ts:39](https://gitlab.com/roomle/web/roomle-ui/-/blob/69e35fbb/src/configurator/embedding/types.ts#L39)
217
+ [src/configurator/embedding/types.ts:39](https://gitlab.com/roomle/web/roomle-ui/-/blob/10155475/src/configurator/embedding/types.ts#L39)
218
218
 
219
219
  ___
220
220
 
@@ -345,7 +345,7 @@ usage: http://www.example.com/configurator?id=#CONFIGURATIONID#
345
345
 
346
346
  #### Defined in
347
347
 
348
- [src/configurator/embedding/types.ts:77](https://gitlab.com/roomle/web/roomle-ui/-/blob/69e35fbb/src/configurator/embedding/types.ts#L77)
348
+ [src/configurator/embedding/types.ts:77](https://gitlab.com/roomle/web/roomle-ui/-/blob/10155475/src/configurator/embedding/types.ts#L77)
349
349
 
350
350
  ___
351
351
 
@@ -410,7 +410,7 @@ an e-mail
410
410
 
411
411
  #### Defined in
412
412
 
413
- [src/configurator/embedding/types.ts:95](https://gitlab.com/roomle/web/roomle-ui/-/blob/69e35fbb/src/configurator/embedding/types.ts#L95)
413
+ [src/configurator/embedding/types.ts:95](https://gitlab.com/roomle/web/roomle-ui/-/blob/10155475/src/configurator/embedding/types.ts#L95)
414
414
 
415
415
  ___
416
416
 
@@ -424,7 +424,7 @@ so that we can ensure a smooth transition between different versions of our conf
424
424
 
425
425
  #### Defined in
426
426
 
427
- [src/configurator/embedding/types.ts:111](https://gitlab.com/roomle/web/roomle-ui/-/blob/69e35fbb/src/configurator/embedding/types.ts#L111)
427
+ [src/configurator/embedding/types.ts:111](https://gitlab.com/roomle/web/roomle-ui/-/blob/10155475/src/configurator/embedding/types.ts#L111)
428
428
 
429
429
  ___
430
430
 
@@ -452,7 +452,7 @@ set this flag to false if the user did not give the consent to Analytics
452
452
 
453
453
  #### Defined in
454
454
 
455
- [src/configurator/embedding/types.ts:115](https://gitlab.com/roomle/web/roomle-ui/-/blob/69e35fbb/src/configurator/embedding/types.ts#L115)
455
+ [src/configurator/embedding/types.ts:115](https://gitlab.com/roomle/web/roomle-ui/-/blob/10155475/src/configurator/embedding/types.ts#L115)
456
456
 
457
457
  ___
458
458
 
@@ -464,7 +464,7 @@ set this flag to true if you want to group the part list by main components
464
464
 
465
465
  #### Defined in
466
466
 
467
- [src/configurator/embedding/types.ts:105](https://gitlab.com/roomle/web/roomle-ui/-/blob/69e35fbb/src/configurator/embedding/types.ts#L105)
467
+ [src/configurator/embedding/types.ts:105](https://gitlab.com/roomle/web/roomle-ui/-/blob/10155475/src/configurator/embedding/types.ts#L105)
468
468
 
469
469
  ___
470
470
 
@@ -651,7 +651,7 @@ small div
651
651
 
652
652
  #### Defined in
653
653
 
654
- [src/configurator/embedding/types.ts:101](https://gitlab.com/roomle/web/roomle-ui/-/blob/69e35fbb/src/configurator/embedding/types.ts#L101)
654
+ [src/configurator/embedding/types.ts:101](https://gitlab.com/roomle/web/roomle-ui/-/blob/10155475/src/configurator/embedding/types.ts#L101)
655
655
 
656
656
  ___
657
657
 
@@ -772,7 +772,7 @@ ___
772
772
 
773
773
  #### Defined in
774
774
 
775
- [src/configurator/embedding/types.ts:63](https://gitlab.com/roomle/web/roomle-ui/-/blob/69e35fbb/src/configurator/embedding/types.ts#L63)
775
+ [src/configurator/embedding/types.ts:63](https://gitlab.com/roomle/web/roomle-ui/-/blob/10155475/src/configurator/embedding/types.ts#L63)
776
776
 
777
777
  ___
778
778
 
@@ -887,7 +887,7 @@ for details see deeplink, the only change is that the placeholder is <CONF_ID> h
887
887
 
888
888
  #### Defined in
889
889
 
890
- [src/configurator/embedding/types.ts:68](https://gitlab.com/roomle/web/roomle-ui/-/blob/69e35fbb/src/configurator/embedding/types.ts#L68)
890
+ [src/configurator/embedding/types.ts:68](https://gitlab.com/roomle/web/roomle-ui/-/blob/10155475/src/configurator/embedding/types.ts#L68)
891
891
 
892
892
  ___
893
893
 
@@ -949,7 +949,7 @@ ___
949
949
 
950
950
  #### Defined in
951
951
 
952
- [src/configurator/embedding/types.ts:60](https://gitlab.com/roomle/web/roomle-ui/-/blob/69e35fbb/src/configurator/embedding/types.ts#L60)
952
+ [src/configurator/embedding/types.ts:60](https://gitlab.com/roomle/web/roomle-ui/-/blob/10155475/src/configurator/embedding/types.ts#L60)
953
953
 
954
954
  ___
955
955
 
@@ -1007,7 +1007,7 @@ You can find all labels here: [Base.json](../../../ui/base.json)
1007
1007
 
1008
1008
  #### Defined in
1009
1009
 
1010
- [src/configurator/embedding/types.ts:132](https://gitlab.com/roomle/web/roomle-ui/-/blob/69e35fbb/src/configurator/embedding/types.ts#L132)
1010
+ [src/configurator/embedding/types.ts:132](https://gitlab.com/roomle/web/roomle-ui/-/blob/10155475/src/configurator/embedding/types.ts#L132)
1011
1011
 
1012
1012
  ___
1013
1013
 
@@ -1088,7 +1088,7 @@ ___
1088
1088
 
1089
1089
  #### Defined in
1090
1090
 
1091
- [src/configurator/embedding/types.ts:62](https://gitlab.com/roomle/web/roomle-ui/-/blob/69e35fbb/src/configurator/embedding/types.ts#L62)
1091
+ [src/configurator/embedding/types.ts:62](https://gitlab.com/roomle/web/roomle-ui/-/blob/10155475/src/configurator/embedding/types.ts#L62)
1092
1092
 
1093
1093
  ___
1094
1094
 
@@ -1139,7 +1139,7 @@ usm:frame is loaded all the items from the tag "DB_Start_ohne_Element" are now s
1139
1139
 
1140
1140
  #### Defined in
1141
1141
 
1142
- [src/configurator/embedding/types.ts:84](https://gitlab.com/roomle/web/roomle-ui/-/blob/69e35fbb/src/configurator/embedding/types.ts#L84)
1142
+ [src/configurator/embedding/types.ts:84](https://gitlab.com/roomle/web/roomle-ui/-/blob/10155475/src/configurator/embedding/types.ts#L84)
1143
1143
 
1144
1144
  ___
1145
1145
 
@@ -1149,7 +1149,7 @@ ___
1149
1149
 
1150
1150
  #### Defined in
1151
1151
 
1152
- [src/configurator/embedding/types.ts:61](https://gitlab.com/roomle/web/roomle-ui/-/blob/69e35fbb/src/configurator/embedding/types.ts#L61)
1152
+ [src/configurator/embedding/types.ts:61](https://gitlab.com/roomle/web/roomle-ui/-/blob/10155475/src/configurator/embedding/types.ts#L61)
1153
1153
 
1154
1154
  ___
1155
1155
 
package/docs/api/modules/roomle_configurator_api.md CHANGED
@@ -26,7 +26,7 @@
26
26
 
27
27
  #### Defined in
28
28
 
29
- [src/configurator/embedding/roomle-configurator-api.ts:70](https://gitlab.com/roomle/web/roomle-ui/-/blob/69e35fbb/src/configurator/embedding/roomle-configurator-api.ts#L70)
29
+ [src/configurator/embedding/roomle-configurator-api.ts:70](https://gitlab.com/roomle/web/roomle-ui/-/blob/10155475/src/configurator/embedding/roomle-configurator-api.ts#L70)
30
30
 
31
31
  ___
32
32
 
@@ -36,7 +36,7 @@ ___
36
36
 
37
37
  #### Defined in
38
38
 
39
- [src/configurator/embedding/roomle-configurator-api.ts:72](https://gitlab.com/roomle/web/roomle-ui/-/blob/69e35fbb/src/configurator/embedding/roomle-configurator-api.ts#L72)
39
+ [src/configurator/embedding/roomle-configurator-api.ts:72](https://gitlab.com/roomle/web/roomle-ui/-/blob/10155475/src/configurator/embedding/roomle-configurator-api.ts#L72)
40
40
 
41
41
  ___
42
42
 
@@ -46,4 +46,4 @@ ___
46
46
 
47
47
  #### Defined in
48
48
 
49
- [src/configurator/embedding/roomle-configurator-api.ts:71](https://gitlab.com/roomle/web/roomle-ui/-/blob/69e35fbb/src/configurator/embedding/roomle-configurator-api.ts#L71)
49
+ [src/configurator/embedding/roomle-configurator-api.ts:71](https://gitlab.com/roomle/web/roomle-ui/-/blob/10155475/src/configurator/embedding/roomle-configurator-api.ts#L71)
package/docs/examples/11_light_settings.html CHANGED
@@ -6,31 +6,36 @@
6
6
  padding: 0;
7
7
  overflow: hidden;
8
8
  }
9
+
9
10
  .ls, .product {
10
- width: 70px;
11
- height: 70px;
12
- margin: 10px;
13
- background-color:azure;
14
- border: 1px solid blue;
15
- color: #090909;
16
- text-align: center;
17
- display: flex;
18
- align-items: center;
19
- cursor: pointer;
11
+ width: 70px;
12
+ height: 70px;
13
+ margin: 10px;
14
+ background-color: azure;
15
+ border: 1px solid blue;
16
+ color: #090909;
17
+ text-align: center;
18
+ display: flex;
19
+ align-items: center;
20
+ cursor: pointer;
20
21
  }
22
+
21
23
  .product {
22
- width: 70px;
23
- height: 70px;
24
- margin: 10px;
25
- background-color:rgb(232, 254, 232);
26
- border: 1px solid green;
24
+ width: 70px;
25
+ height: 70px;
26
+ margin: 10px;
27
+ background-color: rgb(232, 254, 232);
28
+ border: 1px solid green;
27
29
  }
30
+
28
31
  .ls div, .product div {
29
- width: 100%;
32
+ width: 100%;
30
33
  }
34
+
31
35
  .container {
32
- display: flex;
36
+ display: flex;
33
37
  }
38
+
34
39
  #configurator-container {
35
40
  width: 1024px;
36
41
  height: 600px;
@@ -40,60 +45,82 @@
40
45
 
41
46
  <body>
42
47
  <div class="container">
43
- <div class="product" data-roomle-id="usm:frame:1E13940F850F734EDF5ADF48191E9ACDAD93BEC0BE757F89E78807A5DA0FAD8C"><div>Shelf</div></div>
44
- <div class="product" data-roomle-id="musterring:Felicia_Sofa:7698BEE48226BBB1E0AF93F342018DC1FC269242F02D1F0C9367414A26CA3425"><div>Sofa</div></div>
45
- <div class="product" data-roomle-id="hussl:ST6N:C39C46D1AD6F8BC9E3F778A6F92CB017B785CE960D8D4C7146223348A9B70590"><div>Chair</div></div>
48
+ <div class="product"
49
+ data-roomle-id="usm:frame:1E13940F850F734EDF5ADF48191E9ACDAD93BEC0BE757F89E78807A5DA0FAD8C">
50
+ <div>Shelf</div>
51
+ </div>
52
+ <div class="product"
53
+ data-roomle-id="musterring:Felicia_Sofa:7698BEE48226BBB1E0AF93F342018DC1FC269242F02D1F0C9367414A26CA3425">
54
+ <div>Sofa</div>
55
+ </div>
56
+ <div class="product"
57
+ data-roomle-id="hussl:ST6N:C39C46D1AD6F8BC9E3F778A6F92CB017B785CE960D8D4C7146223348A9B70590">
58
+ <div>Chair</div>
59
+ </div>
46
60
  </div>
47
61
  <div class="container">
48
- <div class="ls" data-roomle-ls="sofa"><div>Sofa<br>Light</div></div>
49
- <div class="ls" data-roomle-ls="shelf"><div>Shelf<br>Light</div></div>
50
- <div class="ls" data-roomle-ls="shelf_front"><div>Shelf Front<br>Light</div></div>
51
- <div class="ls" data-roomle-ls="equal"><div>Equal<br>Light</div></div>
52
- <div class="ls" data-roomle-ls="camera"><div>Camera<br>Light</div></div>
53
- <div class="ls" data-roomle-ls="baked"><div>Baked<br>Light</div></div>
62
+ <div class="ls" data-roomle-ls="sofa">
63
+ <div>Sofa<br>Light</div>
64
+ </div>
65
+ <div class="ls" data-roomle-ls="shelf">
66
+ <div>Shelf<br>Light</div>
67
+ </div>
68
+ <div class="ls" data-roomle-ls="shelf_front">
69
+ <div>Shelf Front<br>Light</div>
70
+ </div>
71
+ <div class="ls" data-roomle-ls="equal">
72
+ <div>Equal<br>Light</div>
73
+ </div>
74
+ <div class="ls" data-roomle-ls="camera">
75
+ <div>Camera<br>Light</div>
76
+ </div>
77
+ <div class="ls" data-roomle-ls="baked">
78
+ <div>Baked<br>Light</div>
79
+ </div>
54
80
  </div>
55
81
  <div id="configurator-container"></div>
56
82
  <script src="./roomle-configurator-api.es.min.js" type="module"></script>
57
83
  <script type="module">
58
- import RoomleConfiguratorApi from './roomle-configurator-api.es.min.js';
59
- (async ()=> {
60
- const options = {
61
- id: 'usm:frame:1E13940F850F734EDF5ADF48191E9ACDAD93BEC0BE757F89E78807A5DA0FAD8C'
62
- };
63
- const configurator = await RoomleConfiguratorApi.createConfigurator(
64
- 'demoConfigurator',
65
- document.getElementById('configurator-container'),
66
- options,
67
- );
84
+ import RoomleConfiguratorApi from './roomle-configurator-api.es.min.js';
85
+
86
+ (async () => {
87
+ const options = {
88
+ id: 'usm:frame:1E13940F850F734EDF5ADF48191E9ACDAD93BEC0BE757F89E78807A5DA0FAD8C',
89
+ };
90
+ const configurator = await RoomleConfiguratorApi.createConfigurator(
91
+ 'demoConfigurator',
92
+ document.getElementById('configurator-container'),
93
+ options,
94
+ );
68
95
 
69
- [...document.querySelectorAll('.ls')].forEach((button) => {
70
- button.addEventListener('click', (productDomNode) => {
71
- const target = productDomNode.target;
72
- let roomleLs = target.getAttribute('data-roomle-ls') || target.parentElement.getAttribute('data-roomle-ls');
73
- if(!roomleLs) {
74
- return;
75
- }
76
- // this is obfuscated on purpose because it uses internal API functions
77
- // which are not meant to be used! This example should only demonstrate
78
- // the different light settings. Sure it's easy to decode the string but
79
- // please do not copy and paste the decoded code into your production app
80
- // unless you know what you do :-)
81
- eval(atob('Y29uZmlndXJhdG9yLmV4dGVuZGVkLmxvYWREeW5hbWljTGlnaHRTZXR0aW5nKHtsczogcm9vbWxlTHN9KQ=='));
82
- });
83
- });
96
+ [...document.querySelectorAll('.ls')].forEach((button) => {
97
+ button.addEventListener('click', (productDomNode) => {
98
+ const target = productDomNode.target;
99
+ let roomleLs = target.getAttribute('data-roomle-ls') || target.parentElement.getAttribute('data-roomle-ls');
100
+ if (!roomleLs) {
101
+ return;
102
+ }
103
+ // this is obfuscated on purpose because it uses internal API functions
104
+ // which are not meant to be used! This example should only demonstrate
105
+ // the different light settings. Sure it's easy to decode the string but
106
+ // please do not copy and paste the decoded code into your production app
107
+ // unless you know what you do :-)
108
+ eval(atob('Y29uZmlndXJhdG9yLmV4dGVuZGVkLmxvYWREeW5hbWljTGlnaHRTZXR0aW5nKHtsczogcm9vbWxlTHN9KQ=='));
109
+ });
110
+ });
84
111
 
85
- [...document.querySelectorAll('.product')].forEach((button) => {
86
- button.addEventListener('click', (productDomNode) => {
87
- const target = productDomNode.target;
88
- let roomleId = target.getAttribute('data-roomle-id') || target.parentElement.getAttribute('data-roomle-id');
89
- if(!roomleId) {
90
- return;
91
- }
92
- configurator.ui.loadObject(roomleId);
93
- });
94
- });
95
- })();
112
+ [...document.querySelectorAll('.product')].forEach((button) => {
113
+ button.addEventListener('click', (productDomNode) => {
114
+ const target = productDomNode.target;
96
115
  let roomleId = target.getAttribute('data-roomle-id') || target.parentElement.getAttribute('data-roomle-id');
116
+ if (!roomleId) {
117
+ return;
118
+ }
119
+ configurator.ui.loadObject(roomleId);
120
+ });
121
+ });
122
+ })();
123
+ let roomleId = target.getAttribute('data-roomle-id') || target.parentElement.getAttribute('data-roomle-id');
97
124
  </script>
98
125
  </body>
99
126
  </html>