@roomle/embedding-lib 4.37.0 → 4.40.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.
- package/docs/__sidebar__.json +14 -0
- package/docs/api/classes/exposed_analytics_callbacks.ExposedAnalyticsCallbacks.md +1 -1
- package/docs/api/classes/exposed_api.ExposedApi.md +11 -11
- package/docs/api/classes/exposed_callbacks.ExposedCallbacks.md +31 -7
- package/docs/api/classes/roomle_configurator_api.default.md +9 -9
- package/docs/api/enums/types.UI_BUTTON.md +33 -22
- package/docs/api/interfaces/exposed_callbacks.Labels.md +2 -2
- package/docs/api/interfaces/exposed_callbacks.Price.md +2 -2
- package/docs/api/interfaces/roomle_configurator_api.RoomleEmbeddingApiKeys.md +4 -4
- package/docs/api/interfaces/types.ConfiguratorSettings.md +5 -5
- package/docs/api/interfaces/types.EmbeddingSkin.md +5 -5
- package/docs/api/interfaces/types.UiInitData.md +31 -16
- package/docs/api/modules/roomle_configurator_api.md +3 -3
- package/docs/examples/11_light_settings.html +90 -62
- package/docs/examples/roomle-configurator-api.es.min.js +254 -58
- package/docs/hsp.md +61 -0
- package/docs/integration.md +1101 -0
- package/docs/md/web/ui/EMBEDDING-CHANGELOG.md +14 -2
- package/docs/migration-guides/v2-to-v3.md +2 -2
- package/docs/moc/index.md +86 -0
- package/docs/simple.md +1 -1
- package/package.json +2 -2
- package/types/index.d.ts +53 -28
- package/types/src/common/business-logic/connector.d.ts +8 -0
- package/types/src/common/store/collection-view-state.d.ts +8 -3
- package/types/src/common/store/common-ui-state.d.ts +1 -1
- package/types/src/common/store/index.d.ts +0 -1
- package/types/src/common/utils/touch-drag.d.ts +6 -1
- package/types/src/configurator/business-logic/roomle-sdk-wrapper.d.ts +2 -0
- package/types/src/configurator/business-logic/sdk-connector-configurator.d.ts +3 -5
- package/types/src/configurator/business-logic/sdk-connector.d.ts +4 -7
- package/types/src/configurator/embedding/exposed-api.d.ts +1 -1
- package/types/src/configurator/embedding/exposed-callbacks.d.ts +7 -1
- package/types/src/configurator/embedding/types.d.ts +8 -1
- package/types/src/configurator/store/ui-state.d.ts +1 -0
- package/types/src/planner/business-logic/sdk-connector-planner.d.ts +3 -3
- package/types/src/planner/store/planner-ui-state.d.ts +3 -2
- package/types/src/planner/utils/planner-sidebar.d.ts +0 -1
- package/types/src/viewer/business-logic/sdk-connector-viewer.d.ts +2 -2
- package/types/tests/helpers/data/part-list.d.ts +16 -0
- package/types/tests/helpers/mocks/sdk-connector.d.ts +1 -0
- package/types/tests/integration/{configurator → common}/components/BottomBar.spec.d.ts +0 -0
- package/types/tests/integration/planner/components/{BottomBar.spec.d.ts → PlannerSidebar.spec.d.ts} +0 -0
- package/docs/index.md +0 -846
|
@@ -22,7 +22,8 @@ export declare enum UI_BUTTON {
|
|
|
22
22
|
PARTLIST_PLANNER = "partlist_planner",
|
|
23
23
|
PRODUCTLIST = "productlist",
|
|
24
24
|
TWO_D_VIEW = "2dview",
|
|
25
|
-
ADD_ROOM = "add_room"
|
|
25
|
+
ADD_ROOM = "add_room",
|
|
26
|
+
STARTPLANNER = "startPlanner"
|
|
26
27
|
}
|
|
27
28
|
interface FeatureFlags {
|
|
28
29
|
realPartList?: boolean;
|
|
@@ -52,6 +53,7 @@ export interface UiInitData extends InitDataDefinition, GlobalInitDataDefinition
|
|
|
52
53
|
[UI_BUTTON.TWO_D_VIEW]?: boolean;
|
|
53
54
|
[UI_BUTTON.PARTLIST_PLANNER]?: boolean;
|
|
54
55
|
[UI_BUTTON.ADD_ROOM]?: boolean;
|
|
56
|
+
[UI_BUTTON.STARTPLANNER]?: boolean;
|
|
55
57
|
};
|
|
56
58
|
skin?: EmbeddingSkin;
|
|
57
59
|
zIndex?: number;
|
|
@@ -129,6 +131,11 @@ export interface UiInitData extends InitDataDefinition, GlobalInitDataDefinition
|
|
|
129
131
|
* default: true
|
|
130
132
|
*/
|
|
131
133
|
applyCurrentGlobalParameters?: boolean;
|
|
134
|
+
/**
|
|
135
|
+
* set this flag to true if you want that a user can select more than one material category at once
|
|
136
|
+
* default: false
|
|
137
|
+
*/
|
|
138
|
+
materialMultiSelect?: boolean;
|
|
132
139
|
}
|
|
133
140
|
export interface EmbeddingSkin {
|
|
134
141
|
'primary-color'?: string;
|
|
@@ -51,6 +51,7 @@ export interface UiState extends SharedUiState {
|
|
|
51
51
|
redoEnabled: boolean;
|
|
52
52
|
undoEnabledPlanner: boolean;
|
|
53
53
|
redoEnabledPlanner: boolean;
|
|
54
|
+
materialMultiSelect: boolean;
|
|
54
55
|
}
|
|
55
56
|
export declare enum UI_STATE_MUTATIONS {
|
|
56
57
|
SET_SELECTED_GROUP = "setSelectedGroup",
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import { Connector } from '@/configurator/business-logic/sdk-connector';
|
|
2
1
|
import { Nullable } from '@/common/utils/types';
|
|
3
2
|
import { Store } from 'vuex';
|
|
4
3
|
import { StoreState } from '@/common/store';
|
|
@@ -8,7 +7,8 @@ import { UiInitData } from '@/configurator/embedding/types';
|
|
|
8
7
|
import RoomlePlanner from '@roomle/web-sdk/lib/definitions/planner-core/src/roomle-planner';
|
|
9
8
|
import { RapiId, RapiPlan } from '@roomle/web-sdk/lib/definitions/typings/rapi-types';
|
|
10
9
|
import { Base64Image } from '@roomle/web-sdk/lib/definitions/common-core/src/common-interfaces';
|
|
11
|
-
|
|
10
|
+
import { Connector } from '@/common/business-logic/connector';
|
|
11
|
+
export declare class SdkConnectorPlanner extends Connector {
|
|
12
12
|
private _planner;
|
|
13
13
|
private _initWaiters;
|
|
14
14
|
private _store;
|
|
@@ -19,7 +19,7 @@ export declare class SdkConnectorPlanner implements Connector {
|
|
|
19
19
|
constructor(store: Store<StoreState>, analytics?: Nullable<Analytics>);
|
|
20
20
|
get api(): Promise<RoomlePlanner>;
|
|
21
21
|
init(sdkWrapper: RoomleSdkWrapper, element: HTMLElement, initData: UiInitData): Promise<void>;
|
|
22
|
-
initPlanner(planner: RoomlePlanner): void
|
|
22
|
+
initPlanner(planner: RoomlePlanner): Promise<void>;
|
|
23
23
|
loadPlan(id: RapiId): Promise<void>;
|
|
24
24
|
loadPlanBasedOnObjectId(id: RapiId): Promise<void>;
|
|
25
25
|
onSelectionCancel(): void;
|
|
@@ -18,7 +18,6 @@ export interface PlannerUiState extends SharedUiState {
|
|
|
18
18
|
lastWalls: KernelWall[];
|
|
19
19
|
}
|
|
20
20
|
export declare enum PLANNER_UI_STATE_MUTATIONS {
|
|
21
|
-
SET_SELECTION_PAYLOAD = "PLANNER_UI_STATE_setSelectionPayload",
|
|
22
21
|
SET_SELECTION = "PLANNER_UI_STATE_setSelection",
|
|
23
22
|
SET_IS_LANDSCAPE = "PLANNER_UI_STATE_setIsLandscape",
|
|
24
23
|
SET_INTERACTIONS_EXPANDED = "PLANNER_UI_STATE_setInteractionsExpanded",
|
|
@@ -40,7 +39,9 @@ export declare enum PLANNER_UI_STATE_MUTATIONS {
|
|
|
40
39
|
export declare enum PLANNER_UI_STATE_ACTIONS {
|
|
41
40
|
SELECT_VIEW_MODE = "PLANNER_UI_STATE_SELECT_VIEW_MODE",
|
|
42
41
|
SET_INTERACTIONS_EXPANDED = "PLANNER_UI_STATE_SET_INTERACTIONS_EXPANDED",
|
|
43
|
-
DESELECT_SIDEBAR_ACTION_BUTTONS = "DESELECT_SIDEBAR_ACTION_BUTTONS"
|
|
42
|
+
DESELECT_SIDEBAR_ACTION_BUTTONS = "DESELECT_SIDEBAR_ACTION_BUTTONS",
|
|
43
|
+
CLEAR_AND_CLOSE_SIDEBAR = "CLEAR_AND_CLOSE_SIDEBAR",
|
|
44
|
+
SET_SELECTION_PAYLOAD = "PLANNER_UI_STATE_setSelectionPayload"
|
|
44
45
|
}
|
|
45
46
|
export declare enum PLANNER_UI_STATE_GETTERS {
|
|
46
47
|
CATALOG_ROOT_TAG = "PLANNER_UI_STATE_CATALOG_ROOT_TAG",
|
|
@@ -4,7 +4,6 @@ import { StoreState } from '@/common/store';
|
|
|
4
4
|
import { SdkConnector } from '@/configurator/business-logic/sdk-connector';
|
|
5
5
|
import { RapiConfiguration, RapiItem } from '@roomle/web-sdk/lib/definitions/typings/rapi-types';
|
|
6
6
|
export interface PlannerSidebarState {
|
|
7
|
-
welcome: boolean;
|
|
8
7
|
catalog: boolean;
|
|
9
8
|
productList: boolean;
|
|
10
9
|
partList: boolean;
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import { Connector } from '@/configurator/business-logic/sdk-connector';
|
|
2
1
|
import { Nullable } from '@/common/utils/types';
|
|
3
2
|
import { Store } from 'vuex';
|
|
4
3
|
import { StoreState } from '@/common/store';
|
|
@@ -6,7 +5,8 @@ import { Analytics } from '@/common/plugins/analytics';
|
|
|
6
5
|
import { RoomleSdkWrapper } from '@/configurator/business-logic/roomle-sdk-wrapper';
|
|
7
6
|
import { UiInitData } from '@/configurator/embedding/types';
|
|
8
7
|
import RoomleGLBViewer from '@roomle/web-sdk/lib/definitions/glb-viewer-core/src/roomle-glb-viewer';
|
|
9
|
-
|
|
8
|
+
import { Connector } from '@/common/business-logic/connector';
|
|
9
|
+
export declare class SdkConnectorViewer extends Connector {
|
|
10
10
|
private _viewer;
|
|
11
11
|
private _initWaiters;
|
|
12
12
|
private _store;
|
|
@@ -108,3 +108,19 @@ export declare const USM_PART_LIST: ({
|
|
|
108
108
|
currencySymbol: null;
|
|
109
109
|
parameters: never[];
|
|
110
110
|
})[];
|
|
111
|
+
export declare const PART_LABEL_TESTING: {
|
|
112
|
+
id: string;
|
|
113
|
+
parameters: {
|
|
114
|
+
key: string;
|
|
115
|
+
label: string;
|
|
116
|
+
type: string;
|
|
117
|
+
enabled: boolean;
|
|
118
|
+
visible: boolean;
|
|
119
|
+
visibleInPartList: boolean;
|
|
120
|
+
value: string;
|
|
121
|
+
valueLabel: string;
|
|
122
|
+
valueObjects: {
|
|
123
|
+
value: boolean;
|
|
124
|
+
}[];
|
|
125
|
+
}[];
|
|
126
|
+
};
|
|
File without changes
|
package/types/tests/integration/planner/components/{BottomBar.spec.d.ts → PlannerSidebar.spec.d.ts}
RENAMED
|
File without changes
|