@inweb/client 25.8.16 → 25.8.19

package/dist/client.js

@@ -144,13 +144,13 @@
     // acknowledge and accept the above terms.
     ///////////////////////////////////////////////////////////////////////////////
     /**
-     * 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.
      */
     class Model {
         /**
-         * @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, file) {
             this.path = `${file.path}/downloads`;
@@ -263,16 +263,16 @@
             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, transform) {
             return this.file.setModelTransformMatrix(handle, transform).then(() => this);
         }
         /**
-         * Returns model viewpoint list.
+         * Returns a list of viewpoints of the owner file/assembly.
          */
         getViewpoints() {
             return this._file
@@ -280,7 +280,8 @@
                 .then((array) => array.filter(({ custom_fields = {} }) => custom_fields.modelId === this.id || custom_fields.modelName === this.name));
         }
         /**
-         * 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.
          */
@@ -291,7 +292,7 @@
             });
         }
         /**
-         * 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.
@@ -309,7 +310,7 @@
             return this._file.getSnapshot(guid);
         }
         /**
-         * Returns snapshot data.
+         * Returns viewpoint snapshot data.
          *
          * @param guid - Viewpoint GUID.
          * @param bitmapGuid - Bitmap GUID.
@@ -318,8 +319,8 @@
             return this._file.getSnapshotData(guid, bitmapGuid);
         }
         /**
-         * 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.
@@ -331,7 +332,7 @@
             return this._file.downloadResource(dataId, onProgress, signal);
         }
         /**
-         * 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.
@@ -380,7 +381,9 @@
             await this.downloadResourceRange(dataId, requestId, ranges, onProgress, signal);
         }
         /**
-         * 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}
@@ -481,13 +484,13 @@
 
     ///////////////////////////////////////////////////////////////////////////////
     /**
-     * The base class provides information about the file/assembly clash detection test and test results.
+     * Provides properties and methods for obtaining information about a file/assembly clash detection test.
      */
     class ClashTest {
         /**
-         * @param data - Raw test data.
-         * @param basePath - Clash tests API base path for the owner file/assembly.
-         * @param httpClient - Http client.
+         * @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.
          */
         constructor(data, basePath, httpClient) {
             this.httpClient = httpClient;
@@ -506,10 +509,10 @@
         /**
          * The type of the clashes that the test detects:
          *
-         * - `Сlearance clash` (true) - a clash in which the entity A may or may not intersect with
-         *   entity B, but comes within a distance of less than the `tolerance`.
-         * - `Hard clash` (false) - a clash in which the entity A intersects with entity B by a
-         *   distance of more than the `tolerance`.
+         * - `true` - Сlearance clash. A clash in which the object A may or may not intersect with
+         *   object B, but comes within a distance of less than the {@link tolerance}.
+         * - `false` - Hard clash. A clash in which the object A intersects with object B by a distance
+         *   of more than the {@link tolerance}.
          *
          * @readonly
          */
@@ -582,8 +585,8 @@
             return this.data.owner;
         }
         /**
-         * First selection set for clash detection. Entities from `selectionSetA` will be tested
-         * against each others by entities from the `selectionSetB` during the test.
+         * First selection set for clash detection. Objects from `selectionSetA` will be tested
+         * against each others by objects from the `selectionSetB` during the test.
          *
          * @readonly
          */
@@ -593,10 +596,10 @@
         /**
          * The type of first selection set for clash detection. Can be one of:
          *
-         * - `all` - All file/assembly entities.
-         * - `handle` - Entities with handles specified in the `selectionSetA`.
-         * - `models` - Entities of file/assembly models specified in `selectionSetA`.
-         * - `searchquery` - Entities retrieved by the search queries specified in `selectionSetA`.
+         * - `all` - All file/assembly objects.
+         * - `handle` - Objects with original handles specified in the `selectionSetA`.
+         * - `models` - All objects of the models with original handles specified in the `selectionSetA`.
+         * - `searchquery` - Objects retrieved by the search queries specified in `selectionSetA`.
          *
          * @readonly
          */
@@ -604,8 +607,8 @@
             return this.data.selectionTypeA;
         }
         /**
-         * Second selection set for clash detection. Entities from `selectionSetB` will be tested
-         * against each others by entities from the `selectionSetA` during the test.
+         * Second selection set for clash detection. Objects from `selectionSetB` will be tested
+         * against each others by objects from the `selectionSetA` during the test.
          *
          * @readonly
          */
@@ -615,10 +618,10 @@
         /**
          * The type of second selection set for clash detection. Can be one of:
          *
-         * - `all` - All file/assembly entities.
-         * - `handle` - Entities with handles specified in the `selectionSetB`.
-         * - `models` - Entities of file/assembly models specified in `selectionSetB`.
-         * - `searchquery` - Entities retrieved by the search queries specified in `selectionSetB`.
+         * - `all` - All file/assembly objects.
+         * - `handle` - Objects with original handles specified in the `selectionSetB`.
+         * - `models` - All objects of the models with original handles specified in the `selectionSetB`.
+         * - `searchquery` - Objects retrieved by the search queries specified in `selectionSetB`.
          *
          * @readonly
          */
@@ -634,7 +637,7 @@
             return this.data.status;
         }
         /**
-         * The distance of separation between entities at which test begins detecting clashes.
+         * The distance of separation between objects at which test begins detecting clashes.
          *
          * @readonly
          */
@@ -642,7 +645,7 @@
             return this.data.tolerance;
         }
         /**
-         * Refresh test data.
+         * Reloads test data from the server.
          */
         async checkout() {
             const response = await this.internalGet("");
@@ -650,7 +653,7 @@
             return this;
         }
         /**
-         * Update test data on the server.
+         * Updates test data on the server.
          *
          * @param data - Raw test data.
          */
@@ -660,7 +663,7 @@
             return this;
         }
         /**
-         * Remove a test from a file.
+         * Deletes a test and its results report from the server.
          *
          * @returns Returns the raw data of a deleted test.
          */
