@roomle/embedding-lib 5.9.0-alpha.3 → 5.9.0-alpha.5

package/src/configurator/embedding/roomle-configurator-api.d.ts

@@ -0,0 +1,65 @@
+import { ExposedApi } from './exposed-api';
+import { UiInitData } from './types';
+import { default as ConfiguratorUiCallbacks } from '@roomle/web-sdk/lib/definitions/configurator-core/src/services/configurator-ui-callback';
+import { default as RoomleConfigurator } from '@roomle/web-sdk/lib/definitions/configurator-core/src/roomle-configurator';
+import { ExposedAnalyticsCallbacks } from './exposed-analytics-callbacks';
+import { default as RoomleGLBViewer } from '@roomle/web-sdk/lib/definitions/glb-viewer-core/src/roomle-glb-viewer';
+import { default as RoomlePlanner } from '@roomle/web-sdk/lib/definitions/planner-core/src/roomle-planner';
+import { GlobalCallback } from '@roomle/web-sdk/lib/definitions/common-core/src/services/global-callback';
+
+export interface RoomleEmbeddingApiKeys {
+    extended: any;
+    ui: any;
+    analytics: any;
+    global: any;
+}
+export type RoomleConfiguratorApi = RoomleEmbeddingApi<RoomleConfigurator, ConfiguratorUiCallbacks>;
+export type RoomleViewerApi = RoomleEmbeddingApi<RoomleGLBViewer, ConfiguratorUiCallbacks>;
+export type RoomlePlannerApi = RoomleEmbeddingApi<RoomlePlanner, ConfiguratorUiCallbacks>;
+export default class RoomleEmbeddingApi<SdkType, SdkCallbacks> implements RoomleEmbeddingApiKeys {
+    static createPlanner(configuratorId: string, container: HTMLElement, initData: UiInitData): Promise<RoomlePlannerApi>;
+    /**
+     * Method to create a new instance of a Roomle Configurator
+     * @param configuratorId the id which identifies your configurator, you will get this ID from your Roomle Contact Person
+     * @param container DOM container in which the configurator should be placed
+     * @param initData settings with which the configurator should be started
+     */
+    static createConfigurator(configuratorId: string, container: HTMLElement, initData: UiInitData): Promise<RoomleConfiguratorApi>;
+    /**
+     * Method to create a new instance of a Roomle Configurator
+     * @deprecated please use "createConfigurator"
+     * @param configuratorId the id which identifies your configurator, you will get this ID from your Roomle Contact Person
+     * @param container DOM container in which the configurator should be placed
+     * @param initData settings with which the configurator should be started
+     */
+    static create(configuratorId: string, container: HTMLElement, initData: UiInitData): Promise<RoomleConfiguratorApi>;
+    /**
+     * Method to create a new instance of a Roomle Viewer
+     * @param configuratorId the id which identifies your configurator, you will get this ID from your Roomle Contact Person
+     * @param container DOM container in which the configurator should be placed
+     * @param initData settings with which the configurator should be started
+     */
+    static createViewer(configuratorId: string, container: HTMLElement, initData: UiInitData): Promise<RoomleViewerApi>;
+    private static _create;
+    ui: ExposedApi;
+    extended: SdkType;
+    analytics: {
+        callbacks: ExposedAnalyticsCallbacks;
+    };
+    global: {
+        callbacks: GlobalCallback;
+    };
+    private _waitForIframe;
+    private _container;
+    private _messageHandler;
+    private _configuratorSettings;
+    private _initData;
+    private _iframe;
+    private constructor();
+    teardown(): void;
+    private _createIframe;
+    private _onResize;
+    private _onUseFullPage;
+    private _onBackToWebsite;
+    private _executeMessage;
+}

package/src/configurator/embedding/types.d.ts

