@nest-boot/bullmq 7.0.1 → 7.0.3

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);
     }
@@ -38,7 +71,7 @@ exports.BullModule = BullModule = __decorate([
             {
                 provide: bullmq_module_definition_1.MODULE_OPTIONS_TOKEN,
                 inject: [{ token: bullmq_module_definition_1.BASE_MODULE_OPTIONS_TOKEN, optional: true }],
-                useFactory: (options = {}) => options,
+                useFactory: (options) => options ?? {},
             },
         ],
         exports: [bullmq_module_definition_1.MODULE_OPTIONS_TOKEN],

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,UAA6B,EAAE,EAAE,EAAE,CAAC,OAAO;aACzD;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/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/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"}