@roomle/embedding-lib 5.34.0-alpha.2 → 5.34.0-debug.2

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

@@ -1,204 +0,0 @@
-import { ExposedCallbacks } from './exposed-callbacks';
-import { LoadResponse, SdkConnector } from '../business-logic/sdk-connector';
-import { MessageHandler } from '../../../packages/common/src/utils/message-handler';
-import { Store } from 'vuex';
-import { StoreState } from '../../common/store';
-import { Nullable } from '../../common/utils/types';
-import { ExtObjId, RoomleConfiguratorType, RoomlePlannerWithExtObjs, RoomleGLBViewer, GlobalCallback, Position3, KernelPlanObject, RapiAccess, ID_TYPE, RapiId, LoadExternalObjectGroupResult } from '../../../packages/web-sdk/packages';
-import { Analytics } from '../../common/plugins/analytics';
-import { Translator } from '../../common/composables/use-intl';
-import { Libs } from '../plugins/libs-plugin';
-import { ExposedOverlays } from '../../common/components/utils/-utils/overlays';
-import { default as EventEmitter } from '../../common/business-logic/event-emitter';
-import { DragInOptions } from '../../../packages/embedding-lib/src/plugins/types';
-import { CustomViewSettingsForIframe, PossibleCustomViews } from './types';
-
-export declare class ExposedApi {
-    private _sdk;
-    private _exposedCallbacks;
-    private _sdkConnector;
-    private _store;
-    private _analytics;
-    private _exposedAnalyticsCallbacks;
-    private _isWebsiteReady;
-    private _libs;
-    private _intl;
-    private _configuratorSdk;
-    private _globalCallback;
-    private _messageHandlers;
-    private _eventEmitter;
-    private _rapi;
-    private _dragHandler;
-    constructor(sdkConnector: SdkConnector, mainMessageHandlers: Nullable<MessageHandler>, sdk: RoomleConfiguratorType | RoomleGLBViewer | RoomlePlannerWithExtObjs, exposedCallbacks: ExposedCallbacks, store: Store<StoreState>, analytics: Analytics, globalCallback: GlobalCallback, intl: Translator, libs: Libs, eventEmitter: EventEmitter, rapiAccess: RapiAccess);
-    private _getMethodsAndCallbacks;
-    get callbacks(): ExposedCallbacks;
-    /**
-     * call this method to load the object you want into the 3d Scene
-     * @param id database ID of the object you want to load
-     */
-    loadObject(id: string): Promise<Nullable<LoadResponse>>;
-    /**
-     * call this method to load the object you want into the 3d Scene
-     * @param data the external object configuration
-     */
-    loadExternalObject(data: object): Promise<Nullable<LoadExternalObjectGroupResult[]>>;
-    /**
-     * Calling this method while dragging an item in from a catalog (or external catalog)
-     * will cancel the drag-in and remove the item from the scene.
-     */
-    cancelDragIn(): void;
-    /**
-     * call this method to load the desired catalog to show in the UI
-     * @param catalogId root catalog id
-     */
-    loadCatalog(catalogId: string): Promise<Nullable<LoadResponse>>;
-    /**
-     * call this method to load the configuration string you want into the 3d Scene
-     * @param configurationString string of the configuration, starts with `{` and ends with `}`
-     * @returns null if configuration can not be loaded
-     */
-    loadConfigurationString(configurationString: string): Promise<Nullable<LoadResponse>>;
-    /**
-     * set the price for the UI to show
-     * most likely needed when implementing your own price service
-     *
-     * @param currencySymbol
-     * @param price
-     */
-    setPrice(currencySymbol: string, price: number): void;
-    /**
-     * This method can be used to start configuration when
-     * 3d scene is only initialized as viewer first, the
-     * configurator is automatically instantiated as viewer
-     * if the container where the configurator is placed is
-     * smaller than 1024px (this breakpoint could change in future)
-     * so do not rely on this exact pixel setting
-     */
-    startConfiguring(): void;
-    /**
-     * This method can be used to pause configuration
-     * If the configurator was called in view-only mode
-     * this method triggers the onBackToWebsite callback.
-     * To know when the view-only mode is activated see the
-     * description of the startConfiguring method
-     */
-    pauseConfiguring(): void;
-    /**
-     * call this method to trigger the onRequestProduct event from
-     * outside of the iframe. When this method is called the same
-     * process is kicked off as if the user would have clicked on
-     * request product. Therefore you can just use the same callback
-     * to react on the response
-     */
-    triggerRequestProduct(): Promise<void>;
-    /**
-     * call this method to trigger the onSaveDraft event from
-     * outside of the iframe. When this method is called the same
-     * process is kicked off as if the user would have clicked on
-     * save draft in the bottom bar. Therefore you can just use the same callback
-     * to react on the response
-     */
-    triggerSaveDraft(email?: string): Promise<void>;
-    /**
-     * call this method to trigger the onRequestPlan event from
-     * outside of the iframe. When this method is called the same
-     * process is kicked off as if the user would have clicked on
-     * request plan. Therefore you can just use the same callback
-     * to react on the response
-     */
-    triggerRequestPlan(): Promise<void>;
-    /**
-     * call this method if consent of Google Analytics is given later and not already in init-data on boot
-     */
-    giveGaConsent(): void;
-    /**
-     * Insert an object into the current MOC/planner scene
-     * If no position or rotation is set then it will be placed automatically (without overlapping other objects) with rotation 0
-     * @param id
-     * @param position as x (left/right), y (up/down) and z (front/back)
-     * @param rotation in radians
-     */
-    insertObject(id: string, position?: Position3, rotation?: number): Promise<void>;
-    /**
-     * Load a plan from an XML string into the planner scene
-     * @param xml - The plan XML string to load
-     */
-    loadPlanXml(xml: string): Promise<void>;
-    /**
-     * Changes the currently selected parameter group to a parameter group containing the specified key.
-     * @param groupKey - parameterGroup key.
-     */
-    setActiveParameterGroup(groupKey: string): void;
-    /**
-     * Use this to start a drag in of an object the coordinates x and y are relative
-     * to the iframe. Meaning 0/0 is the top left corner of the iframe
-     * @param id Roomle ID of the object that should be inserted and dragged
-     * @param x coordinate of the drag event
-     * @param y coordinate of the drag event
-     * @param type type of the id, default is 'rml_id' for example: usm:frame, 'rml_serialized' for serialized configurations like {"componentId": "usm:frame"} (currently not supported), 'tc_serialized' for serialized TecConfig Object, 'tc_id' for TecConfig ID (currently not supported)
-     * @returns number runtimeId of the dragged object
-     */
-    dragInObject(id: string, x: number, y: number, type?: ID_TYPE): Promise<number>;
-    getBoundingClientRect(selector: string): DOMRect;
-    private _getComputedStyle;
-    getDrawerAnimation(): {
-        transition: string;
-        direction: string;
-    };
-    getPopUpShadowStyle(): {
-        backgroundColor: string;
-        cursor: string;
-    };
-    closePopUp(): void;
-    /**
-     * After you called dragInObject you can call this method to update the drag position
-     * the coordinates x and y are relative to the iframe. Meaning 0/0 is the top left
-     * corner of the iframe
-     * @param x coordinate of the drag event
-     * @param y coordinate of the drag event
-     * @returns void
-     */
-    updateDrag(x: number, y: number, options?: DragInOptions): void;
-    /**
-     * Call this method when the drag ends
-     */
-    dragInObjectEnd(): void;
-    getPartListPdf(planObject?: KernelPlanObject): Promise<any>;
-    /**
-     * List of overlays that can be triggered from outside the iframe.
-     * These overlays allow for controlled external triggering, ensuring
-     * that only specific, predefined overlays can be displayed from external sources.
-     *
-     * Each overlay in the set is identified by a unique number:
-     *
-     * - SAVE_DRAFT: 1
-     * - OPEN_AR: 4
-     * - EXPORT_3D: 5
-     * - TUTORIALS: 11
-     * - LOAD_PRODUCT: 12 (only available in Room Designer)
-     */
-    triggerShowOverlay(overlay: ExposedOverlays): Promise<void>;
-    getDrawerBoundingClientRect(): Promise<{
-        actual: DOMRect;
-        final: DOMRect;
-    }>;
-    disableEvents(): void;
-    enableEvents(): void;
-    toggleDrawer(): void;
-    activateCustomView(viewName: PossibleCustomViews, options: CustomViewSettingsForIframe<any>): void;
-    deactivateCustomView(viewName: PossibleCustomViews, options: CustomViewSettingsForIframe<any>): void;
-    private _setRoomDesignerActive;
-    deactivateRoomDesigner(): void;
-    activateRoomDesigner(): void;
-    private _websiteReady;
-    private _handleMessage;
-    private _forwardSdkCallbacks;
-    /**
-     *
-     * Inserts an object into the plan or swapped an object with an existing object in the plan.
-     * If an object in the scene is selected and the swap action is enabled, the selected object is replaced with the new object.
-     * If no object is selected or the swap action is disabled, the new object is simply inserted into the scene.
-     * @param objectId of the object being inserted or swapped
-     */
-    insertOrSwapObject(objectId: RapiId | ExtObjId): Promise<void>;
-}