@@ -668,14 +671,14 @@
             return this.internalDelete("").then((response) => response.json());
         }
         /**
-         * Save test data changes to the server. Call this method to update test data on the server
-         * after any changes.
+         * Saves test properties changes to the server. Call this method to update test data on the
+         * server after any property changes.
          */
         save() {
             return this.update(this.data);
         }
         /**
-         * Wait for test to complete. Test is done when it changes to `done` or `failed` status.
+         * Waits for test to complete. Test is done when it changes to `done` or `failed` status.
          *
          * @param params - An object containing waiting parameters.
          * @param params.timeout - The time, in milliseconds that the function should wait test. If
@@ -685,9 +688,15 @@
          * @param params.signal - An
          *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
          *   signal, which can be used to abort waiting as desired.
+         * @param params.onCheckout - Waiting progress callback. Return `true` to cancel waiting.
          */
         waitForDone(params) {
-            const checkDone = () => this.checkout().then((test) => ["done", "failed"].includes(test.status));
+            const checkDone = () => this.checkout().then((test) => {
+                var _a;
+                const ready = ["done", "failed"].includes(test.status);
+                const cancel = (_a = params === null || params === void 0 ? void 0 : params.onCheckout) === null || _a === void 0 ? void 0 : _a.call(params, test, ready);
+                return cancel || ready;
+            });
             return waitFor(checkDone, params).then(() => this);
         }
         /**
@@ -700,12 +709,13 @@
 
     ///////////////////////////////////////////////////////////////////////////////
     /**
-     * The class representing a `assembly` entity.
+     * Provides properties and methods for obtaining information about an assembly on the server
+     * and managing its data.
      */
     class Assembly {
         /**
-         * @param data - An object that implements assembly data storage.
-         * @param httpClient - Http client.
+         * @param data - Raw assembly data received from the server.
+         * @param httpClient - HTTP client instance used to send REST API requests to the server.
          */
         constructor(data, httpClient) {
             this.path = `/assemblies/${data.id}`;
@@ -785,9 +795,9 @@
         /**
          * Assembly geometry data type:
          *
-         * - `vsfx` - VSFX, assembly can be opened in `VisualizeJS` viewer.
+         * - `vsfx` - `VSFX` format, assembly can be opened in `VisualizeJS` viewer.
          *
-         * Returns an empty string if geometry data has not yet been extracted.
+         * Returns an empty string if the geometry data is not yet ready.
          */
         get geometryType() {
             return this.status === "done" ? "vsfx" : "";
@@ -867,7 +877,7 @@
             return this.data.versions;
         }
         /**
-         * Refresh assembly data.
+         * Reloads assembly data from the server.
          */
         async checkout() {
             const response = await this.internalGet("");
@@ -885,7 +895,7 @@
             return this;
         }
         /**
-         * Delete the assembly from the server.
+         * Deletes an assembly from the server.
          *
          * @returns Returns the raw data of a deleted assembly.
          */
@@ -893,8 +903,8 @@
             return this.internalDelete("").then((response) => response.json());
         }
         /**
-         * Save assembly data changes to the server. Call this method to update assembly data on the
-         * server after any changes.
+         * Saves assembly properties changes to the server. Call this method to update assembly data
+         * on the server after any property changes.
          */
         save() {
             return this.update(this.data);
@@ -916,35 +926,19 @@
                 .then((response) => response.json())
                 .then((array) => array.map((data) => new Model(data, this)));
         }
-        /**
-         * Transformation matrix.
-         *
-         * @typedef {any} Transform
-         * @property {any} translate - Translation part, move along the X, Y, Z axes.
-         * @property {number} translate.x - The value for substruct for X axes.
-         * @property {number} translate.y - The value for substruct for Y axes.
-         * @property {number} translate.z - The value for substruct for Z axes.
-         * @property {any} rotation - Rotation part, rotate by the specified angle, around the
-         *   specified vector.
-         * @property {number} rotation.x - X coordinate of the rotation vector.
-         * @property {number} rotation.y - Y coordinate of the rotation vector.
-         * @property {number} rotation.z - Z coordinate of the rotation vector.
-         * @property {number} rotation.angle - The angle of rotation.
-         * @property {number} scale - Scaling part, scale with multiplier, from center of extends.
-         */
         /**
          * Returns a model transformation.
          *
-         * @param handle - Model handle.
+         * @param handle - Model original handle.
          */
         getModelTransformMatrix(handle) {
             return this.data.transform[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 handle - Model original handle.
+         * @param transform - Transformation matrix. Specify `undefined` to remove transformation.
          */
         setModelTransformMatrix(handle, transform) {
             const obj = { ...this.data.transform };
@@ -954,8 +948,8 @@
         /**
          * Returns the properties for an objects in the assembly.
          *
-         * @param handles - Object original handle or handles array. Leave this parameter undefined
-         *   to get properties for all objects in the assembly.
+         * @param handles - Object original handle or handles array. Specify `undefined` to get
+         *   properties for all objects in the assembly.
          * @returns {Promise<any>}
          */
         getProperties(handles) {
@@ -991,7 +985,7 @@
             return this.internalPost("/properties/search", searchPattern).then((response) => response.json());
         }
         /**
-         * Returns the cda.json for an assembly.
+         * Returns the CDA tree for an assembly.
          */
         getCdaTree() {
             return this.internalGet(`/properties/tree`).then((response) => response.json());
@@ -1005,7 +999,7 @@
                 .then((viewpoints) => viewpoints.result);
         }
         /**
-         * Add new assembly viewpoint. To create a viewpoint use `Viewer.createViewpoint()`.
+         * Adds a new viewpoint to the assembly. To create a viewpoint use `Viewer.createViewpoint()`.
          *
          * @param viewpoint - Viewpoint.
          */
@@ -1013,7 +1007,7 @@
             return this.internalPost("/viewpoints", viewpoint).then((response) => response.json());
         }
         /**
-         * Delete assembly viewpoint.
+         * Deletes the specified assembly viewpoint.
          *
          * @param guid - Viewpoint GUID.
          * @returns Returns the raw data of a deleted viewpoint.
@@ -1040,7 +1034,7 @@
             return this.internalGet(`/viewpoints/${guid}/bitmaps/${bitmapGuid}`).then((response) => response.text());
         }
         /**
-         * Download assembly resource file. Resource files are files that contain model scene
+         * Downloads an assembly resource file. Resource files are files that contain model scene
          * descriptions, or geometry data.
          *
          * @param dataId - Resource file name.
@@ -1056,7 +1050,7 @@
                 .then((response) => response.arrayBuffer());
         }
         /**
-         * Download a part of assembly resource file. Resource files are files that contain model
+         * Downloads a part of assembly resource file. Resource files are files that contain model
          * scene descriptions, or geometry data.
          *
          * @param dataId - Resource file name.
@@ -1093,7 +1087,7 @@
             return Promise.resolve({ fileId: "", references: [] });
         }
         /**
-         * Wait for assembly to be created. Assembly is created when it changes to `done` or `failed` status.
+         * Waits for assembly to be created. Assembly is created when it changes to `done` or `failed` status.
          *
          * @param params - An object containing waiting parameters.
          * @param params.timeout - The time, in milliseconds that the function should wait assembly.
@@ -1117,15 +1111,13 @@
         /**
          * Returns a list of assembly clash tests.
          *
-         * @param {number} start - The starting index in the test list. Used for paging.
-         * @param {number} limit - The maximum number of tests that should be returned per request.
-         *   Used for paging.
-         * @param {string} name - Filter the tests by part of the name.
-         * @param {string | string[]} ids - List of tests IDs to return. You can specify multiple IDs
-         *   on one `string` by separating them with a "|".
-         * @param {bool} sortByDesc - Allows to specify the descending order of the result. By
-         *   default tests are sorted by name in ascending order.
-         * @param {string} sortField - Allows to specify sort field.
+         * @param start - The starting index in the test list. Used for paging.
+         * @param limit - The maximum number of tests that should be returned per request. Used for paging.
+         * @param name - Filter the tests by part of the name. Case sensitive.
+         * @param ids - List of tests IDs to return.
+         * @param sortByDesc - Allows to specify the descending order of the result. By default tests
+         *   are sorted by name in ascending order.
+         * @param sortField - Allows to specify sort field.
          */
         getClashTests(start, limit, name, ids, sortByDesc, sortField) {
             const searchParams = new URLSearchParams();
@@ -1160,7 +1152,7 @@
             });
         }
         /**
-         * Returns the assembly clash test information.
+         * Returns information about the specified assembly clash test.
          *
          * @param testId - Test ID.
          */
@@ -1170,20 +1162,39 @@
                 .then((data) => new ClashTest(data, this.path, this.httpClient));
         }
         /**
-         * Create assembly clash test. Assembly must be in a `done` state, otherwise the test will fail.
+         * Creates an assembly clash test. Assembly must be in a `done` state, otherwise the test will fail.
          *
          * @param name - Test name.
-         * @param selectionTypeA - The type of first selection set for clash detection. Can be `all`,
-         *   `handles`, `models` or `searchquery`.
-         * @param selectionTypeB - The type of second selection set for clash detection. Can be
-         *   `all`, `handles`, `models` or `searchquery`.
-         * @param selectionSetA - First selection set for clash detection.
-         * @param selectionSetB - Second selection set for clash detection.
+         * @param selectionTypeA - The type of first selection set for clash detection. Can be one of:
+         *
+         *   - `all` - All file/assembly objects.
+         *   - `handle` - Objects with original handles specified in the `selectionSetA`.
+         *   - `models` - All objects of the models with original handles specified in the `selectionSetA`.
+         *   - `searchquery` - Objects retrieved by the search queries specified in `selectionSetA`.
+         *
+         * @param selectionTypeB - The type of second selection set for clash detection. Can be one of:
+         *
+         *   - `all` - All file/assembly objects.
+         *   - `handle` - Objects with original handles specified in the `selectionSetB`.
+         *   - `models` - All objects of the models with original handles specified in the `selectionSetB`.
+         *   - `searchquery` - Objects retrieved by the search queries specified in `selectionSetB`.
+         *
+         * @param selectionSetA - First selection set for clash detection. Objects from
+         *   `selectionSetA` will be tested against each others by objects from the `selectionSetB`
+         *   during the test.
+         * @param selectionSetB - Second selection set for clash detection. Objects from
+         *   `selectionSetB` will be tested against each others by objects from the `selectionSetA`
+         *   during the test.
          * @param params - An object containing test parameters.
-         * @param params.tolerance - The distance of separation between entities at which test begins
+         * @param params.tolerance - The distance of separation between objects at which test begins
          *   detecting clashes.
-         * @param params.clearance - The type of the clashes that the test detects: `true` for
-         *   `Сlearance clash` or `false` for `Hard clash`.
+         * @param params.clearance - The type of the clashes that the test detects:
+         *
+         *   - `true` - Сlearance clash. A clash in which the object A may or may not intersect with
+         *       object B, but comes within a distance of less than the `tolerance`.
+         *   - `false` - Hard clash. A clash in which the object A intersects with object B by a distance
+         *       of more than the `tolerance`.
+         *
          * @param params.waitForDone - Wait for test to complete.
          * @param params.timeout - The time, in milliseconds that the function should wait test. If
          *   test is not complete during this time, the `TimeoutError` exception will be thrown.
@@ -1213,7 +1224,7 @@
                 .then((result) => (waitForDone ? result.waitForDone(params) : result));
         }
         /**
-         * Delete assembly clash test.
+         * Deletes the specified assembly clash test.
          *
          * @param testId - Test ID.
          * @returns Returns the raw data of a deleted test.
@@ -1520,14 +1531,14 @@
     // acknowledge and accept the above terms.
     ///////////////////////////////////////////////////////////////////////////////
     /**
-     * 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}.
      */
     class Permission {
         /**
-         * @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, fileId, httpClient) {
             this.httpClient = httpClient;
@@ -1546,11 +1557,11 @@
         /**
          * 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() {
             return this.data.actions;
@@ -1590,7 +1601,7 @@
          * @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() {
             return this.data.grantedTo;
@@ -1608,7 +1619,7 @@
             this.data.public = value;
         }
         /**
-         * Refresh permission data.
+         * Reloads permission data from the server.
          */
         async checkout() {
             const response = await this.internalGet();
@@ -1616,7 +1627,7 @@
             return this;
         }
         /**
-         * Update permission data on the server.
+         * Updates permission data on the server.
          *
          * @param data - Raw permission data.
          */
@@ -1626,7 +1637,7 @@
             return this;
         }
         /**
-         * Remove a permission from a file.
+         * Removes a permission from the file.
          *
          * @returns Returns the raw data of a deleted permission.
          */
