@nest-omni/core 4.1.3-1 → 4.1.3-11

package/cache/index.js

@@ -1,14 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.KeyGenerator = exports.DependencyManager = exports.CacheLayer = exports.TimeDependency = exports.TagDependency = exports.FileDependency = exports.DbDependency = exports.ChainDependency = exports.CallbackDependency = exports.REDIS_CLIENT = exports.BaseCacheProvider = exports.RedisCacheProvider = exports.MemoryCacheProvider = exports.ClsCacheProvider = exports.setCacheService = exports.getCacheService = exports.CachePut = exports.CacheEvict = exports.Cacheable = exports.CacheSerializationService = exports.CacheMetricsService = exports.CacheWarmupService = exports.CacheHealthChecker = exports.CacheService = exports.CACHE_COMPRESSION_THRESHOLD = exports.CACHE_COMPRESSION_ENABLED = exports.CACHE_SERVICE = exports.CacheModule = void 0;
+// Module
 var cache_module_1 = require("./cache.module");
 Object.defineProperty(exports, "CacheModule", { enumerable: true, get: function () { return cache_module_1.CacheModule; } });
 Object.defineProperty(exports, "CACHE_SERVICE", { enumerable: true, get: function () { return cache_module_1.CACHE_SERVICE; } });
+// Constants
 var cache_constants_1 = require("./cache.constants");
 Object.defineProperty(exports, "CACHE_COMPRESSION_ENABLED", { enumerable: true, get: function () { return cache_constants_1.CACHE_COMPRESSION_ENABLED; } });
 Object.defineProperty(exports, "CACHE_COMPRESSION_THRESHOLD", { enumerable: true, get: function () { return cache_constants_1.CACHE_COMPRESSION_THRESHOLD; } });
+// Service
 var cache_service_1 = require("./cache.service");
 Object.defineProperty(exports, "CacheService", { enumerable: true, get: function () { return cache_service_1.CacheService; } });
+// Additional Services
 var cache_health_1 = require("./cache.health");
 Object.defineProperty(exports, "CacheHealthChecker", { enumerable: true, get: function () { return cache_health_1.CacheHealthChecker; } });
 var cache_warmup_service_1 = require("./cache.warmup.service");
@@ -17,12 +21,14 @@ var cache_metrics_service_1 = require("./cache-metrics.service");
 Object.defineProperty(exports, "CacheMetricsService", { enumerable: true, get: function () { return cache_metrics_service_1.CacheMetricsService; } });
 var cache_serialization_service_1 = require("./cache-serialization.service");
 Object.defineProperty(exports, "CacheSerializationService", { enumerable: true, get: function () { return cache_serialization_service_1.CacheSerializationService; } });
+// Decorators
 var decorators_1 = require("./decorators");
 Object.defineProperty(exports, "Cacheable", { enumerable: true, get: function () { return decorators_1.Cacheable; } });
 Object.defineProperty(exports, "CacheEvict", { enumerable: true, get: function () { return decorators_1.CacheEvict; } });
 Object.defineProperty(exports, "CachePut", { enumerable: true, get: function () { return decorators_1.CachePut; } });
 Object.defineProperty(exports, "getCacheService", { enumerable: true, get: function () { return decorators_1.getCacheService; } });
 Object.defineProperty(exports, "setCacheService", { enumerable: true, get: function () { return decorators_1.setCacheService; } });
+// Providers
 var providers_1 = require("./providers");
 Object.defineProperty(exports, "ClsCacheProvider", { enumerable: true, get: function () { return providers_1.ClsCacheProvider; } });
 Object.defineProperty(exports, "MemoryCacheProvider", { enumerable: true, get: function () { return providers_1.MemoryCacheProvider; } });
