@spoosh/plugin-cache 0.3.4 → 0.3.5

package/README.md

@@ -16,7 +16,7 @@ npm install @spoosh/plugin-cache
 import { Spoosh } from "@spoosh/core";
 import { cachePlugin } from "@spoosh/plugin-cache";
 
-const client = new Spoosh<ApiSchema, Error>("/api").use([
+const spoosh = new Spoosh<ApiSchema, Error>("/api").use([
   cachePlugin({ staleTime: 5000 }),
 ]);
 
@@ -24,6 +24,10 @@ const client = new Spoosh<ApiSchema, Error>("/api").use([
 useRead((api) => api("posts").GET(), { staleTime: 10000 });
 ```
 
+## How It Works
+
+The cache plugin runs with **priority -10**, meaning it executes early in the middleware chain to check the cache before other plugins (like retry, debug) run. This ensures maximum efficiency by short-circuiting requests when cached data is available.
+
 ## Options
 
 ### Plugin Config
@@ -61,9 +65,9 @@ await trigger({ clearCache: true, invalidate: "*" });
 The plugin exposes a `clearCache` function for manually clearing all cached data:
 
 ```typescript
-import { createReactSpoosh } from "@spoosh/react";
+import { create } from "@spoosh/react";
 
-const { useRead, clearCache } = createReactSpoosh(client);
+const { useRead, clearCache } = create(spoosh);
 
 // Clear all cached data only (no refetch)
 function handleLogout() {

package/dist/index.d.mts

@@ -33,6 +33,9 @@ type CacheWriteResult = object;
  * Returns cached data immediately if available and not stale,
  * avoiding unnecessary network requests.
  *
+ * This plugin runs with priority -10, meaning it executes early in the middleware chain
+ * to check the cache before other plugins (like retry, debug) run.
+ *
  * @param config - Plugin configuration
  *
  * @see {@link https://spoosh.dev/docs/react/plugins/cache | Cache Plugin Documentation}
@@ -41,10 +44,10 @@ type CacheWriteResult = object;
  * ```ts
  * import { Spoosh } from "@spoosh/core";
  *
- * const client = new Spoosh<ApiSchema, Error>("/api")
+ * const spoosh = new Spoosh<ApiSchema, Error>("/api")
  *   .use([
- *     // ... other plugins
  *     cachePlugin({ staleTime: 5000 }),
+ *     // ... other plugins
  *   ]);
  *
  * // Per-query override

package/dist/index.d.ts

@@ -33,6 +33,9 @@ type CacheWriteResult = object;
  * Returns cached data immediately if available and not stale,
  * avoiding unnecessary network requests.
  *
+ * This plugin runs with priority -10, meaning it executes early in the middleware chain
+ * to check the cache before other plugins (like retry, debug) run.
+ *
  * @param config - Plugin configuration
  *
  * @see {@link https://spoosh.dev/docs/react/plugins/cache | Cache Plugin Documentation}
@@ -41,10 +44,10 @@ type CacheWriteResult = object;
  * ```ts
  * import { Spoosh } from "@spoosh/core";
  *
- * const client = new Spoosh<ApiSchema, Error>("/api")
+ * const spoosh = new Spoosh<ApiSchema, Error>("/api")
  *   .use([
- *     // ... other plugins
  *     cachePlugin({ staleTime: 5000 }),
+ *     // ... other plugins
  *   ]);
  *
  * // Per-query override

package/dist/index.js

@@ -30,6 +30,7 @@ function cachePlugin(config = {}) {
   return {
     name: "spoosh:cache",
     operations: ["read", "infiniteRead", "write"],
+    priority: -10,
     middleware: async (context, next) => {
       if (!context.forceRefetch) {
         const cached = context.stateManager.getCache(context.queryKey);

package/dist/index.mjs

@@ -4,6 +4,7 @@ function cachePlugin(config = {}) {
   return {
     name: "spoosh:cache",
     operations: ["read", "infiniteRead", "write"],
+    priority: -10,
     middleware: async (context, next) => {
       if (!context.forceRefetch) {
         const cached = context.stateManager.getCache(context.queryKey);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spoosh/plugin-cache",
-  "version": "0.3.4",
+  "version": "0.3.5",
   "description": "Response caching plugin for Spoosh with configurable stale time",
   "license": "MIT",
   "repository": {
@@ -33,11 +33,11 @@
     }
   },
   "peerDependencies": {
-    "@spoosh/core": ">=0.12.0"
+    "@spoosh/core": ">=0.12.1"
   },
   "devDependencies": {
-    "@spoosh/core": "0.12.0",
-    "@spoosh/test-utils": "0.1.8"
+    "@spoosh/test-utils": "0.1.8",
+    "@spoosh/core": "0.12.1"
   },
   "scripts": {
     "dev": "tsup --watch",