@fetchkit/ffetch 5.1.1 → 5.2.1

package/README.md

@@ -67,6 +67,7 @@ ffetch uses a plugin architecture for optional features, so you only include wha
 - **Deduplication plugin (optional, prebuilt)** – automatic deduping of in-flight identical requests
 - **Request shortcuts plugin (optional, prebuilt)** – call `client.get(url)` / `.post()` / `.put()` / `.patch()` / `.delete()` directly on the client
 - **Response shortcuts plugin (optional, prebuilt)** – call `client(url).json()` / `.text()` / `.blob()` directly on the request promise
+- **Download progress plugin (optional, prebuilt)** – stream download progress callbacks with bytes transferred and percentage
 
 **Built-in error classes:** `TimeoutError`, `RetryLimitError`, `CircuitOpenError`, `HttpError`, `NetworkError`, `AbortError`
 
@@ -78,6 +79,7 @@ All plugins are tree-shakeable — import only what you use.
 - **circuitPlugin (optional)**: fail fast after repeated failures.
 - **requestShortcutsPlugin (optional)**: HTTP method shortcuts on the client (`.get()` / `.post()` / `.put()` / `.patch()` / `.delete()` / `.head()` / `.options()`).
 - **responseShortcutsPlugin (optional)**: use `client(url).json()` / `.text()` / `.blob()` style parsing.
+- **downloadProgressPlugin (optional)**: stream download progress via `onProgress(progress, chunk)` callback.
 
 ## What Problems Does ffetch Solve?
 
@@ -349,9 +351,10 @@ See [deduplication.md](./docs/deduplication.md) for full details.
 | Hooks/Middleware     | ❌ Not available                                        | ✅ Interceptors                | ✅ Hooks                                      | ✅ Comprehensive lifecycle hooks                                                       |
 | Bundle Size          | ✅ Native (0kb)                                         | ❌ ~13kb minified              | ✅ Lightweight (fetch-based)                  | ✅ ~3kb minified                                                                       |
 | Modern APIs          | ✅ Web standards                                        | ❌ XMLHttpRequest              | ✅ Fetch + modern APIs                        | ✅ Fetch + modern features                                                             |
+| Download Progress    | ❌ Manual ReadableStream                                | ❌ Manual                      | ✅ `onDownloadProgress` callback              | ✅ Optional via `downloadProgressPlugin()`                                             |
 | Custom Fetch Support | ❌ No (global only)                                     | ❌ No                          | ❌ No                                         | ✅ Yes (wrap any fetch-compatible implementation, including framework or custom fetch) |
 
-Note: built-in plugins in ffetch are opt-in. Use `dedupePlugin()` for deduplication, `circuitPlugin()` for circuit breaking, `requestShortcutsPlugin()` for client HTTP method shortcuts, and `responseShortcutsPlugin()` for request-promise parsing shortcuts. Bundle size: ~3kb core, additional optional plugin imports are tree-shakeable.
+Note: built-in plugins in ffetch are opt-in. Use `dedupePlugin()` for deduplication, `circuitPlugin()` for circuit breaking, `requestShortcutsPlugin()` for client HTTP method shortcuts, `responseShortcutsPlugin()` for request-promise parsing shortcuts, and `downloadProgressPlugin()` for streaming download progress. Bundle size: ~3kb core, additional optional plugin imports are tree-shakeable.
 
 ### Try ffetch in Action
 

package/dist/plugins/download-progress.cjs

@@ -0,0 +1,59 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/plugins/download-progress.ts
+var download_progress_exports = {};
+__export(download_progress_exports, {
+  downloadProgressPlugin: () => downloadProgressPlugin
+});
+module.exports = __toCommonJS(download_progress_exports);
+function downloadProgressPlugin(onProgress) {
+  return {
+    name: "downloadProgress",
+    wrapDispatch: (next) => async (ctx) => {
+      const response = await next(ctx);
+      if (!response.body) {
+        return response;
+      }
+      const contentLength = response.headers.get("content-length");
+      const totalBytes = contentLength ? parseInt(contentLength, 10) : 0;
+      let transferredBytes = 0;
+      const stream = response.body.pipeThrough(
+        new TransformStream({
+          transform(chunk, controller) {
+            transferredBytes += chunk.byteLength;
+            const percent = totalBytes > 0 ? transferredBytes / totalBytes : 0;
+            onProgress({ percent, transferredBytes, totalBytes }, chunk);
+            controller.enqueue(chunk);
+          }
+        })
+      );
+      return new Response(stream, {
+        status: response.status,
+        statusText: response.statusText,
+        headers: response.headers
+      });
+    }
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  downloadProgressPlugin
+});
+//# sourceMappingURL=download-progress.cjs.map

