@mmstack/resource 20.2.7 → 20.2.9

package/index.d.ts

@@ -1,6 +1,13 @@
 import { HttpResponse, HttpInterceptorFn, HttpContext, HttpResourceOptions, HttpResourceRequest, HttpResourceRef, HttpHeaders } from '@angular/common/http';
 import { Signal, Injector, Provider, WritableSignal, ValueEqualityFn } from '@angular/core';
 
+type StoredEntry<T> = Omit<CacheEntry<T>, 'timeout'>;
+type CacheDB<T> = {
+    getAll: () => Promise<StoredEntry<T>[]>;
+    store: (value: StoredEntry<T>) => Promise<void>;
+    remove: (key: string) => Promise<void>;
+};
+
 /**
  * Options for configuring the Least Recently Used (LRU) cache cleanup strategy.
  * @internal
@@ -40,6 +47,7 @@ type OldsetCleanupType = {
 type CacheEntry<T> = {
     value: T;
     created: number;
+    updated: number;
     stale: number;
     useCount: number;
     expiresAt: number;
@@ -60,8 +68,16 @@ type CleanupType = LRUCleanupType | OldsetCleanupType;
 declare class Cache<T> {
     protected readonly ttl: number;
     protected readonly staleTime: number;
+    private readonly db;
     private readonly internal;
     private readonly cleanupOpt;
+    private readonly id;
+    /**
+     * Destroys the cache instance, cleaning up any resources used by the cache.
+     * This method is called automatically when the cache instance is garbage collected.
+     */
+    readonly destroy: () => void;
+    private readonly broadcast;
     /**
      * Creates a new `Cache` instance.
      *
@@ -70,8 +86,14 @@ declare class Cache<T> {
      *                    stale but can still be used while revalidation occurs in the background. Defaults to 1 hour.
      * @param cleanupOpt - Options for configuring the cache cleanup strategy.  Defaults to LRU with a
      *                     `maxSize` of 200 and a `checkInterval` of one hour.
-     */
-    constructor(ttl?: number, staleTime?: number, cleanupOpt?: Partial<CleanupType>);
+     * @param syncTabs - If provided, the cache will use the options a BroadcastChannel to send updates between tabs.
+     *                   Defaults to `undefined`, meaning no synchronization across tabs.
+     */
+    constructor(ttl?: number, staleTime?: number, cleanupOpt?: Partial<CleanupType>, syncTabs?: {
+        id: string;
+        serialize: (value: T) => string;
+        deserialize: (value: string) => T | null;
+    }, db?: Promise<CacheDB<T>>);
     /** @internal */
     private getInternal;
     /**
@@ -112,13 +134,15 @@ declare class Cache<T> {
      * @param staleTime - (Optional) The stale time for this entry, in milliseconds. Overrides the default `staleTime`.
      * @param ttl - (Optional) The TTL for this entry, in milliseconds. Overrides the default `ttl`.
      */
-    store(key: string, value: T, staleTime?: number, ttl?: number): void;
+    store(key: string, value: T, staleTime?: number, ttl?: number, persist?: boolean): void;
+    private storeInternal;
     /**
      * Invalidates (removes) a cache entry.
      *
      * @param key - The key of the entry to invalidate.
      */
     invalidate(key: string): void;
+    private invalidateInternal;
     /** @internal */
     private cleanup;
 }
@@ -139,6 +163,23 @@ type CacheOptions = {
      * Options for configuring the cache cleanup strategy.
      */
     cleanup?: Partial<CleanupType>;
+    /**
+     * Whether to synchronize cache across tabs. If true, the cache will use a BroadcastChannel to send updates between tabs.
+     */
+    syncTabs?: boolean;
+    /**
+     * Globally disable persistence of cache entries.
+     * If set to `false`, cache entries will not be persisted to the database.
+     * `true` means, cache entries can be persisted, they must still be opted into on the resource level & allowed by server headers.
+     * @default true
+     */
+    persist?: boolean;
+    /**
+     * Version of the caches database, increment this if the interfaces change, this will cause the old data to be deleted.
+     * Minimum value is 1, so first increment should be 2.
+     * @default 1
+     */
+    version?: number;
 };
 /**
  * Provides the instance of the QueryCache for queryResource. This should probably be called
@@ -409,6 +450,11 @@ type ResourceCacheOptions = true | {
      * @default false - By default the resource will respect `Cache-Control` headers.
      */
     ignoreCacheControl?: boolean;
+    /**
+     * Whether to persist the cache entry in the local DB instance.
+     * @default false - By default, the cache entry is not persisted.
+     */
+    persist?: boolean;
 };
 /**
  * Options for configuring a `queryResource`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mmstack/resource",
-  "version": "20.2.7",
+  "version": "20.2.9",
   "keywords": [
     "angular",
     "signals",
@@ -18,7 +18,7 @@
   "homepage": "https://github.com/mihajm/mmstack/blob/master/packages/resource",
   "dependencies": {
     "uuid": "~11.1.0",
-    "@mmstack/primitives": "^20.0.2",
+    "@mmstack/primitives": "^20.0.3",
     "@mmstack/object": "^20.0.0",
     "tslib": "^2.3.0"
   },