@nest-boot/bullmq-mikro-orm 7.0.3 → 7.0.5

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

@@ -1,10 +1,16 @@
 import { EntityClass, EntityData } from "@mikro-orm/core";
 import { Job } from "bullmq";
 import { JobEntity } from "./entities/job.entity";
+/** Configuration options for the BullMQ-MikroORM integration module. */
 export interface BullMQMikroORMModuleOptions<T extends JobEntity = JobEntity> {
+    /** The MikroORM entity class used to persist BullMQ jobs. */
     jobEntity: EntityClass<T>;
+    /** Time-to-live (in milliseconds) after which completed/failed jobs are deleted. */
     jobTTL?: number;
+    /** Custom function to convert a BullMQ job into entity data for persistence. */
     convertJobToEntityData?: (job: Job) => EntityData<T> | Promise<EntityData<T>>;
+    /** Queue names to include for persistence. If unset, all queues are included. */
     includeQueues?: string[];
+    /** Queue names to exclude from persistence. */
     excludeQueues?: string[];
 }

package/dist/bullmq-mikro-orm.module.d.ts

@@ -2,7 +2,24 @@ import { ConfigurableModuleAsyncOptions } from "@nestjs/common";
 import { ConfigurableModuleClass } from "./bullmq-mikro-orm.module-definition";
 import { BullMQMikroORMModuleOptions } from "./bullmq-mikro-orm-module-options.interface";
 import { JobEntity } from "./entities/job.entity";
+/**
+ * Module that integrates BullMQ job events with MikroORM persistence.
+ *
+ * @remarks
+ * Subscribes to BullMQ queue events and automatically persists job state
+ * changes to the database using the configured entity.
+ */
 export declare class BullMQMikroORMModule extends ConfigurableModuleClass {
+    /**
+     * Registers the module with synchronous options.
+     * @param options - Configuration including the job entity class
+     * @returns Dynamic module configuration
+     */
     static forRoot<T extends JobEntity = JobEntity>(options: BullMQMikroORMModuleOptions<T>): import("@nestjs/common").DynamicModule;
+    /**
+     * Registers the module with asynchronous options via factory functions.
+     * @param options - Async configuration options
+     * @returns Dynamic module configuration
+     */
     static forRootAsync<T extends JobEntity = JobEntity>(options: ConfigurableModuleAsyncOptions<BullMQMikroORMModuleOptions<T>>): import("@nestjs/common").DynamicModule;
 }

package/dist/bullmq-mikro-orm.module.js

@@ -11,10 +11,27 @@ const common_1 = require("@nestjs/common");
 const core_1 = require("@nestjs/core");
 const bullmq_mikro_orm_module_definition_1 = require("./bullmq-mikro-orm.module-definition");
 const bullmq_mikro_orm_service_1 = require("./bullmq-mikro-orm.service");
