@inweb/client 25.7.0 → 25.7.2

package/src/Api/Client.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
@@ -35,9 +35,9 @@ import { User } from "./User";
 import { parseArgs } from "./Utils";
 
 /**
- * The `Client.js` library class that provides methods to access the [Open Cloud
- * Server](https://cloud.opendesign.com/docs/index.html#/opencloud_server) resources like
- * Projects, Files, Issues etc.
+ * The `Client.js` library class that provides methods to access the
+ * {@link https://cloud.opendesign.com/docs/index.html#/opencloud_server | Open Cloud Server}
+ * resources like Projects, Files, Issues etc.
  */
 export class Client extends EventEmitter2<ClientEventMap> {
   private _serverUrl = "";
@@ -55,7 +55,7 @@ export class Client extends EventEmitter2<ClientEventMap> {
   }
 
   /**
-   * Open Cloud Server URL. Use {@link Client.configure()} to change server URL.
+   * Open Cloud Server URL. Use {@link configure | configure()} to change server URL.
    *
    * @readonly
    */
@@ -65,6 +65,8 @@ export class Client extends EventEmitter2<ClientEventMap> {
 
   /**
    * Deprecated since `25.3`. Use `Viewer.options()` instead to change Viewer parameters.
+   *
+   * @deprecated
    */
   get options(): any {
     console.warn(
@@ -130,8 +132,6 @@ export class Client extends EventEmitter2<ClientEventMap> {
 
   /**
    * Returns server version.
-   *
-   * @async
    */
   version(): Promise<any> {
     return this.httpClient
@@ -147,10 +147,9 @@ export class Client extends EventEmitter2<ClientEventMap> {
   /**
    * Register a new user with the specified email and password.
    *
-   * @async
    * @param email - User email. Cannot be empty.
    * @param password - User password. Cannot be empty. Password can only contain letters (a-z,
-   *   A-Z), numbers (0-9), and special characters (~!@#$%^&*()_-+={}[]:;"'`<>,.?|/\ ).
+   *   A-Z), numbers (0-9), and special characters (~!@#$%^&*()_-+={}[]<>|/'":;.,?).
    * @param userName - User name. Cannot be empty or blank if defined. Leave undefined to use
    *   `username` from email.
    */
@@ -168,7 +167,6 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * Resend the Confirmation Email to new user. If the user's email is already confirmed, an
    * exception will be thrown.
    *
-   * @async
    * @param email - User email.
    * @param password - User password.
    */
@@ -181,7 +179,6 @@ export class Client extends EventEmitter2<ClientEventMap> {
   /**
    * Confirm the user's email. If the user's email is already confirmed, an exception will be thrown.
    *
-   * @async
    * @param emailConfirmationId - Confirmation code from the Confirmation Email.
    */
   confirmUserEmail(emailConfirmationId: string): Promise<any> {
@@ -193,7 +190,6 @@ export class Client extends EventEmitter2<ClientEventMap> {
   /**
    * Log in an existing user using email or user name.
    *
-   * @async
    * @param email - An email or user name for authentication request.
    * @param password - Password for authentication request.
    */
@@ -208,7 +204,6 @@ export class Client extends EventEmitter2<ClientEventMap> {
   /**
    * Log in an existing user using access token (API Key).
    *
-   * @async
    * @param token - An access token for authentication request. See {@link User.token} for more details.
    */
   async signInWithToken(token: string): Promise<User> {
@@ -252,8 +247,6 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * - Open the `provider.url` link using `window.open()`.
    * - Add a `/oauth` path (server-defined) handler to the router. In this handler, show an error
    *   message if the `error` search parameter is present, or log in with the `token` search parameter.
-   *
-   * @async
    */
   getIdentityProviders(): Promise<any> {
     return this.httpClient.get("/identity").then((response) => response.json());
@@ -261,8 +254,6 @@ export class Client extends EventEmitter2<ClientEventMap> {
 
   /**
    * Returns the current server settings.
-   *
-   * @async
    */
   getServerSettings(): Promise<any> {
     return this.httpClient.get("/settings").then((response) => response.json());
@@ -273,8 +264,6 @@ export class Client extends EventEmitter2<ClientEventMap> {
    *
    * Only administrators can change server settings. If the current logged in user is not an
    * administrator, an exception will be thrown.
-   *
-   * @async
    */
   updateServerSettings(settings: any): Promise<any> {
     return this.httpClient.put("/settings", settings).then((response) => response.json());
@@ -285,8 +274,6 @@ export class Client extends EventEmitter2<ClientEventMap> {
    *
    * Only administrators can get a list of users. If the current logged in user is not an
    * administrator, an exception will be thrown.
-   *
-   * @async
    */
   getUsers(): Promise<User[]> {
     return this.httpClient
@@ -302,7 +289,6 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * Only administrators can get other users. If the current logged in user is not an
    * administrator, they can only get themselves, otherwise an exception will be thrown.
    *
-   * @async
    * @param userId - User ID.
    */
   getUser(userId: string): Promise<User> {
@@ -329,10 +315,9 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * Only administrators can create users. If the current logged in user is not an
    * administrator, an exception will be thrown.
    *
-   * @async
    * @param email - User email. Cannot be empty.
    * @param password - User password. Cannot be empty. Password can only contain latin letters
-   *   (a-z, A-Z), numbers (0-9), and special characters (~!@#$%^&*()_-+={}[]:;"'`<>,.?|/\ ).
+   *   (a-z, A-Z), numbers (0-9), and special characters (~!@#$%^&*()_-+={}[]<>|/'":;.,?).
    * @param params - Additional user data.
    * @param params.isAdmin - `true` if user is an administrator.
    * @param params.userName - User name. Cannot be empty or blank if defined. Leave undefined
@@ -383,7 +368,6 @@ export class Client extends EventEmitter2<ClientEventMap> {
    *
    * You need to re-login to continue working after deleting the current logged in user.
    *
-   * @async
    * @param userId - User ID.
    * @returns Returns the raw data of a deleted user.
    */
@@ -417,16 +401,15 @@ export class Client extends EventEmitter2<ClientEventMap> {
   /**
    * Returns a list of files the user has access to.
    *
-   * @async
    * @param start - The starting index in the file list. Used for paging.
    * @param limit - The maximum number of files that should be returned per request. Used for paging.
    * @param name - Filter the files by part of the name.
    * @param ext - Filter the files by extension. Extension can be `dgn`, `dwf`, `dwg`, `dxf`,
    *   `ifc`, `ifczip`, `nwc`, `nwd`, `obj`, `rcs`, `rfa`, `rvt`, `step`, `stl`, `stp`, `vsf`,
    *   or any other drawing or reference file type extension. You can specify multiple
-   *   extensions on one `string` by separating them with a "|".
+   *   extensions on one string by separating them with a `|`.
    * @param ids - List of file IDs to return. You can specify multiple IDs on one `string` by
-   *   separating them with a "|".
+   *   separating them with a `|`.
    * @param sortByDesc - Allows to specify the descending order of the result. By default,
    *   files are sorted by name in ascending order.
    * @param {string} sortField - Allows to specify sort field.
@@ -473,7 +456,6 @@ export class Client extends EventEmitter2<ClientEventMap> {
   /**
    * Returns the file information.
    *
-   * @async
    * @param fileId - File ID.
    */
   getFile(fileId: string): Promise<File> {
@@ -490,27 +472,26 @@ export class Client extends EventEmitter2<ClientEventMap> {
    *
    * - {@link UploadProgressEvent | uploadprogress}
    *
-   * @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. Can be:
+   * @param params.geometry - Create job to extract file geometry data. Can be:
    *
    *   - `true` - Extract file geometry data into `VSFX` to open the file in `VisualizeJS` viewer.
    *   - `vsfx` - Extract file geometry data into `VSFX` to open the file in `VisualizeJS` viewer.
    *   - `gltf` - Extract file geometry data into `glTF` to open the file in `Three.js` viewer.
    *
-   * @param params.properties=false - Create job to extract file properties.
-   * @param params.waitForDone=false - Wait for geometry and properties jobs to complete.
+   * @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.
    */
   async uploadFile(
@@ -552,7 +533,6 @@ export class Client extends EventEmitter2<ClientEventMap> {
   /**
    * Delete the drawing or reference file from the server.
    *
-   * @async
    * @param fileId - File ID.
    * @returns Returns the raw data of a deleted file.
    */
@@ -563,12 +543,11 @@ export class Client extends EventEmitter2<ClientEventMap> {
   /**
    * Download the drawing or reference file.
    *
-   * @async
    * @param fileId - File ID.
    * @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.
    */
   downloadFile(fileId: string, onProgress?: (progress: number) => void, signal?: AbortSignal): Promise<ArrayBuffer> {
     return this.httpClient
@@ -590,7 +569,6 @@ export class Client extends EventEmitter2<ClientEventMap> {
   /**
    * Returns a list of jobs created by current user.
    *
-   * @async
    * @param status - Filter the jobs by status. Status can be `waiting`, `inpogress`, `done` or
    *   `failed`. You can specify multiple statuses on one `string` by separating them with a "|".
    * @param limit - The maximum number of jobs that should be returned per request. Used for paging.
@@ -632,7 +610,6 @@ export class Client extends EventEmitter2<ClientEventMap> {
   /**
    * Returns the job information.
    *
-   * @async
    * @param jobId - Job ID.
    */
   getJob(jobId: string): Promise<Job> {
@@ -645,7 +622,6 @@ export class Client extends EventEmitter2<ClientEventMap> {
   /**
    * Create a new job.
    *
-   * @async
    * @param fileId - File ID.
    * @param outputFormat - The job type. Can be one of:
    *
@@ -658,7 +634,7 @@ export class Client extends EventEmitter2<ClientEventMap> {
    *       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(fileId: string, outputFormat: string, parameters?: string | object): Promise<Job> {
     return this.httpClient
@@ -675,7 +651,6 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * Remove a job from the server job list. The method does not delete or stop jobs that are
    * already being executed.
    *
-   * @async
    * @param jobId - Job ID.
    * @returns Returns the raw data of a deleted job.
    */
@@ -697,7 +672,6 @@ export class Client extends EventEmitter2<ClientEventMap> {
   /**
    * Returns a list of assemblies the user has access to.
    *
-   * @async
    * @param start - The starting index in the assembly list. Used for paging.
    * @param limit - The maximum number of assemblies that should be returned per request. Used
    *   for paging.
@@ -745,7 +719,6 @@ export class Client extends EventEmitter2<ClientEventMap> {
   /**
    * Get assembly information.
    *
-   * @async
    * @param assemblyId - Assembly ID.
    */
   getAssembly(assemblyId: string): Promise<Assembly> {
@@ -758,11 +731,10 @@ export class Client extends EventEmitter2<ClientEventMap> {
   /**
    * Create a new assembly.
    *
-   * @async
    * @param files - List of file IDs.
    * @param name - Assembly name.
    * @param params - An object containing upload parameters.
-   * @param params.waitForDone=false - Wait for assembly to be created.
+   * @param params.waitForDone - Wait for assembly to be created.
    */
   createAssembly(
     files: string[],
@@ -785,7 +757,6 @@ export class Client extends EventEmitter2<ClientEventMap> {
   /**
    * Delete the assembly from the server.
    *
-   * @async
    * @param assemblyId - Assembly ID.
    * @returns Returns the raw data of a deleted assembly.
    */
@@ -807,7 +778,6 @@ export class Client extends EventEmitter2<ClientEventMap> {
   /**
    * Returns a list of projects the user has access to.
    *
-   * @async
    * @param start - The starting index in the project list. Used for paging.
    * @param limit - The maximum number of projects that should be returned per request. Used for paging.
    * @param name - Filter the projects by part of the name.
@@ -870,7 +840,6 @@ export class Client extends EventEmitter2<ClientEventMap> {
   /**
    * Returns the project information.
    *
-   * @async
    * @param projectId - Project ID.
    */
   getProject(projectId: string): Promise<Project> {
@@ -883,7 +852,6 @@ export class Client extends EventEmitter2<ClientEventMap> {
   /**
    * Create a new project.
    *
-   * @async
    * @param name - Project name.
    * @param description - Project description.
    * @param startDate - Project start date.
@@ -909,7 +877,6 @@ export class Client extends EventEmitter2<ClientEventMap> {
   /**
    * Delete the project from the server.
    *
-   * @async
    * @param projectId - Project ID.
    * @returns Returns the raw data of a deleted project.
    */

package/src/Api/ClientEvents.ts

@@ -1,5 +1,5 @@
 /**
- * A {@link Client | Client} event measuring progress of an file uploading process.
+ * An event measuring progress of an file uploading process.
  *
  * @event
  */
@@ -22,10 +22,12 @@ export interface UploadProgressEvent {
 
 /**
  * Client events.
+ *
+ * @event
  */
 export interface ClientEventMap {
   /**
-   * A {@link Client | Client} event measuring progress of an file uploading process.
+   * An event measuring progress of an file uploading process.
    */
   uploadprogress: UploadProgressEvent;
 }

package/src/Api/Fetch.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/FetchError.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
@@ -110,11 +110,9 @@ export class FetchError extends Error {
   protected statusText: string;
 
   /**
-   * @property status - The <a href="https://developer.mozilla.org/docs/Web/HTTP/Status" target
-   *   ="_blank">HTTP status code</a> of the response.
-   * @property message - Error message. Inherited from <a
-   *   href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error"
-   *   target ="_blank">Error</a>.
+   * @property status - The
+   *   {@link https://developer.mozilla.org/docs/Web/HTTP/Status | HTTP status code} of the response.
+   * @property message - Error message.
    */
   constructor(status: number, message?: string) {
     super(message || statusText(status));