react-browser-cache 1.0.0

package/dist/storages/local-storage.js

@@ -0,0 +1,36 @@
+import { serialize, deserialize } from '../core/serializer';
+export class LocalStorageAdapter {
+    prefix;
+    constructor(prefix = 'rbc_') {
+        this.prefix = prefix;
+    }
+    getKey(key) {
+        return `${this.prefix}${key}`;
+    }
+    async get(key) {
+        const value = localStorage.getItem(this.getKey(key));
+        if (!value)
+            return null;
+        try {
+            return deserialize(value);
+        }
+        catch {
+            return null;
+        }
+    }
+    async set(key, value) {
+        localStorage.setItem(this.getKey(key), serialize(value));
+    }
+    async remove(key) {
+        localStorage.removeItem(this.getKey(key));
+    }
+    async clear() {
+        const keys = Object.keys(localStorage);
+        for (const key of keys) {
+            if (key.startsWith(this.prefix)) {
+                localStorage.removeItem(key);
+            }
+        }
+    }
+}
+//# sourceMappingURL=local-storage.js.map

package/dist/storages/local-storage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"local-storage.js","sourceRoot":"","sources":["../../src/storages/local-storage.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAE5D,MAAM,OAAO,mBAAmB;IACtB,MAAM,CAAS;IAEvB,YAAY,SAAiB,MAAM;QACjC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAEO,MAAM,CAAC,GAAW;QACxB,OAAO,GAAG,IAAI,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;IAChC,CAAC;IAED,KAAK,CAAC,GAAG,CAAI,GAAW;QACtB,MAAM,KAAK,GAAG,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;QACrD,IAAI,CAAC,KAAK;YAAE,OAAO,IAAI,CAAC;QACxB,IAAI,CAAC;YACH,OAAO,WAAW,CAAC,KAAK,CAAC,CAAC;QAC5B,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,KAAK,CAAC,GAAG,CAAI,GAAW,EAAE,KAAoB;QAC5C,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,GAAW;QACtB,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5C,CAAC;IAED,KAAK,CAAC,KAAK;QACT,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACvC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;gBAChC,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;YAC/B,CAAC;QACH,CAAC;IACH,CAAC;CACF"}

package/dist/storages/memory.d.ts

@@ -0,0 +1,9 @@
+import { CacheEntry, StorageAdapter } from '../types';
+export declare class MemoryStorage implements StorageAdapter {
+    private cache;
+    get<T>(key: string): Promise<CacheEntry<T> | null>;
+    set<T>(key: string, value: CacheEntry<T>): Promise<void>;
+    remove(key: string): Promise<void>;
+    clear(): Promise<void>;
+}
+//# sourceMappingURL=memory.d.ts.map

package/dist/storages/memory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"memory.d.ts","sourceRoot":"","sources":["../../src/storages/memory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAEtD,qBAAa,aAAc,YAAW,cAAc;IAClD,OAAO,CAAC,KAAK,CAA6B;IAEpC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAUlD,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAIxD,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIlC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAG7B"}

package/dist/storages/memory.js

@@ -0,0 +1,24 @@
+export class MemoryStorage {
+    cache = new Map();
+    async get(key) {
+        const value = this.cache.get(key);
+        if (!value)
+            return null;
+        try {
+            return JSON.parse(value);
+        }
+        catch {
+            return null;
+        }
+    }
+    async set(key, value) {
+        this.cache.set(key, JSON.stringify(value));
+    }
+    async remove(key) {
+        this.cache.delete(key);
+    }
+    async clear() {
+        this.cache.clear();
+    }
+}
+//# sourceMappingURL=memory.js.map

package/dist/storages/memory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"memory.js","sourceRoot":"","sources":["../../src/storages/memory.ts"],"names":[],"mappings":"AAEA,MAAM,OAAO,aAAa;IAChB,KAAK,GAAG,IAAI,GAAG,EAAkB,CAAC;IAE1C,KAAK,CAAC,GAAG,CAAI,GAAW;QACtB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAClC,IAAI,CAAC,KAAK;YAAE,OAAO,IAAI,CAAC;QACxB,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC3B,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,KAAK,CAAC,GAAG,CAAI,GAAW,EAAE,KAAoB;QAC5C,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,GAAW;QACtB,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;IACrB,CAAC;CACF"}

package/dist/storages/session-storage.d.ts

@@ -0,0 +1,11 @@
+import { CacheEntry, StorageAdapter } from '../types';
+export declare class SessionStorageAdapter implements StorageAdapter {
+    private prefix;
+    constructor(prefix?: string);
+    private getKey;
+    get<T>(key: string): Promise<CacheEntry<T> | null>;
+    set<T>(key: string, value: CacheEntry<T>): Promise<void>;
+    remove(key: string): Promise<void>;
+    clear(): Promise<void>;
+}
+//# sourceMappingURL=session-storage.d.ts.map