package/src/configurator/embedding/exposed-callbacks.d.ts

@@ -1,89 +0,0 @@
-import { Base64Image, KernelPartList, UiPlanObject, RapiConfigurationEnhanced, ExternalConfiguration } from '../../../packages/web-sdk/packages';
-import { ButtonCallbackPayloads, CustomViewCallbackInfo } from './types';
-import { Nullable, SaveDraftPayload } from '../../common/utils/types';
-
-export interface Price {
-    currencySymbol: Nullable<string>;
-    price: Nullable<number>;
-}
-export interface Labels {
-    catalogLabel: Nullable<string>;
-    label: Nullable<string>;
-}
-export declare class ExposedCallbacks {
-    /**
-     * Returns all necessary params when 'Request Product'/'Checkout' button has pressed
-     * @param configurationId id of the current configuration
-     * @param image image of the current configuration
-     * @param partList the part list with all details, grouped, etc
-     * @param price price of the current configuration, either set via setPrice or from Roomle price service
-     * @param labels the label of the catalog and the furniture system
-     * @param configuration the data returned from the Roomle backend
-     */
-    onRequestProduct: (configurationId: string, image: Base64Image, partList: KernelPartList, price: Price, labels: Labels, configuration: RapiConfigurationEnhanced | ExternalConfiguration) => void;
-    /**
-     * fullList fullList (needed for price calculation) of the current configuration
-     * @param partList the part list with all details, grouped, etc
-     */
-    onPartListUpdate: (partList: KernelPartList, hash: string) => void;
-    onResize: (isDesktop: boolean) => void;
-    onUseFullPage: () => void;
-    /**
-     * Gets called when the configuring is paused and the user leaves fullscreen configurator mode
-     */
-    onBackToWebsite: () => void;
-    /**
-     * Gets called when a button in the UI is clicked
-     * @param name
-     * @param args - Optional arguments specific to the button that was clicked. This parameter is an object where each key is a UI_BUTTON and the value is the corresponding arguments for that button.
-     * @returns overrideEventBehaviour true if the event has been consumed and it should not trigger default behaviour, undefined or false otherwise
-     */
-    onButtonClicked: <K extends keyof ButtonCallbackPayloads>(name: K, args?: ButtonCallbackPayloads[K]) => Promise<boolean> | boolean | void;
-    onRequestPlan: (planId: string, image: Base64Image, items: any[], plan: RapiPlanSnapshotGetData | RapiPlan) => void;
-    /**
-     * Gets called if a plan object gets added, changed or removed and returns all objects of the plan
-     * @param objects -- all objects in the plan
-     */
-    onPlanUpdate: (objects: UiPlanObject[]) => void;
-    /**
-     * Called when an element is added to the plan, not called when wall or construction element added
-     * @param addedObject
-     */
-    onPlanElementAdded: (addedObject: UiPlanObject) => void;
-    /**
-     * Called when an element is removed from the plan, not called when wall or construction element removed
-     * @param removedObject
-     */
-    onPlanElementRemoved: (removedObject: UiPlanObject) => void;
-    /**
-     * Called when an element is changed in the plan, not called when wall or construction element changed
-     * @param changedObject
-     */
-    onPlanElementChanged: (changedObject: UiPlanObject) => void;
-    /**
-     * Called when an element is moved in the plan, not called when wall or construction element is moved
-     * @param changedObject
-     */
-    onPlanElementMoved: (changedObject: UiPlanObject) => void;
-    /**
-     * Gets triggered if a tooltip gets closed by controls button
-     * @param tooltipName
-     */
-    onTooltipClose: (tooltipName: string) => void;
-    /**
-     * called when triggerSaveDraft called
-     * @param id configuration id or plan id
-     * @param image image of the current configuration
-     * @param url generated url from save draft
-     * @param data object contains
-     * { type: 'plan' | 'configuration', payload: configuration object or plan snapshot data}
-     */
-    onSaveDraft: (id: string, image: string, url: string, data: SaveDraftPayload) => void;
-    onShowCustomView: (...[viewName, data]: CustomViewCallbackInfo) => Promise<Nullable<boolean>> | Nullable<boolean>;
-    onHideCustomView: (...[viewName, data]: CustomViewCallbackInfo) => void;
-    onCollapseDrawer: (_wasChangeBetweenDesktopAndMobile: boolean) => void;
-    onExpandDrawer: (_wasChangeBetweenDesktopAndMobile: boolean) => void;
-    onSidebarEvent: (...[type, params]: SidebarEventCallbackInfo) => void;
-    onShowPopUp: () => void;
-    onHidePopUp: () => void;
-}

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