@@ -1634,8 +1645,8 @@
             return this.internalDelete().then((response) => response.json());
         }
         /**
-         * 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() {
             return this.update(this.data);
@@ -1644,13 +1655,12 @@
 
     ///////////////////////////////////////////////////////////////////////////////
     /**
-     * The class representing a `job` entity describes the process of converting a file from one
-     * format to another, to obtain geometric data, validate the file, or run a clash test.
+     * Provides properties and methods for obtaining information about a job on the server.
      */
     class Job {
         /**
-         * @param data - An object that implements job data storage.
-         * @param httpClient - Http client.
+         * @param data - Raw job data received from the server.
+         * @param httpClient - HTTP client instance used to send REST API requests to the server.
          */
         constructor(data, httpClient) {
             this.httpClient = httpClient;
@@ -1777,7 +1787,7 @@
             return this.data.startedAt;
         }
         /**
-         * Refresh job data.
+         * Reloads job data from the server.
          */
         async checkout() {
             const response = await this.internalGet();
@@ -1785,7 +1795,7 @@
             return this;
         }
         /**
-         * Update job data on the server.
+         * Updates job data on the server.
          *
          * Only administrators can update job data. If the current logged in user is not an
          * administrator, an exception will be thrown.
@@ -1798,7 +1808,7 @@
             return this;
         }
         /**
-         * Remove a job from the server job list. Jobs that are in progress or have already been
+         * Deletes a job from the server job list. Jobs that are in progress or have already been
          * completed cannot be deleted.
          *
          * @returns Returns the raw data of a deleted job.
@@ -1807,17 +1817,14 @@
             return this.internalDelete().then((response) => response.json());
         }
         // /**
-        //  * Save job data changes to the server. Call this method to update job data on the server
-        //  * after any changes.
-        //  *
-        //  *
-        //  * @returns {Promise<Job>}
+        //  * Save job properties changes to the server. Call this method to update job data on the server
+        //  * after any property changes.
         //  */
         // save() {
         //   return this.update(this.data);
         // }
         /**
-         * Wait for job to be done. Job is done when it changes to `done` or `failed` status.
+         * Waits for job to be done. Job is done when it changes to `done` or `failed` status.
          *
          * @param params - An object containing waiting parameters.
          * @param params.timeout - The time, in milliseconds that the function should wait job. If
@@ -1842,12 +1849,13 @@
 
     ///////////////////////////////////////////////////////////////////////////////
     /**
-     * The class representing a `file` entity.
+     * Provides properties and methods for obtaining information about a file on the server and
+     * managing its data and versions.
      */
     class File {
         /**
-         * @param data - An object that implements file data storage.
-         * @param httpClient - Http client for API.
+         * @param data - Raw file data received from the server.
+         * @param httpClient - HTTP client instance used to send REST API requests to the server.
          */
         constructor(data, httpClient) {
             this.path = `/files/${data.id}`;
@@ -1944,8 +1952,9 @@
             (_m = (_w = this._data).isFileDeleted) !== null && _m !== void 0 ? _m : (_w.isFileDeleted = false);
         }
         /**
-         * Returns a list of files in different formats in which the active version of the file was
-         * exported. To export file to one of the supported formats create File Converter job using
+         * Returns a list of file formats in which the active version of the file was exported.
+         *
+         * To export file to one of the supported formats create File Converter job using
          * {@link createJob | createJob()}. To download exported file use
          * {@link downloadResource | downloadResource()}.
          *
@@ -1957,10 +1966,10 @@
         /**
          * Geometry data type of the active file version. Can be one of:
          *
-         * - `vsfx` - `VSFX`, file can be opened in `VisualizeJS` viewer.
-         * - `gltf` - `glTF`, file can be opened in `Three.js` viewer.
+         * - `vsfx` - `VSFX` format, file can be opened in `VisualizeJS` viewer.
+         * - `gltf` - `glTF` format, file can be opened in `Three.js` viewer.
          *
-         * Returns an empty string if geometry data has not yet been extracted. A files without
+         * Returns an empty string if geometry data has not yet been converted. A files without
          * geometry data can be exported to other formas, but cannot be opened in viewer.
          */
         get geometryType() {
@@ -1980,7 +1989,10 @@
             return this.data.id;
         }
         /**
-         * Returns `true` if source of the active file version has been deleted.
+         * Returns `true` if the source file of the active file version has been deleted.
+         *
+         * A files with deleted source file can be opened in the viewer, but cannot be exported to
+         * other formats.
          *
          * @readonly
          */
@@ -2038,7 +2050,7 @@
             return this.data.size;
         }
         /**
-         * Total size of all versions of the file in the storage in bytes.
+         * Total size of all versions of the file in bytes.
          *
          * @readonly
          */
@@ -2048,8 +2060,8 @@
         /**
          * Data status of the active version of the file. Contains:
          *
-         * - `geometry` - status of geometry data of `VSFX` type.
-         * - `geometryGltf` - status of geometry data of `glTF` type.
+         * - `geometry` - status of geometry data of `vsfx` type.
+         * - `geometryGltf` - status of geometry data of `gltf` type.
          * - `properties` - status of properties.
          * - `validation` - status of validation.
          *
@@ -2111,7 +2123,7 @@
             return this.data.versions;
         }
         /**
-         * Refresh file data.
+         * Reloads file data from the server.
          */
         async checkout() {
             const response = await this.internalGet("");
@@ -2119,7 +2131,7 @@
             return this;
         }
         /**
-         * Update file data on the server.
+         * Updates file data on the server.
          *
          * @param data - Raw file data.
          */
@@ -2129,7 +2141,10 @@
             return this;
         }
         /**
-         * Delete the file and all its versions from the server.
+         * Deletes a file and all its versions from the server.
+         *
+         * You cannot delete a version file using `delete()`, only the original file. To delete a
+         * version file use {@link deleteVersion | deleteVersion()}.
          *
          * @returns Returns the raw data of a deleted file.
          */
