@nest-boot/redis 7.0.1 → 7.0.2

package/dist/index.d.ts

@@ -1,4 +1,2 @@
-import { type RedisOptions } from "ioredis";
-import { Redis } from "./redis";
 export * from "./redis.module";
-export { Redis, type RedisOptions };
+export * from "./utils/load-config-from-env.util";

package/dist/index.js

@@ -14,8 +14,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Redis = void 0;
-const redis_1 = require("./redis");
-Object.defineProperty(exports, "Redis", { enumerable: true, get: function () { return redis_1.Redis; } });
 __exportStar(require("./redis.module"), exports);
+__exportStar(require("./utils/load-config-from-env.util"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAEA,mCAAgC;AAIvB,sFAJA,aAAK,OAIA;AAFd,iDAA+B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iDAA+B;AAC/B,oEAAkD"}

package/dist/redis.module-definition.d.ts

@@ -1,7 +1,5 @@
 import { type RedisOptions } from "ioredis";
-export declare const ConfigurableModuleClass: import("@nestjs/common").ConfigurableModuleCls<RedisOptions, "register", "create", {
-    isGlobal: boolean;
-}>, MODULE_OPTIONS_TOKEN: string | symbol, OPTIONS_TYPE: import("ioredis").CommonRedisOptions & import("ioredis").SentinelConnectionOptions & Partial<{
+export declare const ConfigurableModuleClass: import("@nestjs/common").ConfigurableModuleCls<RedisOptions, "register", "create", {}>, MODULE_OPTIONS_TOKEN: string | symbol, OPTIONS_TYPE: import("ioredis").CommonRedisOptions & import("ioredis").SentinelConnectionOptions & Partial<{
     port: number;
     host?: string | undefined | undefined;
     family?: number | undefined | undefined;
@@ -10,8 +8,4 @@ export declare const ConfigurableModuleClass: import("@nestjs/common").Configura
 }> & {
     disconnectTimeout?: number;
     tls?: import("tls").ConnectionOptions;
-} & Partial<{
-    isGlobal: boolean;
-}>, ASYNC_OPTIONS_TYPE: import("@nestjs/common").ConfigurableModuleAsyncOptions<RedisOptions, "create"> & Partial<{
-    isGlobal: boolean;
-}>;
+} & Partial<{}>, ASYNC_OPTIONS_TYPE: import("@nestjs/common").ConfigurableModuleAsyncOptions<RedisOptions, "create"> & Partial<{}>;

package/dist/redis.module-definition.js

@@ -3,12 +3,5 @@ var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ASYNC_OPTIONS_TYPE = exports.OPTIONS_TYPE = exports.MODULE_OPTIONS_TOKEN = exports.ConfigurableModuleClass = void 0;
 const common_1 = require("@nestjs/common");
-_a = new common_1.ConfigurableModuleBuilder()
-    .setExtras({
-    isGlobal: false,
-}, (definition, extras) => ({
-    ...definition,
-    global: extras.isGlobal,
-}))
-    .build(), exports.ConfigurableModuleClass = _a.ConfigurableModuleClass, exports.MODULE_OPTIONS_TOKEN = _a.MODULE_OPTIONS_TOKEN, exports.OPTIONS_TYPE = _a.OPTIONS_TYPE, exports.ASYNC_OPTIONS_TYPE = _a.ASYNC_OPTIONS_TYPE;
+_a = new common_1.ConfigurableModuleBuilder().build(), exports.ConfigurableModuleClass = _a.ConfigurableModuleClass, exports.MODULE_OPTIONS_TOKEN = _a.MODULE_OPTIONS_TOKEN, exports.OPTIONS_TYPE = _a.OPTIONS_TYPE, exports.ASYNC_OPTIONS_TYPE = _a.ASYNC_OPTIONS_TYPE;
 //# sourceMappingURL=redis.module-definition.js.map

package/dist/redis.module-definition.js.map

@@ -1 +1 @@
-{"version":3,"file":"redis.module-definition.js","sourceRoot":"","sources":["../src/redis.module-definition.ts"],"names":[],"mappings":";;;;AAAA,2CAA2D;AAG9C,KAKT,IAAI,kCAAyB,EAAgB;KAC9C,SAAS,CACR;IACE,QAAQ,EAAE,KAAK;CAChB,EACD,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;IACvB,GAAG,UAAU;IACb,MAAM,EAAE,MAAM,CAAC,QAAQ;CACxB,CAAC,CACH;KACA,KAAK,EAAE,EAdR,+BAAuB,+BACvB,4BAAoB,4BACpB,oBAAY,oBACZ,0BAAkB,yBAWT"}
+{"version":3,"file":"redis.module-definition.js","sourceRoot":"","sources":["../src/redis.module-definition.ts"],"names":[],"mappings":";;;;AAAA,2CAA2D;AAG9C,KAKT,IAAI,kCAAyB,EAAgB,CAAC,KAAK,EAAE,EAJvD,+BAAuB,+BACvB,4BAAoB,4BACpB,oBAAY,oBACZ,0BAAkB,yBACsC"}

package/dist/redis.module.d.ts

@@ -1,8 +1,70 @@
-import { type OnApplicationShutdown } from "@nestjs/common";
-import { Redis } from "./redis";
-import { ConfigurableModuleClass } from "./redis.module-definition";
+import { type DynamicModule, type OnApplicationShutdown } from "@nestjs/common";
+import Redis from "ioredis";
+import { ASYNC_OPTIONS_TYPE, ConfigurableModuleClass, OPTIONS_TYPE } from "./redis.module-definition";
+/**
+ * Module that provides Redis connection using ioredis.
+ *
+ * The module automatically loads configuration from environment variables if not provided:
+ * - `REDIS_URL`: Full Redis connection URL (e.g., redis://user:pass@host:6379/0)
+ * - `REDIS_HOST`: Redis server hostname
+ * - `REDIS_PORT`: Redis server port
+ * - `REDIS_DB` or `REDIS_DATABASE`: Redis database number
+ * - `REDIS_USER` or `REDIS_USERNAME`: Redis username
+ * - `REDIS_PASS` or `REDIS_PASSWORD`: Redis password
+ * - `REDIS_TLS`: Enable TLS connection
+ *
+ * @example
+ * ```typescript
+ * import { RedisModule } from '@nest-boot/redis';
+ *
+ * @Module({
+ *   imports: [
+ *     RedisModule.register({
+ *       host: 'localhost',
+ *       port: 6379,
+ *       isGlobal: true,
+ *     }),
+ *   ],
+ * })
+ * export class AppModule {}
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Inject Redis client in your service
+ * import { Redis } from 'ioredis';
+ *
+ * @Injectable()
+ * export class CacheService {
+ *   constructor(private readonly redis: Redis) {}
+ *
+ *   async get(key: string): Promise<string | null> {
+ *     return this.redis.get(key);
+ *   }
+ * }
+ * ```
+ */
 export declare class RedisModule extends ConfigurableModuleClass implements OnApplicationShutdown {
     private readonly redis;
+    /**
+     * Registers the RedisModule with the given options.
+     * @param options - Redis connection options and isGlobal flag
+     * @returns Dynamic module configuration
+     */
+    static register(options: typeof OPTIONS_TYPE): DynamicModule;
+    /**
+     * Registers the RedisModule asynchronously with factory functions.
+     * @param options - Async configuration options
+     * @returns Dynamic module configuration
+     */
+    static registerAsync(options: typeof ASYNC_OPTIONS_TYPE): DynamicModule;
+    /**
+     * Creates an instance of RedisModule.
+     * @param redis - The Redis client instance
+     */
     constructor(redis: Redis);
+    /**
+     * Gracefully closes the Redis connection when the application shuts down.
+     */
     onApplicationShutdown(): Promise<void>;
 }

package/dist/redis.module.js

@@ -8,36 +8,106 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RedisModule = void 0;
 const common_1 = require("@nestjs/common");
-const redis_1 = require("./redis");
+const ioredis_1 = __importDefault(require("ioredis"));
 const redis_module_definition_1 = require("./redis.module-definition");
 const load_config_from_env_util_1 = require("./utils/load-config-from-env.util");
+/**
+ * Module that provides Redis connection using ioredis.
+ *
+ * The module automatically loads configuration from environment variables if not provided:
+ * - `REDIS_URL`: Full Redis connection URL (e.g., redis://user:pass@host:6379/0)
+ * - `REDIS_HOST`: Redis server hostname
+ * - `REDIS_PORT`: Redis server port
+ * - `REDIS_DB` or `REDIS_DATABASE`: Redis database number
+ * - `REDIS_USER` or `REDIS_USERNAME`: Redis username
+ * - `REDIS_PASS` or `REDIS_PASSWORD`: Redis password
+ * - `REDIS_TLS`: Enable TLS connection
+ *
+ * @example
+ * ```typescript
+ * import { RedisModule } from '@nest-boot/redis';
+ *
+ * @Module({
+ *   imports: [
+ *     RedisModule.register({
+ *       host: 'localhost',
+ *       port: 6379,
+ *       isGlobal: true,
+ *     }),
+ *   ],
+ * })
+ * export class AppModule {}
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Inject Redis client in your service
+ * import { Redis } from 'ioredis';
+ *
+ * @Injectable()
+ * export class CacheService {
+ *   constructor(private readonly redis: Redis) {}
+ *
+ *   async get(key: string): Promise<string | null> {
+ *     return this.redis.get(key);
+ *   }
+ * }
+ * ```
+ */
 let RedisModule = class RedisModule extends redis_module_definition_1.ConfigurableModuleClass {
+    /**
+     * Registers the RedisModule with the given options.
+     * @param options - Redis connection options and isGlobal flag
+     * @returns Dynamic module configuration
+     */
+    static register(options) {
+        return super.register(options);
+    }
+    /**
+     * Registers the RedisModule asynchronously with factory functions.
+     * @param options - Async configuration options
+     * @returns Dynamic module configuration
+     */
+    static registerAsync(options) {
+        return super.registerAsync(options);
+    }
+    /**
+     * Creates an instance of RedisModule.
+     * @param redis - The Redis client instance
+     */
     constructor(redis) {
         super();
         this.redis = redis;
     }
+    /**
+     * Gracefully closes the Redis connection when the application shuts down.
+     */
     async onApplicationShutdown() {
         await this.redis.quit();
     }
 };
 exports.RedisModule = RedisModule;
 exports.RedisModule = RedisModule = __decorate([
+    (0, common_1.Global)(),
     (0, common_1.Module)({
         providers: [
             {
-                provide: redis_1.Redis,
+                provide: ioredis_1.default,
                 inject: [{ token: redis_module_definition_1.MODULE_OPTIONS_TOKEN, optional: true }],
-                useFactory: (options = {}) => new redis_1.Redis({
+                useFactory: (options) => new ioredis_1.default({
                     ...(0, load_config_from_env_util_1.loadConfigFromEnv)(),
                     ...options,
                 }),
             },
         ],
-        exports: [redis_1.Redis],
+        exports: [ioredis_1.default],
     }),
-    __metadata("design:paramtypes", [redis_1.Redis])
+    __metadata("design:paramtypes", [ioredis_1.default])
 ], RedisModule);
 //# sourceMappingURL=redis.module.js.map

package/dist/redis.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"redis.module.js","sourceRoot":"","sources":["../src/redis.module.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAAoE;AAGpE,mCAAgC;AAChC,uEAGmC;AACnC,iFAAsE;AAgB/D,IAAM,WAAW,GAAjB,MAAM,WACX,SAAQ,iDAAuB;IAG/B,YAA6B,KAAY;QACvC,KAAK,EAAE,CAAC;QADmB,UAAK,GAAL,KAAK,CAAO;IAEzC,CAAC;IAED,KAAK,CAAC,qBAAqB;QACzB,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;IAC1B,CAAC;CACF,CAAA;AAXY,kCAAW;sBAAX,WAAW;IAdvB,IAAA,eAAM,EAAC;QACN,SAAS,EAAE;YACT;gBACE,OAAO,EAAE,aAAK;gBACd,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,8CAAoB,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;gBACzD,UAAU,EAAE,CAAC,UAAwB,EAAE,EAAE,EAAE,CACzC,IAAI,aAAK,CAAC;oBACR,GAAG,IAAA,6CAAiB,GAAE;oBACtB,GAAG,OAAO;iBACX,CAAC;aACL;SACF;QACD,OAAO,EAAE,CAAC,aAAK,CAAC;KACjB,CAAC;qCAKoC,aAAK;GAJ9B,WAAW,CAWvB"}
+{"version":3,"file":"redis.module.js","sourceRoot":"","sources":["../src/redis.module.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAKwB;AACxB,sDAAmD;AAEnD,uEAKmC;AACnC,iFAAsE;AAEtE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AAgBI,IAAM,WAAW,GAAjB,MAAM,WACX,SAAQ,iDAAuB;IAG/B;;;;OAIG;IACH,MAAM,CAAU,QAAQ,CAAC,OAA4B;QACnD,OAAO,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAU,aAAa,CAC3B,OAAkC;QAElC,OAAO,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC;IAED;;;OAGG;IACH,YAA6B,KAAY;QACvC,KAAK,EAAE,CAAC;QADmB,UAAK,GAAL,KAAK,CAAO;IAEzC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,qBAAqB;QACzB,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;IAC1B,CAAC;CACF,CAAA;AAtCY,kCAAW;sBAAX,WAAW;IAfvB,IAAA,eAAM,GAAE;IACR,IAAA,eAAM,EAAC;QACN,SAAS,EAAE;YACT;gBACE,OAAO,EAAE,iBAAK;gBACd,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,8CAAoB,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;gBACzD,UAAU,EAAE,CAAC,OAAqB,EAAE,EAAE,CACpC,IAAI,iBAAK,CAAC;oBACR,GAAG,IAAA,6CAAiB,GAAE;oBACtB,GAAG,OAAO;iBACX,CAAC;aACL;SACF;QACD,OAAO,EAAE,CAAC,iBAAK,CAAC;KACjB,CAAC;qCA6BoC,iBAAK;GA5B9B,WAAW,CAsCvB"}