@inweb/client 25.3.17 → 25.3.18

package/src/Api/Job.ts

@@ -22,7 +22,7 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 import { IHttpClient } from "./IHttpClient";
-import { json, waitFor } from "./impl/Utils";
+import { waitFor } from "./Utils";
 
 /**
  * The class representing a `job` entity describes the process of converting a file from one
@@ -45,7 +45,7 @@ export class Job {
     return this.httpClient.get(`/jobs/${this.data.id}`);
   }
 
-  protected internalPut(body?: ArrayBuffer | Blob | globalThis.File | FormData | object | string | null) {
+  protected internalPut(body?: BodyInit | object) {
     return this.httpClient.put(`/jobs/${this.data.id}`, body);
   }
 
@@ -184,7 +184,8 @@ export class Job {
    * @async
    */
   async checkout(): Promise<Job> {
-    this.data = await json(this.internalGet());
+    const response = await this.internalGet();
+    this.data = await response.json();
     return this;
   }
 
@@ -195,7 +196,8 @@ export class Job {
    * @param data - Raw job data.
    */
   async update(data: any): Promise<Job> {
-    this.data = await json(this.internalPut(data));
+    const response = await this.internalPut(data);
+    this.data = await response.json();
     return this;
   }
 
@@ -207,7 +209,7 @@ export class Job {
    * @returns Returns the raw data of a deleted job.
    */
   delete(): Promise<any> {
-    return json(this.internalDelete());
+    return this.internalDelete().then((response) => response.json());
   }
 
   // /**

package/src/Api/Member.ts

@@ -23,7 +23,7 @@
 
 import { IHttpClient } from "./IHttpClient";
 import { IShortUserDescription } from "./IUser";
-import { json, userFullName, userInitials } from "./impl/Utils";
+import { userFullName, userInitials } from "./Utils";
 
 /**
  * Members are the {@link User | users} who have access to the {@link Project | project}.
@@ -48,7 +48,7 @@ export class Member {
     return this.httpClient.get(`/projects/${this.projectId}/members/${this.id}`);
   }
 
-  private internalPut(body?: ArrayBuffer | Blob | globalThis.File | FormData | object | string | null) {
+  private internalPut(body?: BodyInit | object) {
     return this.httpClient.put(`/projects/${this.projectId}/members/${this.id}`, body);
   }
 
@@ -124,7 +124,8 @@ export class Member {
    * @async
    */
   async checkout(): Promise<Member> {
-    this.data = await json(this.internalGet());
+    const response = await this.internalGet();
+    this.data = await response.json();
     return this;
   }
 
@@ -135,7 +136,8 @@ export class Member {
    * @param data - Raw member data.
    */
   async update(data: any): Promise<Member> {
-    this.data = await json(this.internalPut(data));
+    const response = await this.internalPut(data);
+    this.data = await response.json();
     return this;
   }
 
@@ -146,7 +148,7 @@ export class Member {
    * @returns Returns the raw data of a deleted member.
    */
   delete(): Promise<any> {
-    return json(this.internalDelete());
+    return this.internalDelete().then((response) => response.json());
   }
 
   /**

package/src/Api/Model.ts

@@ -69,8 +69,8 @@ export class Model {
   }
 
   /**
-   * Scene description file resource ID. Use {@link Model#downloadResource | downloadResource()}
-   * to download scene description file.
+   * Scene description resource file name. Use {@link Model.downloadResource()} to download
+   * scene description file.
    *
    * @readonly
    */
@@ -106,8 +106,8 @@ export class Model {
   }
 
   /**
-   * The list of resource IDs for geometry data files. Use
-   * {@link Model#downloadResource | downloadResource()} to download geometry data files.
+   * The list of geometry data resource files. Use {@link Model.downloadResource()} to download
+   * geometry data files.
    *
    * @readonly
    */
@@ -247,10 +247,11 @@ export class Model {
   }
 
   /**
-   * Downloads model resource, such as scene description file or geometry data files.
+   * Download model resource file. Resource files are files that contain model scene
+   * descriptions, or geometry data.
    *
    * @async
-   * @param resourceId - Resource ID.
+   * @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
@@ -258,30 +259,76 @@ export class Model {
    */
   downloadResource(
     dataId: string,
-    onProgress?: (progress: number) => void,
+    onProgress?: (progress: number, chunk: Uint8Array) => void,
     signal?: AbortSignal
   ): Promise<ArrayBuffer> {
     return this._file.downloadResource(dataId, onProgress, signal);
   }
 
-  // Internal download routines used by Viewer.
+  /**
+   * Download a part of model resource file. Resource files are files that contain model scene
+   * descriptions, or geometry data.
+   *
+   * @param dataId - Resource file name.
+   * @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.
+   */
+  downloadResourceRange(
+    dataId: string,
+    ranges: Array<{ begin: number; end: number; requestId: number }>,
+    requestId: number,
+    onProgress?: (progress: number, chunk: Uint8Array, requestId: number) => void,
+    signal?: AbortSignal
+  ): Promise<ArrayBuffer> {
+    return this._file.downloadResourceRange(dataId, ranges, requestId, onProgress, signal);
+  }
 
+  /**
+   * Deprecated since `25.3`. Use {@link Model.downloadResource()} instead.
+   */
   partialDownloadResource(
     dataId: string,
-    onProgress?: (progress: number, downloaded: Uint8Array) => void,
+    onProgress?: (progress: number, chunk: Uint8Array) => void,
     signal?: AbortSignal
-  ): Promise<void> {
-    return this._file.partialDownloadResource(dataId, onProgress, signal);
+  ): Promise<ArrayBuffer> {
+    console.warn(
+      "Model.partialDownloadResource() has been deprecated since 25.3 and will be removed in a future release, use Model.downloadResource() instead."
+    );
+    return this.downloadResource(dataId, onProgress, signal);
   }
 
-  downloadFileRange(
+  /**
+   * Deprecated since `25.3`. Use {@link Model.downloadResourceRange()} instead.
+   */
+  async downloadFileRange(
     requestId: number,
     records: any | null,
     dataId: string,
-    onProgress?: (progress: number, downloaded: Uint8Array, requestId: number) => void,
+    onProgress?: (progress: number, chunk: Uint8Array, requestId: number) => void,
     signal?: AbortSignal
   ): Promise<void> {
-    return this._file.downloadFileRange(requestId, records, dataId, onProgress, signal);
+    if (!records) return;
+
+    let ranges = [];
+    if (records.length) {
+      ranges = records.map((record) => ({
+        begin: Number(record.begin),
+        end: Number(record.end),
+        requestId: record.reqId,
+      }));
+    } else {
+      for (let i = 0; i < records.size(); i++) {
+        const record = records.get(i);
+        ranges.push({ begin: Number(record.begin), end: Number(record.end), requestId });
+        record.delete();
+      }
+    }
+
+    await this.downloadResourceRange(dataId, ranges, requestId, onProgress, signal);
   }
 
   /**

package/src/Api/Permission.ts

@@ -22,7 +22,6 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 import { IHttpClient } from "./IHttpClient";
-import { json } from "./impl/Utils";
 
 /**
  * A permission provides information about {@link File | file} sharing granted to a specific
@@ -48,7 +47,7 @@ export class Permission {
     return this.httpClient.get(`/files/${this.fileId}/permissions/${this.id}`);
   }
 
-  private internalPut(body?: ArrayBuffer | Blob | globalThis.File | FormData | object | string | null) {
+  private internalPut(body?: BodyInit | object) {
     return this.httpClient.put(`/files/${this.fileId}/permissions/${this.id}`, body);
   }
 
@@ -136,7 +135,8 @@ export class Permission {
    * @async
    */
   async checkout(): Promise<Permission> {
-    this.data = await json(this.internalGet());
+    const response = await this.internalGet();
+    this.data = await response.json();
     return this;
   }
 
@@ -147,7 +147,8 @@ export class Permission {
    * @param data - Raw permission data.
    */
   async update(data: any): Promise<Permission> {
-    this.data = await json(this.internalPut(data));
+    const response = await this.internalPut(data);
+    this.data = await response.json();
     return this;
   }
 
@@ -158,7 +159,7 @@ export class Permission {
    * @returns Returns the raw data of a deleted permission.
    */
   delete(): Promise<any> {
-    return json(this.internalDelete());
+    return this.internalDelete().then((response) => response.json());
   }
 
   /**

package/src/Api/Project.ts

@@ -25,7 +25,7 @@ import { IHttpClient } from "./IHttpClient";
 import { IShortUserDescription } from "./IUser";
 import { Role } from "./Role";
 import { Member } from "./Member";
-import { json, text, userFullName, userInitials } from "./impl/Utils";
+import { userFullName, userInitials } from "./Utils";
 
 /**
  * Projects are used to collaborate on models and track issues.
@@ -47,17 +47,11 @@ export class Project {
     return this.httpClient.get(`/projects/${this.id}${relativePath}`);
   }
 
-  protected internalPost(
-    relativePath: string,
-    body?: ArrayBuffer | Blob | globalThis.File | FormData | object | string | null
-  ) {
+  protected internalPost(relativePath: string, body?: BodyInit | object) {
     return this.httpClient.post(`/projects/${this.id}${relativePath}`, body);
   }
 
-  protected internalPut(
-    relativePath: string,
-    body?: ArrayBuffer | Blob | globalThis.File | FormData | object | string | null
-  ) {
+  protected internalPut(relativePath: string, body?: BodyInit | object) {
     return this.httpClient.put(`/projects/${this.id}${relativePath}`, body);
   }
 
@@ -249,7 +243,8 @@ export class Project {
    * @async
    */
   async checkout(): Promise<Project> {
-    this.data = await json(this.internalGet(""));
+    const response = await this.internalGet("");
+    this.data = await response.json();
     return this;
   }
 
@@ -260,7 +255,8 @@ export class Project {
    * @param data - Raw project data.
    */
   async update(data: any): Promise<Project> {
-    this.data = await json(this.internalPut("", data));
+    const response = await this.internalPut("", data);
+    this.data = await response.json();
     return this;
   }
 
@@ -271,14 +267,16 @@ export class Project {
    * @returns Returns the raw data of a deleted project.
    */
   delete(): Promise<any> {
-    return text(this.internalDelete("")).then((text) => {
-      // TODO fix for server 23.5 and below
-      try {
-        return JSON.parse(text);
-      } catch {
-        return { id: this.id };
-      }
-    });
+    return this.internalDelete("")
+      .then((response) => response.text())
+      .then((text) => {
+        // TODO fix for server 23.5 and below
+        try {
+          return JSON.parse(text);
+        } catch {
+          return { id: this.id };
+        }
+      });
   }
 
   /**
@@ -305,12 +303,9 @@ export class Project {
    *   target="_blank">File</a> object. Setting the `image` to `null` will remove the preview.
    */
 
-  async setPreview(image?: ArrayBuffer | Blob | globalThis.File | FormData | string | null) {
-    if (image) {
-      this.data = await json(this.internalPost("/preview", image));
-    } else {
-      this.data = await json(this.internalDelete("/preview"));
-    }
+  async setPreview(image: BodyInit | null) {
+    const response = await (image ? this.internalPost("/preview", image) : this.internalDelete("/preview"));
+    this.data = await response.json();
     return this;
   }
 
@@ -321,9 +316,9 @@ export class Project {
    * @async
    */
   getRoles(): Promise<Role[]> {
-    return json(this.internalGet("/roles")).then((array) =>
-      array.map((data) => new Role(data, this.id, this.httpClient))
-    );
+    return this.internalGet("/roles")
+      .then((response) => response.json())
+      .then((array) => array.map((data) => new Role(data, this.id, this.httpClient)));
   }
 
   /**
@@ -333,7 +328,9 @@ export class Project {
    * @param name - Role name.
    */
   getRole(name: string): Promise<Role> {
-    return json(this.internalGet(`/roles/${name}`)).then((data) => new Role(data, this.id, this.httpClient));
+    return this.internalGet(`/roles/${name}`)
+      .then((response) => response.json())
+      .then((data) => new Role(data, this.id, this.httpClient));
   }
 
   /**
@@ -346,13 +343,13 @@ export class Project {
    *   {@link Role#permissions | Role.permissions} for more details.
    */
   createRole(name: string, description: string, permissions: any): Promise<Role> {
-    return json(
-      this.internalPost("/roles", {
-        name,
-        description,
-        permissions: permissions || {},
-      })
-    ).then((data) => new Role(data, this.id, this.httpClient));
+    return this.internalPost("/roles", {
+      name,
+      description,
+      permissions: permissions || {},
+    })
+      .then((response) => response.json())
+      .then((data) => new Role(data, this.id, this.httpClient));
   }
 
   /**
@@ -363,7 +360,7 @@ export class Project {
    * @returns Returns the raw data of a deleted role.
    */
   deleteRole(name: string): Promise<any> {
-    return json(this.internalDelete(`/roles/${name}`));
+    return this.internalDelete(`/roles/${name}`).then((response) => response.json());
   }
 
   /**
@@ -372,9 +369,9 @@ export class Project {
    * @async
    */
   getMembers(): Promise<Member[]> {
-    return json(this.internalGet("/members")).then((array) =>
-      array.map((data) => new Member(data, this.id, this.httpClient))
-    );
+    return this.internalGet("/members")
+      .then((response) => response.json())
+      .then((array) => array.map((data) => new Member(data, this.id, this.httpClient)));
   }
 
   /**
@@ -384,7 +381,9 @@ export class Project {
    * @param memberId - Member ID.
    */
   getMember(memberId: string): Promise<Member> {
-    return json(this.internalGet(`/members/${memberId}`)).then((data) => new Member(data, this.id, this.httpClient));
+    return this.internalGet(`/members/${memberId}`)
+      .then((response) => response.json())
+      .then((data) => new Member(data, this.id, this.httpClient));
   }
 
   /**
@@ -395,9 +394,9 @@ export class Project {
    * @param role - User role from the list of project roles.
    */
   addMember(userId: string, role: string): Promise<Member> {
-    return json(this.internalPost("/members", { userId, role })).then(
-      (data) => new Member(data, this.id, this.httpClient)
-    );
+    return this.internalPost("/members", { userId, role })
+      .then((response) => response.json())
+      .then((data) => new Member(data, this.id, this.httpClient));
   }
 
   /**
@@ -408,7 +407,7 @@ export class Project {
    * @returns Returns the raw data of a deleted member.
    */
   removeMember(memberId: string): Promise<any> {
-    return json(this.internalDelete(`/members/${memberId}`));
+    return this.internalDelete(`/members/${memberId}`).then((response) => response.json());
   }
 
   /**
@@ -431,49 +430,55 @@ export class Project {
    * @async
    */
   getFilesInformation(): Promise<any[]> {
-    return json(this.httpClient.get(`/bcf/3.0/projects/${this.data.id}/files_information`)).then((items) => {
-      items.forEach((item) => {
-        const getFieldValue = (displayName: string) => {
-          return (item.display_information.find((x) => x.field_display_name === displayName) || {}).field_value;
-        };
-
-        const previewUrl = `${this.httpClient.serverUrl}/files/${item.file.reference}/preview`;
-        const ownerAvatarUrl = `${this.httpClient.serverUrl}/users/${getFieldValue("Owner")}/avatar`;
-
-        const ownerFirstName = getFieldValue("Owner First Name");
-        const ownerLastName = getFieldValue("Owner Last Name");
-        const ownerUserName = getFieldValue("Owner User Name");
-        const ownerFullName = userFullName(ownerFirstName, ownerLastName, ownerUserName);
-        const ownerInitials = userInitials(ownerFullName);
-
-        item.display_information.push({ field_display_name: "Preview URL", field_value: previewUrl });
-        item.display_information.push({ field_display_name: "Owner Avatar URL", field_value: ownerAvatarUrl });
-        item.display_information.push({ field_display_name: "Owner Full Name", field_value: ownerFullName });
-        item.display_information.push({ field_display_name: "Owner Initials", field_value: ownerInitials });
-
-        // updatedBy since 24.10
-
-        const updatedByAvatarUrl = `${this.httpClient.serverUrl}/users/${getFieldValue("Updated By")}/avatar`;
-
-        const updatedByFirstName = getFieldValue("Updated By First Name");
-        const updatedByLastName = getFieldValue("Updated By Last Name");
-        const updatedByUserName = getFieldValue("Updated By User Name");
-        const updatedByFullName = userFullName(updatedByFirstName, updatedByLastName, updatedByUserName);
-        const updatedByInitials = userInitials(updatedByFullName);
-
-        item.display_information.push({ field_display_name: "Updated By Avatar URL", field_value: updatedByAvatarUrl });
-        item.display_information.push({ field_display_name: "Updated By Full Name", field_value: updatedByFullName });
-        item.display_information.push({ field_display_name: "Updated By Initials", field_value: updatedByInitials });
-
-        // geometryType since 24.12
-
-        const geometry = getFieldValue("Geometry Status");
-        const geometryGltf = getFieldValue("GeometryGltf Status");
-        const geometryType = geometry === "done" ? "vsfx" : geometryGltf === "done" ? "gltf" : "";
-
-        item.display_information.push({ field_display_name: "Geometry Type", field_value: geometryType });
+    return this.httpClient
+      .get(`/bcf/3.0/projects/${this.data.id}/files_information`)
+      .then((response) => response.json())
+      .then((items) => {
+        items.forEach((item) => {
+          const getFieldValue = (displayName: string) => {
+            return (item.display_information.find((x) => x.field_display_name === displayName) || {}).field_value;
+          };
+
+          const previewUrl = `${this.httpClient.serverUrl}/files/${item.file.reference}/preview`;
+          const ownerAvatarUrl = `${this.httpClient.serverUrl}/users/${getFieldValue("Owner")}/avatar`;
+
+          const ownerFirstName = getFieldValue("Owner First Name");
+          const ownerLastName = getFieldValue("Owner Last Name");
+          const ownerUserName = getFieldValue("Owner User Name");
+          const ownerFullName = userFullName(ownerFirstName, ownerLastName, ownerUserName);
+          const ownerInitials = userInitials(ownerFullName);
+
+          item.display_information.push({ field_display_name: "Preview URL", field_value: previewUrl });
+          item.display_information.push({ field_display_name: "Owner Avatar URL", field_value: ownerAvatarUrl });
+          item.display_information.push({ field_display_name: "Owner Full Name", field_value: ownerFullName });
+          item.display_information.push({ field_display_name: "Owner Initials", field_value: ownerInitials });
+
+          // updatedBy since 24.10
+
+          const updatedByAvatarUrl = `${this.httpClient.serverUrl}/users/${getFieldValue("Updated By")}/avatar`;
+
+          const updatedByFirstName = getFieldValue("Updated By First Name");
+          const updatedByLastName = getFieldValue("Updated By Last Name");
+          const updatedByUserName = getFieldValue("Updated By User Name");
+          const updatedByFullName = userFullName(updatedByFirstName, updatedByLastName, updatedByUserName);
+          const updatedByInitials = userInitials(updatedByFullName);
+
+          item.display_information.push({
+            field_display_name: "Updated By Avatar URL",
+            field_value: updatedByAvatarUrl,
+          });
+          item.display_information.push({ field_display_name: "Updated By Full Name", field_value: updatedByFullName });
+          item.display_information.push({ field_display_name: "Updated By Initials", field_value: updatedByInitials });
+
+          // geometryType since 24.12
+
+          const geometry = getFieldValue("Geometry Status");
+          const geometryGltf = getFieldValue("GeometryGltf Status");
+          const geometryType = geometry === "done" ? "vsfx" : geometryGltf === "done" ? "gltf" : "";
+
+          item.display_information.push({ field_display_name: "Geometry Type", field_value: geometryType });
+        });
+        return items;
       });
-      return items;
-    });
   }
 }

package/src/Api/Role.ts

@@ -22,7 +22,6 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 import { IHttpClient } from "./IHttpClient";
-import { json } from "./impl/Utils";
 
 /**
  * A roles determines what permissions {@link User | users} have on a {@link Project | project}.
@@ -47,7 +46,7 @@ export class Role {
     return this.httpClient.get(`/projects/${this.projectId}/roles/${this.name}`);
   }
 
-  private internalPut(body?: ArrayBuffer | Blob | globalThis.File | FormData | object | string | null) {
+  private internalPut(body?: BodyInit | object) {
     return this.httpClient.put(`/projects/${this.projectId}/roles/${this.name}`, body);
   }
 
@@ -121,7 +120,8 @@ export class Role {
    * @async
    */
   async checkout(): Promise<Role> {
-    this.data = await json(this.internalGet());
+    const response = await this.internalGet();
+    this.data = await response.json();
     return this;
   }
 
@@ -132,7 +132,8 @@ export class Role {
    * @param data - Raw role data.
    */
   async update(data: any): Promise<Role> {
-    this.data = await json(this.internalPut(data));
+    const response = await this.internalPut(data);
+    this.data = await response.json();
     return this;
   }
 
@@ -143,7 +144,7 @@ export class Role {
    * @returns Returns the raw data of a deleted role.
    */
   delete(): Promise<any> {
-    return json(this.internalDelete());
+    return this.internalDelete().then((response) => response.json());
   }
 
   /**