@@ -2137,22 +2152,22 @@
             return this.internalDelete("").then((response) => response.json());
         }
         /**
-         * Save file data changes to the server. Call this method to update file data on the server
-         * after any changes.
+         * Saves file properties changes to the server. Call this method to update file data on the
+         * server after any property changes.
          */
         save() {
             return this.update(this.data);
         }
         /**
-         * Set or remove the file preview.
+         * Sets or removes the file preview.
          *
-         * @param image - Preview image.Can be a
+         * @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) {
             if (!image) {
@@ -2165,7 +2180,7 @@
             return this;
         }
         /**
-         * Remove the file preview.
+         * Removes the file preview.
          */
         async deletePreview() {
             const response = await this.internalDelete("/preview");
@@ -2198,8 +2213,8 @@
         /**
          * Returns the properties for an objects in the active version of the file.
          *
-         * @param handles - Object original handle or handles array. Leave this parameter `undefined`
-         *   to get properties for all objects in the file.
+         * @param handles - Object original handle or handles array. Specify `undefined` to get
+         *   properties for all objects in the file.
          */
         getProperties(handles) {
             const relativePath = handles !== undefined ? `/properties?handles=${handles}` : "/properties";
@@ -2242,7 +2257,7 @@
          *     ],
          *   };
          *
-         * @param {SearchPattern | QueryOperator} searchPattern - Search pattern or combination of
+         * @param {SeacrhPattern | QueryOperator} searchPattern - Search pattern or combination of
          *   the patterns, see example below.
          * @returns {Promise<Properties[]>}
          */
@@ -2250,7 +2265,7 @@
             return this.internalPost("/properties/search", searchPattern).then((response) => response.json());
         }
         /**
-         * Returns the cda.json for an active version of the file.
+         * Returns the CDA tree for an active version of the file.
          */
         getCdaTree() {
             return this.internalGet(`/properties/tree`).then((response) => response.json());
@@ -2264,7 +2279,7 @@
                 .then((viewpoints) => viewpoints.result);
         }
         /**
-         * Add new file viewpoint. To create a viewpoint use `Viewer.createViewpoint()`.
+         * Adds a new viewpoint to the file. To create a viewpoint use `Viewer.createViewpoint()`.
          *
          * @param viewpoint - Viewpoint.
          */
@@ -2272,7 +2287,7 @@
             return this.internalPost("/viewpoints", viewpoint).then((response) => response.json());
         }
         /**
-         * Delete file viewpoint.
+         * Deletes the specified file viewpoint.
          *
          * @param guid - Viewpoint GUID.
          * @returns Returns the raw data of a deleted viewpoint.
@@ -2299,7 +2314,7 @@
             return this.internalGet(`/viewpoints/${guid}/bitmaps/${bitmapGuid}`).then((response) => response.text());
         }
         /**
-         * Download source of active version of the file.
+         * Downloads the source file of active version of the file from the server.
          *
          * @param onProgress - Download progress callback.
          * @param signal - An
@@ -2313,7 +2328,7 @@
                 .then((response) => response.arrayBuffer());
         }
         /**
-         * Download a resource file of the active version of the file. Resource files are files that
+         * Downloads a resource file of the active version of the file. Resource files are files that
          * contain model scene descriptions, or geometry data, or exported files.
          *
          * @example <caption>Export file to DWG.</caption>
@@ -2338,7 +2353,7 @@
                 .then((response) => response.arrayBuffer());
         }
         /**
-         * Download a part of resource file of the active version of the file. Resource files are
+         * Downloads a part of resource file of the active version of the file. Resource files are
          * files that contain model scene descriptions, or geometry data, or exported files.
          *
          * @param dataId - Resource file name.
@@ -2373,7 +2388,9 @@
             await this.downloadResourceRange(dataId, requestId, records, onProgress, signal);
         }
         /**
-         * Returns a list of references to files used to correct rendering of the current file.
+         * Returns a list of file references.
+         *
+         * 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}
@@ -2383,7 +2400,10 @@
             return this.internalGet("/references", signal).then((response) => response.json());
         }
         /**
-         * Set the file references.
+         * Sets the file references.
+         *
+         * References are images, fonts, or any other files to correct rendering of the file.
+         * Reference files must be uploaded to the server before they can be assigned to the current file.
          *
          * @param references - File references.
          */