@@ -0,0 +1,505 @@
+import { FeatureFlags, GlobalInitDataDefinition, InitDataDefinition } from '@roomle/web-sdk/lib/definitions/common-core/src/utils/shims';
+import { HexColorString, RapiConfiguratorSettings, RapiId } from '@roomle/web-sdk/lib/definitions/typings/rapi-types';
+import { Enumify, MEASUREMENT_UNIT, MEASUREMENT_SYSTEM, Nullable, TutorialData } from '../../common/utils/types';
+import { ViewTypeState } from '../../common/store/collection-view-state';
+import { KernelPartList } from '@roomle/web-sdk/lib/definitions/typings/kernel';
+import { INTERACTION_NOTIFICATIONS, NOTIFICATIONS } from '../../common/components/utils/-utils/notifications';
+
+export interface ThumbnailsSettings {
+    collapsed: {
+        desktop: ViewTypeState;
+        mobile: ViewTypeState;
+    };
+    expanded: {
+        desktop: ViewTypeState;
+        mobile: ViewTypeState;
+    };
+}
+export declare enum UI_BUTTON {
+    AR = "ar",
+    PARTLIST = "partlist",
+    MULTISELECT = "multiselect",
+    DIMENSIONS = "dimensions",
+    FULLSCREEN = "fullscreen",
+    RESETCAMERA = "resetcamera",
+    RENDERIMAGE = "renderimage",
+    ADDONS = "addons",
+    REQUESTPRODUCT = "requestproduct",
+    REQUESTPLAN = "requestplan",
+    SAVEDRAFT = "savedraft",
+    STARTCONFIGURE = "startconfigure",
+    PAUSECONFIGURE = "pauseconfigure",
+    FIRST_PERSON = "firstperson",
+    EXPORT_3D = "export3d",
+    ROTATE = "rotate",
+    SNAPPING = "snapping",
+    UNDO = "undo",
+    REDO = "redo",
+    PARTLIST_PLANNER = "partlist_planner",
+    PARTLIST_PRINT = "partlist_print",
+    PRODUCTLIST = "productlist",
+    TWO_D_VIEW = "2dview",
+    ADD_ROOM = "add_room",
+    STARTPLANNER = "startPlanner",
+    THREE_D_VIEW = "3dview",
+    CLOSE_VIEW = "close_view",
+    ADD_TO_BASKET = "add_to_basket",
+    VIEW_MODE = "view_mode",
+    ADD_MEASUREMENT_LINE = "add_measurement_line",
+    HELP_CENTER = "help_center",
+    LOAD_PRODUCT = "load_product",
+    CONFIGURE_IN_ROOM = "configure_in_room"
+}
+export declare enum UI_ELEMENTS {
+    BOTTOM_BAR = "bottom_bar",
+    PARTLIST_BOUNDS = "partlist_bounds",
+    INTERACTION_NOTES = "interaction_notes"
+}
+export interface HelpCenterSetting {
+    configurator?: boolean;
+    roomdesigner?: boolean;
+    disable?: boolean;
+}
+interface UiFeatureFlags extends FeatureFlags {
+    realPartList?: boolean;
+    globalCallbacks?: boolean;
+    mocAr?: boolean;
+    wallAutoHeight?: boolean;
+}
+export interface VariantsMap {
+    [key: string]: RapiId;
+}
+export type LogLevelCanvasCoords = 'all' | 'click' | 'move';
+export interface UiInitData extends InitDataDefinition, GlobalInitDataDefinition {
+    /**
+     * @description show and hide certain buttons
+     */
+    buttons?: {
+        [UI_BUTTON.AR]?: boolean;
+        [UI_BUTTON.PARTLIST]?: boolean;
+        [UI_BUTTON.MULTISELECT]?: boolean;
+        [UI_BUTTON.DIMENSIONS]?: boolean;
+        [UI_BUTTON.FULLSCREEN]?: boolean;
+        [UI_BUTTON.RESETCAMERA]?: boolean;
+        [UI_BUTTON.RENDERIMAGE]?: boolean;
+        [UI_BUTTON.ADDONS]?: boolean;
+        [UI_BUTTON.REQUESTPRODUCT]?: boolean;
+        [UI_BUTTON.REQUESTPLAN]?: boolean;
+        [UI_BUTTON.SAVEDRAFT]?: boolean;
+        [UI_BUTTON.LOAD_PRODUCT]?: boolean;
+        [UI_BUTTON.STARTCONFIGURE]?: boolean;
+        [UI_BUTTON.PAUSECONFIGURE]?: boolean;
+        [UI_BUTTON.EXPORT_3D]?: boolean;
+        [UI_BUTTON.ROTATE]?: boolean;
+        [UI_BUTTON.SNAPPING]?: boolean;
+        [UI_BUTTON.UNDO]?: boolean;
+        [UI_BUTTON.REDO]?: boolean;
+        [UI_BUTTON.TWO_D_VIEW]?: boolean;
+        [UI_BUTTON.PARTLIST_PLANNER]?: boolean;
+        [UI_BUTTON.PARTLIST_PRINT]?: boolean;
+        [UI_BUTTON.PRODUCTLIST]?: boolean;
+        [UI_BUTTON.ADD_ROOM]?: boolean;
+        [UI_BUTTON.STARTPLANNER]?: boolean;
+        [UI_BUTTON.THREE_D_VIEW]?: boolean;
+        [UI_BUTTON.FIRST_PERSON]?: boolean;
+        [UI_BUTTON.CLOSE_VIEW]?: boolean;
+        [UI_BUTTON.ADD_TO_BASKET]?: boolean;
+        [UI_BUTTON.VIEW_MODE]?: boolean;
+        [UI_BUTTON.ADD_MEASUREMENT_LINE]?: boolean;
+        [UI_BUTTON.HELP_CENTER]?: boolean;
+        [UI_BUTTON.CONFIGURE_IN_ROOM]?: boolean;
+        [key: string]: boolean | undefined;
+    };
+    /**
+     * @description show and hide certain elements
+     */
+    elements?: {
+        [UI_ELEMENTS.BOTTOM_BAR]?: boolean;
+        [UI_ELEMENTS.PARTLIST_BOUNDS]?: boolean;
+        [UI_ELEMENTS.INTERACTION_NOTES]?: boolean;
+        [key: string]: boolean | undefined;
+    };
+    /**
+     * @description show and hide certain notifications
+     */
+    notifications?: {
+        [NOTIFICATIONS.LOAD_IDB_CONFIG]?: boolean;
+        [NOTIFICATIONS.FIRST_PERSON_CONTROLS]?: boolean;
+        [NOTIFICATIONS.STOP_CONFIGURE_HINT]?: boolean;
+        [NOTIFICATIONS.INTERACTION_NOTE]?: {
+            [INTERACTION_NOTIFICATIONS.ROOT_ELEMENT]?: boolean;
+            [INTERACTION_NOTIFICATIONS.CONFIRM_GHOSTS]?: boolean;
+            [INTERACTION_NOTIFICATIONS.ADD_ELEMENT]?: boolean;
+            [INTERACTION_NOTIFICATIONS.PARAMETER_CHANGED]?: boolean;
+        };
+    };
+    /**
+     * @description skin the embedding instance
+     */
+    skin?: EmbeddingSkin;
+    /**
+     * @description set the z-index of the embedding instance
+     */
+    zIndex?: number;
+    /**
+     * @internal
+     * @description use a local version of the embedding
+     */
+    useLocalRoomle?: boolean;
+    /**
+     * @internal
+     * @description use another server url for the embedding
+     */
+    overrideServerUrl?: string;
+    /**
+     * @deprecated
+     * @description for details see deeplink, the only change is
+     * that the placeholder is <CONF_ID> here instead
+     *  of #CONFIGURATIONID#
+     */
+    shareUrl?: string;
+    /**
+     * @description Set this parameter to use your custom share url.
+     * The provided url has to contain a configuration id parameter (`#CONFIGURATIONID#`) which will be replaced with the real
+     * configuration id.
+     * default: not set -> use Roomle short url service (linking to roomle.com domain)
+     * usage: http://www.example.com/configurator?id=#CONFIGURATIONID#
+     */
+    deeplink?: string;
+    /**
+     * @description Define to which variants you can switch from which root component id. This is a simple JS object which is
+     * used like a map, e.g.: '"usm:frame": "DB_Start_ohne_Element"' now if a configuration with root component
+     * usm:frame is loaded all the items from the tag "DB_Start_ohne_Element" are now shown as variants
+     */
+    variants?: VariantsMap;
+    /**
+     * @description if set to true you can load the configurator in an iframe.src but without any embedding lib
+     * This is needed if you do not want to interact with the configurator and only want to use it
+     * to view 3d content. Imagine it then as a <img> tag for 3d content
+     */
+    api?: boolean;
+    /**
+     * @description if this is set to true the "save draft" will be done by sending
+     * an e-mail
+     */
+    emails?: boolean;
+    /**
+     * @description set this flag to true if you want to configure on small devices in landscape as well
+     * this is relevant for things like Rubens Admin, where the configurator is embedded into a very
+     * small div
+     */
+    mobileLandscape?: boolean;
+    /**
+     * @description set this flag to true if you want to group the part list by main components
+     */
+    groupPartList?: boolean;
+    /**
+     * @internal
+     * @description this is an object which is for Roomle internal usage, we can set feature flags
+     * so that we can ensure a smooth transition between different versions of our configurator
+     */
+    featureFlags?: UiFeatureFlags;
+    /**
+     * @description  set this flag to false if the user did not give the consent to Analytics
+     */
+    gaConsent?: boolean;
+    /**
+     * @description override translations to change labels for some or all languages.
+     * Example:
+     *
+     * ```
+     *   "translations": {
+     *     "en": {
+     *       "params": {
+     *         "request-product": "Add to cart",
+     *       }
+     *     }
+     *   }
+     * ```
+     *
+     * You can find all labels here: [Base.json](../translate-labels)
+     */
+    translations?: any;
+    /**
+     * @description set this flag to false and global parameters are not applied when switching variants
+     */
+    applyCurrentGlobalParameters?: boolean;
+    /**
+     * @description set this flag to true if you want that a user can select more than one material category at once
+     */
+    materialMultiSelect?: boolean;
+    /**
+     * @description set this flag to true if you want to start the moc in configuring mode if there is only one object in the scene
+     * @groups room-designer
+     */
+    startInDetail?: boolean;
+    /**
+     * @description use this param to initialize the configurator ui state, like opening certain views, camera modes, etc
+     * @groups room-designer
+     */
+    state?: UiState;
+    /**
+     * @description define the root tag of your catalog
+     * you can define multiple root tags by using []
+     * e.g.: catalogRootTag[]=123&catalogRootTag[]=456
+     * @groups room-designer
+     */
+    catalogRootTag?: RapiId | RapiId[];
+    /**
+     * @description define the root tag of the construction elements, default is "construction_moc" when moc=true and null otherwise
+     * you can define multiple root tags by using []
+     * e.g.: constructionRootTag[]=123&constructionRootTag[]=456
+     * @groups room-designer
+     */
+    constructionRootTag?: RapiId | RapiId[];
+    /**
+     * @description define the root tag of the materials that can be used for floors
+     * you can define multiple root tags by using []
+     * e.g.: floorMaterialRootTag[]=123&floorMaterialRootTag[]=456
+     * @groups room-designer
+     */
+    floorMaterialRootTag?: RapiId | RapiId[];
+    /**
+     * @description define the root tag of the materials that can be used for walls
+     * you can define multiple root tags by using []
+     * e.g.: wallMaterialRootTag[]=123&wallMaterialRootTag[]=456
+     * @groups room-designer
+     */
+    wallMaterialRootTag?: RapiId | RapiId[];
+    /**
+     * @description define the root tag of the materials that can be used for doors
+     * you can define multiple root tags by using []
+     * e.g.: doorMaterialRootTag[]=123&doorMaterialRootTag[]=456
+     * @groups room-designer
+     */
+    doorMaterialRootTag?: RapiId | RapiId[];
+    /**
+     * @description define the root tag of the materials that can be used for windows
+     * you can define multiple root tags by using []
+     * e.g.: windowMaterialRootTag[]=123&windowMaterialRootTag[]=456
+     * @groups room-designer
+     */
+    windowMaterialRootTag?: RapiId | RapiId[];
+    /**
+     * @description define the root tag of the materials that can be used for objects
+     * you can define multiple root tags by using []
+     * e.g.: objectMaterialRootTag[]=123&objectMaterialRootTag[]=456
+     * @groups room-designer
+     */
+    objectMaterialRootTag?: RapiId | RapiId[];
+    /**
+     * @description define the root tag of the materials that can be used, this sets
+     * floorMaterialRootTag, wallMaterialRootTag, doorMaterialRootTag,
+     * windowMaterialRootTag, objectMaterialRootTag
+     * if they are not set
+     * you can define multiple root tags by using []
+     * e.g.: materialRootTag[]=123&materialRootTag[]=456
+     * @groups room-designer
+     */
+    materialRootTag?: RapiId | RapiId[];
+    /**
+     * @description sets the measurement unit to be displayed in the planner and configurator UI.
+     */
+    unit?: Enumify<typeof MEASUREMENT_UNIT>;
+    /**
+     * @description sets the measurement unit to be displayed in the planner and configurator UI.
+     * imperial sets measurementUnit to inches if no unit is passed
+     * metric sets measurementUnit to cm if no unit is passed
+     * if unit is not a metric unit (i.e. inch) but unitType=metric it will default to a metric unit (CM)
+     * and vice-versa
+     */
+    measurementSystem?: Enumify<typeof MEASUREMENT_SYSTEM>;
+    /**
+     * @description the query param thumbnails will be converted to the following object:
+     * ```
+     * {
+     *   collapsed: { desktop: ViewTypeState; mobile: ViewTypeState };
+     *   expanded: { desktop: ViewTypeState; mobile: ViewTypeState };
+     * }
+     * ```
+     *
+     * You have separate options to specify the settings for the thumbnails e.g.:
+     * ?thumbnails=big this sets all the values to "big" or you do:
+     * ?thumbnails.collapsed=big&thumbnails.expanded=list this sets the collapsed
+     * state to "big" and the expanded state to "list". Or you can specify the full
+     * object like:
+     * ?thumbnails.collapsed.desktop=big&thumbnails.collapsed.mobile=small&thumbnails.expanded.desktop=list&thumbnails.expanded.mobile=big
+     *
+     * the following values for ViewTypeState are valid: list | small | big
+     * for the collapsed state list will have no effect and just be rendered like small.
+     * On mobile collapsed will only use small
+     */
+    thumbnails?: ThumbnailsSettings;
+    /**
+     * @description start embedding instance only as viewer
+     */
+    viewer?: boolean;
+    /**
+     * @description use an external catalog (deprecated, use customView.extCatalog instead)
+     * @deprecated
+     * @groups room-designer
+     */
+    extCatalog?: string;
+    /**
+     * @description specify a custom font to be used. When using a custom font make sure you understand
+     * the legal implications. For example: copyrigth law, data protection law, etc.
+     * - source needs to be a valid url to a font file CSS.
+     *   Similar to what Google Fonts provides. For an example see:
+     *   https://fonts.googleapis.com/css?family=Lato:300,400,700&display=swap&subset=latin-ext
+     *   The font should provide the following weights: 300, 400, 700
+     *   If you use the URL as a query param make sure to use encodeURIComponent
+     * - family needs to be a valid CSS font family name.
+     *   If you use font family as a query param make sure to use encodeURIComponent
+     */
+    fonts?: {
+        source?: string;
+        family?: string;
+    };
+    /**
+     * @description Shows or hides the first person mode toggle button in the sidebar menu
+     * @groups room-designer
+     */
+    firstPersonView?: boolean;
+    /**
+     * @description Specify which context (i.e room designer or configurator or neither) to show the tutorial/helpcenter
+     * button in the sidebar.
+     */
+    helpcenter?: HelpCenterSetting;
+    /**
+     * @description Specify custom tutorials to be shown in the tutorial/helpcenter.
+     * Should be of the following format:
+     * [{
+     *  "en": { // mandatory
+     *    "link": "SOME_LINK",
+     *    "label": "first step",
+     *    "desc": "some description",
+     *  },
+     *  "de": { // optional
+     *    "link": "SOME_LINK",
+     *    "label": "first step",
+     *    "desc": "some description",
+     *  },
+     *  "SOME_OTHER_LOCALE": { // optional --> SOME_OTHER_LOCALE should be a valid locale from: https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes
+     *    "link": "SOME_LINK",
+     *    "label": "first step",
+     *    "desc": "some description",
+     *  },
+     *  "scope": "room-designer", // optional
+     *  "platform": "desktop" // optional
+     * }]
+     */
+    customTutorials?: TutorialData[];
+    /**
+     * @description Enables saving changes to the current configuration and or plan to indexedDB storage locally in the
+     * browser, reloading the page will prompt the user to restore the saved configuration/plan.
+     * - The data saved in indexedDB is stored in a key-value pair under the database 'rml-idb' and the table
+     * named 'rml-config-store' where the key consists of the current hostname (if inside an iframe it will be 'window.referrer'),
+     * the configurator ID and the plan or configurator ID separated by underscores (_).
+     * - This key format allows saved data to be scoped by the aforementioned IDs and hostname.
+     * - The data stored in 'rml-config-store' follows the following format:
+     * {
+     *     "id": "example.com_exampleConfiguratorId_examplePlanOrConfigurationId",
+     *     "data": "<...configurationOrPlanDataString...>",
+     *     "lastModified": "2024-04-16T04:54:48.825Z"
+     *     "referrer": "example.com"
+     * }
+     * - Any data in the 'rml-idb' database older than 30 days is removed automatically when the app loads.
+     */
+    saveToIdb?: boolean;
+    /**
+     * @description when the configurator/Room Designer is embedded into a too small space we start it in view
+     * only mode, then the user has to click the "start" button and the configurator/Room Designer expands over
+     * the whole window. This is great for UX but it's not always ideal in every use case. Therefore you can
+     * turn on/off this behavior now with this toggle.
+     */
+    autoStart?: boolean;
+    /**
+     * @internal
+     * @description if set to true the coords of the clicks on the canvas will be logged to the console
+     */
+    logCanvasCoords?: LogLevelCanvasCoords;
+    /**
+     * @description For use with planner only, if set to true the room will be shown while configuring a configurable object.
+     */
+    configureInRoom?: boolean;
+    /**
+     * @description define when you want to show the search bar, currently we hide the search bar until there are more than 10 elements.
+     * since it is a query param the value is a string. Please only provide a string that can be parseInt(x,10) otherwise it will be
+     * undefined behavior
+     */
+    searchThreshold?: string;
+    /**
+     * @description Sets the rotation indicator to snap a plan object to the nearest supplied degree value while being rotated, default is 10 degrees.
+     * Supplying 0 will allow the rotation indicator to rotate plan object freely.
+     */
+    rotationSnapDegrees?: number;
+    /**
+     * @description specify an url which can be used as src for an iframe
+     */
+    customView?: CustomViews;
+}
+export interface UiState {
+    /**
+     * define which modes are active when starting the planner/MOC
+     */
+    mode?: 'room' | 'catalog';
+}
+export interface EmbeddingSkin {
+    'primary-color'?: HexColorString;
+    'primary-color-in-rgb'?: HexColorString;
+    'color-on-primary'?: HexColorString;
+    'cta-color'?: HexColorString;
+    'color-on-cta'?: HexColorString;
+    [key: string]: HexColorString | undefined;
+}
+export interface ConfiguratorSettings extends RapiConfiguratorSettings {
+    id: string;
+    allowedHost: string;
+    tenant: number;
+    url: string;
+    settings: UiInitData;
+}
+interface PartlistPrintPayload {
+    partList: KernelPartList[];
+    price: Nullable<string>;
+    label: string;
+    bounds: string;
+    catalogLabel: Nullable<string>;
+}
+type CallbackPayloads = {
+    [UI_BUTTON.PARTLIST_PRINT]: PartlistPrintPayload;
+};
+type DefaultCallbackPayloads<T, U extends string> = {
+    [K in U]: K extends keyof T ? T[K] : void;
+};
+export type ButtonCallbackPayloads = DefaultCallbackPayloads<CallbackPayloads, UI_BUTTON>;
+interface CustomViewSettingsBase<T> {
+    options?: T;
+}
+export interface CustomViewSettingsForOverlay<T> extends CustomViewSettingsBase<T> {
+    overlay: boolean;
+}
+export interface CustomViewSettingsForIframe<T> extends CustomViewSettingsBase<T> {
+    url: string;
+}
+export type CustomViewSettings<T> = CustomViewSettingsForOverlay<T> | CustomViewSettingsForIframe<T>;
+export interface CustomViews {
+    itemSelection?: CustomViewSettings<object>;
+    extCatalog?: CustomViewSettings<{
+        showHeader: boolean;
+    }>;
+}
+export interface CustomViewsCallbacks {
+    itemSelection: void;
+    extCatalog: void;
+}
+export type CustomViewCallbackInfo = {
+    [K in keyof CustomViewsCallbacks]: [
+        viewName: K,
+        viewArgs: CustomViewsCallbacks[K]
+    ];
+}[keyof CustomViewsCallbacks];
+export type PossibleCustomViewSettings = CustomViews[keyof CustomViews];
+export type PossibleCustomViews = keyof CustomViews;
+export type PossibleCustomViewsAndMain = PossibleCustomViews | 'main';
+export {};

