@inweb/client 25.7.0 → 25.7.2

package/src/Api/Job.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
@@ -63,7 +63,7 @@ export class Job {
   }
 
   /**
-   * 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
    */
@@ -72,8 +72,8 @@ export class Job {
   }
 
   /**
-   * 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
    */
@@ -95,7 +95,7 @@ export class Job {
   }
 
   /**
-   * `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
    */
@@ -122,8 +122,8 @@ export class Job {
   }
 
   /**
-   * 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
    */
@@ -169,8 +169,8 @@ export class Job {
   }
 
   /**
-   * 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
    */
@@ -180,8 +180,6 @@ export class Job {
 
   /**
    * Refresh job data.
-   *
-   * @async
    */
   async checkout(): Promise<this> {
     const response = await this.internalGet();
@@ -195,7 +193,6 @@ export 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.
    */
   async update(data: any): Promise<this> {
@@ -208,7 +205,6 @@ export 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> {
@@ -219,7 +215,7 @@ export class Job {
   //  * Save job data changes to the server. Call this method to update job data on the server
   //  * after any changes.
   //  *
-  //  * @async
+  //  *
   //  * @returns {Promise<Job>}
   //  */
   // save() {
@@ -229,15 +225,14 @@ export class Job {
   /**
    * 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/src/Api/Member.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
@@ -82,7 +82,7 @@ export class Member {
   }
 
   /**
-   * 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 {
     return this.data.role;
@@ -120,8 +120,6 @@ export class Member {
 
   /**
    * Refresh member data.
-   *
-   * @async
    */
   async checkout(): Promise<this> {
     const response = await this.internalGet();
@@ -132,7 +130,6 @@ export class Member {
   /**
    * Update member data on the server.
    *
-   * @async
    * @param data - Raw member data.
    */
   async update(data: any): Promise<this> {
@@ -144,7 +141,6 @@ export class Member {
   /**
    * Remove a member from a project.
    *
-   * @async
    * @returns Returns the raw data of a deleted member.
    */
   delete(): Promise<any> {
@@ -154,8 +150,6 @@ export class Member {
   /**
    * Save member data changes to the server. Call this method to update member data on the
    * server after any changes.
-   *
-   * @async
    */
   save(): Promise<this> {
     return this.update(this.data);

package/src/Api/Model.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
@@ -69,8 +69,8 @@ export class Model {
   }
 
   /**
-   * Scene description resource file name. Use {@link Model.downloadResource()} to download
-   * scene description file.
+   * Scene description resource file name. Use {@link downloadResource | downloadResource()} to
+   * download scene description file.
    *
    * @readonly
    */
@@ -106,8 +106,8 @@ export class Model {
   }
 
   /**
-   * The list of geometry data resource files. Use {@link Model.downloadResource()} to download
-   * geometry data files.
+   * The list of geometry data resource files. Use {@link downloadResource | downloadResource()}
+   * to download geometry data files.
    *
    * @readonly
    */
@@ -150,8 +150,6 @@ export class Model {
 
   /**
    * Returns model list with one item `self`.
-   *
-   * @async
    */
   getModels(): Promise<Model[]> {
     return Promise.resolve([this]);
@@ -169,7 +167,6 @@ export class Model {
   /**
    * Set or delete a model transformation.
    *
-   * @async
    * @param handle - Model handle.
    * @param transform - Transformation matrix. To delete transformation provide this to `undefined`.
    */
@@ -179,8 +176,6 @@ export class Model {
 
   /**
    * Returns model viewpoint list.
-   *
-   * @async
    */
   getViewpoints(): Promise<any[]> {
     return this._file
@@ -195,7 +190,6 @@ export class Model {
   /**
    * Add new model viewpoint. To create a new viewpoint use `Viewer.createViewpoint()`.
    *
-   * @async
    * @param viewpoint - Viewpoint.
    */
   saveViewpoint(viewpoint: any): Promise<any> {
@@ -208,7 +202,6 @@ export class Model {
   /**
    * Delete model viewpoint.
    *
-   * @async
    * @param guid - Viewpoint GUID.
    * @returns Returns the raw data of a deleted viewpoint.
    */
@@ -220,7 +213,6 @@ export class Model {
    * Returns viewpoint preview image as
    * {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL}.
    *
-   * @async
    * @param guid - Viewpoint GIID.
    */
   getSnapshot(guid: string): Promise<string> {
@@ -230,7 +222,6 @@ export class Model {
   /**
    * Returns snapshot data.
    *
-   * @async
    * @param guid - Viewpoint GUID.
    * @param bitmapGuid - Bitmap GUID.
    */
@@ -242,12 +233,11 @@ export class Model {
    * Download model resource file. Resource files are files that contain model scene
    * descriptions, or geometry data.
    *
-   * @async
    * @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,
@@ -265,9 +255,9 @@ export class Model {
    * @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,
@@ -280,7 +270,9 @@ export class Model {
   }
 
   /**
-   * Deprecated since `25.3`. Use {@link Model.downloadResource()} instead.
+   * Deprecated since `25.3`. Use {@link downloadResource | downloadResource()} instead.
+   *
+   * @deprecated
    */
   partialDownloadResource(
     dataId: string,
@@ -294,7 +286,9 @@ export class Model {
   }
 
   /**
-   * Deprecated since `25.3`. Use {@link Model.downloadResourceRange()} instead.
+   * Deprecated since `25.3`. Use {@link downloadResourceRange | downloadResourceRange()} instead.
+   *
+   * @deprecated
    */
   async downloadFileRange(
     requestId: number,
@@ -326,10 +320,9 @@ export class Model {
   /**
    * Returns a list of references to files used to extract geometry data.
    *
-   * @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<any> {
     return this._file.getReferences(signal);

package/src/Api/Permission.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
@@ -131,8 +131,6 @@ export class Permission {
 
   /**
    * Refresh permission data.
-   *
-   * @async
    */
   async checkout(): Promise<this> {
     const response = await this.internalGet();
@@ -143,7 +141,6 @@ export class Permission {
   /**
    * Update permission data on the server.
    *
-   * @async
    * @param data - Raw permission data.
    */
   async update(data: any): Promise<this> {
@@ -155,7 +152,6 @@ export class Permission {
   /**
    * Remove a permission from a file.
    *
-   * @async
    * @returns Returns the raw data of a deleted permission.
    */
   delete(): Promise<any> {
@@ -165,8 +161,6 @@ export class Permission {
   /**
    * Save permission data changes to the server. Call this method to update permission data on
    * the server after any changes.
-   *
-   * @async
    */
   save(): Promise<this> {
     return this.update(this.data);

package/src/Api/Project.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
@@ -71,8 +71,8 @@ export class Project {
   }
 
   /**
-   * Project creation time (UTC) in the format specified in <a
-   * href="https://www.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a>.
+   * Project creation time (UTC) in the format specified in
+   * {@link https://www.wikipedia.org/wiki/ISO_8601 | ISO 8601}.
    *
    * @readonly
    */
@@ -122,8 +122,8 @@ export class Project {
   }
 
   /**
-   * Project end date in the format specified in <a
-   * href="https://www.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a>.
+   * Project end date in the format specified in
+   * {@link https://www.wikipedia.org/wiki/ISO_8601 | ISO 8601}.
    */
   get endDate(): string {
     return this.data.endDate;
@@ -210,8 +210,8 @@ export class Project {
   }
 
   /**
-   * Project start date in the format specified in <a
-   * href="https://www.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a>.
+   * Project start date in the format specified in
+   * {@link https://www.wikipedia.org/wiki/ISO_8601 | ISO 8601}.
    */
   get startDate(): string {
     return this.data.startDate;
@@ -231,8 +231,8 @@ export class Project {
   }
 
   /**
-   * Project last update time (UTC) in the format specified in <a
-   * href="https://www.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a>.
+   * Project last update time (UTC) in the format specified in
+   * {@link https://www.wikipedia.org/wiki/ISO_8601 | ISO 8601}.
    *
    * @readonly
    */
@@ -242,8 +242,6 @@ export class Project {
 
   /**
    * Refresh project data.
-   *
-   * @async
    */
   async checkout(): Promise<this> {
     const response = await this.internalGet("");
@@ -254,7 +252,6 @@ export class Project {
   /**
    * Update project data on the server.
    *
-   * @async
    * @param data - Raw project data.
    */
   async update(data: any): Promise<this> {
@@ -266,7 +263,6 @@ export class Project {
   /**
    * Delete the project from the server.
    *
-   * @async
    * @returns Returns the raw data of a deleted project.
    */
   delete(): Promise<any> {
@@ -285,8 +281,6 @@ export class Project {
   /**
    * Save project data changes to the server. Call this method to update project data on the
    * server after any changes.
-   *
-   * @async
    */
   save(): Promise<this> {
     return this.update(this.data);
@@ -295,7 +289,6 @@ export class Project {
   /**
    * Set or remove the project 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,
@@ -317,8 +310,6 @@ export class Project {
 
   /**
    * Remove the project preview.
-   *
-   * @async
    */
   async deletePreview(): Promise<this> {
     const response = await this.internalDelete("/preview");
@@ -327,10 +318,8 @@ export class Project {
   }
 
   /**
-   * Returns a list of project roles. Project {@link Member | members} have different abilities
-   * depending on the role they have in a project.
-   *
-   * @async
+   * Returns a list of project roles. Project members have different abilities depending on the
+   * role they have in a project.
    */
   getRoles(): Promise<Role[]> {
     return this.internalGet("/roles")
@@ -341,7 +330,6 @@ export class Project {
   /**
    * Returns the role information.
    *
-   * @async
    * @param name - Role name.
    */
   getRole(name: string): Promise<Role> {
@@ -353,11 +341,10 @@ export class Project {
   /**
    * Create a new project role.
    *
-   * @async
    * @param name - Role name.
    * @param description - Role description.
-   * @param permissions - Actions are allowed to be performed. See
-   *   {@link Role#permissions | Role.permissions} for more details.
+   * @param permissions - Actions are allowed to be performed. See {@link Role.permissions} for
+   *   more details.
    */
   createRole(name: string, description: string, permissions: any): Promise<Role> {
     return this.internalPost("/roles", {
@@ -372,7 +359,6 @@ export class Project {
   /**
    * Delete project role.
    *
-   * @async
    * @param name - Role name.
    * @returns Returns the raw data of a deleted role.
    */
@@ -382,8 +368,6 @@ export class Project {
 
   /**
    * Returns a list of project members.
-   *
-   * @async
    */
   getMembers(): Promise<Member[]> {
     return this.internalGet("/members")
@@ -394,7 +378,6 @@ export class Project {
   /**
    * Returns the member information.
    *
-   * @async
    * @param memberId - Member ID.
    */
   getMember(memberId: string): Promise<Member> {
@@ -406,7 +389,6 @@ export class Project {
   /**
    * Add a user to the project to become a member and have permission to perform actions.
    *
-   * @async
    * @param userId - User ID.
    * @param role - User role from the list of project roles.
    */
@@ -419,7 +401,6 @@ export class Project {
   /**
    * Remove a member from a project.
    *
-   * @async
    * @param memberId - Member ID.
    * @returns Returns the raw data of a deleted member.
    */
@@ -442,9 +423,7 @@ export class Project {
 
   /**
    * Returns a list of project files. To add a file to this list, create a `project` permission
-   * on the file using {@link File#createPermission | File.createPermission()}.
-   *
-   * @async
+   * on the file using {@link File.createPermission | File.createPermission()}.
    */
   getFilesInformation(): Promise<any[]> {
     return this.httpClient

package/src/Api/Role.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
@@ -116,8 +116,6 @@ export class Role {
 
   /**
    * Refresh role data.
-   *
-   * @async
    */
   async checkout(): Promise<this> {
     const response = await this.internalGet();
@@ -128,7 +126,6 @@ export class Role {
   /**
    * Update role data on the server.
    *
-   * @async
    * @param data - Raw role data.
    */
   async update(data: any): Promise<this> {
@@ -140,7 +137,6 @@ export class Role {
   /**
    * Delete a role from the project.
    *
-   * @async
    * @returns Returns the raw data of a deleted role.
    */
   delete(): Promise<any> {
@@ -150,8 +146,6 @@ export class Role {
   /**
    * Save role data changes to the server. Call this method to update role data on the server
    * after any changes.
-   *
-   * @async
    */
   save(): Promise<this> {
     return this.update(this.data);