@inweb/client 25.8.16 → 25.8.19

package/lib/Api/Assembly.d.ts

@@ -1,10 +1,11 @@
 import { IHttpClient } from "./IHttpClient";
-import { IAssociatedFileData, IAssemblyVersionInfo } from "./IAssembly";
+import { IAssociatedFileData, IAssemblyVersionInfo, IModelTransformMatrix } from "./IAssembly";
 import { IShortUserDescription } from "./IUser";
 import { Model } from "./Model";
 import { ClashTest } from "./ClashTest";
 /**
- * The class representing a `assembly` entity.
+ * Provides properties and methods for obtaining information about an assembly on the server
+ * and managing its data.
  */
 export declare class Assembly {
     private _data;
@@ -12,8 +13,8 @@ export declare class Assembly {
     httpClient: IHttpClient;
     path: string;
     /**
-     * @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: any, httpClient: IHttpClient);
     appendVersionParam(relativePath: string): string;
@@ -51,9 +52,9 @@ export declare class Assembly {
     /**
      * 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(): string;
     /**
@@ -106,7 +107,7 @@ export declare class Assembly {
     get version(): number;
     get versions(): IAssemblyVersionInfo[];
     /**
-     * Refresh assembly data.
+     * Reloads assembly data from the server.
      */
     checkout(): Promise<this>;
     /**
@@ -116,14 +117,14 @@ export declare class Assembly {
      */
     update(data: any): Promise<this>;
     /**
-     * Delete the assembly from the server.
+     * Deletes an assembly from the server.
      *
      * @returns Returns the raw data of a deleted assembly.
      */
     delete(): Promise<any>;
     /**
-     * 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(): Promise<this>;
     setPreview(image?: BodyInit | null): Promise<this>;
@@ -132,40 +133,24 @@ export declare class Assembly {
      * Returns list of assembly models.
      */
     getModels(): Promise<Model[]>;
-    /**
-     * 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: string): any;
+    getModelTransformMatrix(handle: string): IModelTransformMatrix;
     /**
-     * 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: string, transform: any): Promise<this>;
+    setModelTransformMatrix(handle: string, transform: IModelTransformMatrix): Promise<this>;
     /**
      * 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?: string | string[]): Promise<any[]>;
@@ -196,7 +181,7 @@ export declare class Assembly {
      */
     searchProperties(searchPattern: any): Promise<any[]>;
     /**
-     * Returns the cda.json for an assembly.
+     * Returns the CDA tree for an assembly.
      */
     getCdaTree(): Promise<any[]>;
     /**
@@ -204,13 +189,13 @@ export declare class Assembly {
      */
     getViewpoints(): Promise<any[]>;
     /**
-     * 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.
      */
     saveViewpoint(viewpoint: any): Promise<any>;
     /**
-     * Delete assembly viewpoint.
+     * Deletes the specified assembly viewpoint.
      *
      * @param guid - Viewpoint GUID.
      * @returns Returns the raw data of a deleted viewpoint.
@@ -231,7 +216,7 @@ export declare class Assembly {
      */
     getSnapshotData(guid: any, bitmapGuid: any): Promise<string>;
     /**
-     * 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.
@@ -242,7 +227,7 @@ export declare class Assembly {
      */
     downloadResource(dataId: string, onProgress?: (progress: number, chunk: Uint8Array) => void, signal?: AbortSignal): Promise<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.
@@ -270,7 +255,7 @@ export declare class Assembly {
     downloadFileRange(requestId: number, records: any | null, dataId: string, onProgress?: (progress: number, chunk: Uint8Array, requestId: number) => void, signal?: AbortSignal): Promise<void>;
     getReferences(signal?: AbortSignal): Promise<any>;
     /**
-     * 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.
@@ -291,15 +276,13 @@ export declare class Assembly {
     /**
      * 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?: number, limit?: number, name?: string, ids?: string | string[], sortByDesc?: boolean, sortField?: string): Promise<{
         allSize: number;
@@ -309,26 +292,45 @@ export declare class Assembly {
         size: number;
     }>;
     /**
-     * Returns the assembly clash test information.
+     * Returns information about the specified assembly clash test.
      *
      * @param testId - Test ID.
      */
     getClashTest(testId: string): Promise<ClashTest>;
     /**
-     * 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.
@@ -347,7 +349,7 @@ export declare class Assembly {
         signal?: AbortSignal;
     }): Promise<ClashTest>;
     /**
-     * Delete assembly clash test.
+     * Deletes the specified assembly clash test.
      *
      * @param testId - Test ID.
      * @returns Returns the raw data of a deleted test.

package/lib/Api/ClashTest.d.ts

@@ -1,16 +1,16 @@
 import { IHttpClient } from "./IHttpClient";
 import { IShortUserDescription } from "./IUser";
 /**
- * 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.
  */
 export declare class ClashTest {
     private _data;
     basePath: string;
     httpClient: IHttpClient;
     /**
-     * @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: any, basePath: string, httpClient: IHttpClient);
     protected internalGet(relativePath: string): Promise<Response>;
@@ -19,10 +19,10 @@ export declare class ClashTest {
     /**
      * 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
      */
@@ -74,8 +74,8 @@ export declare class ClashTest {
      */
     get owner(): IShortUserDescription;
     /**
-     * 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
      */
@@ -83,17 +83,17 @@ export declare class ClashTest {
     /**
      * 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
      */
     get selectionTypeA(): string;
     /**
-     * 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
      */
@@ -101,10 +101,10 @@ export declare class ClashTest {
     /**
      * 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
      */
@@ -116,34 +116,34 @@ export declare class ClashTest {
      */
     get status(): string;
     /**
-     * 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
      */
     get tolerance(): number;
     /**
-     * Refresh test data.
+     * Reloads test data from the server.
      */
     checkout(): Promise<this>;
     /**
-     * Update test data on the server.
+     * Updates test data on the server.
      *
      * @param data - Raw test data.
      */
     update(data: any): Promise<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.
      */
     delete(): Promise<any>;
     /**
-     * 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(): Promise<this>;
     /**
-     * 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
@@ -153,11 +153,13 @@ export declare class ClashTest {
      * @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?: {
         timeout?: number;
         interval?: number;
         signal?: AbortSignal;
+        onCheckout?: (test: ClashTest, ready: boolean) => boolean;
     }): Promise<this>;
     /**
      * Returns a report with the clash detection results for this test.