@inweb/client 25.8.16 → 25.8.19

package/lib/Api/Permission.d.ts

@@ -1,16 +1,16 @@
 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 declare class Permission {
     private _data;
     fileId: string;
     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);
     private internalGet;
@@ -19,11 +19,11 @@ export declare 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[];
     set actions(value: string[]);
@@ -53,7 +53,7 @@ export declare class Permission {
      * @property {string} project.name - Project name.
      */
     /**
-     * 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[];
     set grantedTo(value: any[]);
@@ -63,24 +63,24 @@ export declare class Permission {
     get public(): boolean;
     set public(value: boolean);
     /**
-     * Refresh permission data.
+     * Reloads permission data from the server.
      */
     checkout(): Promise<this>;
     /**
-     * Update permission data on the server.
+     * Updates permission data on the server.
      *
      * @param data - Raw permission data.
      */
     update(data: any): Promise<this>;
     /**
-     * Remove a permission from a file.
+     * Removes a permission from the file.
      *
      * @returns Returns the raw data of a deleted permission.
      */
     delete(): Promise<any>;
     /**
-     * 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>;
 }

package/lib/Api/Project.d.ts

@@ -3,14 +3,15 @@ import { IShortUserDescription } from "./IUser";
 import { Role } from "./Role";
 import { Member } from "./Member";
 /**
- * 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 declare class Project {
     private _data;
     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);
     protected internalGet(relativePath: string): Promise<Response>;
@@ -20,11 +21,18 @@ export declare 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[];
+    };
     /**
      * Project creation time (UTC) in the format specified in
      * {@link https://www.wikipedia.org/wiki/ISO_8601 | ISO 8601}.
@@ -100,7 +108,7 @@ export declare class Project {
      */
     get previewUrl(): string;
     /**
-     * `true` if project is public (shared) project.
+     * `true` if project is shared project.
      */
     get public(): boolean;
     set public(value: boolean);
@@ -124,40 +132,40 @@ export declare class Project {
      */
     get updatedAt(): string;
     /**
-     * Refresh project data.
+     * Reloads project data from the server.
      */
     checkout(): Promise<this>;
     /**
-     * Update project data on the server.
+     * Updates project data on the server.
      *
      * @param data - Raw project data.
      */
     update(data: any): Promise<this>;
     /**
-     * Delete the project from the server.
+     * Deletes a project from the server.
      *
      * @returns Returns the raw data of a deleted project.
      */
     delete(): Promise<any>;
     /**
-     * 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>;
     /**
-     * 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.
      */
     setPreview(image?: BodyInit | null): Promise<any>;
     /**
-     * Remove the project preview.
+     * Removes the project preview.
      */
     deletePreview(): Promise<this>;
     /**
@@ -166,13 +174,13 @@ export declare class Project {
      */
     getRoles(): Promise<Role[]>;
     /**
-     * Returns the role information.
+     * Returns information about the specified project role.
      *
      * @param name - Role name.
      */
     getRole(name: string): Promise<Role>;
     /**
-     * Create a new project role.
+     * Creates a new project role.
      *
      * @param name - Role name.
      * @param description - Role description.
@@ -181,7 +189,7 @@ export declare class Project {
      */
     createRole(name: string, description: string, permissions: any): Promise<Role>;
     /**
-     * Delete project role.
+     * Deletes the specified project role.
      *
      * @param name - Role name.
      * @returns Returns the raw data of a deleted role.
@@ -192,7 +200,7 @@ export declare class Project {
      */
     getMembers(): Promise<Member[]>;
     /**
-     * Returns the member information.
+     * Returns information about the specified project member.
      *
      * @param memberId - Member ID.
      */
@@ -201,11 +209,11 @@ export declare 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>;
     /**
-     * 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/lib/Api/Role.d.ts

@@ -1,15 +1,16 @@
 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 declare class Role {
     private _data;
     projectId: string;
     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);
     private internalGet;
@@ -52,24 +53,24 @@ export declare class Role {
     get permissions(): any;
     set permissions(value: any);
     /**
-     * Refresh role data.
+     * Reloads role data from the server.
      */
     checkout(): Promise<this>;
     /**
-     * Update role data on the server.
+     * Updates role data on the server.
      *
      * @param data - Raw role data.
      */
     update(data: any): Promise<this>;
     /**
-     * Delete a role from the project.
+     * Deletes a role from the project.
      *
      * @returns Returns the raw data of a deleted role.
      */
     delete(): Promise<any>;
     /**
-     * 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>;
 }

package/lib/Api/User.d.ts

@@ -1,13 +1,13 @@
 import { IHttpClient } from "./IHttpClient";
 /**
- * The class representing a `user` entity.
+ * Provides properties and methods for obtaining information about a server user and manage its data.
  */
 export declare class User {
     private _data;
     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);
     /**
@@ -18,7 +18,7 @@ export declare class User {
      */
     get avatarUrl(): string;
     /**
-     * `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.
      */
@@ -115,7 +115,8 @@ export declare class User {
     get projectsLimit(): number;
     set projectsLimit(value: number);
     /**
-     * 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
      */
@@ -134,8 +135,8 @@ export declare class User {
      */
     get storageUsed(): number;
     /**
-     * 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
      */
@@ -146,14 +147,14 @@ export declare class User {
     get userName(): string;
     set userName(value: string);
     /**
-     * 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.
      */
     checkout(): Promise<this>;
     /**
-     * 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.
@@ -162,7 +163,7 @@ export declare class User {
      */
     update(data: any): Promise<this>;
     /**
-     * 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.
@@ -170,18 +171,18 @@ export declare 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.
      */
     delete(): Promise<any>;
     /**
-     * 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>;
     /**
-     * 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.
@@ -190,26 +191,26 @@ export declare 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.
      */
     setAvatar(image?: BodyInit | null): Promise<this>;
     /**
-     * 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.
      */
     deleteAvatar(): Promise<this>;
     /**
-     * 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/lib/index.d.ts

@@ -5,6 +5,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";

package/package.json

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