@@ -2391,14 +2411,14 @@
             return this.internalPut("/references", references).then((response) => response.json());
         }
         /**
-         * Create a new job for the active version of the file.
+         * Runs a new job on the server for the active version of the file.
          *
          * @param outputFormat - The job type. Can be one of:
          *
-         *   - `geometry` - Extract file geometry data into `VSFX`.
-         *   - `geometryGltf` - Extract file geometry data into `glTF`.
+         *   - `geometry` - Convert file geometry data to `VSFX` format suitable for `VisualizeJS` viewer.
+         *   - `geometryGltf` - Convert file geometry data to `glTF` format suitable for `Three.js` viewer.
          *   - `properties` - Extract file properties.
-         *   - `validation` - Validate the file. Only for `IFC`.
+         *   - `validation` - Validate the file. Only for `IFC` files.
          *   - `dwg`, `obj`, `gltf`, `glb`, `vsf`, `pdf`, `3dpdf` - Export file to the one of the
          *       supported format. Use {@link exports | exports()} to get the list of completed file
          *       exports. Use {@link downloadResource | downloadResource()} to download the exported file.
@@ -2420,13 +2440,13 @@
                 .then((data) => new Job(data, this.httpClient));
         }
         /**
-         * Create job to extract geometry data of active version of the file. This is alias to
+         * Runs a job to convert geometry data of active version of the file. This is alias to
          * {@link createJob | createJob("geometry")}.
          *
          * @param type - Geometry data type. Can be one of:
          *
-         *   - `vsfx` - `VSFX` (default), for opening a file in `VisualizeJS` viewer.
-         *   - `gltf` - `glTF`, for opening a file in `Three.js` viewer.
+         *   - `vsfx` - `VSFX` format (default), for opening a file in `VisualizeJS` viewer.
+         *   - `gltf` - `glTF` format, for opening a file in `Three.js` viewer.
          *
          * @param parameters - Parameters for the job runner. Can be given as command line arguments
          *   for the File Converter tool in form `--arg=value`.
@@ -2435,7 +2455,7 @@
             return this.createJob(type === "gltf" ? "geometryGltf" : "geometry", parameters);
         }
         /**
-         * Create job to extract properties of the active version of the file. This is alias to
+         * Runs a job to extract properties of the active version of the file. This is alias to
          * {@link createJob | createJob("properties")}.
          *
          * @param parameters - Parameters for the job runner. Can be given as command line arguments
@@ -2445,7 +2465,7 @@
             return this.createJob("properties", parameters);
         }
         /**
-         * Create a job to validate the active version of the file. This is alias to
+         * Runs a job to validate the active version of the file. This is alias to
          * {@link createJob | createJob("validation")}.
          *
          * To get validation report use {@link downloadResource | downloadResource("validation_report.json")}.
@@ -2457,8 +2477,8 @@
             return this.createJob("validation", parameters);
         }
         /**
-         * Wait for jobs of the active version of the file to be done. Job is done when it changes to
-         * `none`, `done` or `failed` status.
+         * Waits for jobs of the active version of the file to be done. Job is done when it changes
+         * to `none`, `done` or `failed` status.
          *
          * @param jobs - Job or job array to wait on. Can be `geometry`, `geometryGltf`,
          *   `properties`, `validation`, `dwg`, `obj`, `gltf`, `glb`, `vsf`, `pdf`, `3dpdf` or custom
@@ -2500,7 +2520,7 @@
                 .then((array) => array.map((data) => new Permission(data, this.id, this.httpClient)));
         }
         /**
-         * Returns the permission information.
+         * Returns information about specified file permission.
          *
          * @param permissionId - Permission ID.
          */
@@ -2510,10 +2530,16 @@
                 .then((data) => new Permission(data, this.id, this.httpClient));
         }
         /**
-         * Create a new file permission.
+         * Creates a new file permission.
+         *
+         * @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.
+         *   - `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.
          *
-         * @param actions - Actions are allowed to be performed on a file with this permission. See
-         *   {@link Permission.actions} for more details.
          * @param grantedTo - A collection of principials that will get access to the file.
          * @param _public - Specifies whether all users have access to the file or not.
          */
@@ -2527,7 +2553,7 @@
                 .then((data) => new Permission(data, this.id, this.httpClient));
         }
         /**
-         * Delete file permission.
+         * Removes the specified permission from the file.
          *
          * @param permissionId - Permission ID.
          * @returns Returns the raw data of a deleted permission.
@@ -2536,14 +2562,15 @@
             return this.internalDelete(`/permissions/${permissionId}`).then((response) => response.json());
         }
         /**
-         * Upload the new version of the file to the server and extract the geometry and properties as needed.
+         * Uploads the new version of the file to the server, convert the geometry data and extract
+         * properties as needed.
          *
-         * @param file - Web API {@link https://developer.mozilla.org/docs/Web/API/File | File} object
+         * @param file - {@link https://developer.mozilla.org/docs/Web/API/File | Web API File} object
          *   are generally retrieved from a
          *   {@link https://developer.mozilla.org/docs/Web/API/FileList | FileList} object returned as
          *   a result of a user selecting files using the HTML `<input>` element.
          * @param params - An object containing upload parameters.
-         * @param params.geometry - Create job to extract file geometry data. The geometry data type
+         * @param params.geometry - Create job to convert file geometry data. The geometry data type
          *   is the same as the original file.
          * @param params.properties - Create job to extract file properties.
          * @param params.waitForDone - Wait for geometry and properties jobs to complete.
@@ -2596,7 +2623,7 @@
                 .then((files) => files.map((file) => (file.id == file.originalFileId ? file.useVersion(0) : file)));
         }
         /**
-         * Returns the version file.
+         * Returns information about the specified version file.
          *
          * @param version - Desired version.
          */
@@ -2607,7 +2634,7 @@
                 .then((file) => (file.id == file.originalFileId ? file.useVersion(0) : file));
         }
         /**
-         * Delete version file.
+         * Deletes the specified version file.
          *
          * @param version - Version to delete.
          */
@@ -2618,7 +2645,7 @@
             return data;
         }
         /**
-         * Replace the active version of the file with the selected version.
+         * Replaces the active version of the file with the selected version.
          *
          * @param version - Desired active version.
          */
@@ -2626,34 +2653,36 @@
             return this.update({ activeVersion: version });
         }
         /**
-         * Use given version instead of active version for current file on client side. This version
-         * change will affect the result:
-         *
-         * - getModels()
-         * - getProperties()
-         * - searchProperties()
-         * - getCdaTree()
-         * - download()
-         * - downloadResource()
-         * - createJob()
-         * - extractGeometry()
-         * - extractProperties()
-         * - validate()
-         * - waitForDone()
+         * Makes the given version active on client side. Does not change the active file version on
+         * the server.
+         *
+         * This version change will affect the result:
+         *
+         * - {@link getModels | getModels()}
+         * - {@link getProperties | getProperties()}
+         * - {@link searchProperties | searchProperties()}
+         * - {@link getCdaTree | getCdaTree()}
+         * - {@link download | download()}
+         * - {@link downloadResource | downloadResource()}
+         * - {@link createJob | createJob()}
+         * - {@link extractGeometry | extractGeometry()}
+         * - {@link extractProperties | extractProperties()}
+         * - {@link validate | validate()}
+         * - {@link waitForDone | waitForDone()}
          * - Viewer.open()
          *
          * Other clients will still continue to use the current active version of the file. Use
          * `undefined` to revert back to the active version.
          *
-         * Note. You need to update the file data using {@link checkout | checkout()} to match the
-         * size and status fields to the version you selected.
+         * You need to reload the file data using {@link checkout | checkout()} to match the size and
+         * status fields to the version you selected.
          */
         useVersion(version) {
             this._useVersion = version;
             return this;
         }
         /**
-         * Delete the source of the active file version.
+         * Deletes the source file of the active file version from the server.
          */
         async deleteSource() {
             const response = await this.internalDelete("/source");
@@ -2685,13 +2714,14 @@
     // acknowledge and accept the above terms.
     ///////////////////////////////////////////////////////////////////////////////
     /**
-     * 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}.
      */
     class Role {
         /**
-         * @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, projectId, httpClient) {
             this.httpClient = httpClient;
@@ -2760,7 +2790,7 @@
             this.data.permissions = value || {};
         }
         /**
-         * Refresh role data.
+         * Reloads role data from the server.
          */
         async checkout() {
             const response = await this.internalGet();
@@ -2768,7 +2798,7 @@
             return this;
         }
         /**
-         * Update role data on the server.
+         * Updates role data on the server.
          *
          * @param data - Raw role data.
          */
@@ -2778,7 +2808,7 @@
             return this;
         }
         /**
-         * Delete a role from the project.
+         * Deletes a role from the project.
          *
          * @returns Returns the raw data of a deleted role.
          */
@@ -2786,8 +2816,8 @@
             return this.internalDelete().then((response) => response.json());
         }
         /**
-         * 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() {
             return this.update(this.data);
@@ -2796,13 +2826,14 @@
 
     ///////////////////////////////////////////////////////////////////////////////
     /**
-     * Members are the {@link User | users} who have access to the {@link Project | project}.
+     * Provides properties and methods for obtaining information about a {@link User | user} who has
+     * access to the {@link Project | project}.
      */
     class Member {
         /**
-         * @param data - An object that implements member data storage.
+         * @param data - Raw member 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, projectId, httpClient) {
             this.httpClient = httpClient;
@@ -2874,7 +2905,7 @@
             return this.data.user;
         }
         /**
-         * Refresh member data.
+         * Reloads member data from the server.
          */
         async checkout() {
             const response = await this.internalGet();
@@ -2882,7 +2913,7 @@
             return this;
         }
         /**
-         * Update member data on the server.
+         * Updates member data on the server.
          *
          * @param data - Raw member data.
          */
@@ -2892,7 +2923,7 @@
             return this;
         }
         /**
-         * Remove a member from a project.
+         * Removes a member from the project.
          *
          * @returns Returns the raw data of a deleted member.
          */
