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

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

@@ -1,6 +1,17 @@
 import type Redis from 'ioredis';
 import { BaseCacheProvider } from './base-cache.provider';
+/**
+ * Token for injecting Redis client
+ */
 export declare const REDIS_CLIENT: unique symbol;
+/**
+ * Redis cache provider using ioredis
+ *
+ * This is the L3 cache layer - distributed caching using Redis.
+ * Data is persisted in Redis and shared across all processes/servers.
+ *
+ * Slowest but most persistent and widely shared cache layer.
+ */
 export declare class RedisCacheProvider extends BaseCacheProvider {
     private readonly redis?;
     private readonly keyPrefix;
@@ -12,12 +23,27 @@ export declare class RedisCacheProvider extends BaseCacheProvider {
     deletePattern(pattern: string): Promise<number>;
     clear(): Promise<void>;
     has(key: string): Promise<boolean>;
+    /**
+     * Batch get using Redis MGET
+     */
     mget<T>(keys: string[]): Promise<(T | null)[]>;
+    /**
+     * Batch set using Redis pipeline
+     */
     mset(items: Array<{
         key: string;
         value: any;
     }>, ttl?: number): Promise<void>;
+    /**
+     * Check if Redis client is available
+     */
     isAvailable(): boolean;
+    /**
+     * Get Redis client (for advanced usage)
+     */
     getClient(): Redis | undefined;
+    /**
+     * Get full key with prefix
+     */
     private getFullKey;
 }

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

@@ -24,7 +24,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.RedisCacheProvider = exports.REDIS_CLIENT = void 0;
 const common_1 = require("@nestjs/common");
 const base_cache_provider_1 = require("./base-cache.provider");
+/**
+ * Token for injecting Redis client
+ */
 exports.REDIS_CLIENT = Symbol('REDIS_CLIENT');
+/**
+ * Redis cache provider using ioredis
+ *
+ * This is the L3 cache layer - distributed caching using Redis.
+ * Data is persisted in Redis and shared across all processes/servers.
+ *
+ * Slowest but most persistent and widely shared cache layer.
+ */
 let RedisCacheProvider = class RedisCacheProvider extends base_cache_provider_1.BaseCacheProvider {
     constructor(redis) {
         super();
@@ -65,6 +76,7 @@ let RedisCacheProvider = class RedisCacheProvider extends base_cache_provider_1.
                 const fullKey = this.getFullKey(key);
                 const serialized = JSON.stringify(value);
                 if (ttl && ttl > 0) {
+                    // TTL in milliseconds, Redis expects seconds
                     yield this.redis.setex(fullKey, Math.ceil(ttl / 1000), serialized);
                 }
                 else {
@@ -102,6 +114,7 @@ let RedisCacheProvider = class RedisCacheProvider extends base_cache_provider_1.
                 const fullPattern = this.getFullKey(pattern);
                 let cursor = '0';
                 let deletedCount = 0;
+                // Use SCAN to find matching keys (more efficient than KEYS)
                 do {
                     const [nextCursor, keys] = yield this.redis.scan(cursor, 'MATCH', fullPattern, 'COUNT', 100);
                     cursor = nextCursor;
@@ -124,6 +137,7 @@ let RedisCacheProvider = class RedisCacheProvider extends base_cache_provider_1.
                 return;
             }
             try {
+                // Clear all keys with our prefix
                 yield this.deletePattern('*');
             }
             catch (error) {
@@ -146,6 +160,9 @@ let RedisCacheProvider = class RedisCacheProvider extends base_cache_provider_1.
             }
         });
     }
+    /**
+     * Batch get using Redis MGET
+     */
     mget(keys) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!this.redis || keys.length === 0) {
@@ -172,6 +189,9 @@ let RedisCacheProvider = class RedisCacheProvider extends base_cache_provider_1.
             }
         });
     }
+    /**
+     * Batch set using Redis pipeline
+     */
     mset(items, ttl) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!this.redis || items.length === 0) {
@@ -196,12 +216,21 @@ let RedisCacheProvider = class RedisCacheProvider extends base_cache_provider_1.
             }
         });
     }
+    /**
+     * Check if Redis client is available
+     */
     isAvailable() {
         return !!this.redis && this.redis.status === 'ready';
     }
+    /**
+     * Get Redis client (for advanced usage)
+     */
     getClient() {
         return this.redis;
     }
+    /**
+     * Get full key with prefix
+     */
     getFullKey(key) {
         return `${this.keyPrefix}${key}`;
     }

