@inweb/client 27.1.0 → 27.1.2

package/lib/Api/Client.d.ts

@@ -334,6 +334,7 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
      * @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.
      * @param params.onProgress - Upload progress callback.
      */
     uploadFile(file: globalThis.File, params?: {
@@ -347,6 +348,7 @@ export declare class Client extends EventEmitter2<ClientEventMap> {
         timeout?: number;
         interval?: number;
         signal?: AbortSignal;
+        onCheckout?: (file: File, ready: boolean) => boolean;
         onProgress?: (progress: number, file: globalThis.File) => void;
     }): Promise<File>;
     /**

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?: {
@@ -508,7 +513,7 @@ export declare class File extends Endpoint {
      *
      * ```javascript
      * const action = "update";
-     * const grantedTo = [{ user: { id: myUser.id, email: myUser.email } }];
+     * const grantedTo = { user: { id: myUser.id, email: myUser.email } };
      * await file.createPermission(action, grantedTo);
      * ```
      *
@@ -516,7 +521,7 @@ export declare class File extends Endpoint {
      *
      * ```javascript
      * const actions = ["read", "readSourceFile"];
-     * const grantedTo = [{ project: { id: myProject.id, name: myProject.name } }];
+     * const grantedTo = { project: { id: myProject.id, name: myProject.name } };
      * await file.createPermission(actions, grantedTo);
      * ```
      *
@@ -528,10 +533,10 @@ export declare class File extends Endpoint {
      *   - `readViewpoint` - The ability to read file viewpoints.
      *   - `createViewpoint` - The ability to create file viewpoints.
      *
-     * @param grantedTo - A list of entities that will get access to the file.
+     * @param grantedTo - An entity or a list of entities that will get access to the file.
      * @param _public - Specifies whether all users have access to the file or not.
      */
-    createPermission(actions: string | string[], grantedTo: IGrantedTo[], _public: boolean): Promise<Permission>;
+    createPermission(actions: string | string[], grantedTo: IGrantedTo | IGrantedTo[], _public?: boolean): Promise<Permission>;
     /**
      * Removes the specified permission from the file.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inweb/client",
-  "version": "27.1.0",
+  "version": "27.1.2",
   "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.2"
   },
   "devDependencies": {
     "fflate": "^0.8.2"

package/src/Api/Client.ts

@@ -629,6 +629,7 @@ export class Client extends EventEmitter2<ClientEventMap> {
    * @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.
    * @param params.onProgress - Upload progress callback.
    */
   async uploadFile(
@@ -644,6 +645,7 @@ export class Client extends EventEmitter2<ClientEventMap> {
       timeout?: number;
       interval?: number;
       signal?: AbortSignal;
+      onCheckout?: (file: File, ready: boolean) => boolean;
       onProgress?: (progress: number, file: globalThis.File) => void;
     } = {
       geometry: true,

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(
@@ -828,7 +833,7 @@ export class File extends Endpoint {
    *
    * ```javascript
    * const action = "update";
-   * const grantedTo = [{ user: { id: myUser.id, email: myUser.email } }];
+   * const grantedTo = { user: { id: myUser.id, email: myUser.email } };
    * await file.createPermission(action, grantedTo);
    * ```
    *
@@ -836,7 +841,7 @@ export class File extends Endpoint {
    *
    * ```javascript
    * const actions = ["read", "readSourceFile"];
-   * const grantedTo = [{ project: { id: myProject.id, name: myProject.name } }];
+   * const grantedTo = { project: { id: myProject.id, name: myProject.name } };
    * await file.createPermission(actions, grantedTo);
    * ```
    *
@@ -848,13 +853,17 @@ export class File extends Endpoint {
    *   - `readViewpoint` - The ability to read file viewpoints.
    *   - `createViewpoint` - The ability to create file viewpoints.
    *
-   * @param grantedTo - A list of entities that will get access to the file.
+   * @param grantedTo - An entity or a list of entities that will get access to the file.
    * @param _public - Specifies whether all users have access to the file or not.
    */
-  createPermission(actions: string | string[], grantedTo: IGrantedTo[], _public: boolean): Promise<Permission> {
+  createPermission(
+    actions: string | string[],
+    grantedTo: IGrantedTo | IGrantedTo[],
+    _public = false
+  ): Promise<Permission> {
     return this.post("/permissions", {
       actions: Array.isArray(actions) ? actions : [actions],
-      grantedTo,
+      grantedTo: Array.isArray(grantedTo) ? grantedTo : [grantedTo],
       public: _public,
     })
       .then((response) => response.json())