@spoosh/plugin-debounce 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,50 @@
+# @spoosh/plugin-debounce
+
+Request debouncing plugin for Spoosh - waits for inactivity before fetching.
+
+**[Documentation](https://spoosh.dev/docs/plugins/debounce)** · **Requirements:** TypeScript >= 5.0 · **Peer Dependencies:** `@spoosh/core`
+
+## Installation
+
+```bash
+npm install @spoosh/plugin-debounce
+```
+
+## Usage
+
+```typescript
+import { debouncePlugin } from "@spoosh/plugin-debounce";
+
+const plugins = [debouncePlugin()];
+
+// Wait 300ms after typing stops before fetching
+const { data } = useRead(
+  (api) => api.search.$get({ query: { q: searchTerm } }),
+  { debounce: 300 }
+);
+
+// Conditional debounce - only debounce when search query changes
+const { data } = useRead(
+  (api) => api.search.$get({ query: { q: searchTerm, page } }),
+  { debounce: ({ prevQuery }) => (prevQuery?.q !== searchTerm ? 300 : 0) }
+);
+```
+
+## Options
+
+### Per-Request Options
+
+| Option     | Type                            | Description                                                          |
+| ---------- | ------------------------------- | -------------------------------------------------------------------- |
+| `debounce` | `number \| (context) => number` | Milliseconds to wait, or function receiving previous request context |
+
+### Debounce Function Context
+
+When using a function, you receive:
+
+| Property       | Type      | Description               |
+| -------------- | --------- | ------------------------- |
+| `prevQuery`    | `object`  | Previous query parameters |
+| `prevBody`     | `unknown` | Previous request body     |
+| `prevParams`   | `object`  | Previous path parameters  |
+| `prevFormData` | `object`  | Previous form data        |

package/dist/index.d.mts

@@ -0,0 +1,67 @@
+import { SpooshPlugin } from '@spoosh/core';
+
+type PrevQueryField<TQuery> = [TQuery] extends [never] ? object : {
+    prevQuery?: TQuery;
+};
+type PrevBodyField<TBody> = [TBody] extends [never] ? object : {
+    prevBody?: TBody;
+};
+type PrevParamsField<TParams> = [TParams] extends [never] ? object : {
+    prevParams?: TParams;
+};
+type PrevFormDataField<TFormData> = [TFormData] extends [never] ? object : {
+    prevFormData?: TFormData;
+};
+type DebounceContext<TQuery = never, TBody = never, TParams = never, TFormData = never> = PrevQueryField<TQuery> & PrevBodyField<TBody> & PrevParamsField<TParams> & PrevFormDataField<TFormData>;
+type DebounceFn<TQuery = never, TBody = never, TParams = never, TFormData = never> = (context: DebounceContext<TQuery, TBody, TParams, TFormData>) => number;
+type DebounceValue<TQuery = never, TBody = never, TParams = never, TFormData = never> = number | DebounceFn<TQuery, TBody, TParams, TFormData>;
+type RequestAwareDebounceFn = DebounceValue<never, never, never, never>;
+interface DebounceReadOptions {
+    /**
+     * Debounce requests by X milliseconds. Waits for inactivity before fetching.
+     * Can be a number or a function that returns a number based on previous request.
+     */
+    debounce?: RequestAwareDebounceFn;
+}
+type DebounceInfiniteReadOptions = DebounceReadOptions;
+type DebounceWriteOptions = object;
+type DebounceReadResult = object;
+type DebounceWriteResult = object;
+declare module "@spoosh/core" {
+    interface PluginResolvers<TContext> {
+        debounce: DebounceValue<TContext["input"]["query"], TContext["input"]["body"], TContext["input"]["params"], TContext["input"]["formData"]> | undefined;
+    }
+}
+
+/**
+ * Enables debouncing for read operations.
+ *
+ * Delays requests until input stops changing, useful for search inputs
+ * to avoid excessive API calls while typing.
+ *
+ * @see {@link https://spoosh.dev/docs/plugins/debounce | Debounce Plugin Documentation}
+ *
+ * @example
+ * ```ts
+ * const plugins = [debouncePlugin()];
+ *
+ * // Debounce search by 300ms
+ * useRead((api) => api.search.$get({ query: { q: searchTerm } }), {
+ *   debounce: 300,
+ * });
+ *
+ * // Dynamic debounce based on previous query
+ * useRead((api) => api.search.$get({ query: { q: searchTerm } }), {
+ *   debounce: ({ prevQuery }) => prevQuery?.q ? 300 : 0,
+ * });
+ * ```
+ */
+declare function debouncePlugin(): SpooshPlugin<{
+    readOptions: DebounceReadOptions;
+    writeOptions: DebounceWriteOptions;
+    infiniteReadOptions: DebounceInfiniteReadOptions;
+    readResult: DebounceReadResult;
+    writeResult: DebounceWriteResult;
+}>;
+
+export { type DebounceContext, type DebounceFn, type DebounceInfiniteReadOptions, type DebounceReadOptions, type DebounceReadResult, type DebounceValue, type DebounceWriteOptions, type DebounceWriteResult, type RequestAwareDebounceFn, debouncePlugin };

package/dist/index.d.ts

@@ -0,0 +1,67 @@
+import { SpooshPlugin } from '@spoosh/core';
+
+type PrevQueryField<TQuery> = [TQuery] extends [never] ? object : {
+    prevQuery?: TQuery;
+};
+type PrevBodyField<TBody> = [TBody] extends [never] ? object : {
+    prevBody?: TBody;
+};
+type PrevParamsField<TParams> = [TParams] extends [never] ? object : {
+    prevParams?: TParams;
+};
+type PrevFormDataField<TFormData> = [TFormData] extends [never] ? object : {
+    prevFormData?: TFormData;
+};
+type DebounceContext<TQuery = never, TBody = never, TParams = never, TFormData = never> = PrevQueryField<TQuery> & PrevBodyField<TBody> & PrevParamsField<TParams> & PrevFormDataField<TFormData>;
+type DebounceFn<TQuery = never, TBody = never, TParams = never, TFormData = never> = (context: DebounceContext<TQuery, TBody, TParams, TFormData>) => number;
+type DebounceValue<TQuery = never, TBody = never, TParams = never, TFormData = never> = number | DebounceFn<TQuery, TBody, TParams, TFormData>;
+type RequestAwareDebounceFn = DebounceValue<never, never, never, never>;
+interface DebounceReadOptions {
+    /**
+     * Debounce requests by X milliseconds. Waits for inactivity before fetching.
+     * Can be a number or a function that returns a number based on previous request.
+     */
+    debounce?: RequestAwareDebounceFn;
+}
+type DebounceInfiniteReadOptions = DebounceReadOptions;
+type DebounceWriteOptions = object;
+type DebounceReadResult = object;
+type DebounceWriteResult = object;
+declare module "@spoosh/core" {
+    interface PluginResolvers<TContext> {
+        debounce: DebounceValue<TContext["input"]["query"], TContext["input"]["body"], TContext["input"]["params"], TContext["input"]["formData"]> | undefined;
+    }
+}
+
+/**
+ * Enables debouncing for read operations.
+ *
+ * Delays requests until input stops changing, useful for search inputs
+ * to avoid excessive API calls while typing.
+ *
+ * @see {@link https://spoosh.dev/docs/plugins/debounce | Debounce Plugin Documentation}
+ *
+ * @example
+ * ```ts
+ * const plugins = [debouncePlugin()];
+ *
+ * // Debounce search by 300ms
+ * useRead((api) => api.search.$get({ query: { q: searchTerm } }), {
+ *   debounce: 300,
+ * });
+ *
+ * // Dynamic debounce based on previous query
+ * useRead((api) => api.search.$get({ query: { q: searchTerm } }), {
+ *   debounce: ({ prevQuery }) => prevQuery?.q ? 300 : 0,
+ * });
+ * ```
+ */
+declare function debouncePlugin(): SpooshPlugin<{
+    readOptions: DebounceReadOptions;
+    writeOptions: DebounceWriteOptions;
+    infiniteReadOptions: DebounceInfiniteReadOptions;
+    readResult: DebounceReadResult;
+    writeResult: DebounceWriteResult;
+}>;
+
+export { type DebounceContext, type DebounceFn, type DebounceInfiniteReadOptions, type DebounceReadOptions, type DebounceReadResult, type DebounceValue, type DebounceWriteOptions, type DebounceWriteResult, type RequestAwareDebounceFn, debouncePlugin };

package/dist/index.js

@@ -0,0 +1,105 @@
+"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, {
+  debouncePlugin: () => debouncePlugin
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/plugin.ts
+function resolveDebounceMs(debounce, context) {
+  if (debounce === void 0) return 0;
+  if (typeof debounce === "number") return debounce;
+  return debounce(context);
+}
+function debouncePlugin() {
+  const timers = /* @__PURE__ */ new Map();
+  const latestQueryKeys = /* @__PURE__ */ new Map();
+  const prevRequests = /* @__PURE__ */ new Map();
+  return {
+    name: "spoosh:debounce",
+    operations: ["read", "infiniteRead"],
+    middleware: async (context, next) => {
+      const pluginOptions = context.pluginOptions;
+      const debounceOption = pluginOptions?.debounce;
+      if (debounceOption === void 0 || context.forceRefetch) {
+        return next();
+      }
+      const { queryKey, requestOptions, path, method } = context;
+      const stableKey = `${path.join("/")}:${method}`;
+      const opts = requestOptions;
+      const currentRequest = {
+        query: opts?.query,
+        params: opts?.params,
+        body: opts?.body,
+        formData: opts?.formData
+      };
+      const prevRequest = prevRequests.get(stableKey);
+      const prevContext = {};
+      if (prevRequest?.query !== void 0) {
+        prevContext.prevQuery = prevRequest.query;
+      }
+      if (prevRequest?.params !== void 0) {
+        prevContext.prevParams = prevRequest.params;
+      }
+      if (prevRequest?.body !== void 0) {
+        prevContext.prevBody = prevRequest.body;
+      }
+      if (prevRequest?.formData !== void 0) {
+        prevContext.prevFormData = prevRequest.formData;
+      }
+      const debounceMs = resolveDebounceMs(debounceOption, prevContext);
+      prevRequests.set(stableKey, currentRequest);
+      if (!debounceMs || debounceMs <= 0) {
+        return next();
+      }
+      const existingQueryKey = latestQueryKeys.get(stableKey);
+      if (existingQueryKey === queryKey) {
+        const cached2 = context.stateManager.getCache(queryKey);
+        if (cached2?.state?.data !== void 0) {
+          return { data: cached2.state.data, status: 200 };
+        }
+        return { data: void 0, status: 0 };
+      }
+      const existingTimer = timers.get(stableKey);
+      if (existingTimer) {
+        clearTimeout(existingTimer);
+      }
+      latestQueryKeys.set(stableKey, queryKey);
+      const cached = context.stateManager.getCache(queryKey);
+      const timer = setTimeout(() => {
+        timers.delete(stableKey);
+        const latestKey = latestQueryKeys.get(stableKey);
+        if (latestKey) {
+          context.eventEmitter.emit("refetch", {
+            queryKey: latestKey,
+            reason: "invalidate"
+          });
+        }
+      }, debounceMs);
+      timers.set(stableKey, timer);
+      if (cached?.state?.data !== void 0) {
+        return { data: cached.state.data, status: 200 };
+      }
+      return { data: void 0, status: 0 };
+    }
+  };
+}

package/dist/index.mjs

@@ -0,0 +1,82 @@
+// src/plugin.ts
+function resolveDebounceMs(debounce, context) {
+  if (debounce === void 0) return 0;
+  if (typeof debounce === "number") return debounce;
+  return debounce(context);
+}
+function debouncePlugin() {
+  const timers = /* @__PURE__ */ new Map();
+  const latestQueryKeys = /* @__PURE__ */ new Map();
+  const prevRequests = /* @__PURE__ */ new Map();
+  return {
+    name: "spoosh:debounce",
+    operations: ["read", "infiniteRead"],
+    middleware: async (context, next) => {
+      const pluginOptions = context.pluginOptions;
+      const debounceOption = pluginOptions?.debounce;
+      if (debounceOption === void 0 || context.forceRefetch) {
+        return next();
+      }
+      const { queryKey, requestOptions, path, method } = context;
+      const stableKey = `${path.join("/")}:${method}`;
+      const opts = requestOptions;
+      const currentRequest = {
+        query: opts?.query,
+        params: opts?.params,
+        body: opts?.body,
+        formData: opts?.formData
+      };
+      const prevRequest = prevRequests.get(stableKey);
+      const prevContext = {};
+      if (prevRequest?.query !== void 0) {
+        prevContext.prevQuery = prevRequest.query;
+      }
+      if (prevRequest?.params !== void 0) {
+        prevContext.prevParams = prevRequest.params;
+      }
+      if (prevRequest?.body !== void 0) {
+        prevContext.prevBody = prevRequest.body;
+      }
+      if (prevRequest?.formData !== void 0) {
+        prevContext.prevFormData = prevRequest.formData;
+      }
+      const debounceMs = resolveDebounceMs(debounceOption, prevContext);
+      prevRequests.set(stableKey, currentRequest);
+      if (!debounceMs || debounceMs <= 0) {
+        return next();
+      }
+      const existingQueryKey = latestQueryKeys.get(stableKey);
+      if (existingQueryKey === queryKey) {
+        const cached2 = context.stateManager.getCache(queryKey);
+        if (cached2?.state?.data !== void 0) {
+          return { data: cached2.state.data, status: 200 };
+        }
+        return { data: void 0, status: 0 };
+      }
+      const existingTimer = timers.get(stableKey);
+      if (existingTimer) {
+        clearTimeout(existingTimer);
+      }
+      latestQueryKeys.set(stableKey, queryKey);
+      const cached = context.stateManager.getCache(queryKey);
+      const timer = setTimeout(() => {
+        timers.delete(stableKey);
+        const latestKey = latestQueryKeys.get(stableKey);
+        if (latestKey) {
+          context.eventEmitter.emit("refetch", {
+            queryKey: latestKey,
+            reason: "invalidate"
+          });
+        }
+      }, debounceMs);
+      timers.set(stableKey, timer);
+      if (cached?.state?.data !== void 0) {
+        return { data: cached.state.data, status: 200 };
+      }
+      return { data: void 0, status: 0 };
+    }
+  };
+}
+export {
+  debouncePlugin
+};

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@spoosh/plugin-debounce",
+  "version": "0.1.0-beta.0",
+  "description": "Request debouncing plugin for Spoosh - waits for inactivity before fetching",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nxnom/spoosh.git",
+    "directory": "packages/plugin-debounce"
+  },
+  "bugs": {
+    "url": "https://github.com/nxnom/spoosh/issues"
+  },
+  "homepage": "https://spoosh.dev/docs/plugins/debounce",
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "spoosh",
+    "plugin",
+    "debounce",
+    "api-client",
+    "search"
+  ],
+  "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'"
+  }
+}