package/cache/utils/dependency-manager.util.d.ts

@@ -1,15 +1,67 @@
 import type { CacheDependency, DependencyData } from '../interfaces';
+/**
+ * Wrapper for cached value with dependency data
+ */
 export interface CachedValueWithDependencies<T> {
     value: T;
     dependencies?: DependencyData[];
     cachedAt: number;
 }
+/**
+ * Utility class for managing cache dependencies
+ */
 export declare class DependencyManager {
+    /**
+     * Wrap a value with its dependencies
+     *
+     * @param value - The value to cache
+     * @param dependencies - Array of dependencies
+     * @returns Wrapped value with dependency data
+     */
     static wrapWithDependencies<T>(value: T, dependencies?: CacheDependency[]): Promise<CachedValueWithDependencies<T>>;
+    /**
+     * Capture current state of all dependencies
+     *
+     * @param dependencies - Array of dependencies
+     * @returns Array of dependency data snapshots
+     */
     static captureDependencies(dependencies: CacheDependency[]): Promise<DependencyData[]>;
+    /**
+     * Check if any dependencies have changed
+     *
+     * @param dependencies - Current dependencies
+     * @param cachedDependencies - Previously captured dependency data
+     * @returns true if any dependency has changed
+     */
     static areDependenciesChanged(dependencies: CacheDependency[], cachedDependencies?: DependencyData[]): Promise<boolean>;
+    /**
+     * Unwrap cached value and validate dependencies
+     *
+     * @param wrapped - Wrapped cached value
+     * @param dependencies - Current dependencies to check
+     * @returns Unwrapped value if valid, null if dependencies changed
+     */
     static unwrapAndValidate<T>(wrapped: CachedValueWithDependencies<T> | null, dependencies?: CacheDependency[]): Promise<T | null>;
+    /**
+     * Get which dependencies have changed
+     *
+     * @param dependencies - Current dependencies
+     * @param cachedDependencies - Previously captured dependency data
+     * @returns Array of changed dependency keys
+     */
     static getChangedDependencies(dependencies: CacheDependency[], cachedDependencies?: DependencyData[]): Promise<string[]>;
+    /**
+     * Serialize dependencies for storage
+     *
+     * @param dependencies - Dependency data
+     * @returns Serialized string
+     */
     static serializeDependencies(dependencies: DependencyData[]): string;
+    /**
+     * Deserialize dependencies from storage
+     *
+     * @param serialized - Serialized string
+     * @returns Dependency data array
+     */
     static deserializeDependencies(serialized: string): DependencyData[];
 }

package/cache/utils/dependency-manager.util.js

