@inweb/client 26.6.3 → 26.6.5

package/dist/client.js

@@ -42,6 +42,7 @@
             this.httpClient = httpClient;
             this.headers = headers;
         }
+        // Internal: append the `?version=` search param to the specified relative path.
         appendVersionParam(relativePath) {
             if (this._useVersion === undefined)
                 return relativePath;
@@ -443,8 +444,11 @@
          * 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
@@ -1201,8 +1205,11 @@
          * 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
@@ -1210,7 +1217,7 @@
          */
         downloadResourceRange(dataId, requestId, ranges, onProgress, signal) {
             return this.httpClient
-                .downloadFileRange(this.getEndpointPath(`/downloads/${dataId}?requestId=${requestId}`), requestId, ranges, onProgress, { signal, headers: this.headers })
+                .downloadFileRange(this.getEndpointPath(`/downloads/${dataId}${requestId ? "?requestId=" + requestId : ""}`), requestId, ranges, onProgress, { signal, headers: this.headers })
                 .then((response) => response.arrayBuffer());
         }
         /**
@@ -1665,32 +1672,13 @@
                 uploadProgress: onProgress,
             });
         }
-        // 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, onProgress, init = {}) {
             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({
+            const stream = new ReadableStream({
                 async start(controller) {
                     const reader = response.body.getReader();
                     let loaded = 0;
@@ -1700,20 +1688,24 @@
                             break;
                         controller.enqueue(value);
                         loaded += value.length;
-                        if (onProgress)
-                            onProgress(loaded / total, value);
+                        onProgress(loaded / total, value);
                     }
                     controller.close();
                 },
-            }));
+            });
+            return new Response(stream);
         }
         async downloadFileRange(relativePath, reserved, ranges, onProgress, init = {}) {
-            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({
+            const stream = new ReadableStream({
                 async start(controller) {
                     const reader = response.body.getReader();
                     let loaded = 0;
@@ -1729,18 +1721,16 @@
                         let chunkPos = 0;
                         while (chunkLeft > 0) {
                             const range = ranges[rangedIndex];
-                            const rangeLeft = range.end - range.begin - rangePos;
+                            const rangeLeft = range.end - range.begin + 1 - rangePos;
                             if (chunkLeft < rangeLeft) {
                                 const chunk = value.subarray(chunkPos, chunkPos + chunkLeft);
-                                if (onProgress)
-                                    onProgress(loaded / total, chunk, range.requestId);
+                                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);
+                                onProgress(loaded / total, chunk, range.requestId);
                                 chunkPos += rangeLeft;
                                 chunkLeft -= rangeLeft;
                                 rangedIndex++;
@@ -1750,7 +1740,8 @@
                     }
                     controller.close();
                 },
-            }));
+            });
+            return new Response(stream);
         }
     }
 
@@ -2784,8 +2775,11 @@
          * 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
@@ -2793,7 +2787,7 @@
          */
         downloadResourceRange(dataId, requestId, ranges, onProgress, signal) {
             return this.httpClient
-                .downloadFileRange(this.getEndpointPath(`/downloads/${dataId}?requestId=${requestId}`), requestId, ranges, onProgress, { signal, headers: this.headers })
+                .downloadFileRange(this.getEndpointPath(`/downloads/${dataId}${requestId ? "?requestId=" + requestId : ""}`), requestId, ranges, onProgress, { signal, headers: this.headers })
                 .then((response) => response.arrayBuffer());
         }
         /**
@@ -4631,7 +4625,7 @@
                 .then((data) => ({
                 ...data,
                 server: data.version,
-                client: "26.6.3",
+                client: "26.6.5",
             }));
         }
         /**
@@ -5530,7 +5524,7 @@
     // By use of this software, its documentation or related materials, you
     // acknowledge and accept the above terms.
     ///////////////////////////////////////////////////////////////////////////////
-    const version = "26.6.3";
+    const version = "26.6.5";
 
     exports.Assembly = Assembly;
     exports.ClashTest = ClashTest;