@bimdata/viewer 2.7.0-beta.4 → 2.7.0-beta.6

package/index.d.ts

@@ -1,18 +1,22 @@
 /// <reference types="./types/api"/>
 /// <reference types="./types/models"/>
+/// <reference types="./types/plugins"/>
 /// <reference types="./types/state"/>
+/// <reference types="./types/window"/>
 
 declare module "@bimdata/viewer" {
+  /** See: https://developers.bimdata.io/viewer/reference/makeBIMDataViewer.html */
   export default function makeBIMDataViewer(cfg: BDV.ViewerConfig): BDV.Viewer;
 }
 
 declare namespace BDV {
   interface Viewer {
+    /** See: https://developers.bimdata.io/viewer/reference/mount.html#mount */
     mount(container: HTMLElement | string, layout?: any): any;
     destroy(): void;
     setAccessToken(token: string): void;
     setLocale(lang: ViewerLocale): void;
-    registerPlugin(plugin: PluginDefinition, cfg?: Object): void;
+    registerPlugin(plugin: PluginDefinition): void;
     registerWindow(window: Object): void;
     unregisterWindow(name: string): void;
     loadModels(modelIds: number[]): Promise<StateModel[]>;
@@ -60,6 +64,7 @@ declare namespace BDV {
       colorHighLighter?: string;
       colorHighDark?: string;
       colorText?: string;
+      headerHeight?: string;
     };
     version?: boolean;
   }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@bimdata/viewer",
   "type": "module",
-  "version": "2.7.0-beta.4",
+  "version": "2.7.0-beta.6",
   "description": "A customizable BIM viewer.",
   "keywords": [
     "bim",
@@ -84,7 +84,7 @@
     "babel-jest": "^29.7.0",
     "conventional-changelog-eslint": "^6.0.0",
     "cypress": "^13.16.0",
-    "esbuild": "^0.24.0",
+    "esbuild": "^0.25.0",
     "eslint": "9.15.0",
     "eslint-config-prettier": "9.1.0",
     "eslint-plugin-cypress": "4.1.0",

package/types/api.d.ts

@@ -17,13 +17,6 @@ declare namespace BDV {
     createStoreyPlan(modelId: number, storeyUuid: string, docId: number): Promise<ApiPlan>;
     deleteStoreyPlan(modelId: number, storeyUuid: string, planId: number): Promise<void>;
     updatePlanPositioning(modelId: number, storeyUuid: string, planId: number, positioning: ApiPositionning): Promise<ApiPositionning>;
-
-    // ---
-
-    /** @deprecated use `getModel` instead */
-    getIfc(modelId: number): Promise<ApiModel>;
-    /** @deprecated use `getModelStructure` instead */
-    getIfcStructure(model: ApiModel): Promise<any>;
   }
 
   interface ApiDocument {
@@ -50,7 +43,8 @@ declare namespace BDV {
     // Model files
     preview_file?: string;
     structure_file?: string;
-    xkt_file?: string; // Deprecated: use `xkt_files` instead
+    /** @deprecated use `xkt_files` instead */
+    xkt_file?: string;
     xkt_files?: { version: number; file: string }[];
     gltf_file?: string;
     map_file?: string;
@@ -62,8 +56,9 @@ declare namespace BDV {
     recommanded_2d_angle?: number;
     size_ratio?: number;
 
-    // Multi-page PDF
+    // Multi-page PDF / Multi layout DWG
     page_number?: number;
+    layout_name?: string;
     parent_id?: number;
     children?: ApiModel[];
   }

package/types/plugins.d.ts

@@ -0,0 +1,47 @@
+declare namespace BDV {
+  interface PluginDefinition {
+    name: string;
+    isViewer?: boolean;
+    /** Plugin settings */
+    settings?: any;
+    /** See: https://developers.bimdata.io/viewer/reference/plugin.html#i18n */
+    i18n?: any;
+    i18nTokenPrefix?: string;
+    addToWindows?: string[];
+
+    /** Vue 3 component */
+    component?: Object;
+
+    /** See: https://developers.bimdata.io/viewer/reference/plugin.html#startupscript */
+    startupScript?: ($viewer: any) => void;
+
+    /** Window plugin definition (see: https://developers.bimdata.io/viewer/reference/window.html#window-api) */
+    window?: Window;
+
+    /** Button plugin definition (see: https://developers.bimdata.io/viewer/reference/plugin.html#plugin-as-button) */
+    button?: {
+      position: string;
+      content: string;
+      icon?: { imgUri: string; };
+      iconOpen?: { imgUri: string; };
+      tooltip?: string;
+      keepOpen?: boolean;
+    };
+  }
+
+  interface PluginInstance extends PluginDefinition {
+    /** Vue component instance */
+    componentInstance: Object | null;
+
+    shown: boolean;
+    show(): void;
+    hide(): void;
+
+    // Button plugin instance
+    loading: boolean;
+    buttonText: string;
+    isOpen: boolean;
+    open(options?: any): Promise<void>;
+    close(options?: any): Promise<void>;
+  }
+}

package/types/state.d.ts

@@ -92,19 +92,6 @@ declare namespace BDV {
     addAnnotation(annotation: StateAnnotation, options?: any): StateAnnotation;
     removeAnnotation(annotation: StateAnnotation, options?: any): boolean;
     clearAnnotations(): void;
-
-    // ---
-
-    /** @deprecated use `models` instead */
-    readonly ifcs: StateModel[];
-    /** @deprecated use `modelsMap` instead */
-    readonly ifcsMap: Map<number, StateModel>;
-    /** @deprecated use `loadModels` instead */
-    loadIfcs(ifcIds: string[]): Promise<StateModel[]>;
-    /** @deprecated use `unloadModels` instead */
-    unloadIfcs(ifcIds: string[]): void;
-    /** @deprecated use `getModel` instead */
-    getIfc(id: number): StateModel;
   }
 
   type StateEvents = {
@@ -180,17 +167,6 @@ declare namespace BDV {
       annotation: StateAnnotation;
       options?: any;
     };
-
-    // ---
-
-    /** @deprecated use `models-loaded` instead */
-    "ifcs-loaded": {
-      ifcs: StateModel[];
-    };
-    /** @deprecated use `models-unloaded` instead */
-    "ifcs-unloaded": {
-      ifcs: StateModel[];
-    };
   };
 
   interface StateModel extends ApiModel {
@@ -220,12 +196,7 @@ declare namespace BDV {
     readonly storey: StateObject;
     readonly layout: StateObject;
     readonly space: StateObject;
-    getFirstAncestorWithType: (type: string) => StateObject;
-
-    // ---
-
-    /** @deprecated use `model` instead */
-    ifc: StateModel;
+    getFirstAncestorWithType(type: string): StateObject;
   }
 
   interface StateStorey {
@@ -261,10 +232,34 @@ declare namespace BDV {
   }
 
   interface StateAnnotation {
+    id: number;
+    draggable: boolean;
     x: number;
     y: number;
     z: number;
     component: any;
     props?: any;
   }
+
+  // ---
+
+  type Events = {
+    [eventName: string]: Object;
+  };
+
+  interface EventHandler<T extends Events> {
+    on<N extends keyof T>(
+      eventName: N,
+      callback: (arg: T[N]) => void,
+      options?: any
+    ): number;
+    once<N extends keyof T>(
+      eventName: N,
+      callback: (arg: T[N]) => void,
+      options?: any
+    ): number;
+    off(subscriptionId: number): void;
+    emit<N extends keyof T>(eventName: N, payload: T[N]): void;
+    clear(): void;
+  }
 }

package/types/window.d.ts

@@ -0,0 +1,16 @@
+declare namespace BDV {
+  interface Window {
+    name: string;
+    label: string;
+    icon: { imgUri: string; };
+    plugins?: string[];
+    modelTypes?: string[];
+    multiModel?: boolean;
+    noModel?: boolean;
+    defaultWindow?: boolean;
+    displayedInWindowSelector?: boolean;
+
+    header?: boolean;
+    logoAndVersion?: boolean;
+  }
+}