@nest-boot/bullmq 7.0.2 → 7.1.0

package/dist/bullmq-module-options.interface.d.ts

@@ -1,4 +1,6 @@
 import { ConnectionOptions, type QueueOptions } from "bullmq";
+/** Configuration options for the BullMQ module. */
 export interface BullModuleOptions extends Omit<QueueOptions, "connection"> {
+    /** Redis connection options for BullMQ queues and workers. */
     connection?: ConnectionOptions;
 }

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

@@ -2,4 +2,4 @@ import { BullModuleOptions } from "./bullmq-module-options.interface";
 export declare const SCHEDULE_QUEUE_NAME = "schedule";
 export declare const SCHEDULE_METADATA_KEY: `${string}-${string}-${string}-${string}-${string}`;
 export declare const MODULE_OPTIONS_TOKEN: unique symbol;
-export declare const ConfigurableModuleClass: import("@nestjs/common").ConfigurableModuleCls<BullModuleOptions, "forRoot", "create", {}>, BASE_MODULE_OPTIONS_TOKEN: string | symbol;
+export declare const ConfigurableModuleClass: import("@nestjs/common").ConfigurableModuleCls<BullModuleOptions, "forRoot", "create", {}>, BASE_MODULE_OPTIONS_TOKEN: string | symbol, OPTIONS_TYPE: BullModuleOptions & Partial<{}>, ASYNC_OPTIONS_TYPE: import("@nestjs/common").ConfigurableModuleAsyncOptions<BullModuleOptions, "create"> & Partial<{}>;

package/dist/bullmq.module-definition.js

@@ -1,7 +1,7 @@
 "use strict";
 var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BASE_MODULE_OPTIONS_TOKEN = exports.ConfigurableModuleClass = exports.MODULE_OPTIONS_TOKEN = exports.SCHEDULE_METADATA_KEY = exports.SCHEDULE_QUEUE_NAME = void 0;
+exports.ASYNC_OPTIONS_TYPE = exports.OPTIONS_TYPE = exports.BASE_MODULE_OPTIONS_TOKEN = exports.ConfigurableModuleClass = exports.MODULE_OPTIONS_TOKEN = exports.SCHEDULE_METADATA_KEY = exports.SCHEDULE_QUEUE_NAME = void 0;
 const common_1 = require("@nestjs/common");
 const crypto_1 = require("crypto");
 exports.SCHEDULE_QUEUE_NAME = "schedule";
@@ -9,5 +9,5 @@ exports.SCHEDULE_METADATA_KEY = (0, crypto_1.randomUUID)();
 exports.MODULE_OPTIONS_TOKEN = Symbol("BullModuleOptions");
 _a = new common_1.ConfigurableModuleBuilder()
     .setClassMethodName("forRoot")
-    .build(), exports.ConfigurableModuleClass = _a.ConfigurableModuleClass, exports.BASE_MODULE_OPTIONS_TOKEN = _a.MODULE_OPTIONS_TOKEN;
+    .build(), exports.ConfigurableModuleClass = _a.ConfigurableModuleClass, exports.BASE_MODULE_OPTIONS_TOKEN = _a.MODULE_OPTIONS_TOKEN, exports.OPTIONS_TYPE = _a.OPTIONS_TYPE, exports.ASYNC_OPTIONS_TYPE = _a.ASYNC_OPTIONS_TYPE;
 //# sourceMappingURL=bullmq.module-definition.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"bullmq.module-definition.js","sourceRoot":"","sources":["../src/bullmq.module-definition.ts"],"names":[],"mappings":";;;;AAAA,2CAA2D;AAC3D,mCAAoC;AAIvB,QAAA,mBAAmB,GAAG,UAAU,CAAC;AAEjC,QAAA,qBAAqB,GAAG,IAAA,mBAAU,GAAE,CAAC;AAErC,QAAA,oBAAoB,GAAG,MAAM,CAAC,mBAAmB,CAAC,CAAC;AAEnD,KAGT,IAAI,kCAAyB,EAAqB;KACnD,kBAAkB,CAAC,SAAS,CAAC;KAC7B,KAAK,EAAE,EAJR,+BAAuB,+BACD,iCAAyB,2BAGtC"}
