@inweb/client 25.7.0 → 25.7.2

package/src/Api/Assembly.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
@@ -90,8 +90,8 @@ export class Assembly {
   }
 
   /**
-   * Assembly creation time (UTC) in the format specified in <a
-   * href="https://www.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a>.
+   * Assembly creation time (UTC) in the format specified in
+   * {@link https://www.wikipedia.org/wiki/ISO_8601 | ISO 8601}.
    *
    * @readonly
    */
@@ -228,8 +228,6 @@ export class Assembly {
 
   /**
    * Refresh assembly data.
-   *
-   * @async
    */
   async checkout(): Promise<this> {
     const response = await this.internalGet("");
@@ -240,7 +238,6 @@ export class Assembly {
   /**
    * Updates assembly data on the server.
    *
-   * @async
    * @param data - Raw assembly data.
    */
   async update(data: any): Promise<this> {
@@ -252,7 +249,6 @@ export class Assembly {
   /**
    * Delete the assembly from the server.
    *
-   * @async
    * @returns Returns the raw data of a deleted assembly.
    */
   delete(): Promise<any> {
@@ -262,8 +258,6 @@ export class Assembly {
   /**
    * Save assembly data changes to the server. Call this method to update assembly data on the
    * server after any changes.
-   *
-   * @async
    */
   save(): Promise<this> {
     return this.update(this.data);
@@ -283,8 +277,6 @@ export class Assembly {
 
   /**
    * Returns list of assembly models.
-   *
-   * @async
    */
   getModels(): Promise<Model[]> {
     return this.internalGet("/geometry")
@@ -321,7 +313,6 @@ export class Assembly {
   /**
    * Set or delete a model transformation.
    *
-   * @async
    * @param handle - Model handle.
    * @param transform - Transformation matrix. To delete transformation provide this to `undefined`.
    */
@@ -334,7 +325,6 @@ export class Assembly {
   /**
    * Returns the properties for an objects in the assembly.
    *
-   * @async
    * @param handles - Object original handle or handles array. Leave this parameter undefined
    *   to get properties for all objects in the assembly.
    * @returns {Promise<any>}
@@ -348,7 +338,6 @@ export class Assembly {
    * Returns the list of original handles for an objects in 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",
@@ -376,8 +365,6 @@ export class Assembly {
 
   /**
    * Returns the cda.json for an assembly.
-   *
-   * @async
    */
   getCdaTree(): Promise<any[]> {
     return this.internalGet(`/properties/tree`).then((response) => response.json());
@@ -385,8 +372,6 @@ export class Assembly {
 
   /**
    * Returns a list of assembly viewpoints.
-   *
-   * @async
    */
   getViewpoints(): Promise<any[]> {
     return this.internalGet("/viewpoints")
@@ -395,9 +380,8 @@ export class Assembly {
   }
 
   /**
-   * Add new assembly viewpoint. To create a new viewpoint use {@link Viewer.createViewpoint()}.
+   * Add new assembly viewpoint. To create a viewpoint use `Viewer.createViewpoint()`.
    *
-   * @async
    * @param viewpoint - Viewpoint.
    */
   saveViewpoint(viewpoint: any): Promise<any> {
@@ -407,7 +391,6 @@ export class Assembly {
   /**
    * Delete assembly viewpoint.
    *
-   * @async
    * @param guid - Viewpoint GUID.
    * @returns Returns the raw data of a deleted viewpoint.
    */
@@ -419,7 +402,6 @@ export class Assembly {
    * 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: any): Promise<any> {
@@ -429,7 +411,6 @@ export class Assembly {
   /**
    * Returns viewpoint preview data.
    *
-   * @async
    * @param guid - Viewpoint GUID.
    * @param bitmapGuid - Bitmap GUID.
    */
@@ -441,12 +422,11 @@ export class Assembly {
    * Download assembly 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,
@@ -467,9 +447,9 @@ export class Assembly {
    * @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,
@@ -485,7 +465,9 @@ export class Assembly {
   }
 
   /**
-   * Deprecated since `25.3`. Use {@link Assembly.downloadResource()} instead.
+   * Deprecated since `25.3`. Use {@link downloadResource | downloadResource()} instead.
+   *
+   * @deprecated
    */
   partialDownloadResource(
     dataId: string,
@@ -499,7 +481,7 @@ export class Assembly {
   }
 
   /**
-   * Deprecated since `25.3`. Use {@link Assembly.downloadResourceRange()} instead.
+   * Deprecated since `25.3`. Use {@link downloadResourceRange | downloadResourceRange()} instead.
    */
   async downloadFileRange(
     requestId: number,
@@ -520,15 +502,14 @@ export class Assembly {
   /**
    * Wait for assembly to be created. Assembly is created 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 assembly.
    *   If assembly is not created during this time, the `TimeoutError` exception will be thrown.
    * @param params.interval - The time, in milliseconds, the function should delay in between
    *   checking assembly 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?: {
@@ -550,7 +531,6 @@ export class Assembly {
   /**
    * Returns a list of assembly clash tests.
    *
-   * @async
    * @param {number} start - The starting index in the test list. Used for paging.
    * @param {number} limit - The maximum number of tests that should be returned per request.
    *   Used for paging.
@@ -597,7 +577,6 @@ export class Assembly {
   /**
    * Returns the assembly clash test information.
    *
-   * @async
    * @param testId - Test ID.
    */
   getClashTest(testId: string): Promise<ClashTest> {
@@ -609,7 +588,6 @@ export class Assembly {
   /**
    * Create assembly clash test. Assembly must be in a `done` state, otherwise the test will fail.
    *
-   * @async
    * @param name - Test name.
    * @param selectionTypeA - The type of first selection set for clash detection. Can be `all`,
    *   `handles`, `models` or `searchquery`.
@@ -627,9 +605,9 @@ export class Assembly {
    *   test is not complete during this time, the `TimeoutError` exception will be thrown.
    * @param params.interval - The time, in milliseconds, the function should delay in between
    *   checking test 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.
    */
   createClashTest(
     name: string,
@@ -667,7 +645,6 @@ export class Assembly {
   /**
    * Delete assembly clash test.
    *
-   * @async
    * @param testId - Test ID.
    * @returns Returns the raw data of a deleted test.
    */

package/src/Api/ClashTest.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 ClashTest {
   }
 
   /**
-   * Test creation time (UTC) in the format specified in <a
-   * href="https://www.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a>.
+   * Test creation time (UTC) in the format specified in
+   * {@link https://www.wikipedia.org/wiki/ISO_8601 | ISO 8601}.
    *
    * @readonly
    */
@@ -106,8 +106,8 @@ export class ClashTest {
   }
 
   /**
-   * Test last update (UTC) time in the format specified in <a
-   * href="https://www.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a>.
+   * Test last update (UTC) time in the format specified in
+   * {@link https://www.wikipedia.org/wiki/ISO_8601 | ISO 8601}.
    *
    * @readonly
    */
@@ -211,8 +211,6 @@ export class ClashTest {
 
   /**
    * Refresh test data.
-   *
-   * @async
    */
   async checkout(): Promise<this> {
     const response = await this.internalGet("");
@@ -223,7 +221,6 @@ export class ClashTest {
   /**
    * Update test data on the server.
    *
-   * @async
    * @param data - Raw test data.
    */
   async update(data: any): Promise<this> {
@@ -235,7 +232,6 @@ export class ClashTest {
   /**
    * Remove a test from a file.
    *
-   * @async
    * @returns Returns the raw data of a deleted test.
    */
   delete(): Promise<any> {
@@ -245,8 +241,6 @@ export class ClashTest {
   /**
    * Save test data changes to the server. Call this method to update test data on the server
    * after any changes.
-   *
-   * @async
    */
   save(): Promise<this> {
     return this.update(this.data);
@@ -255,15 +249,14 @@ export class ClashTest {
   /**
    * Wait for test to complete. Test 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 test. If
    *   test is not complete during this time, the `TimeoutError` exception will be thrown.
    * @param params.interval - The time, in milliseconds, the function should delay in between
    *   checking test 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.
    */
   waitForDone(params?: { timeout?: number; interval?: number; signal?: AbortSignal }): Promise<this> {
     const checkDone = () => this.checkout().then((test) => ["done", "failed"].includes(test.status));
@@ -272,8 +265,6 @@ export class ClashTest {
 
   /**
    * Returns a report with the clash detection results for this test.
-   *
-   * @async
    */
   getReport(): Promise<any> {
     return this.internalGet("/report").then((response) => response.json());