@@ -2900,8 +2931,8 @@
             return this.internalDelete().then((response) => response.json());
         }
         /**
-         * Save member data changes to the server. Call this method to update member data on the
-         * server after any changes.
+         * Saves member properties changes to the server. Call this method to update member data on
+         * the server after any property changes.
          */
         save() {
             return this.update(this.data);
@@ -2910,12 +2941,13 @@
 
     ///////////////////////////////////////////////////////////////////////////////
     /**
-     * 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.
      */
     class Project {
         /**
-         * @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, httpClient) {
             this.httpClient = httpClient;
@@ -2936,8 +2968,6 @@
         /**
          * Project features the user has access to.
          *
-         * @property {string[]} project_actions - Actions are allowed to be performed: `update`,
-         *   `createTopic`, `createDocument`.
          * @readonly
          */
         get authorization() {
@@ -3056,7 +3086,7 @@
             return this._data.previewUrl;
         }
         /**
-         * `true` if project is public (shared) project.
+         * `true` if project is shared project.
          */
         get public() {
             return this.data.public;
@@ -3092,7 +3122,7 @@
             return this.data.updatedAt;
         }
         /**
-         * Refresh project data.
+         * Reloads project data from the server.
          */
         async checkout() {
             const response = await this.internalGet("");
@@ -3100,7 +3130,7 @@
             return this;
         }
         /**
-         * Update project data on the server.
+         * Updates project data on the server.
          *
          * @param data - Raw project data.
          */
@@ -3110,7 +3140,7 @@
             return this;
         }
         /**
-         * Delete the project from the server.
+         * Deletes a project from the server.
          *
          * @returns Returns the raw data of a deleted project.
          */
@@ -3128,22 +3158,22 @@
             });
         }
         /**
-         * 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() {
             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) {
             if (!image) {
@@ -3156,7 +3186,7 @@
             return this;
         }
         /**
-         * Remove the project preview.
+         * Removes the project preview.
          */
         async deletePreview() {
             const response = await this.internalDelete("/preview");
@@ -3173,7 +3203,7 @@
                 .then((array) => array.map((data) => new Role(data, this.id, this.httpClient)));
         }
         /**
-         * Returns the role information.
+         * Returns information about the specified project role.
          *
          * @param name - Role name.
          */
@@ -3183,7 +3213,7 @@
                 .then((data) => new Role(data, this.id, this.httpClient));
         }
         /**
-         * Create a new project role.
+         * Creates a new project role.
          *
          * @param name - Role name.
          * @param description - Role description.
@@ -3200,7 +3230,7 @@
                 .then((data) => new Role(data, this.id, this.httpClient));
         }
         /**
-         * Delete project role.
+         * Deletes the specified project role.
          *
          * @param name - Role name.
          * @returns Returns the raw data of a deleted role.
@@ -3217,7 +3247,7 @@
                 .then((array) => array.map((data) => new Member(data, this.id, this.httpClient)));
         }
         /**
-         * Returns the member information.
+         * Returns information about the specified project member.
          *
          * @param memberId - Member ID.
          */
@@ -3230,7 +3260,7 @@
          * 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, role) {
             return this.internalPost("/members", { userId, role })
@@ -3238,7 +3268,7 @@
                 .then((data) => new Member(data, this.id, this.httpClient));
         }
         /**
-         * 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.
@@ -3308,12 +3338,12 @@
 
     ///////////////////////////////////////////////////////////////////////////////
     /**
-     * The class representing a `user` entity.
+     * Provides properties and methods for obtaining information about a server user and manage its data.
      */
     class User {
         /**
-         * @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, httpClient) {
             this.httpClient = httpClient;
@@ -3329,7 +3359,7 @@
             return this._data.avatarUrl;
         }
         /**
-         * `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.
          */
@@ -3479,7 +3509,8 @@
             this._data.projectsLimit = value;
         }
         /**
-         * 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
          */
@@ -3506,8 +3537,8 @@
             return this.data.storageUsed;
         }
         /**
-         * 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
          */
@@ -3524,7 +3555,7 @@
             this._data.userName = value;
         }
         /**
-         * 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.
@@ -3546,7 +3577,7 @@
             return 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.
@@ -3570,7 +3601,7 @@
             return 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.
@@ -3578,7 +3609,7 @@
          * 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.
          */
@@ -3601,14 +3632,14 @@
             }
         }
         /**
-         * 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() {
             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.
@@ -3617,9 +3648,9 @@
          *   {@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) {
             if (!image) {
@@ -3641,7 +3672,7 @@
             return 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.
@@ -3663,13 +3694,13 @@
             return 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
@@ -3695,25 +3726,24 @@
 
     ///////////////////////////////////////////////////////////////////////////////
     /**
-     * The `Client.js` library class that provides methods to access the
-     * {@link https://cloud.opendesign.com/docs/index.html#/opencloud_server | Open Cloud Server}
-     * resources like Projects, Files, Issues etc.
+     * Provides methods for managing server resources such as users, files, assemblies, jobs, projects, etc.
      */
     class Client extends EventEmitter2 {
         /**
          * @param params - An object containing client configuration parameters.
-         * @param params.serverUrl - Open Cloud Server URL.
+         * @param params.serverUrl - Open Cloud Server REST API base URL.
+         * @param params.url - Deprecated since `25.8`. Use `serverUrl` instead.
          */
         constructor(params = {}) {
             super();
             this._serverUrl = "";
-            this.httpClient = new HttpClient("");
+            this._httpClient = new HttpClient("");
             this._user = null;
             this.eventEmitter = this;
             this.configure(params);
         }
         /**
-         * Open Cloud Server URL. Use {@link configure | configure()} to change server URL.
+         * Open Cloud Server REST API base URL. Use {@link configure | configure()} to change server URL.
          *
          * @readonly
          */
@@ -3721,7 +3751,15 @@
             return this._serverUrl;
         }
         /**
-         * Deprecated since `25.3`. Use `Viewer.options()` instead to change Viewer parameters.
+         * HTTP client instance used to send REST API requests and receive responses from the server.
+         *
+         * @readonly
+         */
+        get httpClient() {
+            return this._httpClient;
+        }
+        /**
+         * Deprecated since `25.3`. Use `Viewer.options()` instead to change `Viewer` parameters.
          *
          * @deprecated
          */
@@ -3763,15 +3801,16 @@
             };
         }
         /**
-         * Change the client configuration parameters.
+         * Changes the client parameters.
          *
-         * @param params - An object containing new configuration parameters.
-         * @param params.serverUrl - Open Cloud Server URL.
-         * @returns Returns a reference to the `Client`.
+         * After changing the parameters, you must re-login.
+         *
+         * @param params - An object containing new parameters.
+         * @param params.serverUrl - Open Cloud Server REST API base URL.
          */
         configure(params) {
             this._serverUrl = (params.serverUrl || "").replace(/\/+$/, "");
-            this.httpClient = new HttpClient(this.serverUrl);
+            this._httpClient = new HttpClient(this.serverUrl);
             this._user = null;
             return this;
         }
