@nest-boot/schedule 7.0.2 → 7.1.0

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;
+    };
+})();
+describe("public API", () => {
+    it("should export schedule module APIs", async () => {
+        const api = await Promise.resolve().then(() => __importStar(require(".")));
+        expect(api.ScheduleModule).toBeDefined();
+        expect(api.ScheduleRegistry).toBeDefined();
+        expect(api.Schedule).toBeDefined();
+        expect(api.Cron).toBeDefined();
+        expect(api.Interval).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,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IAC1B,EAAE,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;QAClD,MAAM,GAAG,GAAG,wDAAa,GAAG,GAAC,CAAC;QAE9B,MAAM,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,WAAW,EAAE,CAAC;QACzC,MAAM,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,WAAW,EAAE,CAAC;QAC3C,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC;QACnC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;QAC/B,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC;IACrC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

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

@@ -1,5 +1,17 @@
 import { type RegisterQueueOptions } from "@nest-boot/bullmq";
+import { type ConnectionOptions } from "bullmq";
+/**
+ * Configuration options for the schedule module.
+ *
+ * @remarks
+ * Extends BullMQ queue options with schedule-specific settings
+ * for controlling job processing behavior.
+ */
 export interface ScheduleModuleOptions extends RegisterQueueOptions {
+    /** Whether to automatically start processing scheduled jobs on module init. */
     autorun?: boolean;
+    /** Maximum number of concurrent scheduled jobs to process. */
     concurrency?: number;
+    /** Optional Redis connection options for the schedule queue. */
+    connection?: ConnectionOptions;
 }

package/dist/schedule-options.interface.d.ts

@@ -1,6 +1,10 @@
 import { JobSchedulerTemplateOptions } from "bullmq";
+/** Options for configuring a scheduled job. */
 export interface ScheduleOptions extends JobSchedulerTemplateOptions {
+    /** Type of schedule: `"cron"` for cron expressions or `"interval"` for millisecond intervals. */
     type: "cron" | "interval";
+    /** Cron expression (for `"cron"` type) or millisecond interval (for `"interval"` type). */
     value: number | string;
+    /** Timezone for cron expressions (defaults to `"UTC"`). */
     timezone?: string;
 }

package/dist/schedule.decorator.d.ts

@@ -1,4 +1,21 @@
 import { type ScheduleOptions } from "./schedule-options.interface";
+/**
+ * Decorator that registers a method as a scheduled job.
+ * @param options - Schedule configuration (type, value, timezone, etc.)
+ * @returns Method decorator
+ */
 export declare const Schedule: (options: ScheduleOptions) => <T>(target: object, propertyKey: string, descriptor: TypedPropertyDescriptor<T>) => void;
+/**
+ * Decorator that registers a method as a cron-scheduled job.
+ * @param value - Cron expression (e.g. `"0 * * * *"`)
+ * @param options - Additional schedule options (timezone, etc.)
+ * @returns Method decorator
+ */
 export declare const Cron: (value: string, options?: Omit<ScheduleOptions, "type" | "value">) => <T>(target: object, propertyKey: string, descriptor: TypedPropertyDescriptor<T>) => void;
+/**
+ * Decorator that registers a method as an interval-scheduled job.
+ * @param value - Interval in milliseconds
+ * @param options - Additional schedule options
+ * @returns Method decorator
+ */
 export declare const Interval: (value: number | string, options?: Omit<ScheduleOptions, "type" | "value">) => <T>(target: object, propertyKey: string, descriptor: TypedPropertyDescriptor<T>) => void;

package/dist/schedule.decorator.js

@@ -3,16 +3,33 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Interval = exports.Cron = exports.Schedule = void 0;
 const common_1 = require("@nestjs/common");
 const schedule_module_definition_1 = require("./schedule.module-definition");
+/**
+ * Decorator that registers a method as a scheduled job.
+ * @param options - Schedule configuration (type, value, timezone, etc.)
+ * @returns Method decorator
+ */
 const Schedule = (options) => (target, propertyKey, descriptor) => {
     (0, common_1.SetMetadata)(schedule_module_definition_1.SCHEDULE_METADATA_KEY, options)(target, propertyKey, descriptor);
 };
 exports.Schedule = Schedule;
+/**
+ * Decorator that registers a method as a cron-scheduled job.
+ * @param value - Cron expression (e.g. `"0 * * * *"`)
+ * @param options - Additional schedule options (timezone, etc.)
+ * @returns Method decorator
+ */
 const Cron = (value, options) => (0, exports.Schedule)({
     type: "cron",
     value,
     ...(options ?? {}),
 });
 exports.Cron = Cron;
+/**
+ * Decorator that registers a method as an interval-scheduled job.
+ * @param value - Interval in milliseconds
+ * @param options - Additional schedule options
+ * @returns Method decorator
+ */
 const Interval = (value, options) => (0, exports.Schedule)({
     type: "interval",
     value,

package/dist/schedule.decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"schedule.decorator.js","sourceRoot":"","sources":["../src/schedule.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAA6C;AAE7C,6EAAqE;AAG9D,MAAM,QAAQ,GACnB,CAAC,OAAwB,EAAE,EAAE,CAC7B,CACE,MAAc,EACd,WAAmB,EACnB,UAAsC,EACtC,EAAE;IACF,IAAA,oBAAW,EAA0B,kDAAqB,EAAE,OAAO,CAAC,CAClE,MAAM,EACN,WAAW,EACX,UAAU,CACX,CAAC;AACJ,CAAC,CAAC;AAZS,QAAA,QAAQ,YAYjB;AAEG,MAAM,IAAI,GAAG,CAClB,KAAa,EACb,OAAiD,EACjD,EAAE,CACF,IAAA,gBAAQ,EAAC;IACP,IAAI,EAAE,MAAM;IACZ,KAAK;IACL,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC;CACnB,CAAC,CAAC;AARQ,QAAA,IAAI,QAQZ;AAEE,MAAM,QAAQ,GAAG,CACtB,KAAsB,EACtB,OAAiD,EACjD,EAAE,CACF,IAAA,gBAAQ,EAAC;IACP,IAAI,EAAE,UAAU;IAChB,KAAK;IACL,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC;CACnB,CAAC,CAAC;AARQ,QAAA,QAAQ,YAQhB"}
+{"version":3,"file":"schedule.decorator.js","sourceRoot":"","sources":["../src/schedule.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAA6C;AAE7C,6EAAqE;AAGrE;;;;GAIG;AACI,MAAM,QAAQ,GACnB,CAAC,OAAwB,EAAE,EAAE,CAC7B,CACE,MAAc,EACd,WAAmB,EACnB,UAAsC,EACtC,EAAE;IACF,IAAA,oBAAW,EAA0B,kDAAqB,EAAE,OAAO,CAAC,CAClE,MAAM,EACN,WAAW,EACX,UAAU,CACX,CAAC;AACJ,CAAC,CAAC;AAZS,QAAA,QAAQ,YAYjB;AAEJ;;;;;GAKG;AACI,MAAM,IAAI,GAAG,CAClB,KAAa,EACb,OAAiD,EACjD,EAAE,CACF,IAAA,gBAAQ,EAAC;IACP,IAAI,EAAE,MAAM;IACZ,KAAK;IACL,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC;CACnB,CAAC,CAAC;AARQ,QAAA,IAAI,QAQZ;AAEL;;;;;GAKG;AACI,MAAM,QAAQ,GAAG,CACtB,KAAsB,EACtB,OAAiD,EACjD,EAAE,CACF,IAAA,gBAAQ,EAAC;IACP,IAAI,EAAE,UAAU;IAChB,KAAK;IACL,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC;CACnB,CAAC,CAAC;AARQ,QAAA,QAAQ,YAQhB"}

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

@@ -0,0 +1 @@
+import "reflect-metadata";

package/dist/schedule.decorator.spec.js

@@ -0,0 +1,108 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+require("reflect-metadata");
+const schedule_decorator_1 = require("./schedule.decorator");
+const schedule_module_definition_1 = require("./schedule.module-definition");
+function getMethod(prototype, name) {
+    return Object.getOwnPropertyDescriptor(prototype, name)?.value;
+}
+describe("schedule decorators", () => {
+    class ExampleSchedules {
+        explicit() {
+            return undefined;
+        }
+        cron() {
+            return undefined;
+        }
+        interval() {
+            return undefined;
+        }
+    }
+    __decorate([
+        (0, schedule_decorator_1.Schedule)({
+            type: "cron",
+            value: "0 1 * * *",
+            timezone: "Asia/Shanghai",
+        }),
+        __metadata("design:type", Function),
+        __metadata("design:paramtypes", []),
+        __metadata("design:returntype", void 0)
+    ], ExampleSchedules.prototype, "explicit", null);
+    __decorate([
+        (0, schedule_decorator_1.Cron)("* * * * *", {
+            attempts: 2,
+            timezone: "UTC",
+        }),
+        __metadata("design:type", Function),
+        __metadata("design:paramtypes", []),
+        __metadata("design:returntype", void 0)
+    ], ExampleSchedules.prototype, "cron", null);
+    __decorate([
+        (0, schedule_decorator_1.Interval)("5000", {
+            removeOnComplete: true,
+        }),
+        __metadata("design:type", Function),
+        __metadata("design:paramtypes", []),
+        __metadata("design:returntype", void 0)
+    ], ExampleSchedules.prototype, "interval", null);
+    it("should attach explicit schedule metadata", () => {
+        expect(Reflect.getMetadata(schedule_module_definition_1.SCHEDULE_METADATA_KEY, getMethod(ExampleSchedules.prototype, "explicit"))).toEqual({
+            type: "cron",
+            value: "0 1 * * *",
+            timezone: "Asia/Shanghai",
+        });
+    });
+    it("should build cron and interval metadata with optional job options", () => {
+        expect(Reflect.getMetadata(schedule_module_definition_1.SCHEDULE_METADATA_KEY, getMethod(ExampleSchedules.prototype, "cron"))).toEqual({
+            attempts: 2,
+            timezone: "UTC",
+            type: "cron",
+            value: "* * * * *",
+        });
+        expect(Reflect.getMetadata(schedule_module_definition_1.SCHEDULE_METADATA_KEY, getMethod(ExampleSchedules.prototype, "interval"))).toEqual({
+            removeOnComplete: true,
+            type: "interval",
+            value: "5000",
+        });
+    });
+    it("should default omitted decorator options to an empty object", () => {
+        class Defaults {
+            cron() {
+                return undefined;
+            }
+            interval() {
+                return undefined;
+            }
+        }
+        __decorate([
+            (0, schedule_decorator_1.Cron)("0 * * * *"),
+            __metadata("design:type", Function),
+            __metadata("design:paramtypes", []),
+            __metadata("design:returntype", void 0)
+        ], Defaults.prototype, "cron", null);
+        __decorate([
+            (0, schedule_decorator_1.Interval)(1000),
+            __metadata("design:type", Function),
+            __metadata("design:paramtypes", []),
+            __metadata("design:returntype", void 0)
+        ], Defaults.prototype, "interval", null);
+        expect(Reflect.getMetadata(schedule_module_definition_1.SCHEDULE_METADATA_KEY, getMethod(Defaults.prototype, "cron"))).toEqual({
+            type: "cron",
+            value: "0 * * * *",
+        });
+        expect(Reflect.getMetadata(schedule_module_definition_1.SCHEDULE_METADATA_KEY, getMethod(Defaults.prototype, "interval"))).toEqual({
+            type: "interval",
+            value: 1000,
+        });
+    });
+});
+//# sourceMappingURL=schedule.decorator.spec.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"schedule.decorator.spec.js","sourceRoot":"","sources":["../src/schedule.decorator.spec.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,4BAA0B;AAE1B,6DAAgE;AAChE,6EAAqE;AAErE,SAAS,SAAS,CAAC,SAAiB,EAAE,IAAY;IAChD,OAAO,MAAM,CAAC,wBAAwB,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,KAAK,CAAC;AACjE,CAAC;AAED,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;IACnC,MAAM,gBAAgB;QAMpB,QAAQ;YACN,OAAO,SAAS,CAAC;QACnB,CAAC;QAMD,IAAI;YACF,OAAO,SAAS,CAAC;QACnB,CAAC;QAKD,QAAQ;YACN,OAAO,SAAS,CAAC;QACnB,CAAC;KACF;IAlBC;QALC,IAAA,6BAAQ,EAAC;YACR,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,WAAW;YAClB,QAAQ,EAAE,eAAe;SAC1B,CAAC;;;;oDAGD;IAMD;QAJC,IAAA,yBAAI,EAAC,WAAW,EAAE;YACjB,QAAQ,EAAE,CAAC;YACX,QAAQ,EAAE,KAAK;SAChB,CAAC;;;;gDAGD;IAKD;QAHC,IAAA,6BAAQ,EAAC,MAAM,EAAE;YAChB,gBAAgB,EAAE,IAAI;SACvB,CAAC;;;;oDAGD;IAGH,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;QAClD,MAAM,CACJ,OAAO,CAAC,WAAW,CACjB,kDAAqB,EACrB,SAAS,CAAC,gBAAgB,CAAC,SAAS,EAAE,UAAU,CAAC,CAClD,CACF,CAAC,OAAO,CAAC;YACR,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,WAAW;YAClB,QAAQ,EAAE,eAAe;SAC1B,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mEAAmE,EAAE,GAAG,EAAE;QAC3E,MAAM,CACJ,OAAO,CAAC,WAAW,CACjB,kDAAqB,EACrB,SAAS,CAAC,gBAAgB,CAAC,SAAS,EAAE,MAAM,CAAC,CAC9C,CACF,CAAC,OAAO,CAAC;YACR,QAAQ,EAAE,CAAC;YACX,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,WAAW;SACnB,CAAC,CAAC;QACH,MAAM,CACJ,OAAO,CAAC,WAAW,CACjB,kDAAqB,EACrB,SAAS,CAAC,gBAAgB,CAAC,SAAS,EAAE,UAAU,CAAC,CAClD,CACF,CAAC,OAAO,CAAC;YACR,gBAAgB,EAAE,IAAI;YACtB,IAAI,EAAE,UAAU;YAChB,KAAK,EAAE,MAAM;SACd,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6DAA6D,EAAE,GAAG,EAAE;QACrE,MAAM,QAAQ;YAEZ,IAAI;gBACF,OAAO,SAAS,CAAC;YACnB,CAAC;YAGD,QAAQ;gBACN,OAAO,SAAS,CAAC;YACnB,CAAC;SACF;QARC;YADC,IAAA,yBAAI,EAAC,WAAW,CAAC;;;;4CAGjB;QAGD;YADC,IAAA,6BAAQ,EAAC,IAAI,CAAC;;;;gDAGd;QAGH,MAAM,CACJ,OAAO,CAAC,WAAW,CACjB,kDAAqB,EACrB,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC,CACtC,CACF,CAAC,OAAO,CAAC;YACR,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,WAAW;SACnB,CAAC,CAAC;QACH,MAAM,CACJ,OAAO,CAAC,WAAW,CACjB,kDAAqB,EACrB,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC,CAC1C,CACF,CAAC,OAAO,CAAC;YACR,IAAI,EAAE,UAAU;YAChB,KAAK,EAAE,IAAI;SACZ,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

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

@@ -2,4 +2,4 @@ import { type ScheduleModuleOptions } from "./schedule-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<ScheduleModuleOptions, "forRoot", "create", {}>, BASE_MODULE_OPTIONS_TOKEN: string | symbol;
+export declare const ConfigurableModuleClass: import("@nestjs/common").ConfigurableModuleCls<ScheduleModuleOptions, "forRoot", "create", {}>, BASE_MODULE_OPTIONS_TOKEN: string | symbol, OPTIONS_TYPE: ScheduleModuleOptions & Partial<{}>, ASYNC_OPTIONS_TYPE: import("@nestjs/common").ConfigurableModuleAsyncOptions<ScheduleModuleOptions, "create"> & Partial<{}>;

package/dist/schedule.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("ScheduleModuleOptions");
 _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=schedule.module-definition.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"schedule.module-definition.js","sourceRoot":"","sources":["../src/schedule.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,uBAAuB,CAAC,CAAC;AAEvD,KAGT,IAAI,kCAAyB,EAAyB;KACvD,kBAAkB,CAAC,SAAS,CAAC;KAC7B,KAAK,EAAE,EAJR,+BAAuB,+BACD,iCAAyB,2BAGtC"}
+{"version":3,"file":"schedule.module-definition.js","sourceRoot":"","sources":["../src/schedule.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,uBAAuB,CAAC,CAAC;AAEvD,KAKT,IAAI,kCAAyB,EAAyB;KACvD,kBAAkB,CAAC,SAAS,CAAC;KAC7B,KAAK,EAAE,EANR,+BAAuB,+BACD,iCAAyB,4BAC/C,oBAAY,oBACZ,0BAAkB,yBAGT"}

package/dist/schedule.module.d.ts

@@ -1,3 +1,23 @@
-import { ConfigurableModuleClass } from "./schedule.module-definition";
+import { type DynamicModule } from "@nestjs/common";
+import { ASYNC_OPTIONS_TYPE, ConfigurableModuleClass, OPTIONS_TYPE } from "./schedule.module-definition";
+/**
+ * Job scheduling module powered by BullMQ.
+ *
+ * @remarks
+ * Provides cron-like job scheduling using BullMQ queues.
+ * Supports decorator-based schedule registration and configurable concurrency.
+ */
 export declare class ScheduleModule extends ConfigurableModuleClass {
+    /**
+     * Registers the ScheduleModule with the given options.
+     * @param options - Configuration options including connection and concurrency
+     * @returns Dynamic module configuration
+     */
+    static forRoot(options: typeof OPTIONS_TYPE): DynamicModule;
+    /**
+     * Registers the ScheduleModule asynchronously with factory functions.
+     * @param options - Async configuration options
+     * @returns Dynamic module configuration
+     */
+    static forRootAsync(options: typeof ASYNC_OPTIONS_TYPE): DynamicModule;
 }

package/dist/schedule.module.js

@@ -13,7 +13,30 @@ const core_1 = require("@nestjs/core");
 const schedule_module_definition_1 = require("./schedule.module-definition");
 const schedule_processor_1 = require("./schedule.processor");
 const schedule_registry_1 = require("./schedule.registry");
+/**
+ * Job scheduling module powered by BullMQ.
+ *
+ * @remarks
+ * Provides cron-like job scheduling using BullMQ queues.
+ * Supports decorator-based schedule registration and configurable concurrency.
+ */
 let ScheduleModule = class ScheduleModule extends schedule_module_definition_1.ConfigurableModuleClass {
+    /**
+     * Registers the ScheduleModule with the given options.
+     * @param options - Configuration options including connection and concurrency
+     * @returns Dynamic module configuration
+     */
+    static forRoot(options) {
+        return super.forRoot(options);
+    }
+    /**
+     * Registers the ScheduleModule asynchronously with factory functions.
+     * @param options - Async configuration options
+     * @returns Dynamic module configuration
+     */
+    static forRootAsync(options) {
+        return super.forRootAsync(options);
+    }
 };
 exports.ScheduleModule = ScheduleModule;
 exports.ScheduleModule = ScheduleModule = __decorate([

package/dist/schedule.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"schedule.module.js","sourceRoot":"","sources":["../src/schedule.module.ts"],"names":[],"mappings":";;;;;;;;;AAAA,8CAA+C;AAC/C,2CAAwD;AACxD,uCAA+C;AAE/C,6EAIsC;AACtC,6DAAyD;AACzD,2DAAuD;AAyBhD,IAAM,cAAc,GAApB,MAAM,cAAe,SAAQ,oDAAuB;CAAG,CAAA;AAAjD,wCAAc;yBAAd,cAAc;IAtB1B,IAAA,eAAM,GAAE;IACR,IAAA,eAAM,EAAC;QACN,OAAO,EAAE;YACP,sBAAe;YACf,mBAAU,CAAC,kBAAkB,CAAC;gBAC5B,IAAI,EAAE,UAAU;gBAChB,MAAM,EAAE,CAAC,iDAAoB,CAAC;gBAC9B,UAAU,EAAE,CAAC,OAA8B,EAAE,EAAE,CAAC,OAAO;aACxD,CAAC;SACH;QACD,SAAS,EAAE;YACT,eAAM;YACN,oCAAgB;YAChB,sCAAiB;YACjB;gBACE,OAAO,EAAE,iDAAoB;gBAC7B,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,sDAAyB,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;gBAC9D,UAAU,EAAE,CAAC,OAA+B,EAAE,EAAE,CAAC,OAAO,IAAI,EAAE;aAC/D;SACF;QACD,OAAO,EAAE,CAAC,iDAAoB,CAAC;KAChC,CAAC;GACW,cAAc,CAAmC"}
+{"version":3,"file":"schedule.module.js","sourceRoot":"","sources":["../src/schedule.module.ts"],"names":[],"mappings":";;;;;;;;;AAAA,8CAA+C;AAC/C,2CAA4E;AAC5E,uCAA+C;AAE/C,6EAMsC;AACtC,6DAAyD;AACzD,2DAAuD;AAGvD;;;;;;GAMG;AAuBI,IAAM,cAAc,GAApB,MAAM,cAAe,SAAQ,oDAAuB;IACzD;;;;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;CACF,CAAA;AApBY,wCAAc;yBAAd,cAAc;IAtB1B,IAAA,eAAM,GAAE;IACR,IAAA,eAAM,EAAC;QACN,OAAO,EAAE;YACP,sBAAe;YACf,mBAAU,CAAC,kBAAkB,CAAC;gBAC5B,IAAI,EAAE,UAAU;gBAChB,MAAM,EAAE,CAAC,iDAAoB,CAAC;gBAC9B,UAAU,EAAE,CAAC,OAA8B,EAAE,EAAE,CAAC,OAAO;aACxD,CAAC;SACH;QACD,SAAS,EAAE;YACT,eAAM;YACN,oCAAgB;YAChB,sCAAiB;YACjB;gBACE,OAAO,EAAE,iDAAoB;gBAC7B,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,sDAAyB,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;gBAC9D,UAAU,EAAE,CAAC,OAA+B,EAAE,EAAE,CAAC,OAAO,IAAI,EAAE;aAC/D;SACF;QACD,OAAO,EAAE,CAAC,iDAAoB,CAAC;KAChC,CAAC;GACW,cAAc,CAoB1B"}

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

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

package/dist/schedule.module.spec.js

@@ -1,39 +1,91 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-require("dotenv/config");
-const bullmq_1 = require("@nest-boot/bullmq");
-const testing_1 = require("@nestjs/testing");
-const _1 = require(".");
-describe("BullModule", () => {
-    let app;
-    it(`ScheduleModule`, async () => {
-        const moduleRef = await testing_1.Test.createTestingModule({
-            imports: [bullmq_1.BullModule, _1.ScheduleModule],
-        }).compile();
-        app = moduleRef.createNestApplication();
-        await app.init();
-        await app.close();
+const common_1 = require("@nestjs/common");
+const constants_1 = require("@nestjs/common/constants");
+const core_1 = require("@nestjs/core");
+let mockRegisterQueueAsyncOptions;
+const mockQueueModule = {
+    module: class QueueModule {
+    },
+};
+const mockRegisterQueueAsync = jest.fn((options) => {
+    mockRegisterQueueAsyncOptions = options;
+    return mockQueueModule;
+});
+const mockProcessorDecorator = jest.fn();
+const mockProcessor = jest.fn(() => mockProcessorDecorator);
+jest.mock("@nest-boot/bullmq", () => ({
+    BullModule: {
+        registerQueueAsync: mockRegisterQueueAsync,
+    },
+    InjectQueue: jest.fn(() => jest.fn()),
+    Processor: mockProcessor,
+    WorkerHost: class WorkerHost {
+        constructor() {
+            this.worker = {
+                concurrency: 1,
+                run: jest.fn().mockResolvedValue(undefined),
+            };
+        }
+    },
+}));
+const schedule_module_1 = require("./schedule.module");
+const schedule_module_definition_1 = require("./schedule.module-definition");
+const schedule_processor_1 = require("./schedule.processor");
+const schedule_registry_1 = require("./schedule.registry");
+describe("ScheduleModule", () => {
+    beforeEach(() => {
+        jest.clearAllMocks();
+    });
+    it("should expose configurable root registrations", () => {
+        const options = {
+            concurrency: 3,
+        };
+        const useFactory = () => options;
+        const dynamicModule = schedule_module_1.ScheduleModule.forRoot(options);
+        const asyncModule = schedule_module_1.ScheduleModule.forRootAsync({
+            useFactory,
+        });
+        expect(dynamicModule.module).toBe(schedule_module_1.ScheduleModule);
+        expect(dynamicModule.providers).toEqual(expect.arrayContaining([
+            {
+                provide: schedule_module_definition_1.BASE_MODULE_OPTIONS_TOKEN,
+                useValue: options,
+            },
+        ]));
+        expect(asyncModule.providers).toEqual(expect.arrayContaining([
+            {
+                inject: [],
+                provide: schedule_module_definition_1.BASE_MODULE_OPTIONS_TOKEN,
+                useFactory,
+            },
+        ]));
     });
-    it(`ScheduleModule.forRoot`, async () => {
-        const moduleRef = await testing_1.Test.createTestingModule({
-            imports: [bullmq_1.BullModule, _1.ScheduleModule.forRoot({})],
-        }).compile();
-        app = moduleRef.createNestApplication();
-        await app.init();
-        await app.close();
+    it("should provide options, queue registration, and schedule services", () => {
+        const imports = Reflect.getMetadata(constants_1.MODULE_METADATA.IMPORTS, schedule_module_1.ScheduleModule);
+        const providers = Reflect.getMetadata(constants_1.MODULE_METADATA.PROVIDERS, schedule_module_1.ScheduleModule);
+        const exports = Reflect.getMetadata(constants_1.MODULE_METADATA.EXPORTS, schedule_module_1.ScheduleModule);
+        const optionsProvider = providers.find((provider) => provider.provide === schedule_module_definition_1.MODULE_OPTIONS_TOKEN);
+        expect(imports).toEqual([core_1.DiscoveryModule, mockQueueModule]);
+        expect(providers).toEqual(expect.arrayContaining([common_1.Logger, schedule_registry_1.ScheduleRegistry, schedule_processor_1.ScheduleProcessor]));
+        expect(exports).toEqual([schedule_module_definition_1.MODULE_OPTIONS_TOKEN]);
+        expect(optionsProvider.useFactory(undefined)).toEqual({});
+        expect(optionsProvider.useFactory({
+            autorun: false,
+        })).toEqual({
+            autorun: false,
+        });
     });
-    it(`ScheduleModule.forRootAsync`, async () => {
-        const moduleRef = await testing_1.Test.createTestingModule({
-            imports: [
-                bullmq_1.BullModule,
-                _1.ScheduleModule.forRootAsync({
-                    useFactory: () => ({}),
-                }),
-            ],
-        }).compile();
-        app = moduleRef.createNestApplication();
-        await app.init();
-        await app.close();
+    it("should register the schedule queue from module options", () => {
+        expect(mockRegisterQueueAsyncOptions).toEqual(expect.objectContaining({
+            inject: [schedule_module_definition_1.MODULE_OPTIONS_TOKEN],
+            name: "schedule",
+        }));
+        expect(mockRegisterQueueAsyncOptions.useFactory({
+            concurrency: 2,
+        })).toEqual({
+            concurrency: 2,
+        });
     });
 });
 //# sourceMappingURL=schedule.module.spec.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"schedule.module.spec.js","sourceRoot":"","sources":["../src/schedule.module.spec.ts"],"names":[],"mappings":";;AAAA,yBAAuB;AAEvB,8CAA+C;AAE/C,6CAAuC;AAEvC,wBAAmC;AAEnC,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IAC1B,IAAI,GAAqB,CAAC;IAE1B,EAAE,CAAC,gBAAgB,EAAE,KAAK,IAAI,EAAE;QAC9B,MAAM,SAAS,GAAG,MAAM,cAAI,CAAC,mBAAmB,CAAC;YAC/C,OAAO,EAAE,CAAC,mBAAU,EAAE,iBAAc,CAAC;SACtC,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,wBAAwB,EAAE,KAAK,IAAI,EAAE;QACtC,MAAM,SAAS,GAAG,MAAM,cAAI,CAAC,mBAAmB,CAAC;YAC/C,OAAO,EAAE,CAAC,mBAAU,EAAE,iBAAc,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;SAClD,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,6BAA6B,EAAE,KAAK,IAAI,EAAE;QAC3C,MAAM,SAAS,GAAG,MAAM,cAAI,CAAC,mBAAmB,CAAC;YAC/C,OAAO,EAAE;gBACP,mBAAU;gBACV,iBAAc,CAAC,YAAY,CAAC;oBAC1B,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":"schedule.module.spec.js","sourceRoot":"","sources":["../src/schedule.module.spec.ts"],"names":[],"mappings":";;AAAA,2CAAwC;AACxC,wDAA2D;AAC3D,uCAA+C;AAE/C,IAAI,6BAAkC,CAAC;AACvC,MAAM,eAAe,GAAG;IACtB,MAAM,EAAE,MAAM,WAAW;KAAG;CAC7B,CAAC;AACF,MAAM,sBAAsB,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE;IACjD,6BAA6B,GAAG,OAAO,CAAC;IACxC,OAAO,eAAe,CAAC;AACzB,CAAC,CAAC,CAAC;AACH,MAAM,sBAAsB,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;AACzC,MAAM,aAAa,GAAG,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,sBAAsB,CAAC,CAAC;AAE5D,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,GAAG,EAAE,CAAC,CAAC;IACpC,UAAU,EAAE;QACV,kBAAkB,EAAE,sBAAsB;KAC3C;IACD,WAAW,EAAE,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;IACrC,SAAS,EAAE,aAAa;IACxB,UAAU,EAAE,MAAM,UAAU;QAAhB;YACV,WAAM,GAAG;gBACP,WAAW,EAAE,CAAC;gBACd,GAAG,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,SAAS,CAAC;aAC5C,CAAC;QACJ,CAAC;KAAA;CACF,CAAC,CAAC,CAAC;AAEJ,uDAAmD;AACnD,6EAGsC;AACtC,6DAAyD;AACzD,2DAAuD;AAEvD,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;IAC9B,UAAU,CAAC,GAAG,EAAE;QACd,IAAI,CAAC,aAAa,EAAE,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+CAA+C,EAAE,GAAG,EAAE;QACvD,MAAM,OAAO,GAAG;YACd,WAAW,EAAE,CAAC;SACf,CAAC;QACF,MAAM,UAAU,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC;QAEjC,MAAM,aAAa,GAAG,gCAAc,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACtD,MAAM,WAAW,GAAG,gCAAc,CAAC,YAAY,CAAC;YAC9C,UAAU;SACX,CAAC,CAAC;QAEH,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,gCAAc,CAAC,CAAC;QAClD,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,OAAO,CACrC,MAAM,CAAC,eAAe,CAAC;YACrB;gBACE,OAAO,EAAE,sDAAyB;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,sDAAyB;gBAClC,UAAU;aACX;SACF,CAAC,CACH,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mEAAmE,EAAE,GAAG,EAAE;QAC3E,MAAM,OAAO,GAAG,OAAO,CAAC,WAAW,CACjC,2BAAe,CAAC,OAAO,EACvB,gCAAc,CACf,CAAC;QACF,MAAM,SAAS,GAAG,OAAO,CAAC,WAAW,CACnC,2BAAe,CAAC,SAAS,EACzB,gCAAc,CACf,CAAC;QACF,MAAM,OAAO,GAAG,OAAO,CAAC,WAAW,CACjC,2BAAe,CAAC,OAAO,EACvB,gCAAc,CACf,CAAC;QACF,MAAM,eAAe,GAAG,SAAS,CAAC,IAAI,CACpC,CAAC,QAAa,EAAE,EAAE,CAAC,QAAQ,CAAC,OAAO,KAAK,iDAAoB,CAC7D,CAAC;QAEF,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,sBAAe,EAAE,eAAe,CAAC,CAAC,CAAC;QAC5D,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CACvB,MAAM,CAAC,eAAe,CAAC,CAAC,eAAM,EAAE,oCAAgB,EAAE,sCAAiB,CAAC,CAAC,CACtE,CAAC;QACF,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,iDAAoB,CAAC,CAAC,CAAC;QAChD,MAAM,CAAC,eAAe,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAC1D,MAAM,CACJ,eAAe,CAAC,UAAU,CAAC;YACzB,OAAO,EAAE,KAAK;SACf,CAAC,CACH,CAAC,OAAO,CAAC;YACR,OAAO,EAAE,KAAK;SACf,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;QAChE,MAAM,CAAC,6BAA6B,CAAC,CAAC,OAAO,CAC3C,MAAM,CAAC,gBAAgB,CAAC;YACtB,MAAM,EAAE,CAAC,iDAAoB,CAAC;YAC9B,IAAI,EAAE,UAAU;SACjB,CAAC,CACH,CAAC;QACF,MAAM,CACJ,6BAA6B,CAAC,UAAU,CAAC;YACvC,WAAW,EAAE,CAAC;SACf,CAAC,CACH,CAAC,OAAO,CAAC;YACR,WAAW,EAAE,CAAC;SACf,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

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

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