@roomle/embedding-lib 5.7.0-alpha.1 → 5.7.0-alpha.3

package/index.d.ts

@@ -1,54 +1,131 @@
-import { default as default_2 } from '@roomle/web-sdk/lib/definitions/planner-core/src/roomle-planner';
-import { default as default_3 } from '@roomle/web-sdk/lib/definitions/configurator-core/src/services/configurator-ui-callback';
-import { default as default_4 } from '@roomle/web-sdk/lib/definitions/configurator-core/src/roomle-configurator';
+import { default as default_2 } from '@roomle/web-sdk/lib/definitions/configurator-core/src/roomle-configurator';
+import { default as default_3 } from '@roomle/web-sdk/lib/definitions/planner-core/src/roomle-planner';
+import { default as default_4 } from '@roomle/web-sdk/lib/definitions/configurator-core/src/services/configurator-ui-callback';
 import { default as default_5 } from '@roomle/web-sdk/lib/definitions/glb-viewer-core/src/roomle-glb-viewer';
+import { EmbeddingCommand } from '../../common/src/utils/message-handler';
 import { ExposedAnalyticsCallbacks } from '../../../src/configurator/embedding/exposed-analytics-callbacks';
 import { ExposedApi } from '../../../../src/configurator/embedding/exposed-api';
 import { ExposedApi as ExposedApi_2 } from '../../../src/configurator/embedding/exposed-api';
 import { GlobalCallback } from '@roomle/web-sdk/lib/definitions/common-core/src/services/global-callback';
+import { MessageHandler } from '../../common/src/utils/message-handler';
+import { Nullable } from '../../../src/common/utils/types';
+import { OnBeforeUpdateDragGhost } from '../../../../common/src/utils/drag';
+import { OnBeforeUpdateDragGhost as OnBeforeUpdateDragGhost_2 } from '../../../common/src/utils/drag';
+import { PossibleCustomViews } from '../../../src/configurator/embedding/types';
+import { PossibleCustomViewsAndMain } from '../../../src/configurator/embedding/types';
+import { PossibleCustomViewsAndMain as PossibleCustomViewsAndMain_2 } from '../../../../src/configurator/embedding/types';
 import { RapiId } from '@roomle/web-sdk/lib/definitions/typings/rapi-types';
 import { UiInitData } from '../../../src/configurator/embedding/types';
 
-declare interface AvailablePlugins {
-    dragIn?: DragIn;
-}
+declare type AvailablePlugins = {
+    [K in keyof PluginMap]?: InstanceType<PluginMap[K]>;
+};
 
