@inweb/client 27.1.0 → 27.1.1

package/lib/Api/File.d.ts

@@ -122,17 +122,21 @@ export declare class File extends Endpoint {
      */
     get sharedLinkToken(): string;
     /**
-     * Data status of the active version of the file. Contains:
+     * Jobs status of the active version of the file. This is an object contains keys corresponding to
+     * different job types:
      *
-     * - `geometry` - status of geometry data of `vsfx` type.
-     * - `geometryGltf` - status of geometry data of `gltf` type.
-     * - `properties` - status of properties.
-     * - `validation` - status of validation.
+     * - `geometry` - status of geometry extraction job (`VSFX` format).
+     * - `geometryGltf` - status of geometry extraction job (`glTF` format).
+     * - `properties` - status of property extraction job .
+     * - `validation` - status of validation job .
+     *
+     * Export jobs (`dwg`, `obj`, `gltf`, `glb`, `vsf`, `pdf`, `3dpdf`) and custom jobs appear in the
+     * status object dynamically as jobs are started.
      *
      * Each status entity is a record with properties:
      *
-     * - `state` - Data state. Can be `none`, `waiting`, `inprogress`, `done` or `failed`.
-     * - `jobId` - Unique ID of the data job.
+     * - `state` - Job state. Can be `none`, `waiting`, `inprogress`, `done` or `failed`.
+     * - `jobId` - Unique ID of the job.
      *
      * @readonly
      */
@@ -482,7 +486,8 @@ export declare class File extends Endpoint {
      *   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.
+     *   can be used to abort waiting as desired. If waiting has been aborted, the `AbortError` exception
+     *   will be thrown.
      * @param params.onCheckout - Waiting progress callback. Return `true` to cancel waiting.
      */
     waitForDone(jobs: string | string[], waitAll?: boolean, params?: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inweb/client",
-  "version": "27.1.0",
+  "version": "27.1.1",
   "description": "JavaScript REST API client for the Open Cloud Server",
   "homepage": "https://cloud.opendesign.com/docs/index.html",
   "license": "SEE LICENSE IN LICENSE",
@@ -26,7 +26,7 @@
     "docs": "typedoc"
   },
   "dependencies": {
-    "@inweb/eventemitter2": "~27.1.0"
+    "@inweb/eventemitter2": "~27.1.1"
   },
   "devDependencies": {
     "fflate": "^0.8.2"

package/src/Api/File.ts

@@ -235,17 +235,21 @@ export class File extends Endpoint {
   }
 
   /**
-   * Data status of the active version of the file. Contains:
+   * Jobs status of the active version of the file. This is an object contains keys corresponding to
+   * different job types:
    *
-   * - `geometry` - status of geometry data of `vsfx` type.
-   * - `geometryGltf` - status of geometry data of `gltf` type.
-   * - `properties` - status of properties.
-   * - `validation` - status of validation.
+   * - `geometry` - status of geometry extraction job (`VSFX` format).
+   * - `geometryGltf` - status of geometry extraction job (`glTF` format).
+   * - `properties` - status of property extraction job .
+   * - `validation` - status of validation job .
+   *
+   * Export jobs (`dwg`, `obj`, `gltf`, `glb`, `vsf`, `pdf`, `3dpdf`) and custom jobs appear in the
+   * status object dynamically as jobs are started.
    *
    * Each status entity is a record with properties:
    *
-   * - `state` - Data state. Can be `none`, `waiting`, `inprogress`, `done` or `failed`.
-   * - `jobId` - Unique ID of the data job.
+   * - `state` - Job state. Can be `none`, `waiting`, `inprogress`, `done` or `failed`.
+   * - `jobId` - Unique ID of the job.
    *
    * @readonly
    */
@@ -771,7 +775,8 @@ export class File extends Endpoint {
    *   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.
+   *   can be used to abort waiting as desired. If waiting has been aborted, the `AbortError` exception
+   *   will be thrown.
    * @param params.onCheckout - Waiting progress callback. Return `true` to cancel waiting.
    */
   waitForDone(