@@ -1,29 +0,0 @@
-import { ExposedCallbacks } from './exposed-callbacks';
-import { Store } from 'vuex';
-import { StoreState } from '../../common/store';
-import { SdkConnector } from '../business-logic/sdk-connector';
-import { Analytics } from '../../common/plugins/analytics';
-import { RapiConfigurationEnhanced, RapiPlan, RapiPlanSnapshotGetData, KernelPartList, KernelPlanObject, SelectionPayload, ExternalConfiguration } from '../../../packages/web-sdk/packages';
-import { Nullable, SaveDraft } from '../../common/utils/types';
-import { KernelBoundsFormatted } from '../../common/utils/helper';
-import { Ref } from 'vue';
-import { Libs } from '../plugins/libs-plugin';
-import { Translator } from '../../common/composables/use-intl';
-
-export declare const startConfiguring: (store: Store<StoreState>, exposedCallbacks: ExposedCallbacks) => void;
-export declare const resetSidebarStates: (store: Store<StoreState>) => void;
-export declare const stopConfiguring: (store: Store<StoreState>, sdkConnector: SdkConnector, embeddingCallbacks?: ExposedCallbacks) => Promise<void>;
-export declare const triggerRequestProduct: (embeddingCallbacks: ExposedCallbacks, sdkConnector: SdkConnector, store: Store<StoreState>, analytics: Analytics) => Promise<void>;
-export declare const sendSaveDraft: (sdkConnector: SdkConnector, store: Store<StoreState>, currentConfiguration: RapiConfigurationEnhanced | Nullable<RapiPlanSnapshotGetData | RapiPlan | ExternalConfiguration>) => Promise<any>;
-export declare function handleSave(embeddingCallbacks: ExposedCallbacks, sdkConnector: SdkConnector, store: Store<StoreState>, analytics: Analytics, email?: string): Promise<SaveDraft>;
-export declare const initializeConfiguration: (sdkConnector: SdkConnector, isPlanner: boolean, store: Store<StoreState>, email?: string, analytics?: Analytics, embeddingCallbacks?: ExposedCallbacks, skipSendCallback?: boolean) => Promise<{
-    configuration: any;
-    image: Base64Image;
-    url: string;
-}>;
-export declare const generateUrl: (sdkConnector: SdkConnector, store: Store<StoreState>, currentConfiguration: Nullable<RapiPlan | RapiConfigurationEnhanced | RapiPlanSnapshotGetData | ExternalConfiguration>, isPlanner: boolean) => Promise<string>;
-export declare const triggerRequestPlan: (embeddingCallbacks: ExposedCallbacks, sdkConnector: SdkConnector, store: Store<StoreState>, analytics: Analytics) => Promise<void>;
-export declare const getCurrentPerspectiveImage: (currentSelectedElement: Nullable<SelectionPayload>) => any;
-export declare const printPartList: (partList: KernelPartList[], price: Nullable<string>, label: string, bounds: string, catalogLabel: Nullable<string>, sdkConnector: SdkConnector, store: Store<StoreState>, embeddingCallbacks: ExposedCallbacks, libs: Libs, intl: Translator, isGenerating: Ref<boolean>) => Promise<void>;
-export declare const generatePartListPdf: (partList: KernelPartList[], price: Nullable<string>, label: string, bounds: string, catalogLabel: Nullable<string>, sdkConnector: SdkConnector, store: Store<StoreState>, libs: Libs, intl: Translator, isGenerating: Ref<boolean>, perspectiveImage?: string, planObject?: KernelPlanObject) => Promise<import('jspdf').jsPDF>;
-export declare const formatBounds: (bounds: Nullable<KernelBoundsFormatted>, intl: Translator) => string;

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

@@ -1,61 +0,0 @@
-import { ExposedApi } from './exposed-api';
-import { UiInitData } from './types';
-import { ConfiguratorUiCallbacks, RoomleConfigurator, RoomleGLBViewer, RoomlePlanner, GlobalCallback } from '../../../packages/web-sdk/packages';
-import { ExposedAnalyticsCallbacks } from './exposed-analytics-callbacks';
-
-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;
-}