@@ -30,6 +36,7 @@ Object.defineProperty(exports, "RedisCacheProvider", { enumerable: true, get: fu
 Object.defineProperty(exports, "BaseCacheProvider", { enumerable: true, get: function () { return providers_1.BaseCacheProvider; } });
 var redis_cache_provider_1 = require("./providers/redis-cache.provider");
 Object.defineProperty(exports, "REDIS_CLIENT", { enumerable: true, get: function () { return redis_cache_provider_1.REDIS_CLIENT; } });
+// Dependencies
 var dependencies_1 = require("./dependencies");
 Object.defineProperty(exports, "CallbackDependency", { enumerable: true, get: function () { return dependencies_1.CallbackDependency; } });
 Object.defineProperty(exports, "ChainDependency", { enumerable: true, get: function () { return dependencies_1.ChainDependency; } });
@@ -37,8 +44,10 @@ Object.defineProperty(exports, "DbDependency", { enumerable: true, get: function
 Object.defineProperty(exports, "FileDependency", { enumerable: true, get: function () { return dependencies_1.FileDependency; } });
 Object.defineProperty(exports, "TagDependency", { enumerable: true, get: function () { return dependencies_1.TagDependency; } });
 Object.defineProperty(exports, "TimeDependency", { enumerable: true, get: function () { return dependencies_1.TimeDependency; } });
+// Interfaces
 var interfaces_1 = require("./interfaces");
 Object.defineProperty(exports, "CacheLayer", { enumerable: true, get: function () { return interfaces_1.CacheLayer; } });
+// Utils (advanced usage)
 var utils_1 = require("./utils");
 Object.defineProperty(exports, "DependencyManager", { enumerable: true, get: function () { return utils_1.DependencyManager; } });
 Object.defineProperty(exports, "KeyGenerator", { enumerable: true, get: function () { return utils_1.KeyGenerator; } });

package/cache/interfaces/cache-dependency.interface.d.ts

@@ -1,11 +1,64 @@
+/**
+ * Cache dependency interface - similar to Yii2 cache dependency system
+ *
+ * A cache dependency represents a dependency relationship between cached data
+ * and some external state. When the external state changes, the cached data
+ * becomes invalid.
+ *
+ * @example
+ * ```typescript
+ * // Tag-based dependency
+ * new TagDependency(['user-list'])
+ *
+ * // Database-based dependency
+ * new DbDependency('SELECT MAX(updated_at) FROM users WHERE id = ?', [userId])
+ *
+ * // Callback-based dependency
+ * new CallbackDependency(() => ConfigService.get('app.version'))
+ * ```
+ */
 export interface CacheDependency {
+    /**
+     * Get a unique key that identifies this dependency
+     * This key is used to store the dependency state
+     *
+     * @returns Unique dependency key
+     */
     getKey(): string;
+    /**
+     * Get the current state/value of this dependency
+     * This value will be compared with stored state to detect changes
+     *
+     * @returns Current dependency data/state
+     */
     getData(): Promise<any>;
+    /**
+     * Check if the dependency has changed by comparing old data with current data
+     *
+     * @param oldData - Previously stored dependency data
+     * @returns true if dependency has changed, false otherwise
+     */
     isChanged(oldData: any): Promise<boolean>;
+    /**
+     * Reset/clear the dependency state
+     * Used when manually invalidating dependencies
+     */
     reset?(): Promise<void>;
 }
+/**
+ * Serialized dependency data stored alongside cached values
+ */
 export interface DependencyData {
+    /**
+     * Dependency key
+     */
     key: string;
+    /**
+     * Dependency state snapshot at cache time
+     */
     data: any;
+    /**
+     * Timestamp when dependency was captured
+     */
     timestamp: number;
 }

package/cache/interfaces/cache-options.interface.d.ts

@@ -1,32 +1,113 @@
 import type { CacheDependency } from './cache-dependency.interface';
+/**
+ * Cache layer enum - defines the three-tier cache architecture
+ */
 export declare enum CacheLayer {
+    /** L1: Request-level cache (nestjs-cls) - fastest, scoped to request */
     CLS = "cls",
+    /** L2: Process-level cache (native Map) - fast, scoped to process */
     MEMORY = "memory",
+    /** L3: Distributed cache (Redis) - persistent, shared across processes */
     REDIS = "redis"
 }
+/**
+ * Cache configuration options
+ */
 export interface CacheOptions {
+    /**
+     * Time to live in milliseconds
+     * @example 300_000 // 5 minutes
+     */
     ttl?: number;
+    /**
+     * Cache layers to use
+     * @default [CacheLayer.MEMORY, CacheLayer.REDIS]
+     */
     layers?: CacheLayer[];
+    /**
+     * Key prefix for namespacing
+     * @example 'user:' will result in keys like 'user:123'
+     */
     prefix?: string;
+    /**
+     * Condition function to determine if value should be cached
+     * @param args - Method arguments
+     * @returns true to cache, false to skip
+     */
     condition?: (...args: any[]) => boolean | Promise<boolean>;
+    /**
+     * Cache dependencies - cache will be invalidated when dependencies change
+     * Similar to Yii2 cache dependency system
+     */
     dependencies?: CacheDependency[];
+    /**
+     * Whether to backfill upper cache layers when value is found in lower layer
+     * @default true
+     */
     backfill?: boolean;
+    /**
+     * Namespace for grouping related cache keys
+     */
     namespace?: string;
 }
+/**
+ * Options for cache decorator key generation
+ */
 export interface CacheKeyOptions {
+    /**
+     * Static key or key generator function
+     */
     key?: string | ((...args: any[]) => string);
+    /**
+     * Key prefix
+     */
     prefix?: string;
+    /**
+     * Whether to include all method arguments in key generation
+     * @default false
+     */
     includeAllArgs?: boolean;
 }
+/**
+ * Options for @Cacheable decorator
+ */
 export interface CacheableOptions extends CacheOptions, CacheKeyOptions {
 }
+/**
+ * Options for @CacheEvict decorator
+ */
 export interface CacheEvictOptions {
+    /**
+     * Keys to evict (can be static strings or generator functions)
+     */
     keys?: Array<string | ((...args: any[]) => string)>;
+    /**
+     * Patterns to match for eviction (supports wildcards)
+     * @example ['user:*', 'posts:list:*']
+     */
     patterns?: string[];
+    /**
+     * Tags to invalidate
+     */
     tags?: string[];
+    /**
+     * Cache layers to evict from
+     */
     layers?: CacheLayer[];
+    /**
+     * Condition to determine if eviction should occur
+     * @param args - Method arguments
+     * @param result - Method return value
+     */
     condition?: (...args: any[]) => boolean | Promise<boolean>;
+    /**
+     * Whether to evict before or after method execution
+     * @default 'after'
+     */
     timing?: 'before' | 'after';
 }
+/**
+ * Options for @CachePut decorator
+ */
 export interface CachePutOptions extends CacheOptions, CacheKeyOptions {
 }

package/cache/interfaces/cache-options.interface.js

@@ -1,9 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CacheLayer = void 0;
+/**
+ * Cache layer enum - defines the three-tier cache architecture
+ */
 var CacheLayer;
 (function (CacheLayer) {
+    /** L1: Request-level cache (nestjs-cls) - fastest, scoped to request */
     CacheLayer["CLS"] = "cls";
+    /** L2: Process-level cache (native Map) - fast, scoped to process */
     CacheLayer["MEMORY"] = "memory";
+    /** L3: Distributed cache (Redis) - persistent, shared across processes */
     CacheLayer["REDIS"] = "redis";
 })(CacheLayer || (exports.CacheLayer = CacheLayer = {}));

package/cache/interfaces/cache-provider.interface.d.ts

@@ -1,28 +1,106 @@
+/**
+ * Base cache provider interface
+ * All cache providers (CLS, Memory, Redis) implement this interface
+ */
 export interface CacheProvider {
+    /**
+     * Get value from cache
+     *
+     * @param key - Cache key
+     * @returns Cached value or null if not found
+     */
     get<T>(key: string): Promise<T | null>;
+    /**
+     * Set value in cache
+     *
+     * @param key - Cache key
+     * @param value - Value to cache
+     * @param ttl - Time to live in milliseconds
+     */
     set<T>(key: string, value: T, ttl?: number): Promise<void>;
+    /**
+     * Delete value from cache
+     *
+     * @param key - Cache key or array of keys
+     */
     delete(key: string | string[]): Promise<void>;
+    /**
+     * Delete keys matching a pattern (supports wildcards)
+     *
+     * @param pattern - Pattern to match (e.g., 'user:*')
+     * @returns Number of keys deleted
+     */
     deletePattern?(pattern: string): Promise<number>;
+    /**
+     * Clear all cache entries
+     */
     clear(): Promise<void>;
+    /**
+     * Check if a key exists in cache
+     *
+     * @param key - Cache key
+     */
     has(key: string): Promise<boolean>;
+    /**
+     * Get multiple values at once
+     *
+     * @param keys - Array of cache keys
+     * @returns Array of values (null for missing keys)
+     */
     mget<T>(keys: string[]): Promise<(T | null)[]>;
+    /**
+     * Set multiple values at once
+     *
+     * @param items - Array of key-value pairs
+     * @param ttl - Time to live in milliseconds
+     */
     mset(items: Array<{
         key: string;
         value: any;
     }>, ttl?: number): Promise<void>;
+    /**
+     * Get provider name
+     */
     getName(): string;
 }
+/**
+ * Cache statistics
+ */
 export interface CacheStats {
+    /**
+     * Total number of get operations
+     */
     totalGets: number;
+    /**
+     * Number of cache hits
+     */
     hits: number;
+    /**
+     * Number of cache misses
+     */
     misses: number;
+    /**
+     * Hit rate (hits / totalGets)
+     */
     hitRate: number;
+    /**
+     * Stats per layer
+     */
     byLayer: Record<string, {
         hits: number;
         misses: number;
         hitRate: number;
     }>;
+    /**
+     * Total number of set operations
+     */
     totalSets: number;
+    /**
+     * Total number of delete operations
+     */
     totalDeletes: number;
+    /**
+     * Total number of clear operations
+     */
     totalClears: number;
 }

package/cache/providers/base-cache.provider.d.ts

@@ -1,4 +1,7 @@
 import type { CacheProvider } from '../interfaces/cache-provider.interface';
+/**
+ * Base cache provider with common utility methods
+ */
 export declare abstract class BaseCacheProvider implements CacheProvider {
     abstract get<T>(key: string): Promise<T | null>;
     abstract set<T>(key: string, value: T, ttl?: number): Promise<void>;
@@ -7,10 +10,21 @@ export declare abstract class BaseCacheProvider implements CacheProvider {
     abstract clear(): Promise<void>;
     abstract has(key: string): Promise<boolean>;
     abstract getName(): string;
+    /**
+     * Get multiple values at once
+     * Default implementation - can be overridden for better performance
+     */
     mget<T>(keys: string[]): Promise<(T | null)[]>;
+    /**
+     * Set multiple values at once
+     * Default implementation - can be overridden for better performance
+     */
     mset(items: Array<{
         key: string;
         value: any;
     }>, ttl?: number): Promise<void>;
+    /**
+     * Convert wildcard pattern to RegExp
+     */
     protected patternToRegex(pattern: string): RegExp;
 }

package/cache/providers/base-cache.provider.js

@@ -10,21 +10,37 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseCacheProvider = void 0;
+/**
+ * Base cache provider with common utility methods
+ */
 class BaseCacheProvider {
+    /**
+     * Get multiple values at once
+     * Default implementation - can be overridden for better performance
+     */
     mget(keys) {
         return __awaiter(this, void 0, void 0, function* () {
             const promises = keys.map((key) => this.get(key));
             return Promise.all(promises);
         });
     }
+    /**
+     * Set multiple values at once
+     * Default implementation - can be overridden for better performance
+     */
     mset(items, ttl) {
         return __awaiter(this, void 0, void 0, function* () {
             const promises = items.map((item) => this.set(item.key, item.value, ttl));
             yield Promise.all(promises);
         });
     }
+    /**
+     * Convert wildcard pattern to RegExp
+     */
     patternToRegex(pattern) {
+        // Escape special regex characters except *
         const escaped = pattern.replace(/[.+?^${}()|[\]\\]/g, '\\$&');
+        // Convert * to .*
         const regexPattern = escaped.replace(/\*/g, '.*');
         return new RegExp(`^${regexPattern}$`);
     }

package/cache/providers/cls-cache.provider.d.ts

@@ -1,4 +1,12 @@
 import { BaseCacheProvider } from './base-cache.provider';
+/**
+ * CLS (Continuation Local Storage) cache provider
+ *
+ * This is the L1 cache layer - request-scoped caching using nestjs-cls.
+ * Data stored here is only available within the same request context.
+ *
+ * Fastest cache layer but limited to single request lifecycle.
+ */
 export declare class ClsCacheProvider extends BaseCacheProvider {
     private static readonly CACHE_PREFIX;
     private static readonly KEYS_SET;
@@ -9,8 +17,20 @@ export declare class ClsCacheProvider extends BaseCacheProvider {
     deletePattern(pattern: string): Promise<number>;
     clear(): Promise<void>;
     has(key: string): Promise<boolean>;
+    /**
+     * Get full key with prefix
+     */
     private getFullKey;
+    /**
+     * Add key to tracked keys set
+     */
     private addKeyToSet;
+    /**
+     * Remove key from tracked keys set
+     */
     private removeKeyFromSet;
+    /**
+     * Get all tracked keys
+     */
     private getAllKeys;
 }

package/cache/providers/cls-cache.provider.js

@@ -12,6 +12,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ClsCacheProvider = void 0;
 const nestjs_cls_1 = require("nestjs-cls");
 const base_cache_provider_1 = require("./base-cache.provider");
+/**
+ * CLS (Continuation Local Storage) cache provider
+ *
+ * This is the L1 cache layer - request-scoped caching using nestjs-cls.
+ * Data stored here is only available within the same request context.
+ *
+ * Fastest cache layer but limited to single request lifecycle.
+ */
 class ClsCacheProvider extends base_cache_provider_1.BaseCacheProvider {
     getName() {
         return 'CLS';
@@ -25,6 +33,7 @@ class ClsCacheProvider extends base_cache_provider_1.BaseCacheProvider {
                 if (!cached) {
                     return null;
                 }
+                // Check TTL
                 if (cached.expiresAt && Date.now() > cached.expiresAt) {
                     yield this.delete(key);
                     return null;
@@ -32,6 +41,7 @@ class ClsCacheProvider extends base_cache_provider_1.BaseCacheProvider {
                 return cached.value;
             }
             catch (_a) {
+                // CLS might not be available (e.g., outside request context)
                 return null;
             }
         });
@@ -46,9 +56,11 @@ class ClsCacheProvider extends base_cache_provider_1.BaseCacheProvider {
                     cached.expiresAt = Date.now() + ttl;
                 }
                 store.set(fullKey, cached);
+                // Track this key for cleanup
                 this.addKeyToSet(key);
             }
             catch (_a) {
+                // CLS might not be available, silently fail
             }
         });
     }
@@ -64,6 +76,7 @@ class ClsCacheProvider extends base_cache_provider_1.BaseCacheProvider {
                 }
             }
             catch (_a) {
+                // CLS might not be available, silently fail
             }
         });
     }
@@ -90,6 +103,7 @@ class ClsCacheProvider extends base_cache_provider_1.BaseCacheProvider {
                 yield this.delete(allKeys);
             }
             catch (_a) {
+                // CLS might not be available, silently fail
             }
         });
     }
