@roomle/embedding-lib 4.24.1-alpha.2 → 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 (37) hide show
  1. package/docs/api/README.md +1 -1
  2. package/docs/api/classes/exposed_analytics_callbacks.ExposedAnalyticsCallbacks.md +1 -1
  3. package/docs/api/classes/exposed_api.ExposedApi.md +38 -10
  4. package/docs/api/classes/exposed_callbacks.ExposedCallbacks.md +7 -7
  5. package/docs/api/classes/roomle_configurator_api.default.md +9 -9
  6. package/docs/api/enums/types.UI_BUTTON.md +48 -15
  7. package/docs/api/interfaces/exposed_callbacks.Labels.md +2 -2
  8. package/docs/api/interfaces/exposed_callbacks.Price.md +2 -2
  9. package/docs/api/interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md +4 -4
  10. package/docs/api/interfaces/types.ConfiguratorSettings.md +5 -5
  11. package/docs/api/interfaces/types.EmbeddingSkin.md +5 -5
  12. package/docs/api/interfaces/types.UiInitData.md +58 -37
  13. package/docs/api/modules/roomle_configurator_api.md +3 -3
  14. package/docs/index.md +31 -0
  15. package/docs/md/web/ui/EMBEDDING-CHANGELOG.md +65 -9
  16. package/package.json +28 -1
  17. package/roomle-configurator-api.cjs.js +48 -4
  18. package/roomle-configurator-api.cjs.min.js +1 -1
  19. package/roomle-configurator-api.es.js +48 -4
  20. package/roomle-configurator-api.es.min.js +1 -1
  21. package/roomle-configurator-api.js +48 -4
  22. package/types/index.d.ts +190 -129
  23. package/types/src/common/store/collection-view-state.d.ts +2 -2
  24. package/types/src/common/store/index.d.ts +6 -0
  25. package/types/src/common/utils/helper.d.ts +3 -0
  26. package/types/src/common/utils/types.d.ts +3 -2
  27. package/types/src/configurator/business-logic/sdk-connector.d.ts +1 -0
  28. package/types/src/configurator/components/-utils/overlays.d.ts +8 -8
  29. package/types/src/configurator/components/grid-view/-utils/GridViewHelper.d.ts +3 -0
  30. package/types/src/configurator/embedding/exposed-api.d.ts +10 -0
  31. package/types/src/configurator/embedding/types.d.ts +7 -1
  32. package/types/src/configurator/store/ui-state.d.ts +19 -3
  33. package/types/tests/helpers/data/variants.d.ts +60 -0
  34. package/types/tests/helpers/mocks/sdk-connector-planner.d.ts +13 -0
  35. package/types/tests/helpers/mocks/sdk-connector.d.ts +5 -0
  36. package/types/tests/integration/configurator/components/{overlays/PartList.spec.d.ts → parameters/types/ProductVariant.spec.d.ts} +0 -0
  37. package/types/tests/integration/planner/components/BottomBar.spec.d.ts +1 -0
