polystore 0.22.0 → 0.23.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "polystore",
-  "version": "0.22.0",
+  "version": "0.23.0",
   "description": "A small compatibility layer for many popular KV stores like localStorage, Redis, FileSystem, etc.",
   "homepage": "https://polystore.dev",
   "repository": "github:franciscop/polystore",
@@ -17,7 +17,7 @@
   ],
   "scripts": {
     "size": "echo $(gzip -c index.js | wc -c) bytes",
-    "build": "bunx tsup src/index.ts --format esm --dts --out-dir . --target node24 && bunx tsup src/plugins/express/index.ts --format esm --dts --out-dir src/plugins/express --target node24 --external polystore --external express-session && bunx tsup src/plugins/hono-sessions/index.ts --format esm --dts --out-dir src/plugins/hono-sessions --target node24 --external polystore --external hono-sessions && bunx tsup src/plugins/better-auth/index.ts --format esm --dts --out-dir src/plugins/better-auth --target node24 --external polystore",
+    "build": "bunx tsup src/index.ts --format esm --dts --out-dir . --target node24 && bunx tsup src/plugins/express/index.ts --format esm --dts --out-dir src/plugins/express --target node24 --external polystore --external express-session && bunx tsup src/plugins/hono-sessions/index.ts --format esm --dts --out-dir src/plugins/hono-sessions --target node24 --external polystore --external hono-sessions && bunx tsup src/plugins/better-auth/index.ts --format esm --dts --out-dir src/plugins/better-auth --target node24 --external polystore && bunx tsup src/plugins/axios-cache-interceptor/index.ts --format esm --dts --out-dir src/plugins/axios-cache-interceptor --target node24 --external polystore --external axios-cache-interceptor",
     "lint": "tsc",
     "start": "bun test --watch",
     "service:db": "etcd",
@@ -43,7 +43,9 @@
     "src/plugins/hono-sessions/index.js",
     "src/plugins/hono-sessions/index.d.ts",
     "src/plugins/better-auth/index.js",
-    "src/plugins/better-auth/index.d.ts"
+    "src/plugins/better-auth/index.d.ts",
+    "src/plugins/axios-cache-interceptor/index.js",
+    "src/plugins/axios-cache-interceptor/index.d.ts"
   ],
   "exports": {
     ".": {
@@ -61,6 +63,10 @@
     "./better-auth": {
       "types": "./src/plugins/better-auth/index.d.ts",
       "import": "./src/plugins/better-auth/index.js"
+    },
+    "./axios-cache-interceptor": {
+      "types": "./src/plugins/axios-cache-interceptor/index.d.ts",
+      "import": "./src/plugins/axios-cache-interceptor/index.js"
     }
   },
   "documentation.page": {
@@ -74,6 +80,7 @@
       "Github": "https://github.com/franciscop/polystore"
     }
   },
