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

package/cache/dependencies/file.dependency.d.ts

@@ -1,4 +1,33 @@
 import type { CacheDependency } from '../interfaces/cache-dependency.interface';
+/**
+ * File-based cache dependency
+ *
+ * This dependency monitors file modification time. When the file is modified,
+ * the cache becomes invalid.
+ *
+ * Useful for configuration files, templates, or other file-based resources.
+ *
+ * @example
+ * ```typescript
+ * // Cache template, invalidate when template file changes
+ * @Cacheable({
+ *   key: (name) => `template:${name}`,
+ *   dependencies: [
+ *     new FileDependency((name) => `./templates/${name}.html`)
+ *   ]
+ * })
+ * async getTemplate(name: string) { }
+ *
+ * // Cache config, invalidate when config file changes
+ * @Cacheable({
+ *   key: 'app:config',
+ *   dependencies: [
+ *     new FileDependency('./config/app.json')
+ *   ]
+ * })
+ * async getConfig() { }
+ * ```
+ */
 export declare class FileDependency implements CacheDependency {
     private readonly filePath;
     constructor(filePath: string | ((...args: any[]) => string));
@@ -13,5 +42,8 @@ export declare class FileDependency implements CacheDependency {
         mtime: number;
         size: number;
     } | null): Promise<boolean>;
+    /**
+     * Resolve the file path (handle dynamic paths)
+     */
     private resolveFilePath;
 }

package/cache/dependencies/file.dependency.js

@@ -11,6 +11,35 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FileDependency = void 0;
 const node_fs_1 = require("node:fs");
