@inweb/client 25.3.17 → 25.3.18

package/src/Api/File.ts

@@ -27,16 +27,7 @@ import { IShortUserDescription } from "./IUser";
 import { Model } from "./Model";
 import { Permission } from "./Permission";
 import { Job } from "./Job";
-import {
-  json,
-  text,
-  downloadProgress,
-  downloadPartOfFile,
-  waitFor,
-  parseArgs,
-  userFullName,
-  userInitials,
-} from "./impl/Utils";
+import { waitFor, parseArgs, userFullName, userInitials } from "./Utils";
 
 /**
  * The class representing a `file` entity.
@@ -59,7 +50,6 @@ export class File {
 
   private appendVersionParam(relativePath: string): string {
     if (this._useVersion === undefined) return relativePath;
-
     const delimiter = relativePath.includes("?") ? "&" : "?";
     return `${relativePath}${delimiter}version=${this._useVersion}`;
   }
@@ -69,18 +59,12 @@ export class File {
     return this.httpClient.get(`${this.path}${relativePath}`, signal);
   }
 
-  private internalPost(
-    relativePath: string,
-    body?: ArrayBuffer | Blob | globalThis.File | FormData | object | string | null
-  ) {
+  private internalPost(relativePath: string, body?: BodyInit | object) {
     relativePath = this.appendVersionParam(relativePath);
     return this.httpClient.post(`${this.path}${relativePath}`, body);
   }
 
-  private internalPut(
-    relativePath: string,
-    body?: ArrayBuffer | Blob | globalThis.File | FormData | object | string | null
-  ) {
+  private internalPut(relativePath: string, body?: BodyInit | object) {
     relativePath = this.appendVersionParam(relativePath);
     return this.httpClient.put(`${this.path}${relativePath}`, body);
   }
@@ -90,52 +74,6 @@ export class File {
     return this.httpClient.delete(`${this.path}${relativePath}`);
   }
 
-  async partialDownloadResource(
-    dataId: string,
-    onProgress?: (progress: number, downloaded: Uint8Array) => void,
-    signal?: AbortSignal
-  ) {
-    let pathname = `${this.path}/downloads/${dataId}`;
-    pathname = this.appendVersionParam(pathname);
-
-    // TODO: replace with $get to handle fetch errors
-    const response = await fetch(`${this.httpClient.serverUrl}${pathname}`, {
-      headers: this.httpClient.headers,
-      signal,
-    });
-
-    // TODO: use ReadableStream pipeTo()
-    const contentLength = response.headers.get("Content-Length") ?? "";
-    const total = parseInt(contentLength, 10);
-    const reader = response.body.getReader();
-    let loaded = 0;
-    while (true) {
-      const { done, value } = await reader.read();
-      if (done) break;
-      loaded += value.byteLength;
-      if (typeof onProgress === "function") onProgress(loaded / total, value);
-    }
-  }
-
-  downloadFileRange(
-    requestId: number,
-    records: any | null,
-    dataId: string,
-    onProgress?: (progress: number, downloaded: Uint8Array, requestId: number) => void,
-    signal?: AbortSignal
-  ) {
-    let pathname = `${this.path}/downloads/${dataId}?requestId=${requestId}`;
-    pathname = this.appendVersionParam(pathname);
-    return downloadPartOfFile(
-      requestId,
-      records,
-      `${this.httpClient.serverUrl}${pathname}`,
-      this.httpClient.headers,
-      onProgress,
-      signal
-    );
-  }
-
   /**
    * Active version number of the file.
    *
@@ -201,8 +139,8 @@ export class File {
   }
 
   /**
-   * Returns a list of formats in which the active version of the file was exported. To export
-   * file to one of the supported formats create File Converter job using
+   * Returns a list of files in different formats in which the active version of the file was
+   * exported. To export file to one of the supported formats create File Converter job using
    * {@link File.createJob()}. To download exported file use {@link File.downloadResource()}.
    *
    * @readonly
@@ -377,7 +315,8 @@ export class File {
    * @async
    */
   async checkout(): Promise<File> {
-    this.data = await json(this.internalGet(""));
+    const response = await this.internalGet("");
+    this.data = await response.json();
     return this;
   }
 