package/src/configurator/plugins/ar-service-plugin.d.ts

@@ -0,0 +1,6 @@
+declare const ARServicePlugin: {
+    install(app: any, { configuratorId }: {
+        configuratorId: string;
+    }): void;
+};
+export default ARServicePlugin;

package/src/configurator/plugins/embedding-callbacks-plugin.d.ts

@@ -0,0 +1,4 @@
+declare const EmbeddingCallbacksPlugin: {
+    install(app: any): void;
+};
+export default EmbeddingCallbacksPlugin;

package/src/configurator/plugins/libs-plugin.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="jspdf" />
+export declare class Libs {
+    getJsPdf(): Promise<{
+        jsPDF: typeof import('jspdf').jsPDF;
+        autoTable: typeof import('jspdf-autotable').default;
+    }>;
+}
+declare const LibsPlugin: {
+    install(app: any): void;
+};
+export default LibsPlugin;

package/src/configurator/plugins/sdk-connector-plugin.d.ts

@@ -0,0 +1,21 @@
+import { Analytics } from '../../common/plugins/analytics';
+import { RoomleSdkWrapper } from '../business-logic/roomle-sdk-wrapper';
+import { Store } from 'vuex';
+import { StoreState } from '../../common/store';
+import { ExposedCallbacks } from '../embedding/exposed-callbacks';
+import { default as EventEmitter } from '../../common/business-logic/event-emitter';
+import { Translator } from '../../common/composables/use-intl';
+import { Libs } from './libs-plugin';
+
+declare const SdkConnectorPlugin: {
+    install(app: any, { analytics, store, sdkWrapper, embeddingCallbacks, eventEmitter, intl, libs, }: {
+        analytics: Analytics;
+        sdkWrapper: RoomleSdkWrapper;
+        store: Store<StoreState>;
+        embeddingCallbacks: ExposedCallbacks;
+        eventEmitter: EventEmitter;
+        intl: Translator;
+        libs: Libs;
+    }): void;
+};
+export default SdkConnectorPlugin;

