@inweb/client 25.9.3 → 25.9.4

package/dist/client.js

@@ -511,7 +511,7 @@
         /**
          * @param data - Raw test data received from the server.
          * @param basePath - The clash test API base path of the file/assembly that owns the test.
-         * @param httpClient - HTTP client instance used to send REST API requests to the server.
+         * @param httpClient - HTTP client instance used to send requests to the REST API server.
          */
         constructor(data, basePath, httpClient) {
             this.httpClient = httpClient;
@@ -592,14 +592,6 @@
         /**
          * Test owner information.
          *
-         * @property {string} userId - User ID.
-         * @property {string} userName - User name.
-         * @property {string} name - First name.
-         * @property {string} lastName - Last name.
-         * @property {string} fullName - Full name.
-         * @property {string} initials - Initials.
-         * @property {string} email - User email.
-         * @property {string} avatarUrl - User avatar image URL.
          * @readonly
          */
         get owner() {
@@ -751,13 +743,13 @@
     // acknowledge and accept the above terms.
     ///////////////////////////////////////////////////////////////////////////////
     /**
-     * Provides properties and methods for obtaining information about an assembly on the server
-     * and managing its data.
+     * Provides properties and methods for obtaining information about an assembly on the Open
+     * Cloud Server and managing its data.
      */
     class Assembly {
         /**
          * @param data - Raw assembly data received from the server.
-         * @param httpClient - HTTP client instance used to send REST API requests to the server.
+         * @param httpClient - HTTP client instance used to send requests to the REST API server..
          */
         constructor(data, httpClient) {
             this.path = `/assemblies/${data.id}`;
@@ -868,14 +860,6 @@
         /**
          * Assembly owner information.
          *
-         * @property {string} userId - User ID.
-         * @property {string} userName - User name.
-         * @property {string} name - First name.
-         * @property {string} lastName - Last name.
-         * @property {string} fullName - Full name.
-         * @property {string} initials - Initials.
-         * @property {string} email - User email.
-         * @property {string} avatarUrl - User avatar image URL.
          * @readonly
          */
         get owner() {
@@ -1566,7 +1550,7 @@
                 },
             }));
         }
