@inweb/client 25.8.20 → 25.8.21

package/lib/Api/Assembly.d.ts

@@ -189,7 +189,7 @@ export declare class Assembly {
      */
     getViewpoints(): Promise<any[]>;
     /**
-     * Adds a new viewpoint to the assembly. To create a viewpoint use `Viewer.createViewpoint()`.
+     * Saves a new assembly viewpoint to the server. To create a viewpoint use `Viewer.createViewpoint()`.
      *
      * @param viewpoint - Viewpoint.
      */
@@ -200,16 +200,16 @@ export declare class Assembly {
      * @param guid - Viewpoint GUID.
      * @returns Returns the raw data of a deleted viewpoint.
      */
-    deleteViewpoint(guid: any): Promise<any>;
+    deleteViewpoint(guid: string): Promise<any>;
     /**
-     * Returns viewpoint preview image as
+     * Returns viewpoint snapshot as base64-encoded
      * {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}.
      *
      * @param guid - Viewpoint GUID.
      */
-    getSnapshot(guid: any): Promise<any>;
+    getSnapshot(guid: string): Promise<string>;
     /**
-     * Returns viewpoint preview data.
+     * Returns viewpoint snapshot data.
      *
      * @param guid - Viewpoint GUID.
      * @param bitmapGuid - Bitmap GUID.

package/lib/Api/File.d.ts

@@ -293,7 +293,7 @@ export declare class File {
      */
     getViewpoints(): Promise<any[]>;
     /**
-     * Adds a new viewpoint to the file. To create a viewpoint use `Viewer.createViewpoint()`.
+     * Saves a new file viewpoint to the server. To create a viewpoint use `Viewer.createViewpoint()`.
      *
      * @param viewpoint - Viewpoint.
      */
@@ -306,14 +306,14 @@ export declare class File {
      */
     deleteViewpoint(guid: string): Promise<any>;
     /**
-     * Returns viewpoint preview image as
+     * Returns viewpoint snapshot as base64-encoded
      * {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}.
      *
      * @param guid - Viewpoint GUID.
      */
     getSnapshot(guid: string): Promise<string>;
     /**
-     * Returns viewpoint preview data.
+     * Returns viewpoint snapshot data.
      *
      * @param guid - Viewpoint GUID.
      * @param bitmapGuid - Bitmap GUID.
@@ -492,7 +492,7 @@ export declare class File {
      *   - `readViewpoint` - The ability to read file viewpoints.
      *   - `createViewpoint` - The ability to create file viewpoints.
      *
-     * @param grantedTo - A collection of principials that will get access to the file.
+     * @param grantedTo - A list of principials that will get access to the file.
      * @param _public - Specifies whether all users have access to the file or not.
      */
     createPermission(actions: string | string[], grantedTo: any[], _public: boolean): Promise<Permission>;

package/lib/Api/IFile.d.ts

@@ -27,7 +27,7 @@ export interface IFileReference {
  */
 export interface IFileReferences {
     /**
-     * The references ID, changed after each update of the file references.
+     * The references list ID, changed after each update of the file references.
      */
     id: string;
     /**

package/lib/Api/Model.d.ts

@@ -103,8 +103,8 @@ export declare class Model {
      */
     getViewpoints(): Promise<any[]>;
     /**
-     * Adds a new viewpoint to the owner file/assembly. To create a new viewpoint use
-     * `Viewer.createViewpoint()`.
+     * Saves a new model owner file/assembly viewpoint to the server. To create a new viewpoint
+     * use `Viewer.createViewpoint()`.
      *
      * @param viewpoint - Viewpoint.
      */
@@ -117,10 +117,10 @@ export declare class Model {
      */
     deleteViewpoint(guid: string): Promise<any>;
     /**
-     * Returns viewpoint preview image as
+     * Returns viewpoint snapshot as base64-encoded
      * {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}.
      *
-     * @param guid - Viewpoint GIID.
+     * @param guid - Viewpoint GUID.
      */
     getSnapshot(guid: string): Promise<string>;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inweb/client",
-  "version": "25.8.20",
+  "version": "25.8.21",
   "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 @@
     "docs": "typedoc"
   },
   "dependencies": {
-    "@inweb/eventemitter2": "~25.8.20"
+    "@inweb/eventemitter2": "~25.8.21"
   }
 }

package/src/Api/Assembly.ts

@@ -364,7 +364,7 @@ export class Assembly {
   }
 
   /**
-   * Adds a new viewpoint to the assembly. To create a viewpoint use `Viewer.createViewpoint()`.
+   * Saves a new assembly viewpoint to the server. To create a viewpoint use `Viewer.createViewpoint()`.
    *
    * @param viewpoint - Viewpoint.
    */
@@ -378,22 +378,22 @@ export class Assembly {
    * @param guid - Viewpoint GUID.
    * @returns Returns the raw data of a deleted viewpoint.
    */
-  deleteViewpoint(guid: any): Promise<any> {
+  deleteViewpoint(guid: string): Promise<any> {
     return this.internalDelete(`/viewpoints/${guid}`).then((response) => response.json());
   }
 
   /**
-   * Returns viewpoint preview image as
+   * Returns viewpoint snapshot as base64-encoded
    * {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}.
    *
    * @param guid - Viewpoint GUID.
    */
-  getSnapshot(guid: any): Promise<any> {
+  getSnapshot(guid: string): Promise<string> {
     return this.internalGet(`/viewpoints/${guid}/snapshot`).then((response) => response.text());
   }
 
   /**
-   * Returns viewpoint preview data.
+   * Returns viewpoint snapshot data.
    *
    * @param guid - Viewpoint GUID.
    * @param bitmapGuid - Bitmap GUID.

package/src/Api/File.ts

@@ -505,7 +505,7 @@ export class File {
   }
 
   /**
-   * Adds a new viewpoint to the file. To create a viewpoint use `Viewer.createViewpoint()`.
+   * Saves a new file viewpoint to the server. To create a viewpoint use `Viewer.createViewpoint()`.
    *
    * @param viewpoint - Viewpoint.
    */
@@ -524,7 +524,7 @@ export class File {
   }
 
   /**
-   * Returns viewpoint preview image as
+   * Returns viewpoint snapshot as base64-encoded
    * {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}.
    *
    * @param guid - Viewpoint GUID.
@@ -534,7 +534,7 @@ export class File {
   }
 
   /**
-   * Returns viewpoint preview data.
+   * Returns viewpoint snapshot data.
    *
    * @param guid - Viewpoint GUID.
    * @param bitmapGuid - Bitmap GUID.
@@ -816,7 +816,7 @@ export class File {
    *   - `readViewpoint` - The ability to read file viewpoints.
    *   - `createViewpoint` - The ability to create file viewpoints.
    *
-   * @param grantedTo - A collection of principials that will get access to the file.
+   * @param grantedTo - A list of principials that will get access to the file.
    * @param _public - Specifies whether all users have access to the file or not.
    */
   createPermission(actions: string | string[], grantedTo: any[], _public: boolean): Promise<Permission> {

package/src/Api/IFile.ts

@@ -54,7 +54,7 @@ export interface IFileReference {
  */
 export interface IFileReferences {
   /**
-   * The references ID, changed after each update of the file references.
+   * The references list ID, changed after each update of the file references.
    */
   id: string;
 

package/src/Api/Model.ts

@@ -189,8 +189,8 @@ export class Model {
   }
 
   /**
-   * Adds a new viewpoint to the owner file/assembly. To create a new viewpoint use
-   * `Viewer.createViewpoint()`.
+   * Saves a new model owner file/assembly viewpoint to the server. To create a new viewpoint
+   * use `Viewer.createViewpoint()`.
    *
    * @param viewpoint - Viewpoint.
    */
@@ -212,10 +212,10 @@ export class Model {
   }
 
   /**
-   * Returns viewpoint preview image as
+   * Returns viewpoint snapshot as base64-encoded
    * {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}.
    *
-   * @param guid - Viewpoint GIID.
+   * @param guid - Viewpoint GUID.
    */
   getSnapshot(guid: string): Promise<string> {
     return this._file.getSnapshot(guid);