@nest-boot/redis 7.0.2 → 7.1.0

package/dist/index.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.spec.js

@@ -0,0 +1,45 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+const publicApi = __importStar(require("."));
+const redis_module_1 = require("./redis.module");
+const load_config_from_env_util_1 = require("./utils/load-config-from-env.util");
+describe("public API", () => {
+    it("should export Redis module and config loader", () => {
+        expect(publicApi.RedisModule).toBe(redis_module_1.RedisModule);
+        expect(publicApi.loadConfigFromEnv).toBe(load_config_from_env_util_1.loadConfigFromEnv);
+    });
+});
+//# sourceMappingURL=index.spec.js.map

package/dist/index.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.spec.js","sourceRoot":"","sources":["../src/index.spec.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA+B;AAC/B,iDAA6C;AAC7C,iFAAsE;AAEtE,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IAC1B,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACtD,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,0BAAW,CAAC,CAAC;QAChD,MAAM,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC,IAAI,CAAC,6CAAiB,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/redis.module.d.ts

@@ -5,7 +5,7 @@ import { ASYNC_OPTIONS_TYPE, ConfigurableModuleClass, OPTIONS_TYPE } from "./red
  * 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_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
@@ -58,9 +58,8 @@ export declare class RedisModule extends ConfigurableModuleClass implements OnAp
      * @returns Dynamic module configuration
      */
     static registerAsync(options: typeof ASYNC_OPTIONS_TYPE): DynamicModule;
