@inweb/client 25.7.0 → 25.7.2

package/lib/Api/File.d.ts

@@ -29,8 +29,8 @@ export declare class File {
      */
     get activeVersion(): number;
     /**
-     * File creation time (UTC) in the format specified in <a
-     * href="https://www.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a>.
+     * File creation time (UTC) in the format specified in
+     * {@link https://www.wikipedia.org/wiki/ISO_8601 | ISO 8601}.
      *
      * @readonly
      */
@@ -52,7 +52,8 @@ export declare class File {
     /**
      * 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
-     * {@link File.createJob()}. To download exported file use {@link File.downloadResource()}.
+     * {@link createJob | createJob()}. To download exported file use
+     * {@link downloadResource | downloadResource()}.
      *
      * @readonly
      */
@@ -100,7 +101,7 @@ export declare class File {
     get owner(): IShortUserDescription;
     /**
      * File preview image URL or empty string if the file does not have a preview. Use
-     * {@link File.setPreview | setPreview()} to change preview image.
+     * {@link setPreview | setPreview()} to change preview image.
      *
      * @readonly
      */
@@ -140,8 +141,8 @@ export declare class File {
      */
     get type(): string;
     /**
-     * File last update time (UTC) in the format specified in <a
-     * href="https://www.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a>.
+     * File last update time (UTC) in the format specified in
+     * {@link https://www.wikipedia.org/wiki/ISO_8601 | ISO 8601}.
      *
      * @readonly
      */
@@ -172,35 +173,28 @@ export declare class File {
     get versions(): IFileVersionInfo[];
     /**
      * Refresh file data.
-     *
-     * @async
      */
     checkout(): Promise<this>;
     /**
      * Update file data on the server.
      *
-     * @async
      * @param data - Raw file data.
      */
     update(data: any): Promise<this>;
     /**
      * Delete the file and all its versions from the server.
      *
-     * @async
      * @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.
-     *
-     * @async
      */
     save(): Promise<this>;
     /**
      * Set or remove the file preview.
      *
-     * @async
      * @param image - Preview image.Can be a
      *   {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}
      *   string,
@@ -212,14 +206,10 @@ export declare class File {
     setPreview(image?: BodyInit | null): Promise<this>;
     /**
      * Remove the file preview.
-     *
-     * @async
      */
     deletePreview(): Promise<this>;
     /**
      * Returns a list of models of the active version of the file.
-     *
-     * @async
      */
     getModels(): Promise<Model[]>;
     getModelTransformMatrix(handle: string): any;
@@ -234,7 +224,6 @@ export declare class File {
     /**
      * Returns the properties for an objects in the active version of the file.
      *
-     * @async
      * @param handles - Object original handle or handles array. Leave this parameter `undefined`
      *   to get properties for all objects in the file.
      */
@@ -257,7 +246,6 @@ export declare class File {
      * Returns the list of original handles for an objects in the active version of the file that
      * match the specified patterns. Search patterns may be combined using query operators.
      *
-     * @async
      * @example <caption>Simple search pattern.</caption>
      *   searchPattern = {
      *     key: "Category",
@@ -284,27 +272,21 @@ export declare class File {
     searchProperties(searchPattern: any): Promise<any[]>;
     /**
      * Returns the cda.json for an active version of the file.
-     *
-     * @async
      */
     getCdaTree(): Promise<any[]>;
     /**
      * Returns a list of file viewpoints.
-     *
-     * @async
      */
     getViewpoints(): Promise<any[]>;
     /**
-     * Add new file viewpoint. To create a new viewpoint use `Viewer.createViewpoint()`.
+     * Add new file viewpoint. To create a viewpoint use `Viewer.createViewpoint()`.
      *
-     * @async
      * @param viewpoint - Viewpoint.
      */
     saveViewpoint(viewpoint: any): Promise<any>;
     /**
      * Delete file viewpoint.
      *
-     * @async
      * @param guid - Viewpoint GUID.
      * @returns Returns the raw data of a deleted viewpoint.
      */
@@ -313,14 +295,12 @@ export declare class File {
      * Returns viewpoint preview image as
      * {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}.
      *
-     * @async
      * @param guid - Viewpoint GUID.
      */
     getSnapshot(guid: string): Promise<string>;
     /**
      * Returns viewpoint preview data.
      *
-     * @async
      * @param guid - Viewpoint GUID.
      * @param bitmapGuid - Bitmap GUID.
      */
@@ -328,11 +308,10 @@ export declare class File {
     /**
      * Download source of active version of the file.
      *
-     * @async
      * @param onProgress - Download progress callback.
-     * @param signal - An <a href="https://developer.mozilla.org/docs/Web/API/AbortSignal" target
-     *   ="_blank">AbortSignal</a> object instance. Allows to communicate with a fetch request
-     *   and abort it if desired.
+     * @param signal - An
+     *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
+     *   signal. Allows to communicate with a fetch request and abort it if desired.
      */
     download(onProgress?: (progress: number) => void, signal?: AbortSignal): Promise<ArrayBuffer>;
     /**
@@ -350,9 +329,9 @@ export declare class File {
      *
      * @param dataId - Resource file name.
      * @param onProgress - Download progress callback.
-     * @param signal - An <a href="https://developer.mozilla.org/docs/Web/API/AbortSignal" target
-     *   ="_blank">AbortSignal</a> object instance. Allows to communicate with a fetch request
-     *   and abort it if desired.
+     * @param signal - An
+     *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
+     *   signal. Allows to communicate with a fetch request and abort it if desired.
      */
     downloadResource(dataId: string, onProgress?: (progress: number, chunk: Uint8Array) => void, signal?: AbortSignal): Promise<ArrayBuffer>;
     /**
@@ -363,9 +342,9 @@ export declare class File {
      * @param ranges - A range of resource file contents to download.
      * @param requestId - Request ID for download progress callback.
      * @param onProgress - Download progress callback.
-     * @param signal - An <a href="https://developer.mozilla.org/docs/Web/API/AbortSignal" target
-     *   ="_blank">AbortSignal</a> object instance. Allows to communicate with a fetch request
-     *   and abort it if desired.
+     * @param signal - An
+     *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
+     *   signal. Allows to communicate with a fetch request and abort it if desired.
      */
     downloadResourceRange(dataId: string, requestId: number, ranges: Array<{
         begin: number;
@@ -373,33 +352,34 @@ export declare class File {
         requestId: number;
     }>, onProgress?: (progress: number, chunk: Uint8Array, requestId: number) => void, signal?: AbortSignal): Promise<ArrayBuffer>;
     /**
-     * Deprecated since `25.3`. Use {@link File.downloadResource()} instead.
+     * Deprecated since `25.3`. Use {@link downloadResource | downloadResource()} instead.
+     *
+     * @deprecated
      */
     partialDownloadResource(dataId: string, onProgress?: (progress: number, downloaded: Uint8Array) => void, signal?: AbortSignal): Promise<ArrayBuffer>;
     /**
-     * Deprecated since `25.3`. Use {@link File.downloadResourceRange()} instead.
+     * Deprecated since `25.3`. Use {@link downloadResourceRange | downloadResourceRange()} instead.
+     *
+     * @deprecated
      */
     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.
      *
-     * @async
-     * @param [signal] - An <a
-     *   href="https://developer.mozilla.org/docs/Web/API/AbortController">AbortController</a>
-     *   signal object instance, which can be used to abort waiting as desired.
+     * @param signal - An
+     *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController}
+     *   signal, which can be used to abort waiting as desired.
      */
     getReferences(signal?: AbortSignal): Promise<IFileReferences>;
     /**
      * Set the file references.
      *
-     * @async
      * @param references - File references.
      */
     setReferences(references: IFileReferences): Promise<IFileReferences>;
     /**
      * Create a new job for the active version of the file.
      *
-     * @async
      * @param outputFormat - The job type. Can be one of:
      *
      *   - `geometry` - Extract file geometry data into `VSFX`.
@@ -407,71 +387,64 @@ export declare class File {
      *   - `properties` - Extract file properties.
      *   - `validation` - Validate the file. Only for `IFC`.
      *   - `dwg`, `obj`, `gltf`, `glb`, `vsf`, `pdf`, `3dpdf` - Export file to the one of the
-     *       supported format. Use {@link File.exports | File.exports()} to get the list of
-     *       completed file exports. Use {@link File.downloadResource | File.downloadResource()}
-     *       to download the exported file.
-     *   - Other custom job name. Custom job runner must be registered in the job templates table
-     *       before creating a job.
+     *       supported format. Use {@link exports | exports()} to get the list of completed file
+     *       exports. Use {@link downloadResource | downloadResource()} to download the exported file.
+     *   - Other custom job name. Custom job runner must be registered in the job templates before
+     *       creating a job.
      *
      * @param parameters - Parameters for the job runner. Can be given as command line arguments
-     *   for the File Converter tool in form "--arg=value".
+     *   for the File Converter tool in form `--arg=value`.
      */
     createJob(outputFormat: string, parameters?: string | object): Promise<Job>;
     /**
      * Create job to extract geometry data of active version of the file. This is alias to
-     * {@link File.createJob | File.createJob("geometry")}.
+     * {@link createJob | createJob("geometry")}.
      *
-     * @async
      * @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.
      *
      * @param parameters - Parameters for the job runner. Can be given as command line arguments
-     *   for the File Converter tool in form "--arg=value".
+     *   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
-     * {@link File.createJob | File.createJob("properties")}.
+     * {@link createJob | createJob("properties")}.
      *
-     * @async
      * @param parameters - Parameters for the job runner. Can be given as command line arguments
-     *   for the File Converter tool in form "--arg=value".
+     *   for the File Converter tool in form `--arg=value`.
      */
     extractProperties(parameters?: string | object): Promise<Job>;
     /**
      * Create a job to validate the active version of the file. This is alias to
-     * {@link File.createJob | File.createJob("validation")}.
+     * {@link createJob | createJob("validation")}.
      *
-     * To get validation report use
-     * {@link File.downloadResource | File.downloadResource("validation_report.json")}.
+     * To get validation report use {@link downloadResource | downloadResource("validation_report.json")}.
      *
-     * @async
      * @param parameters - Parameters for the job runner. Can be given as command line arguments
-     *   for the File Converter tool in form "--arg=value".
+     *   for the File Converter tool in form `--arg=value`.
      */
     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.
      *
-     * @async
-     * @param {string | string[]} jobs - Job or job array to wait on. Can be `geometry`,
-     *   `geometryGltf`, `properties`, `validation`, `dwg`, `obj`, `gltf`, `glb`, `vsf`, `pdf`,
-     *   `3dpdf` or custom job name.
-     * @param {Boolean} [waitAll] - If this parameter is `true`, the function returns when all
-     *   the specified jobs have done. If `false`, the function returns when any one of the jobs are done.
-     * @param {Object} [params] - An object containing waiting parameters.
-     * @param {Number} [params.timeout] - The time, in milliseconds that the function should wait
-     *   jobs. If no one jobs are done during this time, the `TimeoutError` exception will be thrown.
-     * @param {Number} [params.interval] - The time, in milliseconds, the function should delay
-     *   in between checking jobs status.
-     * @param {AbortSignal} [params.signal] - An <a
-     *   href="https://developer.mozilla.org/docs/Web/API/AbortController">AbortController</a>
-     *   signal object instance, which can be used to abort waiting as desired.
-     * @param {function} [params.onCheckout] - Waiting progress callback. Return `true` to cancel waiting.
-     * @returns {Promise<File>}
+     * @param jobs - Job or job array to wait on. Can be `geometry`, `geometryGltf`,
+     *   `properties`, `validation`, `dwg`, `obj`, `gltf`, `glb`, `vsf`, `pdf`, `3dpdf` or custom
+     *   job name.
+     * @param waitAll - If this parameter is `true`, the function returns when all the specified
+     *   jobs have done. If `false`, the function returns when any one of the jobs are done.
+     * @param params - An object containing waiting parameters.
+     * @param params.timeout - The time, in milliseconds that the function should wait jobs. If
+     *   no one jobs are done during this time, the `TimeoutError` exception will be thrown.
+     * @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}
+     *   signal, which can be used to abort waiting as desired.
+     * @param params.onCheckout - Waiting progress callback. Return `true` to cancel waiting.
      */
     waitForDone(jobs: string | string[], waitAll?: boolean, params?: {
         timeout?: number;
@@ -481,31 +454,26 @@ export declare class File {
     }): Promise<this>;
     /**
      * Returns a list of file permissions.
-     *
-     * @async
      */
     getPermissions(): Promise<Permission[]>;
     /**
      * Returns the permission information.
      *
-     * @async
      * @param permissionId - Permission ID.
      */
     getPermission(permissionId: string): Promise<Permission>;
     /**
      * Create a new file permission.
      *
-     * @async
      * @param actions - Actions are allowed to be performed on a file with this permission. See
-     *   {@link Permission#actions | Permission.actions} for more details.
+     *   {@link Permission.actions} for more details.
      * @param grantedTo - A collection of principials that will get access to the file.
-     * @param public = false - Specifies whether all users have access to the file or not.
+     * @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.
      *
-     * @async
      * @param permissionId - Permission ID.
      * @returns Returns the raw data of a deleted permission.
      */
@@ -513,23 +481,22 @@ export declare class File {
     /**
      * Upload the new version of the file to the server and extract the geometry and properties as needed.
      *
-     * @async
-     * @param file - Web API <a href="https://developer.mozilla.org/docs/Web/API/File"
-     *   target="_blank">File</a> object are generally retrieved from a <a
-     *   href="https://developer.mozilla.org/docs/Web/API/FileList" target="_blank">FileList</a>
-     *   object returned as a result of a user selecting files using the HTML `<input>` element.
+     * @param file - Web API {@link https://developer.mozilla.org/docs/Web/API/File | 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=true - Create job to extract file geometry data. The geometry data
-     *   type is the same as the original file.
-     * @param params.properties=false - Create job to extract file properties.
-     * @param params.waitForDone=false - Wait for geometry and properties jobs to complete.
+     * @param params.geometry - Create job to extract 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.
      * @param params.timeout - The time, in milliseconds that the function should wait jobs. If
      *   no one jobs are done during this time, the `TimeoutError` exception will be thrown.
      * @param params.interval - The time, in milliseconds, the function should delay in between
      *   checking jobs status.
-     * @param params.signal - An <a
-     *   href="https://developer.mozilla.org/docs/Web/API/AbortController">AbortController</a>
-     *   signal object instance, which can be used to abort waiting as desired.
+     * @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.onProgress - Upload progress callback.
      */
     uploadVersion(file: globalThis.File, params?: {
@@ -543,28 +510,23 @@ export declare class File {
     }): Promise<File>;
     /**
      * Returns a list of version files.
-     *
-     * @async
      */
     getVersions(): Promise<File[]>;
     /**
      * Returns the version file.
      *
-     * @async
      * @param version - Desired version.
      */
     getVersion(version: number): Promise<File>;
     /**
      * Delete version file.
      *
-     * @async
      * @param version - Version to delete.
      */
     deleteVersion(version: number): Promise<any>;
     /**
      * Replace the active version of the file with the selected version.
      *
-     * @async
      * @param version - Desired active version.
      */
     setActiveVersion(version: number): Promise<this>;
@@ -588,8 +550,8 @@ export declare class File {
      * 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 [File.checkout()]{@link File#checkout} to
-     * match the size and status fields to the version you selected.
+     * Note. You need to update the file data using {@link checkout | checkout()} to match the
+     * size and status fields to the version you selected.
      */
     useVersion(version?: number): this;
 }

package/lib/Api/Job.d.ts

@@ -21,14 +21,14 @@ export declare class Job {
      */
     get assemblyId(): string;
     /**
-     * Job creator ID. Use {@link Client#getUser | Client.getUser()} to obtain detailed creator information.
+     * Job creator ID. Use {@link Client.getUser | Client.getUser()} to obtain detailed creator information.
      *
      * @readonly
      */
     get authorId(): string;
     /**
-     * Job creation time (UTC) in the format specified in <a
-     * href="https://www.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a>.
+     * Job creation time (UTC) in the format specified in
+     * {@link https://www.wikipedia.org/wiki/ISO_8601 | ISO 8601}.
      *
      * @readonly
      */
@@ -41,7 +41,7 @@ export declare class Job {
     get data(): any;
     private set data(value);
     /**
-     * `true` if job is `done` or `failed`. See {@link Job#status | status} for more details.
+     * `true` if job is `done` or `failed`. See {@link status} for more details.
      *
      * @readonly
      */
@@ -59,8 +59,8 @@ export declare class Job {
      */
     get id(): string;
     /**
-     * Job last update (UTC) time in the format specified in <a
-     * href="https://www.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a>.
+     * Job last update (UTC) time in the format specified in
+     * {@link https://www.wikipedia.org/wiki/ISO_8601 | ISO 8601}.
      *
      * @readonly
      */
@@ -91,16 +91,14 @@ export declare class Job {
      */
     get statusMessage(): string;
     /**
-     * Job starting time (UTC) in the format specified in <a
-     * href="https://www.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a>.
+     * Job starting time (UTC) in the format specified in
+     * {@link https://www.wikipedia.org/wiki/ISO_8601 | ISO 8601}.
      *
      * @readonly
      */
     get startedAt(): string;
     /**
      * Refresh job data.
-     *
-     * @async
      */
     checkout(): Promise<this>;
     /**
@@ -109,7 +107,6 @@ export declare class Job {
      * Only administrators can update job data. If the current logged in user is not an
      * administrator, an exception will be thrown.
      *
-     * @async
      * @param data - Raw job data.
      */
     update(data: any): Promise<this>;
@@ -117,22 +114,20 @@ export declare class Job {
      * Remove a job from the server job list. Jobs that are in progress or have already been
      * completed cannot be deleted.
      *
-     * @async
      * @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.
      *
-     * @async
      * @param params - An object containing waiting parameters.
      * @param params.timeout - The time, in milliseconds that the function should wait job. If
      *   jobs is not done during this time, the `TimeoutError` exception will be thrown.
      * @param params.interval - The time, in milliseconds, the function should delay in between
      *   checking job status.
-     * @param params.signal- An <a
-     *   href="https://developer.mozilla.org/docs/Web/API/AbortController">AbortController</a>
-     *   signal object instance, which can be used to abort waiting as desired.
+     * @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?: {

package/lib/Api/Member.d.ts

@@ -30,7 +30,7 @@ export declare class Member {
      */
     get id(): string;
     /**
-     * Member role. See {@link Project#getRoles | Project.getRoles()} for more details.
+     * Member role. See {@link Project.getRoles | Project.getRoles()} for more details.
      */
     get role(): string;
     set role(value: string);
@@ -56,29 +56,23 @@ export declare class Member {
     get user(): IShortUserDescription;
     /**
      * Refresh member data.
-     *
-     * @async
      */
     checkout(): Promise<this>;
     /**
      * Update member data on the server.
      *
-     * @async
      * @param data - Raw member data.
      */
     update(data: any): Promise<this>;
     /**
      * Remove a member from a project.
      *
-     * @async
      * @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.
-     *
-     * @async
      */
     save(): Promise<this>;
 }