@inweb/client 25.7.0 → 25.7.2

package/src/Api/File.ts

@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
-// Copyright (C) 2002-2023, Open Design Alliance (the "Alliance").
+// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance").
 // All rights reserved.
 //
 // This software and its documentation and related materials are owned by
@@ -14,7 +14,7 @@
 //
 //   This application incorporates Open Design Alliance software pursuant to a
 //   license agreement with Open Design Alliance.
-//   Open Design Alliance Copyright (C) 2002-2021 by Open Design Alliance.
+//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance.
 //   All rights reserved.
 //
 // By use of this software, its documentation or related materials, you
@@ -84,8 +84,8 @@ export class File {
   }
 
   /**
-   * 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
    */
@@ -145,7 +145,8 @@ export 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
    */
@@ -216,7 +217,7 @@ export class File {
 
   /**
    * 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
    */
@@ -271,8 +272,8 @@ export class File {
   }
 
   /**
-   * 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
    */
@@ -316,8 +317,6 @@ export class File {
 
   /**
    * Refresh file data.
-   *
-   * @async
    */
   async checkout(): Promise<this> {
     const response = await this.internalGet("");
@@ -328,7 +327,6 @@ export class File {
   /**
    * Update file data on the server.
    *
-   * @async
    * @param data - Raw file data.
    */
   async update(data: any): Promise<this> {
@@ -340,7 +338,6 @@ export class File {
   /**
    * Delete the file and all its versions from the server.
    *
-   * @async
    * @returns Returns the raw data of a deleted file.
    */
   delete(): Promise<any> {
@@ -350,8 +347,6 @@ export class File {
   /**
    * Save file data changes to the server. Call this method to update file data on the server
    * after any changes.
-   *
-   * @async
    */
   save(): Promise<this> {
     return this.update(this.data);
@@ -360,7 +355,6 @@ export class File {
   /**
    * 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,
@@ -381,8 +375,6 @@ export class File {
 
   /**
    * Remove the file preview.
-   *
-   * @async
    */
   async deletePreview(): Promise<this> {
     const response = await this.internalDelete("/preview");
@@ -392,8 +384,6 @@ export class File {
 
   /**
    * Returns a list of models of the active version of the file.
-   *
-   * @async
    */
   getModels(): Promise<Model[]> {
     return this.internalGet("/geometry")
@@ -423,7 +413,6 @@ export 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.
    */
@@ -452,7 +441,6 @@ export 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",
@@ -483,8 +471,6 @@ export class File {
 
   /**
    * Returns the cda.json for an active version of the file.
-   *
-   * @async
    */
   getCdaTree(): Promise<any[]> {
     return this.internalGet(`/properties/tree`).then((response) => response.json());
@@ -492,8 +478,6 @@ export class File {
 
   /**
    * Returns a list of file viewpoints.
-   *
-   * @async
    */
   getViewpoints(): Promise<any[]> {
     return this.internalGet("/viewpoints")
@@ -502,9 +486,8 @@ export class File {
   }
 
   /**
-   * 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> {
@@ -514,7 +497,6 @@ export class File {
   /**
    * Delete file viewpoint.
    *
-   * @async
    * @param guid - Viewpoint GUID.
    * @returns Returns the raw data of a deleted viewpoint.
    */
@@ -526,7 +508,6 @@ export 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> {
@@ -536,7 +517,6 @@ export class File {
   /**
    * Returns viewpoint preview data.
    *
-   * @async
    * @param guid - Viewpoint GUID.
    * @param bitmapGuid - Bitmap GUID.
    */
@@ -547,11 +527,10 @@ export 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> {
     const relativePath = this.appendVersionParam("/downloads");
@@ -575,9 +554,9 @@ export 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,
@@ -598,9 +577,9 @@ export 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,
@@ -616,7 +595,9 @@ export class File {
   }
 
   /**
-   * Deprecated since `25.3`. Use {@link File.downloadResource()} instead.
+   * Deprecated since `25.3`. Use {@link downloadResource | downloadResource()} instead.
+   *
+   * @deprecated
    */
   partialDownloadResource(
     dataId: string,
@@ -630,7 +611,9 @@ export class File {
   }
 
   /**
-   * Deprecated since `25.3`. Use {@link File.downloadResourceRange()} instead.
+   * Deprecated since `25.3`. Use {@link downloadResourceRange | downloadResourceRange()} instead.
+   *
+   * @deprecated
    */
   async downloadFileRange(
     requestId: number,
@@ -645,10 +628,9 @@ export class File {
   /**
    * 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> {
     return this.internalGet("/references", signal).then((response) => response.json());
@@ -657,7 +639,6 @@ export class File {
   /**
    * Set the file references.
    *
-   * @async
    * @param references - File references.
    */
   setReferences(references: IFileReferences): Promise<IFileReferences> {
@@ -667,7 +648,6 @@ export class File {
   /**
    * 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`.
@@ -675,14 +655,13 @@ export 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> {
     const relativePath = this.appendVersionParam("/jobs");
@@ -698,16 +677,15 @@ export class File {
 
   /**
    * 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> {
     return this.createJob(type === "gltf" ? "geometryGltf" : "geometry", parameters);
@@ -715,11 +693,10 @@ export class File {
 
   /**
    * 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> {
     return this.createJob("properties", parameters);
@@ -727,14 +704,12 @@ export class File {
 
   /**
    * 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> {
     return this.createJob("validation", parameters);
@@ -744,22 +719,20 @@ export class File {
    * 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[],
@@ -790,8 +763,6 @@ export class File {
 
   /**
    * Returns a list of file permissions.
-   *
-   * @async
    */
   getPermissions(): Promise<Permission[]> {
     return this.internalGet("/permissions")
@@ -802,7 +773,6 @@ export class File {
   /**
    * Returns the permission information.
    *
-   * @async
    * @param permissionId - Permission ID.
    */
   getPermission(permissionId: string): Promise<Permission> {
@@ -814,11 +784,10 @@ export class File {
   /**
    * 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> {
     return this.internalPost("/permissions", {
@@ -833,7 +802,6 @@ export class File {
   /**
    * Delete file permission.
    *
-   * @async
    * @param permissionId - Permission ID.
    * @returns Returns the raw data of a deleted permission.
    */
@@ -844,23 +812,22 @@ export 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.
    */
 
@@ -905,8 +872,6 @@ export class File {
 
   /**
    * Returns a list of version files.
-   *
-   * @async
    */
   getVersions(): Promise<File[]> {
     return this.internalGet("/versions")
@@ -918,7 +883,6 @@ export class File {
   /**
    * Returns the version file.
    *
-   * @async
    * @param version - Desired version.
    */
   getVersion(version: number): Promise<File> {
@@ -931,7 +895,6 @@ export class File {
   /**
    * Delete version file.
    *
-   * @async
    * @param version - Version to delete.
    */
   async deleteVersion(version: number): Promise<any> {
@@ -944,7 +907,6 @@ export class File {
   /**
    * Replace the active version of the file with the selected version.
    *
-   * @async
    * @param version - Desired active version.
    */
 
@@ -972,8 +934,8 @@ export 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 {
     this._useVersion = version;

package/src/Api/HttpClient.ts

@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
-// Copyright (C) 2002-2021, Open Design Alliance (the "Alliance").
+// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance").
 // All rights reserved.
 //
 // This software and its documentation and related materials are owned by
@@ -14,7 +14,7 @@
 //
 //   This application incorporates Open Design Alliance software pursuant to a
 //   license agreement with Open Design Alliance.
-//   Open Design Alliance Copyright (C) 2002-2021 by Open Design Alliance.
+//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance.
 //   All rights reserved.
 //
 // By use of this software, its documentation or related materials, you

package/src/Api/IAssembly.ts

@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
-// Copyright (C) 2002-2021, Open Design Alliance (the "Alliance").
+// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance").
 // All rights reserved.
 //
 // This software and its documentation and related materials are owned by
@@ -14,7 +14,7 @@
 //
 //   This application incorporates Open Design Alliance software pursuant to a
 //   license agreement with Open Design Alliance.
-//   Open Design Alliance Copyright (C) 2002-2021 by Open Design Alliance.
+//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance.
 //   All rights reserved.
 //
 // By use of this software, its documentation or related materials, you

package/src/Api/IFile.ts

@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
-// Copyright (C) 2002-2023, Open Design Alliance (the "Alliance").
+// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance").
 // All rights reserved.
 //
 // This software and its documentation and related materials are owned by
@@ -14,7 +14,7 @@
 //
 //   This application incorporates Open Design Alliance software pursuant to a
 //   license agreement with Open Design Alliance.
-//   Open Design Alliance Copyright (C) 2002-2021 by Open Design Alliance.
+//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance.
 //   All rights reserved.
 //
 // By use of this software, its documentation or related materials, you

package/src/Api/IHttpClient.ts

@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
-// Copyright (C) 2002-2021, Open Design Alliance (the "Alliance").
+// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance").
 // All rights reserved.
 //
 // This software and its documentation and related materials are owned by
@@ -14,7 +14,7 @@
 //
 //   This application incorporates Open Design Alliance software pursuant to a
 //   license agreement with Open Design Alliance.
-//   Open Design Alliance Copyright (C) 2002-2021 by Open Design Alliance.
+//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance.
 //   All rights reserved.
 //
 // By use of this software, its documentation or related materials, you

package/src/Api/IUser.ts

@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
-// Copyright (C) 2002-2021, Open Design Alliance (the "Alliance").
+// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance").
 // All rights reserved.
 //
 // This software and its documentation and related materials are owned by
@@ -14,7 +14,7 @@
 //
 //   This application incorporates Open Design Alliance software pursuant to a
 //   license agreement with Open Design Alliance.
-//   Open Design Alliance Copyright (C) 2002-2021 by Open Design Alliance.
+//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance.
 //   All rights reserved.
 //
 // By use of this software, its documentation or related materials, you