package/docs/api/interfaces/types.UiInitData.md CHANGED
@@ -31,6 +31,7 @@
31
31
  - [customApiUrl](types.UiInitData.md#customapiurl)
32
32
  - [debug](types.UiInitData.md#debug)
33
33
  - [deeplink](types.UiInitData.md#deeplink)
34
+ - [disableEnvMap](types.UiInitData.md#disableenvmap)
34
35
  - [dls](types.UiInitData.md#dls)
35
36
  - [edit](types.UiInitData.md#edit)
36
37
  - [emails](types.UiInitData.md#emails)
@@ -114,7 +115,7 @@ InitDataDefinition.addOnSpots
114
115
 
115
116
  #### Defined in
116
117
 
117
- node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:189
118
+ node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:194
118
119
 
119
120
  ___
120
121
 
@@ -146,7 +147,7 @@ to view 3d content. Imagine it then as a <img> tag for 3d content
146
147
 
147
148
  #### Defined in
148
149
 
149
- [src/configurator/embedding/types.ts:80](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L80)
150
+ [src/configurator/embedding/types.ts:86](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L86)
150
151
 
151
152
  ___
152
153
 
@@ -163,7 +164,7 @@ InitDataDefinition.applyCurrentGlobalParameters
163
164
 
164
165
  #### Defined in
165
166
 
166
- [src/configurator/embedding/types.ts:127](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L127)
167
+ [src/configurator/embedding/types.ts:133](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L133)
167
168
 
168
169
  ___
169
170
 
@@ -199,7 +200,7 @@ InitDataDefinition.bananaForScale
199
200
 
200
201
  #### Defined in
201
202
 
202
- node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:248
203
+ node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:253
203
204
 
204
205
  ___
205
206
 
@@ -219,15 +220,18 @@ ___
219
220
  | `multiselect?` | false \| true |
220
221
  | `partlist?` | false \| true |
221
222
  | `pauseconfigure?` | false \| true |
223
+ | `redo?` | false \| true |
222
224
  | `renderimage?` | false \| true |
223
225
  | `requestproduct?` | false \| true |
224
226
  | `resetcamera?` | false \| true |
225
227
  | `savedraft?` | false \| true |
228
+ | `snapping?` | false \| true |
226
229
  | `startconfigure?` | false \| true |
230
+ | `undo?` | false \| true |
227
231
 
228
232
  #### Defined in
229
233
 
230
- [src/configurator/embedding/types.ts:35](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L35)
234
+ [src/configurator/embedding/types.ts:38](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L38)
231
235
 
232
236
  ___
233
237
 
@@ -245,7 +249,7 @@ InitDataDefinition.cameraRestriction
245
249
 
246
250
  #### Defined in
247
251
 
248
- node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:222
252
+ node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:227
249
253
 
250
254
  ___
251
255
 
@@ -263,7 +267,7 @@ InitDataDefinition.cameraSpacing
263
267
 
264
268
  #### Defined in
265
269
 
266
- node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:274
270
+ node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:279
267
271
 
268
272
  ___
269
273
 
@@ -358,7 +362,24 @@ usage: http://www.example.com/configurator?id=#CONFIGURATIONID#
358
362
 
359
363
  #### Defined in
360
364
 
361
- [src/configurator/embedding/types.ts:67](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L67)
365
+ [src/configurator/embedding/types.ts:73](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L73)
366
+
367
+ ___
368
+
369
+ ### disableEnvMap
370
+
371
+ • `Optional` **disableEnvMap**: false \| true
372
+
373
+ **`internal`**
374
+ If set to true, it will disable the environment map completely
375
+
376
+ #### Inherited from
377
+
378
+ InitDataDefinition.disableEnvMap
379
+
380
+ #### Defined in
381
+
382
+ node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:181
362
383
 
363
384
  ___
364
385
 
@@ -376,7 +397,7 @@ InitDataDefinition.dls
376
397
 
377
398
  #### Defined in
378
399
 
379
- node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:205
400
+ node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:210
380
401
 
381
402
  ___
382
403
 
@@ -393,7 +414,7 @@ InitDataDefinition.edit
393
414
 
394
415
  #### Defined in
395
416
 
396
- node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:288
417
+ node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:298
397
418
 
398
419
  ___
399
420
 
@@ -406,7 +427,7 @@ an e-mail
406
427
 
407
428
  #### Defined in
408
429
 
409
- [src/configurator/embedding/types.ts:85](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L85)
430
+ [src/configurator/embedding/types.ts:91](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L91)
410
431
 
411
432
  ___
412
433
 
@@ -420,7 +441,7 @@ so that we can ensure a smooth transition between different versions of our conf
420
441
 
421
442
  #### Defined in
422
443
 
423
- [src/configurator/embedding/types.ts:101](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L101)
444
+ [src/configurator/embedding/types.ts:107](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L107)
424
445
 
425
446
  ___
426
447
 
@@ -436,7 +457,7 @@ InitDataDefinition.floorMaterialsTag
436
457
 
437
458
  #### Defined in
438
459
 
439
- node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:210
460
+ node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:215
440
461
 
441
462
  ___
442
463
 
@@ -448,7 +469,7 @@ set this flag to false if the user did not give the consent to Analytics
448
469
 
449
470
  #### Defined in
450
471
 
451
- [src/configurator/embedding/types.ts:105](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L105)
472
+ [src/configurator/embedding/types.ts:111](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L111)
452
473
 
453
474
  ___
454
475
 
@@ -460,7 +481,7 @@ set this flag to true if you want to group the part list by main components
460
481
 
461
482
  #### Defined in
462
483
 
463
- [src/configurator/embedding/types.ts:95](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L95)
484
+ [src/configurator/embedding/types.ts:101](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L101)
464
485
 
465
486
  ___
466
487
 
@@ -496,7 +517,7 @@ InitDataDefinition.initialFloorMaterial
496
517
 
497
518
  #### Defined in
498
519
 
499
- node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:199
520
+ node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:204
500
521
 
501
522
  ___
502
523
 
@@ -544,7 +565,7 @@ InitDataDefinition.ls
544
565
 
545
566
  #### Defined in
546
567
 
547
- node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:206
568
+ node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:211
548
569
 
549
570
  ___
550
571
 
@@ -562,7 +583,7 @@ InitDataDefinition.maxHorizontalCameraAngle
562
583
 
563
584
  #### Defined in
564
585
 
565
- node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:246
586
+ node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:251
566
587
 
567
588
  ___
568
589
 
@@ -580,7 +601,7 @@ InitDataDefinition.maxVerticalCameraAngle
580
601
 
581
602
  #### Defined in
582
603
 
583
- node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:234
604
+ node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:239
584
605
 
585
606
  ___
586
607
 
@@ -615,7 +636,7 @@ InitDataDefinition.minHorizontalCameraAngle
615
636
 
616
637
  #### Defined in
617
638
 
618
- node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:240
639
+ node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:245
619
640
 
620
641
  ___
621
642
 
@@ -633,7 +654,7 @@ InitDataDefinition.minVerticalCameraAngle
633
654
 
634
655
  #### Defined in
635
656
 
636
- node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:228
657
+ node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:233
637
658
 
638
659
  ___
639
660
 
@@ -647,7 +668,7 @@ small div
647
668
 
648
669
  #### Defined in
649
670
 
650
- [src/configurator/embedding/types.ts:91](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L91)
671
+ [src/configurator/embedding/types.ts:97](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L97)
651
672
 
652
673
  ___
653
674
 
@@ -667,7 +688,7 @@ InitDataDefinition.moc
667
688
 
668
689
  #### Defined in
669
690
 
670
- node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:296
691
+ node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:306
671
692
 
672
693
  ___
673
694
 
@@ -686,7 +707,7 @@ InitDataDefinition.mode
686
707
 
687
708
  #### Defined in
688
709
 
689
- node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:283
710
+ node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:293
690
711
 
691
712
  ___
692
713
 
@@ -703,7 +724,7 @@ InitDataDefinition.offlineSync
703
724
 
704
725
  #### Defined in
705
726
 
706
- node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:183
727
+ node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:188
707
728
 
708
729
  ___
709
730
 
@@ -768,7 +789,7 @@ ___
768
789
 
769
790
  #### Defined in
770
791
 
771
- [src/configurator/embedding/types.ts:53](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L53)
792
+ [src/configurator/embedding/types.ts:59](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L59)
772
793
 
773
794
  ___
774
795
 
@@ -805,7 +826,7 @@ InitDataDefinition.plusInPreview
805
826
 
806
827
  #### Defined in
807
828
 
808
- node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:194
829
+ node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:199
809
830
 
810
831
  ___
811
832
 
@@ -900,7 +921,7 @@ for details see deeplink, the only change is that the placeholder is <CONF_ID> h
900
921
 
901
922
  #### Defined in
902
923
 
903
- [src/configurator/embedding/types.ts:58](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L58)
924
+ [src/configurator/embedding/types.ts:64](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L64)
904
925
 
905
926
  ___
906
927
 
@@ -935,7 +956,7 @@ InitDataDefinition.showInfos
935
956
 
936
957
  #### Defined in
937
958
 
938
- node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:259
959
+ node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:264
939
960
 
940
961
  ___
941
962
 
@@ -952,7 +973,7 @@ InitDataDefinition.showPrice
952
973
 
953
974
  #### Defined in
954
975
 
955
- node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:264
976
+ node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:269
956
977
 
957
978
  ___
958
979
 
@@ -962,7 +983,7 @@ ___
962
983
 
963
984
  #### Defined in
964
985
 
965
- [src/configurator/embedding/types.ts:50](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L50)
986
+ [src/configurator/embedding/types.ts:56](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L56)
966
987
 
967
988
  ___
968
989
 
@@ -1020,7 +1041,7 @@ You can find all labels here: [Base.json](../../../ui/base.json)
1020
1041
 
1021
1042
  #### Defined in
1022
1043
 
1023
- [src/configurator/embedding/types.ts:122](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L122)
1044
+ [src/configurator/embedding/types.ts:128](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L128)
1024
1045
 
1025
1046
  ___
1026
1047
 
@@ -1038,7 +1059,7 @@ InitDataDefinition.transparentHighlighting
1038
1059
 
1039
1060
  #### Defined in
1040
1061
 
1041
- node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:254
1062
+ node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:259
1042
1063
 
1043
1064
  ___
1044
1065
 
@@ -1101,7 +1122,7 @@ ___
1101
1122
 
1102
1123
  #### Defined in
1103
1124
 
1104
- [src/configurator/embedding/types.ts:52](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L52)
1125
+ [src/configurator/embedding/types.ts:58](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L58)
1105
1126
 
1106
1127
  ___
1107
1128
 
@@ -1152,7 +1173,7 @@ usm:frame is loaded all the items from the tag "DB_Start_ohne_Element" are now s
1152
1173
 
1153
1174
  #### Defined in
1154
1175
 
1155
- [src/configurator/embedding/types.ts:74](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L74)
1176
+ [src/configurator/embedding/types.ts:80](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L80)
1156
1177
 
1157
1178
  ___
1158
1179
 
@@ -1162,7 +1183,7 @@ ___
1162
1183
 
1163
1184
  #### Defined in
1164
1185
 
1165
- [src/configurator/embedding/types.ts:51](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/types.ts#L51)
1186
+ [src/configurator/embedding/types.ts:57](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/types.ts#L57)
1166
1187
 
1167
1188
  ___
1168
1189
 
@@ -1180,4 +1201,4 @@ InitDataDefinition.zoomDistance
1180
1201
 
1181
1202
  #### Defined in
1182
1203
 
1183
- node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:216
1204
+ node_modules/@roomle/web-sdk/lib/definitions/common-core/src/utils/shims.d.ts:221
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:69](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/roomle-configurator-api.ts#L69)
29
+ [src/configurator/embedding/roomle-configurator-api.ts:69](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/roomle-configurator-api.ts#L69)
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:71](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/roomle-configurator-api.ts#L71)
39
+ [src/configurator/embedding/roomle-configurator-api.ts:71](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/roomle-configurator-api.ts#L71)
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:70](https://gitlab.com/roomle/web/roomle-ui/-/blob/5c482b70/src/configurator/embedding/roomle-configurator-api.ts#L70)
49
+ [src/configurator/embedding/roomle-configurator-api.ts:70](https://gitlab.com/roomle/web/roomle-ui/-/blob/353723c4/src/configurator/embedding/roomle-configurator-api.ts#L70)
package/docs/index.md CHANGED
@@ -384,6 +384,8 @@ export enum UI_BUTTON {
384
384
  PAUSECONFIGURE = 'pauseconfigure',
385
385
  EXPORT_3D = 'export3d',
386
386
  ROTATE = 'rotate',
387
+ UNDO = 'undo',
388
+ REDO = 'redo'
387
389
  }
388
390
  ```
389
391
 
@@ -783,10 +785,39 @@ To see which labels exist you can take a look at the [API documentation](./api/i
783
785
  You can test and play around with those settings in this CodeSandbox:
784
786
  [![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)
785
787
 
788
+ ### Implementing a custom share pop up
789
+
790
+ If you want to fully customize the share experience of your users you can do this by implementing your own pop-up. Therefore you need to apply the knowledge you already have from the section ["React on button clicks"](#react-on-button-clicks). In that specific case you need to wait for the click on the button `savedraft`. Since you want to implement your own share logic you just need to return `true` to indicate that you want to disable the default behavior. Now the event "click savedraft" is your hook to execute your own logic. This can vary widely depending on what you want to do but a very basic idea and gist is implemented inside the following CodeSandbox:
791
+
792
+ [![Edit custom-share-functionality-gou3u](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/custom-share-functionality-gou3u?file=/index.js?fontsize=14&hidenavigation=1&theme=dark)
793
+
786
794
  ### Customize/change the UI
787
795
 
788
796
  Learn more about UI elements and how to change them in the configurator tutorial about [UI Customization](../guides/tutorial/configurator/08_UI_customization.html).
789
797
 
798
+ ### Image of current configuration/product
799
+
800
+ There are two ways to get an image/render of the current configuration shown in the Rubens configurator:
801
+
802
+ - 3D / Perspective Image
803
+ - 2D / Top Image
804
+
805
+ If you are using the SDK you can use [preparePerspectiveImage](./api/classes/roomleconfigurator.html#prepareperspectiveimage) or [prepareTopImage](./api/classes/roomleconfigurator.html#preparetopimage) directly on the `RoomleConfigurator` instance.
806
+
807
+ In case you are using the `EmbeddingLib`, you can use those calls on the `extended` object of the interface. For example:
808
+
809
+ ```JavaScript
810
+ const configurator = await RoomleConfiguratorApi.create(
811
+ 'demoConfigurator',
812
+ document.getElementById('configurator-container'),
813
+ {...options}
814
+ );
815
+ const base64Image = await configurator.extended.preparePerspectiveImage({
816
+ showDimensions: true
817
+ });
818
+ ```
819
+
820
+
790
821
  <!---
791
822
  ### Multiple objects
792
823
 
package/docs/md/web/ui/EMBEDDING-CHANGELOG.md CHANGED
@@ -1,15 +1,71 @@
1
- ### [4.24.1-alpha.2](https://gitlab.com/roomle/web/roomle-ui/compare/embedding-v4.24.1-alpha.1...embedding-v4.24.1-alpha.2) (2021-11-30)
1
+ ## [4.25.0-alpha.1](https://gitlab.com/roomle/web/roomle-ui/compare/embedding-v4.24.1-alpha.2...embedding-v4.25.0-alpha.1) (2022-04-06)
2
2
 
3
- ### [4.24.1-alpha.1](https://gitlab.com/roomle/web/roomle-ui/compare/embedding-v4.24.0...embedding-v4.24.1-alpha.1) (2021-11-29)
4
3
 
4
+ ### Features
5
5
 
6
- ### Bug Fixes
7
-
8
- * do not swallow loading errors resolves RML-2843 ([888f322](https://gitlab.com/roomle/web/roomle-ui/commit/888f3221e39d07d1c58e10bae7c26a5a5caae7bb))
9
-
10
- ## [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)
6
+ * add gap between boolean buttons, because of style reasons ([62ef422](https://gitlab.com/roomle/web/roomle-ui/commit/62ef42288187872fbfa1273f5381cd359dc08c35))
7
+ * add insertObject API to add items to the MOC scene ([213d465](https://gitlab.com/roomle/web/roomle-ui/commit/213d4659523d8660ca99da5b41b772a1307d6a04))
8
+ * add possibility to disable and overwrite undo and redo button ([e06e55c](https://gitlab.com/roomle/web/roomle-ui/commit/e06e55c06db2bfef09cdf41c9367c9e4e05bae76))
9
+ * add snapping button to MOC ([b18ec7e](https://gitlab.com/roomle/web/roomle-ui/commit/b18ec7e1e9d58f0a9c5b11fe20f3bd9b5fba7885))
10
+ * add tests for checking if id gets set properly in store and if callback function sets store to null again ([3bcbdfb](https://gitlab.com/roomle/web/roomle-ui/commit/3bcbdfb8d3d51279f2a103e1a126dea937da7cc0))
11
+ * add undo redo functionality to buttons in planner ([b44c342](https://gitlab.com/roomle/web/roomle-ui/commit/b44c342d44034468cf43feeb3a310e68f6ca0beb))
12
+ * add undo/redo button in topbar, add callback function and save it to the store ([497a91c](https://gitlab.com/roomle/web/roomle-ui/commit/497a91c22d7d908135453dab0d676fbc21bd3c18))
13
+ * do not show warning if we didn't change anything ([8388a31](https://gitlab.com/roomle/web/roomle-ui/commit/8388a31ba238a4e3f391a286e5d9355a97d30e77))
14
+ * enable selection of multiple categories for materials ([8ba5739](https://gitlab.com/roomle/web/roomle-ui/commit/8ba5739efa0a1511a99ad7d524da1de2c43bab17))
15
+ * highlight parts in the scene when hovering over them in the partlist ([275985c](https://gitlab.com/roomle/web/roomle-ui/commit/275985cb36d15c7ed9141a027bcff9b975c9a388))
16
+ * only show price header in part list if a price is available ([226cdbf](https://gitlab.com/roomle/web/roomle-ui/commit/226cdbfdab06cd424f32f434ebb8491fe493df66))
17
+ * only show variant warning if necessary ([3cdf3aa](https://gitlab.com/roomle/web/roomle-ui/commit/3cdf3aab0027f11b6e54f0b0f094ba051e3bd6d8))
18
+ * show parameters when changing groups or addons ([3dd4809](https://gitlab.com/roomle/web/roomle-ui/commit/3dd4809ea4b9d1098be1240e652792e2e88bc843))
19
+ * update to newest SDK version 2.24.0-alpha.1 ([4ecc431](https://gitlab.com/roomle/web/roomle-ui/commit/4ecc43199849854df35fd19b933f9c07112ba9fe))
20
+ * upgrade SDK to 2.20.0-alpha.1 ([4d3914d](https://gitlab.com/roomle/web/roomle-ui/commit/4d3914dc8493ed6b2c77c75baf7a2224ef89935d))
21
+ * upgrade SDK to version 2.20.0 ([07bd456](https://gitlab.com/roomle/web/roomle-ui/commit/07bd45669613da41d9d72c436b93c224e11eb93a))
22
+ * upgrade SDK to version 2.20.0-alpha.3 ([b29f317](https://gitlab.com/roomle/web/roomle-ui/commit/b29f3171a6521479665742fae79ef285bbb5acd5))
23
+ * upgrade SDK to version 2.20.0-alpha.4 ([e3db2b7](https://gitlab.com/roomle/web/roomle-ui/commit/e3db2b74748c23c079259bb69c1597eb780cbb64))
24
+ * upgrade SDK to version 2.21.0-alpha.1 ([24c7202](https://gitlab.com/roomle/web/roomle-ui/commit/24c7202cd676421b4166b50468eddc1920063caa))
25
+ * upgrade SDK to version 2.22.0 ([a25ed2a](https://gitlab.com/roomle/web/roomle-ui/commit/a25ed2a0aa33f794a71c9a431dd02680420e7e38))
26
+ * upgrade SDK to version 2.22.0-alpha.1 ([d746132](https://gitlab.com/roomle/web/roomle-ui/commit/d746132d00156854749c9e0ea0678c3f6463abec))
27
+ * upgrade SDK to version 2.22.0-alpha.2 ([393ea48](https://gitlab.com/roomle/web/roomle-ui/commit/393ea485386c2cc2556ef8b56e648fc826972903))
28
+ * upgrade SDK to version 2.22.0-alpha.3 ([7e1f511](https://gitlab.com/roomle/web/roomle-ui/commit/7e1f5111790a5b0ad7fda3f9a0d8a814a9b84173))
29
+ * upgrade SDK to version 2.22.0-alpha.4 ([f0f7450](https://gitlab.com/roomle/web/roomle-ui/commit/f0f7450e97b6c9214102f8c08d0a74f5c88bb1b7))
30
+ * upgrade SDK to version 2.23.0 ([c12b566](https://gitlab.com/roomle/web/roomle-ui/commit/c12b56610067f103d5a81763979b66c0ed4030d2))
31
+ * upgrade SDK to version 2.23.0-alpha.1 ([8be7069](https://gitlab.com/roomle/web/roomle-ui/commit/8be70698546aff1498d34f389f9ec17f0c955029))
32
+ * upgrade SDK to version 2.24.0-alpha.1 ([d9b36f8](https://gitlab.com/roomle/web/roomle-ui/commit/d9b36f862c23d6ecd5cf76e0871d70091184ec6d))
33
+ * upgrade SDK to version 2.24.0-alpha.2 ([fac1868](https://gitlab.com/roomle/web/roomle-ui/commit/fac18686fbdfc3087b3ef4612b862c769fbdfc41))
34
+ * upgrade SDK to version 2.28.0-alpha.2 ([b87ec4a](https://gitlab.com/roomle/web/roomle-ui/commit/b87ec4a9cb579f0f913e9d15aa2e55aba61b71c2))
35
+ * upgrade SDK to version 2.28.0-alpha.3 ([65cb89b](https://gitlab.com/roomle/web/roomle-ui/commit/65cb89b96da9ea0cca095034e5fde2a92545da0c))
36
+ * upgrade SDK to version 2.29.0-alpha.1 ([c44c6bd](https://gitlab.com/roomle/web/roomle-ui/commit/c44c6bdd98348e1b844deb27b56dfc0ce0a6a613))
37
+ * **SDK:** upgrade to version 2.21.0 ([b16a2e3](https://gitlab.com/roomle/web/roomle-ui/commit/b16a2e3336677c520192a7cb4e99372bab830c50))
38
+ * **SDK:** upgrade to version 2.24.0 ([a239abd](https://gitlab.com/roomle/web/roomle-ui/commit/a239abdda583a92c7873e11f53b000ec5985e2e0))
39
+ * **SDK:** upgrade to version 2.25.0 ([8a4e033](https://gitlab.com/roomle/web/roomle-ui/commit/8a4e0339d668cb38500604e51c4070a37441f6d4))
40
+ * **SDK:** upgrade to version 2.26.0 ([708f644](https://gitlab.com/roomle/web/roomle-ui/commit/708f644f912e3b5b63aad1845470036bf815eca5))
41
+ * **SDK:** upgrade to version 2.27.0 ([49e703a](https://gitlab.com/roomle/web/roomle-ui/commit/49e703ac28aac0abf0fdfa0bb135902330e9221c))
42
+ * **SDK:** upgrade to version 2.27.0-alpha.2 ([202a9a3](https://gitlab.com/roomle/web/roomle-ui/commit/202a9a3b4f01aad618164a81c17031e1f9800b50))
11
43
 
12
44
 
13
- ### Features
45
+ ### Bug Fixes
14
46
 
15
- * upgrade SDK to version 2.19.0 ([34c7760](https://gitlab.com/roomle/web/roomle-ui/commit/34c7760ec4877beef0e6645f9e12e466de185f08))
47
+ * always set id when loading plan xml ([f672b68](https://gitlab.com/roomle/web/roomle-ui/commit/f672b68c5ff856fbf4c4a3a233d513d59a13eb90))
48
+ * autocomplete of email input at save draft ([d0c72b6](https://gitlab.com/roomle/web/roomle-ui/commit/d0c72b6dee313e3cd8275dfcdf3f3f8f01a54278))
49
+ * autocomplete of email input with right line spacing at save draft ([0ea5900](https://gitlab.com/roomle/web/roomle-ui/commit/0ea5900b88cbb80e75db7f6eb380403abcdaa744))
50
+ * change wrong visibility in Safari parts list ([5be3493](https://gitlab.com/roomle/web/roomle-ui/commit/5be3493a8f816aa90262bd74112f86dc186557f1))
51
+ * check if undo or redo button fuctionalitiy are overwritten ([5b65415](https://gitlab.com/roomle/web/roomle-ui/commit/5b65415b07846d6e52075edfd66c9a1c76c1ad41))
52
+ * disable savedraft and requestPlan button in planner ([cd66284](https://gitlab.com/roomle/web/roomle-ui/commit/cd66284a6adcb2c1bea4965b069f7babc06c52d7))
53
+ * disable undo and redo button completely by initData ([4420916](https://gitlab.com/roomle/web/roomle-ui/commit/44209162cc11c865f018d615da9b796cd8bf018f))
54
+ * don't disable undo/redo button fully to prevent jumping buttons ([c459504](https://gitlab.com/roomle/web/roomle-ui/commit/c459504d13ab2ef343e7bfb1e5d24823c5a39448))
55
+ * error message bug, added rightly in loco ([a530ef6](https://gitlab.com/roomle/web/roomle-ui/commit/a530ef6930126a4738b8449fb35bcd2c881668f1))
56
+ * eslint warnings ([2b187a0](https://gitlab.com/roomle/web/roomle-ui/commit/2b187a0d62fb851e9305ab0d4cc5c2a318bd3543))
57
+ * failing tests ([2b2aa0d](https://gitlab.com/roomle/web/roomle-ui/commit/2b2aa0d7f9a72258582fa7b03b90f5493fc7fe03))
58
+ * fix failing tests ([d6cfa77](https://gitlab.com/roomle/web/roomle-ui/commit/d6cfa7731ed52ab2793be0c4e5351042beb9647b))
59
+ * make generic error pop unclickable ([5b9fb6e](https://gitlab.com/roomle/web/roomle-ui/commit/5b9fb6e3b08446c242d12c869ee301ee314dd5f6))
60
+ * only reset last selected variant if some changes happened ([58a15c0](https://gitlab.com/roomle/web/roomle-ui/commit/58a15c0dcf10adf4b802405e7ab2e09f49f747e7))
61
+ * pass correct object in tests so that the test does not break ([c8d8c2d](https://gitlab.com/roomle/web/roomle-ui/commit/c8d8c2dcda2ab185f6ba211ccf7d6e4fa3ea4cfa))
62
+ * scroll to the top of sidebar if parameter group got changed ([84619ae](https://gitlab.com/roomle/web/roomle-ui/commit/84619aedf2ba5b1af3fa1e40a43cb8ce04b30b37))
63
+ * send AR user actions when opened with a QR code ([b855cb2](https://gitlab.com/roomle/web/roomle-ui/commit/b855cb2f49a21fc81f9b1281f888cead305d5ba6))
64
+ * send save draft user action when sharing a configuration ([2c25fbf](https://gitlab.com/roomle/web/roomle-ui/commit/2c25fbffd5a2361c0ea23a2885a3353568ceab59))
65
+ * send user action save draft when not using emails ([98545f3](https://gitlab.com/roomle/web/roomle-ui/commit/98545f3c40485ef32c594acd19dfe157473c6609))
66
+ * set correct mail type for save configuration ([0531717](https://gitlab.com/roomle/web/roomle-ui/commit/05317177d3bfa122cb0955f2da0b9916cd0c02e6))
67
+ * show error message if configurable or static item breaks when loading ([68f01b3](https://gitlab.com/roomle/web/roomle-ui/commit/68f01b31c5ad5b824237fefc2835b65e6b07021f))
68
+ * upgrade SDK to version 2.28.0 ([35d549f](https://gitlab.com/roomle/web/roomle-ui/commit/35d549ffd3e7d22ae98bdbbae47ebbd364c33ed2))
69
+ * use promise so that mock is "really" async ([ce83dd0](https://gitlab.com/roomle/web/roomle-ui/commit/ce83dd0a4608331aee98ba7c375c656f50743c48))
70
+ * use volta to pin node version which works on all machines ([170d7e2](https://gitlab.com/roomle/web/roomle-ui/commit/170d7e2380b8266ab09b9a0bd2250c9097c9227a))
71
+ * wrap email input in form for fix autocomplete bug in firefox, preventDefault because firefox only want one onClick action ([629b618](https://gitlab.com/roomle/web/roomle-ui/commit/629b618152c3d11a0b0abb7e485e273566330b6a))
package/package.json CHANGED
@@ -1 +1,28 @@
1
- {"name":"@roomle/embedding-lib","version":"4.24.1-alpha.2","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"}
1
+ {
2
+ "name": "@roomle/embedding-lib",
3
+ "version": "4.25.0-alpha.1",
4
+ "main": "roomle-configurator-api.es.min.js",
5
+ "types": "types/index.d.ts",
6
+ "author": "Roomle Development",
7
+ "dependencies": {
8
+ "@roomle/web-sdk": "2.29.0-alpha.1"
9
+ },
10
+ "devDependencies": {
11
+ "@semantic-release/changelog": "^5.0.1",
12
+ "@semantic-release/exec": "^5.0.0",
13
+ "conventional-changelog-conventionalcommits": "^4.2.3",
14
+ "semantic-release": "^17.0.7"
15
+ },
16
+ "scripts": {
17
+ "release": "semantic-release"
18
+ },
19
+ "description": "This is a small library which can be used to communicate with the Roomle Configurator",
20
+ "repository": {
21
+ "type": "git",
22
+ "url": "git+https://github.com/roomle-build/npm-packages.git"
23
+ },
24
+ "publishConfig": {
25
+ "access": "public"
26
+ },
27
+ "license": "MIT"
28
+ }
package/roomle-configurator-api.cjs.js CHANGED
@@ -1,5 +1,7 @@
1
1
  'use strict';
2
2
 
3
+ require('@/common/styles/Global.module.scss');
4
+
3
5
  class MessageHandler {
4
6
  constructor(side, incomingMessageBus, outgoingMessageBus, messageExecution) {
5
7
  this._outgoingMessageBus = null;
@@ -162,6 +164,51 @@ const isInIframe = () => {
162
164
  }
163
165
  };
164
166
 
167
+ // see why: so#/58065241/10800831
168
+ const isAndroid = () => /(android)/i.test(navigator.userAgent);
169
+
170
+ /* TO DOs in Google Analytics Admin UI
171
+
172
+ To track the Hit ID, Hit Time, and Hit Type and custom dimensions, first create them in Google Analytics
173
+ and set their scope to "Hit"
174
+
175
+ Once you've created the custom metrics in Google Analytics
176
+ (and set their scope to "Hit" and their formatting type to "Integer")
177
+ this setup is ready to go. You need to do this in every GA property
178
+
179
+ For more details see: https://philipwalton.com/articles/the-google-analytics-setup-i-use-on-every-site-i-build/
180
+
181
+ */
182
+ // Probably we could add const enums here
183
+ // but we need to investigate: https://roomle.atlassian.net/browse/CONF-238
184
+ var GA_CUSTOM;
185
+ (function (GA_CUSTOM) {
186
+ GA_CUSTOM["DIMENSION"] = "dimension";
187
+ GA_CUSTOM["METRIC"] = "metric";
188
+ })(GA_CUSTOM || (GA_CUSTOM = {}));
189
+ var GA_HIT_TYPE;
190
+ (function (GA_HIT_TYPE) {
191
+ GA_HIT_TYPE["EVENT"] = "event";
192
+ })(GA_HIT_TYPE || (GA_HIT_TYPE = {}));
193
+ var GA_ACTION_TYPE;
194
+ (function (GA_ACTION_TYPE) {
195
+ GA_ACTION_TYPE["EXCEPTION"] = "exception";
196
+ GA_ACTION_TYPE["TIMING"] = "timing_complete";
197
+ })(GA_ACTION_TYPE || (GA_ACTION_TYPE = {}));
198
+ var CUSTOM_ACTION_TYPE;
199
+ (function (CUSTOM_ACTION_TYPE) {
200
+ CUSTOM_ACTION_TYPE["TRACK_TIMING"] = "track_timing";
201
+ })(CUSTOM_ACTION_TYPE || (CUSTOM_ACTION_TYPE = {}));
202
+ var GA_CATEGORY;
203
+ (function (GA_CATEGORY) {
204
+ GA_CATEGORY["ERROR"] = "Error";
205
+ GA_CATEGORY["NAVIGATION_TIMING"] = "Navigation Timing";
206
+ GA_CATEGORY["TIMING"] = "Timing";
207
+ GA_CATEGORY["INTERACTION"] = "Interaction";
208
+ GA_CATEGORY["TRACKING"] = "Tracking";
209
+ GA_CATEGORY["DEPRECATION"] = "Deprecation";
210
+ })(GA_CATEGORY || (GA_CATEGORY = {}));
211
+
165
212
  /**
166
213
  * Recursively merge properties of two objects.
167
214
  * If a property exists in both it, property of obj2 is used.
@@ -307,16 +354,13 @@ const getFallbackInitData = () => {
307
354
  if (hostname && isDemoHostname(hostname)) {
308
355
  fallbackInitData.configuratorId = 'demoConfigurator';
309
356
  }
310
- fallbackInitData.customApiUrl = 'https://alpha.roomle.com/api/v2';
357
+ fallbackInitData.customApiUrl = 'https://www.roomle.com/api/v2';
311
358
  fallbackInitData.emails = false;
312
359
  return fallbackInitData;
313
360
  };
314
361
  const LEGACY_SHARE_PLACEHOLDER = '<CONF_ID>';
315
362
  const SHARE_PLACEHOLDER = '#CONFIGURATIONID#';
316
363
 
317
- // see why: so#/58065241/10800831
318
- const isAndroid = () => /(android)/i.test(navigator.userAgent);
319
-
320
364
  const setDefaultBehaviour = (object, callbackName, defaultBehaviour) => {
321
365
  let customBehaviour = null;
322
366
  Object.defineProperty(object, callbackName, {