@@ -10,7 +10,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DependencyManager = void 0;
+/**
+ * Utility class for managing cache dependencies
+ */
 class DependencyManager {
+    /**
+     * Wrap a value with its dependencies
+     *
+     * @param value - The value to cache
+     * @param dependencies - Array of dependencies
+     * @returns Wrapped value with dependency data
+     */
     static wrapWithDependencies(value, dependencies) {
         return __awaiter(this, void 0, void 0, function* () {
             const wrapped = {
@@ -23,6 +33,12 @@ class DependencyManager {
             return wrapped;
         });
     }
+    /**
+     * Capture current state of all dependencies
+     *
+     * @param dependencies - Array of dependencies
+     * @returns Array of dependency data snapshots
+     */
     static captureDependencies(dependencies) {
         return __awaiter(this, void 0, void 0, function* () {
             const results = [];
@@ -36,6 +52,7 @@ class DependencyManager {
                     });
                 }
                 catch (error) {
+                    // Store error state
                     results.push({
                         key: dep.getKey(),
                         data: {
@@ -48,44 +65,67 @@ class DependencyManager {
             return results;
         });
     }
+    /**
+     * Check if any dependencies have changed
+     *
+     * @param dependencies - Current dependencies
+     * @param cachedDependencies - Previously captured dependency data
+     * @returns true if any dependency has changed
+     */
     static areDependenciesChanged(dependencies, cachedDependencies) {
         return __awaiter(this, void 0, void 0, function* () {
+            // No dependencies means never changed
             if (!dependencies || dependencies.length === 0) {
                 return false;
             }
+            // No cached dependency data means changed (first time)
             if (!cachedDependencies || cachedDependencies.length === 0) {
                 return true;
             }
+            // Different number of dependencies means changed
             if (dependencies.length !== cachedDependencies.length) {
                 return true;
             }
+            // Check each dependency
             for (let i = 0; i < dependencies.length; i++) {
                 const dep = dependencies[i];
                 const cached = cachedDependencies[i];
+                // Key mismatch means dependencies changed
                 if (dep.getKey() !== cached.key) {
                     return true;
                 }
                 try {
+                    // Check if this dependency has changed
                     const changed = yield dep.isChanged(cached.data);
                     if (changed) {
                         return true;
                     }
                 }
                 catch (_a) {
+                    // If check fails, consider it changed to be safe
                     return true;
                 }
             }
             return false;
         });
     }
+    /**
+     * Unwrap cached value and validate dependencies
+     *
+     * @param wrapped - Wrapped cached value
+     * @param dependencies - Current dependencies to check
+     * @returns Unwrapped value if valid, null if dependencies changed
+     */
     static unwrapAndValidate(wrapped, dependencies) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!wrapped) {
                 return null;
             }
+            // No dependencies to check, return value
             if (!dependencies || dependencies.length === 0) {
                 return wrapped.value;
             }
+            // Check if dependencies have changed
             const changed = yield this.areDependenciesChanged(dependencies, wrapped.dependencies);
             if (changed) {
                 return null;
@@ -93,6 +133,13 @@ class DependencyManager {
             return wrapped.value;
         });
     }
+    /**
+     * Get which dependencies have changed
+     *
+     * @param dependencies - Current dependencies
+     * @param cachedDependencies - Previously captured dependency data
+     * @returns Array of changed dependency keys
+     */
     static getChangedDependencies(dependencies, cachedDependencies) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!dependencies || dependencies.length === 0) {
@@ -121,6 +168,12 @@ class DependencyManager {
             return changed;
         });
     }
+    /**
+     * Serialize dependencies for storage
+     *
+     * @param dependencies - Dependency data
+     * @returns Serialized string
+     */
     static serializeDependencies(dependencies) {
         try {
             return JSON.stringify(dependencies);
@@ -129,6 +182,12 @@ class DependencyManager {
             return '[]';
         }
     }
+    /**
+     * Deserialize dependencies from storage
+     *
+     * @param serialized - Serialized string
+     * @returns Dependency data array
+     */
     static deserializeDependencies(serialized) {
         try {
             return JSON.parse(serialized);

package/cache/utils/key-generator.util.d.ts

@@ -1,10 +1,52 @@
 import type { CacheKeyOptions } from '../interfaces';
+/**
+ * Utility class for generating cache keys
+ */
 export declare class KeyGenerator {
+    /**
+     * Generate cache key from options and method arguments
+     *
+     * @param options - Cache key options
+     * @param args - Method arguments
+     * @returns Generated cache key
+     */
     static generate(options: CacheKeyOptions, args: any[]): string;
+    /**
+     * Generate key from method arguments
+     *
+     * @param args - Method arguments
+     * @returns Serialized key
+     */
     static generateFromArgs(args: any[]): string;
+    /**
+     * Normalize key (remove invalid characters, enforce length limits)
+     *
+     * @param key - Raw key
+     * @param maxLength - Maximum key length (default 250)
+     * @returns Normalized key
+     */
     static normalize(key: string, maxLength?: number): string;
+    /**
+     * Add namespace to key
+     *
+     * @param key - Original key
+     * @param namespace - Namespace
+     * @returns Namespaced key
+     */
     static addNamespace(key: string, namespace?: string): string;
+    /**
+     * Generate hash code for a string
+     *
+     * @param str - Input string
+     * @returns Hash code as string
+     */
     static hashCode(str: string): string;
+    /**
+     * Parse pattern into segments for matching
+     *
+     * @param pattern - Pattern with wildcards
+     * @returns Pattern segments
+     */
     static parsePattern(pattern: string): {
         prefix: string;
         suffix: string;

package/cache/utils/key-generator.util.js

@@ -1,60 +1,112 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.KeyGenerator = void 0;
+/**
+ * Utility class for generating cache keys
+ */
 class KeyGenerator {
+    /**
+     * Generate cache key from options and method arguments
+     *
+     * @param options - Cache key options
+     * @param args - Method arguments
+     * @returns Generated cache key
+     */
     static generate(options, args) {
         let key;
         if (typeof options.key === 'function') {
+            // Dynamic key generation using function
             key = options.key(...args);
         }
         else if (typeof options.key === 'string') {
+            // Static key
             key = options.key;
         }
         else if (options.includeAllArgs) {
+            // Auto-generate key from all arguments
             key = this.generateFromArgs(args);
         }
         else {
+            // Default: use first argument as key
             key = args.length > 0 ? String(args[0]) : 'default';
         }
+        // Add prefix if specified
         if (options.prefix) {
             key = `${options.prefix}${key}`;
         }
         return key;
     }
+    /**
+     * Generate key from method arguments
+     *
+     * @param args - Method arguments
+     * @returns Serialized key
+     */
     static generateFromArgs(args) {
         if (args.length === 0) {
             return 'default';
         }
         try {
+            // Serialize arguments to JSON
             return JSON.stringify(args);
         }
         catch (_a) {
+            // Fallback to string concatenation
             return args.map((arg) => String(arg)).join(':');
         }
     }
+    /**
+     * Normalize key (remove invalid characters, enforce length limits)
+     *
+     * @param key - Raw key
+     * @param maxLength - Maximum key length (default 250)
+     * @returns Normalized key
+     */
     static normalize(key, maxLength = 250) {
+        // Remove or replace invalid characters
         let normalized = key.replace(/[\s\n\r\t]/g, '_');
+        // Enforce length limit
         if (normalized.length > maxLength) {
+            // Use hash for long keys
             const hash = this.hashCode(normalized);
             normalized = normalized.substring(0, maxLength - 10) + '_' + hash;
         }
         return normalized;
     }
+    /**
+     * Add namespace to key
+     *
+     * @param key - Original key
+     * @param namespace - Namespace
+     * @returns Namespaced key
+     */
     static addNamespace(key, namespace) {
         if (!namespace) {
             return key;
         }
         return `${namespace}:${key}`;
     }
+    /**
+     * Generate hash code for a string
+     *
+     * @param str - Input string
+     * @returns Hash code as string
+     */
     static hashCode(str) {
         let hash = 0;
         for (let i = 0; i < str.length; i++) {
             const char = str.charCodeAt(i);
             hash = (hash << 5) - hash + char;
-            hash = hash & hash;
+            hash = hash & hash; // Convert to 32bit integer
         }
         return Math.abs(hash).toString(36);
     }
+    /**
+     * Parse pattern into segments for matching
+     *
+     * @param pattern - Pattern with wildcards
+     * @returns Pattern segments
+     */
     static parsePattern(pattern) {
         const wildcardIndex = pattern.indexOf('*');
         if (wildcardIndex === -1) {

package/common/abstract.entity.d.ts

@@ -1,9 +1,23 @@
 import type { AbstractDto, AbstractTranslationDto } from './dto/abstract.dto';
 import { LanguageCode } from '../constants';
+/**
+ * Abstract DTO-able Entity
+ *
+ * @description Base class that provides toDto functionality without any database fields.
+ * Use this for view entities or other entities that don't need createdAt/updatedAt fields.
+ */
 export declare abstract class AbstractDtoEntity<DTO, O = never> {
     translations?: AbstractTranslationEntity[];
     toDto(options?: O): DTO;
 }
+/**
+ * Abstract Entity
+ *
+ * @description This class is an abstract class for all entities.
+ * It's experimental and recommended using it only in microservice architecture,
+ * otherwise just delete and use your own entity.
+ * Extends AbstractDtoEntity and adds createdAt/updatedAt timestamp fields.
+ */
 export declare abstract class AbstractBaseEntity<DTO, O> extends AbstractDtoEntity<DTO, O> {
     createdAt: Date;
     updatedAt: Date;

package/common/abstract.entity.js

@@ -14,6 +14,12 @@ const typeorm_1 = require("typeorm");
 const decorators_1 = require("../decorators");
 const constants_1 = require("../constants");
 const uuid_1 = require("uuid");
+/**
+ * Abstract DTO-able Entity
+ *
+ * @description Base class that provides toDto functionality without any database fields.
+ * Use this for view entities or other entities that don't need createdAt/updatedAt fields.
+ */
 class AbstractDtoEntity {
     toDto(options) {
         const dtoClass = Object.getPrototypeOf(this).dtoClass;
@@ -24,6 +30,14 @@ class AbstractDtoEntity {
     }
 }
 exports.AbstractDtoEntity = AbstractDtoEntity;
+/**
+ * Abstract Entity
+ *
+ * @description This class is an abstract class for all entities.
+ * It's experimental and recommended using it only in microservice architecture,
+ * otherwise just delete and use your own entity.
+ * Extends AbstractDtoEntity and adds createdAt/updatedAt timestamp fields.
+ */
 class AbstractBaseEntity extends AbstractDtoEntity {
 }
 exports.AbstractBaseEntity = AbstractBaseEntity;