package/dist/plugins/download-progress.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/plugins/download-progress.ts"],"sourcesContent":["import type { ClientPlugin } from '../plugins.js'\n\nexport type DownloadProgressEvent = {\n  percent: number\n  transferredBytes: number\n  totalBytes: number\n}\n\nexport type DownloadProgressCallback = (\n  progress: DownloadProgressEvent,\n  chunk: Uint8Array\n) => void\n\nexport function downloadProgressPlugin(\n  onProgress: DownloadProgressCallback\n): ClientPlugin {\n  return {\n    name: 'downloadProgress',\n    wrapDispatch: (next) => async (ctx) => {\n      const response = await next(ctx)\n\n      if (!response.body) {\n        return response\n      }\n\n      const contentLength = response.headers.get('content-length')\n      const totalBytes = contentLength ? parseInt(contentLength, 10) : 0\n      let transferredBytes = 0\n\n      const stream = response.body.pipeThrough(\n        new TransformStream<Uint8Array, Uint8Array>({\n          transform(chunk, controller) {\n            transferredBytes += chunk.byteLength\n            const percent = totalBytes > 0 ? transferredBytes / totalBytes : 0\n            onProgress({ percent, transferredBytes, totalBytes }, chunk)\n            controller.enqueue(chunk)\n          },\n        })\n      )\n\n      return new Response(stream, {\n        status: response.status,\n        statusText: response.statusText,\n        headers: response.headers,\n      })\n    },\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAaO,SAAS,uBACd,YACc;AACd,SAAO;AAAA,IACL,MAAM;AAAA,IACN,cAAc,CAAC,SAAS,OAAO,QAAQ;AACrC,YAAM,WAAW,MAAM,KAAK,GAAG;AAE/B,UAAI,CAAC,SAAS,MAAM;AAClB,eAAO;AAAA,MACT;AAEA,YAAM,gBAAgB,SAAS,QAAQ,IAAI,gBAAgB;AAC3D,YAAM,aAAa,gBAAgB,SAAS,eAAe,EAAE,IAAI;AACjE,UAAI,mBAAmB;AAEvB,YAAM,SAAS,SAAS,KAAK;AAAA,QAC3B,IAAI,gBAAwC;AAAA,UAC1C,UAAU,OAAO,YAAY;AAC3B,gCAAoB,MAAM;AAC1B,kBAAM,UAAU,aAAa,IAAI,mBAAmB,aAAa;AACjE,uBAAW,EAAE,SAAS,kBAAkB,WAAW,GAAG,KAAK;AAC3D,uBAAW,QAAQ,KAAK;AAAA,UAC1B;AAAA,QACF,CAAC;AAAA,MACH;AAEA,aAAO,IAAI,SAAS,QAAQ;AAAA,QAC1B,QAAQ,SAAS;AAAA,QACjB,YAAY,SAAS;AAAA,QACrB,SAAS,SAAS;AAAA,MACpB,CAAC;AAAA,IACH;AAAA,EACF;AACF;","names":[]}

package/dist/plugins/download-progress.d.cts

@@ -0,0 +1,11 @@
+import { C as ClientPlugin } from '../plugins-DqBQVM4I.cjs';
+
+type DownloadProgressEvent = {
+    percent: number;
+    transferredBytes: number;
+    totalBytes: number;
+};
+type DownloadProgressCallback = (progress: DownloadProgressEvent, chunk: Uint8Array) => void;
+declare function downloadProgressPlugin(onProgress: DownloadProgressCallback): ClientPlugin;
+
+export { type DownloadProgressCallback, type DownloadProgressEvent, downloadProgressPlugin };

package/dist/plugins/download-progress.d.ts

@@ -0,0 +1,11 @@
+import { C as ClientPlugin } from '../plugins-DqBQVM4I.js';
+
+type DownloadProgressEvent = {
+    percent: number;
+    transferredBytes: number;
+    totalBytes: number;
+};
+type DownloadProgressCallback = (progress: DownloadProgressEvent, chunk: Uint8Array) => void;
+declare function downloadProgressPlugin(onProgress: DownloadProgressCallback): ClientPlugin;
+
+export { type DownloadProgressCallback, type DownloadProgressEvent, downloadProgressPlugin };

package/dist/plugins/download-progress.js

@@ -0,0 +1,34 @@
+// src/plugins/download-progress.ts
+function downloadProgressPlugin(onProgress) {
+  return {
+    name: "downloadProgress",
+    wrapDispatch: (next) => async (ctx) => {
+      const response = await next(ctx);
+      if (!response.body) {
+        return response;
+      }
+      const contentLength = response.headers.get("content-length");
+      const totalBytes = contentLength ? parseInt(contentLength, 10) : 0;
+      let transferredBytes = 0;
+      const stream = response.body.pipeThrough(
+        new TransformStream({
+          transform(chunk, controller) {
+            transferredBytes += chunk.byteLength;
+            const percent = totalBytes > 0 ? transferredBytes / totalBytes : 0;
+            onProgress({ percent, transferredBytes, totalBytes }, chunk);
+            controller.enqueue(chunk);
+          }
+        })
+      );
+      return new Response(stream, {
+        status: response.status,
+        statusText: response.statusText,
+        headers: response.headers
+      });
+    }
+  };
+}
+export {
+  downloadProgressPlugin
+};
+//# sourceMappingURL=download-progress.js.map

package/dist/plugins/download-progress.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/plugins/download-progress.ts"],"sourcesContent":["import type { ClientPlugin } from '../plugins.js'\n\nexport type DownloadProgressEvent = {\n  percent: number\n  transferredBytes: number\n  totalBytes: number\n}\n\nexport type DownloadProgressCallback = (\n  progress: DownloadProgressEvent,\n  chunk: Uint8Array\n) => void\n\nexport function downloadProgressPlugin(\n  onProgress: DownloadProgressCallback\n): ClientPlugin {\n  return {\n    name: 'downloadProgress',\n    wrapDispatch: (next) => async (ctx) => {\n      const response = await next(ctx)\n\n      if (!response.body) {\n        return response\n      }\n\n      const contentLength = response.headers.get('content-length')\n      const totalBytes = contentLength ? parseInt(contentLength, 10) : 0\n      let transferredBytes = 0\n\n      const stream = response.body.pipeThrough(\n        new TransformStream<Uint8Array, Uint8Array>({\n          transform(chunk, controller) {\n            transferredBytes += chunk.byteLength\n            const percent = totalBytes > 0 ? transferredBytes / totalBytes : 0\n            onProgress({ percent, transferredBytes, totalBytes }, chunk)\n            controller.enqueue(chunk)\n          },\n        })\n      )\n\n      return new Response(stream, {\n        status: response.status,\n        statusText: response.statusText,\n        headers: response.headers,\n      })\n    },\n  }\n}\n"],"mappings":";AAaO,SAAS,uBACd,YACc;AACd,SAAO;AAAA,IACL,MAAM;AAAA,IACN,cAAc,CAAC,SAAS,OAAO,QAAQ;AACrC,YAAM,WAAW,MAAM,KAAK,GAAG;AAE/B,UAAI,CAAC,SAAS,MAAM;AAClB,eAAO;AAAA,MACT;AAEA,YAAM,gBAAgB,SAAS,QAAQ,IAAI,gBAAgB;AAC3D,YAAM,aAAa,gBAAgB,SAAS,eAAe,EAAE,IAAI;AACjE,UAAI,mBAAmB;AAEvB,YAAM,SAAS,SAAS,KAAK;AAAA,QAC3B,IAAI,gBAAwC;AAAA,UAC1C,UAAU,OAAO,YAAY;AAC3B,gCAAoB,MAAM;AAC1B,kBAAM,UAAU,aAAa,IAAI,mBAAmB,aAAa;AACjE,uBAAW,EAAE,SAAS,kBAAkB,WAAW,GAAG,KAAK;AAC3D,uBAAW,QAAQ,KAAK;AAAA,UAC1B;AAAA,QACF,CAAC;AAAA,MACH;AAEA,aAAO,IAAI,SAAS,QAAQ;AAAA,QAC1B,QAAQ,SAAS;AAAA,QACjB,YAAY,SAAS;AAAA,QACrB,SAAS,SAAS;AAAA,MACpB,CAAC;AAAA,IACH;AAAA,EACF;AACF;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fetchkit/ffetch",
-  "version": "5.1.1",
+  "version": "5.2.1",
   "description": "Fetch wrapper with configurable timeouts, retries, and TypeScript-first DX",
   "keywords": [
     "fetch",
@@ -46,6 +46,11 @@
       "types": "./dist/plugins/request-shortcuts.d.ts",
       "import": "./dist/plugins/request-shortcuts.js",
       "require": "./dist/plugins/request-shortcuts.cjs"
+    },
+    "./plugins/download-progress": {
+      "types": "./dist/plugins/download-progress.d.ts",
+      "import": "./dist/plugins/download-progress.js",
+      "require": "./dist/plugins/download-progress.cjs"
     }
   },
   "files": [