@archilogic/floor-plan-sdk 5.0.0-rc.0 → 5.0.0-rc.2

package/dist/fpe.d.ts

@@ -309,10 +309,10 @@ declare class FloorPlanCore {
     constructor({ options }?: {
         options?: FpeConfig;
     });
-    on(event: FpeCoreEvent, callback: Function, ctx?: any): this;
-    once(event: FpeCoreEvent, callback: Function, ctx?: any): this;
-    off(event: FpeCoreEvent, callback?: Function): this;
-    emit(event: FpeCoreEvent, ...args: any[]): this;
+    on<EventType extends FpeCoreEvent, Context>(event: EventType, handler: FpeCoreEventHandler<EventType>, ctx?: Context): this;
+    once<EventType extends FpeCoreEvent, Context>(event: EventType, handler: FpeCoreEventHandler<EventType>, ctx?: Context): this;
+    off<EventType extends FpeCoreEvent>(event: EventType, handler?: FpeCoreEventHandler<EventType>): this;
+    emit<EventType extends FpeCoreEvent>(event: EventType, ...args: FpeCoreEventMap[EventType]): this;
     loadLayout(layout: SpaceGraphLayout, { skipGeometryCompute }?: {
         skipGeometryCompute?: boolean;
     }): void;
@@ -369,16 +369,17 @@ export declare class FloorPlanEngine extends FloorPlanCore {
     /**
      * Subscribe to an event
      */
-    on(event: FpeEvent, callback: Function, ctx?: any): this;
+    on<EventType extends FpeEvent, Context>(event: EventType, handler: FpeEventHandler<EventType>, ctx?: Context): this;
     /**
      * Subscribe to an event once
      */
-    once(event: FpeEvent, callback: Function, ctx?: any): this;
+    once<EventType extends FpeEvent, Context>(event: EventType, handler: FpeEventHandler<EventType>, ctx?: Context): this;
     /**
+     * Unsubscribe from an event
      */
-    off(event: FpeEvent, callback?: Function): this;
-    emit(event: FpeEvent, ...args: any[]): this;
-    handleDrop(evt: any): void;
+    off<EventType extends FpeEvent, Context>(event: EventType, handler?: FpeEventHandler<EventType>, ctx?: Context): this;
+    emit<EventType extends FpeEvent>(event: EventType, ...args: FpeEventMap[EventType]): this;
+    handleDrop(evt: DragEvent): void;
     /**
      * Change options after the floor plan engine instance has been created
      * @param args - Startup options
@@ -563,9 +564,55 @@ declare interface FpeConfig extends StartupOptions {
     destroyOnDomRemove?: boolean;
 }
 
-declare type FpeCoreEvent = 'update-settings';
+export declare type FpeCoreEvent = keyof FpeCoreEventMap;
 
-declare type FpeEvent = FpeCoreEvent | 'click' | 'dblclick' | 'context-menu' | 'mousemove' | 'drop' | 'drag-move' | 'drag-start' | 'drag-end' | 'key' | 'keyup';
+declare type FpeCoreEventHandler<EventType extends FpeCoreEvent> = FpeCoreEventMap[EventType] extends any[] ? (...args: FpeCoreEventMap[EventType]) => void : never;
+
+declare type FpeCoreEventMap = {
+    'update-settings': [event: FpeConfig];
+};
+
+export declare type FpeDragEvent = {
+    position: Vector2_2;
+    screenPos: Vector2_2;
+    sourceEvent: FpeInteractionEvent;
+};
+
+export declare type FpeDropEvent = {
+    position: Vector2_2;
+    screenPos: Vector2_2;
+    verticalPos: number;
+    sourceEvent: DragEvent;
+};
+
+export declare type FpeEvent = keyof FpeEventMap;
+
+declare type FpeEventHandler<EventType extends FpeEvent> = FpeEventMap[EventType] extends any[] ? (...args: FpeEventMap[EventType]) => void : never;
+
+export declare type FpeEventMap = FpeCoreEventMap & {
+    click: [event: FpePointerEvent];
+    dblclick: [event: FpePointerEvent];
+    'context-menu': [event: FpePointerEvent];
+    mousemove: [event: FpePointerEvent];
+    drop: [event: FpeDropEvent];
+    'drag-move': [event: FpeDragEvent];
+    'drag-start': [event: FpeDragEvent];
+    'drag-end': [event: FpeDragEvent];
+    key: [event: FpeKeyEvent];
+    keyup: [event: FpeKeyEvent];
+    focus: [event: boolean];
+    'resource-loaded': [event: {
+        resourceId: string;
+    }];
+    'spaces-loaded': [];
+    'loading-status': [event: {
+        totalCount: number;
+        doneCount: number;
+    }];
+    'loading-done': [event: {
+        totalCount: number;
+    }];
+};
 
 declare interface FpeInteraction {
     lastSceneClick: Vector2_2;
@@ -587,6 +634,14 @@ declare interface FpeInteraction {
     preventFocusoutOnAltKeyup: boolean;
 }
 
+export declare type FpeInteractionEvent = InteractionEventType[keyof InteractionEventType];
+
+export declare type FpeKeyEvent = {
+    key: string;
+    lowerCaseKey: string;
+    sourceEvent: KeyboardEvent;
+};
+
 declare class FpeLoader extends TinyEmitter {
     promiseCache: Map<string, Promise<any>>;
     loadStages: {
@@ -602,7 +657,6 @@ declare class FpeLoader extends TinyEmitter {
         texture: Map<string, TextureData>;
     };
     floorPlan: FloorPlanCore;
-    isSceneStructureLoaded: boolean;
     productContourCacheAge: number;
     productDataCacheAge: number;
     initialLoading: boolean;
@@ -621,6 +675,13 @@ declare class FpeLoader extends TinyEmitter {
 
 declare type FpeLoader_2 = FloorPlanCore['loader'];
 
+export declare type FpePointerEvent = {
+    nodeId?: string;
+    position: Vector2_2;
+    isDoubleClick?: boolean;
+    sourceEvent: FpeInteractionEvent;
+};
+
 declare class GeometryBase extends SpaceGraphNodeBase {
     type: SpaceGraphGeometryType;
     position: PositionEntry;
@@ -923,6 +984,10 @@ declare interface InfoWindowState extends InfoWindowArgs {
     floorPlan?: FloorPlanEngine;
 }
 
+declare type InteractionEventType = {
+    dom: MouseEvent;
+};
+
 declare class Layout2dView extends LayoutViewBase {
     type: Layout2dViewType;
     parameters: Layout2dViewParameters;
@@ -2176,6 +2241,7 @@ declare type PolygonCurveType = typeof PolygonCurveTypeValue;
 
 declare const PolygonCurveTypeValue = "curve:polygon";
 
+/** outer ring counter clockwise, inner rings ( holes ) clockwise */
 declare type PolygonWithHoles = Polygon[];
 
 declare interface PolygonWithHolesCurve extends BaseShape {
@@ -3037,7 +3103,7 @@ declare class WebGlView extends TinyEmitter {
     once: (event: ViewEvent, callback: Function, ctx?: any) => this;
     off: (event: ViewEvent, callback?: Function) => this;
     emit: (event: ViewEvent, ...args: any[]) => this;
-    constructor(loader: FpeLoader_2, settings: FpeConfig, fpeId: string);
+    constructor(loader: FpeLoader_2, settings: FpeConfig, parentEl: HTMLElement);
     /**
      * main animation loop
      */