+{"version":3,"file":"bullmq.module-definition.js","sourceRoot":"","sources":["../src/bullmq.module-definition.ts"],"names":[],"mappings":";;;;AAAA,2CAA2D;AAC3D,mCAAoC;AAIvB,QAAA,mBAAmB,GAAG,UAAU,CAAC;AAEjC,QAAA,qBAAqB,GAAG,IAAA,mBAAU,GAAE,CAAC;AAErC,QAAA,oBAAoB,GAAG,MAAM,CAAC,mBAAmB,CAAC,CAAC;AAEnD,KAKT,IAAI,kCAAyB,EAAqB;KACnD,kBAAkB,CAAC,SAAS,CAAC;KAC7B,KAAK,EAAE,EANR,+BAAuB,+BACD,iCAAyB,4BAC/C,oBAAY,oBACZ,0BAAkB,yBAGT"}

package/dist/bullmq.module.d.ts

@@ -1,7 +1,36 @@
 import { BullModule as BaseBullModule } from "@nestjs/bullmq";
 import { type DynamicModule } from "@nestjs/common";
-import { ConfigurableModuleClass } from "./bullmq.module-definition";
+import { ASYNC_OPTIONS_TYPE, ConfigurableModuleClass, OPTIONS_TYPE } from "./bullmq.module-definition";
+/**
+ * BullMQ integration module for job queue processing.
+ *
+ * @remarks
+ * Wraps `@nestjs/bullmq` with automatic Redis connection configuration
+ * from environment variables. Supports registering queues and flow producers.
+ */
 export declare class BullModule extends ConfigurableModuleClass {
+    /**
+     * Registers the BullModule with the given options.
+     * @param options - Configuration options including Redis connection
+     * @returns Dynamic module configuration
+     */
+    static forRoot(options: typeof OPTIONS_TYPE): DynamicModule;
+    /**
+     * Registers the BullModule asynchronously with factory functions.
+     * @param options - Async configuration options
+     * @returns Dynamic module configuration
+     */
+    static forRootAsync(options: typeof ASYNC_OPTIONS_TYPE): DynamicModule;
+    /**
+     * Registers a BullMQ queue.
+     * @param args - registerQueue arguments
+     * @returns Dynamic module configuration
+     */
     static registerQueue(...args: Parameters<typeof BaseBullModule.registerQueue>): DynamicModule;
+    /**
+     * Registers a BullMQ queue asynchronously.
+     * @param args - registerQueueAsync arguments
+     * @returns Dynamic module configuration
+     */
     static registerQueueAsync(...args: Parameters<typeof BaseBullModule.registerQueueAsync>): DynamicModule;
 }

package/dist/bullmq.module.js

@@ -11,10 +11,43 @@ const bullmq_1 = require("@nestjs/bullmq");
 const common_1 = require("@nestjs/common");
 const bullmq_module_definition_1 = require("./bullmq.module-definition");
 const load_config_from_env_util_1 = require("./utils/load-config-from-env.util");