+/**
+ * File-based cache dependency
+ *
+ * This dependency monitors file modification time. When the file is modified,
+ * the cache becomes invalid.
+ *
+ * Useful for configuration files, templates, or other file-based resources.
+ *
+ * @example
+ * ```typescript
+ * // Cache template, invalidate when template file changes
+ * @Cacheable({
+ *   key: (name) => `template:${name}`,
+ *   dependencies: [
+ *     new FileDependency((name) => `./templates/${name}.html`)
+ *   ]
+ * })
+ * async getTemplate(name: string) { }
+ *
+ * // Cache config, invalidate when config file changes
+ * @Cacheable({
+ *   key: 'app:config',
+ *   dependencies: [
+ *     new FileDependency('./config/app.json')
+ *   ]
+ * })
+ * async getConfig() { }
+ * ```
+ */
 class FileDependency {
     constructor(filePath) {
         if (!filePath) {
@@ -42,15 +71,20 @@ class FileDependency {
         return __awaiter(this, void 0, void 0, function* () {
             try {
                 const currentData = yield this.getData();
+                // File path changed or mtime changed or size changed
                 return (currentData.path !== oldData.path ||
                     currentData.mtime !== oldData.mtime ||
                     currentData.size !== oldData.size);
             }
             catch (_a) {
+                // If we can't access file, consider it changed
                 return true;
             }
         });
     }
+    /**
+     * Resolve the file path (handle dynamic paths)
+     */
     resolveFilePath() {
         return __awaiter(this, void 0, void 0, function* () {
             if (typeof this.filePath === 'function') {

package/cache/dependencies/tag.dependency.d.ts

@@ -1,13 +1,49 @@
 import type { CacheDependency } from '../interfaces/cache-dependency.interface';
+/**
+ * Tag-based cache dependency
+ *
+ * This dependency allows you to invalidate multiple cache entries by tags.
+ * When a tag is invalidated, all cache entries depending on that tag become invalid.
+ *
+ * This is the most commonly used dependency type for managing related cache entries.
+ *
+ * @example
+ * ```typescript
+ * // Cache user list with tag dependency
+ * @Cacheable({
+ *   key: (tenantId) => `users:list:${tenantId}`,
+ *   dependencies: [new TagDependency(['user-list', `tenant:${tenantId}`])]
+ * })
+ * async getUserList(tenantId: string) { }
+ *
+ * // When creating a new user, invalidate the tag
+ * await cacheService.invalidateTags(['user-list']);
+ * ```
+ */
 export declare class TagDependency implements CacheDependency {
     private readonly tags;
     private static readonly PREFIX;
     private static tagVersions;
     constructor(tags: string[]);
+    /**
+     * Get current version of a tag
+     */
     static getTagVersion(tag: string): number;
+    /**
+     * Invalidate a tag (increment its version)
+     */
     static invalidateTag(tag: string): void;
+    /**
+     * Invalidate multiple tags
+     */
     static invalidateTags(tags: string[]): void;
+    /**
+     * Reset all tag versions (useful for testing)
+     */
     static resetAllTags(): void;
+    /**
+     * Get all tags and their versions
+     */
     static getAllTags(): Map<string, number>;
     getKey(): string;
     getData(): Promise<Record<string, number>>;

package/cache/dependencies/tag.dependency.js

@@ -10,6 +10,27 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TagDependency = void 0;
+/**
+ * Tag-based cache dependency
+ *
+ * This dependency allows you to invalidate multiple cache entries by tags.
+ * When a tag is invalidated, all cache entries depending on that tag become invalid.
+ *
+ * This is the most commonly used dependency type for managing related cache entries.
+ *
+ * @example
+ * ```typescript
+ * // Cache user list with tag dependency
+ * @Cacheable({
+ *   key: (tenantId) => `users:list:${tenantId}`,
+ *   dependencies: [new TagDependency(['user-list', `tenant:${tenantId}`])]
+ * })
+ * async getUserList(tenantId: string) { }
+ *
+ * // When creating a new user, invalidate the tag
+ * await cacheService.invalidateTags(['user-list']);
+ * ```
+ */
 class TagDependency {
     constructor(tags) {
         this.tags = tags;
@@ -17,21 +38,36 @@ class TagDependency {
             throw new Error('TagDependency requires at least one tag');
         }
     }
+    /**
+     * Get current version of a tag
+     */
     static getTagVersion(tag) {
         return this.tagVersions.get(tag) || 0;
     }
+    /**
+     * Invalidate a tag (increment its version)
+     */
     static invalidateTag(tag) {
         const currentVersion = this.tagVersions.get(tag) || 0;
         this.tagVersions.set(tag, currentVersion + 1);
     }
+    /**
+     * Invalidate multiple tags
+     */
     static invalidateTags(tags) {
         for (const tag of tags) {
             this.invalidateTag(tag);
         }
     }
+    /**
+     * Reset all tag versions (useful for testing)
+     */
     static resetAllTags() {
         this.tagVersions.clear();
     }
+    /**
+     * Get all tags and their versions
+     */
     static getAllTags() {
         return new Map(this.tagVersions);
     }

package/cache/dependencies/time.dependency.d.ts

@@ -1,4 +1,38 @@
 import type { CacheDependency } from '../interfaces/cache-dependency.interface';
+/**
+ * Time-based cache dependency
+ *
+ * This dependency invalidates cache after a specific duration.
+ * Unlike TTL which is checked on read, this is checked as a dependency.
+ *
+ * Useful for implementing complex time-based invalidation logic.
+ *
+ * @example
+ * ```typescript
+ * // Cache for 5 minutes
+ * @Cacheable({
+ *   key: 'daily:report',
+ *   dependencies: [
+ *     new TimeDependency(5 * 60 * 1000) // 5 minutes
+ *   ]
+ * })
+ * async getDailyReport() { }
+ *
+ * // Cache until midnight
+ * @Cacheable({
+ *   key: 'today:stats',
+ *   dependencies: [
+ *     new TimeDependency(() => {
+ *       const now = new Date();
+ *       const midnight = new Date(now);
+ *       midnight.setHours(24, 0, 0, 0);
+ *       return midnight.getTime() - now.getTime();
+ *     })
+ *   ]
+ * })
+ * async getTodayStats() { }
+ * ```
+ */
 export declare class TimeDependency implements CacheDependency {
     private readonly duration;
     private createdAt;
@@ -13,7 +47,16 @@ export declare class TimeDependency implements CacheDependency {
         duration: number;
     }): Promise<boolean>;
     reset(): Promise<void>;
+    /**
+     * Get remaining time in milliseconds
+     */
     getRemainingTime(): number;
+    /**
+     * Check if dependency has expired
+     */
     isExpired(): boolean;
+    /**
+     * Resolve duration value (handle dynamic duration)
+     */
     private resolveDuration;
 }

package/cache/dependencies/time.dependency.js

@@ -10,6 +10,40 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TimeDependency = void 0;
+/**
+ * Time-based cache dependency
+ *
+ * This dependency invalidates cache after a specific duration.
+ * Unlike TTL which is checked on read, this is checked as a dependency.
+ *
+ * Useful for implementing complex time-based invalidation logic.
+ *
+ * @example
+ * ```typescript
+ * // Cache for 5 minutes
+ * @Cacheable({
+ *   key: 'daily:report',
+ *   dependencies: [
+ *     new TimeDependency(5 * 60 * 1000) // 5 minutes
+ *   ]
+ * })
+ * async getDailyReport() { }
+ *
+ * // Cache until midnight
+ * @Cacheable({
+ *   key: 'today:stats',
+ *   dependencies: [
+ *     new TimeDependency(() => {
+ *       const now = new Date();
+ *       const midnight = new Date(now);
+ *       midnight.setHours(24, 0, 0, 0);
+ *       return midnight.getTime() - now.getTime();
+ *     })
+ *   ]
+ * })
+ * async getTodayStats() { }
+ * ```
+ */
 class TimeDependency {
     constructor(duration) {
         if (typeof duration !== 'number' && typeof duration !== 'function') {
@@ -48,15 +82,24 @@ class TimeDependency {
             this.createdAt = Date.now();
         });
     }
+    /**
+     * Get remaining time in milliseconds
+     */
     getRemainingTime() {
         const duration = this.resolveDuration();
         const elapsed = Date.now() - this.createdAt;
         const remaining = duration - elapsed;
         return Math.max(0, remaining);
     }
+    /**
+     * Check if dependency has expired
+     */
     isExpired() {
         return this.getRemainingTime() === 0;
     }
+    /**
+     * Resolve duration value (handle dynamic duration)
+     */
     resolveDuration() {
         if (typeof this.duration === 'function') {
             const value = this.duration();

package/cache/examples/basic-usage.d.ts

@@ -1,3 +1,6 @@
+/**
+ * 基础缓存使用示例
+ */
 import { CacheService } from '../index';
 interface User {
     id: string;
@@ -25,6 +28,9 @@ declare class UserRepository {
 declare class PostRepository {
     findByAuthor(authorId: string): Promise<Post[]>;
 }
+/**
+ * 用户服务示例
+ */
 export declare class UserService {
     private cacheService;
     private userRepository;
@@ -39,6 +45,9 @@ export declare class UserService {
     cacheLargeData(id: string): Promise<void>;
     getLargeData(id: string): Promise<any>;
 }
+/**
+ * 文章服务示例 - 展示依赖使用
+ */
 export declare class PostService {
     private cacheService;
     private postRepository;
@@ -47,6 +56,9 @@ export declare class PostService {
     getFeaturedPosts(): Promise<Post[]>;
     private getConfigVersion;
 }
+/**
+ * 缓存统计和监控示例
+ */
 export declare class CacheMonitoringService {
     private cacheService;
     constructor(cacheService: CacheService);
@@ -54,5 +66,8 @@ export declare class CacheMonitoringService {
     resetStats(): void;
     startMonitoring(intervalMs?: number): void;
 }
+/**
+ * 使用示例
+ */
 declare function demonstrateCacheUsage(): Promise<void>;
 export { demonstrateCacheUsage };

package/cache/examples/basic-usage.js

@@ -1,4 +1,7 @@
 "use strict";
+/**
+ * 基础缓存使用示例
+ */
 var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
     var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
     if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
@@ -22,16 +25,18 @@ exports.CacheMonitoringService = exports.PostService = exports.UserService = voi
 exports.demonstrateCacheUsage = demonstrateCacheUsage;
 const common_1 = require("@nestjs/common");
 const index_1 = require("../index");
+// 模拟的仓库类
 class UserRepository {
     findOne(id) {
         return __awaiter(this, void 0, void 0, function* () {
+            // 模拟数据库查询
             console.log(`[DB] 查询用户 ${id}`);
             return {
                 id,
                 name: `User ${id}`,
                 email: `user${id}@example.com`,
                 profile: {
-                    bio: `这是用户 ${id} 的个人简介`.repeat(10),
+                    bio: `这是用户 ${id} 的个人简介`.repeat(10), // 长文本，用于测试压缩
                     avatar: `avatar_${id}.jpg`,
                 },
             };
@@ -80,37 +85,45 @@ class PostRepository {
                 .map((_, i) => ({
                 id: `post_${authorId}_${i}`,
                 title: `文章 ${i}`,
-                content: `这是文章 ${i} 的内容`.repeat(15),
+                content: `这是文章 ${i} 的内容`.repeat(15), // 长内容，用于测试压缩
                 authorId,
                 createdAt: new Date(),
             }));
         });
     }
 }
+/**
+ * 用户服务示例
+ */
 let UserService = class UserService {
     constructor(cacheService, userRepository) {
         this.cacheService = cacheService;
         this.userRepository = userRepository;
     }
+    // 基础缓存使用
     getUser(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.cacheService.getOrSet(`user:${id}`, () => this.userRepository.findOne(id), { ttl: 300000 });
         });
     }
+    // 使用装饰器缓存
     getUserProfile(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.userRepository.findOne(id);
         });
     }
+    // 条件缓存 - 不缓存管理员用户
     getUserData(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.userRepository.findOne(id);
         });
     }
+    // 批量获取用户
     getUsersBatch(ids) {
         return __awaiter(this, void 0, void 0, function* () {
             const keys = ids.map((id) => `user:${id}`);
             const cachedUsers = yield this.cacheService.mget(keys);
+            // 找出缓存中没有的用户
             const uncachedIds = [];
             const result = [];
             cachedUsers.forEach((user, index) => {
@@ -121,8 +134,10 @@ let UserService = class UserService {
                     uncachedIds.push(ids[index]);
                 }
             });
+            // 批量查询未缓存的用户
             if (uncachedIds.length > 0) {
                 const newUsers = yield this.userRepository.findMany(uncachedIds);
+                // 批量设置缓存
                 const cacheItems = newUsers.map((user) => ({
                     key: `user:${user.id}`,
                     value: user,
@@ -133,22 +148,26 @@ let UserService = class UserService {
             return result;
         });
     }
+    // 更新用户并缓存
     updateUser(id, data) {
         return __awaiter(this, void 0, void 0, function* () {
             const updatedUser = yield this.userRepository.save(Object.assign({ id }, data));
             return updatedUser;
         });
     }
+    // 删除用户并清除缓存
     deleteUser(id) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.userRepository.delete(id);
         });
     }
+    // 使用标签失效
     invalidateAllProfiles() {
         return __awaiter(this, void 0, void 0, function* () {
             console.log('清除所有用户资料缓存');
         });
     }
+    // 缓存大数据（测试压缩）
     cacheLargeData(id) {
         return __awaiter(this, void 0, void 0, function* () {
             const largeData = {
@@ -173,11 +192,13 @@ let UserService = class UserService {
                     averageRating: (Math.random() * 5).toFixed(2),
                 },
             };
+            // 这个数据会被自动压缩，因为大于 1KB
             yield this.cacheService.set(`user:${id}:large-data`, largeData, {
-                ttl: 3600000,
+                ttl: 3600000, // 1小时
             });
         });
     }
+    // 获取大数据
     getLargeData(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.cacheService.get(`user:${id}:large-data`);
@@ -188,7 +209,7 @@ exports.UserService = UserService;
 __decorate([
     (0, index_1.Cacheable)({
         key: (id) => `user:${id}:profile`,
-        ttl: 600000,
+        ttl: 600000, // 10分钟
         dependencies: [new index_1.TagDependency(['user-profile'])],
     }),
     __metadata("design:type", Function),
@@ -235,18 +256,24 @@ exports.UserService = UserService = __decorate([
     __metadata("design:paramtypes", [index_1.CacheService,
         UserRepository])
 ], UserService);
+/**
+ * 文章服务示例 - 展示依赖使用
+ */
 let PostService = class PostService {
     constructor(cacheService, postRepository) {
         this.cacheService = cacheService;
         this.postRepository = postRepository;
     }
+    // 使用数据库依赖 - 当用户表更新时，相关文章缓存会自动失效
     getPostsByAuthor(authorId) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.postRepository.findByAuthor(authorId);
         });
     }
+    // 使用回调依赖 - 基于配置版本
     getFeaturedPosts() {
         return __awaiter(this, void 0, void 0, function* () {
+            // 模拟获取推荐文章
             console.log('[DB] 获取推荐文章');
             return Array(10)
                 .fill(null)
@@ -261,6 +288,7 @@ let PostService = class PostService {
     }
     getConfigVersion() {
         return __awaiter(this, void 0, void 0, function* () {
+            // 模拟获取配置版本
             return '1.0.0';
         });
     }
@@ -269,7 +297,7 @@ exports.PostService = PostService;
 __decorate([
     (0, index_1.Cacheable)({
         key: (authorId) => `posts:by-author:${authorId}`,
-        ttl: 600000,
+        ttl: 600000, // 10分钟
         dependencies: [
             new index_1.DbDependency('SELECT updated_at FROM users WHERE id = ?', (authorId) => [authorId]),
         ],
@@ -281,10 +309,11 @@ __decorate([
 __decorate([
     (0, index_1.Cacheable)({
         key: 'posts:featured',
-        ttl: 1800000,
+        ttl: 1800000, // 30分钟
         dependencies: [
             new index_1.CallbackDependency(() => __awaiter(void 0, void 0, void 0, function* () {
-                return yield 'v1.0.0';
+                // 检查配置版本，如果配置改变则失效缓存
+                return yield 'v1.0.0'; // 简化为固定值
             })),
         ],
     }),
@@ -297,10 +326,14 @@ exports.PostService = PostService = __decorate([
     __metadata("design:paramtypes", [index_1.CacheService,
         PostRepository])
 ], PostService);
+/**
+ * 缓存统计和监控示例
+ */
 let CacheMonitoringService = class CacheMonitoringService {
     constructor(cacheService) {
         this.cacheService = cacheService;
     }
+    // 获取缓存统计信息
     getCacheStats() {
         const stats = this.cacheService.getStats();
         console.log('=== 缓存统计信息 ===');
@@ -317,13 +350,16 @@ let CacheMonitoringService = class CacheMonitoringService {
         }
         return stats;
     }
+    // 重置统计
     resetStats() {
         this.cacheService.resetStats();
         console.log('缓存统计已重置');
     }
+    // 定期监控
     startMonitoring(intervalMs = 60000) {
         setInterval(() => {
             const stats = this.getCacheStats();
+            // 如果命中率过低，发出警告
             if (stats.hitRate < 0.7) {
                 console.warn(`⚠️ 缓存命中率过低: ${(stats.hitRate * 100).toFixed(2)}%`);
             }
@@ -336,38 +372,56 @@ exports.CacheMonitoringService = CacheMonitoringService = __decorate([
     (0, common_1.Injectable)(),
     __metadata("design:paramtypes", [index_1.CacheService])
 ], CacheMonitoringService);
+/**
+ * 使用示例
+ */
 function demonstrateCacheUsage() {
     return __awaiter(this, void 0, void 0, function* () {
-        const userService = new UserService(new index_1.CacheService({}, {}, {}, true, 1024), new UserRepository());
+        // 注意：在实际应用中，这些服务会通过依赖注入获得
+        const userService = new UserService(new index_1.CacheService(
+        // 这些参数在实际应用中会通过模块配置自动注入
+        {}, // CLS Provider
+        {}, // Memory Provider
+        {}, // Redis Provider
+        true, // 启用压缩
+        1024), new UserRepository());
         const postService = new PostService(new index_1.CacheService({}, {}, {}, true, 1024), new PostRepository());
         const monitoringService = new CacheMonitoringService(new index_1.CacheService({}, {}, {}, true, 1024));
         console.log('🚀 开始缓存演示...\n');
         try {
+            // 1. 基础缓存演示
             console.log('1. 基础缓存使用:');
             const user1 = yield userService.getUser('1');
             console.log(`获取用户: ${user1.name}`);
+            // 第二次获取应该从缓存获取
             const user1Cached = yield userService.getUser('1');
             console.log(`从缓存获取用户: ${user1Cached.name}\n`);
+            // 2. 装饰器缓存演示
             console.log('2. 装饰器缓存:');
             const profile = yield userService.getUserProfile('2');
             console.log(`获取用户资料: ${profile.name}`);
             const profileCached = yield userService.getUserProfile('2');
             console.log(`从缓存获取用户资料: ${profileCached.name}\n`);
+            // 3. 批量操作演示
             console.log('3. 批量操作:');
             const users = yield userService.getUsersBatch(['1', '2', '3', '4', '5']);
             console.log(`批量获取 ${users.length} 个用户\n`);
+            // 4. 大数据压缩演示
             console.log('4. 大数据压缩:');
             yield userService.cacheLargeData('1');
             console.log('缓存大数据完成（应该自动压缩）');
             const largeData = yield userService.getLargeData('1');
             console.log(`获取大数据: 用户 ${largeData.user.name}, 文章数 ${largeData.posts.length}\n`);
+            // 5. 依赖系统演示
             console.log('5. 依赖系统:');
             const posts = yield postService.getPostsByAuthor('1');
             console.log(`获取作者文章: ${posts.length} 篇`);
             const featuredPosts = yield postService.getFeaturedPosts();
             console.log(`获取推荐文章: ${featuredPosts.length} 篇\n`);
+            // 6. 缓存统计
             console.log('6. 缓存统计:');
             monitoringService.getCacheStats();
+            // 7. 缓存失效演示
             console.log('\n7. 缓存失效:');
             yield userService.invalidateAllProfiles();
             console.log('已清除所有用户资料缓存');