-declare class DragIn {
-    private _iframe;
-    private _currentDrag;
-    private _currentTouch;
-    private _firefoxDragPosition;
-    private _instance;
-    options: {
-        dragInOverlapX?: number;
-        dragInOverlapY?: number;
-        fingerSize?: number;
-        touchDragDelay?: number;
-        touchDragEpsilon?: number;
+declare class Connector<SdkType, SdkCallbacks> implements RoomleEmbeddingApiKeys {
+    protected _messageHandler: Nullable<MessageHandler>;
+    isSetupDone: boolean;
+    viewName: PossibleCustomViewsAndMain;
+    plugins: AvailablePlugins;
+    pluginsLoaded: Array<Promise<void>>;
+    ui: ExposedApi_2;
+    extended: SdkType;
+    configurator: default_2;
+    analytics: {
+        callbacks: ExposedAnalyticsCallbacks;
     };
+    global: {
+        callbacks: GlobalCallback;
+    };
+    setMessageHandler(messageHandler: MessageHandler): void;
+    handleSetup(methodsAndCallbacks: {
+        methods: string[];
+        callbacks: string[];
+    }): void;
+    executeMessage({ message, args }: EmbeddingCommand): Promise<{
+        result: any;
+    }>;
+    setupPlugins(plugins: PluginDefinitions, iframe: HTMLIFrameElement | HTMLBodyElement, mode?: EmbeddingPluginMode): void;
+}
+
+declare class DragIn extends EmbeddingPlugin implements DragInStrategy {
+    options: DragInSettings;
+    private _strategy;
+    private _customDragSignal;
     private _injectStyles;
     private _initializeDragGhost;
-    constructor(iframe: HTMLIFrameElement);
-    setInstance(instance: ExposedApi): void;
-    private _firefoxFallback;
-    dragStart(id: RapiId, event: DragEvent | TouchEvent, type?: string): void;
-    dragUpdate(event: DragEvent | TouchEvent): void;
+    constructor(instance: ExposedApi, mainDomElement: HTMLIFrameElement | HTMLBodyElement, mode: EmbeddingPluginMode, viewName: PossibleCustomViewsAndMain_2);
+    init(): Promise<void>;
+    get isDragging(): boolean;
+    dragStart(id: RapiId, event: DragEvent | TouchEvent | MouseEvent, type?: string): void;
+    dragUpdate(event: DragEvent | TouchEvent | MouseEvent): void;
     dragEnd(): void;
     touchStart(id: RapiId, event: TouchEvent, type?: string): void;
     touchMove(event: TouchEvent): void;
     touchEnd(): void;
     dispose(): void;
+    beforeUpdateGhost(handler: OnBeforeUpdateDragGhost_2): void;
+    registerCustomDrag({ customDragStart, customDragEnd, customDragUpdate, beforeUpdateGhost, }: {
+        customDragStart: (event: MouseEvent | TouchEvent) => void;
+        customDragEnd: (event: MouseEvent | TouchEvent) => void;
+        customDragUpdate: (event: MouseEvent | TouchEvent) => void;
+        beforeUpdateGhost?: OnBeforeUpdateDragGhost_2;
+    }): void;
+    unregisterCustomDrag(): void;
+    releaseInput(event: DragEvent | TouchEvent | MouseEvent): void;
+}
+
+declare interface DragInSettings {
+    dragInOverlapX?: number;
+    dragInOverlapY?: number;
+    fingerSize?: number;
+    touchDragDelay?: number;
+    touchDragEpsilon?: number;
+    customDragDelay?: number;
+    customDragEpsilon?: number;
 }
 
+declare interface DragInStrategy {
+    isDragging: boolean;
+    dragStart(id: RapiId, event: DragEvent | TouchEvent | MouseEvent, type: string): void;
+    dragUpdate(event: DragEvent | TouchEvent | MouseEvent): void;
+    dragEnd(): void;
+    touchStart(id: RapiId, event: TouchEvent, type: string): void;
+    touchMove(event: TouchEvent): void;
+    touchEnd(): void;
+    beforeUpdateGhost(handler: OnBeforeUpdateDragGhost): void;
+    releaseInput(event: DragEvent | TouchEvent | MouseEvent): void;
+    dispose(): void;
+}
+
+declare class EmbeddingPlugin {
+    protected _mainDomElement: HTMLIFrameElement | HTMLBodyElement;
+    protected _instance: ExposedApi;
+    protected _mode: EmbeddingPluginMode;
+    protected _viewName: PossibleCustomViewsAndMain_2;
+    constructor(instance: ExposedApi, iframe: HTMLIFrameElement | HTMLBodyElement, mode: EmbeddingPluginMode, viewName: PossibleCustomViewsAndMain_2);
+    init(): Promise<void>;
+}
+
+declare type EmbeddingPluginMode = 'website' | 'custom-view';
+
+declare type PluginConstructors = {
+    [K in keyof PluginMap]: PluginMap[K];
+};
+
 declare type PluginDefinitions = Array<keyof AvailablePlugins | {
     name: keyof AvailablePlugins;
-    loader: () => Promise<any>;
+    loader: () => Promise<PluginConstructors[keyof PluginConstructors]>;
 }>;
 
-declare type RoomleConfiguratorApi = RoomleEmbeddingApi<default_4, default_3>;
+declare interface PluginMap {
+    dragIn: typeof DragIn;
+}
+
+declare type RoomleConfiguratorApi = RoomleEmbeddingApi<default_2, default_4>;
 
-declare class RoomleEmbeddingApi<SdkType, SdkCallbacks> implements RoomleEmbeddingApiKeys {
+declare class RoomleEmbeddingApi<SdkType, SdkCallbacks> extends Connector<SdkType, SdkCallbacks> {
     static createPlanner(configuratorId: string, container: HTMLElement, initData: UiInitData, plugins?: PluginDefinitions): Promise<RoomlePlannerApi>;
+    static connect(customView: PossibleCustomViews, plugins?: PluginDefinitions): Promise<Connector<default_2, default_4>>;
     /**
      * 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
@@ -72,23 +149,11 @@ declare class RoomleEmbeddingApi<SdkType, SdkCallbacks> implements RoomleEmbeddi
      */
     static createViewer(configuratorId: string, container: HTMLElement, initData: UiInitData, plugins?: PluginDefinitions): Promise<RoomleViewerApi>;
     private static _create;
-    ui: ExposedApi_2;
-    extended: SdkType;
-    configurator: default_4;
-    analytics: {
-        callbacks: ExposedAnalyticsCallbacks;
-    };
-    global: {
-        callbacks: GlobalCallback;
-    };
-    plugins: AvailablePlugins;
     private _waitForIframe;
     private _container;
-    private _messageHandler;
     private _configuratorSettings;
     private _initData;
     private _iframe;
-    pluginsLoaded: Array<Promise<void>>;
     private constructor();
     teardown(): void;
     private _createIframe;
@@ -107,8 +172,8 @@ declare interface RoomleEmbeddingApiKeys {
     global: any;
 }
 
-declare type RoomlePlannerApi = RoomleEmbeddingApi<default_2, default_3>;
+declare type RoomlePlannerApi = RoomleEmbeddingApi<default_3, default_4>;
 
-declare type RoomleViewerApi = RoomleEmbeddingApi<default_5, default_3>;
+declare type RoomleViewerApi = RoomleEmbeddingApi<default_5, default_4>;
 
 export { }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@roomle/embedding-lib",
-  "version": "5.7.0-alpha.1",
+  "version": "5.7.0-alpha.3",
   "description": "This is a small library which can be used to communicate with the Roomle Configurator",
   "type": "module",
   "main": "./roomle-embedding-lib.umd.js",
@@ -29,7 +29,7 @@
     "npm": "8.3.1"
   },
   "devDependencies": {
-    "@roomle/web-sdk": "2.88.1-alpha.1"
+    "@roomle/web-sdk": "2.89.0-alpha.5"
   },
   "repository": {
     "type": "git",