@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
@@ -6,6 +6,7 @@ import { KernelComponent, UiPossibleChild } from '@roomle/web-sdk/lib/definition
6
6
  import { OverlaysOpenState } from '@/configurator/components/-utils/overlays';
7
7
  import { UiInitData } from '@/configurator/embedding/types';
8
8
  import { RapiTagForUi } from '@roomle/web-sdk/lib/definitions/typings/rapi-types';
9
+ import { GridViewVariantElement } from '@/configurator/components/grid-view/-utils/GridViewHelper';
9
10
  export declare enum BUTTON_ACTIONS {
10
11
  AR = 0,
11
12
  PARTLIST = 1,
@@ -14,7 +15,10 @@ export declare enum BUTTON_ACTIONS {
14
15
  FULLSCREEN = 4,
15
16
  RESET_CAMERA = 5,
16
17
  RENDER_IMAGE = 6,
17
- ROTATE = 7
18
+ ROTATE = 7,
19
+ SNAPPING = 8,
20
+ UNDO = 9,
21
+ REDO = 10
18
22
  }
19
23
  export interface SceneSelection {
20
24
  selectionMode: string;
@@ -38,6 +42,11 @@ export interface UiState extends SharedUiState {
38
42
  isConfigurator: boolean;
39
43
  isPlanner: boolean;
40
44
  email: Nullable<string>;
45
+ lastSelectedVariant: Nullable<GridViewVariantElement>;
46
+ undoEnabled: boolean;
47
+ redoEnabled: boolean;
48
+ undoEnabledPlanner: boolean;
49
+ redoEnabledPlanner: boolean;
41
50
  }
42
51
  export declare enum UI_STATE_MUTATIONS {
43
52
  SET_SELECTED_GROUP = "setSelectedGroup",
@@ -61,7 +70,12 @@ export declare enum UI_STATE_MUTATIONS {
61
70
  SET_CURRENT_VARIANTS = "SET_CURRENT_VARIANTS",
62
71
  SET_SHOW_VARIANTS = "SET_SHOW_VARIANTS",
63
72
  SET_EMAIL = "SET_EMAIL",
64
- RESET_UI = "RESET_UI"
73
+ RESET_UI = "RESET_UI",
74
+ SET_LAST_SELECTED_VARIANT = "SET_LAST_SELECTED_VARIANT",
75
+ SET_UNDO = "SET_UNDO",
76
+ SET_REDO = "SET_REDO",
77
+ SET_UNDO_PLANNER = "SET_UNDO_PLANNER",
78
+ SET_REDO_PLANNER = "SET_REDO_PLANNER"
65
79
  }
66
80
  export declare enum UI_STATE_ACTIONS {
67
81
  SELECT_GROUP = "SELECT_GROUP",
@@ -73,10 +87,12 @@ export declare enum UI_STATE_ACTIONS {
73
87
  PAUSE_CONFIGURING = "PAUSE_CONFIGURING",
74
88
  USE_VIEWER = "USE_VIEWER",
75
89
  USE_PLANNER = "USE_PLANNER",
76
- USE_CONFIGURATOR = "USE_CONFIGURATOR"
90
+ USE_CONFIGURATOR = "USE_CONFIGURATOR",
91
+ SHOW_PARAMS = "SHOW_PARAMS"
77
92
  }
78
93
  export declare enum UI_STATE_GETTERS {
79
94
  USE_REGULAR_LAYOUT = "USE_REGULAR_LAYOUT",
95
+ PART_LIST_SHOWN = "PART_LIST_SHOWN",
80
96
  COLLECTION_VIEW_ELEMENTS = "COLLECTION_VIEW_ELEMENTS",
81
97
  COLLECTION_VIEW_ADDON_ELEMENTS = "COLLECTION_VIEW_ADDON_ELEMENTS",
82
98
  COLLECTION_VIEW_VARIANTS = "COLLECTION_VIEW_VARIANTS",
@@ -0,0 +1,60 @@
1
+ export declare const ROLF_BENZ_VARIANTS: {
2
+ id: string;
3
+ global: boolean;
4
+ created: string;
5
+ updated: string;
6
+ links: {
7
+ items: string;
8
+ materials: string;
9
+ };
10
+ catalog: string;
11
+ label: string;
12
+ language: string;
13
+ items: {
14
+ height: number;
15
+ width: number;
16
+ depth: number;
17
+ displayedHeight: number;
18
+ displayedWidth: number;
19
+ displayedDepth: number;
20
+ perspectiveImage: string;
21
+ topImage: string;
22
+ assets: {};
23
+ externalIdentifier: string;
24
+ manufacturerSKU: string;
25
+ configuration: string;
26
+ rootComponentId: string;
27
+ hidden: boolean;
28
+ visibilityStatus: number;
29
+ created: string;
30
+ updated: string;
31
+ flipable: boolean;
32
+ scaleable: boolean;
33
+ colorable: boolean;
34
+ layer: number;
35
+ sort: number;
36
+ basecolor: string;
37
+ orderable: boolean;
38
+ requestable: boolean;
39
+ retailPriceAllowed: boolean;
40
+ label: string;
41
+ language: string;
42
+ catalog: string;
43
+ id: string;
44
+ tags: string[];
45
+ links: {
46
+ tags: string;
47
+ similarItems: string;
48
+ perfectFit: string;
49
+ additionalContents: string;
50
+ };
51
+ attributes: never[];
52
+ version: number;
53
+ __rapi_path__: string;
54
+ sketch: string;
55
+ }[];
56
+ parents: string[];
57
+ hidden: boolean;
58
+ __rapi_path__: string;
59
+ materials: never[];
60
+ };
@@ -0,0 +1,13 @@
1
+ import { SdkConnectorPlanner } from '@/planner/business-logic/sdk-connector-planner';
2
+ export interface MockSdkConnectorPlannerOverrides {
3
+ planner?: object;
4
+ api?: object;
5
+ store?: object;
6
+ analytics?: object;
7
+ }
8
+ export declare class MockSdkConnectorPlanner extends SdkConnectorPlanner {
9
+ overrides: MockSdkConnectorPlannerOverrides;
10
+ constructor(overrides?: MockSdkConnectorPlannerOverrides);
11
+ get api(): Promise<any>;
12
+ setParameter: () => Promise<void>;
13
+ }
@@ -2,7 +2,9 @@ import { SdkConnector } from '@/configurator/business-logic/sdk-connector';
2
2
  import { RapiTenant } from '@roomle/web-sdk/lib/definitions/typings/rapi-types';
3
3
  export interface MockSdkConnectorOverrides {
4
4
  configurator?: object;
5
+ planner?: object;
5
6
  configuratorConnector?: object;
7
+ plannerConnector?: object;
6
8
  loadInProgress?: boolean;
7
9
  someLoadDone?: boolean;
8
10
  rapiAccess?: object;
@@ -23,7 +25,10 @@ export declare class MockSdkConnector extends SdkConnector {
23
25
  constructor(overrides?: MockSdkConnectorOverrides);
24
26
  getTenant(): Promise<RapiTenant>;
25
27
  initConfigurator(): void;
28
+ initPlanner(): void;
26
29
  get configuratorApi(): Promise<any>;
30
+ get plannerApi(): Promise<any>;
27
31
  get configuratorConnector(): Promise<any>;
32
+ get plannerConnector(): Promise<any>;
28
33
  setParameter: () => Promise<void>;
29
34
  }