@@ -99,9 +113,15 @@ class ClsCacheProvider extends base_cache_provider_1.BaseCacheProvider {
             return value !== null;
         });
     }
+    /**
+     * Get full key with prefix
+     */
     getFullKey(key) {
         return `${ClsCacheProvider.CACHE_PREFIX}${key}`;
     }
+    /**
+     * Add key to tracked keys set
+     */
     addKeyToSet(key) {
         try {
             const store = nestjs_cls_1.ClsServiceManager.getClsService();
@@ -110,8 +130,12 @@ class ClsCacheProvider extends base_cache_provider_1.BaseCacheProvider {
             store.set(ClsCacheProvider.KEYS_SET, keys);
         }
         catch (_a) {
+            // Ignore
         }
     }
+    /**
+     * Remove key from tracked keys set
+     */
     removeKeyFromSet(key) {
         try {
             const store = nestjs_cls_1.ClsServiceManager.getClsService();
@@ -122,8 +146,12 @@ class ClsCacheProvider extends base_cache_provider_1.BaseCacheProvider {
             }
         }
         catch (_a) {
+            // Ignore
         }
     }
+    /**
+     * Get all tracked keys
+     */
     getAllKeys() {
         try {
             const store = nestjs_cls_1.ClsServiceManager.getClsService();

package/cache/providers/memory-cache.provider.d.ts

@@ -1,4 +1,12 @@
 import { BaseCacheProvider } from './base-cache.provider';
+/**
+ * Memory cache provider using native Map with TTL support
+ *
+ * This is the L2 cache layer - process-level caching.
+ * Data is stored in memory and shared across all requests in the same process.
+ *
+ * Faster than Redis but not shared across multiple processes/servers.
+ */
 export declare class MemoryCacheProvider extends BaseCacheProvider {
     private cache;
     private keys;
@@ -15,10 +23,25 @@ export declare class MemoryCacheProvider extends BaseCacheProvider {
     deletePattern(pattern: string): Promise<number>;
     clear(): Promise<void>;
     has(key: string): Promise<boolean>;
+    /**
+     * Get all keys (for debugging/testing)
+     */
     getAllKeys(): string[];
+    /**
+     * Get cache size
+     */
     getSize(): number;
+    /**
+     * Clean up expired items (optional maintenance method)
+     */
     cleanup(): number;
+    /**
+     * Optimized mget with batch cleanup
+     */
     mget<T>(keys: string[]): Promise<(T | null)[]>;
+    /**
+     * Optimized mset
+     */
     mset(items: Array<{
         key: string;
         value: any;

package/cache/providers/memory-cache.provider.js

@@ -11,6 +11,14 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MemoryCacheProvider = void 0;
 const base_cache_provider_1 = require("./base-cache.provider");
+/**
+ * Memory cache provider using native Map with TTL support
+ *
+ * This is the L2 cache layer - process-level caching.
+ * Data is stored in memory and shared across all requests in the same process.
+ *
+ * Faster than Redis but not shared across multiple processes/servers.
+ */
 class MemoryCacheProvider extends base_cache_provider_1.BaseCacheProvider {
     constructor(options) {
         super();
@@ -29,6 +37,7 @@ class MemoryCacheProvider extends base_cache_provider_1.BaseCacheProvider {
                 if (!item) {
                     return null;
                 }
+                // Check if item has expired
                 if (item.expiresAt && Date.now() > item.expiresAt) {
                     this.cache.delete(key);
                     this.keys.delete(key);
@@ -110,6 +119,7 @@ class MemoryCacheProvider extends base_cache_provider_1.BaseCacheProvider {
                 if (!item) {
                     return false;
                 }
+                // Check if item has expired
                 if (item.expiresAt && Date.now() > item.expiresAt) {
                     this.cache.delete(key);
                     this.keys.delete(key);
@@ -122,12 +132,21 @@ class MemoryCacheProvider extends base_cache_provider_1.BaseCacheProvider {
             }
         });
     }
+    /**
+     * Get all keys (for debugging/testing)
+     */
     getAllKeys() {
         return Array.from(this.keys);
     }
+    /**
+     * Get cache size
+     */
     getSize() {
         return this.keys.size;
     }
+    /**
+     * Clean up expired items (optional maintenance method)
+     */
     cleanup() {
         let cleaned = 0;
         const now = Date.now();
@@ -140,6 +159,9 @@ class MemoryCacheProvider extends base_cache_provider_1.BaseCacheProvider {
         }
         return cleaned;
     }
+    /**
+     * Optimized mget with batch cleanup
+     */
     mget(keys) {
         return __awaiter(this, void 0, void 0, function* () {
             const results = [];
@@ -150,6 +172,7 @@ class MemoryCacheProvider extends base_cache_provider_1.BaseCacheProvider {
                     results.push(null);
                     continue;
                 }
+                // Check if item has expired
                 if (item.expiresAt && now > item.expiresAt) {
                     this.cache.delete(key);
                     this.keys.delete(key);
@@ -161,6 +184,9 @@ class MemoryCacheProvider extends base_cache_provider_1.BaseCacheProvider {
             return results;
         });
     }
+    /**
+     * Optimized mset
+     */
     mset(items, ttl) {
         return __awaiter(this, void 0, void 0, function* () {
             const promises = items.map((item) => this.set(item.key, item.value, ttl));