@inweb/client 25.3.9 → 25.3.11

package/lib/Api/Client.d.ts

@@ -1,7 +1,5 @@
 import { EventEmitter2 } from "../Viewer/EventEmitter2";
 import { ClientEventMap } from "./ClientEvents";
-import { Options } from "../Viewer/Options";
-import { OptionsEventMap } from "../Viewer/OptionsEvents";
 import { Assembly } from "./Assembly";
 import { File } from "./File";
 import { Job } from "./Job";
@@ -12,8 +10,7 @@ import { User } from "./User";
  * Server](https://cloud.opendesign.com/docs/index.html#/opencloud_server) resources like
  * Projects, Files, Issues etc.
  */
-export declare class Client extends EventEmitter2<ClientEventMap & OptionsEventMap> {
-    private _options;
+export declare class Client extends EventEmitter2<ClientEventMap> {
     private _serverUrl;
     private _httpClient;
     private _user;
@@ -33,10 +30,10 @@ export declare class Client extends EventEmitter2<ClientEventMap & OptionsEventM
      */
     get serverUrl(): string;
     /**
-     * `VisualizeJS` parameters. Changes to these parameters are automatically applied to
-     * `Viewer` instances associated with that client.
+     * Deprecated since `25.3`. Use [Viewer.options]{@link Viewer#options} instead to change
+     * Viewer parameters.
      */
-    get options(): Options;
+    get options(): any;
     /**
      * Change the client configuration parameters.
      *
@@ -223,7 +220,7 @@ export declare class Client extends EventEmitter2<ClientEventMap & OptionsEventM
      * @param params - An object containing upload parameters.
      * @param params.geometry=true - Create job to extract file geometry data. Can be:
      *
-     *   - `true` - Extract file geometry data into type, defined by [options]{@link Client#options}.
+     *   - `true` - Extract file geometry data into `VSFX` to open the file in `VisualizeJS` viewer.
      *   - `vsfx` - Extract file geometry data into `VSFX` to open the file in `VisualizeJS` viewer.
      *   - `gltf` - Extract file geometry data into `glTF` to open the file in `Three.js` viewer.
      *

package/lib/Viewer/Viewer.d.ts

@@ -25,7 +25,6 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & OptionsEventM
     protected _options: Options;
     protected _visualizeJsUrl: string;
     protected _abortControllerForReferences: AbortController | undefined;
-    private clientoptionschange;
     private canvaseventlistener;
     draggerFactory: Map<string, typeof OdBaseDragger>;
     canvasEvents: string[];
@@ -58,11 +57,6 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & OptionsEventM
     });
     /**
      * `VisualizeJS` parameters.
-     *
-     * Use this only for standalone viewer instances. Use {@link Client#options | Client.options}
-     * instead if the viewer was created with a `Client` reference using
-     * {@link Viewer | Viewer.create(client)}. Changes in client options will be automatically
-     * applied to the viewer options.
      */
     get options(): Options;
     /**

package/lib/index.d.ts

@@ -16,6 +16,7 @@ export { Project } from "./Api/Project";
 export { Role } from "./Api/Role";
 export { User } from "./Api/User";
 export { Viewer, Viewer as VisualizejsViewer } from "./Viewer/Viewer";
+export { parseArgs, userFullName, userInitials, waitFor } from "./Api/impl/Utils";
 export * from "./Api/ClientEvents";
 export * from "./Viewer/Markup/IViewpoint";
 export * from "./Viewer/OptionsEvents";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inweb/client",
-  "version": "25.3.9",
+  "version": "25.3.11",
   "description": "Client.js is a library for implementing BIM Project management applications.",
   "homepage": "https://cloud.opendesign.com/docs/index.html",
   "license": "SEE LICENSE IN LICENSE",

package/src/Api/Client.ts

@@ -25,8 +25,6 @@ import { EventEmitter2 } from "../Viewer/EventEmitter2";
 import { IHttpClient } from "./IHttpClient";
 import { HttpClient } from "./HttpClient";
 import { ClientEventMap } from "./ClientEvents";
-import { Options } from "../Viewer/Options";
-import { OptionsEventMap } from "../Viewer/OptionsEvents";
 import { Assembly } from "./Assembly";
 import { File } from "./File";
 import { Job } from "./Job";
@@ -39,8 +37,7 @@ import { downloadProgress, json, text, parseArgs } from "./impl/Utils";
  * Server](https://cloud.opendesign.com/docs/index.html#/opencloud_server) resources like
  * Projects, Files, Issues etc.
  */
-export class Client extends EventEmitter2<ClientEventMap & OptionsEventMap> {
-  private _options: Options;
+export class Client extends EventEmitter2<ClientEventMap> {
   private _serverUrl: string;
 
   private _httpClient: IHttpClient;
@@ -56,7 +53,6 @@ export class Client extends EventEmitter2<ClientEventMap & OptionsEventMap> {
     super();
     this.configure(params);
     this.eventEmitter = this;
-    this._options = new Options(this);
     this._user = null;
   }
 
@@ -70,11 +66,47 @@ export class Client extends EventEmitter2<ClientEventMap & OptionsEventMap> {
   }
 
   /**
-   * `VisualizeJS` parameters. Changes to these parameters are automatically applied to
-   * `Viewer` instances associated with that client.
-   */
-  get options(): Options {
-    return this._options;
+   * Deprecated since `25.3`. Use [Viewer.options]{@link Viewer#options} instead to change
+   * Viewer parameters.
+   */
+  get options(): any {
+    console.warn(
+      "Client.options has been deprecated since 25.3 and will be removed in a future release, use Viewer.options instead."
+    );
+    const data = {
+      showWCS: true,
+      cameraAnimation: true,
+      antialiasing: true,
+      groundShadow: false,
+      shadows: false,
+      cameraAxisXSpeed: 4,
+      cameraAxisYSpeed: 1,
+      ambientOcclusion: false,
+      enableStreamingMode: true,
+      enablePartialMode: false,
+      memoryLimit: 3294967296,
+      cuttingPlaneFillColor: { red: 0xff, green: 0x98, blue: 0x00 },
+      edgesColor: { r: 0xff, g: 0x98, b: 0x00 },
+      facesColor: { r: 0xff, g: 0x98, b: 0x00 },
+      edgesVisibility: true,
+      edgesOverlap: true,
+      facesOverlap: false,
+      facesTransparancy: 200,
+      enableCustomHighlight: true,
+      sceneGraph: false,
+      edgeModel: true,
+      reverseZoomWheel: false,
+      enableZoomWheel: true,
+      enableGestures: true,
+    };
+    return {
+      ...data,
+      data,
+      defaults: () => data,
+      resetToDefaults: () => {},
+      saveToStorage: () => {},
+      loadFromStorage: () => {},
+    };
   }
 
   /**
@@ -402,7 +434,7 @@ export class Client extends EventEmitter2<ClientEventMap & OptionsEventMap> {
    * @param params - An object containing upload parameters.
    * @param params.geometry=true - Create job to extract file geometry data. Can be:
    *
-   *   - `true` - Extract file geometry data into type, defined by [options]{@link Client#options}.
+   *   - `true` - Extract file geometry data into `VSFX` to open the file in `VisualizeJS` viewer.
    *   - `vsfx` - Extract file geometry data into `VSFX` to open the file in `VisualizeJS` viewer.
    *   - `gltf` - Extract file geometry data into `glTF` to open the file in `Three.js` viewer.
    *
@@ -441,7 +473,7 @@ export class Client extends EventEmitter2<ClientEventMap & OptionsEventMap> {
       .then((xhr: XMLHttpRequest) => JSON.parse(xhr.responseText))
       .then((data) => new File(data, this._httpClient));
 
-    const geometryType = typeof params.geometry === "string" ? params.geometry : this.options.geometryType;
+    const geometryType = typeof params.geometry === "string" ? params.geometry : "vsfx";
 
     const jobs: string[] = [];
     if (params.geometry) jobs.push((await result.extractGeometry(geometryType)).outputFormat);

package/src/Viewer/Viewer.ts

@@ -25,7 +25,7 @@ import { IViewer } from "./IViewer";
 import { commands } from "./Commands";
 import { EventEmitter2 } from "./EventEmitter2";
 import { ViewerEventMap } from "./ViewerEvents";
-import { OptionsEventMap, OptionsChangeEvent } from "./OptionsEvents";
+import { OptionsEventMap } from "./OptionsEvents";
 import { CANVAS_EVENTS } from "./CanvasEvents";
 
 import { OdBaseDragger } from "./Draggers/Common/OdBaseDragger";
@@ -76,7 +76,6 @@ export class Viewer extends EventEmitter2<ViewerEventMap & OptionsEventMap> impl
   protected _visualizeJsUrl: string;
   protected _abortControllerForReferences: AbortController | undefined;
 
-  private clientoptionschange: (event: OptionsChangeEvent) => void;
   private canvaseventlistener: (event: Event) => void;
 
   public draggerFactory: Map<string, typeof OdBaseDragger>;
@@ -117,7 +116,6 @@ export class Viewer extends EventEmitter2<ViewerEventMap & OptionsEventMap> impl
     this._options = new Options(this);
 
     this.client = client;
-    this.clientoptionschange = (event: OptionsChangeEvent) => (this._options.data = event.data.data);
 
     this._activeDragger = null;
     this._renderTime = 0;
@@ -154,11 +152,6 @@ export class Viewer extends EventEmitter2<ViewerEventMap & OptionsEventMap> impl
 
   /**
    * `VisualizeJS` parameters.
-   *
-   * Use this only for standalone viewer instances. Use {@link Client#options | Client.options}
-   * instead if the viewer was created with a `Client` reference using
-   * {@link Viewer | Viewer.create(client)}. Changes in client options will be automatically
-   * applied to the viewer options.
    */
   get options(): Options {
     return this._options;
@@ -207,10 +200,6 @@ export class Viewer extends EventEmitter2<ViewerEventMap & OptionsEventMap> impl
    *   of the `VisualizeJS` library. Retrieves {@link event:visualizeprogress | visualizeprogress} event.
    */
   async initialize(canvas: HTMLCanvasElement, onProgress?: (event: ProgressEvent) => void): Promise<this> {
-    if (this.client) {
-      this.client.addEventListener("optionschange", this.clientoptionschange);
-      this.options.data = this.client.options.data;
-    }
     this.addEventListener("optionschange", (event) => this.syncOptions(event.data));
 
     if (canvas.style.width === "" && canvas.style.height === "") {
@@ -287,8 +276,6 @@ export class Viewer extends EventEmitter2<ViewerEventMap & OptionsEventMap> impl
     this.visualizeJs?.getViewer().clear();
     this.visualizeJs = undefined;
 
-    this.client?.removeEventListener("optionschange", this.clientoptionschange);
-
     return this;
   }
 

package/src/index.ts

@@ -39,6 +39,7 @@ export { Project } from "./Api/Project";
 export { Role } from "./Api/Role";
 export { User } from "./Api/User";
 export { Viewer, Viewer as VisualizejsViewer } from "./Viewer/Viewer";
+export { parseArgs, userFullName, userInitials, waitFor } from "./Api/impl/Utils";
 
 export * from "./Api/ClientEvents";
 export * from "./Viewer/Markup/IViewpoint";