package/dist/storages/session-storage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"session-storage.d.ts","sourceRoot":"","sources":["../../src/storages/session-storage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAGtD,qBAAa,qBAAsB,YAAW,cAAc;IAC1D,OAAO,CAAC,MAAM,CAAS;gBAEX,MAAM,GAAE,MAAe;IAInC,OAAO,CAAC,MAAM;IAIR,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAUlD,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAIxD,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIlC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAQ7B"}

package/dist/storages/session-storage.js

@@ -0,0 +1,36 @@
+import { serialize, deserialize } from '../core/serializer';
+export class SessionStorageAdapter {
+    prefix;
+    constructor(prefix = 'rbc_') {
+        this.prefix = prefix;
+    }
+    getKey(key) {
+        return `${this.prefix}${key}`;
+    }
+    async get(key) {
+        const value = sessionStorage.getItem(this.getKey(key));
+        if (!value)
+            return null;
+        try {
+            return deserialize(value);
+        }
+        catch {
+            return null;
+        }
+    }
+    async set(key, value) {
+        sessionStorage.setItem(this.getKey(key), serialize(value));
+    }
+    async remove(key) {
+        sessionStorage.removeItem(this.getKey(key));
+    }
+    async clear() {
+        const keys = Object.keys(sessionStorage);
+        for (const key of keys) {
+            if (key.startsWith(this.prefix)) {
+                sessionStorage.removeItem(key);
+            }
+        }
+    }
+}
+//# sourceMappingURL=session-storage.js.map

package/dist/storages/session-storage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"session-storage.js","sourceRoot":"","sources":["../../src/storages/session-storage.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAE5D,MAAM,OAAO,qBAAqB;IACxB,MAAM,CAAS;IAEvB,YAAY,SAAiB,MAAM;QACjC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAEO,MAAM,CAAC,GAAW;QACxB,OAAO,GAAG,IAAI,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;IAChC,CAAC;IAED,KAAK,CAAC,GAAG,CAAI,GAAW;QACtB,MAAM,KAAK,GAAG,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;QACvD,IAAI,CAAC,KAAK;YAAE,OAAO,IAAI,CAAC;QACxB,IAAI,CAAC;YACH,OAAO,WAAW,CAAC,KAAK,CAAC,CAAC;QAC5B,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,KAAK,CAAC,GAAG,CAAI,GAAW,EAAE,KAAoB;QAC5C,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7D,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,GAAW;QACtB,cAAc,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IAC9C,CAAC;IAED,KAAK,CAAC,KAAK;QACT,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACzC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;gBAChC,cAAc,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;YACjC,CAAC;QACH,CAAC;IACH,CAAC;CACF"}

package/dist/types/index.d.ts

