@inweb/client 25.4.3 → 25.4.6

package/lib/Api/Assembly.d.ts

@@ -211,10 +211,42 @@ export declare class Assembly {
      * @async
      */
     getCdaTree(): Promise<any[]>;
-    getViewpoints(): Promise<[]>;
+    /**
+     * Returns a list of assembly viewpoints.
+     *
+     * @async
+     */
+    getViewpoints(): Promise<any[]>;
+    /**
+     * Add new assembly viewpoint. To create a new viewpoint use {@link Viewer.createViewpoint()}.
+     *
+     * @async
+     * @param viewpoint - Viewpoint.
+     */
     saveViewpoint(viewpoint: any): Promise<any>;
+    /**
+     * Delete assembly viewpoint.
+     *
+     * @async
+     * @param guid - Viewpoint GUID.
+     * @returns Returns the raw data of a deleted viewpoint.
+     */
     deleteViewpoint(guid: any): Promise<any>;
+    /**
+     * Returns viewpoint preview image as
+     * {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}.
+     *
+     * @async
+     * @param guid - Viewpoint GUID.
+     */
     getSnapshot(guid: any): Promise<any>;
+    /**
+     * Returns viewpoint preview data.
+     *
+     * @async
+     * @param guid - Viewpoint GUID.
+     * @param bitmapGuid - Bitmap GUID.
+     */
     getSnapshotData(guid: any, bitmapGuid: any): Promise<string>;
     /**
      * Download assembly resource file. Resource files are files that contain model scene

package/lib/Api/Client.d.ts

@@ -107,6 +107,8 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
      * - Open the `provider.url` link using `window.open()`.
      * - Add a `/oauth` path (server-defined) handler to the router. In this handler, show an error
      *   message if the `error` search parameter is present, or log in with the `token` search parameter.
+     *
+     * @async
      */
     getIdentityProviders(): Promise<any>;
     private setCurrentUser;

package/lib/Api/File.d.ts

@@ -304,9 +304,8 @@ export declare class File {
      */
     deleteViewpoint(guid: string): Promise<any>;
     /**
-     * Returns viewpoint preview image as <a
-     * href="https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs"
-     * target="_blank">Data URL</a>.
+     * Returns viewpoint preview image as
+     * {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}.
      *
      * @async
      * @param guid - Viewpoint GUID.

package/lib/Api/Model.d.ts

@@ -128,9 +128,8 @@ export declare class Model {
      */
     deleteViewpoint(guid: string): Promise<any>;
     /**
-     * Returns viewpoint preview image as <a
-     * href="https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs"
-     * target="_blank">Data URL</a>.
+     * Returns viewpoint preview image as
+     * {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}.
      *
      * @async
      * @param guid - Viewpoint GIID.

package/lib/Api/User.d.ts

@@ -1,34 +1,4 @@
 import { IHttpClient } from "./IHttpClient";
-export interface UserParams {
-    /**
-     * `true` if user is an administrator
-     */
-    isAdmin?: boolean;
-    /**
-     * User name
-     */
-    userName?: string;
-    /**
-     * First name
-     */
-    firstName?: string;
-    /**
-     * Last name
-     */
-    lastName?: string;
-    /**
-     * `true` if user is allowed to create a project
-     */
-    canCreateProject?: boolean;
-    /**
-     * The maximum number of projects that the user can create
-     */
-    projectsLimit?: number;
-    /**
-     * The size of the file storage available to the user
-     */
-    storageLimit?: number;
-}
 /**
  * The class representing a `user` entity.
  */
@@ -104,6 +74,10 @@ export declare class User {
      * and last names are empty, returns the first letter of the user name.
      */
     get initials(): string;
+    /**
+     * `true` if user is has an administrator rights.
+     */
+    get isAdmin(): boolean;
     /**
      * `false` if the user has not yet confirmed his email address.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inweb/client",
-  "version": "25.4.3",
+  "version": "25.4.6",
   "description": "JavaScript REST API client for the Open Cloud Server",
   "homepage": "https://cloud.opendesign.com/docs/index.html",
   "license": "SEE LICENSE IN LICENSE",
@@ -26,6 +26,6 @@
     "ts-docs": "typedoc"
   },
   "dependencies": {
-    "@inweb/eventemitter2": "~25.4.3"
+    "@inweb/eventemitter2": "~25.4.6"
   }
 }

package/src/Api/Assembly.ts

@@ -378,31 +378,58 @@ export class Assembly {
     return this.internalGet(`/properties/tree`).then((response) => response.json());
   }
 
-  // Reserved for future use
-
-  getViewpoints(): Promise<[]> {
-    console.warn("Assembly does not support viewpoints");
-    return Promise.resolve([]);
+  /**
+   * Returns a list of assembly viewpoints.
+   *
+   * @async
+   */
+  getViewpoints(): Promise<any[]> {
+    return this.internalGet("/viewpoints")
+      .then((response) => response.json())
+      .then((viewpoints) => viewpoints.result);
   }
 
+  /**
+   * Add new assembly viewpoint. To create a new viewpoint use {@link Viewer.createViewpoint()}.
+   *
+   * @async
+   * @param viewpoint - Viewpoint.
+   */
   saveViewpoint(viewpoint: any): Promise<any> {
-    console.warn("Assembly does not support viewpoints");
-    return Promise.resolve({});
+    return this.internalPost("/viewpoints", viewpoint).then((response) => response.json());
   }
 
+  /**
+   * Delete assembly viewpoint.
+   *
+   * @async
+   * @param guid - Viewpoint GUID.
+   * @returns Returns the raw data of a deleted viewpoint.
+   */
   deleteViewpoint(guid: any): Promise<any> {
-    console.warn("Assembly does not support viewpoints");
-    return Promise.resolve({});
+    return this.internalDelete(`/viewpoints/${guid}`).then((response) => response.json());
   }
 
+  /**
+   * Returns viewpoint preview image as
+   * {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}.
+   *
+   * @async
+   * @param guid - Viewpoint GUID.
+   */
   getSnapshot(guid: any): Promise<any> {
-    console.warn("Assembly does not support viewpoints");
-    return Promise.resolve({});
+    return this.internalGet(`/viewpoints/${guid}/snapshot`).then((response) => response.text());
   }
 
+  /**
+   * Returns viewpoint preview data.
+   *
+   * @async
+   * @param guid - Viewpoint GUID.
+   * @param bitmapGuid - Bitmap GUID.
+   */
   getSnapshotData(guid: any, bitmapGuid: any): Promise<string> {
-    console.warn("Assembly does not support viewpoints");
-    return Promise.resolve("");
+    return this.internalGet(`/viewpoints/${guid}/bitmaps/${bitmapGuid}`).then((response) => response.text());
   }
 
   /**

package/src/Api/Client.ts

@@ -225,6 +225,8 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * - Open the `provider.url` link using `window.open()`.
    * - Add a `/oauth` path (server-defined) handler to the router. In this handler, show an error
    *   message if the `error` search parameter is present, or log in with the `token` search parameter.
+   *
+   * @async
    */
   getIdentityProviders(): Promise<any> {
     return this.httpClient.get("/identity").then((response) => response.json());

package/src/Api/File.ts

@@ -506,9 +506,8 @@ export class File {
   }
 
   /**
-   * Returns viewpoint preview image as <a
-   * href="https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs"
-   * target="_blank">Data URL</a>.
+   * Returns viewpoint preview image as
+   * {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}.
    *
    * @async
    * @param guid - Viewpoint GUID.

package/src/Api/Model.ts

@@ -223,9 +223,8 @@ export class Model {
   }
 
   /**
-   * Returns viewpoint preview image as <a
-   * href="https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs"
-   * target="_blank">Data URL</a>.
+   * Returns viewpoint preview image as
+   * {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}.
    *
    * @async
    * @param guid - Viewpoint GIID.

package/src/Api/User.ts

@@ -24,43 +24,6 @@
 import { IHttpClient } from "./IHttpClient";
 import { userFullName, userInitials } from "./Utils";
 
-export interface UserParams {
-  /**
-   * `true` if user is an administrator
-   */
-  isAdmin?: boolean;
-
-  /**
-   * User name
-   */
-  userName?: string;
-
-  /**
-   * First name
-   */
-  firstName?: string;
-
-  /**
-   * Last name
-   */
-  lastName?: string;
-
-  /**
-   * `true` if user is allowed to create a project
-   */
-  canCreateProject?: boolean;
-
-  /**
-   * The maximum number of projects that the user can create
-   */
-  projectsLimit?: number;
-
-  /**
-   * The size of the file storage available to the user
-   */
-  storageLimit?: number;
-}
-
 /**
  * The class representing a `user` entity.
  */
@@ -187,6 +150,13 @@ export class User {
     return this.data.initials;
   }
 
+  /**
+   * `true` if user is has an administrator rights.
+   */
+  get isAdmin(): boolean {
+    return this.data.isAdmin;
+  }
+
   /**
    * `false` if the user has not yet confirmed his email address.
    *