@inweb/client 25.8.16 → 25.8.19

package/src/Api/Model.ts

@@ -24,9 +24,10 @@
 import { IHttpClient } from "./IHttpClient";
 import type { File } from "./File";
 import type { Assembly } from "./Assembly";
+import type { IModelTransformMatrix } from "./IAssembly";
 
 /**
- * The class representing the is a description of view of the file or assembly. For example,
+ * Provides properties and methods for working with view of the file or assembly. For example,
  * for `dwg` it is a `Model` space or layout, and for `rvt` files it is a `3D` view.
  */
 export class Model {
@@ -36,8 +37,8 @@ export class Model {
   public path: string;
 
   /**
-   * @param data - An object that implements model data storage.
-   * @param file - The `File` of 'Assembly' instance that owns the model.
+   * @param data - Raw model data received from the server.
+   * @param file - The file/assembly instance that owns the model.
    */
   constructor(data: any, file: File | Assembly) {
     this.path = `${file.path}/downloads`;
@@ -160,22 +161,22 @@ export class Model {
    *
    * @param handle - Model handle.
    */
-  getModelTransformMatrix(handle: string): any {
+  getModelTransformMatrix(handle: string): IModelTransformMatrix {
     return this.file.getModelTransformMatrix(handle);
   }
 
   /**
-   * Set or delete a model transformation.
+   * Sets or removes a model transformation.
    *
    * @param handle - Model handle.
-   * @param transform - Transformation matrix. To delete transformation provide this to `undefined`.
+   * @param transform - Transformation matrix. Specify `undefined` to remove transformation.
    */
-  setModelTransformMatrix(handle: string, transform: any): Promise<this> {
+  setModelTransformMatrix(handle: string, transform: IModelTransformMatrix): Promise<this> {
     return this.file.setModelTransformMatrix(handle, transform).then(() => this);
   }
 
   /**
-   * Returns model viewpoint list.
+   * Returns a list of viewpoints of the owner file/assembly.
    */
   getViewpoints(): Promise<any[]> {
     return this._file
@@ -188,7 +189,8 @@ export class Model {
   }
 
   /**
-   * Add new model viewpoint. To create a new viewpoint use `Viewer.createViewpoint()`.
+   * Adds a new viewpoint to the owner file/assembly. To create a new viewpoint use
+   * `Viewer.createViewpoint()`.
    *
    * @param viewpoint - Viewpoint.
    */
@@ -200,7 +202,7 @@ export class Model {
   }
 
   /**
-   * Delete model viewpoint.
+   * Deletes the specified viewpoint from the owner file/assembly.
    *
    * @param guid - Viewpoint GUID.
    * @returns Returns the raw data of a deleted viewpoint.
@@ -220,7 +222,7 @@ export class Model {
   }
 
   /**
-   * Returns snapshot data.
+   * Returns viewpoint snapshot data.
    *
    * @param guid - Viewpoint GUID.
    * @param bitmapGuid - Bitmap GUID.
@@ -230,8 +232,8 @@ export class Model {
   }
 
   /**
-   * Download model resource file. Resource files are files that contain model scene
-   * descriptions, or geometry data.
+   * Downloads a resource file. Resource files are files that contain model scene descriptions,
+   * or geometry data.
    *
    * @param dataId - Resource file name.
    * @param onProgress - Download progress callback.
@@ -248,7 +250,7 @@ export class Model {
   }
 
   /**
-   * Download a part of model resource file. Resource files are files that contain model scene
+   * Downloads a part of resource file. Resource files are files that contain model scene
    * descriptions, or geometry data.
    *
    * @param dataId - Resource file name.
@@ -318,7 +320,9 @@ export class Model {
   }
 
   /**
-   * Returns a list of references to files used to extract geometry data.
+   * Returns a list of references of the owner file/assembly.
+   *
+   * References are images, fonts, or any other files to correct rendering of the file.
    *
    * @param signal - An
    *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}

package/src/Api/Permission.ts

@@ -24,8 +24,8 @@
 import { IHttpClient } from "./IHttpClient";
 
 /**
- * A permission provides information about {@link File | file} sharing granted to a specific
- * {@link User | users}, group, or project {@link Member | member}.
+ * Provides properties and methods for obtaining information about {@link File | file} actions
+ * granted to a specific {@link User | users}, or project {@link Member | member}.
  */
 export class Permission {
   private _data: any;
@@ -33,9 +33,9 @@ export class Permission {
   public httpClient: IHttpClient;
 
   /**
-   * @param data - An object that implements permission data storage.
+   * @param data - Raw permission data received from the server.
    * @param fileId - Owner file ID.
-   * @param httpClient - Http client.
+   * @param httpClient - HTTP client instance used to send REST API requests to the server.
    */
   constructor(data: any, fileId: string, httpClient: IHttpClient) {
     this.httpClient = httpClient;
@@ -58,11 +58,11 @@ export class Permission {
   /**
    * Defines what actions are allowed to be performed on a file with this permission:
    *
-   * - `read` - The ability to read file description, geometry data and properties
-   * - `readSourceFile` - The ability to read source file
-   * - `write` - The ability to modify file name, description and references
-   * - `readViewpoint` - The ability to read file viewpoints
-   * - `createViewpoint` - The ability to create file viewpoints
+   * - `read` - The ability to read file description, geometry data and properties.
+   * - `readSourceFile` - The ability to read source file.
+   * - `write` - The ability to modify file name, description and references.
+   * - `readViewpoint` - The ability to read file viewpoints.
+   * - `createViewpoint` - The ability to create file viewpoints.
    */
   get actions(): string[] {
     return this.data.actions;
@@ -108,7 +108,7 @@ export class Permission {
    */
 
   /**
-   * A collection of principials that will get access to the file.
+   * A list of principials that will get access to the file.
    */
   get grantedTo(): any[] {
     return this.data.grantedTo;
@@ -130,7 +130,7 @@ export class Permission {
   }
 
   /**
-   * Refresh permission data.
+   * Reloads permission data from the server.
    */
   async checkout(): Promise<this> {
     const response = await this.internalGet();
@@ -139,7 +139,7 @@ export class Permission {
   }
 
   /**
-   * Update permission data on the server.
+   * Updates permission data on the server.
    *
    * @param data - Raw permission data.
    */
@@ -150,7 +150,7 @@ export class Permission {
   }
 
   /**
-   * Remove a permission from a file.
+   * Removes a permission from the file.
    *
    * @returns Returns the raw data of a deleted permission.
    */
@@ -159,8 +159,8 @@ export class Permission {
   }
 
   /**
-   * Save permission data changes to the server. Call this method to update permission data on
-   * the server after any changes.
+   * Saves permission properties changes to the server. Call this method to update permission
+   * data on the server after any property changes.
    */
   save(): Promise<this> {
     return this.update(this.data);

package/src/Api/Project.ts

@@ -28,15 +28,16 @@ import { Member } from "./Member";
 import { userFullName, userInitials } from "./Utils";
 
 /**
- * Projects are used to collaborate on models and track issues.
+ * Provides properties and methods for obtaining information about a project on the server and
+ * managing its {@link Role | roles}, {@link Member | members} and models.
  */
 export class Project {
   private _data: any;
   public httpClient: IHttpClient;
 
   /**
-   * @param data - An object that implements project data storage.
-   * @param httpClient - Http client.
+   * @param data - Raw project data received from the server.
+   * @param httpClient - HTTP client instance used to send REST API requests to the server.
    */
   constructor(data: any, httpClient: IHttpClient) {
     this.httpClient = httpClient;
@@ -62,11 +63,18 @@ export class Project {
   /**
    * Project features the user has access to.
    *
-   * @property {string[]} project_actions - Actions are allowed to be performed: `update`,
-   *   `createTopic`, `createDocument`.
    * @readonly
    */
-  get authorization(): any {
+  get authorization(): {
+    /**
+     * Actions are allowed to be performed:
+     *
+     * - `update` - The ability to update the project details.
+     * - `createTopic` - The ability to create a new topic.
+     * - `createDocument` - The ability to create a new document.
+     */
+    project_actions: string[];
+  } {
     return this.data.authorization;
   }
 
@@ -199,7 +207,7 @@ export class Project {
   }
 
   /**
-   * `true` if project is public (shared) project.
+   * `true` if project is shared project.
    */
   get public(): boolean {
     return this.data.public;
@@ -241,7 +249,7 @@ export class Project {
   }
 
   /**
-   * Refresh project data.
+   * Reloads project data from the server.
    */
   async checkout(): Promise<this> {
     const response = await this.internalGet("");
@@ -250,7 +258,7 @@ export class Project {
   }
 
   /**
-   * Update project data on the server.
+   * Updates project data on the server.
    *
    * @param data - Raw project data.
    */
@@ -261,7 +269,7 @@ export class Project {
   }
 
   /**
-   * Delete the project from the server.
+   * Deletes a project from the server.
    *
    * @returns Returns the raw data of a deleted project.
    */
@@ -279,23 +287,23 @@ export class Project {
   }
 
   /**
-   * Save project data changes to the server. Call this method to update project data on the
-   * server after any changes.
+   * Saves project properties changes to the server. Call this method to update project data on
+   * the server after any property changes.
    */
   save(): Promise<this> {
     return this.update(this.data);
   }
 
   /**
-   * Set or remove the project preview.
+   * Sets or removes the project preview.
    *
    * @param image - Preview image. Can be a
    *   {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}
    *   string,
    *   {@link https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer | ArrayBuffer},
-   *   {@link https://developer.mozilla.org/docs/Web/API/Blob/Blob | Blob} or Web API
-   *   {@link https://developer.mozilla.org/docs/Web/API/File | File} object. Setting the
-   *   `image` to `null` will remove the preview.
+   *   {@link https://developer.mozilla.org/docs/Web/API/Blob/Blob | Blob} or
+   *   {@link https://developer.mozilla.org/docs/Web/API/File | Web API File} object. Setting
+   *   the `image` to `null` will remove the preview.
    */
 
   async setPreview(image?: BodyInit | null): Promise<any> {
@@ -309,7 +317,7 @@ export class Project {
   }
 
   /**
-   * Remove the project preview.
+   * Removes the project preview.
    */
   async deletePreview(): Promise<this> {
     const response = await this.internalDelete("/preview");
@@ -328,7 +336,7 @@ export class Project {
   }
 
   /**
-   * Returns the role information.
+   * Returns information about the specified project role.
    *
    * @param name - Role name.
    */
@@ -339,7 +347,7 @@ export class Project {
   }
 
   /**
-   * Create a new project role.
+   * Creates a new project role.
    *
    * @param name - Role name.
    * @param description - Role description.
@@ -357,7 +365,7 @@ export class Project {
   }
 
   /**
-   * Delete project role.
+   * Deletes the specified project role.
    *
    * @param name - Role name.
    * @returns Returns the raw data of a deleted role.
@@ -376,7 +384,7 @@ export class Project {
   }
 
   /**
-   * Returns the member information.
+   * Returns information about the specified project member.
    *
    * @param memberId - Member ID.
    */
@@ -390,7 +398,7 @@ export class Project {
    * Add a user to the project to become a member and have permission to perform actions.
    *
    * @param userId - User ID.
-   * @param role - User role from the list of project roles.
+   * @param role - Role name from the list of project roles.
    */
   addMember(userId: string, role: string): Promise<Member> {
     return this.internalPost("/members", { userId, role })
@@ -399,7 +407,7 @@ export class Project {
   }
 
   /**
-   * Remove a member from a project.
+   * Remove the specified member from a project.
    *
    * @param memberId - Member ID.
    * @returns Returns the raw data of a deleted member.

package/src/Api/Role.ts

@@ -24,7 +24,8 @@
 import { IHttpClient } from "./IHttpClient";
 
 /**
- * A roles determines what permissions {@link User | users} have on a {@link Project | project}.
+ * A role determines what actions allowed to be performed by {@link User | users} on a
+ * {@link Project | project}.
  */
 export class Role {
   private _data: any;
@@ -32,9 +33,9 @@ export class Role {
   public httpClient: IHttpClient;
 
   /**
-   * @param data - An object that implements role data storage.
+   * @param data - Raw role data received from the server.
    * @param projectId - Owner project ID.
-   * @param httpClient - Http client.
+   * @param httpClient - HTTP client instance used to send REST API requests to the server.
    */
   constructor(data: any, projectId: string, httpClient: IHttpClient) {
     this.httpClient = httpClient;
@@ -115,7 +116,7 @@ export class Role {
   }
 
   /**
-   * Refresh role data.
+   * Reloads role data from the server.
    */
   async checkout(): Promise<this> {
     const response = await this.internalGet();
@@ -124,7 +125,7 @@ export class Role {
   }
 
   /**
-   * Update role data on the server.
+   * Updates role data on the server.
    *
    * @param data - Raw role data.
    */
@@ -135,7 +136,7 @@ export class Role {
   }
 
   /**
-   * Delete a role from the project.
+   * Deletes a role from the project.
    *
    * @returns Returns the raw data of a deleted role.
    */
@@ -144,8 +145,8 @@ export class Role {
   }
 
   /**
-   * Save role data changes to the server. Call this method to update role data on the server
-   * after any changes.
+   * Saves role properties changes to the server. Call this method to update role data on the
+   * server after any property changes.
    */
   save(): Promise<this> {
     return this.update(this.data);

package/src/Api/User.ts

@@ -26,15 +26,15 @@ import { FetchError } from "./FetchError";
 import { userFullName, userInitials } from "./Utils";
 
 /**
- * The class representing a `user` entity.
+ * Provides properties and methods for obtaining information about a server user and manage its data.
  */
 export class User {
   private _data: any;
   public httpClient: IHttpClient;
 
   /**
-   * @param data - An object that implements user data storage.
-   * @param httpClient - Http client.
+   * @param data - Raw user data received from the server.
+   * @param httpClient - HTTP client instance used to send REST API requests to the server.
    */
   constructor(data: any, httpClient: IHttpClient) {
     this.httpClient = httpClient;
@@ -52,7 +52,7 @@ export class User {
   }
 
   /**
-   * `true` if user is allowed to create a project.
+   * `true` if user is allowed to create a projects.
    *
    * Only administrators can change create project permission.
    */
@@ -227,7 +227,8 @@ export class User {
   }
 
   /**
-   * The identity provider used to create the account. Can be `ldap`, `oauth`, `saml` or empty.
+   * The identity provider used to create the account. Can be `ldap`, `oauth`, `saml` or empty
+   * for local accounts.
    *
    * @readonly
    */
@@ -258,8 +259,8 @@ export class User {
   }
 
   /**
-   * The user's access token (API key). Use {@link signInWithToken | Client.signInWithToken()}
-   * to log in using token.
+   * The user's access token (API key). Use
+   * {@link Client.signInWithToken | Client.signInWithToken()} to sign in to the server using this token.
    *
    * @readonly
    */
@@ -279,7 +280,7 @@ export class User {
   }
 
   /**
-   * Refresh user data.
+   * Reloads user data from the server.
    *
    * Only administrators can checkout other users. If the current logged in user is not an
    * administrator, they can only checkout themselves, otherwise an exception will be thrown.
@@ -300,7 +301,7 @@ export class User {
   }
 
   /**
-   * Update user data on the server.
+   * Updates user data on the server.
    *
    * Only administrators can update other users. If the current logged in user is not an
    * administrator, they can only update themself, otherwise an exception will be thrown.
@@ -323,7 +324,7 @@ export class User {
   }
 
   /**
-   * Delete a user from the server.
+   * Deletes a user from the server.
    *
    * Only administrators can delete users. If the current logged in user is not an
    * administrator, an exception will be thrown.
@@ -331,7 +332,7 @@ export class User {
    * Administrators can delete themselves or other administrators. An administrator can only
    * delete themself if they is not the last administrator.
    *
-   * You need to re-login to continue working after deleting the current logged in user.
+   * You need to re-login after deleting the current logged in user.
    *
    * @returns Returns the raw data of a deleted user.
    */
@@ -354,15 +355,15 @@ export class User {
   }
 
   /**
-   * Save user data changes to the server. Call this method to update user data on the server
-   * after any changes.
+   * Saves user properties changes to the server. Call this method to update user data on the
+   * server after any property changes.
    */
   save(): Promise<this> {
     return this.update(this.data);
   }
 
   /**
-   * Set or remove the user avatar.
+   * Sets or removes the user avatar.
    *
    * Only administrators can set the avatar of other users. If the current logged in user is
    * not an administrator, they can only set their avatar, otherwise an exception will be thrown.
@@ -371,9 +372,9 @@ export class User {
    *   {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}
    *   string,
    *   {@link https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer | ArrayBuffer},
-   *   {@link https://developer.mozilla.org/docs/Web/API/Blob/Blob | Blob} or Web API
-   *   {@link https://developer.mozilla.org/docs/Web/API/File | File} object. Setting the
-   *   `image` to `null` will remove the avatar.
+   *   {@link https://developer.mozilla.org/docs/Web/API/Blob/Blob | Blob} or
+   *   {@link https://developer.mozilla.org/docs/Web/API/File | Web API File} object. Setting
+   *   the `image` to `null` will remove the avatar.
    */
   async setAvatar(image?: BodyInit | null): Promise<this> {
     if (!image) {
@@ -393,7 +394,7 @@ export class User {
   }
 
   /**
-   * Remove the user avatar.
+   * Removes the user avatar.
    *
    * Only administrators can remove the avatar of other users. If the current logged in user is
    * not an administrator, they can only remove their avatar, otherwise an exception will be thrown.
@@ -414,13 +415,13 @@ export class User {
   }
 
   /**
-   * Change the user password.
+   * Changes the user password.
    *
    * Only administrators can change the passwords of other users. If the current logged in user
    * is not an administrator, they can only change their password, otherwise an exception will
    * be thrown.
    *
-   * To change their password, non-administrator users must provide their old password.
+   * To change their password, non-administrator users must specify their old password.
    *
    * @param newPassword - New user password.
    * @param oldPassword - Old user password. Only required for non-administrator users to

package/src/index.ts

@@ -28,6 +28,7 @@ export * from "./Api/ClientEvents";
 export { File } from "./Api/File";
 export { FetchError, statusText } from "./Api/FetchError";
 export { Job } from "./Api/Job";
+export { IModelTransformMatrix } from "./Api/IAssembly";
 export { Member } from "./Api/Member";
 export { Model } from "./Api/Model";
 export { Permission } from "./Api/Permission";