-    /**
-     * Creates an instance of RedisModule.
-     * @param redis - The Redis client instance
+    /** Creates a new RedisModule instance.
+     * @param redis - The ioredis client instance
      */
     constructor(redis: Redis);
     /**

package/dist/redis.module.js

@@ -21,7 +21,7 @@ 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_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
@@ -77,9 +77,8 @@ let RedisModule = class RedisModule extends redis_module_definition_1.Configurab
     static registerAsync(options) {
         return super.registerAsync(options);
     }
-    /**
-     * Creates an instance of RedisModule.
-     * @param redis - The Redis client instance
+    /** Creates a new RedisModule instance.
+     * @param redis - The ioredis client instance
      */
     constructor(redis) {
         super();

package/dist/redis.module.js.map

@@ -1 +1 @@
-{"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"}
+{"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;;OAEG;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;AArCY,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;qCA4BoC,iBAAK;GA3B9B,WAAW,CAqCvB"}

package/dist/redis.module.spec.d.ts

@@ -1 +1 @@
-import "dotenv/config";
+export {};

package/dist/redis.module.spec.js

@@ -1,37 +1,67 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-require("dotenv/config");
-const testing_1 = require("@nestjs/testing");
-const _1 = require(".");
+const constants_1 = require("@nestjs/common/constants");
+const mockRedisInstance = {
+    quit: jest.fn(),
+};
+const mockRedis = jest.fn(() => mockRedisInstance);
+jest.mock("ioredis", () => ({
+    __esModule: true,
+    default: mockRedis,
+}));
+jest.mock("./utils/load-config-from-env.util", () => ({
+    loadConfigFromEnv: jest.fn(() => ({
+        host: "redis.local",
+    })),
+}));
+const redis_module_1 = require("./redis.module");
+const redis_module_definition_1 = require("./redis.module-definition");
+const load_config_from_env_util_1 = require("./utils/load-config-from-env.util");
 describe("RedisModule", () => {
-    let app;
-    it(`RedisModule`, async () => {
-        const moduleRef = await testing_1.Test.createTestingModule({
-            imports: [_1.RedisModule],
-        }).compile();
-        app = moduleRef.createNestApplication();
-        await app.init();
-        await app.close();
+    beforeEach(() => {
+        jest.clearAllMocks();
     });
-    it(`RedisModule.register`, async () => {
-        const moduleRef = await testing_1.Test.createTestingModule({
-            imports: [_1.RedisModule.register({})],
-        }).compile();
-        app = moduleRef.createNestApplication();
-        await app.init();
-        await app.close();
+    it("should register synchronous and asynchronous options", () => {
+        const options = {
+            host: "custom.redis",
+        };
+        const dynamicModule = redis_module_1.RedisModule.register(options);
+        const useFactory = () => options;
+        const asyncModule = redis_module_1.RedisModule.registerAsync({
+            useFactory,
+        });
+        expect(dynamicModule.module).toBe(redis_module_1.RedisModule);
+        expect(dynamicModule.providers).toEqual(expect.arrayContaining([
+            {
+                provide: redis_module_definition_1.MODULE_OPTIONS_TOKEN,
+                useValue: options,
+            },
+        ]));
+        expect(asyncModule.providers).toEqual(expect.arrayContaining([
+            {
+                inject: [],
+                provide: redis_module_definition_1.MODULE_OPTIONS_TOKEN,
+                useFactory,
+            },
+        ]));
     });
-    it(`RedisModule.registerAsync`, async () => {
-        const moduleRef = await testing_1.Test.createTestingModule({
-            imports: [
-                _1.RedisModule.registerAsync({
-                    useFactory: () => ({}),
-                }),
-            ],
-        }).compile();
-        app = moduleRef.createNestApplication();
-        await app.init();
-        await app.close();
+    it("should create Redis clients from env config merged with options", () => {
+        const providers = Reflect.getMetadata(constants_1.MODULE_METADATA.PROVIDERS, redis_module_1.RedisModule);
+        const redisProvider = providers.find((provider) => provider.provide === mockRedis);
+        expect(redisProvider).toBeDefined();
+        expect(redisProvider?.useFactory({
+            db: 1,
+        })).toBe(mockRedisInstance);
+        expect(load_config_from_env_util_1.loadConfigFromEnv).toHaveBeenCalledTimes(1);
+        expect(mockRedis).toHaveBeenCalledWith({
+            db: 1,
+            host: "redis.local",
+        });
+    });
+    it("should close Redis on application shutdown", async () => {
+        const module = new redis_module_1.RedisModule(mockRedisInstance);
+        await module.onApplicationShutdown();
+        expect(mockRedisInstance.quit).toHaveBeenCalledTimes(1);
     });
 });
 //# sourceMappingURL=redis.module.spec.js.map

package/dist/redis.module.spec.js.map

@@ -1 +1 @@
-{"version":3,"file":"redis.module.spec.js","sourceRoot":"","sources":["../src/redis.module.spec.ts"],"names":[],"mappings":";;AAAA,yBAAuB;AAGvB,6CAAuC;AAEvC,wBAAgC;AAEhC,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IAC3B,IAAI,GAAqB,CAAC;IAE1B,EAAE,CAAC,aAAa,EAAE,KAAK,IAAI,EAAE;QAC3B,MAAM,SAAS,GAAG,MAAM,cAAI,CAAC,mBAAmB,CAAC;YAC/C,OAAO,EAAE,CAAC,cAAW,CAAC;SACvB,CAAC,CAAC,OAAO,EAAE,CAAC;QAEb,GAAG,GAAG,SAAS,CAAC,qBAAqB,EAAE,CAAC;QACxC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;QACjB,MAAM,GAAG,CAAC,KAAK,EAAE,CAAC;IACpB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sBAAsB,EAAE,KAAK,IAAI,EAAE;QACpC,MAAM,SAAS,GAAG,MAAM,cAAI,CAAC,mBAAmB,CAAC;YAC/C,OAAO,EAAE,CAAC,cAAW,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;SACpC,CAAC,CAAC,OAAO,EAAE,CAAC;QAEb,GAAG,GAAG,SAAS,CAAC,qBAAqB,EAAE,CAAC;QACxC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;QACjB,MAAM,GAAG,CAAC,KAAK,EAAE,CAAC;IACpB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2BAA2B,EAAE,KAAK,IAAI,EAAE;QACzC,MAAM,SAAS,GAAG,MAAM,cAAI,CAAC,mBAAmB,CAAC;YAC/C,OAAO,EAAE;gBACP,cAAW,CAAC,aAAa,CAAC;oBACxB,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC;iBACvB,CAAC;aACH;SACF,CAAC,CAAC,OAAO,EAAE,CAAC;QAEb,GAAG,GAAG,SAAS,CAAC,qBAAqB,EAAE,CAAC;QACxC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;QACjB,MAAM,GAAG,CAAC,KAAK,EAAE,CAAC;IACpB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
+{"version":3,"file":"redis.module.spec.js","sourceRoot":"","sources":["../src/redis.module.spec.ts"],"names":[],"mappings":";;AAAA,wDAA2D;AAE3D,MAAM,iBAAiB,GAAG;IACxB,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE;CAChB,CAAC;AACF,MAAM,SAAS,GAAG,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,iBAAiB,CAAC,CAAC;AAEnD,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,EAAE,CAAC,CAAC;IAC1B,UAAU,EAAE,IAAI;IAChB,OAAO,EAAE,SAAS;CACnB,CAAC,CAAC,CAAC;AACJ,IAAI,CAAC,IAAI,CAAC,mCAAmC,EAAE,GAAG,EAAE,CAAC,CAAC;IACpD,iBAAiB,EAAE,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC;QAChC,IAAI,EAAE,aAAa;KACpB,CAAC,CAAC;CACJ,CAAC,CAAC,CAAC;AAEJ,iDAA6C;AAC7C,uEAAiE;AACjE,iFAAsE;AAOtE,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IAC3B,UAAU,CAAC,GAAG,EAAE;QACd,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAC9D,MAAM,OAAO,GAAG;YACd,IAAI,EAAE,cAAc;SACrB,CAAC;QACF,MAAM,aAAa,GAAG,0BAAW,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QACpD,MAAM,UAAU,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC;QACjC,MAAM,WAAW,GAAG,0BAAW,CAAC,aAAa,CAAC;YAC5C,UAAU;SACX,CAAC,CAAC;QAEH,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,0BAAW,CAAC,CAAC;QAC/C,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,OAAO,CACrC,MAAM,CAAC,eAAe,CAAC;YACrB;gBACE,OAAO,EAAE,8CAAoB;gBAC7B,QAAQ,EAAE,OAAO;aAClB;SACF,CAAC,CACH,CAAC;QACF,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,OAAO,CACnC,MAAM,CAAC,eAAe,CAAC;YACrB;gBACE,MAAM,EAAE,EAAE;gBACV,OAAO,EAAE,8CAAoB;gBAC7B,UAAU;aACX;SACF,CAAC,CACH,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;QACzE,MAAM,SAAS,GAAG,OAAO,CAAC,WAAW,CACnC,2BAAe,CAAC,SAAS,EACzB,0BAAW,CACO,CAAC;QACrB,MAAM,aAAa,GAAG,SAAS,CAAC,IAAI,CAClC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,OAAO,KAAK,SAAS,CAC7C,CAAC;QAEF,MAAM,CAAC,aAAa,CAAC,CAAC,WAAW,EAAE,CAAC;QACpC,MAAM,CACJ,aAAa,EAAE,UAAU,CAAC;YACxB,EAAE,EAAE,CAAC;SACN,CAAC,CACH,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC1B,MAAM,CAAC,6CAAiB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QACnD,MAAM,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC;YACrC,EAAE,EAAE,CAAC;YACL,IAAI,EAAE,aAAa;SACpB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;QAC1D,MAAM,MAAM,GAAG,IAAI,0BAAW,CAAC,iBAA0B,CAAC,CAAC;QAE3D,MAAM,MAAM,CAAC,qBAAqB,EAAE,CAAC;QAErC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}