@@ -3783,7 +3822,7 @@
          * @property {string} hash - Build hash.
          */
         /**
-         * Returns server version.
+         * Returns client and server versions.
          */
         version() {
             return this.httpClient
@@ -3792,17 +3831,17 @@
                 .then((data) => ({
                 ...data,
                 server: data.version,
-                client: "25.8.16",
+                client: "25.8.19",
             }));
         }
         /**
-         * Register a new user with the specified email and password.
+         * Registers a new user on the server.
          *
-         * @param email - User email. Cannot be empty.
+         * @param email - User email. Cannot be empty. Must be unique within the server.
          * @param password - User password. Cannot be empty. Password can only contain letters (a-z,
          *   A-Z), numbers (0-9), and special characters (~!@#$%^&*()_-+={}[]<>|/'":;.,?).
-         * @param userName - User name. Cannot be empty or blank if defined. Leave undefined to use
-         *   `username` from email.
+         * @param userName - User name. Cannot be empty or blank if defined. this to `undefined` to
+         *   use `username` from email.
          */
         registerUser(email, password, userName) {
             return this.httpClient
@@ -3814,7 +3853,7 @@
                 .then((response) => response.json());
         }
         /**
-         * Resend the Confirmation Email to new user. If the user's email is already confirmed, an
+         * Resends a Confirmation Email to the new user. If the user's email is already confirmed, an
          * exception will be thrown.
          *
          * @param email - User email.
@@ -3826,7 +3865,8 @@
                 .then((response) => response.json());
         }
         /**
-         * Confirm the user's email. If the user's email is already confirmed, an exception will be thrown.
+         * Marks the user's email address as confirmed. If the user's email is already confirmed, an
+         * exception will be thrown.
          *
          * @param emailConfirmationId - Confirmation code from the Confirmation Email.
          */
@@ -3874,8 +3914,8 @@
             this.httpClient.signInUserIsAdmin = false;
         }
         /**
-         * Returns the current logged in user information. Returns `null` if the user is not logged
-         * in or the logged in user has deleted himself.
+         * Returns the current logged in user. Returns `null` if the user is not logged in or the
+         * logged in user has deleted themself.
          */
         getCurrentUser() {
             if (this._user && !this.httpClient.signInUserId)
@@ -3883,13 +3923,7 @@
             return this._user;
         }
         /**
-         * Get the list of server indentity providers.
-         *
-         * To sign in with the provider in your web application:
-         *
-         * - 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.
+         * Returns the list of server enabled indentity providers.
          */
         getIdentityProviders() {
             return this.httpClient.get("/identity").then((response) => response.json());
@@ -3901,7 +3935,7 @@
             return this.httpClient.get("/settings").then((response) => response.json());
         }
         /**
-         * Change server settings.
+         * Changes the server settings.
          *
          * Only administrators can change server settings. If the current logged in user is not an
          * administrator, an exception will be thrown.
@@ -3910,7 +3944,7 @@
             return this.httpClient.put("/settings", settings).then((response) => response.json());
         }
         /**
-         * Returns a list of server users.
+         * Returns the list of server users.
          *
          * Only administrators can get a list of users. If the current logged in user is not an
          * administrator, an exception will be thrown.
@@ -3923,7 +3957,7 @@
                 .then((array) => array.map((data) => new User(data, this.httpClient)));
         }
         /**
-         * Returns the user information.
+         * Returns information about the specified user.
          *
          * Only administrators can get other users. If the current logged in user is not an
          * administrator, they can only get themselves, otherwise an exception will be thrown.
@@ -3950,18 +3984,18 @@
             }
         }
         /**
-         * Create a new user.
+         * Creates a new user on the server.
          *
          * Only administrators can create users. If the current logged in user is not an
          * administrator, an exception will be thrown.
          *
-         * @param email - User email. Cannot be empty.
+         * @param email - User email. Cannot be empty. Must be unique within the server.
          * @param password - User password. Cannot be empty. Password can only contain latin letters
          *   (a-z, A-Z), numbers (0-9), and special characters (~!@#$%^&*()_-+={}[]<>|/'":;.,?).
          * @param params - Additional user data.
          * @param params.isAdmin - `true` if user is an administrator.
-         * @param params.userName - User name. Cannot be empty or blank if defined. Leave undefined
-         *   to use `username` from email.
+         * @param params.userName - User name. Cannot be empty or blank if defined. Specify
+         *   `undefined` to use `username` from email.
          * @param params.firstName - First name.
          * @param params.lastName - Last name.
          * @param params.canCreateProject - `true` if user is allowed to create a project.
@@ -3985,7 +4019,7 @@
                 .then((data) => new User(data, this.httpClient));
         }
         /**
-         * Delete a user from the server.
+         * Deletes the specified user from the server.
          *
          * Only administrators can delete users. If the current logged in user is not an
          * administrator, an exception will be thrown.
@@ -3993,7 +4027,7 @@
          * 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.
          *
          * @param userId - User ID.
          * @returns Returns the raw data of a deleted user.
@@ -4025,17 +4059,15 @@
          * @property {number} size - The number of files in the result list.
          */
         /**
-         * Returns a list of files the user has access to.
+         * Returns a list of files that the current logged in user has uploaded to the server or has access to.
          *
          * @param start - The starting index in the file list. Used for paging.
          * @param limit - The maximum number of files that should be returned per request. Used for paging.
-         * @param name - Filter the files by part of the name.
+         * @param name - Filter the files by part of the name. Case sensitive.
          * @param ext - Filter the files by extension. Extension can be `dgn`, `dwf`, `dwg`, `dxf`,
          *   `ifc`, `ifczip`, `nwc`, `nwd`, `obj`, `rcs`, `rfa`, `rvt`, `step`, `stl`, `stp`, `vsf`,
-         *   or any other drawing or reference file type extension. You can specify multiple
-         *   extensions on one string by separating them with a `|`.
-         * @param ids - List of file IDs to return. You can specify multiple IDs on one `string` by
-         *   separating them with a `|`.
+         *   or any other file type extension.
+         * @param ids - List of file IDs to return.
          * @param sortByDesc - Allows to specify the descending order of the result. By default,
          *   files are sorted by name in ascending order.
          * @param {string} sortField - Allows to specify sort field.
@@ -4079,7 +4111,7 @@
             });
         }
         /**
-         * Returns the file information.
+         * Returns information about the specified file.
          *
          * @param fileId - File ID.
          */
@@ -4096,16 +4128,16 @@
          *
          * - {@link UploadProgressEvent | uploadprogress}
          *
