@spoosh/plugin-throttle 0.1.0-beta.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,39 @@
+# @spoosh/plugin-throttle
+
+Request throttling plugin for Spoosh - limits request frequency.
+
+**[Documentation](https://spoosh.dev/docs/plugins/throttle)** · **Requirements:** TypeScript >= 5.0 · **Peer Dependencies:** `@spoosh/core`
+
+## Installation
+
+```bash
+npm install @spoosh/plugin-throttle
+```
+
+## Usage
+
+```typescript
+import { throttlePlugin } from "@spoosh/plugin-throttle";
+
+const plugins = [
+  // ...otherPlugins,
+  throttlePlugin(), // register at end to block even force fetches
+];
+
+// Max 1 request per second - extras return cached data
+const { data } = useRead((api) => api.expensive.$get(), { throttle: 1000 });
+```
+
+## Options
+
+### Per-Request Options
+
+| Option     | Type     | Description                                                          |
+| ---------- | -------- | -------------------------------------------------------------------- |
+| `throttle` | `number` | Max 1 request per X milliseconds. Extra requests return cached data. |
+
+## Notes
+
+- Register this plugin at the end of your plugin list, to make sure it block even force fetch requests.
+- Unlike debounce (which delays), throttle immediately returns cached data for extra requests
+- Useful for rate-limiting expensive endpoints

package/dist/index.d.mts

@@ -0,0 +1,38 @@
+import { SpooshPlugin } from '@spoosh/core';
+
+interface ThrottleReadOptions {
+    /** Throttle requests to max 1 per X milliseconds. Extras return cached data. */
+    throttle?: number;
+}
+type ThrottleInfiniteReadOptions = ThrottleReadOptions;
+type ThrottleWriteOptions = object;
+type ThrottleReadResult = object;
+type ThrottleWriteResult = object;
+
+/**
+ * Enables throttling for read operations.
+ *
+ * Limits how frequently a query can be executed, returning cached data
+ * if the throttle window hasn't elapsed.
+ *
+ * @see {@link https://spoosh.dev/docs/plugins/throttle | Throttle Plugin Documentation}
+ *
+ * @example
+ * ```ts
+ * const plugins = [throttlePlugin()];
+ *
+ * // Throttle to max once per second
+ * useRead((api) => api.posts.$get(), {
+ *   throttle: 1000,
+ * });
+ * ```
+ */
+declare function throttlePlugin(): SpooshPlugin<{
+    readOptions: ThrottleReadOptions;
+    writeOptions: ThrottleWriteOptions;
+    infiniteReadOptions: ThrottleInfiniteReadOptions;
+    readResult: ThrottleReadResult;
+    writeResult: ThrottleWriteResult;
+}>;
+
+export { type ThrottleInfiniteReadOptions, type ThrottleReadOptions, type ThrottleReadResult, type ThrottleWriteOptions, type ThrottleWriteResult, throttlePlugin };

package/dist/index.d.ts

@@ -0,0 +1,38 @@
+import { SpooshPlugin } from '@spoosh/core';
+
+interface ThrottleReadOptions {
+    /** Throttle requests to max 1 per X milliseconds. Extras return cached data. */
+    throttle?: number;
+}
+type ThrottleInfiniteReadOptions = ThrottleReadOptions;
+type ThrottleWriteOptions = object;
+type ThrottleReadResult = object;
+type ThrottleWriteResult = object;
+
+/**
+ * Enables throttling for read operations.
+ *
+ * Limits how frequently a query can be executed, returning cached data
+ * if the throttle window hasn't elapsed.
+ *
+ * @see {@link https://spoosh.dev/docs/plugins/throttle | Throttle Plugin Documentation}
+ *
+ * @example
+ * ```ts
+ * const plugins = [throttlePlugin()];
+ *
+ * // Throttle to max once per second
+ * useRead((api) => api.posts.$get(), {
+ *   throttle: 1000,
+ * });
+ * ```
+ */
+declare function throttlePlugin(): SpooshPlugin<{
+    readOptions: ThrottleReadOptions;
+    writeOptions: ThrottleWriteOptions;
+    infiniteReadOptions: ThrottleInfiniteReadOptions;
+    readResult: ThrottleReadResult;
+    writeResult: ThrottleWriteResult;
+}>;
+
+export { type ThrottleInfiniteReadOptions, type ThrottleReadOptions, type ThrottleReadResult, type ThrottleWriteOptions, type ThrottleWriteResult, throttlePlugin };

package/dist/index.js

@@ -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/index.ts
+var src_exports = {};
+__export(src_exports, {
+  throttlePlugin: () => throttlePlugin
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/plugin.ts
+function throttlePlugin() {
+  const lastFetchTime = /* @__PURE__ */ new Map();
+  return {
+    name: "spoosh:throttle",
+    operations: ["read", "infiniteRead"],
+    middleware: async (context, next) => {
+      const pluginOptions = context.pluginOptions;
+      const throttleMs = pluginOptions?.throttle;
+      if (!throttleMs || throttleMs <= 0) {
+        return next();
+      }
+      const { queryKey } = context;
+      const now = Date.now();
+      const lastTime = lastFetchTime.get(queryKey) ?? 0;
+      const elapsed = now - lastTime;
+      if (elapsed < throttleMs) {
+        const cached = context.stateManager.getCache(queryKey);
+        if (cached?.state?.data !== void 0) {
+          return { data: cached.state.data, status: 200 };
+        }
+        return { data: void 0, status: 0 };
+      }
+      lastFetchTime.set(queryKey, now);
+      return next();
+    },
+    lifecycle: {
+      onUnmount(context) {
+        lastFetchTime.delete(context.queryKey);
+      }
+    }
+  };
+}

package/dist/index.mjs

@@ -0,0 +1,36 @@
+// src/plugin.ts
+function throttlePlugin() {
+  const lastFetchTime = /* @__PURE__ */ new Map();
+  return {
+    name: "spoosh:throttle",
+    operations: ["read", "infiniteRead"],
+    middleware: async (context, next) => {
+      const pluginOptions = context.pluginOptions;
+      const throttleMs = pluginOptions?.throttle;
+      if (!throttleMs || throttleMs <= 0) {
+        return next();
+      }
+      const { queryKey } = context;
+      const now = Date.now();
+      const lastTime = lastFetchTime.get(queryKey) ?? 0;
+      const elapsed = now - lastTime;
+      if (elapsed < throttleMs) {
+        const cached = context.stateManager.getCache(queryKey);
+        if (cached?.state?.data !== void 0) {
+          return { data: cached.state.data, status: 200 };
+        }
+        return { data: void 0, status: 0 };
+      }
+      lastFetchTime.set(queryKey, now);
+      return next();
+    },
+    lifecycle: {
+      onUnmount(context) {
+        lastFetchTime.delete(context.queryKey);
+      }
+    }
+  };
+}
+export {
+  throttlePlugin
+};

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@spoosh/plugin-throttle",
+  "version": "0.1.0-beta.0",
+  "description": "Request throttling plugin for Spoosh - limits request frequency",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nxnom/spoosh.git",
+    "directory": "packages/plugin-throttle"
+  },
+  "bugs": {
+    "url": "https://github.com/nxnom/spoosh/issues"
+  },
+  "homepage": "https://spoosh.dev/docs/plugins/throttle",
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "spoosh",
+    "plugin",
+    "throttle",
+    "api-client",
+    "rate-limit"
+  ],
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "peerDependencies": {
+    "@spoosh/core": ">=0.1.0"
+  },
+  "devDependencies": {
+    "@spoosh/core": "0.1.0-beta.0",
+    "@spoosh/test-utils": "0.1.0-beta.0"
+  },
+  "scripts": {
+    "dev": "tsup --watch",
+    "build": "tsup",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src --max-warnings 0",
+    "format": "prettier --write 'src/**/*.ts'"
+  }
+}