+  "dependencies": {},
   "devDependencies": {
     "@deno/kv": "^0.8.1",
     "@types/better-sqlite3": "^7.6.13",
@@ -84,6 +91,8 @@
     "@types/jsdom": "^27.0.0",
     "@types/pg": "^8.11.10",
     "@types/supertest": "^7.2.0",
+    "axios": "^1.9.0",
+    "axios-cache-interceptor": "^1.12.0",
     "better-sqlite3": "^12.6.0",
     "concurrently": "^9.2.1",
     "dotenv": "^16.3.1",

package/readme.md

@@ -639,7 +639,7 @@ Quick overview:
 | [Local Forage](#local-forage) | Browser | ✅ | ❓ | Better capacity than localStorage |
 | [Redis](#redis) | Node.js | ✅ | ✅ | Good distributed cache backend |
 | [SQLite](#sqlite) | Node.js | ✅ | ❌ | Simple local persistence |
-| [Fetch API](#fetch-api) | Any with `fetch` | ❓ | ❓ | Bring your own KV HTTP API |
+| [Fetch API](#fetch-api) | Node.js + Browser | ❓ | ❓ | Bring your own API |
 | [File](#file) | Node.js | ✅ | ❌ | Single JSON file store |
 | [Folder](#folder) | Node.js | ✅ | ❌ | One-file-per-key store |
 | [Cloudflare KV](#cloudflare-kv) | Cloudflare | ✅ | ✅ | Edge-native KV |
@@ -1350,6 +1350,47 @@ Use `.prefix()` to namespace keys in a shared store:
 secondaryStorage: betterAuthStorage(createClient().connect()).prefix("auth:")
 ```
 
+### Axios Cache Interceptor
+
+> [Full example →](https://github.com/franciscop/polystore/tree/master/examples/axios-cache-interceptor)
+
+Use any Polystore-compatible store as the cache storage for [axios-cache-interceptor](https://axios-cache-interceptor.js.org/):
+
+```js
+import axios from "axios";
+import { setupCache } from "axios-cache-interceptor";
+import axiosCacheStorage from "polystore/axios-cache-interceptor";
+
+const http = setupCache(axios, {
+  storage: axiosCacheStorage(),  // in-memory by default
+});
+
+// First request hits the network, second is served from cache
+const { data } = await http.get("https://api.example.com/users");
+await http.get("https://api.example.com/users"); // cached
+```
+
+For production, swap in any Polystore adapter:
+
+```js
+import { createClient } from "redis";
+import axiosCacheStorage from "polystore/axios-cache-interceptor";
+
+const http = setupCache(axios, {
+  storage: axiosCacheStorage(createClient().connect()),
+});
+```
+
+Use `.prefix()` to namespace cache keys in a shared store:
+
+```js
+const http = setupCache(axios, {
+  storage: axiosCacheStorage(createClient().connect()).prefix("api-cache:"),
+});
+```
+
+Cache TTL is derived automatically from each response's cache headers (via `Cache-Control: max-age`, `Expires`, etc.) so you don't need to configure it separately. The cache entry is stored with a matching expiration so backends like Redis will evict it automatically.
+
 ### fch
 
 [Fch](https://www.npmjs.com/package/fch) is a lightweight fetch wrapper that uses Polystore natively for caching. Pass any Polystore store as the `cache` option and GET responses are cached automatically:

package/src/plugins/axios-cache-interceptor/index.d.ts

@@ -0,0 +1,17 @@
+import { Store } from 'polystore';
+import { AxiosStorage, CacheRequestConfig, StorageValue, NotEmptyStorageValue } from 'axios-cache-interceptor';
+
+declare class PolystoreAxiosCacheStorage implements AxiosStorage {
+    "is-storage": number;
+    private store;
+    private _storage;
+    constructor(store: Store);
+    prefix(prefix?: string): PolystoreAxiosCacheStorage;
+    get(key: string, currentRequest?: CacheRequestConfig): Promise<StorageValue>;
+    set(key: string, value: NotEmptyStorageValue, currentRequest?: CacheRequestConfig): Promise<void>;
+    remove(key: string, currentRequest?: CacheRequestConfig): Promise<void>;
+    clear(): Promise<void>;
+}
+declare function axiosCacheStorage(store?: any): PolystoreAxiosCacheStorage;
+
+export { PolystoreAxiosCacheStorage, axiosCacheStorage as default };

package/src/plugins/axios-cache-interceptor/index.js

@@ -0,0 +1,49 @@
+// src/plugins/axios-cache-interceptor/index.ts
+import { buildStorage } from "axios-cache-interceptor";
+import kv from "polystore";
+var MAX_STALE_AGE = 36e5;
+var ttlFromValue = (value) => {
+  if (value.ttl === void 0 || value.createdAt === void 0) return void 0;
+  const staleTtl = value.state === "cached" ? value.staleTtl ?? 0 : 0;
+  const removableAt = value.createdAt + value.ttl + Math.max(staleTtl, MAX_STALE_AGE);
+  const secs = Math.ceil((removableAt - Date.now()) / 1e3);
+  return secs > 0 ? { expires: secs } : void 0;
+};
+var PolystoreAxiosCacheStorage = class _PolystoreAxiosCacheStorage {
+  // Marks this object as a valid storage so `setupCache()` accepts it (it calls
+  // the internal `isStorage()`, which checks for this exact property).
+  "is-storage" = 1;
+  store;
+  _storage;
+  constructor(store) {
+    this.store = store;
+    this._storage = buildStorage({
+      find: (key) => this.store.get(key).then((v) => v ?? void 0),
+      set: (key, value) => this.store.set(key, value, ttlFromValue(value)),
+      remove: (key) => this.store.del(key),
+      clear: () => this.store.clear()
+    });
+  }
+  prefix(prefix = "") {
+    return new _PolystoreAxiosCacheStorage(this.store.prefix(prefix));
+  }
+  get(key, currentRequest) {
+    return this._storage.get(key, currentRequest);
+  }
+  set(key, value, currentRequest) {
+    return this._storage.set(key, value, currentRequest);
+  }
+  remove(key, currentRequest) {
+    return this._storage.remove(key, currentRequest);
+  }
+  clear() {
+    return Promise.resolve(this._storage.clear?.());
+  }
+};
+function axiosCacheStorage(store = /* @__PURE__ */ new Map()) {
+  return new PolystoreAxiosCacheStorage(kv(store));
+}
+export {
+  PolystoreAxiosCacheStorage,
+  axiosCacheStorage as default
+};