-        async downloadFileRange(relativePath, requestId, ranges, onProgress, signal) {
+        async downloadFileRange(relativePath, reserved, ranges, onProgress, signal) {
             const headers = { ...this.headers };
             headers["Range"] = "bytes=" + ranges.map((x) => `${x.begin}-${x.end}`).join(",");
             const response = await $fetch(`${this.serverUrl}${relativePath}`, { method: "GET", headers, signal });
@@ -1643,7 +1627,7 @@
         /**
          * @param data - Raw permission data received from the server.
          * @param fileId - Owner file ID.
-         * @param httpClient - HTTP client instance used to send REST API requests to the server.
+         * @param httpClient - HTTP client instance used to send requests to the REST API server.
          */
         constructor(data, fileId, httpClient) {
             this.httpClient = httpClient;
@@ -1694,19 +1678,7 @@
             return this.data.id;
         }
         /**
-         * Principials are any entity that can be authenticated by the server, such as a any user or
-         * project that will get access to the file.
-         *
-         * @typedef {any} Principial
-         * @property {any} user - The user entry that get access to the file.
-         * @property {string} user.id - User ID.
-         * @property {string} user.name - User name.
-         * @property {any} project - The project entry that get access to the file.
-         * @property {string} project.id - Project ID.
-         * @property {string} project.name - Project name.
-         */
-        /**
-         * A list of principials that will get access to the file.
+         * A list of entities that will get access to the file.
          */
         get grantedTo() {
             return this.data.grantedTo;
@@ -1781,12 +1753,12 @@
     // acknowledge and accept the above terms.
     ///////////////////////////////////////////////////////////////////////////////
     /**
-     * Provides properties and methods for obtaining information about a job on the server.
+     * Provides properties and methods for obtaining information about a job on the Open Cloud Server.
      */
     class Job {
         /**
          * @param data - Raw job data received from the server.
-         * @param httpClient - HTTP client instance used to send REST API requests to the server.
+         * @param httpClient - HTTP client instance used to send requests to the REST API server.
          */
         constructor(data, httpClient) {
             this.httpClient = httpClient;
@@ -1996,13 +1968,13 @@
     // acknowledge and accept the above terms.
     ///////////////////////////////////////////////////////////////////////////////
     /**
-     * Provides properties and methods for obtaining information about a file on the server and
-     * managing its data and versions.
+     * Provides properties and methods for obtaining information about a file on the Open Cloud
+     * Server and managing its data and versions.
      */
     class File {
         /**
          * @param data - Raw file data received from the server.
-         * @param httpClient - HTTP client instance used to send REST API requests to the server.
+         * @param httpClient - HTTP client instance used to send requests to the REST API server.
          */
         constructor(data, httpClient) {
             this.path = `/files/${data.id}`;
@@ -2166,14 +2138,6 @@
         /**
          * File owner information.
          *
-         * @property {string} userId - User ID.
-         * @property {string} userName - User name.
-         * @property {string} name - First name.
-         * @property {string} lastName - Last name.
-         * @property {string} fullName - Full name.
-         * @property {string} initials - Initials.
-         * @property {string} email - User email.
-         * @property {string} avatarUrl - User avatar image URL.
          * @readonly
          */
         get owner() {
@@ -2242,14 +2206,6 @@
         /**
          * Information about the user who made the last update.
          *
-         * @property {string} userId - User ID.
-         * @property {string} userName - User name.
-         * @property {string} name - First name.
-         * @property {string} lastName - Last name.
-         * @property {string} fullName - Full name.
-         * @property {string} initials - Initials.
-         * @property {string} email - User email.
-         * @property {string} avatarUrl - User avatar image URL.
          * @readonly
          */
         get updatedBy() {
@@ -2679,6 +2635,16 @@
         /**
          * Creates a new file permission.
          *
+         * @example <caption>Grant the specified user permission to "update" the file.</caption>
+         *   const action = "update";
+         *   const grantedTo = [{ user: { id: myUser.id, email: myUser.email } }];
+         *   await file.createPermission(action, grantedTo);
+         *
+         * @example <caption>Add a file to the specified project in `read-only` mode.</caption>
+         *   const actions = ["read", "readSourceFile"];
+         *   const grantedTo = [{ project: { id: myProject.id, name: myProject.name } }];
+         *   await file.createPermission(actions, grantedTo);
+         *
          * @param actions - Actions are allowed to be performed on a file with this permission:
          *
          *   - `read` - The ability to read file description, geometry data and properties.
@@ -2687,7 +2653,7 @@
          *   - `readViewpoint` - The ability to read file viewpoints.
          *   - `createViewpoint` - The ability to create file viewpoints.
          *
-         * @param grantedTo - A list of principials that will get access to the file.
+         * @param grantedTo - A list of entities that will get access to the file.
          * @param _public - Specifies whether all users have access to the file or not.
          */
         createPermission(actions, grantedTo, _public) {
@@ -2868,7 +2834,7 @@
         /**
          * @param data - Raw role data received from the server.
          * @param projectId - Owner project ID.
-         * @param httpClient - HTTP client instance used to send REST API requests to the server.
+         * @param httpClient - HTTP client instance used to send requests to the REST API server.
          */
         constructor(data, projectId, httpClient) {
             this.httpClient = httpClient;
@@ -2915,20 +2881,6 @@
         }
         /**
          * Role actions are allowed to be performed.
-         *
-         * @property {string[]} projectActions - Actions are allowed to be performed at the project
-         *   level: `update`, `createTopic`, `createDocument`.
-         * @property {string[]} topicActions - Actions are allowed to be performed at the topic
-         *   level: `update`, `updateBimSnippet`, `updateRelatedTopics`, `updateDocumentReferences`,
-         *   `updateFiles`, `createComment`, `createViewpoint`, `delete`.
-         * @property {string[]} commentActions - Actions are allowed to be performed at the comment
-         *   level: `update`, `delete`.
-         * @property {string[]} viewpointActions - Actions are allowed to be performed at the
-         *   viewpoint level: `delete`.
-         * @property {string[]} odaGroupActions - Actions are allowed to be performed at the members
-         *   level: `update`, `delete`.
-         * @property {string[]} odaRoleActions - Actions are allowed to be performed at the roles
-         *   level: `update`, `delete`.
          */
         get permissions() {
             return this.data.permissions;
@@ -3001,7 +2953,7 @@
         /**
          * @param data - Raw member data received from the server.
          * @param projectId - Owner project ID.
-         * @param httpClient - HTTP client instance used to send REST API requests to the server.
+         * @param httpClient - HTTP client instance used to send requests to the REST API server.
          */
         constructor(data, projectId, httpClient) {
             this.httpClient = httpClient;
@@ -3040,7 +2992,8 @@
             return this.data.id;
         }
         /**
-         * Member role. See {@link Project.getRoles | Project.getRoles()} for more details.
+         * Member role name in the project. See {@link Project.getRoles | Project.getRoles()} for list
+         * of project roles.
          */
         get role() {
             return this.data.role;
@@ -3059,14 +3012,6 @@
         /**
          * User information.
          *
-         * @property {string} userId - User ID.
-         * @property {string} userName - User name.
-         * @property {string} name - First name.
-         * @property {string} lastName - Last name.
-         * @property {string} fullName - Full name.
-         * @property {string} initials - Initials.
-         * @property {string} email - User email.
-         * @property {string} avatarUrl - User avatar image URL.
          * @readonly
          */
         get user() {
@@ -3130,13 +3075,13 @@
     // acknowledge and accept the above terms.
     ///////////////////////////////////////////////////////////////////////////////
     /**
-     * Provides properties and methods for obtaining information about a project on the server and
-     * managing its {@link Role | roles}, {@link Member | members} and models.
+     * Provides properties and methods for obtaining information about a project on the Open Cloud
+     * Server and managing its {@link Role | roles}, {@link Member | members} and models.
      */
     class Project {
         /**
          * @param data - Raw project data received from the server.
-         * @param httpClient - HTTP client instance used to send REST API requests to the server.
+         * @param httpClient - HTTP client instance used to send requests to the REST API server.
          */
         constructor(data, httpClient) {
             this.httpClient = httpClient;
@@ -3252,14 +3197,6 @@
         /**
          * Project owner information.
          *
-         * @property {string} userId - User ID.
-         * @property {string} userName - User name.
-         * @property {string} name - First name.
-         * @property {string} lastName - Last name.
-         * @property {string} fullName - Full name.
-         * @property {string} initials - Initials.
-         * @property {string} email - User email.
-         * @property {string} avatarUrl - User avatar image URL.
          * @readonly
          */
         get owner() {
@@ -3406,8 +3343,7 @@
          *
          * @param name - Role name.
          * @param description - Role description.
-         * @param permissions - Actions are allowed to be performed. See {@link Role.permissions} for
-         *   more details.
+         * @param permissions - Actions are allowed to be performed for the role.
          */
         createRole(name, description, permissions) {
             return this.internalPost("/roles", {
@@ -3449,7 +3385,7 @@
          * Add a user to the project to become a member and have permission to perform actions.
          *
          * @param userId - User ID.
-         * @param role - Role name from the list of project roles.
+         * @param role - Role name from the list of project {@link getRoles | roles}.
          */
         addMember(userId, role) {
             return this.internalPost("/members", { userId, role })
@@ -3478,8 +3414,11 @@
          * @property {string} file.reference - File ID.
          */
         /**
-         * Returns a list of project files. To add a file to this list, create a `project` permission
-         * on the file using {@link File.createPermission | File.createPermission()}.
+         * Returns a list of project files.
+         *
+         * This list contains all files that the project has access to. To add a file to this list,
+         * create a {@link IGrantedTo.project | project} permission on the file using
+         * {@link File.createPermission | File.createPermission()}.
          */
         getFilesInformation() {
             return this.httpClient
@@ -3548,12 +3487,13 @@
     // acknowledge and accept the above terms.
     ///////////////////////////////////////////////////////////////////////////////
     /**
-     * Provides properties and methods for obtaining information about a server user and manage its data.
+     * Provides properties and methods for obtaining information about a Open Cloud Server user and
+     * manage its data.
      */
     class User {
         /**
          * @param data - Raw user data received from the server.
-         * @param httpClient - HTTP client instance used to send REST API requests to the server.
+         * @param httpClient - HTTP client instance used to send requests to the REST API server.
          */
         constructor(data, httpClient) {
             this.httpClient = httpClient;
@@ -3957,7 +3897,8 @@
     // acknowledge and accept the above terms.
     ///////////////////////////////////////////////////////////////////////////////
     /**
-     * Provides methods for managing server resources such as users, files, assemblies, jobs, projects, etc.
+     * Provides methods for managing Open Cloud Server resources such as users, files, assemblies,
+     * jobs, projects, etc.
      */
     class Client extends EventEmitter2 {
         /**
@@ -3974,7 +3915,7 @@
             this.configure(params);
         }
         /**
-         * Open Cloud Server REST API base URL. Use {@link configure | configure()} to change server URL.
+         * Open Cloud REST API server base URL. Use {@link configure | configure()} to change server URL.
          *
          * @readonly
          */
@@ -3982,7 +3923,7 @@
             return this._serverUrl;
         }
         /**
-         * HTTP client instance used to send REST API requests and receive responses from the server.
+         * HTTP client instance used to send requests to the REST API server.
          *
          * @readonly
          */
@@ -4062,7 +4003,7 @@
                 .then((data) => ({
                 ...data,
                 server: data.version,
-                client: "25.9.3",
+                client: "25.9.4",
             }));
         }
         /**
@@ -4777,7 +4718,7 @@
     // By use of this software, its documentation or related materials, you
     // acknowledge and accept the above terms.
     ///////////////////////////////////////////////////////////////////////////////
-    const version = "25.9.3";
+    const version = "25.9.4";
 
     exports.Assembly = Assembly;
     exports.ClashTest = ClashTest;