@bimdata/viewer 2.0.0-beta.99 → 2.0.0

package/index.d.ts

@@ -63,7 +63,6 @@ declare namespace BDV {
     offline?: {
       enabled: boolean;
       dataFile: string;
-      fallbackToNetwork?: boolean;
     };
 
     /** @deprecated use `modelIds` instead */
@@ -84,6 +83,7 @@ declare namespace BDV {
         };
     bcfManager?: boolean;
     buildingMaker?: boolean;
+    "drawing-tools"?: boolean;
     dwg?:
       | boolean
       | {
@@ -97,22 +97,21 @@ declare namespace BDV {
           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";
+          storeySelector?: boolean;
+          storeySelectorAutoOpen?: boolean;
         };
     pointCloud?:
       | boolean
@@ -137,17 +136,17 @@ declare namespace BDV {
     structure?:
       | boolean
       | {
-          merge?: boolean;
           export?: boolean;
+          merge?: boolean;
           translateIfcEntities?: boolean;
           customTranslations?: Object;
         };
     "structure-properties"?:
       | boolean
       | {
-          merge?: boolean;
-          export?: boolean;
           editProperties?: boolean;
+          export?: boolean;
+          merge?: boolean;
           translateIfcEntities?: boolean;
           customTranslations?: Object;
         };
@@ -159,9 +158,10 @@ declare namespace BDV {
           compass?: boolean;
           help?: boolean;
           modelLoader?: "hidden" | "disabled";
+          storeySelector?: boolean;
+          storeySelectorAutoOpen?: boolean;
         };
     "viewer2d-background"?: boolean;
-    "viewer2d-drawer"?: boolean;
     "viewer2d-parameters"?: boolean;
     "viewer2d-screenshot"?: boolean;
     viewer3d?:

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@bimdata/viewer",
   "type": "module",
-  "version": "2.0.0-beta.99",
+  "version": "2.0.0",
   "description": "A customizable BIM viewer.",
   "keywords": [
     "bim",
@@ -23,7 +23,8 @@
   "main": "dist/bimdata-viewer.esm.min.js",
   "module": "dist/bimdata-viewer.esm.min.js",
   "scripts": {
-    "build": "vite build && npm exec terser -- -c -m --module dist/bimdata-viewer.js > dist/bimdata-viewer.esm.min.js && rm dist/bimdata-viewer.js",
+    "build": "vite build && esbuild dist/bimdata-viewer.esm.min.js --minify --outfile=dist/bimdata-viewer.esm.min.js --allow-overwrite",
+    "build:split": "vite build -c vite.config.split.js && esbuild dist/bimdata-viewer-split.esm.min.js --minify --outfile=dist/bimdata-viewer-split.esm.min.js --allow-overwrite",
     "cy:run": "cypress run",
     "cy:open": "cypress open",
     "dev": "vite",
@@ -48,62 +49,62 @@
     "index.d.ts"
   ],
   "devDependencies": {
-    "@babel/preset-env": "^7.22.20",
+    "@babel/preset-env": "^7.24.0",
     "@bimdata/2d-engine": "2.4.0",
-    "@bimdata/areas-next": "0.1.13",
-    "@bimdata/bcf-components": "6.2.0",
+    "@bimdata/areas-next": "0.1.15",
+    "@bimdata/bcf-components": "6.2.1",
     "@bimdata/building-maker": "3.0.3",
-    "@bimdata/components": "1.3.1",
-    "@bimdata/design-system": "2.1.0-rc.12",
-    "@bimdata/typescript-fetch-api-client": "9.20.1",
-    "@rollup/plugin-alias": "5.0.0",
-    "@rollup/plugin-babel": "^6.0.3",
-    "@rollup/plugin-commonjs": "^25.0.4",
-    "@rollup/plugin-image": "^3.0.2",
-    "@rollup/plugin-replace": "^5.0.2",
+    "@bimdata/components": "1.3.2",
+    "@bimdata/design-system": "2.1.0-rc.14",
+    "@bimdata/typescript-fetch-api-client": "10.0.0",
+    "@rollup/plugin-alias": "5.1.0",
+    "@rollup/plugin-babel": "^6.0.4",
+    "@rollup/plugin-commonjs": "^25.0.7",
+    "@rollup/plugin-image": "^3.0.3",
+    "@rollup/plugin-replace": "^5.0.5",
     "@semantic-release/changelog": "^6.0.3",
-    "@semantic-release/commit-analyzer": "^11.0.0",
+    "@semantic-release/commit-analyzer": "^11.1.0",
     "@semantic-release/git": "^10.0.1",
-    "@semantic-release/github": "^9.2.1",
-    "@semantic-release/npm": "^11.0.0",
-    "@semantic-release/release-notes-generator": "^12.0.0",
-    "@vitejs/plugin-vue": "4.3.4",
+    "@semantic-release/github": "^9.2.6",
+    "@semantic-release/npm": "^11.0.3",
+    "@semantic-release/release-notes-generator": "^12.1.0",
+    "@vitejs/plugin-vue": "4.6.2",
     "@vue/vue3-jest": "29.2.6",
     "@xeokit/xeokit-sdk": "git+https://git@github.com/Amoki/xeokit-sdk.git#369bb4876e529995cd4c192bc7fda5e957f9634f",
-    "@zip.js/zip.js": "^2.7.32",
-    "async": "^3.2.4",
-    "autoprefixer": "^10.4.16",
+    "@zip.js/zip.js": "^2.7.37",
+    "async": "^3.2.5",
+    "autoprefixer": "^10.4.18",
     "babel-core": "^7.0.0-bridge.0",
     "babel-jest": "^29.7.0",
     "conventional-changelog-eslint": "^5.0.0",
-    "cypress": "13.3.0",
-    "eslint": "^8.50.0",
-    "eslint-config-prettier": "^9.0.0",
+    "cypress": "13.6.6",
+    "esbuild": "^0.20.1",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-cypress": "^2.15.1",
-    "eslint-plugin-jest": "^27.4.2",
-    "eslint-plugin-prettier": "^5.0.0",
-    "eslint-plugin-vue": "^9.17.0",
+    "eslint-plugin-jest": "^27.9.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "eslint-plugin-vue": "^9.22.0",
     "form-data": "^4.0.0",
     "html2canvas": "1.4.1",
     "http-server": "^14.1.1",
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
-    "jest-extended": "^4.0.1",
+    "jest-extended": "^4.0.2",
     "jspdf": "^2.5.1",
     "lodash": "^4.17.21",
     "node-fetch": "^3.3.2",
-    "postcss": "^8.4.31",
-    "prettier": "^3.0.3",
+    "postcss": "^8.4.35",
+    "prettier": "^3.2.5",
     "querystring": "^0.2.0",
-    "sass": "^1.68.0",
-    "semantic-release": "^22.0.5",
-    "sinon": "^16.0.0",
-    "start-server-and-test": "2.0.1",
-    "terser": "^5.20.0",
-    "vite": "4.4.9",
-    "vite-plugin-css-injected-by-js": "3.3.0",
-    "vue": "3.3.4",
-    "vue-eslint-parser": "^9.3.1",
-    "vue-i18n": "^9.5.0"
+    "sass": "^1.71.1",
+    "semantic-release": "^22.0.12",
+    "sinon": "^16.1.3",
+    "start-server-and-test": "2.0.3",
+    "vite": "4.5.2",
+    "vite-plugin-css-injected-by-js": "3.4.0",
+    "vue": "3.4.21",
+    "vue-eslint-parser": "^9.4.2",
+    "vue-i18n": "^9.10.1"
   }
 }

package/types/api.d.ts

@@ -94,6 +94,8 @@ declare namespace BDV {
   }
 
   interface Permissions {
+    hasReadPermission: boolean;
+    hasWritePermission: boolean;
     hasAdminPermission: boolean;
     hasBcfReadPermission: boolean;
     hasBcfWritePermission: boolean;
@@ -101,8 +103,16 @@ declare namespace BDV {
     hasDocWritePermission: boolean;
     hasModelReadPermission: boolean;
     hasModelWritePermission: boolean;
-    hasReadPermission: boolean;
-    hasWritePermission: boolean;
+    tokenScopes: {
+      bcf?: string[];
+      document?: string[];
+      model?: string[];
+    };
+    usableScopes: {
+      bcf?: string[];
+      document?: string[];
+      model?: string[];
+    };
     userRole?: string;
     user?: {
       id: number;
@@ -115,15 +125,5 @@ declare namespace BDV {
       sub: string;
       profile_picture: string;
     };
-    tokenScopes: {
-      bcf?: string[];
-      model?: string[];
-      document?: string[];
-    };
-    usableScopes: {
-      bcf?: string[];
-      model?: string[];
-      document?: string[];
-    };
   }
 }

package/types/state.d.ts

@@ -244,25 +244,20 @@ declare namespace BDV {
     selected: boolean;
   }
 
-  interface StatePlan extends ApiPlan {
-    plan?: ApiPlan;
+  interface StatePlan extends StatePositionning {
     model: StateModel;
     storey: StateStorey;
-    positioning: StatePositionning;
-
-    key: string;
     index: number;
-    loading: boolean;
-    editing: boolean;
-    selected: boolean;
+    key: string;
   }
 
   interface StatePositionning {
-    x: number;
-    y: number;
-    angle: number;
+    translation_x: number;
+    translation_y: number;
+    rotate_z: number;
     scale: number;
     opacity: number;
+    plan?: ApiPlan;
   }
 
   interface StateAnnotation {

package/types/$viewer.d.ts

@@ -1,28 +0,0 @@
-declare namespace BDV {
-  interface $Viewer {
-    cfg: ViewerConfig;
-    i18n: i18n;
-    readonly api: Api;
-    readonly state: State;
-    readonly pluginsCfg: ViewerConfigPlugins;
-    readonly registeredPlugins: string[];
-    readonly registeredWindows: string[];
-
-    readonly globalContext: GlobalContext;
-    readonly localContext: LocalContext;
-    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/events.d.ts

@@ -1,25 +0,0 @@
-type Events = {
-  [eventName: string]: Object;
-};
-
-type SubscriptionId = number;
-
-interface EventOptions {
-  getLastEvent?: boolean;
-}
-
-interface EventHandler<T extends Events> {
-  on<N extends keyof T>(
-    eventName: N,
-    callback: (arg: T[N]) => void,
-    options?: EventOptions
-  ): SubscriptionId;
-  once<N extends keyof T>(
-    eventName: N,
-    callback: (arg: T[N]) => void,
-    options?: EventOptions
-  ): 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,40 +0,0 @@
-declare namespace BDV {
-  interface GlobalContext {
-    hub: EventHandler<GlobalContextEvents & LocalContextEvents>;
-    layout: any;
-    readonly el: HTMLElement;
-    readonly plugins: Map<string, PluginInstance[]>;
-
-    activeLocalContext?: LocalContext;
-    readonly localContexts: LocalContext[];
-    getLocalContexts(window: string): LocalContext[];
-    getViewers(): ModelViewerInstance[];
-
-    // ---
-
-    registerShortcut(shortcut: Shortcut, context: GlobalContext | LocalContext): boolean;
-    unregisterShortcut(name: string, context: GlobalContext | LocalContext): boolean;
-
-    readonly loading: boolean;
-    loadingProcessStart(): void;
-    loadingProcessEnd(): void;
-    setSpinner(spinner: any): void;
-
-    modals: {
-      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 = {
-    "window-open": Window;
-    "window-close": Window;
-  };
-}

package/types/local-context.d.ts

@@ -1,162 +0,0 @@
-declare namespace BDV {
-  interface LocalContext {
-    hub: EventHandler<LocalContextEvents>;
-
-    id: number;
-    readonly el: Element;
-    readonly x: number;
-    readonly y: number;
-    readonly width: number;
-    readonly height: number;
-    resolution: number;
-
-    // Local state
-    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;
-
-    // Plugins
-    readonly plugins: Map<string, PluginInstance>;
-    readonly _plugins: PluginInstance[];
-    setPlugins(names: string[]): void;
-
-    // Shortcuts
-    registerShortcut(shortcut: Shortcut): boolean;
-    unregisterShortcut(name: string): boolean;
-
-    // Loading
-    readonly loading: boolean;
-    loadingProcessStart(): void;
-    loadingProcessEnd(): 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.Instance;
-      /** @deprecated use `model` instead */
-      ifc: StateModel;
-    };
-    "3d-model-unloaded": {
-      model: StateModel;
-      plugin: ViewerIfc3D.Instance;
-      /** @deprecated use `model` instead */
-      ifc: StateModel;
-    };
-    "2d-model-loaded": {
-      model: StateModel;
-      plugin: ViewerIfc2D.Instance;
-      /** @deprecated use `model` instead */
-      ifc: StateModel;
-    };
-    "2d-model-unloaded": {
-      model: StateModel;
-      plugin: ViewerIfc2D.Instance;
-      /** @deprecated use `model` instead */
-      ifc: StateModel;
-    };
-    "dwg-model-loaded": {
-      type: "svg" | "binary";
-      dwg: Document | ArrayBuffer;
-      model: StateModel;
-      plugin: ViewerDwg.Instance;
-    };
-    "dwg-model-unloaded": {
-      model: StateModel;
-      plugin: ViewerDwg.Instance;
-    };
-    "dxf-model-loaded": {
-      type: "svg" | "binary";
-      dxf: Document | ArrayBuffer;
-      model: StateModel;
-      plugin: ViewerDwg.Instance;
-    };
-    "dxf-model-unloaded": {
-      model: StateModel;
-      plugin: ViewerDwg.Instance;
-    };
-    "plan-model-loaded": {
-      model: StateModel;
-      plugin: ViewerPlan.Instance;
-    };
-    "plan-model-unloaded": {
-      model: StateModel;
-      plugin: ViewerPlan.Instance;
-    };
-    "pointcloud-model-loaded": {
-      model: StateModel;
-      plugin: ViewerPointCloud.Instance;
-    };
-    "pointcloud-model-unloaded": {
-      model: StateModel;
-      plugin: ViewerPointCloud.Instance;
-    };
-
-    "pdf-page-changed": {
-      model: StateModel;
-      page: any;
-    };
-  };
-}

package/types/plugins.d.ts

@@ -1,81 +0,0 @@
-declare namespace BDV {
-  interface PluginDefinition {
-    name: string;
-    isViewer?: boolean;
-    i18n?: Object;
-    addToWindows?: string[];
-    component?: any;
-    window?: Window;
-    button?: {
-      position: string;
-      stance?: number;
-      tooltip: string;
-      content: "free" | "simple" | "panel" | "none";
-      keepOpen?: boolean;
-      overlapWith?: string[];
-      icon?: {
-        imgUri?: string;
-        component?: any;
-        options?: { props: Object; };
-      };
-    };
-    startupScript?: ($viewer: $Viewer) => void;
-
-    // Appended properties
-    id?: number;
-    componentInstance?: PluginInstance;
-    shown?: boolean;
-  }
-
-  interface PluginInstance {
-    name: string;
-    plugin: PluginDefinition;
-    $cfg: any;
-    $viewer: $Viewer;
-    $show(): void;
-    $hide(): void;
-    $open?: () => void;
-    onOpen?: () => void;
-    $close?: () => void;
-    onClose?: () => void;
-  }
-
-  interface ModelViewerConfig {
-    modelLoader?: "hidden" | "disabled";
-  }
-
-  interface ModelViewerInstance extends PluginInstance {
-    viewer?: any;
-    modelTypes?: string[];
-    annotationMode: boolean;
-
-    getLoadedModels: () => StateModel[];
-    loadModels: (models: StateModel[]) => Promise<void>;
-    unloadModels: (models: StateModel[]) => Promise<void>;
-    getViewpoint: (options?: any) => any | Promise<any>;
-    setViewpoint: (viewpoint: any, options?: any) => void | Promise<void>;
-    startAnnotationMode: (callback: AnnotationCallback) => void;
-    stopAnnotationMode: () => void;
-    fitView: (options?: any) => void;
-    showUI: (options?: any) => void;
-    hideUI: (options?: { exceptions: string[] }) => Promise<void>;
-  }
-
-  interface PluginManager {
-    cfg: ViewerConfigPlugins;
-    readonly registeredPlugins: Map<string, PluginDefinition>;
-    readonly pluginsUnits: PluginsUnit[];
-
-    getPluginCopy(name: string, silent?: boolean): PluginDefinition;
-    registerPlugin(plugin: PluginDefinition): void;
-    registerPluginsTranslations(i18nPlugin: any): void;
-    runPluginsScripts($viewer: $Viewer): void;
-  }
-
-  interface PluginsUnit {
-    localContext: LocalContext;
-  }
-
-  type AnnotationCallback = (params: AnnotationParams) => void;
-  type AnnotationParams = { x: number, y: number, z: number, models: StateModel[], storey?: StateStorey, page?: number };
-}

package/types/windows.d.ts

@@ -1,17 +0,0 @@
-declare namespace BDV {
-  interface Window {
-    name: string;
-    label: string;
-    icon: { imgUri: string; };
-    plugins?: string[];
-    menu?: boolean;
-    modelTypes?: string[];
-    multiModel: boolean;
-  }
-
-  interface WindowManager {
-    registeredWindows: Map<string, Window>;
-    registerWindow(window: Window): Window;
-    unregisterWindow(name: string): void;
-  }
-}