@inweb/client 25.4.2 → 25.4.4

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/ClashTest.d.ts

@@ -5,8 +5,8 @@ import { IShortUserDescription } from "./IUser";
  */
 export declare class ClashTest {
     private _data;
-    private basePath;
-    private httpClient;
+    basePath: string;
+    httpClient: IHttpClient;
     /**
      * @param data - Raw test data.
      * @param basePath - Clash tests API base path for the owner file/assembly.

package/lib/Api/Client.d.ts

@@ -1,4 +1,5 @@
 import { EventEmitter2 } from "@inweb/eventemitter2";
+import { IHttpClient } from "./IHttpClient";
 import { ClientEventMap } from "./ClientEvents";
 import { Assembly } from "./Assembly";
 import { File } from "./File";
@@ -12,7 +13,7 @@ import { User } from "./User";
  */
 export declare class Client extends EventEmitter2<ClientEventMap> {
     private _serverUrl;
-    private _httpClient;
+    httpClient: IHttpClient;
     private _user;
     eventEmitter: EventEmitter2;
     /**
@@ -106,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/Job.d.ts

@@ -5,7 +5,7 @@ import { IHttpClient } from "./IHttpClient";
  */
 export declare class Job {
     private _data;
-    protected httpClient: IHttpClient;
+    httpClient: IHttpClient;
     /**
      * @param data - An object that implements job data storage.
      * @param httpClient - Http client.

package/lib/Api/Member.d.ts

@@ -5,8 +5,8 @@ import { IShortUserDescription } from "./IUser";
  */
 export declare class Member {
     private _data;
-    protected projectId: string;
-    protected httpClient: IHttpClient;
+    projectId: string;
+    httpClient: IHttpClient;
     /**
      * @param data - An object that implements member data storage.
      * @param projectId - Owner project ID.

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/Permission.d.ts

@@ -5,8 +5,8 @@ import { IHttpClient } from "./IHttpClient";
  */
 export declare class Permission {
     private _data;
-    protected fileId: string;
-    protected httpClient: IHttpClient;
+    fileId: string;
+    httpClient: IHttpClient;
     /**
      * @param data - An object that implements permission data storage.
      * @param fileId - Owner file ID.

package/lib/Api/Project.d.ts

@@ -7,7 +7,7 @@ import { Member } from "./Member";
  */
 export declare class Project {
     private _data;
-    protected httpClient: IHttpClient;
+    httpClient: IHttpClient;
     /**
      * @param data - An object that implements project data storage.
      * @param httpClient - Http client.

package/lib/Api/Role.d.ts

@@ -4,8 +4,8 @@ import { IHttpClient } from "./IHttpClient";
  */
 export declare class Role {
     private _data;
-    protected projectId: string;
-    protected httpClient: IHttpClient;
+    projectId: string;
+    httpClient: IHttpClient;
     /**
      * @param data - An object that implements role data storage.
      * @param projectId - Owner project ID.

package/lib/Api/User.d.ts

@@ -34,7 +34,7 @@ export interface UserParams {
  */
 export declare class User {
     private _data;
-    protected httpClient: IHttpClient;
+    httpClient: IHttpClient;
     /**
      * @param data - An object that implements user data storage.
      * @param httpClient - Http client.

package/lib/index.d.ts

@@ -3,6 +3,7 @@ export { Client } from "./Api/Client";
 export { ClashTest } from "./Api/ClashTest";
 export * from "./Api/ClientEvents";
 export { File } from "./Api/File";
+export { FetchError, statusText } from "./Api/FetchError";
 export { Job } from "./Api/Job";
 export { Member } from "./Api/Member";
 export { Model } from "./Api/Model";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inweb/client",
-  "version": "25.4.2",
+  "version": "25.4.4",
   "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.2"
+    "@inweb/eventemitter2": "~25.4.4"
   }
 }

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/ClashTest.ts

@@ -30,8 +30,8 @@ import { waitFor, userFullName, userInitials } from "./Utils";
  */
 export class ClashTest {
   private _data: any;
-  private basePath: string;
-  private httpClient: IHttpClient;
+  public basePath: string;
+  public httpClient: IHttpClient;
 
   /**
    * @param data - Raw test data.