@@ -388,7 +327,8 @@ export class File {
    * @param data - Raw file data.
    */
   async update(data: any): Promise<File> {
-    this.data = await json(this.internalPut("", data));
+    const response = await this.internalPut("", data);
+    this.data = await response.json();
     return this;
   }
 
@@ -399,7 +339,7 @@ export class File {
    * @returns Returns the raw data of a deleted file.
    */
   delete(): Promise<any> {
-    return json(this.internalDelete(""));
+    return this.internalDelete("").then((response) => response.json());
   }
 
   /**
@@ -425,12 +365,9 @@ export class File {
    *   Web API <a href="https://developer.mozilla.org/docs/Web/API/File"
    *   target="_blank">File</a> object. Setting the `image` to `null` will remove the preview.
    */
-  async setPreview(image?: ArrayBuffer | Blob | globalThis.File | FormData | string | null): Promise<File> {
-    if (image) {
-      this.data = await json(this.internalPost("/preview", image));
-    } else {
-      this.data = await json(this.internalDelete("/preview"));
-    }
+  async setPreview(image: BodyInit | null): Promise<File> {
+    const response = await (image ? this.internalPost("/preview", image) : this.internalDelete("/preview"));
+    this.data = await response.json();
     return this;
   }
 
@@ -440,7 +377,9 @@ export class File {
    * @async
    */
   getModels(): Promise<Model[]> {
-    return json(this.internalGet("/geometry")).then((array) => array.map((data) => new Model(data, this)));
+    return this.internalGet("/geometry")
+      .then((response) => response.json())
+      .then((array) => array.map((data) => new Model(data, this)));
   }
 
   // File does not support model transformation.
@@ -470,7 +409,8 @@ export class File {
    *   to get properties for all objects in the file.
    */
   getProperties(handles?: string | string[]): Promise<any[]> {
-    return json(this.internalGet(handles !== undefined ? `/properties?handles=${handles}` : "/properties"));
+    const relativePath = handles !== undefined ? `/properties?handles=${handles}` : "/properties";
+    return this.internalGet(relativePath).then((response) => response.json());
   }
 
   /**
@@ -519,7 +459,7 @@ export class File {
    */
 
   searchProperties(searchPattern: any): Promise<any[]> {
-    return json(this.internalPost("/properties/search", searchPattern));
+    return this.internalPost("/properties/search", searchPattern).then((response) => response.json());
   }
 
   /**
@@ -528,7 +468,7 @@ export class File {
    * @async
    */
   getCdaTree(): Promise<any[]> {
-    return json(this.internalGet(`/properties/tree`));
+    return this.internalGet(`/properties/tree`).then((response) => response.json());
   }
 
   /**
@@ -537,7 +477,9 @@ export class File {
    * @async
    */
   getViewpoints(): Promise<any[]> {
-    return json(this.internalGet("/viewpoints")).then((viewpoints) => viewpoints.result);
+    return this.internalGet("/viewpoints")
+      .then((response) => response.json())
+      .then((viewpoints) => viewpoints.result);
   }
 
   /**
@@ -548,7 +490,7 @@ export class File {
    * @param viewpoint - Viewpoint.
    */
   saveViewpoint(viewpoint: any): Promise<any> {
-    return json(this.internalPost("/viewpoints", viewpoint));
+    return this.internalPost("/viewpoints", viewpoint).then((response) => response.json());
   }
 
   /**
@@ -559,7 +501,7 @@ export class File {
    * @returns Returns the raw data of a deleted viewpoint.
    */
   deleteViewpoint(guid: string): Promise<any> {
-    return json(this.internalDelete(`/viewpoints/${guid}`));
+    return this.internalDelete(`/viewpoints/${guid}`).then((response) => response.json());
   }
 
   /**
@@ -571,7 +513,7 @@ export class File {
    * @param guid - Viewpoint GUID.
    */
   getSnapshot(guid: string): Promise<string> {
-    return text(this.internalGet(`/viewpoints/${guid}/snapshot`));
+    return this.internalGet(`/viewpoints/${guid}/snapshot`).then((response) => response.text());
   }
 
   /**
@@ -582,7 +524,7 @@ export class File {
    * @param bitmapGuid - Bitmap GUID.
    */
   getSnapshotData(guid: string, bitmapGuid: string): Promise<string> {
-    return text(this.internalGet(`/viewpoints/${guid}/bitmaps/${bitmapGuid}`));
+    return this.internalGet(`/viewpoints/${guid}/bitmaps/${bitmapGuid}`).then((response) => response.text());
   }
 
   /**
@@ -595,24 +537,26 @@ export class File {
    *   and abort it if desired.
    */
   download(onProgress?: (progress: number) => void, signal?: AbortSignal): Promise<ArrayBuffer> {
-    return this.internalGet(`/downloads`, signal)
-      .then((response) => downloadProgress(response, onProgress))
+    const relativePath = this.appendVersionParam("/downloads");
+    return this.httpClient
+      .downloadFile(`${this.path}${relativePath}`, onProgress, signal)
       .then((response) => response.arrayBuffer());
   }
 
   /**
-   * Download file resource data of the active version of the file, such as exported file.
+   * Download a resource file of the active version of the file. Resource files are files that
+   * contain model scene descriptions, or geometry data, or exported files.
    *
    * @example <caption>Export file to DWG.</caption>
    *   const job = await file.crateJob("dwg");
    *   await job.waitForDone();
-   *   const resourceId = file.exports.find((x) => x.endsWith(".dwg"));
-   *   const arrayBuffer = await file.downloadResource(resourceId);
+   *   const dwgFileName = file.exports.find((x) => x.endsWith(".dwg"));
+   *   const arrayBuffer = await file.downloadResource(dwgFileName);
    *   const blob = new Blob([arrayBuffer]);
    *   const fileName = file.name.replace(/\.[^.]+$/, "") + ".dwg";
    *   FileSaver.saveAs(blob, fileName);
    *
-   * @param dataId - 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
@@ -620,14 +564,67 @@ export class File {
    */
   downloadResource(
     dataId: string,
-    onProgress?: (progress: number) => void,
+    onProgress?: (progress: number, chunk: Uint8Array) => void,
+    signal?: AbortSignal
+  ): Promise<ArrayBuffer> {
+    const relativePath = this.appendVersionParam(`/downloads/${dataId}`);
+    return this.httpClient
+      .downloadFile(`${this.path}${relativePath}`, onProgress, signal)
+      .then((response) => response.arrayBuffer());
+  }
+
+  /**
+   * Download a part of resource file of the active version of the file. Resource files are
+   * files that contain model scene descriptions, or geometry data, or exported files.
+   *
+   * @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.internalGet(`/downloads/${dataId}`, signal)
-      .then((response) => downloadProgress(response, onProgress))
+    const relativePath = this.appendVersionParam(`/downloads/${dataId}?requestId=${requestId}`);
+    return this.httpClient
+      .downloadFileRange(`${this.path}${relativePath}`, ranges, onProgress, signal)
       .then((response) => response.arrayBuffer());
   }
 
+  /**
+   * Deprecated since `25.3`. Use {@link File.downloadResource()} instead.
+   */
+  partialDownloadResource(
+    dataId: string,
+    onProgress?: (progress: number, downloaded: Uint8Array) => void,
+    signal?: AbortSignal
+  ): Promise<ArrayBuffer> {
+    console.warn(
+      "File.partialDownloadResource() has been deprecated since 25.3 and will be removed in a future release, use File.downloadResource() instead."
+    );
+    return this.downloadResource(dataId, onProgress, signal);
+  }
+
+  /**
+   * Deprecated since `25.3`. Use {@link File.downloadResourceRange()} instead.
+   */
+  async downloadFileRange(
+    requestId: number,
+    records: any | null,
+    dataId: string,
+    onProgress?: (progress: number, downloaded: Uint8Array, requestId: number) => void,
+    signal?: AbortSignal
+  ): Promise<void> {
+    await this.downloadResourceRange(dataId, records, requestId, onProgress, signal);
+  }
+
   /**
    * Returns a list of references to files used to correct rendering of the current file.
    *
@@ -637,7 +634,7 @@ export class File {
    *   signal object instance, which can be used to abort waiting as desired.
    */
   getReferences(signal?: AbortSignal): Promise<IFileReferences> {
-    return json(this.internalGet("/references", signal));
+    return this.internalGet("/references", signal).then((response) => response.json());
   }
 
   /**
@@ -647,7 +644,7 @@ export class File {
    * @param references - File references.
    */
   setReferences(references: IFileReferences): Promise<IFileReferences> {
-    return json(this.internalPut("/references", references));
+    return this.internalPut("/references", references).then((response) => response.json());
   }
 
   /**
@@ -671,9 +668,9 @@ export class File {
    *   for the File Converter tool in form "--arg=value".
    */
   createJob(outputFormat: string, parameters?: string | object): Promise<Job> {
-    const pathname = this.appendVersionParam("/jobs");
+    const relativePath = this.appendVersionParam("/jobs");
     return this.httpClient
-      .post(pathname, {
+      .post(relativePath, {
         fileId: this.id,
         outputFormat,
         parameters: parseArgs(parameters),
@@ -779,9 +776,9 @@ export class File {
    * @async
    */
   getPermissions(): Promise<Permission[]> {
-    return json(this.internalGet("/permissions")).then((array) =>
-      array.map((data) => new Permission(data, this.id, this.httpClient))
-    );
+    return this.internalGet("/permissions")
+      .then((response) => response.json())
+      .then((array) => array.map((data) => new Permission(data, this.id, this.httpClient)));
   }
 
   /**
@@ -791,9 +788,9 @@ export class File {
    * @param permissionId - Permission ID.
    */
   getPermission(permissionId: string): Promise<Permission> {
-    return json(this.internalGet(`/permissions/${permissionId}`)).then(
-      (data) => new Permission(data, this.id, this.httpClient)
-    );
+    return this.internalGet(`/permissions/${permissionId}`)
+      .then((response) => response.json())
+      .then((data) => new Permission(data, this.id, this.httpClient));
   }
 
   /**
@@ -806,13 +803,13 @@ export class File {
    * @param public = false - Specifies whether all users have access to the file or not.
    */
   createPermission(actions: string | string[], grantedTo: any[], _public: boolean): Promise<Permission> {
-    return json(
-      this.internalPost("/permissions", {
-        actions: typeof actions === "string" ? [actions] : actions,
-        grantedTo,
-        public: _public,
-      })
-    ).then((data) => new Permission(data, this.id, this.httpClient));
+    return this.internalPost("/permissions", {
+      actions: Array.isArray(actions) ? actions : [actions],
+      grantedTo,
+      public: _public,
+    })
+      .then((response) => response.json())
+      .then((data) => new Permission(data, this.id, this.httpClient));
   }
 
   /**
@@ -823,7 +820,7 @@ export class File {
    * @returns Returns the raw data of a deleted permission.
    */
   deletePermission(permissionId: string): Promise<any> {
-    return json(this.internalDelete(`/permissions/${permissionId}`));
+    return this.internalDelete(`/permissions/${permissionId}`).then((response) => response.json());
   }
 
   /**
@@ -864,7 +861,7 @@ export class File {
     }
   ): Promise<File> {
     const result = await this.httpClient
-      .postFile(`${this.path}/versions`, file, (progress) => params.onProgress?.(progress, file))
+      .uploadFile(`${this.path}/versions`, file, (progress) => params.onProgress?.(progress, file))
       .then((xhr: XMLHttpRequest) => JSON.parse(xhr.responseText))
       .then((data) => new File(data, this.httpClient));
 
@@ -914,11 +911,9 @@ export class File {
    */
   async deleteVersion(version: number): Promise<any> {
     const response = await this.internalDelete(`/versions/${version}`);
-    const result = await response.json();
-
+    const data = await response.json();
     await this.checkout();
-
-    return result;
+    return data;
   }
 
   /**

package/src/Api/HttpClient.ts

@@ -22,7 +22,8 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 import { IHttpClient } from "./IHttpClient";
-import { $get, $delete, $post, $put, $XMLHttp } from "./impl/Utils";
+import { $fetch } from "./Fetch";
+import { $xmlhttp } from "./XMLHttp";
 
 export class HttpClient implements IHttpClient {
   serverUrl: string;
@@ -34,40 +35,126 @@ export class HttpClient implements IHttpClient {
   }
 
   get(relativePath: string, signal?: AbortSignal): Promise<Response> {
-    return $get(`${this.serverUrl}${relativePath}`, this.headers, signal);
+    return $fetch(`${this.serverUrl}${relativePath}`, { method: "GET", headers: this.headers, signal });
   }
 
-  post(
-    relativePath: string,
-    body?: string | object | ArrayBuffer | Blob | globalThis.File | FormData
-  ): Promise<Response> {
-    return $post(`${this.serverUrl}${relativePath}`, this.headers, body);
+  post(relativePath: string, body?: BodyInit | object): Promise<Response> {
+    return $fetch(`${this.serverUrl}${relativePath}`, { method: "POST", headers: this.headers, body });
   }
 
-  put(
-    relativePath: string,
-    body?: string | object | ArrayBuffer | Blob | globalThis.File | FormData
-  ): Promise<Response> {
-    return $put(`${this.serverUrl}${relativePath}`, this.headers, body);
+  put(relativePath: string, body?: BodyInit | object): Promise<Response> {
+    return $fetch(`${this.serverUrl}${relativePath}`, { method: "PUT", headers: this.headers, body });
   }
 
   delete(relativePath: string): Promise<Response> {
-    return $delete(`${this.serverUrl}${relativePath}`, this.headers);
+    return $fetch(`${this.serverUrl}${relativePath}`, { method: "DELETE", headers: this.headers });
   }
 
-  postFile(
-    relativePath: string,
-    file: globalThis.File,
-    onProgress?: (progress: number) => void
-  ): Promise<XMLHttpRequest> {
+  uploadFile(relativePath: string, file: File, onProgress?: (progress: number) => void): Promise<XMLHttpRequest> {
     const data = new FormData();
     data.append("file", file);
-
-    return $XMLHttp(`${this.serverUrl}${relativePath}`, {
+    return $xmlhttp(`${this.serverUrl}${relativePath}`, {
       method: "POST",
       headers: this.headers,
       body: data,
       uploadProgress: onProgress,
     });
   }
+
+  // async downloadFile(
+  //   relativePath: string,
+  //   onProgress?: (progress: number, chunk: Uint8Array) => void,
+  //   signal?: AbortSignal
+  // ): Promise<Response> {
+  //   const response = await this.get(relativePath, signal);
+  //   const teedOff = response.body.tee();
+  //   if (onProgress) {
+  //     const contentLength = response.headers.get("Content-Length");
+  //     const total = parseInt(contentLength, 10) || 1;
+  //     let loaded = 0;
+  //     const reader = teedOff[0].getReader();
+  //     reader.read().then(function processChunk({ done, value }) {
+  //       if (done) return;
+  //       loaded += value.length;
+  //       onProgress(loaded / total, value);
+  //       reader.read().then(processChunk);
+  //     });
+  //   }
+  //   return new Response(teedOff[1]);
+  // }
+
+  async downloadFile(
+    relativePath: string,
+    onProgress?: (progress: number, chunk: Uint8Array) => void,
+    signal?: AbortSignal
+  ): Promise<Response> {
+    const response = await this.get(relativePath, signal);
+    const contentLength = response.headers.get("Content-Length");
+    const total = parseInt(contentLength, 10) || 1;
+    return new Response(
+      new ReadableStream({
+        async start(controller) {
+          const reader = response.body.getReader();
+          let loaded = 0;
+          while (true) {
+            const { done, value } = await reader.read();
+            if (done) break;
+            controller.enqueue(value);
+            loaded += value.length;
+            if (onProgress) onProgress(loaded / total, value);
+          }
+          controller.close();
+        },
+      })
+    );
+  }
+
+  async downloadFileRange(
+    relativePath: string,
+    ranges: Array<{ begin: number; end: number; requestId: number }>,
+    onProgress?: (progress: number, chunk: Uint8Array, requestId: number) => void,
+    signal?: AbortSignal
+  ): Promise<Response> {
+    const headers = { ...this.headers };
+    headers["Range"] = "bytes=" + ranges.map((x) => `${x.begin}-${x.end}`).join(",");
+    const response = await $fetch(`${this.serverUrl}${relativePath}`, { method: "GET", headers, signal });
+    const contentLength = response.headers.get("content-length");
+    const total = parseInt(contentLength, 10) || 1;
+    return new Response(
+      new ReadableStream({
+        async start(controller) {
+          const reader = response.body.getReader();
+          let loaded = 0;
+          let rangedIndex = 0;
+          let rangePos = 0;
+          while (true) {
+            const { done, value } = await reader.read();
+            if (done) break;
+            controller.enqueue(value);
+            loaded += value.length;
+            let chunkLeft = value.length;
+            let chunkPos = 0;
+            while (chunkLeft > 0) {
+              const range = ranges[rangedIndex];
+              const rangeLeft = range.end - range.begin - rangePos;
+              if (chunkLeft < rangeLeft) {
+                const chunk = value.subarray(chunkPos, chunkPos + chunkLeft);
+                if (onProgress) onProgress(loaded / total, chunk, range.requestId);
+                rangePos += chunkLeft;
+                chunkLeft = 0;
+              } else {
+                const chunk = value.subarray(chunkPos, chunkPos + rangeLeft);
+                if (onProgress) onProgress(loaded / total, chunk, range.requestId);
+                chunkPos += rangeLeft;
+                chunkLeft -= rangeLeft;
+                rangedIndex++;
+                rangePos = 0;
+              }
+            }
+          }
+          controller.close();
+        },
+      })
+    );
+  }
 }

package/src/Api/IHttpClient.ts

@@ -23,28 +23,33 @@
 
 export interface IHttpClient {
   serverUrl: string;
-
   headers: HeadersInit;
-
   signInUserId: string;
 
-  get(relativePath, signal?: AbortSignal): Promise<Response>;
+  get(relativePath: string, signal?: AbortSignal): Promise<Response>;
 
-  post(
-    relativePath: string,
-    body?: ArrayBuffer | Blob | globalThis.File | FormData | object | string | null
-  ): Promise<Response>;
+  post(relativePath: string, body?: BodyInit | object): Promise<Response>;
 
-  put(
-    relativePath: string,
-    body?: ArrayBuffer | Blob | globalThis.File | FormData | object | string | null
-  ): Promise<Response>;
+  put(relativePath: string, body?: BodyInit | object): Promise<Response>;
 
   delete(relativePath: string): Promise<Response>;
 
-  postFile(
+  uploadFile(
     relativePath: string,
     file: globalThis.File,
     onProgress?: (progress: number) => void
   ): Promise<XMLHttpRequest>;
+
+  downloadFile(
+    relativePath: string,
+    onProgress?: (progress: number, chunk: Uint8Array) => void,
+    signal?: AbortSignal
+  ): Promise<Response>;
+
+  downloadFileRange(
+    relativePath: string,
+    ranges: Array<{ begin: number; end: number; requestId: number }>,
+    onProgress?: (progress: number, chunk: Uint8Array, requestId: number) => void,
+    signal?: AbortSignal
+  ): Promise<Response>;
 }