@inweb/client 25.3.8 → 25.3.10

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/Markup/Api/Impl/Konva/KonvaCloud.d.ts

@@ -7,10 +7,10 @@ export declare class KonvaCloud implements IMarkupCloud, IMarkupColorable {
             x: number;
             y: number;
         };
-        width: number;
-        height: number;
-        lineWidth: number;
-        color: string;
+        width?: number;
+        height?: number;
+        lineWidth?: number;
+        color?: string;
         id?: string;
     }, ref?: any);
     ref(): import("konva/lib/Shape").Shape<import("konva/lib/Shape").ShapeConfig>;

package/lib/Viewer/Markup/Api/Impl/Konva/KonvaEllipse.d.ts

@@ -11,8 +11,8 @@ export declare class KonvaEllipse implements IMarkupEllipse, IMarkupColorable {
             x: number;
             y: number;
         };
-        color: string;
         lineWidth?: number;
+        color?: string;
         id?: string;
     }, ref?: any);
     getPosition(): {

package/lib/Viewer/Markup/Api/Impl/Konva/KonvaLine.d.ts

@@ -8,9 +8,9 @@ export declare class KonvaLine implements IMarkupLine, IMarkupColorable {
             x: number;
             y: number;
         }[];
-        color: string;
-        type: LineType;
-        width: number;
+        type?: LineType;
+        width?: number;
+        color?: string;
         id?: string;
     }, ref?: any);
     ref(): import("konva/lib/shapes/Line").Line<import("konva/lib/shapes/Line").LineConfig>;

package/lib/Viewer/Markup/Api/Impl/Konva/KonvaRectangle.d.ts

@@ -7,10 +7,10 @@ export declare class KonvaRectangle implements IMarkupRectangle, IMarkupColorabl
             x: number;
             y: number;
         };
-        color: string;
-        lineWidth: number;
-        width: number;
-        height: number;
+        width?: number;
+        height?: number;
+        lineWidth?: number;
+        color?: string;
         id?: string;
     }, ref?: any);
     getPosition(): {

package/lib/Viewer/Markup/Api/Impl/Konva/KonvaText.d.ts

@@ -9,9 +9,9 @@ export declare class KonvaText implements IMarkupText, IMarkupColorable {
             y: number;
         };
         text: string;
-        fontSize: number;
-        color: string;
-        rotation: number;
+        rotation?: number;
+        fontSize?: number;
+        color?: string;
         id?: string;
     }, ref?: any);
     ref(): import("konva/lib/shapes/Text").Text;

package/lib/Viewer/Markup/IViewpoint.d.ts

