@spoosh/plugin-cache 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,38 @@
+# @spoosh/plugin-cache
+
+Response caching plugin for Spoosh with configurable stale time.
+
+**[Documentation](https://spoosh.dev/docs/plugins/cache)** · **Requirements:** TypeScript >= 5.0 · **Peer Dependencies:** `@spoosh/core`
+
+## Installation
+
+```bash
+npm install @spoosh/plugin-cache
+```
+
+## Usage
+
+```typescript
+import { cachePlugin } from "@spoosh/plugin-cache";
+
+const plugins = [
+  cachePlugin({ staleTime: 5000 }), // 5 second stale time
+];
+
+// Per-query override
+useRead((api) => api.posts.$get(), { staleTime: 10000 });
+```
+
+## Options
+
+### Plugin Config
+
+| Option      | Type     | Default | Description                        |
+| ----------- | -------- | ------- | ---------------------------------- |
+| `staleTime` | `number` | `0`     | Default stale time in milliseconds |
+
+### Per-Request Options
+
+| Option      | Type     | Description                          |
+| ----------- | -------- | ------------------------------------ |
+| `staleTime` | `number` | Override stale time for this request |

package/dist/index.d.mts

@@ -0,0 +1,47 @@
+import { SpooshPlugin } from '@spoosh/core';
+
+interface CachePluginConfig {
+    /** Default stale time in milliseconds. Data older than this is considered stale. Defaults to 0. */
+    staleTime?: number;
+}
+interface CacheReadOptions {
+    /** Time in milliseconds before cached data is considered stale. Overrides plugin default. */
+    staleTime?: number;
+}
+type CacheWriteOptions = object;
+interface CacheInfiniteReadOptions {
+    /** Time in milliseconds before cached data is considered stale. Overrides plugin default. */
+    staleTime?: number;
+}
+type CacheReadResult = object;
+type CacheWriteResult = object;
+
+/**
+ * Enables caching for read operations with configurable stale time.
+ *
+ * Returns cached data immediately if available and not stale,
+ * avoiding unnecessary network requests.
+ *
+ * @param config - Plugin configuration
+ *
+ * @see {@link https://spoosh.dev/docs/plugins/cache | Cache Plugin Documentation}
+ *
+ * @example
+ * ```ts
+ * const plugins = [cachePlugin({ staleTime: 5000 })];
+ *
+ * // Per-query override
+ * useRead((api) => api.posts.$get(), {
+ *   staleTime: 10000, // Override default stale time
+ * });
+ * ```
+ */
+declare function cachePlugin(config?: CachePluginConfig): SpooshPlugin<{
+    readOptions: CacheReadOptions;
+    writeOptions: CacheWriteOptions;
+    infiniteReadOptions: CacheInfiniteReadOptions;
+    readResult: CacheReadResult;
+    writeResult: CacheWriteResult;
+}>;
+
+export { type CacheInfiniteReadOptions, type CachePluginConfig, type CacheReadOptions, type CacheReadResult, type CacheWriteOptions, type CacheWriteResult, cachePlugin };

package/dist/index.d.ts

@@ -0,0 +1,47 @@
+import { SpooshPlugin } from '@spoosh/core';
+
+interface CachePluginConfig {
+    /** Default stale time in milliseconds. Data older than this is considered stale. Defaults to 0. */
+    staleTime?: number;
+}
+interface CacheReadOptions {
+    /** Time in milliseconds before cached data is considered stale. Overrides plugin default. */
+    staleTime?: number;
+}
+type CacheWriteOptions = object;
+interface CacheInfiniteReadOptions {
+    /** Time in milliseconds before cached data is considered stale. Overrides plugin default. */
+    staleTime?: number;
+}
+type CacheReadResult = object;
+type CacheWriteResult = object;
+
+/**
+ * Enables caching for read operations with configurable stale time.
+ *
+ * Returns cached data immediately if available and not stale,
+ * avoiding unnecessary network requests.
+ *
+ * @param config - Plugin configuration
+ *
+ * @see {@link https://spoosh.dev/docs/plugins/cache | Cache Plugin Documentation}
+ *
+ * @example
+ * ```ts
+ * const plugins = [cachePlugin({ staleTime: 5000 })];
+ *
+ * // Per-query override
+ * useRead((api) => api.posts.$get(), {
+ *   staleTime: 10000, // Override default stale time
+ * });
+ * ```
+ */
+declare function cachePlugin(config?: CachePluginConfig): SpooshPlugin<{
+    readOptions: CacheReadOptions;
+    writeOptions: CacheWriteOptions;
+    infiniteReadOptions: CacheInfiniteReadOptions;
+    readResult: CacheReadResult;
+    writeResult: CacheWriteResult;
+}>;
+
+export { type CacheInfiniteReadOptions, type CachePluginConfig, type CacheReadOptions, type CacheReadResult, type CacheWriteOptions, type CacheWriteResult, cachePlugin };

package/dist/index.js

@@ -0,0 +1,60 @@
+"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, {
+  cachePlugin: () => cachePlugin
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/plugin.ts
+function cachePlugin(config = {}) {
+  const { staleTime: defaultStaleTime = 0 } = config;
+  return {
+    name: "spoosh:cache",
+    operations: ["read", "infiniteRead"],
+    middleware: async (context, next) => {
+      if (!context.forceRefetch) {
+        const cached = context.stateManager.getCache(context.queryKey);
+        if (cached?.state.data && !cached.stale) {
+          const pluginOptions = context.pluginOptions;
+          const staleTime = pluginOptions?.staleTime ?? defaultStaleTime;
+          const isTimeStale = Date.now() - cached.state.timestamp > staleTime;
+          if (!isTimeStale) {
+            return { data: cached.state.data, status: 200 };
+          }
+        }
+      }
+      const response = await next();
+      if (response.data !== void 0 && !response.error) {
+        context.stateManager.setCache(context.queryKey, {
+          state: {
+            data: response.data,
+            error: void 0,
+            timestamp: Date.now()
+          },
+          tags: context.tags,
+          stale: false
+        });
+      }
+      return response;
+    }
+  };
+}

package/dist/index.mjs

@@ -0,0 +1,37 @@
+// src/plugin.ts
+function cachePlugin(config = {}) {
+  const { staleTime: defaultStaleTime = 0 } = config;
+  return {
+    name: "spoosh:cache",
+    operations: ["read", "infiniteRead"],
+    middleware: async (context, next) => {
+      if (!context.forceRefetch) {
+        const cached = context.stateManager.getCache(context.queryKey);
+        if (cached?.state.data && !cached.stale) {
+          const pluginOptions = context.pluginOptions;
+          const staleTime = pluginOptions?.staleTime ?? defaultStaleTime;
+          const isTimeStale = Date.now() - cached.state.timestamp > staleTime;
+          if (!isTimeStale) {
+            return { data: cached.state.data, status: 200 };
+          }
+        }
+      }
+      const response = await next();
+      if (response.data !== void 0 && !response.error) {
+        context.stateManager.setCache(context.queryKey, {
+          state: {
+            data: response.data,
+            error: void 0,
+            timestamp: Date.now()
+          },
+          tags: context.tags,
+          stale: false
+        });
+      }
+      return response;
+    }
+  };
+}
+export {
+  cachePlugin
+};

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@spoosh/plugin-cache",
+  "version": "0.1.0-beta.0",
+  "description": "Response caching plugin for Spoosh with configurable stale time",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nxnom/spoosh.git",
+    "directory": "packages/plugin-cache"
+  },
+  "bugs": {
+    "url": "https://github.com/nxnom/spoosh/issues"
+  },
+  "homepage": "https://spoosh.dev/docs/plugins/cache",
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "spoosh",
+    "plugin",
+    "cache",
+    "api-client",
+    "stale-time"
+  ],
+  "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'"
+  }
+}