package/src/configurator/store/core-data.d.ts

@@ -0,0 +1,25 @@
+import { Module } from 'vuex';
+import { StoreState } from '../../common/store';
+import { KernelParameterGroup, KernelPartList, UiKernelParameter, UiPossibleChildTag } from '@roomle/web-sdk/lib/definitions/typings/kernel';
+import { Nullable } from '../../common/utils/types';
+import { KernelBoundsFormatted } from '../../common/utils/helper';
+import { EnsurePrefix } from './ui-state';
+
+export interface ParameterGroup extends KernelParameterGroup {
+    parameters: UiKernelParameter[];
+}
+type CoreDataIdentifier = EnsurePrefix<'CORE_DATA_'>;
+export interface CoreData {
+    groups: ParameterGroup[];
+    parameters: UiKernelParameter[];
+    addons: UiPossibleChildTag[];
+    partList: KernelPartList;
+    bounds: Nullable<KernelBoundsFormatted>;
+    currencySymbol: string;
+    price: Nullable<number>;
+}
+export declare const CORE_DATA_MUTATIONS: CoreDataIdentifier;
+export declare const CORE_DATA_ACTIONS: CoreDataIdentifier;
+export declare const CORE_DATA_GETTERS: CoreDataIdentifier;
+export declare const coreData: Module<CoreData, StoreState>;
+export {};

package/src/configurator/store/core-state.d.ts

@@ -0,0 +1,21 @@
+import { Module } from 'vuex';
+import { StoreState } from '../../common/store';
+import { Nullable } from '../../common/utils/types';
+import { EnsurePrefix } from './ui-state';
+import { UiPlanObject } from '@roomle/web-sdk/lib/definitions/typings/kernel';
+
+type CoreStateIdentifier = EnsurePrefix<'CORE_STATE_'>;
+export interface CoreState {
+    label: string;
+    componentHasChildren: boolean;
+    componentRuntimeId: Nullable<number>;
+    catalogLabel: Nullable<string>;
+    initialHash: Nullable<string>;
+    currentHash: Nullable<string>;
+    currentPlanElement: Nullable<UiPlanObject>;
+}
+export declare const CORE_STATE_MUTATIONS: CoreStateIdentifier;
+export declare const CORE_STATE_ACTIONS: CoreStateIdentifier;
+export declare const CORE_STATE_GETTERS: CoreStateIdentifier;
+export declare const coreState: Module<CoreState, StoreState>;
+export {};