@@ -0,0 +1,31 @@
+export type StorageType = 'memory' | 'local' | 'session' | 'indexeddb';
+export interface CacheEntry<T> {
+    value: T;
+    createdAt: number;
+    expiresAt: number | null;
+    tags?: string[];
+    version: number;
+    isStale?: boolean;
+}
+export interface StorageAdapter {
+    get<T>(key: string): Promise<CacheEntry<T> | null>;
+    set<T>(key: string, value: CacheEntry<T>): Promise<void>;
+    remove(key: string): Promise<void>;
+    clear(): Promise<void>;
+}
+export interface CacheOptions {
+    storage?: StorageType;
+    ttl?: number;
+    staleWhileRevalidate?: boolean;
+    syncTabs?: boolean;
+    tags?: string[];
+    version?: number;
+}
+export interface GlobalCacheConfig {
+    defaultStorage: StorageType;
+    defaultTTL: number;
+    prefix?: string;
+    serialize?: (value: any) => string;
+    deserialize?: (value: string) => any;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,OAAO,GAAG,SAAS,GAAG,WAAW,CAAC;AAEvE,MAAM,WAAW,UAAU,CAAC,CAAC;IAC3B,KAAK,EAAE,CAAC,CAAC;IACT,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,cAAc;IAC7B,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IACnD,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzD,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB;AAED,MAAM,WAAW,YAAY;IAC3B,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,iBAAiB;IAChC,cAAc,EAAE,WAAW,CAAC;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,MAAM,CAAC;IACnC,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,GAAG,CAAC;CACtC"}

package/dist/types/index.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":""}

package/dist/utils/hydrate.d.ts

@@ -0,0 +1,9 @@
+import { CacheManager } from '../core/cache-manager';
+import { CacheOptions } from '../types';
+export interface HydrateEntry<T> {
+    key: string;
+    value: T;
+    options?: CacheOptions;
+}
+export declare const hydrate: (cacheManager: CacheManager, entries: HydrateEntry<any>[]) => Promise<void>;
+//# sourceMappingURL=hydrate.d.ts.map

package/dist/utils/hydrate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hydrate.d.ts","sourceRoot":"","sources":["../../src/utils/hydrate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAExC,MAAM,WAAW,YAAY,CAAC,CAAC;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,CAAC,CAAC;IACT,OAAO,CAAC,EAAE,YAAY,CAAC;CACxB;AAED,eAAO,MAAM,OAAO,GAClB,cAAc,YAAY,EAC1B,SAAS,YAAY,CAAC,GAAG,CAAC,EAAE,kBAO7B,CAAC"}

package/dist/utils/hydrate.js

@@ -0,0 +1,4 @@
+export const hydrate = async (cacheManager, entries) => {
+    await Promise.all(entries.map(entry => cacheManager.set(entry.key, entry.value, entry.options)));
+};
+//# sourceMappingURL=hydrate.js.map

package/dist/utils/hydrate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hydrate.js","sourceRoot":"","sources":["../../src/utils/hydrate.ts"],"names":[],"mappings":"AASA,MAAM,CAAC,MAAM,OAAO,GAAG,KAAK,EAC1B,YAA0B,EAC1B,OAA4B,EAC5B,EAAE;IACF,MAAM,OAAO,CAAC,GAAG,CACf,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAClB,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,CACxD,CACF,CAAC;AACJ,CAAC,CAAC"}

package/dist/utils/prefetch.d.ts

@@ -0,0 +1,4 @@
+import { CacheManager } from '../core/cache-manager';
+import { CacheOptions } from '../types';
+export declare const prefetch: <T>(cacheManager: CacheManager, key: string, fetcher: () => Promise<T>, options?: CacheOptions) => Promise<T>;
+//# sourceMappingURL=prefetch.d.ts.map

package/dist/utils/prefetch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prefetch.d.ts","sourceRoot":"","sources":["../../src/utils/prefetch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAExC,eAAO,MAAM,QAAQ,GAAU,CAAC,EAC9B,cAAc,YAAY,EAC1B,KAAK,MAAM,EACX,SAAS,MAAM,OAAO,CAAC,CAAC,CAAC,EACzB,UAAU,YAAY,KACrB,OAAO,CAAC,CAAC,CASX,CAAC"}

package/dist/utils/prefetch.js

@@ -0,0 +1,10 @@
+export const prefetch = async (cacheManager, key, fetcher, options) => {
+    const cached = await cacheManager.get(key, options);
+    if (cached !== null && !cached.__isStale) {
+        return cached;
+    }
+    const data = await fetcher();
+    await cacheManager.set(key, data, options);
+    return data;
+};
+//# sourceMappingURL=prefetch.js.map

package/dist/utils/prefetch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prefetch.js","sourceRoot":"","sources":["../../src/utils/prefetch.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,MAAM,QAAQ,GAAG,KAAK,EAC3B,YAA0B,EAC1B,GAAW,EACX,OAAyB,EACzB,OAAsB,EACV,EAAE;IACd,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,GAAG,CAAI,GAAG,EAAE,OAAO,CAAC,CAAC;IACvD,IAAI,MAAM,KAAK,IAAI,IAAI,CAAE,MAAc,CAAC,SAAS,EAAE,CAAC;QAClD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAM,IAAI,GAAG,MAAM,OAAO,EAAE,CAAC;IAC7B,MAAM,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC3C,OAAO,IAAI,CAAC;AACd,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "react-browser-cache",
+  "version": "1.0.0",
+  "description": "Production-ready hook-based browser caching system for React with TTL, stale-while-revalidate, and cross-tab sync.",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "dev": "tsc --watch",
+    "build": "npm run build:esm && npm run build:cjs",
+    "build:esm": "tsc",
+    "build:cjs": "tsc --module commonjs --outDir dist/cjs",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "react",
+    "cache",
+    "browser",
+    "storage",
+    "localstorage",
+    "sessionstorage",
+    "indexeddb",
+    "hooks",
+    "ttl",
+    "swr",
+    "stale-while-revalidate"
+  ],
+  "author": "KloudzComputing",
+  "license": "MIT",
+  "peerDependencies": {
+    "react": ">=18",
+    "react-dom": ">=18"
+  },
+  "devDependencies": {
+    "@types/react": "^18.2.0",
+    "@types/react-dom": "^18.2.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "typescript": "^5.0.0",
+    "vitest": "^1.0.0"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/cjs/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  }
+}