+/**
+ * Module that integrates BullMQ job events with MikroORM persistence.
+ *
+ * @remarks
+ * Subscribes to BullMQ queue events and automatically persists job state
+ * changes to the database using the configured entity.
+ */
 let BullMQMikroORMModule = class BullMQMikroORMModule extends bullmq_mikro_orm_module_definition_1.ConfigurableModuleClass {
+    /**
+     * Registers the module with synchronous options.
+     * @param options - Configuration including the job entity class
+     * @returns Dynamic module configuration
+     */
     static forRoot(options) {
         return super.forRoot(options);
     }
+    /**
+     * Registers the module with asynchronous options via factory functions.
+     * @param options - Async configuration options
+     * @returns Dynamic module configuration
+     */
     static forRootAsync(options) {
         return super.forRootAsync(options);
     }

package/dist/bullmq-mikro-orm.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"bullmq-mikro-orm.module.js","sourceRoot":"","sources":["../src/bullmq-mikro-orm.module.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAAgF;AAChF,uCAA+C;AAE/C,6FAA+E;AAC/E,yEAAmE;AAS5D,IAAM,oBAAoB,GAA1B,MAAM,oBAAqB,SAAQ,4DAAuB;IAC/D,MAAM,CAAC,OAAO,CACZ,OAAuC;QAEvC,OAAO,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAChC,CAAC;IAED,MAAM,CAAC,YAAY,CACjB,OAAuE;QAEvE,OAAO,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IACrC,CAAC;CACF,CAAA;AAZY,oDAAoB;+BAApB,oBAAoB;IALhC,IAAA,eAAM,GAAE;IACR,IAAA,eAAM,EAAC;QACN,OAAO,EAAE,CAAC,sBAAe,CAAC;QAC1B,SAAS,EAAE,CAAC,gDAAqB,CAAC;KACnC,CAAC;GACW,oBAAoB,CAYhC"}
+{"version":3,"file":"bullmq-mikro-orm.module.js","sourceRoot":"","sources":["../src/bullmq-mikro-orm.module.ts"],"names":[],"mappings":";;;;;;;;;AAAA,2CAAgF;AAChF,uCAA+C;AAE/C,6FAA+E;AAC/E,yEAAmE;AAInE;;;;;;GAMG;AAMI,IAAM,oBAAoB,GAA1B,MAAM,oBAAqB,SAAQ,4DAAuB;IAC/D;;;;OAIG;IACH,MAAM,CAAC,OAAO,CACZ,OAAuC;QAEvC,OAAO,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,YAAY,CACjB,OAAuE;QAEvE,OAAO,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IACrC,CAAC;CACF,CAAA;AAtBY,oDAAoB;+BAApB,oBAAoB;IALhC,IAAA,eAAM,GAAE;IACR,IAAA,eAAM,EAAC;QACN,OAAO,EAAE,CAAC,sBAAe,CAAC;QAC1B,SAAS,EAAE,CAAC,gDAAqB,CAAC;KACnC,CAAC;GACW,oBAAoB,CAsBhC"}

package/dist/entities/job.entity.d.ts

@@ -1,17 +1,37 @@
 import { Opt } from "@mikro-orm/core";
 import { JobProgress } from "bullmq";
+/**
+ * Abstract base entity for persisting BullMQ job data in the database.
+ *
+ * @remarks
+ * Extend this entity in your application to create a concrete job table.
+ * Automatically populated by the BullMQ-MikroORM subscriber.
+ */
 export declare abstract class JobEntity {
+    /** BullMQ job identifier. */
     id: string;
+    /** Name of the BullMQ queue this job belongs to. */
     queueName: string;
+    /** Job name (type identifier). */
     name: string;
+    /** JSON payload of the job. */
     data: any;
+    /** Return value from the job processor, if completed. */
     returnValue?: any;
+    /** Error message if the job failed. */
     failedReason?: string;
+    /** Job priority (lower values = higher priority). */
     priority: number;
+    /** Current progress of the job (number or object). */
     progress: Opt<JobProgress>;
+    /** Current status of the job. */
     status: string;
+    /** Timestamp when the job started processing. */
     startedAt?: Date;
+    /** Timestamp when the job finished processing. */
     finishedAt?: Date;
+    /** Timestamp when the job was created. */
     createdAt: Opt<Date>;
+    /** Timestamp of the last update. */
     updatedAt: Opt<Date>;
 }

package/dist/entities/job.entity.js

@@ -12,9 +12,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.JobEntity = void 0;
 const core_1 = require("@mikro-orm/core");
 const job_status_enum_1 = require("../enums/job-status.enum");
+/**
+ * Abstract base entity for persisting BullMQ job data in the database.
+ *
+ * @remarks
+ * Extend this entity in your application to create a concrete job table.
+ * Automatically populated by the BullMQ-MikroORM subscriber.
+ */
 let JobEntity = class JobEntity {
     constructor() {
+        /** Timestamp when the job was created. */
         this.createdAt = new Date();
+        /** Timestamp of the last update. */
         this.updatedAt = new Date();
     }
 };

package/dist/entities/job.entity.js.map

@@ -1 +1 @@
-{"version":3,"file":"job.entity.js","sourceRoot":"","sources":["../../src/entities/job.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,0CAQyB;AAGzB,8DAAqD;AAG9C,IAAe,SAAS,GAAxB,MAAe,SAAS;IAAxB;QAuCL,cAAS,GAAc,IAAI,IAAI,EAAE,CAAC;QAQlC,cAAS,GAAc,IAAI,IAAI,EAAE,CAAC;IACpC,CAAC;CAAA,CAAA;AAhDqB,8BAAS;AAE7B;IADC,IAAA,iBAAU,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,MAAM,EAAE,CAAC;;qCACnB;AAGZ;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,MAAM,EAAE,CAAC;;4CACV;AAInB;IAFC,IAAA,YAAK,GAAE;IACP,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,MAAM,EAAE,CAAC;;uCACf;AAGd;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,CAAC;;uCAChB;AAGX;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;8CACzB;AAGlB;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;+CACvB;AAGtB;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,OAAO,EAAE,CAAC;;2CACZ;AAIlB;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,CAAC;;2CACC;AAI5B;IAFC,IAAA,YAAK,GAAE;IACP,IAAA,WAAI,EAAC,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,2BAAS,EAAE,CAAC;;yCACjB;AAGhB;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;8BACnC,IAAI;4CAAC;AAGjB;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;8BAClC,IAAI;6CAAC;AAIlB;IAFC,IAAA,YAAK,GAAE;IACP,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC;;4CAClB;AAQlC;IANC,IAAA,YAAK,GAAE;IACP,IAAA,eAAQ,EAAC;QACR,IAAI,EAAE,QAAC,CAAC,QAAQ;QAChB,UAAU,EAAE,OAAO;QACnB,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE;KAC3B,CAAC;;4CACgC;oBA/Cd,SAAS;IAD9B,IAAA,aAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;GACL,SAAS,CAgD9B"}
+{"version":3,"file":"job.entity.js","sourceRoot":"","sources":["../../src/entities/job.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,0CAQyB;AAGzB,8DAAqD;AAErD;;;;;;GAMG;AAEI,IAAe,SAAS,GAAxB,MAAe,SAAS;IAAxB;QAgDL,0CAA0C;QAG1C,cAAS,GAAc,IAAI,IAAI,EAAE,CAAC;QAElC,oCAAoC;QAOpC,cAAS,GAAc,IAAI,IAAI,EAAE,CAAC;IACpC,CAAC;CAAA,CAAA;AA7DqB,8BAAS;AAG7B;IADC,IAAA,iBAAU,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,MAAM,EAAE,CAAC;;qCACnB;AAIZ;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,MAAM,EAAE,CAAC;;4CACV;AAKnB;IAFC,IAAA,YAAK,GAAE;IACP,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,MAAM,EAAE,CAAC;;uCACf;AAId;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,CAAC;;uCAChB;AAIX;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;8CACzB;AAIlB;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;+CACvB;AAItB;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,OAAO,EAAE,CAAC;;2CACZ;AAKlB;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,IAAI,EAAE,CAAC;;2CACC;AAK5B;IAFC,IAAA,YAAK,GAAE;IACP,IAAA,WAAI,EAAC,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,2BAAS,EAAE,CAAC;;yCACjB;AAIhB;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;8BACnC,IAAI;4CAAC;AAIjB;IADC,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;8BAClC,IAAI;6CAAC;AAKlB;IAFC,IAAA,YAAK,GAAE;IACP,IAAA,eAAQ,EAAC,EAAE,IAAI,EAAE,QAAC,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC;;4CAClB;AASlC;IANC,IAAA,YAAK,GAAE;IACP,IAAA,eAAQ,EAAC;QACR,IAAI,EAAE,QAAC,CAAC,QAAQ;QAChB,UAAU,EAAE,OAAO;QACnB,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE;KAC3B,CAAC;;4CACgC;oBA5Dd,SAAS;IAD9B,IAAA,aAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;GACL,SAAS,CA6D9B"}

package/dist/enums/job-status.enum.d.ts

@@ -1,10 +1,19 @@
+/** Enumeration of possible BullMQ job statuses persisted in the database. */
 export declare enum JobStatus {
+    /** Job is actively being processed. */
     ACTIVE = "active",
+    /** Job has completed successfully. */
     COMPLETED = "completed",
+    /** Job is delayed and will be processed later. */
     DELAYED = "delayed",
+    /** Job has failed after exhausting all retry attempts. */
     FAILED = "failed",
+    /** Job is waiting in the prioritized queue. */
     PRIORITIZED = "prioritized",
+    /** Job status is unknown. */
     UNKNOWN = "unknown",
+    /** Job is waiting in the queue to be processed. */
     WAITING = "waiting",
+    /** Job is waiting for its child jobs to complete. */
     WAITING_CHILDREN = "waiting-children"
 }

package/dist/enums/job-status.enum.js

@@ -1,15 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.JobStatus = void 0;
+/** Enumeration of possible BullMQ job statuses persisted in the database. */
 var JobStatus;
 (function (JobStatus) {
+    /** Job is actively being processed. */
     JobStatus["ACTIVE"] = "active";
+    /** Job has completed successfully. */
     JobStatus["COMPLETED"] = "completed";
+    /** Job is delayed and will be processed later. */
     JobStatus["DELAYED"] = "delayed";
+    /** Job has failed after exhausting all retry attempts. */
     JobStatus["FAILED"] = "failed";
+    /** Job is waiting in the prioritized queue. */
     JobStatus["PRIORITIZED"] = "prioritized";
+    /** Job status is unknown. */
     JobStatus["UNKNOWN"] = "unknown";
+    /** Job is waiting in the queue to be processed. */
     JobStatus["WAITING"] = "waiting";
+    /** Job is waiting for its child jobs to complete. */
     JobStatus["WAITING_CHILDREN"] = "waiting-children";
 })(JobStatus || (exports.JobStatus = JobStatus = {}));
 //# sourceMappingURL=job-status.enum.js.map

package/dist/enums/job-status.enum.js.map

@@ -1 +1 @@
-{"version":3,"file":"job-status.enum.js","sourceRoot":"","sources":["../../src/enums/job-status.enum.ts"],"names":[],"mappings":";;;AAAA,IAAY,SASX;AATD,WAAY,SAAS;IACnB,8BAAiB,CAAA;IACjB,oCAAuB,CAAA;IACvB,gCAAmB,CAAA;IACnB,8BAAiB,CAAA;IACjB,wCAA2B,CAAA;IAC3B,gCAAmB,CAAA;IACnB,gCAAmB,CAAA;IACnB,kDAAqC,CAAA;AACvC,CAAC,EATW,SAAS,yBAAT,SAAS,QASpB"}
+{"version":3,"file":"job-status.enum.js","sourceRoot":"","sources":["../../src/enums/job-status.enum.ts"],"names":[],"mappings":";;;AAAA,6EAA6E;AAC7E,IAAY,SAiBX;AAjBD,WAAY,SAAS;IACnB,uCAAuC;IACvC,8BAAiB,CAAA;IACjB,sCAAsC;IACtC,oCAAuB,CAAA;IACvB,kDAAkD;IAClD,gCAAmB,CAAA;IACnB,0DAA0D;IAC1D,8BAAiB,CAAA;IACjB,+CAA+C;IAC/C,wCAA2B,CAAA;IAC3B,6BAA6B;IAC7B,gCAAmB,CAAA;IACnB,mDAAmD;IACnD,gCAAmB,CAAA;IACnB,qDAAqD;IACrD,kDAAqC,CAAA;AACvC,CAAC,EAjBW,SAAS,yBAAT,SAAS,QAiBpB"}