@@ -40,58 +40,58 @@ export interface IPerspectiveCamera {
 export type LineType = "solid" | "dot" | "dash";
 export interface ILine {
     points: IPoint[];
-    color: string;
-    type: LineType;
-    width: number;
-    id: string;
+    type?: LineType;
+    width?: number;
+    color?: string;
+    id?: string;
 }
 export interface IText {
     position: IPoint;
     text: string;
-    angle: number;
-    text_size: number;
-    color: string;
-    id: string;
-    font_size: number;
+    angle?: number;
+    font_size?: number;
+    text_size?: number;
+    color?: string;
+    id?: string;
 }
 export interface IArrow {
-    id: string;
     start: IPoint;
     end: IPoint;
-    color: string;
+    color?: string;
+    id?: string;
 }
 export interface ICloud {
-    id: string;
     position: IPoint;
-    width: number;
-    height: number;
-    line_width: number;
-    color: string;
+    width?: number;
+    height?: number;
+    line_width?: number;
+    color?: string;
+    id?: string;
 }
 export interface IEllipse {
-    id: string;
     position: IPoint;
     radius: {
         x: number;
         y: number;
     };
-    line_width: number;
-    color: string;
+    line_width?: number;
+    color?: string;
+    id?: string;
 }
 export interface IImage {
-    id: string;
     position: IPoint;
     src: string;
     width: number;
     height: number;
+    id?: string;
 }
 export interface IRectangle {
-    id: string;
     position: IPoint;
-    width: number;
-    height: number;
-    line_width: number;
-    color: string;
+    width?: number;
+    height?: number;
+    line_width?: number;
+    color?: string;
+    id?: string;
 }
 export interface IColoring {
     handle: string;
@@ -100,10 +100,13 @@ export interface IColoring {
 export interface IEntity {
     handle: string;
 }
+export interface ISnapshot {
+    data: string;
+}
 export interface IViewpoint {
     bitmaps?: IBitmap[];
     guid?: string;
-    file_id: string;
+    file_id?: string;
     assembly_id?: string;
     orthogonal_camera?: IOrthogonalCamera;
     perspective_camera?: IPerspectiveCamera;
@@ -121,5 +124,6 @@ export interface IViewpoint {
     images?: IImage[];
     rectangles?: IRectangle[];
     custom_fields?: any;
+    snapshot?: ISnapshot;
 }
 //# sourceMappingURL=IViewpoint.d.ts.map

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inweb/client",
-  "version": "25.3.8",
+  "version": "25.3.10",
   "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/Markup/Api/Impl/Konva/KonvaCloud.ts

@@ -8,10 +8,10 @@ export class KonvaCloud implements IMarkupCloud, IMarkupColorable {
   constructor(
     params: {
       position: { x: number; y: number };
-      width: number;
-      height: number;
-      lineWidth: number;
-      color: string;
+      width?: number;
+      height?: number;
+      lineWidth?: number;
+      color?: string;
       id?: string;
     },
     ref = null

package/src/Viewer/Markup/Api/Impl/Konva/KonvaEllipse.ts

@@ -9,8 +9,8 @@ export class KonvaEllipse implements IMarkupEllipse, IMarkupColorable {
     params: {
       position: { x: number; y: number };
       radius: { x: number; y: number };
-      color: string;
       lineWidth?: number;
+      color?: string;
       id?: string;
     },
     ref = null

package/src/Viewer/Markup/Api/Impl/Konva/KonvaLine.ts

@@ -13,7 +13,7 @@ export class KonvaLine implements IMarkupLine, IMarkupColorable {
   private _ref: Konva.Line;
 
   constructor(
-    params: { points: { x: number; y: number }[]; color: string; type: LineType; width: number; id?: string },
+    params: { points: { x: number; y: number }[]; type?: LineType; width?: number; color?: string; id?: string },
     ref = null
   ) {
     if (ref) {

package/src/Viewer/Markup/Api/Impl/Konva/KonvaRectangle.ts

@@ -8,10 +8,10 @@ export class KonvaRectangle implements IMarkupRectangle, IMarkupColorable {
   constructor(
     params: {
       position: { x: number; y: number };
-      color: string;
-      lineWidth: number;
-      width: number;
-      height: number;
+      width?: number;
+      height?: number;
+      lineWidth?: number;
+      color?: string;
       id?: string;
     },
     ref = null
@@ -31,8 +31,8 @@ export class KonvaRectangle implements IMarkupRectangle, IMarkupColorable {
       lineJoin: "round",
       x: params.position.x,
       y: params.position.y,
-      width: params.width,
-      height: params.height,
+      width: params.width ?? 200,
+      height: params.height ?? 200,
       draggable: true,
       strokeScaleEnabled: false,
     });

package/src/Viewer/Markup/Api/Impl/Konva/KonvaText.ts

@@ -10,9 +10,9 @@ export class KonvaText implements IMarkupText, IMarkupColorable {
     params: {
       position: { x: number; y: number };
       text: string;
-      fontSize: number;
-      color: string;
-      rotation: number;
+      rotation?: number;
+      fontSize?: number;
+      color?: string;
       id?: string;
     },
     ref = null

package/src/Viewer/Markup/IViewpoint.ts

@@ -48,64 +48,64 @@ export type LineType = "solid" | "dot" | "dash";
 
 export interface ILine {
   points: IPoint[];
-  color: string;
-  type: LineType;
-  width: number;
-  id: string;
+  type?: LineType;
+  width?: number;
+  color?: string;
+  id?: string;
 }
 
 export interface IText {
   position: IPoint;
   text: string;
-  angle: number;
-  text_size: number;
-  color: string;
-  id: string;
-  font_size: number;
+  angle?: number;
+  font_size?: number;
+  text_size?: number;
+  color?: string;
+  id?: string;
 }
 
 export interface IArrow {
-  id: string;
   start: IPoint;
   end: IPoint;
-  color: string;
+  color?: string;
+  id?: string;
 }
 
 export interface ICloud {
-  id: string;
   position: IPoint;
-  width: number;
-  height: number;
-  line_width: number;
-  color: string;
+  width?: number;
+  height?: number;
+  line_width?: number;
+  color?: string;
+  id?: string;
 }
 
 export interface IEllipse {
-  id: string;
   position: IPoint;
   radius: {
     x: number;
     y: number;
   };
-  line_width: number;
-  color: string;
+  line_width?: number;
+  color?: string;
+  id?: string;
 }
 
 export interface IImage {
-  id: string;
   position: IPoint;
   src: string;
   width: number;
   height: number;
+  id?: string;
 }
 
 export interface IRectangle {
-  id: string;
   position: IPoint;
-  width: number;
-  height: number;
-  line_width: number;
-  color: string;
+  width?: number;
+  height?: number;
+  line_width?: number;
+  color?: string;
+  id?: string;
 }
 
 export interface IColoring {
@@ -117,10 +117,14 @@ export interface IEntity {
   handle: string;
 }
 
+export interface ISnapshot {
+  data: string;
+}
+
 export interface IViewpoint {
   bitmaps?: IBitmap[];
   guid?: string;
-  file_id: string;
+  file_id?: string;
   assembly_id?: string;
   orthogonal_camera?: IOrthogonalCamera;
   perspective_camera?: IPerspectiveCamera;
@@ -138,4 +142,5 @@ export interface IViewpoint {
   images?: IImage[];
   rectangles?: IRectangle[];
   custom_fields?: any;
+  snapshot?: ISnapshot;
 }

package/src/Viewer/Markup/Impl/Konva/KonvaMarkup.ts

@@ -243,10 +243,10 @@ export class KonvaMarkup implements IMarkup {
   }
 
   getViewpoint(): IViewpoint {
-    // TODO: at the current 25.2 state we need VisualizeJS here and below. In the future we need to use it as an external interface
-    if (!this._viewer.visualizeJs) return { file_id: "" };
+    // TODO: at the current 25.2 state we need VisualizeJS here and below. In the future we need to use it as an external interface.
+    if (!this._viewer.visualizeJs) return {};
 
-    const viewpoint = {
+    const viewpoint: IViewpoint = {
       lines: [],
       texts: [],
       arrows: [],
@@ -254,7 +254,7 @@ export class KonvaMarkup implements IMarkup {
       ellipses: [],
       images: [],
       rectangles: [],
-    } as any;
+    };
 
     viewpoint.snapshot = {
       data: this.combineMarkupWithDrawing(),
@@ -931,9 +931,9 @@ export class KonvaMarkup implements IMarkup {
 
     const konvaLine = new KonvaLine({
       points,
-      color: color || this._markupColor.HexColor,
       type: type || "solid",
       width: width || this.lineWidth,
+      color: color || this._markupColor.HexColor,
       id,
     });
 
@@ -1009,9 +1009,9 @@ export class KonvaMarkup implements IMarkup {
       const konvaText = new KonvaText({
         position: { x: position.x, y: position.y },
         text: specifiedText,
+        rotation: angle,
         fontSize,
         color: color || this._markupColor.HexColor,
-        rotation: angle,
         id,
       });
 
@@ -1042,10 +1042,10 @@ export class KonvaMarkup implements IMarkup {
 
     const konvaRectangle = new KonvaRectangle({
       position,
-      color: color || this._markupColor.HexColor,
-      lineWidth: lineWidth || this.lineWidth,
       width,
       height,
+      lineWidth: lineWidth || this.lineWidth,
+      color: color || this._markupColor.HexColor,
       id,
     });
 

package/src/Viewer/Markup/Impl/Visualize/VisualizeMarkup.ts

@@ -4,7 +4,7 @@ import { OdBaseDragger } from "../../../Draggers/Common/OdBaseDragger";
 import { MARKUP_ENTITY_LINE, OdaLineDragger } from "../../../Draggers/OdaLineDragger";
 import { MARKUP_ENTITY_TEXT, OdaTextDragger } from "../../../Draggers/OdaTextDragger";
 import { IMarkupObject } from "../../Api/IMarkupObject";
-import { IViewpoint } from "../../IViewpoint";
+import { ILine, IText, IViewpoint } from "../../IViewpoint";
 
 export class VisualizeMarkup implements IMarkup {
   private _viewer: Viewer;
@@ -133,15 +133,15 @@ export class VisualizeMarkup implements IMarkup {
       return { x: array[0], y: array[1], z: array[2] };
     }
 
-    if (!this._viewer.visualizeJs) return { file_id: "" };
+    if (!this._viewer.visualizeJs) return {};
 
     const visLib = this._viewer.visLib();
     const visViewer = visLib.getViewer();
 
-    const viewpoint = {
+    const viewpoint: IViewpoint = {
       lines: [],
       texts: [],
-    } as any;
+    };
 
     const model = visViewer.getMarkupModel();
     const itr = model.getEntitiesIterator();
@@ -162,7 +162,7 @@ export class VisualizeMarkup implements IMarkup {
         const polylinePtr = geometryId.openAsPolyline();
         const points = polylinePtr.getPoints();
 
-        const line = {
+        const line: ILine = {
           points: [],
         };
         for (const point of points) {
@@ -175,7 +175,7 @@ export class VisualizeMarkup implements IMarkup {
         const textPtr = geometryId.openAsText();
         const position = textPtr.getPosition();
 
-        const text = {
+        const text: IText = {
           position: getLogicalPoint3dFromArray(position),
           text: textPtr.getString(),
           angle: textPtr.getRotation(),