-         * @param file - Web API {@link https://developer.mozilla.org/docs/Web/API/File | File} object
+         * @param file - {@link https://developer.mozilla.org/docs/Web/API/File | Web API File} object
          *   are generally retrieved from a
          *   {@link https://developer.mozilla.org/docs/Web/API/FileList | FileList} object returned as
          *   a result of a user selecting files using the HTML `<input>` element.
          * @param params - An object containing upload parameters.
-         * @param params.geometry - Create job to extract file geometry data. Can be:
+         * @param params.geometry - Create job to convert file geometry data. Can be:
          *
-         *   - `true` - Extract file geometry data into `VSFX` to open the file in `VisualizeJS` viewer.
-         *   - `vsfx` - Extract file geometry data into `VSFX` to open the file in `VisualizeJS` viewer.
-         *   - `gltf` - Extract file geometry data into `glTF` to open the file in `Three.js` viewer.
+         *   - `true` - Convert file geometry data to `VSFX` format to open the file in `VisualizeJS` viewer.
+         *   - `vsfx` - Convert file geometry data to `VSFX` format to open the file in `VisualizeJS` viewer.
+         *   - `gltf` - Convert file geometry data to `glTF` format to open the file in `Three.js` viewer.
          *
          * @param params.properties - Create job to extract file properties.
          * @param params.waitForDone - Wait for geometry and properties jobs to complete.
@@ -4114,7 +4146,7 @@
          * @param params.interval - The time, in milliseconds, the function should delay in between
          *   checking jobs status.
          * @param params.signal - An
-         *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController} *
+         *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
          *   signal, which can be used to abort waiting as desired.
          * @param params.onProgress - Upload progress callback.
          */
@@ -4145,7 +4177,10 @@
             return result;
         }
         /**
-         * Delete the drawing or reference file from the server.
+         * Deletes the specified file and all its versions from the server.
+         *
+         * You cannot delete a version file using `deleteFile()`, only the original file. To delete a
+         * version file use {@link File.deleteVersion | File.deleteVersion()}.
          *
          * @param fileId - File ID.
          * @returns Returns the raw data of a deleted file.
@@ -4154,7 +4189,7 @@
             return this.httpClient.delete(`/files/${fileId}`).then((response) => response.json());
         }
         /**
-         * Download the drawing or reference file.
+         * Downloads the specified file from the server.
          *
          * @param fileId - File ID.
          * @param onProgress - Download progress callback.
@@ -4178,10 +4213,9 @@
          * @property {number} size - The number of jobs in the result list.
          */
         /**
-         * Returns a list of jobs created by current user.
+         * Returns a list of jobs started by the current logged in user.
          *
-         * @param status - Filter the jobs by status. Status can be `waiting`, `inpogress`, `done` or
-         *   `failed`. You can specify multiple statuses on one `string` by separating them with a "|".
+         * @param status - Filter the jobs by status. Status can be `waiting`, `inpogress`, `done` or `failed`.
          * @param limit - The maximum number of jobs that should be returned per request. Used for paging.
          * @param start - The starting index in the job list. Used for paging.
          * @param sortByDesc - Allows to specify the descending order of the result. By default, jobs
@@ -4218,7 +4252,7 @@
             }));
         }
         /**
-         * Returns the job information.
+         * Returns information about the specified job.
          *
          * @param jobId - Job ID.
          */
@@ -4229,15 +4263,15 @@
                 .then((data) => new Job(data, this.httpClient));
         }
         /**
-         * Create a new job.
+         * Runs a new job on the server for the sepecified file.
          *
          * @param fileId - File ID.
          * @param outputFormat - The job type. Can be one of:
          *
-         *   - `geometry` - Extract file geometry data into `VSFX`.
-         *   - `geometryGltf` - Extract file geometry data into `glTF`.
+         *   - `geometry` - Convert file geometry data to `VSFX` format suitable for `VisualizeJS` viewer.
+         *   - `geometryGltf` - Convert file geometry data to `glTF` format suitable for `Three.js` viewer.
          *   - `properties` - Extract file properties.
-         *   - `validation` - Validate the file. Only for `IFC`.
+         *   - `validation` - Validate the file. Only for `IFC` files.
          *   - `dwg`, `obj`, `gltf`, `glb`, `vsf`, `pdf`, `3dpdf` - Export file to the one of the supported format.
          *   - Other custom job name. Custom job runner must be registered in the job templates table
          *       before creating a job.
@@ -4256,8 +4290,8 @@
                 .then((data) => new Job(data, this.httpClient));
         }
         /**
-         * Remove a job from the server job list. The method does not delete or stop jobs that are
-         * already being executed.
+         * Deletes the specified job from the server job list. Jobs that are in progress or have
+         * already been completed cannot be deleted.
          *
          * @param jobId - Job ID.
          * @returns Returns the raw data of a deleted job.
@@ -4276,14 +4310,13 @@
          * @property {number} size - The number of assemblies in the result list.
          */
         /**
-         * Returns a list of assemblies the user has access to.
+         * Returns a list of assemblies created by the current logged in user.
          *
          * @param start - The starting index in the assembly list. Used for paging.
          * @param limit - The maximum number of assemblies that should be returned per request. Used
          *   for paging.
-         * @param name - Filter the assemblies by part of the name.
-         * @param ids - List of assembly IDs to return. You can specify multiple IDs on one `string`
-         *   by separating them with a "|".
+         * @param name - Filter the assemblies by part of the name. Case sensitive.
+         * @param ids - List of assembly IDs to return.
          * @param sortByDesc - Allows to specify the descending order of the result. By default
          *   assemblies are sorted by name in ascending order.
          * @param sortField - Allows to specify sort field.
@@ -4322,7 +4355,7 @@
             });
         }
         /**
-         * Get assembly information.
+         * Returns information about the specified assembly.
          *
          * @param assemblyId - Assembly ID.
          */
@@ -4333,12 +4366,21 @@
                 .then((data) => new Assembly(data, this.httpClient));
         }
         /**
-         * Create a new assembly.
+         * Creates a new assembly on the server.
          *
          * @param files - List of file IDs.
          * @param name - Assembly name.
-         * @param params - An object containing upload parameters.
+         * @param params - Additional assembly creating parameters.
          * @param params.waitForDone - Wait for assembly to be created.
+         * @param params.timeout - The time, in milliseconds, that the function should wait for the
+         *   assembly to be created. If the assembly is not created within this time, a TimeoutError
+         *   exception will be thrown.
+         * @param params.interval - The time, in milliseconds, the function should delay in between
+         *   checking assembly status.
+         * @param params.signal - An
+         *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
+         *   signal, which can be used to abort waiting as desired.
+         * @param params.onCheckout - Waiting progress callback. Return `true` to cancel waiting.
          */
         createAssembly(files, name, params) {
             const { waitForDone } = params !== null && params !== void 0 ? params : {};
@@ -4349,7 +4391,7 @@
                 .then((result) => (waitForDone ? result.waitForDone(params) : result));
         }
         /**
-         * Delete the assembly from the server.
+         * Deletes the specified assembly from the server.
          *
          * @param assemblyId - Assembly ID.
          * @returns Returns the raw data of a deleted assembly.
@@ -4368,13 +4410,12 @@
          * @property {number} size - The number of projects in the result list.
          */
         /**
-         * Returns a list of projects the user has access to.
+         * Returns a list of projects that the currently logged in user has created or has access to.
          *
          * @param start - The starting index in the project list. Used for paging.
          * @param limit - The maximum number of projects that should be returned per request. Used for paging.
-         * @param name - Filter the projects by part of the name.
-         * @param ids - List of project IDs to return. You can specify multiple IDs on one `string`
-         *   by separating them with a "|".
+         * @param name - Filter the projects by part of the name. Case sensitive.
+         * @param ids - List of project IDs to return.
          * @param sortByDesc - Allows to specify the descending order of the result. By default
          *   projects are sorted by name in ascending order.
          */
@@ -4432,7 +4473,7 @@
             });
         }
         /**
-         * Returns the project information.
+         * Returns information about the specified project.
          *
          * @param projectId - Project ID.
          */
@@ -4443,7 +4484,7 @@
                 .then((data) => new Project(data, this.httpClient));
         }
         /**
-         * Create a new project.
+         * Creates a new project on the server.
          *
          * @param name - Project name.
          * @param description - Project description.
@@ -4462,7 +4503,7 @@
                 .then((data) => new Project(data, this.httpClient));
         }
         /**
-         * Delete the project from the server.
+         * Deletes the specified project from the server.
          *
          * @param projectId - Project ID.
          * @returns Returns the raw data of a deleted project.
@@ -4484,7 +4525,7 @@
     }
 
     ///////////////////////////////////////////////////////////////////////////////
-    const version = "25.8.16";
+    const version = "25.8.19";
 
     exports.Assembly = Assembly;
     exports.ClashTest = ClashTest;