+/**
+ * BullMQ integration module for job queue processing.
+ *
+ * @remarks
+ * Wraps `@nestjs/bullmq` with automatic Redis connection configuration
+ * from environment variables. Supports registering queues and flow producers.
+ */
 let BullModule = class BullModule extends bullmq_module_definition_1.ConfigurableModuleClass {
+    /**
+     * Registers the BullModule with the given options.
+     * @param options - Configuration options including Redis connection
+     * @returns Dynamic module configuration
+     */
+    static forRoot(options) {
+        return super.forRoot(options);
+    }
+    /**
+     * Registers the BullModule asynchronously with factory functions.
+     * @param options - Async configuration options
+     * @returns Dynamic module configuration
+     */
+    static forRootAsync(options) {
+        return super.forRootAsync(options);
+    }
+    /**
+     * Registers a BullMQ queue.
+     * @param args - registerQueue arguments
+     * @returns Dynamic module configuration
+     */
     static registerQueue(...args) {
         return bullmq_1.BullModule.registerQueue(...args);
     }
+    /**
+     * Registers a BullMQ queue asynchronously.
+     * @param args - registerQueueAsync arguments
+     * @returns Dynamic module configuration
+     */
     static registerQueueAsync(...args) {
         return bullmq_1.BullModule.registerQueueAsync(...args);
     }

package/dist/bullmq.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"bullmq.module.js","sourceRoot":"","sources":["../src/bullmq.module.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAA8D;AAC9D,2CAAoE;AAEpE,yEAIoC;AAEpC,iFAAsE;AAwB/D,IAAM,UAAU,GAAhB,MAAM,UAAW,SAAQ,kDAAuB;IACrD,MAAM,CAAC,aAAa,CAClB,GAAG,IAAqD;QAExD,OAAO,mBAAc,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,CAAC;IAC/C,CAAC;IAED,MAAM,CAAC,kBAAkB,CACvB,GAAG,IAA0D;QAE7D,OAAO,mBAAc,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC,CAAC;IACpD,CAAC;CACF,CAAA;AAZY,gCAAU;qBAAV,UAAU;IAtBtB,IAAA,eAAM,GAAE;IACR,IAAA,eAAM,EAAC;QACN,OAAO,EAAE;YACP,mBAAc,CAAC,YAAY,CAAC;gBAC1B,MAAM,EAAE,CAAC,+CAAoB,CAAC;gBAC9B,UAAU,EAAE,CAAC,OAA0B,EAAE,EAAE;oBACzC,OAAO;wBACL,GAAG,OAAO;wBACV,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,IAAA,6CAAiB,GAAE;qBACtD,CAAC;gBACJ,CAAC;aACF,CAAC;SACH;QACD,SAAS,EAAE;YACT;gBACE,OAAO,EAAE,+CAAoB;gBAC7B,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,oDAAyB,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;gBAC9D,UAAU,EAAE,CAAC,OAA2B,EAAE,EAAE,CAAC,OAAO,IAAI,EAAE;aAC3D;SACF;QACD,OAAO,EAAE,CAAC,+CAAoB,CAAC;KAChC,CAAC;GACW,UAAU,CAYtB"}
+{"version":3,"file":"bullmq.module.js","sourceRoot":"","sources":["../src/bullmq.module.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAA8D;AAC9D,2CAAoE;AAEpE,yEAMoC;AAEpC,iFAAsE;AAEtE;;;;;;GAMG;AAuBI,IAAM,UAAU,GAAhB,MAAM,UAAW,SAAQ,kDAAuB;IACrD;;;;OAIG;IACH,MAAM,CAAU,OAAO,CAAC,OAA4B;QAClD,OAAO,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAU,YAAY,CAC1B,OAAkC;QAElC,OAAO,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IACrC,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,aAAa,CAClB,GAAG,IAAqD;QAExD,OAAO,mBAAc,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,CAAC;IAC/C,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,kBAAkB,CACvB,GAAG,IAA0D;QAE7D,OAAO,mBAAc,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC,CAAC;IACpD,CAAC;CACF,CAAA;AA1CY,gCAAU;qBAAV,UAAU;IAtBtB,IAAA,eAAM,GAAE;IACR,IAAA,eAAM,EAAC;QACN,OAAO,EAAE;YACP,mBAAc,CAAC,YAAY,CAAC;gBAC1B,MAAM,EAAE,CAAC,+CAAoB,CAAC;gBAC9B,UAAU,EAAE,CAAC,OAA0B,EAAE,EAAE;oBACzC,OAAO;wBACL,GAAG,OAAO;wBACV,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,IAAA,6CAAiB,GAAE;qBACtD,CAAC;gBACJ,CAAC;aACF,CAAC;SACH;QACD,SAAS,EAAE;YACT;gBACE,OAAO,EAAE,+CAAoB;gBAC7B,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,oDAAyB,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;gBAC9D,UAAU,EAAE,CAAC,OAA2B,EAAE,EAAE,CAAC,OAAO,IAAI,EAAE;aAC3D;SACF;QACD,OAAO,EAAE,CAAC,+CAAoB,CAAC;KAChC,CAAC;GACW,UAAU,CA0CtB"}

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

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

package/dist/bullmq.module.spec.js

@@ -1,37 +1,117 @@
 "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");
+let mockForRootAsyncOptions;
+const mockBaseBullModule = {
+    forRootAsync: jest.fn((options) => {
+        mockForRootAsyncOptions = options;
+        return {
+            module: class BaseRootModule {
+            },
+        };
+    }),
+    registerQueue: jest.fn(),
+    registerQueueAsync: jest.fn(),
+};
+jest.mock("@nestjs/bullmq", () => ({
+    BullModule: mockBaseBullModule,
+    QueueEventsListener: class QueueEventsListener {
+    },
+}));
+const bullmq_module_1 = require("./bullmq.module");
+const bullmq_module_definition_1 = require("./bullmq.module-definition");
+const load_config_from_env_util_1 = require("./utils/load-config-from-env.util");
+jest.mock("./utils/load-config-from-env.util", () => ({
+    loadConfigFromEnv: jest.fn(() => ({
+        host: "redis.local",
+    })),
+}));
 describe("BullModule", () => {
-    let app;
-    it(`BullModule`, async () => {
-        const moduleRef = await testing_1.Test.createTestingModule({
-            imports: [_1.BullModule],
-        }).compile();
-        app = moduleRef.createNestApplication();
-        await app.init();
-        await app.close();
+    beforeEach(() => {
+        jest.clearAllMocks();
     });
-    it(`BullModule.forRoot`, async () => {
-        const moduleRef = await testing_1.Test.createTestingModule({
-            imports: [_1.BullModule.forRoot({})],
-        }).compile();
-        app = moduleRef.createNestApplication();
-        await app.init();
-        await app.close();
+    it("should register synchronous and asynchronous options", () => {
+        const options = {
+            connection: {
+                host: "redis.local",
+            },
+        };
+        const dynamicModule = bullmq_module_1.BullModule.forRoot(options);
+        const useFactory = () => options;
+        const asyncModule = bullmq_module_1.BullModule.forRootAsync({
+            useFactory,
+        });
+        expect(dynamicModule.module).toBe(bullmq_module_1.BullModule);
+        expect(dynamicModule.providers).toEqual(expect.arrayContaining([
+            {
+                provide: bullmq_module_definition_1.BASE_MODULE_OPTIONS_TOKEN,
+                useValue: options,
+            },
+        ]));
+        expect(asyncModule.providers).toEqual(expect.arrayContaining([
+            {
+                inject: [],
+                provide: bullmq_module_definition_1.BASE_MODULE_OPTIONS_TOKEN,
+                useFactory,
+            },
+        ]));
     });
-    it(`BullModule.forRootAsync`, async () => {
-        const moduleRef = await testing_1.Test.createTestingModule({
-            imports: [
-                _1.BullModule.forRootAsync({
-                    useFactory: () => ({}),
-                }),
-            ],
-        }).compile();
-        app = moduleRef.createNestApplication();
-        await app.init();
-        await app.close();
+    it("should provide empty options when base options are missing", () => {
+        const providers = Reflect.getMetadata(constants_1.MODULE_METADATA.PROVIDERS, bullmq_module_1.BullModule);
+        const optionsProvider = providers.find((provider) => provider.provide === bullmq_module_definition_1.MODULE_OPTIONS_TOKEN);
+        expect(optionsProvider).toBeDefined();
+        expect(optionsProvider?.useFactory(undefined)).toEqual({});
+        expect(optionsProvider?.useFactory({
+            prefix: "jobs",
+        })).toEqual({
+            prefix: "jobs",
+        });
+    });
+    it("should merge module options with environment Redis config", () => {
+        const imports = Reflect.getMetadata(constants_1.MODULE_METADATA.IMPORTS, bullmq_module_1.BullModule);
+        expect(mockForRootAsyncOptions).toEqual(expect.objectContaining({
+            inject: [bullmq_module_definition_1.MODULE_OPTIONS_TOKEN],
+        }));
+        expect(mockForRootAsyncOptions.useFactory({
+            prefix: "jobs",
+        })).toEqual({
+            connection: {
+                host: "redis.local",
+            },
+            prefix: "jobs",
+        });
+        expect(mockForRootAsyncOptions.useFactory({
+            connection: {
+                host: "custom.redis",
+            },
+        })).toEqual({
+            connection: {
+                host: "custom.redis",
+            },
+        });
+        expect(load_config_from_env_util_1.loadConfigFromEnv).toHaveBeenCalledTimes(1);
+        expect(imports).toEqual([
+            {
+                module: expect.any(Function),
+            },
+        ]);
+    });
+    it("should delegate queue registration to the base Bull module", () => {
+        const queueModule = {
+            module: class QueueModule {
+            },
+        };
+        const asyncQueueModule = {
+            module: class AsyncQueueModule {
+            },
+        };
+        mockBaseBullModule.registerQueue.mockReturnValue(queueModule);
+        mockBaseBullModule.registerQueueAsync.mockReturnValue(asyncQueueModule);
+        expect(bullmq_module_1.BullModule.registerQueue({ name: "email" })).toBe(queueModule);
+        expect(bullmq_module_1.BullModule.registerQueueAsync({
+            name: "email",
+            useFactory: () => ({}),
+        })).toBe(asyncQueueModule);
     });
 });
 //# sourceMappingURL=bullmq.module.spec.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"bullmq.module.spec.js","sourceRoot":"","sources":["../src/bullmq.module.spec.ts"],"names":[],"mappings":";;AAAA,yBAAuB;AAGvB,6CAAuC;AAEvC,wBAA+B;AAE/B,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IAC1B,IAAI,GAAqB,CAAC;IAE1B,EAAE,CAAC,YAAY,EAAE,KAAK,IAAI,EAAE;QAC1B,MAAM,SAAS,GAAG,MAAM,cAAI,CAAC,mBAAmB,CAAC;YAC/C,OAAO,EAAE,CAAC,aAAU,CAAC;SACtB,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,oBAAoB,EAAE,KAAK,IAAI,EAAE;QAClC,MAAM,SAAS,GAAG,MAAM,cAAI,CAAC,mBAAmB,CAAC;YAC/C,OAAO,EAAE,CAAC,aAAU,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;SAClC,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,yBAAyB,EAAE,KAAK,IAAI,EAAE;QACvC,MAAM,SAAS,GAAG,MAAM,cAAI,CAAC,mBAAmB,CAAC;YAC/C,OAAO,EAAE;gBACP,aAAU,CAAC,YAAY,CAAC;oBACtB,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":"bullmq.module.spec.js","sourceRoot":"","sources":["../src/bullmq.module.spec.ts"],"names":[],"mappings":";;AAAA,wDAA2D;AAE3D,IAAI,uBAA4B,CAAC;AACjC,MAAM,kBAAkB,GAAG;IACzB,YAAY,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE;QAChC,uBAAuB,GAAG,OAAO,CAAC;QAClC,OAAO;YACL,MAAM,EAAE,MAAM,cAAc;aAAG;SAChC,CAAC;IACJ,CAAC,CAAC;IACF,aAAa,EAAE,IAAI,CAAC,EAAE,EAAE;IACxB,kBAAkB,EAAE,IAAI,CAAC,EAAE,EAAE;CAC9B,CAAC;AAEF,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,GAAG,EAAE,CAAC,CAAC;IACjC,UAAU,EAAE,kBAAkB;IAC9B,mBAAmB,EAAE,MAAM,mBAAmB;KAAG;CAClD,CAAC,CAAC,CAAC;AAEJ,mDAA6C;AAC7C,yEAGoC;AACpC,iFAAsE;AAEtE,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;AAOJ,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IAC1B,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,UAAU,EAAE;gBACV,IAAI,EAAE,aAAa;aACpB;SACF,CAAC;QACF,MAAM,aAAa,GAAG,0BAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAClD,MAAM,UAAU,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC;QACjC,MAAM,WAAW,GAAG,0BAAU,CAAC,YAAY,CAAC;YAC1C,UAAU;SACX,CAAC,CAAC;QAEH,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,0BAAU,CAAC,CAAC;QAC9C,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,OAAO,CACrC,MAAM,CAAC,eAAe,CAAC;YACrB;gBACE,OAAO,EAAE,oDAAyB;gBAClC,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,oDAAyB;gBAClC,UAAU;aACX;SACF,CAAC,CACH,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE;QACpE,MAAM,SAAS,GAAG,OAAO,CAAC,WAAW,CACnC,2BAAe,CAAC,SAAS,EACzB,0BAAU,CACc,CAAC;QAC3B,MAAM,eAAe,GAAG,SAAS,CAAC,IAAI,CACpC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,OAAO,KAAK,+CAAoB,CACxD,CAAC;QAEF,MAAM,CAAC,eAAe,CAAC,CAAC,WAAW,EAAE,CAAC;QACtC,MAAM,CAAC,eAAe,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAC3D,MAAM,CACJ,eAAe,EAAE,UAAU,CAAC;YAC1B,MAAM,EAAE,MAAM;SACf,CAAC,CACH,CAAC,OAAO,CAAC;YACR,MAAM,EAAE,MAAM;SACf,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;QACnE,MAAM,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC,2BAAe,CAAC,OAAO,EAAE,0BAAU,CAAC,CAAC;QAEzE,MAAM,CAAC,uBAAuB,CAAC,CAAC,OAAO,CACrC,MAAM,CAAC,gBAAgB,CAAC;YACtB,MAAM,EAAE,CAAC,+CAAoB,CAAC;SAC/B,CAAC,CACH,CAAC;QAEF,MAAM,CACJ,uBAAuB,CAAC,UAAU,CAAC;YACjC,MAAM,EAAE,MAAM;SACf,CAAC,CACH,CAAC,OAAO,CAAC;YACR,UAAU,EAAE;gBACV,IAAI,EAAE,aAAa;aACpB;YACD,MAAM,EAAE,MAAM;SACf,CAAC,CAAC;QACH,MAAM,CACJ,uBAAuB,CAAC,UAAU,CAAC;YACjC,UAAU,EAAE;gBACV,IAAI,EAAE,cAAc;aACrB;SACF,CAAC,CACH,CAAC,OAAO,CAAC;YACR,UAAU,EAAE;gBACV,IAAI,EAAE,cAAc;aACrB;SACF,CAAC,CAAC;QACH,MAAM,CAAC,6CAAiB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QACnD,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC;YACtB;gBACE,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;aAC7B;SACF,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE;QACpE,MAAM,WAAW,GAAG;YAClB,MAAM,EAAE,MAAM,WAAW;aAAG;SAC7B,CAAC;QACF,MAAM,gBAAgB,GAAG;YACvB,MAAM,EAAE,MAAM,gBAAgB;aAAG;SAClC,CAAC;QACF,kBAAkB,CAAC,aAAa,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;QAC9D,kBAAkB,CAAC,kBAAkB,CAAC,eAAe,CAAC,gBAAgB,CAAC,CAAC;QAExE,MAAM,CAAC,0BAAU,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACtE,MAAM,CACJ,0BAAU,CAAC,kBAAkB,CAAC;YAC5B,IAAI,EAAE,OAAO;YACb,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC;SACvB,CAAC,CACH,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAC3B,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/index.d.ts

@@ -3,4 +3,3 @@ export * from "./bullmq-module-options.interface";
 export { Processor } from "./processor.decorator";
 export * from "@nestjs/bullmq";
 export { QueueEventsListener } from "@nestjs/bullmq";
-export * from "bullmq";

package/dist/index.js

@@ -23,5 +23,4 @@ Object.defineProperty(exports, "Processor", { enumerable: true, get: function ()
 __exportStar(require("@nestjs/bullmq"), exports);
 var bullmq_1 = require("@nestjs/bullmq");
 Object.defineProperty(exports, "QueueEventsListener", { enumerable: true, get: function () { return bullmq_1.QueueEventsListener; } });
-__exportStar(require("bullmq"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,iDAA6C;AAApC,2GAAA,UAAU,OAAA;AACnB,oEAAkD;AAClD,6DAAkD;AAAzC,gHAAA,SAAS,OAAA;AAClB,iDAA+B;AAC/B,yCAAqD;AAA5C,6GAAA,mBAAmB,OAAA;AAC5B,yCAAuB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,iDAA6C;AAApC,2GAAA,UAAU,OAAA;AACnB,oEAAkD;AAClD,6DAAkD;AAAzC,gHAAA,SAAS,OAAA;AAClB,iDAA+B;AAC/B,yCAAqD;AAA5C,6GAAA,mBAAmB,OAAA"}

package/dist/index.spec.d.ts

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

package/dist/index.spec.js

@@ -0,0 +1,47 @@
+"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 bullmq_module_1 = require("./bullmq.module");
+const processor_decorator_1 = require("./processor.decorator");
+describe("public API", () => {
+    it("should export Bull module and upstream BullMQ helpers", () => {
+        expect(publicApi.BullModule).toBe(bullmq_module_1.BullModule);
+        expect(publicApi.Processor).toBe(processor_decorator_1.Processor);
+        expect(publicApi.WorkerHost).toBeDefined();
+        expect(publicApi.QueueEventsListener).toBeDefined();
+    });
+});
+//# 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,mDAA6C;AAC7C,+DAAkD;AAElD,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IAC1B,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;QAC/D,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,0BAAU,CAAC,CAAC;QAC9C,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,+BAAS,CAAC,CAAC;QAC5C,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,WAAW,EAAE,CAAC;QAC3C,MAAM,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC,WAAW,EAAE,CAAC;IACtD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/processor.decorator.d.ts

@@ -1,6 +1,32 @@
 import { ProcessorOptions } from "@nestjs/bullmq";
 import { NestWorkerOptions } from "@nestjs/bullmq/dist/interfaces/worker-options.interface";
+/**
+ * Decorator that marks a class as a BullMQ queue processor.
+ *
+ * @remarks
+ * Wraps the `@nestjs/bullmq` `Processor` decorator to automatically
+ * create a {@link RequestContext} for each processed job.
+ *
+ * @param queueName - The name of the queue to process
+ */
 export declare function Processor(queueName: string): ClassDecorator;
+/**
+ * Decorator that marks a class as a BullMQ queue processor with worker options.
+ *
+ * @param queueName - The name of the queue to process
+ * @param workerOptions - Worker configuration options
+ */
 export declare function Processor(queueName: string, workerOptions: NestWorkerOptions): ClassDecorator;
+/**
+ * Decorator that marks a class as a BullMQ queue processor with processor options.
+ *
+ * @param processorOptions - Processor configuration options
+ */
 export declare function Processor(processorOptions: ProcessorOptions): ClassDecorator;
+/**
+ * Decorator that marks a class as a BullMQ queue processor with processor and worker options.
+ *
+ * @param processorOptions - Processor configuration options
+ * @param workerOptions - Worker configuration options
+ */
 export declare function Processor(processorOptions: ProcessorOptions, workerOptions: NestWorkerOptions): ClassDecorator;

package/dist/processor.decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"processor.decorator.js","sourceRoot":"","sources":["../src/processor.decorator.ts"],"names":[],"mappings":";AAAA,0DAA0D;;AA2B1D,8BAuBC;AAhDD,gEAA4D;AAC5D,2CAKwB;AAmBxB,SAAgB,SAAS,CACvB,kBAA8C,EAC9C,kBAAsC;IAEtC,OAAO,CAAC,MAA2B,EAAE,EAAE;QACrC,MAAM,eAAe,GAAG,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC;QACjD,IAAI,eAAe,EAAE,CAAC;YACpB,MAAM,CAAC,SAAS,CAAC,OAAO,GAAG,KAAK,WAAW,GAAQ;gBACjD,MAAM,GAAG,GAAG,IAAI,gCAAc,CAAC;oBAC7B,EAAE,EAAE,GAAG,CAAC,EAAE;oBACV,IAAI,EAAE,OAAO;iBACd,CAAC,CAAC;gBAEH,GAAG,CAAC,GAAG,CAAC,gBAAO,EAAE,GAAG,CAAC,CAAC;gBAEtB,OAAO,MAAM,gCAAc,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,CACxC,eAAe,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,CAChC,CAAC;YACJ,CAAC,CAAC;QACJ,CAAC;QAED,IAAA,kBAAa,EAAC,kBAAyB,EAAE,kBAAyB,CAAC,CAAC,MAAM,CAAC,CAAC;IAC9E,CAAC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"processor.decorator.js","sourceRoot":"","sources":["../src/processor.decorator.ts"],"names":[],"mappings":";AAAA,0DAA0D;;AAqD1D,8BAuBC;AA1ED,gEAA4D;AAC5D,2CAKwB;AA6CxB,SAAgB,SAAS,CACvB,kBAA8C,EAC9C,kBAAsC;IAEtC,OAAO,CAAC,MAA2B,EAAE,EAAE;QACrC,MAAM,eAAe,GAAG,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC;QACjD,IAAI,eAAe,EAAE,CAAC;YACpB,MAAM,CAAC,SAAS,CAAC,OAAO,GAAG,KAAK,WAAW,GAAQ;gBACjD,MAAM,GAAG,GAAG,IAAI,gCAAc,CAAC;oBAC7B,EAAE,EAAE,GAAG,CAAC,EAAE;oBACV,IAAI,EAAE,OAAO;iBACd,CAAC,CAAC;gBAEH,GAAG,CAAC,GAAG,CAAC,gBAAO,EAAE,GAAG,CAAC,CAAC;gBAEtB,OAAO,MAAM,gCAAc,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,CACxC,eAAe,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,CAChC,CAAC;YACJ,CAAC,CAAC;QACJ,CAAC;QAED,IAAA,kBAAa,EAAC,kBAAyB,EAAE,kBAAyB,CAAC,CAAC,MAAM,CAAC,CAAC;IAC9E,CAAC,CAAC;AACJ,CAAC"}

package/dist/processor.decorator.spec.d.ts

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

package/dist/processor.decorator.spec.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const mockJobRef = Symbol("JOB_REF");
+const mockBaseProcessorDecorator = jest.fn();
+const mockBaseProcessor = jest.fn(() => mockBaseProcessorDecorator);
+jest.mock("@nestjs/bullmq", () => ({
+    JOB_REF: mockJobRef,
+    Processor: mockBaseProcessor,
+    WorkerHost: class WorkerHost {
+    },
+}));
+const request_context_1 = require("@nest-boot/request-context");
+const processor_decorator_1 = require("./processor.decorator");
+describe("Processor", () => {
+    afterEach(() => {
+        jest.restoreAllMocks();
+        jest.clearAllMocks();
+    });
+    it("should wrap process in a queue request context and apply the base decorator", async () => {
+        const set = jest.spyOn(request_context_1.RequestContext.prototype, "set");
+        const run = jest
+            .spyOn(request_context_1.RequestContext, "run")
+            .mockImplementation(async (ctx, callback) => await callback(ctx));
+        const job = {
+            id: "job-1",
+        };
+        class EmailProcessor {
+            async process(input) {
+                await Promise.resolve();
+                return `processed:${input.id}`;
+            }
+        }
+        (0, processor_decorator_1.Processor)("email")(EmailProcessor);
+        await expect(new EmailProcessor().process(job)).resolves.toBe("processed:job-1");
+        expect(set).toHaveBeenCalledWith(mockJobRef, job);
+        expect(run).toHaveBeenCalledWith(expect.objectContaining({
+            id: "job-1",
+            type: "queue",
+        }), expect.any(Function));
+        expect(mockBaseProcessor).toHaveBeenCalledWith("email", undefined);
+        expect(mockBaseProcessorDecorator).toHaveBeenCalledWith(EmailProcessor);
+    });
+    it("should apply the base decorator when no process method exists", () => {
+        class EmptyProcessor {
+        }
+        const processorOptions = {
+            name: "email",
+        };
+        const workerOptions = {
+            concurrency: 2,
+        };
+        (0, processor_decorator_1.Processor)(processorOptions, workerOptions)(EmptyProcessor);
+        expect(mockBaseProcessor).toHaveBeenCalledWith(processorOptions, workerOptions);
+        expect(mockBaseProcessorDecorator).toHaveBeenCalledWith(EmptyProcessor);
+    });
+});
+//# sourceMappingURL=processor.decorator.spec.js.map

package/dist/processor.decorator.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"processor.decorator.spec.js","sourceRoot":"","sources":["../src/processor.decorator.spec.ts"],"names":[],"mappings":";;AAAA,MAAM,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;AACrC,MAAM,0BAA0B,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;AAC7C,MAAM,iBAAiB,GAAG,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,0BAA0B,CAAC,CAAC;AAEpE,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,GAAG,EAAE,CAAC,CAAC;IACjC,OAAO,EAAE,UAAU;IACnB,SAAS,EAAE,iBAAiB;IAC5B,UAAU,EAAE,MAAM,UAAU;KAAG;CAChC,CAAC,CAAC,CAAC;AAEJ,gEAA4D;AAE5D,+DAAkD;AAElD,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IACzB,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6EAA6E,EAAE,KAAK,IAAI,EAAE;QAC3F,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,gCAAc,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QACxD,MAAM,GAAG,GAAG,IAAI;aACb,KAAK,CAAC,gCAAc,EAAE,KAAK,CAAC;aAC5B,kBAAkB,CAAC,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,EAAE,CAAC,MAAM,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;QACpE,MAAM,GAAG,GAAG;YACV,EAAE,EAAE,OAAO;SACZ,CAAC;QACF,MAAM,cAAc;YAClB,KAAK,CAAC,OAAO,CAAC,KAAiB;gBAC7B,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC;gBACxB,OAAO,aAAa,KAAK,CAAC,EAAE,EAAE,CAAC;YACjC,CAAC;SACF;QAED,IAAA,+BAAS,EAAC,OAAO,CAAC,CAAC,cAAuB,CAAC,CAAC;QAE5C,MAAM,MAAM,CAAC,IAAI,cAAc,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAC3D,iBAAiB,CAClB,CAAC;QAEF,MAAM,CAAC,GAAG,CAAC,CAAC,oBAAoB,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;QAClD,MAAM,CAAC,GAAG,CAAC,CAAC,oBAAoB,CAC9B,MAAM,CAAC,gBAAgB,CAAC;YACtB,EAAE,EAAE,OAAO;YACX,IAAI,EAAE,OAAO;SACd,CAAC,EACF,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CACrB,CAAC;QACF,MAAM,CAAC,iBAAiB,CAAC,CAAC,oBAAoB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QACnE,MAAM,CAAC,0BAA0B,CAAC,CAAC,oBAAoB,CAAC,cAAc,CAAC,CAAC;IAC1E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+DAA+D,EAAE,GAAG,EAAE;QACvE,MAAM,cAAc;SAAG;QACvB,MAAM,gBAAgB,GAAG;YACvB,IAAI,EAAE,OAAO;SACd,CAAC;QACF,MAAM,aAAa,GAAG;YACpB,WAAW,EAAE,CAAC;SACf,CAAC;QAEF,IAAA,+BAAS,EAAC,gBAAgB,EAAE,aAAa,CAAC,CAAC,cAAuB,CAAC,CAAC;QAEpE,MAAM,CAAC,iBAAiB,CAAC,CAAC,oBAAoB,CAC5C,gBAAgB,EAChB,aAAa,CACd,CAAC;QACF,MAAM,CAAC,0BAA0B,CAAC,CAAC,oBAAoB,CAAC,cAAc,CAAC,CAAC;IAC1E,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}