@spoosh/plugin-refetch 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,48 @@
+# @spoosh/plugin-refetch
+
+Auto-refetch plugin for Spoosh - refetch on window focus and network reconnect.
+
+**[Documentation](https://spoosh.dev/docs/plugins/refetch)** · **Requirements:** TypeScript >= 5.0 · **Peer Dependencies:** `@spoosh/core`
+
+## Installation
+
+```bash
+npm install @spoosh/plugin-refetch
+```
+
+## Usage
+
+```typescript
+import { refetchPlugin } from "@spoosh/plugin-refetch";
+
+const plugins = [
+  refetchPlugin({
+    refetchOnFocus: true,
+    refetchOnReconnect: true,
+  }),
+];
+
+// Uses plugin defaults
+useRead((api) => api.posts.$get());
+
+// Per-query override
+useRead((api) => api.posts.$get(), {
+  refetchOnFocus: false, // Disable for this query
+});
+```
+
+## Options
+
+### Plugin Config
+
+| Option               | Type      | Default | Description                       |
+| -------------------- | --------- | ------- | --------------------------------- |
+| `refetchOnFocus`     | `boolean` | `false` | Refetch when window regains focus |
+| `refetchOnReconnect` | `boolean` | `false` | Refetch when network reconnects   |
+
+### Per-Request Options
+
+| Option               | Type      | Description                         |
+| -------------------- | --------- | ----------------------------------- |
+| `refetchOnFocus`     | `boolean` | Override focus refetch behavior     |
+| `refetchOnReconnect` | `boolean` | Override reconnect refetch behavior |

package/dist/index.d.mts

@@ -0,0 +1,49 @@
+import { SpooshPlugin } from '@spoosh/core';
+
+interface RefetchPluginConfig {
+    /** Automatically refetch when window regains focus. Defaults to `false`. */
+    refetchOnFocus?: boolean;
+    /** Automatically refetch when network reconnects. Defaults to `false`. */
+    refetchOnReconnect?: boolean;
+}
+interface RefetchReadOptions {
+    /** Automatically refetch when window regains focus. Overrides plugin default. */
+    refetchOnFocus?: boolean;
+    /** Automatically refetch when network reconnects. Overrides plugin default. */
+    refetchOnReconnect?: boolean;
+}
+type RefetchWriteOptions = object;
+type RefetchInfiniteReadOptions = object;
+type RefetchReadResult = object;
+type RefetchWriteResult = object;
+
+/**
+ * Enables automatic refetching on window focus and network reconnect.
+ *
+ * @param config - Plugin configuration
+ *
+ * @see {@link https://spoosh.dev/docs/plugins/refetch | Refetch Plugin Documentation}
+ *
+ * @returns Refetch plugin instance
+ *
+ * @example
+ * ```ts
+ * const plugins = [
+ *   refetchPlugin({ refetchOnFocus: true, refetchOnReconnect: true }),
+ * ];
+ *
+ * // Per-query override
+ * useRead((api) => api.posts.$get(), {
+ *   refetchOnFocus: false, // Disable for this query
+ * });
+ * ```
+ */
+declare function refetchPlugin(config?: RefetchPluginConfig): SpooshPlugin<{
+    readOptions: RefetchReadOptions;
+    writeOptions: RefetchWriteOptions;
+    infiniteReadOptions: RefetchInfiniteReadOptions;
+    readResult: RefetchReadResult;
+    writeResult: RefetchWriteResult;
+}>;
+
+export { type RefetchInfiniteReadOptions, type RefetchPluginConfig, type RefetchReadOptions, type RefetchReadResult, type RefetchWriteOptions, type RefetchWriteResult, refetchPlugin };

package/dist/index.d.ts

@@ -0,0 +1,49 @@
+import { SpooshPlugin } from '@spoosh/core';
+
+interface RefetchPluginConfig {
+    /** Automatically refetch when window regains focus. Defaults to `false`. */
+    refetchOnFocus?: boolean;
+    /** Automatically refetch when network reconnects. Defaults to `false`. */
+    refetchOnReconnect?: boolean;
+}
+interface RefetchReadOptions {
+    /** Automatically refetch when window regains focus. Overrides plugin default. */
+    refetchOnFocus?: boolean;
+    /** Automatically refetch when network reconnects. Overrides plugin default. */
+    refetchOnReconnect?: boolean;
+}
+type RefetchWriteOptions = object;
+type RefetchInfiniteReadOptions = object;
+type RefetchReadResult = object;
+type RefetchWriteResult = object;
+
+/**
+ * Enables automatic refetching on window focus and network reconnect.
+ *
+ * @param config - Plugin configuration
+ *
+ * @see {@link https://spoosh.dev/docs/plugins/refetch | Refetch Plugin Documentation}
+ *
+ * @returns Refetch plugin instance
+ *
+ * @example
+ * ```ts
+ * const plugins = [
+ *   refetchPlugin({ refetchOnFocus: true, refetchOnReconnect: true }),
+ * ];
+ *
+ * // Per-query override
+ * useRead((api) => api.posts.$get(), {
+ *   refetchOnFocus: false, // Disable for this query
+ * });
+ * ```
+ */
+declare function refetchPlugin(config?: RefetchPluginConfig): SpooshPlugin<{
+    readOptions: RefetchReadOptions;
+    writeOptions: RefetchWriteOptions;
+    infiniteReadOptions: RefetchInfiniteReadOptions;
+    readResult: RefetchReadResult;
+    writeResult: RefetchWriteResult;
+}>;
+
+export { type RefetchInfiniteReadOptions, type RefetchPluginConfig, type RefetchReadOptions, type RefetchReadResult, type RefetchWriteOptions, type RefetchWriteResult, refetchPlugin };

package/dist/index.js

@@ -0,0 +1,148 @@
+"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, {
+  refetchPlugin: () => refetchPlugin
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/plugin.ts
+function refetchPlugin(config = {}) {
+  const { refetchOnFocus = false, refetchOnReconnect = false } = config;
+  const listenersByHook = /* @__PURE__ */ new Map();
+  const isBrowser = typeof window !== "undefined";
+  const setupFocusListener = (hookId, queryKey, eventEmitter) => {
+    if (!isBrowser) return;
+    const visibilityHandler = () => {
+      if (document.visibilityState === "visible") {
+        eventEmitter.emit("refetch", {
+          queryKey,
+          reason: "focus"
+        });
+      }
+    };
+    const focusHandler = () => {
+      eventEmitter.emit("refetch", {
+        queryKey,
+        reason: "focus"
+      });
+    };
+    document.addEventListener("visibilitychange", visibilityHandler);
+    window.addEventListener("focus", focusHandler);
+    const entry = listenersByHook.get(hookId) ?? { queryKey };
+    entry.queryKey = queryKey;
+    entry.focusCleanup = () => {
+      document.removeEventListener("visibilitychange", visibilityHandler);
+      window.removeEventListener("focus", focusHandler);
+    };
+    listenersByHook.set(hookId, entry);
+  };
+  const setupReconnectListener = (hookId, queryKey, eventEmitter) => {
+    if (!isBrowser) return;
+    const handler = () => {
+      eventEmitter.emit("refetch", {
+        queryKey,
+        reason: "reconnect"
+      });
+    };
+    window.addEventListener("online", handler);
+    const entry = listenersByHook.get(hookId) ?? { queryKey };
+    entry.queryKey = queryKey;
+    entry.reconnectCleanup = () => {
+      window.removeEventListener("online", handler);
+    };
+    listenersByHook.set(hookId, entry);
+  };
+  const cleanupHook = (hookId) => {
+    const entry = listenersByHook.get(hookId);
+    if (entry) {
+      entry.focusCleanup?.();
+      entry.reconnectCleanup?.();
+      listenersByHook.delete(hookId);
+    }
+  };
+  const hasFocusListener = (hookId) => {
+    return listenersByHook.get(hookId)?.focusCleanup !== void 0;
+  };
+  const hasReconnectListener = (hookId) => {
+    return listenersByHook.get(hookId)?.reconnectCleanup !== void 0;
+  };
+  const removeFocusListener = (hookId) => {
+    const entry = listenersByHook.get(hookId);
+    if (entry?.focusCleanup) {
+      entry.focusCleanup();
+      entry.focusCleanup = void 0;
+    }
+  };
+  const removeReconnectListener = (hookId) => {
+    const entry = listenersByHook.get(hookId);
+    if (entry?.reconnectCleanup) {
+      entry.reconnectCleanup();
+      entry.reconnectCleanup = void 0;
+    }
+  };
+  return {
+    name: "spoosh:refetch",
+    operations: ["read", "infiniteRead"],
+    lifecycle: {
+      onMount(context) {
+        const { queryKey, eventEmitter, hookId } = context;
+        if (!hookId) return;
+        const pluginOptions = context.pluginOptions;
+        const shouldRefetchOnFocus = pluginOptions?.refetchOnFocus ?? refetchOnFocus;
+        const shouldRefetchOnReconnect = pluginOptions?.refetchOnReconnect ?? refetchOnReconnect;
+        if (shouldRefetchOnFocus) {
+          setupFocusListener(hookId, queryKey, eventEmitter);
+        }
+        if (shouldRefetchOnReconnect) {
+          setupReconnectListener(hookId, queryKey, eventEmitter);
+        }
+      },
+      onUpdate(context) {
+        const { queryKey, eventEmitter, hookId } = context;
+        if (!hookId) return;
+        const pluginOptions = context.pluginOptions;
+        const shouldRefetchOnFocus = pluginOptions?.refetchOnFocus ?? refetchOnFocus;
+        const shouldRefetchOnReconnect = pluginOptions?.refetchOnReconnect ?? refetchOnReconnect;
+        const entry = listenersByHook.get(hookId);
+        const queryKeyChanged = entry && entry.queryKey !== queryKey;
+        if (queryKeyChanged) {
+          cleanupHook(hookId);
+        }
+        if (shouldRefetchOnFocus && !hasFocusListener(hookId)) {
+          setupFocusListener(hookId, queryKey, eventEmitter);
+        } else if (!shouldRefetchOnFocus && hasFocusListener(hookId)) {
+          removeFocusListener(hookId);
+        }
+        if (shouldRefetchOnReconnect && !hasReconnectListener(hookId)) {
+          setupReconnectListener(hookId, queryKey, eventEmitter);
+        } else if (!shouldRefetchOnReconnect && hasReconnectListener(hookId)) {
+          removeReconnectListener(hookId);
+        }
+      },
+      onUnmount(context) {
+        if (context.hookId) {
+          cleanupHook(context.hookId);
+        }
+      }
+    }
+  };
+}

package/dist/index.mjs

@@ -0,0 +1,125 @@
+// src/plugin.ts
+function refetchPlugin(config = {}) {
+  const { refetchOnFocus = false, refetchOnReconnect = false } = config;
+  const listenersByHook = /* @__PURE__ */ new Map();
+  const isBrowser = typeof window !== "undefined";
+  const setupFocusListener = (hookId, queryKey, eventEmitter) => {
+    if (!isBrowser) return;
+    const visibilityHandler = () => {
+      if (document.visibilityState === "visible") {
+        eventEmitter.emit("refetch", {
+          queryKey,
+          reason: "focus"
+        });
+      }
+    };
+    const focusHandler = () => {
+      eventEmitter.emit("refetch", {
+        queryKey,
+        reason: "focus"
+      });
+    };
+    document.addEventListener("visibilitychange", visibilityHandler);
+    window.addEventListener("focus", focusHandler);
+    const entry = listenersByHook.get(hookId) ?? { queryKey };
+    entry.queryKey = queryKey;
+    entry.focusCleanup = () => {
+      document.removeEventListener("visibilitychange", visibilityHandler);
+      window.removeEventListener("focus", focusHandler);
+    };
+    listenersByHook.set(hookId, entry);
+  };
+  const setupReconnectListener = (hookId, queryKey, eventEmitter) => {
+    if (!isBrowser) return;
+    const handler = () => {
+      eventEmitter.emit("refetch", {
+        queryKey,
+        reason: "reconnect"
+      });
+    };
+    window.addEventListener("online", handler);
+    const entry = listenersByHook.get(hookId) ?? { queryKey };
+    entry.queryKey = queryKey;
+    entry.reconnectCleanup = () => {
+      window.removeEventListener("online", handler);
+    };
+    listenersByHook.set(hookId, entry);
+  };
+  const cleanupHook = (hookId) => {
+    const entry = listenersByHook.get(hookId);
+    if (entry) {
+      entry.focusCleanup?.();
+      entry.reconnectCleanup?.();
+      listenersByHook.delete(hookId);
+    }
+  };
+  const hasFocusListener = (hookId) => {
+    return listenersByHook.get(hookId)?.focusCleanup !== void 0;
+  };
+  const hasReconnectListener = (hookId) => {
+    return listenersByHook.get(hookId)?.reconnectCleanup !== void 0;
+  };
+  const removeFocusListener = (hookId) => {
+    const entry = listenersByHook.get(hookId);
+    if (entry?.focusCleanup) {
+      entry.focusCleanup();
+      entry.focusCleanup = void 0;
+    }
+  };
+  const removeReconnectListener = (hookId) => {
+    const entry = listenersByHook.get(hookId);
+    if (entry?.reconnectCleanup) {
+      entry.reconnectCleanup();
+      entry.reconnectCleanup = void 0;
+    }
+  };
+  return {
+    name: "spoosh:refetch",
+    operations: ["read", "infiniteRead"],
+    lifecycle: {
+      onMount(context) {
+        const { queryKey, eventEmitter, hookId } = context;
+        if (!hookId) return;
+        const pluginOptions = context.pluginOptions;
+        const shouldRefetchOnFocus = pluginOptions?.refetchOnFocus ?? refetchOnFocus;
+        const shouldRefetchOnReconnect = pluginOptions?.refetchOnReconnect ?? refetchOnReconnect;
+        if (shouldRefetchOnFocus) {
+          setupFocusListener(hookId, queryKey, eventEmitter);
+        }
+        if (shouldRefetchOnReconnect) {
+          setupReconnectListener(hookId, queryKey, eventEmitter);
+        }
+      },
+      onUpdate(context) {
+        const { queryKey, eventEmitter, hookId } = context;
+        if (!hookId) return;
+        const pluginOptions = context.pluginOptions;
+        const shouldRefetchOnFocus = pluginOptions?.refetchOnFocus ?? refetchOnFocus;
+        const shouldRefetchOnReconnect = pluginOptions?.refetchOnReconnect ?? refetchOnReconnect;
+        const entry = listenersByHook.get(hookId);
+        const queryKeyChanged = entry && entry.queryKey !== queryKey;
+        if (queryKeyChanged) {
+          cleanupHook(hookId);
+        }
+        if (shouldRefetchOnFocus && !hasFocusListener(hookId)) {
+          setupFocusListener(hookId, queryKey, eventEmitter);
+        } else if (!shouldRefetchOnFocus && hasFocusListener(hookId)) {
+          removeFocusListener(hookId);
+        }
+        if (shouldRefetchOnReconnect && !hasReconnectListener(hookId)) {
+          setupReconnectListener(hookId, queryKey, eventEmitter);
+        } else if (!shouldRefetchOnReconnect && hasReconnectListener(hookId)) {
+          removeReconnectListener(hookId);
+        }
+      },
+      onUnmount(context) {
+        if (context.hookId) {
+          cleanupHook(context.hookId);
+        }
+      }
+    }
+  };
+}
+export {
+  refetchPlugin
+};

package/package.json

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