layercache 1.0.2 → 1.1.0

package/dist/index.d.ts

@@ -29,6 +29,7 @@ interface CacheMSetEntry<T> {
     value: T;
     options?: CacheWriteOptions;
 }
+/** Interface that all cache backend implementations must satisfy. */
 interface CacheLayer {
     readonly name: string;
     readonly defaultTtl?: number;
@@ -41,11 +42,28 @@ interface CacheLayer {
     clear(): Promise<void>;
     deleteMany?(keys: string[]): Promise<void>;
     keys?(): Promise<string[]>;
+    /**
+     * Returns true if the key exists and has not expired.
+     * Implementations may omit this; CacheStack will fall back to `get()`.
+     */
+    has?(key: string): Promise<boolean>;
+    /**
+     * Returns the remaining TTL in seconds for the key, or null if the key
+     * does not exist, has no TTL, or has already expired.
+     * Implementations may omit this.
+     */
+    ttl?(key: string): Promise<number | null>;
+    /**
+     * Returns the number of entries currently held by this layer.
+     * Implementations may omit this.
+     */
+    size?(): Promise<number>;
 }
 interface CacheSerializer {
     serialize(value: unknown): string | Buffer;
     deserialize<T>(payload: string | Buffer): T;
 }
+/** Snapshot of cumulative cache counters. */
 interface CacheMetricsSnapshot {
     hits: number;
     misses: number;
@@ -64,6 +82,15 @@ interface CacheMetricsSnapshot {
     degradedOperations: number;
     hitsByLayer: Record<string, number>;
     missesByLayer: Record<string, number>;
+    /** Timestamp (ms since epoch) when metrics were last reset. */
+    resetAt: number;
+}
+/** Computed hit-rate statistics derived from CacheMetricsSnapshot. */
+interface CacheHitRateSnapshot {
+    /** Overall hit rate across all layers (0–1). */
+    overall: number;
+    /** Per-layer hit rates (0–1 each). */
+    byLayer: Record<string, number>;
 }
 interface CacheLogger {
     debug?(message: string, context?: Record<string, unknown>): void;
@@ -104,6 +131,9 @@ interface CacheStackOptions {
     invalidationBus?: InvalidationBus;
     tagIndex?: CacheTagIndex;
     broadcastL1Invalidation?: boolean;
+    /**
+     * @deprecated Use `broadcastL1Invalidation` instead.
+     */
     publishSetInvalidation?: boolean;
     negativeCaching?: boolean;
     negativeTtl?: number | LayerTtlMap;
@@ -119,6 +149,12 @@ interface CacheStackOptions {
     singleFlightLeaseMs?: number;
     singleFlightTimeoutMs?: number;
     singleFlightPollMs?: number;
+    /**
+     * Maximum number of entries in `accessProfiles` and `circuitBreakers` maps
+     * before the oldest entries are pruned. Prevents unbounded memory growth.
+     * Defaults to 100 000.
+     */
+    maxProfileEntries?: number;
 }
 interface CacheAdaptiveTtlOptions {
     hotAfter?: number;
@@ -138,9 +174,19 @@ interface CacheWarmEntry<T = unknown> {
     options?: CacheGetOptions;
     priority?: number;
 }
+/** Options controlling the cache warm-up process. */
 interface CacheWarmOptions {
     concurrency?: number;
     continueOnError?: boolean;
+    /** Called after each entry is processed (success or failure). */
+    onProgress?: (progress: CacheWarmProgress) => void;
+}
+/** Progress information delivered to `CacheWarmOptions.onProgress`. */
+interface CacheWarmProgress {
+    completed: number;
+    total: number;
+    key: string;
+    success: boolean;
 }
 interface CacheWrapOptions<TArgs extends unknown[] = unknown[]> extends CacheGetOptions {
     keyResolver?: (...args: TArgs) => string;
@@ -159,14 +205,66 @@ interface CacheStatsSnapshot {
     }>;
     backgroundRefreshes: number;
 }
+/** All events emitted by CacheStack and their payload shapes. */
+interface CacheStackEvents {
+    /** Fired on every cache hit. */
+    hit: {
+        key: string;
+        layer: string;
+        state: 'fresh' | 'stale-while-revalidate' | 'stale-if-error';
+    };
+    /** Fired on every cache miss before the fetcher runs. */
+    miss: {
+        key: string;
+        mode: string;
+    };
+    /** Fired after a value is stored in the cache. */
+    set: {
+        key: string;
+        kind: string;
+        tags?: string[];
+    };
+    /** Fired after one or more keys are deleted. */
+    delete: {
+        keys: string[];
+    };
+    /** Fired when a value is backfilled into a faster layer. */
+    backfill: {
+        key: string;
+        layer: string;
+    };
+    /** Fired when a stale value is returned to the caller. */
+    'stale-serve': {
+        key: string;
+        state: string;
+        layer: string;
+    };
+    /** Fired when a duplicate request is deduplicated in stampede prevention. */
+    'stampede-dedupe': {
+        key: string;
+    };
+    /** Fired after a key is successfully warmed. */
+    warm: {
+        key: string;
+    };
+    /** Fired when an error occurs (layer failure, circuit breaker, etc.). */
+    error: {
+        operation: string;
+        [key: string]: unknown;
+    };
+}
 
 declare class CacheNamespace {
     private readonly cache;
     private readonly prefix;
     constructor(cache: CacheStack, prefix: string);
     get<T>(key: string, fetcher?: () => Promise<T>, options?: CacheGetOptions): Promise<T | null>;
+    getOrSet<T>(key: string, fetcher: () => Promise<T>, options?: CacheGetOptions): Promise<T | null>;
+    has(key: string): Promise<boolean>;
+    ttl(key: string): Promise<number | null>;
     set<T>(key: string, value: T, options?: CacheWriteOptions): Promise<void>;
     delete(key: string): Promise<void>;
+    mdelete(keys: string[]): Promise<void>;
     clear(): Promise<void>;
     mget<T>(entries: CacheMGetEntry<T>[]): Promise<Array<T | null>>;
     mset<T>(entries: CacheMSetEntry<T>[]): Promise<void>;
@@ -175,40 +273,90 @@ declare class CacheNamespace {
     wrap<TArgs extends unknown[], TResult>(keyPrefix: string, fetcher: (...args: TArgs) => Promise<TResult>, options?: CacheWrapOptions<TArgs>): (...args: TArgs) => Promise<TResult | null>;
     warm(entries: CacheWarmEntry[], options?: CacheWarmOptions): Promise<void>;
     getMetrics(): CacheMetricsSnapshot;
+    getHitRate(): CacheHitRateSnapshot;
     qualify(key: string): string;
 }
 
+/** Typed overloads for EventEmitter so callers get autocomplete on event names. */
+interface CacheStack {
+    on<K extends keyof CacheStackEvents>(event: K, listener: (data: CacheStackEvents[K]) => void): this;
+    once<K extends keyof CacheStackEvents>(event: K, listener: (data: CacheStackEvents[K]) => void): this;
+    off<K extends keyof CacheStackEvents>(event: K, listener: (data: CacheStackEvents[K]) => void): this;
+    emit<K extends keyof CacheStackEvents>(event: K, data: CacheStackEvents[K]): boolean;
+}
 declare class CacheStack extends EventEmitter {
     private readonly layers;
     private readonly options;
     private readonly stampedeGuard;
-    private readonly metrics;
+    private readonly metricsCollector;
     private readonly instanceId;
     private readonly startup;
     private unsubscribeInvalidation?;
     private readonly logger;
     private readonly tagIndex;
     private readonly backgroundRefreshes;
-    private readonly accessProfiles;
     private readonly layerDegradedUntil;
-    private readonly circuitBreakers;
+    private readonly ttlResolver;
+    private readonly circuitBreakerManager;
     private isDisconnecting;
     private disconnectPromise?;
     constructor(layers: CacheLayer[], options?: CacheStackOptions);
+    /**
+     * Read-through cache get.
+     * Returns the cached value if present and fresh, or invokes `fetcher` on a miss
+     * and stores the result across all layers. Returns `null` if the key is not found
+     * and no `fetcher` is provided.
+     */
     get<T>(key: string, fetcher?: () => Promise<T>, options?: CacheGetOptions): Promise<T | null>;
+    /**
+     * Alias for `get(key, fetcher, options)` — explicit get-or-set pattern.
+     * Fetches and caches the value if not already present.
+     */
+    getOrSet<T>(key: string, fetcher: () => Promise<T>, options?: CacheGetOptions): Promise<T | null>;
+    /**
+     * Returns true if the given key exists and is not expired in any layer.
+     */
+    has(key: string): Promise<boolean>;
+    /**
+     * Returns the remaining TTL in seconds for the key in the fastest layer
+     * that has it, or null if the key is not found / has no TTL.
+     */
+    ttl(key: string): Promise<number | null>;
+    /**
+     * Stores a value in all cache layers. Overwrites any existing value.
+     */
     set<T>(key: string, value: T, options?: CacheWriteOptions): Promise<void>;
+    /**
+     * Deletes the key from all layers and publishes an invalidation message.
+     */
     delete(key: string): Promise<void>;
     clear(): Promise<void>;
+    /**
+     * Deletes multiple keys at once. More efficient than calling `delete()` in a loop.
+     */
+    mdelete(keys: string[]): Promise<void>;
     mget<T>(entries: CacheMGetEntry<T>[]): Promise<Array<T | null>>;
     mset<T>(entries: CacheMSetEntry<T>[]): Promise<void>;
     warm(entries: CacheWarmEntry[], options?: CacheWarmOptions): Promise<void>;
+    /**
+     * Returns a cached version of `fetcher`. The cache key is derived from
+     * `prefix` plus the serialized arguments unless a `keyResolver` is provided.
+     */
     wrap<TArgs extends unknown[], TResult>(prefix: string, fetcher: (...args: TArgs) => Promise<TResult>, options?: CacheWrapOptions<TArgs>): (...args: TArgs) => Promise<TResult | null>;
+    /**
+     * Creates a `CacheNamespace` that automatically prefixes all keys with
+     * `prefix:`. Useful for multi-tenant or module-level isolation.
+     */
     namespace(prefix: string): CacheNamespace;
     invalidateByTag(tag: string): Promise<void>;
     invalidateByPattern(pattern: string): Promise<void>;
     getMetrics(): CacheMetricsSnapshot;
     getStats(): CacheStatsSnapshot;
     resetMetrics(): void;
+    /**
+     * Returns computed hit-rate statistics (overall and per-layer).
+     */
+    getHitRate(): CacheHitRateSnapshot;
     exportState(): Promise<CacheSnapshotEntry[]>;
     importState(entries: CacheSnapshotEntry[]): Promise<void>;
     persistToFile(filePath: string): Promise<void>;
@@ -226,8 +374,6 @@ declare class CacheStack extends EventEmitter {
     private executeLayerOperations;
     private resolveFreshTtl;
     private resolveLayerSeconds;
-    private readLayerNumber;
-    private applyJitter;
     private shouldNegativeCache;
     private scheduleBackgroundRefresh;
     private resolveSingleFlightOptions;
@@ -248,15 +394,10 @@ declare class CacheStack extends EventEmitter {
     private validateAdaptiveTtlOptions;
     private validateCircuitBreakerOptions;
     private applyFreshReadPolicies;
-    private applyAdaptiveTtl;
-    private recordAccess;
-    private incrementMetricMap;
     private shouldSkipLayer;
     private handleLayerFailure;
     private isGracefulDegradationEnabled;
-    private assertCircuitClosed;
     private recordCircuitFailure;
-    private resetCircuitBreaker;
     private isNegativeStoredValue;
     private emitError;
     private serializeKeyPart;
@@ -265,7 +406,17 @@ declare class CacheStack extends EventEmitter {
 }
 
 declare class PatternMatcher {
+    /**
+     * Tests whether a glob-style pattern matches a value.
+     * Supports `*` (any sequence of characters) and `?` (any single character).
+     * Uses a linear-time algorithm to avoid ReDoS vulnerabilities.
+     */
     static matches(pattern: string, value: string): boolean;
+    /**
+     * Linear-time glob matching using dynamic programming.
+     * Avoids catastrophic backtracking that RegExp-based glob matching can cause.
+     */
+    private static matchLinear;
 }
 
 interface RedisInvalidationBusOptions {
@@ -369,28 +520,41 @@ interface MemoryLayerSnapshotEntry {
     value: unknown;
     expiresAt: number | null;
 }
+/**
+ * Eviction policy applied when `maxSize` is reached.
+ * - `lru` (default): evicts the Least Recently Used entry.
+ * - `lfu`: evicts the Least Frequently Used entry.
+ * - `fifo`: evicts the oldest inserted entry.
+ */
+type EvictionPolicy = 'lru' | 'lfu' | 'fifo';
 interface MemoryLayerOptions {
     ttl?: number;
     maxSize?: number;
     name?: string;
+    evictionPolicy?: EvictionPolicy;
 }
 declare class MemoryLayer implements CacheLayer {
     readonly name: string;
     readonly defaultTtl?: number;
     readonly isLocal = true;
     private readonly maxSize;
+    private readonly evictionPolicy;
     private readonly entries;
     constructor(options?: MemoryLayerOptions);
     get<T>(key: string): Promise<T | null>;
     getEntry<T = unknown>(key: string): Promise<T | null>;
     getMany<T>(keys: string[]): Promise<Array<T | null>>;
     set(key: string, value: unknown, ttl?: number | undefined): Promise<void>;
+    has(key: string): Promise<boolean>;
+    ttl(key: string): Promise<number | null>;
+    size(): Promise<number>;
     delete(key: string): Promise<void>;
     deleteMany(keys: string[]): Promise<void>;
     clear(): Promise<void>;
     keys(): Promise<string[]>;
     exportState(): MemoryLayerSnapshotEntry[];
     importState(entries: MemoryLayerSnapshotEntry[]): void;
+    private evict;
     private pruneExpired;
     private isExpired;
 }
@@ -425,6 +589,13 @@ declare class RedisLayer implements CacheLayer {
     set(key: string, value: unknown, ttl?: number | undefined): Promise<void>;
     delete(key: string): Promise<void>;
     deleteMany(keys: string[]): Promise<void>;
+    has(key: string): Promise<boolean>;
+    ttl(key: string): Promise<number | null>;
+    size(): Promise<number>;
+    /**
+     * Deletes all keys matching the layer's prefix in batches to avoid
+     * loading millions of keys into memory at once.
+     */
     clear(): Promise<void>;
     keys(): Promise<string[]>;
     private scanKeys;
@@ -435,6 +606,94 @@ declare class RedisLayer implements CacheLayer {
     private decodePayload;
 }
 
+interface DiskLayerOptions {
+    directory: string;
+    ttl?: number;
+    name?: string;
+    serializer?: CacheSerializer;
+}
+/**
+ * A file-system backed cache layer.
+ * Each key is stored as a separate JSON file in `directory`.
+ * Useful for persisting cache across process restarts without needing Redis.
+ *
+ * NOTE: DiskLayer is designed for low-to-medium traffic scenarios.
+ * For high-throughput workloads, use MemoryLayer + RedisLayer.
+ */
+declare class DiskLayer implements CacheLayer {
+    readonly name: string;
+    readonly defaultTtl?: number;
+    readonly isLocal = true;
+    private readonly directory;
+    private readonly serializer;
+    constructor(options: DiskLayerOptions);
+    get<T>(key: string): Promise<T | null>;
+    getEntry<T = unknown>(key: string): Promise<T | null>;
+    set(key: string, value: unknown, ttl?: number | undefined): Promise<void>;
+    has(key: string): Promise<boolean>;
+    ttl(key: string): Promise<number | null>;
+    delete(key: string): Promise<void>;
+    deleteMany(keys: string[]): Promise<void>;
+    clear(): Promise<void>;
+    keys(): Promise<string[]>;
+    size(): Promise<number>;
+    private keyToPath;
+    private safeDelete;
+}
+
+/**
+ * Minimal interface that MemcachedLayer expects from a Memcached client.
+ * Compatible with the `memjs` and `memcache-client` npm packages.
+ *
+ * Install one of:
+ *   npm install memjs
+ *   npm install memcache-client
+ */
+interface MemcachedClient {
+    get(key: string): Promise<{
+        value: Buffer | null;
+    } | null>;
+    set(key: string, value: string | Buffer, options?: {
+        expires?: number;
+    }): Promise<boolean | undefined>;
+    delete(key: string): Promise<boolean | undefined>;
+}
+interface MemcachedLayerOptions {
+    client: MemcachedClient;
+    ttl?: number;
+    name?: string;
+    keyPrefix?: string;
+}
+/**
+ * Memcached-backed cache layer.
+ *
+ * Example usage with `memjs`:
+ * ```ts
+ * import Memjs from 'memjs'
+ * import { CacheStack, MemcachedLayer, MemoryLayer } from 'layercache'
+ *
+ * const memcached = Memjs.Client.create('localhost:11211')
+ * const cache = new CacheStack([
+ *   new MemoryLayer({ ttl: 30 }),
+ *   new MemcachedLayer({ client: memcached, ttl: 300 })
+ * ])
+ * ```
+ */
+declare class MemcachedLayer implements CacheLayer {
+    readonly name: string;
+    readonly defaultTtl?: number;
+    readonly isLocal = false;
+    private readonly client;
+    private readonly keyPrefix;
+    constructor(options: MemcachedLayerOptions);
+    get<T>(key: string): Promise<T | null>;
+    set(key: string, value: unknown, ttl?: number | undefined): Promise<void>;
+    delete(key: string): Promise<void>;
+    deleteMany(keys: string[]): Promise<void>;
+    clear(): Promise<void>;
+    private withPrefix;
+}
+
 declare class JsonSerializer implements CacheSerializer {
     serialize(value: unknown): string;
     deserialize<T>(payload: string | Buffer): T;
@@ -462,4 +721,25 @@ declare class StampedeGuard {
     private getMutexEntry;
 }
 
-export { type CacheAdaptiveTtlOptions, type CacheCircuitBreakerOptions, type CacheDegradationOptions, type CacheGetOptions, type CacheLayer, type CacheLogger, type CacheMGetEntry, type CacheMSetEntry, type CacheMetricsSnapshot, CacheNamespace, type CacheSerializer, type CacheSingleFlightCoordinator, type CacheSingleFlightExecutionOptions, type CacheSnapshotEntry, CacheStack, type CacheStackOptions, type CacheStatsSnapshot, type CacheTagIndex, type CacheWarmEntry, type CacheWarmOptions, type CacheWrapOptions, type CacheWriteOptions, type InvalidationBus, type InvalidationMessage, JsonSerializer, type LayerTtlMap, MemoryLayer, MsgpackSerializer, PatternMatcher, RedisInvalidationBus, RedisLayer, RedisSingleFlightCoordinator, RedisTagIndex, StampedeGuard, TagIndex, cacheGraphqlResolver, createCacheStatsHandler, createCachedMethodDecorator, createFastifyLayercachePlugin, createTrpcCacheMiddleware };
+/**
+ * Returns a function that generates a Prometheus-compatible text exposition
+ * of the cache metrics from one or more CacheStack instances.
+ *
+ * Usage example:
+ * ```ts
+ * const collect = createPrometheusMetricsExporter(cache)
+ * http.createServer(async (_req, res) => {
+ *   res.setHeader('content-type', 'text/plain; version=0.0.4; charset=utf-8')
+ *   res.end(collect())
+ * }).listen(9091)
+ * ```
+ *
+ * @param stacks  One or more CacheStack instances. When multiple stacks are
+ *                given, each must be named via the optional `name` parameter.
+ */
+declare function createPrometheusMetricsExporter(stacks: CacheStack | Array<{
+    stack: CacheStack;
+    name: string;
+}>): () => string;
+
+export { type CacheAdaptiveTtlOptions, type CacheCircuitBreakerOptions, type CacheDegradationOptions, type CacheGetOptions, type CacheHitRateSnapshot, type CacheLayer, type CacheLogger, type CacheMGetEntry, type CacheMSetEntry, type CacheMetricsSnapshot, CacheNamespace, type CacheSerializer, type CacheSingleFlightCoordinator, type CacheSingleFlightExecutionOptions, type CacheSnapshotEntry, CacheStack, type CacheStackEvents, type CacheStackOptions, type CacheStatsSnapshot, type CacheTagIndex, type CacheWarmEntry, type CacheWarmOptions, type CacheWarmProgress, type CacheWrapOptions, type CacheWriteOptions, DiskLayer, type EvictionPolicy, type InvalidationBus, type InvalidationMessage, JsonSerializer, type LayerTtlMap, type MemcachedClient, MemcachedLayer, MemoryLayer, type MemoryLayerSnapshotEntry, MsgpackSerializer, PatternMatcher, RedisInvalidationBus, RedisLayer, RedisSingleFlightCoordinator, RedisTagIndex, StampedeGuard, TagIndex, cacheGraphqlResolver, createCacheStatsHandler, createCachedMethodDecorator, createFastifyLayercachePlugin, createPrometheusMetricsExporter, createTrpcCacheMiddleware };