@spoosh/plugin-progress 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Spoosh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,48 @@
+# @spoosh/plugin-progress
+
+Upload and download progress tracking plugin for Spoosh via XHR transport.
+
+**[Documentation](https://spoosh.dev/docs/react/plugins/progress)** · **Requirements:** TypeScript >= 5.0 · **Peer Dependencies:** `@spoosh/core`
+
+## Installation
+
+```bash
+npm install @spoosh/plugin-progress
+```
+
+## Usage
+
+```typescript
+import { Spoosh } from "@spoosh/core";
+import { progressPlugin } from "@spoosh/plugin-progress";
+
+const client = new Spoosh<ApiSchema, Error>("/api").use([progressPlugin()]);
+
+// Enable per-request
+useRead((api) => api("files/:id").GET(), { progress: true });
+
+// File upload with progress
+const { trigger, progress } = useWrite((api) => api("files").POST, {
+  progress: true,
+});
+trigger({ body: form({ file: selectedFile }) });
+```
+
+## Per-Request Options
+
+| Option     | Type                         | Description                                                 |
+| ---------- | ---------------------------- | ----------------------------------------------------------- |
+| `progress` | `boolean \| ProgressOptions` | Enable progress tracking. Automatically uses XHR transport. |
+
+### ProgressOptions
+
+| Option        | Type     | Description                                                                  |
+| ------------- | -------- | ---------------------------------------------------------------------------- |
+| `totalHeader` | `string` | Response header to read total size from when `Content-Length` is unavailable |
+
+## Result
+
+| Field    | Type     | Description                |
+| -------- | -------- | -------------------------- |
+| `loaded` | `number` | Bytes transferred so far   |
+| `total`  | `number` | Total bytes (0 if unknown) |

package/dist/index.d.mts

@@ -0,0 +1,35 @@
+import { SpooshPlugin } from '@spoosh/core';
+
+interface ProgressInfo {
+    loaded: number;
+    total: number;
+}
+interface ProgressOptions {
+    /** Response header name to read total size from when Content-Length is unavailable. */
+    totalHeader?: string;
+}
+interface ProgressReadOptions {
+    /** Enable progress tracking. Forces XHR transport. */
+    progress?: boolean | ProgressOptions;
+}
+interface ProgressWriteOptions {
+    /** Enable progress tracking. Forces XHR transport. */
+    progress?: boolean | ProgressOptions;
+}
+type ProgressInfiniteReadOptions = ProgressReadOptions;
+interface ProgressReadResult {
+    progress?: ProgressInfo;
+}
+interface ProgressWriteResult {
+    progress?: ProgressInfo;
+}
+
+declare function progressPlugin(): SpooshPlugin<{
+    readOptions: ProgressReadOptions;
+    writeOptions: ProgressWriteOptions;
+    infiniteReadOptions: ProgressInfiniteReadOptions;
+    readResult: ProgressReadResult;
+    writeResult: ProgressWriteResult;
+}>;
+
+export { type ProgressInfiniteReadOptions, type ProgressInfo, type ProgressOptions, type ProgressReadOptions, type ProgressReadResult, type ProgressWriteOptions, type ProgressWriteResult, progressPlugin };

package/dist/index.d.ts

@@ -0,0 +1,35 @@
+import { SpooshPlugin } from '@spoosh/core';
+
+interface ProgressInfo {
+    loaded: number;
+    total: number;
+}
+interface ProgressOptions {
+    /** Response header name to read total size from when Content-Length is unavailable. */
+    totalHeader?: string;
+}
+interface ProgressReadOptions {
+    /** Enable progress tracking. Forces XHR transport. */
+    progress?: boolean | ProgressOptions;
+}
+interface ProgressWriteOptions {
+    /** Enable progress tracking. Forces XHR transport. */
+    progress?: boolean | ProgressOptions;
+}
+type ProgressInfiniteReadOptions = ProgressReadOptions;
+interface ProgressReadResult {
+    progress?: ProgressInfo;
+}
+interface ProgressWriteResult {
+    progress?: ProgressInfo;
+}
+
+declare function progressPlugin(): SpooshPlugin<{
+    readOptions: ProgressReadOptions;
+    writeOptions: ProgressWriteOptions;
+    infiniteReadOptions: ProgressInfiniteReadOptions;
+    readResult: ProgressReadResult;
+    writeResult: ProgressWriteResult;
+}>;
+
+export { type ProgressInfiniteReadOptions, type ProgressInfo, type ProgressOptions, type ProgressReadOptions, type ProgressReadResult, type ProgressWriteOptions, type ProgressWriteResult, progressPlugin };

package/dist/index.js

@@ -0,0 +1,64 @@
+"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/index.ts
+var src_exports = {};
+__export(src_exports, {
+  progressPlugin: () => progressPlugin
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/plugin.ts
+function progressPlugin() {
+  return {
+    name: "spoosh:progress",
+    operations: ["read", "write", "infiniteRead"],
+    middleware: async (context, next) => {
+      const pluginOptions = context.pluginOptions;
+      if (!pluginOptions?.progress) {
+        return next();
+      }
+      const progressOptions = typeof pluginOptions.progress === "object" ? pluginOptions.progress : {};
+      context.requestOptions = {
+        ...context.requestOptions,
+        transport: "xhr",
+        transportOptions: {
+          onProgress: (event, xhr) => {
+            let total = event.total;
+            if (!event.lengthComputable && progressOptions.totalHeader) {
+              const headerVal = xhr.getResponseHeader(
+                progressOptions.totalHeader
+              );
+              if (headerVal) {
+                total = parseInt(headerVal, 10);
+              }
+            }
+            context.stateManager.setMeta(context.queryKey, {
+              progress: {
+                loaded: event.loaded,
+                total
+              }
+            });
+          }
+        }
+      };
+      return next();
+    }
+  };
+}

package/dist/index.mjs

@@ -0,0 +1,41 @@
+// src/plugin.ts
+function progressPlugin() {
+  return {
+    name: "spoosh:progress",
+    operations: ["read", "write", "infiniteRead"],
+    middleware: async (context, next) => {
+      const pluginOptions = context.pluginOptions;
+      if (!pluginOptions?.progress) {
+        return next();
+      }
+      const progressOptions = typeof pluginOptions.progress === "object" ? pluginOptions.progress : {};
+      context.requestOptions = {
+        ...context.requestOptions,
+        transport: "xhr",
+        transportOptions: {
+          onProgress: (event, xhr) => {
+            let total = event.total;
+            if (!event.lengthComputable && progressOptions.totalHeader) {
+              const headerVal = xhr.getResponseHeader(
+                progressOptions.totalHeader
+              );
+              if (headerVal) {
+                total = parseInt(headerVal, 10);
+              }
+            }
+            context.stateManager.setMeta(context.queryKey, {
+              progress: {
+                loaded: event.loaded,
+                total
+              }
+            });
+          }
+        }
+      };
+      return next();
+    }
+  };
+}
+export {
+  progressPlugin
+};

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@spoosh/plugin-progress",
+  "version": "0.1.0",
+  "description": "Upload and download progress tracking plugin for Spoosh via XHR transport",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/spooshdev/spoosh.git",
+    "directory": "packages/plugin-progress"
+  },
+  "bugs": {
+    "url": "https://github.com/spooshdev/spoosh/issues"
+  },
+  "homepage": "https://spoosh.dev/docs/react/plugins/progress",
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "spoosh",
+    "plugin",
+    "progress",
+    "upload",
+    "download",
+    "xhr"
+  ],
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "peerDependencies": {
+    "@spoosh/core": ">=0.10.0"
+  },
+  "devDependencies": {
+    "@spoosh/core": "0.10.0",
+    "@spoosh/test-utils": "0.1.5"
+  },
+  "scripts": {
+    "dev": "tsup --watch",
+    "build": "tsup",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src --max-warnings 0",
+    "format": "prettier --write 'src/**/*.ts'"
+  }
+}