@bimdata/viewer 2.0.0-beta.74 → 2.0.0-beta.76

package/index.d.ts

@@ -5,18 +5,19 @@ declare module "@bimdata/viewer" {
 declare namespace BDV {
   interface Viewer {
     mount(container: HTMLElement | string, layout?: any): any;
+    destroy(): void;
     setAccessToken(token: string): void;
-    setLocale(lang: ViewerLocales): void;
-    registerPlugin(plugin: PluginConfig, cfg?: Object): void;
+    setLocale(lang: ViewerLocale): void;
+    registerPlugin(plugin: PluginDefinition, cfg?: Object): void;
     registerWindow(window: Object): void;
     unregisterWindow(name: string): void;
-    loadModels(modelIds: number[]): StateModel[];
+    loadModels(modelIds: number[]): Promise<StateModel[]>;
 
     /** @deprecated use `loadModels` instead */
-    loadIfcs(ifcIds: number[]): StateModel[];
+    loadIfcs(ifcIds: number[]): Promise<StateModel[]>;
   }
 
-  enum ViewerLocales {
+  enum ViewerLocale {
     "de",
     "en",
     "es",
@@ -28,7 +29,7 @@ declare namespace BDV {
     ui?: ViewerConfigUI;
     api: ViewerConfigApi;
     plugins?: ViewerConfigPlugins;
-    locale?: ViewerLocales;
+    locale?: ViewerLocale;
   }
 
   interface ViewerConfigUI {
@@ -57,23 +58,77 @@ declare namespace BDV {
   }
 
   interface ViewerConfigPlugins {
-    // Conf
-    addPlugins?: boolean;
-    windowSelector?: boolean;
+    // --- General config ---
+    windowSelector?: boolean; // Enable/Disable window selector
 
-    // IFC 3D Viewer
-    viewer3d?:
+    // --- Native plugins config ---
+
+    alerts?: boolean;
+    bcf?:
       | boolean
       | {
-          edges?: boolean;
-          enableOffsets: boolean;
+          topicGuid?: string;
+        };
+    bcfManager?: boolean;
+    buildingMaker?: boolean;
+    dwg?:
+      | boolean
+      | {
+          help?: boolean;
+          modelLoader?: "hidden" | "disabled";
+        };
+    "dwg-layer"?: boolean;
+    dxf?:
+      | boolean
+      | {
+          help?: boolean;
+          modelLoader?: "hidden" | "disabled";
+        };
+    equipment2d?: boolean;
+    fullscreen?: boolean;
+    gauge2d?: boolean;
+    ged?: boolean;
+    header?: boolean;
+    measure2d?: boolean;
+    measure3d?: boolean;
+    navigationVersionsModel?: boolean;
+    pdf?: boolean;
+    pdfAnnotations?: boolean;
+    pdfExport?: boolean;
+    plan?:
+      | boolean
+      | {
+          help?: boolean;
+          modelLoader?: "hidden" | "disabled";
+        };
+    pointCloud?:
+      | boolean
+      | {
+          help?: boolean;
+          modelLoader?: "hidden" | "disabled";
           navCube?: boolean;
           pivotMarker?: boolean;
         };
+    pointCloudParameters?: boolean;
     projection?: boolean;
+    properties?:
+      | boolean
+      | {
+          editProperties?: boolean;
+        };
+    "right-angled"?: boolean;
     search?: boolean;
     section?: boolean;
+    smartview?: boolean;
     split?: boolean;
+    structure?:
+      | boolean
+      | {
+          merge?: boolean;
+          export?: boolean;
+          translateIfcEntities?: boolean;
+          customTranslations?: Object;
+        };
     "structure-properties"?:
       | boolean
       | {
@@ -83,63 +138,32 @@ declare namespace BDV {
         translateIfcEntities?: boolean;
         customTranslations?: Object;
       };
-    "viewer3d-parameters"?: boolean;
-
-    // IFC 2D Viewer
-    viewer2d?: boolean;
-    equipment2d?: boolean;
-    gauge2d?: boolean;
     switch?: boolean;
+    synchronization?: boolean;
+    viewer2d?: 
+      | boolean
+      | {
+          help?: boolean;
+          modelLoader?: "hidden" | "disabled";
+        };
     "viewer2d-background"?: boolean;
     "viewer2d-drawer"?: boolean;
     "viewer2d-parameters"?: boolean;
     "viewer2d-screenshot"?: boolean;
-
-    // DWG / DXF Viewers
-    dwg?: boolean;
-    dxf?: boolean;
-    "dwg-layer"?: boolean;
-
-    // Plan / Meta-Building Viewer
-    plan?: boolean;
-    synchronization?: boolean;
-
-    // Point Cloud Viewer
-    pointCloud?:
+    viewer3d?:
       | boolean
       | {
+          edges?: boolean;
+          enableDynamicLOD?: boolean;
+          enableOffsets: boolean;
+          home?: boolean;
+          help?: boolean;
+          modelLoader?: "hidden" | "disabled";
           navCube?: boolean;
+          navigationVersionsModel?: boolean;
+          pivotMarker?: boolean;
         };
-
-    // BCF
-    bcf?:
-      | boolean
-      | {
-          topicGuid?: string;
-        };
-    bcfManager?: boolean;
-
-    // Misc
-    alerts?: boolean;
-    buildingMaker?: boolean;
-    fullscreen?: boolean;
-    ged?: boolean;
-    header?: boolean;
-    pdf?: boolean;
-    properties?:
-      | boolean
-      | {
-          editProperties?: boolean;
-        };
-    "storey-selector"?: boolean;
-    structure?:
-      | boolean
-      | {
-          merge?: boolean;
-          export?: boolean;
-          translateIfcEntities?: boolean;
-          customTranslations?: Object;
-        };
+    "viewer3d-parameters"?: boolean;
     "window-split"?: boolean;
   }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@bimdata/viewer",
   "type": "module",
-  "version": "2.0.0-beta.74",
+  "version": "2.0.0-beta.76",
   "description": "A customizable BIM viewer.",
   "keywords": [
     "bim",

package/types/$viewer.d.ts

@@ -1,17 +1,28 @@
 declare namespace BDV {
   interface $Viewer {
     cfg: ViewerConfig;
-    i18n: any;
+    i18n: i18n;
     readonly api: Api;
     readonly state: State;
+    readonly pluginsCfg: ViewerConfigPlugins;
+    readonly registeredPlugins: string[];
+    readonly registeredWindows: string[];
 
-    readonly pluginManager: PluginManager;
-    readonly shortcutManager: ShortcutManager;
     readonly globalContext: GlobalContext;
     readonly localContext: LocalContext;
-    getLocalContexts(window: string): LocalContext[];
-
-    currentContext: any;
     contextMenu: ContextMenu;
+
+    readonly shortcutManager: ShortcutManager;
+
+    // ---
+
+    readonly _pluginManager: PluginManager;
+    readonly _windowManager: WindowManager;
+  }
+
+  interface i18n {
+    i18nVuePlugin: any;
+    registerTranslations(messages: Object): void;
+    changeLocale(locale: ViewerLocale): void;
   }
 }

package/types/api.d.ts

@@ -1,17 +1,22 @@
 declare namespace BDV {
   interface Api {
-    readonly permissions: Permissions;
     readonly apiClient: any;
     readonly apiUrl: string;
     readonly archiveUrl: string;
     readonly cloudId: number;
     readonly projectId: number;
+    readonly permissions: Permissions;
     accessToken: string;
 
     getModel(modelId: number): Promise<ApiModel>;
     getModelStructure(model: ApiModel): Promise<any>;
     getRawElements(modelId: number): Promise<any>;
     getStoreys(modelId: number): Promise<ApiStorey[]>;
+    createModel(docId: number): Promise<ApiModel>;
+    waitForModelProcess(model: ApiModel): Promise<ApiModel>;
+    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>;
 
     // ---
 
@@ -38,12 +43,17 @@ declare namespace BDV {
     source: ModelSource;
     status: ModelStatus;
     archived: boolean;
-    document: ApiDocument;
+    document?: ApiDocument;
     project_id: number;
     structure_file?: string;
     xkt_file?: string;
     gltf_file?: string;
     map_file?: string;
+
+    // Multi-page PDF
+    page_number?: number;
+    parent_id?: number;
+    children?: ApiModel[];
   }
 
   type ApiPlan = ApiModel;
@@ -54,12 +64,7 @@ declare namespace BDV {
     longname: string;
     type: string;
     object_type: string;
-    model: StateModel;
-    parent: StateObject;
     children: ApiObject[];
-
-    /** @deprecated use `model` instead */
-    ifc: StateModel;
   }
 
   interface ApiStorey {

package/types/events.d.ts

@@ -2,6 +2,8 @@ type Events = {
   [eventName: string]: Object;
 };
 
+type SubscriptionId = number;
+
 interface EventOptions {
   getLastEvent?: boolean;
 }
@@ -11,13 +13,13 @@ interface EventHandler<T extends Events> {
     eventName: N,
     callback: (arg: T[N]) => void,
     options?: EventOptions
-  ): number;
+  ): SubscriptionId;
   once<N extends keyof T>(
     eventName: N,
     callback: (arg: T[N]) => void,
     options?: EventOptions
-  ): number;
-  off(subscriptionId: number): void;
+  ): SubscriptionId;
+  off(subId: SubscriptionId): void;
   emit<N extends keyof T>(eventName: N, payload: T[N]): void;
   clear(): void;
 }

package/types/global-context.d.ts

@@ -1,42 +1,39 @@
 declare namespace BDV {
   interface GlobalContext {
-    hub: EventHandler<LocalContextEvents & GlobalContextEvents>;
+    hub: EventHandler<GlobalContextEvents & LocalContextEvents>;
+    layout: any;
+    readonly el: HTMLElement;
+    readonly plugins: Map<string, PluginInstance[]>;
 
-    areas: any;
-    areasSettingsDisplayed: boolean;
-    areasSwapEnabled: boolean;
-    areasSettingsFullOption: boolean;
-    bcfManagerDisplayed: boolean;
-    mouseover: boolean;
-
-    /** @deprecated */
-    getPlugins(name: string): Plugin[];
-    plugins: Map<string, Plugin>;
+    activeLocalContext?: LocalContext;
+    readonly localContexts: LocalContext[];
+    getLocalContexts(window: string): LocalContext[];
+    getViewers(): ModelViewerInstance[];
 
     // ---
 
-    loading: boolean;
+    registerShortcut(shortcut: Shortcut, context: GlobalContext | LocalContext): boolean;
+    unregisterShortcut(name: string, context: GlobalContext | LocalContext): boolean;
+
+    readonly loading: boolean;
     loadingProcessStart(): void;
     loadingProcessEnd(): void;
-
-    registerShortcut(shortcut: Shortcut, context: GlobalContext): boolean;
-    unregisterShortcut(name: string, context: GlobalContext): boolean;
+    setSpinner(spinner: any): void;
 
     modals: {
-      pushModal(component: Object, options?: { args: Object }): void;
+      pushModal(component: any, props?: any, options?: any): void;
       clearModal(): void;
     };
+
+    // ---
+
+    bcfManagerDisplayed: boolean; // TODO: should be moved elsewhere
+
+    /** @deprecated use `plugins` Map instead */
+    getPlugins(name: string): PluginInstance[];
   }
 
   type GlobalContextEvents = {
-    "plan-model-loaded": {
-      model: ApiModel;
-      plugin: ViewerDwg.Plugin;
-    };
-    "plan-model-unloaded": {
-      model: ApiModel;
-      plugin: ViewerDwg.Plugin;
-    };
     "window-open": Window;
     "window-close": Window;
   };

package/types/local-context.d.ts

@@ -3,106 +3,160 @@ declare namespace BDV {
     hub: EventHandler<LocalContextEvents>;
 
     id: number;
-    el: Element;
-    width: number;
-    height: number;
+    readonly el: Element;
+    readonly x: number;
+    readonly y: number;
+    readonly width: number;
+    readonly height: number;
     resolution: number;
 
     // Local state
-    loadedModels: StateModel[];
-    loadedModelIds: number[];
-    loadingModelIds: number[];
-    modelTypes: string[];
-    multiModel: boolean;
+    readonly multiModel: boolean;
+    readonly modelTypes?: string[];
+    readonly loadedModels: StateModel[];
+    readonly loadedModelIds: number[];
+    readonly loadingModelIds: number[];
+    readonly currentStorey: StateStorey | null;
     loadModels(ids: number[]): Promise<boolean>;
     unloadModels(ids: number[]): boolean;
     toggleModel(id: number): Promise<boolean>;
+    selectStorey(storey: StateStorey): void;
+    showPlan(plan: StatePlan): void;
+    hidePlan(plan: StatePlan): void;
+    togglePlanVisibility(plan: StatePlan): void;
+    togglePlanEdition(plan: StatePlan): void;
+    createPlan(model: StateModel, storey: StateStorey, document: ApiDocument, positioning: StatePositionning): Promise<StatePlan>;
+    updatePlan(plan: StatePlan, positioning: StatePositionning): Promise<StatePlan>;
+    deletePlan(plan: StatePlan): Promise<void>;
+
+    // Viewer
+    readonly viewer: ModelViewerInstance | null;
+    readonly annotationMode: boolean;
+    getViewpoint: (options?: any) => any | Promise<any>;
+    setViewpoint: (viewpoint: any, options?: any) => void | Promise<void>;
+    startAnnotationMode: (callback: Function) => void;
+    stopAnnotationMode: () => void;
+    fitView: (options?: any) => void;
+    showUI: (options?: any) => void;
+    hideUI: (options?: { exceptions: string[] }) => Promise<void>;
 
     // Window
+    readonly window: Window;
     loadWindow(windowName: string): void;
-    window: Window;
 
-    // Plugin
-    /** @deprecated */
-    getPlugin(name: string): Plugin;
-    plugins: Map<string, Plugin>;
+    // Plugins
+    readonly plugins: Map<string, PluginInstance>;
+    readonly _plugins: PluginInstance[];
+    setPlugins(names: string[]): void;
+
+    // Shortcuts
+    registerShortcut(shortcut: Shortcut): boolean;
+    unregisterShortcut(name: string): boolean;
 
-    loading: boolean;
+    // Loading
+    readonly loading: boolean;
     loadingProcessStart(): void;
     loadingProcessEnd(): void;
 
-    registerShortcut(shortcut: Shortcut, context: LocalContext): boolean;
-    unregisterShortcut(name: string, context: LocalContext): boolean;
-
-    modals: {
-      pushModal(component: Object, options?: { args: Object }): void;
+    // Modals
+    readonly modals: {
+      pushModal(component: Object, props?: Object, options?: Object): void;
       clearModal(): void;
     };
+
+    // ---
+
+    /** @deprecated use `plugins` Map instead */
+    getPlugin(name: string): PluginInstance;
+    /** @deprecated use `loadingProcessStart` instead */
+    incrementSpinnerProcesses(): void;
+    /** @deprecated use `loadingProcessEnd` instead */
+    decrementSpinnerProcesses(): void;
   }
 
   type LocalContextEvents = {
+    "alert": { type: string; message: string };
+    "context-resize": { width: number; height: number };
+    "plugin-created": { name: string; plugin: PluginInstance; };
+    "plugin-destroyed": { name: string; plugin: PluginInstance; };
+    "plugin-menu-open": { name: string; plugin: PluginInstance; };
+    "plugin-menu-close": { name: string; plugin: PluginInstance; };
+
     "models-loaded": { models: StateModel[] };
     "models-unloaded": { models: StateModel[] };
     "models-loading": { ids: number[] };
+    "storey-selected": { storey: StateStorey };
+    "plan-shown": { plan: StatePlan };
+    "plan-hidden": { plan: StatePlan };
+    "plan-editing": { plan: StatePlan | null };
+    "plan-created": { plan: StatePlan };
+    "plan-updated": { plan: StatePlan };
+    "plan-deleted": { plan: StatePlan };
+
     "3d-model-loaded": {
       model: StateModel;
-      plugin: ViewerIfc3D.Plugin;
+      plugin: ViewerIfc3D.Instance;
       /** @deprecated use `model` instead */
       ifc: StateModel;
     };
     "3d-model-unloaded": {
       model: StateModel;
-      plugin: ViewerIfc3D.Plugin;
+      plugin: ViewerIfc3D.Instance;
       /** @deprecated use `model` instead */
       ifc: StateModel;
     };
     "2d-model-loaded": {
       model: StateModel;
-      plugin: ViewerIfc2D.Plugin;
+      plugin: ViewerIfc2D.Instance;
       /** @deprecated use `model` instead */
       ifc: StateModel;
     };
     "2d-model-unloaded": {
       model: StateModel;
-      plugin: ViewerIfc2D.Plugin;
+      plugin: ViewerIfc2D.Instance;
       /** @deprecated use `model` instead */
       ifc: StateModel;
     };
     "dwg-model-loaded": {
-      dwg: Document;
+      type: "svg" | "binary";
+      dwg: Document | ArrayBuffer;
       model: StateModel;
-      plugin: ViewerDwg.Plugin;
+      plugin: ViewerDwg.Instance;
     };
     "dwg-model-unloaded": {
-      plugin: ViewerDwg.Plugin;
+      model: StateModel;
+      plugin: ViewerDwg.Instance;
     };
     "dxf-model-loaded": {
-      dxf: Document;
+      type: "svg" | "binary";
+      dxf: Document | ArrayBuffer;
       model: StateModel;
-      plugin: ViewerDwg.Plugin;
+      plugin: ViewerDwg.Instance;
     };
     "dxf-model-unloaded": {
-      plugin: ViewerDwg.Plugin;
+      model: StateModel;
+      plugin: ViewerDwg.Instance;
     };
     "plan-model-loaded": {
-      model: ApiModel;
-      plugin: ViewerDwg.Plugin;
+      model: StateModel;
+      plugin: ViewerPlan.Instance;
     };
     "plan-model-unloaded": {
-      model: ApiModel;
-      plugin: ViewerDwg.Plugin;
+      model: StateModel;
+      plugin: ViewerPlan.Instance;
     };
-    "plugin-created": {
-      pluginName: string;
-      plugin: Plugin;
+    "pointcloud-model-loaded": {
+      model: StateModel;
+      plugin: ViewerPointCloud.Instance;
     };
-    "plugin-destroyed": {
-      pluginName: string;
-      plugin: Plugin;
+    "pointcloud-model-unloaded": {
+      model: StateModel;
+      plugin: ViewerPointCloud.Instance;
+    };
+
+    "pdf-page-changed": {
+      model: StateModel;
+      page: any;
     };
-    "plugin-menu-open": Plugin;
-    "plugin-menu-close": Plugin;
-    "context-resize": { width: number; height: number };
-    alert: { type: string; message: string };
   };
 }