@inweb/client 25.8.16 → 25.8.19

package/lib/Api/File.d.ts

@@ -5,7 +5,8 @@ import { Model } from "./Model";
 import { Permission } from "./Permission";
 import { Job } from "./Job";
 /**
- * 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.
  */
 export declare class File {
     private _data;
@@ -13,8 +14,8 @@ export declare class File {
     httpClient: IHttpClient;
     path: string;
     /**
-     * @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: any, httpClient: IHttpClient);
     private appendVersionParam;
@@ -50,8 +51,9 @@ export declare class File {
     get data(): any;
     private set data(value);
     /**
-     * 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()}.
      *
@@ -61,10 +63,10 @@ export declare class File {
     /**
      * 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(): string;
@@ -75,7 +77,10 @@ export declare class File {
      */
     get id(): string;
     /**
-     * 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
      */
@@ -119,7 +124,7 @@ export declare class File {
      */
     get size(): number;
     /**
-     * Total size of all versions of the file in the storage in bytes.
+     * Total size of all versions of the file in bytes.
      *
      * @readonly
      */
@@ -127,8 +132,8 @@ export declare class File {
     /**
      * 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.
      *
@@ -178,40 +183,43 @@ export declare class File {
      */
     get versions(): IFileVersionInfo[];
     /**
-     * Refresh file data.
+     * Reloads file data from the server.
      */
     checkout(): Promise<this>;
     /**
-     * Update file data on the server.
+     * Updates file data on the server.
      *
      * @param data - Raw file data.
      */
     update(data: any): Promise<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.
      */
     delete(): Promise<any>;
     /**
-     * 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(): Promise<this>;
     /**
-     * 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.
      */
     setPreview(image?: BodyInit | null): Promise<this>;
     /**
-     * Remove the file preview.
+     * Removes the file preview.
      */
     deletePreview(): Promise<this>;
     /**
@@ -230,8 +238,8 @@ export declare class File {
     /**
      * 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?: string | string[]): Promise<any[]>;
     /**
@@ -271,13 +279,13 @@ export declare class File {
      *     ],
      *   };
      *
-     * @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[]>}
      */
     searchProperties(searchPattern: any): Promise<any[]>;
     /**
-     * Returns the cda.json for an active version of the file.
+     * Returns the CDA tree for an active version of the file.
      */
     getCdaTree(): Promise<any[]>;
     /**
@@ -285,13 +293,13 @@ export declare class File {
      */
     getViewpoints(): Promise<any[]>;
     /**
-     * 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.
      */
     saveViewpoint(viewpoint: any): Promise<any>;
     /**
-     * Delete file viewpoint.
+     * Deletes the specified file viewpoint.
      *
      * @param guid - Viewpoint GUID.
      * @returns Returns the raw data of a deleted viewpoint.
@@ -312,7 +320,7 @@ export declare class File {
      */
     getSnapshotData(guid: string, bitmapGuid: string): Promise<string>;
     /**
-     * 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
@@ -321,7 +329,7 @@ export declare class File {
      */
     download(onProgress?: (progress: number) => void, signal?: AbortSignal): Promise<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>
@@ -341,7 +349,7 @@ export declare class File {
      */
     downloadResource(dataId: string, onProgress?: (progress: number, chunk: Uint8Array) => void, signal?: AbortSignal): Promise<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.
@@ -370,7 +378,9 @@ export declare class File {
      */
     downloadFileRange(requestId: number, records: any | null, dataId: string, onProgress?: (progress: number, downloaded: Uint8Array, requestId: number) => void, signal?: AbortSignal): Promise<void>;
     /**
-     * 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}
@@ -378,20 +388,23 @@ export declare class File {
      */
     getReferences(signal?: AbortSignal): Promise<IFileReferences>;
     /**
-     * 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.
      */
     setReferences(references: IFileReferences): Promise<IFileReferences>;
     /**
-     * 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.
@@ -403,20 +416,20 @@ export declare class File {
      */
     createJob(outputFormat: string, parameters?: string | object): Promise<Job>;
     /**
-     * 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`.
      */
     extractGeometry(type?: string, parameters?: string | object): Promise<Job>;
     /**
-     * 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
@@ -424,7 +437,7 @@ export declare class File {
      */
     extractProperties(parameters?: string | object): Promise<Job>;
     /**
-     * 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")}.
@@ -434,8 +447,8 @@ export declare class File {
      */
     validate(parameters?: string | object): Promise<Job>;
     /**
-     * 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
@@ -463,36 +476,43 @@ export declare class File {
      */
     getPermissions(): Promise<Permission[]>;
     /**
-     * Returns the permission information.
+     * Returns information about specified file permission.
      *
      * @param permissionId - Permission ID.
      */
     getPermission(permissionId: string): Promise<Permission>;
     /**
-     * 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.
      */
     createPermission(actions: string | string[], grantedTo: any[], _public: boolean): Promise<Permission>;
     /**
-     * Delete file permission.
+     * Removes the specified permission from the file.
      *
      * @param permissionId - Permission ID.
      * @returns Returns the raw data of a deleted permission.
      */
     deletePermission(permissionId: string): Promise<any>;
     /**
-     * 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.
@@ -519,49 +539,51 @@ export declare class File {
      */
     getVersions(): Promise<File[]>;
     /**
-     * Returns the version file.
+     * Returns information about the specified version file.
      *
      * @param version - Desired version.
      */
     getVersion(version: number): Promise<File>;
     /**
-     * Delete version file.
+     * Deletes the specified version file.
      *
      * @param version - Version to delete.
      */
     deleteVersion(version: number): Promise<any>;
     /**
-     * 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.
      */
     setActiveVersion(version: number): Promise<this>;
     /**
-     * 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?: number): this;
     /**
-     * Delete the source of the active file version.
+     * Deletes the source file of the active file version from the server.
      */
     deleteSource(): Promise<this>;
 }

package/lib/Api/IAssembly.d.ts

@@ -11,3 +11,29 @@ export interface IAssemblyVersionInfo {
     createdAt: string;
     ownerId: string;
 }
+/**
+ * Model transformation matrix.
+ */
+export interface IModelTransformMatrix {
+    /**
+     * Translation part, move by specified offset along the X, Y, Z axes.
+     */
+    translate: {
+        x: number;
+        y: number;
+        z: number;
+    };
+    /**
+     * Rotation part, rotate by the specified angle, around the specified vector.
+     */
+    rotation: {
+        x: number;
+        y: number;
+        z: number;
+        angle: number;
+    };
+    /**
+     * Scaling part, scale with multiplier, from center of extends.
+     */
+    scale: number;
+}

package/lib/Api/Job.d.ts

@@ -1,14 +1,13 @@
 import { IHttpClient } from "./IHttpClient";
 /**
- * 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.
  */
 export declare class Job {
     private _data;
     httpClient: IHttpClient;
     /**
-     * @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: any, httpClient: IHttpClient);
     protected internalGet(): Promise<Response>;
@@ -98,11 +97,11 @@ export declare class Job {
      */
     get startedAt(): string;
     /**
-     * Refresh job data.
+     * Reloads job data from the server.
      */
     checkout(): Promise<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.
@@ -111,14 +110,14 @@ export declare class Job {
      */
     update(data: any): Promise<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.
      */
     delete(): Promise<any>;
     /**
-     * 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

package/lib/Api/Member.d.ts

@@ -1,16 +1,17 @@
 import { IHttpClient } from "./IHttpClient";
 import { IShortUserDescription } from "./IUser";
 /**
- * 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}.
  */
 export declare class Member {
     private _data;
     projectId: string;
     httpClient: IHttpClient;
     /**
-     * @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: any, projectId: string, httpClient: IHttpClient);
     private internalGet;
@@ -55,24 +56,24 @@ export declare class Member {
      */
     get user(): IShortUserDescription;
     /**
-     * Refresh member data.
+     * Reloads member data from the server.
      */
     checkout(): Promise<this>;
     /**
-     * Update member data on the server.
+     * Updates member data on the server.
      *
      * @param data - Raw member data.
      */
     update(data: any): Promise<this>;
     /**
-     * Remove a member from a project.
+     * Removes a member from the project.
      *
      * @returns Returns the raw data of a deleted member.
      */
     delete(): Promise<any>;
     /**
-     * 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(): Promise<this>;
 }

package/lib/Api/Model.d.ts

@@ -1,8 +1,9 @@
 import { IHttpClient } from "./IHttpClient";
 import type { File } from "./File";
 import type { Assembly } from "./Assembly";
+import type { IModelTransformMatrix } from "./IAssembly";
 /**
- * The class representing the is a description of view of the file or assembly. For example,
+ * Provides properties and methods for working with view of the file or assembly. For example,
  * for `dwg` it is a `Model` space or layout, and for `rvt` files it is a `3D` view.
  */
 export declare class Model {
@@ -11,8 +12,8 @@ export declare class Model {
     httpClient: IHttpClient;
     path: string;
     /**
-     * @param data - An object that implements model data storage.
-     * @param file - The `File` of 'Assembly' instance that owns the model.
+     * @param data - Raw model data received from the server.
+     * @param file - The file/assembly instance that owns the model.
      */
     constructor(data: any, file: File | Assembly);
     /**
@@ -89,26 +90,27 @@ export declare class Model {
      *
      * @param handle - Model 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 transform - Transformation matrix. Specify `undefined` to remove transformation.
      */
-    setModelTransformMatrix(handle: string, transform: any): Promise<this>;
+    setModelTransformMatrix(handle: string, transform: IModelTransformMatrix): Promise<this>;
     /**
-     * Returns model viewpoint list.
+     * Returns a list of viewpoints of the owner file/assembly.
      */
     getViewpoints(): Promise<any[]>;
     /**
-     * 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.
      */
     saveViewpoint(viewpoint: any): Promise<any>;
     /**
-     * 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.
@@ -122,15 +124,15 @@ export declare class Model {
      */
     getSnapshot(guid: string): Promise<string>;
     /**
-     * Returns snapshot data.
+     * Returns viewpoint snapshot data.
      *
      * @param guid - Viewpoint GUID.
      * @param bitmapGuid - Bitmap GUID.
      */
     getSnapshotData(guid: string, bitmapGuid: string): Promise<string>;
     /**
-     * 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.
@@ -140,7 +142,7 @@ export declare class Model {
      */
     downloadResource(dataId: string, onProgress?: (progress: number, chunk: Uint8Array) => void, signal?: AbortSignal): Promise<ArrayBuffer>;
     /**
-     * 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.
@@ -169,7 +171,9 @@ export declare class Model {
      */
     downloadFileRange(requestId: number, records: any | null, dataId: string, onProgress?: (progress: number, chunk: Uint8Array, requestId: number) => void, signal?: AbortSignal): Promise<void>;
     /**
-     * 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}