@spoosh/plugin-polling 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,61 @@
+# @spoosh/plugin-polling
+
+Automatic polling/refetching plugin for Spoosh.
+
+**[Documentation](https://spoosh.dev/docs/plugins/polling)** · **Requirements:** TypeScript >= 5.0 · **Peer Dependencies:** `@spoosh/core`
+
+## Installation
+
+```bash
+npm install @spoosh/plugin-polling
+```
+
+## Usage
+
+```typescript
+import { pollingPlugin } from "@spoosh/plugin-polling";
+
+const plugins = [pollingPlugin()];
+
+// Static polling interval (5 seconds)
+useRead((api) => api.posts.$get(), { pollingInterval: 5000 });
+
+// Disable polling (Default behavior)
+useRead((api) => api.posts.$get(), { pollingInterval: false });
+
+// Dynamic polling interval based on data/error
+useRead((api) => api.booking[123].$get(), {
+  pollingInterval: (data, error) => {
+    if (error) return 10000; // Slower polling on error
+    if (data?.status === "pending") return 1000; // Fast polling for pending
+    return 5000; // Normal polling
+  },
+});
+```
+
+## Options
+
+### Per-Request Options
+
+| Option            | Type                                                  | Description                                                                               |
+| ----------------- | ----------------------------------------------------- | ----------------------------------------------------------------------------------------- |
+| `pollingInterval` | `number \| false \| (data, error) => number \| false` | Polling interval in milliseconds, `false` to disable, or a function for dynamic intervals |
+
+## Dynamic Polling
+
+The polling interval can be a function that receives the current data and error, allowing you to adjust the polling rate based on the response:
+
+```typescript
+useRead((api) => api.jobs(":id").$get({ id: jobId }), {
+  pollingInterval: (data) => {
+    // Stop polling when job is complete
+    if (data?.status === "completed") return false;
+
+    // Poll faster while job is running
+    if (data?.status === "running") return 1000;
+
+    // Default interval
+    return 5000;
+  },
+});
+```

package/dist/index.d.mts

@@ -0,0 +1,51 @@
+import { SpooshPlugin } from '@spoosh/core';
+
+type PollingIntervalValue = number | false;
+type PollingIntervalFn<TData = unknown, TError = unknown> = (data: TData | undefined, error: TError | undefined) => PollingIntervalValue;
+type PollingInterval<TData = unknown, TError = unknown> = PollingIntervalValue | PollingIntervalFn<TData, TError>;
+interface PollingReadOptions {
+    /** Polling interval in milliseconds, `false` to disable, or a function for dynamic intervals. */
+    pollingInterval?: PollingInterval;
+}
+type PollingWriteOptions = object;
+type PollingInfiniteReadOptions = object;
+type PollingReadResult = object;
+type PollingWriteResult = object;
+declare module "@spoosh/core" {
+    interface PluginResolvers<TContext> {
+        pollingInterval: PollingInterval<TContext["data"], TContext["error"]> | undefined;
+    }
+}
+
+/**
+ * Enables automatic polling for queries at configurable intervals.
+ *
+ * Automatically refetches data at specified intervals to keep it fresh.
+ * Supports dynamic intervals based on current data or error state.
+ *
+ * @see {@link https://spoosh.dev/docs/plugins/polling | Polling Plugin Documentation}
+ *
+ * @example
+ * ```ts
+ * const plugins = [pollingPlugin()];
+ *
+ * // Poll every 5 seconds
+ * useRead((api) => api.posts.$get(), {
+ *   pollingInterval: 5000,
+ * });
+ *
+ * // Dynamic interval based on data
+ * useRead((api) => api.posts.$get(), {
+ *   pollingInterval: (data, error) => error ? 10000 : 5000,
+ * });
+ * ```
+ */
+declare function pollingPlugin(): SpooshPlugin<{
+    readOptions: PollingReadOptions;
+    writeOptions: PollingWriteOptions;
+    infiniteReadOptions: PollingInfiniteReadOptions;
+    readResult: PollingReadResult;
+    writeResult: PollingWriteResult;
+}>;
+
+export { type PollingInfiniteReadOptions, type PollingInterval, type PollingIntervalFn, type PollingIntervalValue, type PollingReadOptions, type PollingReadResult, type PollingWriteOptions, type PollingWriteResult, pollingPlugin };

package/dist/index.d.ts

@@ -0,0 +1,51 @@
+import { SpooshPlugin } from '@spoosh/core';
+
+type PollingIntervalValue = number | false;
+type PollingIntervalFn<TData = unknown, TError = unknown> = (data: TData | undefined, error: TError | undefined) => PollingIntervalValue;
+type PollingInterval<TData = unknown, TError = unknown> = PollingIntervalValue | PollingIntervalFn<TData, TError>;
+interface PollingReadOptions {
+    /** Polling interval in milliseconds, `false` to disable, or a function for dynamic intervals. */
+    pollingInterval?: PollingInterval;
+}
+type PollingWriteOptions = object;
+type PollingInfiniteReadOptions = object;
+type PollingReadResult = object;
+type PollingWriteResult = object;
+declare module "@spoosh/core" {
+    interface PluginResolvers<TContext> {
+        pollingInterval: PollingInterval<TContext["data"], TContext["error"]> | undefined;
+    }
+}
+
+/**
+ * Enables automatic polling for queries at configurable intervals.
+ *
+ * Automatically refetches data at specified intervals to keep it fresh.
+ * Supports dynamic intervals based on current data or error state.
+ *
+ * @see {@link https://spoosh.dev/docs/plugins/polling | Polling Plugin Documentation}
+ *
+ * @example
+ * ```ts
+ * const plugins = [pollingPlugin()];
+ *
+ * // Poll every 5 seconds
+ * useRead((api) => api.posts.$get(), {
+ *   pollingInterval: 5000,
+ * });
+ *
+ * // Dynamic interval based on data
+ * useRead((api) => api.posts.$get(), {
+ *   pollingInterval: (data, error) => error ? 10000 : 5000,
+ * });
+ * ```
+ */
+declare function pollingPlugin(): SpooshPlugin<{
+    readOptions: PollingReadOptions;
+    writeOptions: PollingWriteOptions;
+    infiniteReadOptions: PollingInfiniteReadOptions;
+    readResult: PollingReadResult;
+    writeResult: PollingWriteResult;
+}>;
+
+export { type PollingInfiniteReadOptions, type PollingInterval, type PollingIntervalFn, type PollingIntervalValue, type PollingReadOptions, type PollingReadResult, type PollingWriteOptions, type PollingWriteResult, pollingPlugin };

package/dist/index.js

@@ -0,0 +1,85 @@
+"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, {
+  pollingPlugin: () => pollingPlugin
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/plugin.ts
+function pollingPlugin() {
+  const timeouts = /* @__PURE__ */ new Map();
+  const clearPolling = (queryKey) => {
+    const timeout = timeouts.get(queryKey);
+    if (timeout) {
+      clearTimeout(timeout);
+      timeouts.delete(queryKey);
+    }
+  };
+  const scheduleNextPoll = (context) => {
+    const { queryKey, eventEmitter } = context;
+    const pluginOptions = context.pluginOptions;
+    const pollingInterval = pluginOptions?.pollingInterval;
+    if (!pollingInterval) return;
+    const cached = context.stateManager.getCache(queryKey);
+    const data = cached?.state.data;
+    const error = cached?.state.error;
+    const resolvedInterval = typeof pollingInterval === "function" ? pollingInterval(data, error) : pollingInterval;
+    if (resolvedInterval === false || resolvedInterval <= 0) return;
+    clearPolling(queryKey);
+    const timeout = setTimeout(() => {
+      timeouts.delete(queryKey);
+      eventEmitter.emit("refetch", {
+        queryKey,
+        reason: "polling"
+      });
+    }, resolvedInterval);
+    timeouts.set(queryKey, timeout);
+  };
+  return {
+    name: "spoosh:polling",
+    operations: ["read", "infiniteRead"],
+    onResponse(context) {
+      scheduleNextPoll(context);
+    },
+    lifecycle: {
+      onUpdate(context, previousContext) {
+        if (previousContext.queryKey !== context.queryKey) {
+          clearPolling(previousContext.queryKey);
+        }
+        const { queryKey } = context;
+        const pluginOptions = context.pluginOptions;
+        const pollingInterval = pluginOptions?.pollingInterval;
+        if (!pollingInterval) {
+          clearPolling(queryKey);
+          return;
+        }
+        const currentTimeout = timeouts.get(queryKey);
+        if (!currentTimeout) {
+          scheduleNextPoll(context);
+        }
+      },
+      onUnmount(context) {
+        clearPolling(context.queryKey);
+      }
+    }
+  };
+}

package/dist/index.mjs

@@ -0,0 +1,62 @@
+// src/plugin.ts
+function pollingPlugin() {
+  const timeouts = /* @__PURE__ */ new Map();
+  const clearPolling = (queryKey) => {
+    const timeout = timeouts.get(queryKey);
+    if (timeout) {
+      clearTimeout(timeout);
+      timeouts.delete(queryKey);
+    }
+  };
+  const scheduleNextPoll = (context) => {
+    const { queryKey, eventEmitter } = context;
+    const pluginOptions = context.pluginOptions;
+    const pollingInterval = pluginOptions?.pollingInterval;
+    if (!pollingInterval) return;
+    const cached = context.stateManager.getCache(queryKey);
+    const data = cached?.state.data;
+    const error = cached?.state.error;
+    const resolvedInterval = typeof pollingInterval === "function" ? pollingInterval(data, error) : pollingInterval;
+    if (resolvedInterval === false || resolvedInterval <= 0) return;
+    clearPolling(queryKey);
+    const timeout = setTimeout(() => {
+      timeouts.delete(queryKey);
+      eventEmitter.emit("refetch", {
+        queryKey,
+        reason: "polling"
+      });
+    }, resolvedInterval);
+    timeouts.set(queryKey, timeout);
+  };
+  return {
+    name: "spoosh:polling",
+    operations: ["read", "infiniteRead"],
+    onResponse(context) {
+      scheduleNextPoll(context);
+    },
+    lifecycle: {
+      onUpdate(context, previousContext) {
+        if (previousContext.queryKey !== context.queryKey) {
+          clearPolling(previousContext.queryKey);
+        }
+        const { queryKey } = context;
+        const pluginOptions = context.pluginOptions;
+        const pollingInterval = pluginOptions?.pollingInterval;
+        if (!pollingInterval) {
+          clearPolling(queryKey);
+          return;
+        }
+        const currentTimeout = timeouts.get(queryKey);
+        if (!currentTimeout) {
+          scheduleNextPoll(context);
+        }
+      },
+      onUnmount(context) {
+        clearPolling(context.queryKey);
+      }
+    }
+  };
+}
+export {
+  pollingPlugin
+};

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@spoosh/plugin-polling",
+  "version": "0.1.0-beta.0",
+  "description": "Automatic polling/refetching plugin for Spoosh",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nxnom/spoosh.git",
+    "directory": "packages/plugin-polling"
+  },
+  "bugs": {
+    "url": "https://github.com/nxnom/spoosh/issues"
+  },
+  "homepage": "https://spoosh.dev/docs/plugins/polling",
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "spoosh",
+    "plugin",
+    "polling",
+    "interval",
+    "auto-refresh",
+    "api-client"
+  ],
+  "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'"
+  }
+}