@inweb/client 26.6.4 → 26.6.6

package/lib/Api/Assembly.d.ts

@@ -250,14 +250,17 @@ export declare class Assembly extends Endpoint {
      * 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 ranges - A ranges of resource file contents to download. See
+     *   {@link https://developer.mozilla.org/docs/Web/HTTP/Guides/Range_requests | HTTP range requests} for
+     *   more details.
+     * @param requestId - Specify a non-empty `requestId` to append the `?requestId=` search parameter to
+     *   the server request. If specified, server-side caching may not work.
      * @param onProgress - Download progress callback.
      * @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, requestId: number, ranges: Array<{
+    downloadResourceRange(dataId: string, requestId: number | string, ranges: Array<{
         begin: number;
         end: number;
         requestId: number;

package/lib/Api/File.d.ts

@@ -375,14 +375,17 @@ export declare class File extends Endpoint {
      * 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 ranges - A ranges of resource file contents to download. See
+     *   {@link https://developer.mozilla.org/docs/Web/HTTP/Guides/Range_requests | HTTP range requests} for
+     *   more details.
+     * @param requestId - Specify a non-empty `requestId` to append the `?requestId=` search parameter to
+     *   the server request. If specified, server-side caching may not work.
      * @param onProgress - Download progress callback.
      * @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, requestId: number, ranges: Array<{
+    downloadResourceRange(dataId: string, requestId: number | string, ranges: Array<{
         begin: number;
         end: number;
         requestId: number;

package/lib/Api/HttpClient.d.ts

@@ -11,7 +11,7 @@ export declare class HttpClient implements IHttpClient {
     delete(relativePath: string, init?: RequestInit): Promise<Response>;
     uploadFile(relativePath: string, file: File, onProgress?: (progress: number) => void, init?: RequestInit): Promise<XMLHttpRequest>;
     downloadFile(relativePath: string, onProgress?: (progress: number, chunk: Uint8Array) => void, init?: RequestInit): Promise<Response>;
-    downloadFileRange(relativePath: string, reserved: number, ranges: Array<{
+    downloadFileRange(relativePath: string, reserved: number | string, ranges: Array<{
         begin: number;
         end: number;
         requestId: number;

package/lib/Api/IHttpClient.d.ts

@@ -89,12 +89,14 @@ export interface IHttpClient {
      *
      * @param relativePath - Download endpoint relative path.
      * @param reserved - Reserved, do not use.
-     * @param ranges - A ranges of resource file contents to download.
+     * @param ranges - A ranges of resource file contents to download. See
+     *   {@link https://developer.mozilla.org/docs/Web/HTTP/Guides/Range_requests | HTTP range requests} for
+     *   more details.
      * @param onProgress - Download progress callback.
      * @param init - A set of options that can be used to configure a fetch request. See
      *   {@link https://developer.mozilla.org/docs/Web/API/RequestInit | RequestInit} for more details.
      */
-    downloadFileRange(relativePath: string, reserved: number, ranges: Array<{
+    downloadFileRange(relativePath: string, reserved: number | string, ranges: Array<{
         begin: number;
         end: number;
         requestId: number;

package/lib/Api/Model.d.ts

@@ -146,8 +146,11 @@ export declare class Model extends Endpoint {
      * 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 ranges - A ranges of resource file contents to download. See
+     *   {@link https://developer.mozilla.org/docs/Web/HTTP/Guides/Range_requests | HTTP range requests} for
+     *   more details.
+     * @param requestId - Specify a non-empty `requestId` to append the `?requestId=` search parameter to
+     *   the server request. If specified, server-side caching may not work.
      * @param onProgress - Download progress callback.
      * @param signal - An
      *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController} signal. Allows

package/package.json

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

package/src/Api/Assembly.ts

@@ -435,8 +435,11 @@ export class Assembly extends Endpoint {
    * 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 ranges - A ranges of resource file contents to download. See
+   *   {@link https://developer.mozilla.org/docs/Web/HTTP/Guides/Range_requests | HTTP range requests} for
+   *   more details.
+   * @param requestId - Specify a non-empty `requestId` to append the `?requestId=` search parameter to
+   *   the server request. If specified, server-side caching may not work.
    * @param onProgress - Download progress callback.
    * @param signal - An
    *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController} signal. Allows
@@ -444,14 +447,14 @@ export class Assembly extends Endpoint {
    */
   downloadResourceRange(
     dataId: string,
-    requestId: number,
+    requestId: number | string,
     ranges: Array<{ begin: number; end: number; requestId: number }>,
     onProgress?: (progress: number, chunk: Uint8Array, requestId: number) => void,
     signal?: AbortSignal
   ): Promise<ArrayBuffer> {
     return this.httpClient
       .downloadFileRange(
-        this.getEndpointPath(`/downloads/${dataId}?requestId=${requestId}`),
+        this.getEndpointPath(`/downloads/${dataId}${requestId ? "?requestId=" + requestId : ""}`),
         requestId,
         ranges,
         onProgress,

package/src/Api/Endpoint.ts

@@ -54,6 +54,8 @@ export class Endpoint {
     this.headers = headers;
   }
 
+  // Internal: append the `?version=` search param to the specified relative path.
+
   appendVersionParam(relativePath: string): string {
     if (this._useVersion === undefined) return relativePath;
     const delimiter = relativePath.includes("?") ? "&" : "?";

package/src/Api/File.ts

@@ -606,8 +606,11 @@ export class File extends Endpoint {
    * 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 ranges - A ranges of resource file contents to download. See
+   *   {@link https://developer.mozilla.org/docs/Web/HTTP/Guides/Range_requests | HTTP range requests} for
+   *   more details.
+   * @param requestId - Specify a non-empty `requestId` to append the `?requestId=` search parameter to
+   *   the server request. If specified, server-side caching may not work.
    * @param onProgress - Download progress callback.
    * @param signal - An
    *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController} signal. Allows
@@ -615,14 +618,14 @@ export class File extends Endpoint {
    */
   downloadResourceRange(
     dataId: string,
-    requestId: number,
+    requestId: number | string,
     ranges: Array<{ begin: number; end: number; requestId: number }>,
     onProgress?: (progress: number, chunk: Uint8Array, requestId: number) => void,
     signal?: AbortSignal
   ): Promise<ArrayBuffer> {
     return this.httpClient
       .downloadFileRange(
-        this.getEndpointPath(`/downloads/${dataId}?requestId=${requestId}`),
+        this.getEndpointPath(`/downloads/${dataId}${requestId ? "?requestId=" + requestId : ""}`),
         requestId,
         ranges,
         onProgress,

package/src/Api/HttpClient.ts

@@ -85,101 +85,87 @@ export class HttpClient implements IHttpClient {
     });
   }
 
-  // async downloadFile(
-  //   relativePath: string,
-  //   onProgress?: (progress: number, chunk: Uint8Array) => void,
-  //   init: RequestInit = {}
-  // ): Promise<Response> {
-  //   const response = await this.get(relativePath, init);
-  //   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,
     init: RequestInit = {}
   ): Promise<Response> {
     const response = await this.get(relativePath, init);
+    if (!onProgress) return response;
+
     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();
-        },
-      })
-    );
+
+    const stream = 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;
+          onProgress(loaded / total, value);
+        }
+        controller.close();
+      },
+    });
+
+    return new Response(stream);
   }
 
   async downloadFileRange(
     relativePath: string,
-    reserved: number,
+    reserved: number | string,
     ranges: Array<{ begin: number; end: number; requestId: number }>,
     onProgress?: (progress: number, chunk: Uint8Array, requestId: number) => void,
     init: RequestInit = {}
   ): Promise<Response> {
-    const headers = { ...init.headers };
-    headers["Range"] = "bytes=" + ranges.map((x) => `${x.begin}-${x.end}`).join(",");
+    const headers = {
+      ...init.headers,
+      Range: "bytes=" + ranges.map((x) => `${x.begin}-${x.end}`).join(","),
+    };
     const response = await this.get(relativePath, { ...init, headers });
+    if (!onProgress) return response;
+
     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;
-              }
+
+    const stream = 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 + 1 - rangePos;
+            if (chunkLeft < rangeLeft) {
+              const chunk = value.subarray(chunkPos, chunkPos + chunkLeft);
+              onProgress(loaded / total, chunk, range.requestId);
+              rangePos += chunkLeft;
+              chunkLeft = 0;
+            } else {
+              const chunk = value.subarray(chunkPos, chunkPos + rangeLeft);
+              onProgress(loaded / total, chunk, range.requestId);
+              chunkPos += rangeLeft;
+              chunkLeft -= rangeLeft;
+              rangedIndex++;
+              rangePos = 0;
             }
           }
-          controller.close();
-        },
-      })
-    );
+        }
+        controller.close();
+      },
+    });
+
+    return new Response(stream);
   }
 }

package/src/Api/IHttpClient.ts

@@ -131,14 +131,16 @@ export interface IHttpClient {
    *
    * @param relativePath - Download endpoint relative path.
    * @param reserved - Reserved, do not use.
-   * @param ranges - A ranges of resource file contents to download.
+   * @param ranges - A ranges of resource file contents to download. See
+   *   {@link https://developer.mozilla.org/docs/Web/HTTP/Guides/Range_requests | HTTP range requests} for
+   *   more details.
    * @param onProgress - Download progress callback.
    * @param init - A set of options that can be used to configure a fetch request. See
    *   {@link https://developer.mozilla.org/docs/Web/API/RequestInit | RequestInit} for more details.
    */
   downloadFileRange(
     relativePath: string,
-    reserved: number,
+    reserved: number | string,
     ranges: Array<{ begin: number; end: number; requestId: number }>,
     onProgress?: (progress: number, chunk: Uint8Array, requestId: number) => void,
     init?: RequestInit

package/src/Api/Model.ts

@@ -253,8 +253,11 @@ export class Model extends Endpoint {
    * 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 ranges - A ranges of resource file contents to download. See
+   *   {@link https://developer.mozilla.org/docs/Web/HTTP/Guides/Range_requests | HTTP range requests} for
+   *   more details.
+   * @param requestId - Specify a non-empty `requestId` to append the `?requestId=` search parameter to
+   *   the server request. If specified, server-side caching may not work.
    * @param onProgress - Download progress callback.
    * @param signal - An
    *   {@link https://developer.mozilla.org/docs/Web/API/AbortController | AbortController} signal. Allows