@hazeljs/cron 0.2.0-alpha.1

package/dist/cron.module.d.ts

@@ -0,0 +1,38 @@
+import { CronService } from './cron.service';
+/**
+ * Cron module options
+ */
+export interface CronModuleOptions {
+    /**
+     * Whether this is a global module
+     * @default true
+     */
+    isGlobal?: boolean;
+}
+/**
+ * Cron module for HazelJS
+ * Provides scheduled job execution using cron expressions
+ */
+export declare class CronModule {
+    /**
+     * Configure cron module
+     */
+    static forRoot(options?: CronModuleOptions): {
+        module: typeof CronModule;
+        providers: Array<typeof CronService>;
+        exports: Array<typeof CronService>;
+        global: boolean;
+    };
+    /**
+     * Manually register cron jobs from a provider instance
+     * Call this method after the provider has been instantiated
+     *
+     * @example
+     * ```typescript
+     * const taskService = container.resolve(TaskService);
+     * CronModule.registerJobsFromProvider(taskService);
+     * ```
+     */
+    static registerJobsFromProvider(provider: object): void;
+}
+//# sourceMappingURL=cron.module.d.ts.map

package/dist/cron.module.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cron.module.d.ts","sourceRoot":"","sources":["../src/cron.module.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAK7C;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;GAGG;AACH,qBAIa,UAAU;IACrB;;OAEG;IACH,MAAM,CAAC,OAAO,CAAC,OAAO,GAAE,iBAAsB,GAAG;QAC/C,MAAM,EAAE,OAAO,UAAU,CAAC;QAC1B,SAAS,EAAE,KAAK,CAAC,OAAO,WAAW,CAAC,CAAC;QACrC,OAAO,EAAE,KAAK,CAAC,OAAO,WAAW,CAAC,CAAC;QACnC,MAAM,EAAE,OAAO,CAAC;KACjB;IAaD;;;;;;;;;OASG;IACH,MAAM,CAAC,wBAAwB,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;CAgCxD"}

package/dist/cron.module.js

@@ -0,0 +1,78 @@
+"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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var CronModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CronModule = void 0;
+const core_1 = require("@hazeljs/core");
+const cron_service_1 = require("./cron.service");
+const cron_decorator_1 = require("./cron.decorator");
+const core_2 = require("@hazeljs/core");
+const core_3 = __importDefault(require("@hazeljs/core"));
+/**
+ * Cron module for HazelJS
+ * Provides scheduled job execution using cron expressions
+ */
+let CronModule = CronModule_1 = class CronModule {
+    /**
+     * Configure cron module
+     */
+    static forRoot(options = {}) {
+        const { isGlobal = true } = options;
+        core_3.default.info('Configuring cron module...');
+        return {
+            module: CronModule_1,
+            providers: [cron_service_1.CronService],
+            exports: [cron_service_1.CronService],
+            global: isGlobal,
+        };
+    }
+    /**
+     * Manually register cron jobs from a provider instance
+     * Call this method after the provider has been instantiated
+     *
+     * @example
+     * ```typescript
+     * const taskService = container.resolve(TaskService);
+     * CronModule.registerJobsFromProvider(taskService);
+     * ```
+     */
+    static registerJobsFromProvider(provider) {
+        try {
+            const container = core_2.Container.getInstance();
+            const cronService = container.resolve(cron_service_1.CronService);
+            if (!cronService) {
+                core_3.default.warn('CronService not found in DI container');
+                return;
+            }
+            const metadata = (0, cron_decorator_1.getCronMetadata)(provider);
+            if (metadata && metadata.length > 0) {
+                for (const job of metadata) {
+                    const instance = provider;
+                    const callback = instance[job.methodName];
+                    if (typeof callback === 'function') {
+                        cronService.registerJob(job.options.name || job.methodName, job.options.cronTime, callback.bind(instance), job.options);
+                        core_3.default.info(`Registered cron job: ${job.options.name || job.methodName}`);
+                    }
+                }
+            }
+        }
+        catch (error) {
+            core_3.default.error('Error registering cron jobs from provider:', error);
+        }
+    }
+};
+exports.CronModule = CronModule;
+exports.CronModule = CronModule = CronModule_1 = __decorate([
+    (0, core_1.HazelModule)({
+        providers: [cron_service_1.CronService],
+        exports: [cron_service_1.CronService],
+    })
+], CronModule);

package/dist/cron.service.d.ts

@@ -0,0 +1,56 @@
+import { CronOptions, CronJobStatus } from './cron.types';
+/**
+ * Cron service for managing scheduled jobs
+ */
+export declare class CronService {
+    private jobs;
+    /**
+     * Register a new cron job
+     */
+    registerJob(name: string, cronExpression: string, callback: () => void | Promise<void>, options?: CronOptions): void;
+    /**
+     * Delete a cron job
+     */
+    deleteJob(name: string): boolean;
+    /**
+     * Start a specific job
+     */
+    startJob(name: string): boolean;
+    /**
+     * Stop a specific job
+     */
+    stopJob(name: string): boolean;
+    /**
+     * Enable a job
+     */
+    enableJob(name: string): boolean;
+    /**
+     * Disable a job
+     */
+    disableJob(name: string): boolean;
+    /**
+     * Get status of a specific job
+     */
+    getJobStatus(name: string): CronJobStatus | undefined;
+    /**
+     * Get status of all jobs
+     */
+    getAllJobStatuses(): CronJobStatus[];
+    /**
+     * Stop all jobs
+     */
+    stopAll(): void;
+    /**
+     * Start all jobs
+     */
+    startAll(): void;
+    /**
+     * Clear all jobs
+     */
+    clearAll(): void;
+    /**
+     * Get number of registered jobs
+     */
+    getJobCount(): number;
+}
+//# sourceMappingURL=cron.service.d.ts.map

package/dist/cron.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cron.service.d.ts","sourceRoot":"","sources":["../src/cron.service.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAgK1D;;GAEG;AACH,qBACa,WAAW;IACtB,OAAO,CAAC,IAAI,CAA8B;IAE1C;;OAEG;IACH,WAAW,CACT,IAAI,EAAE,MAAM,EACZ,cAAc,EAAE,MAAM,EACtB,QAAQ,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,EACpC,OAAO,GAAE,WAA0C,GAClD,IAAI;IAeP;;OAEG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAWhC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAU/B;;OAEG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAU9B;;OAEG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAUhC;;OAEG;IACH,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAUjC;;OAEG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS;IAKrD;;OAEG;IACH,iBAAiB,IAAI,aAAa,EAAE;IAIpC;;OAEG;IACH,OAAO,IAAI,IAAI;IAKf;;OAEG;IACH,QAAQ,IAAI,IAAI;IAKhB;;OAEG;IACH,QAAQ,IAAI,IAAI;IAMhB;;OAEG;IACH,WAAW,IAAI,MAAM;CAGtB"}

package/dist/cron.service.js

@@ -0,0 +1,273 @@
+"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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CronService = void 0;
+const core_1 = require("@hazeljs/core");
+const core_2 = __importDefault(require("@hazeljs/core"));
+const node_cron_1 = __importDefault(require("node-cron"));
+/**
+ * Represents a scheduled cron job
+ * Uses node-cron for proper cron expression parsing and scheduling
+ */
+class CronJob {
+    constructor(name, cronExpression, callback, options) {
+        this.name = name;
+        this.cronExpression = cronExpression;
+        this.callback = callback;
+        this.options = options;
+        this.task = null;
+        this._isRunning = false;
+        this._runCount = 0;
+        this._enabled = true;
+        this._enabled = options.enabled !== false;
+        // node-cron uses 5-field (minute-level) or 6-field (second-level) expressions
+        // Validate the expression upfront
+        const expr = this.normalizeExpression(this.cronExpression);
+        if (!node_cron_1.default.validate(expr)) {
+            throw new Error(`Invalid cron expression: ${this.cronExpression}. ` +
+                `Format: second minute hour day-of-month month day-of-week`);
+        }
+    }
+    /**
+     * Normalize expression for node-cron compatibility
+     * node-cron supports both 5-field (no seconds) and 6-field (with seconds)
+     */
+    normalizeExpression(expression) {
+        return expression;
+    }
+    /**
+     * Start the cron job
+     */
+    start() {
+        if (this.task) {
+            core_2.default.warn(`Cron job "${this.name}" is already running`);
+            return;
+        }
+        if (!this._enabled) {
+            core_2.default.warn(`Cron job "${this.name}" is disabled`);
+            return;
+        }
+        const expr = this.normalizeExpression(this.cronExpression);
+        this.task = node_cron_1.default.schedule(expr, async () => {
+            await this.execute();
+        }, {
+            scheduled: true,
+            timezone: this.options.timeZone,
+        });
+        // Run on init if specified
+        if (this.options.runOnInit) {
+            this.execute();
+        }
+        core_2.default.info(`Cron job "${this.name}" started with expression: ${this.cronExpression}`);
+    }
+    /**
+     * Stop the cron job
+     */
+    stop() {
+        if (this.task) {
+            this.task.stop();
+            this.task = null;
+            this._nextExecution = undefined;
+            core_2.default.info(`Cron job "${this.name}" stopped`);
+        }
+    }
+    /**
+     * Execute the job
+     */
+    async execute() {
+        if (this._isRunning) {
+            core_2.default.warn(`Cron job "${this.name}" is already executing, skipping this run`);
+            return;
+        }
+        // Check max runs
+        if (this.options.maxRuns && this._runCount >= this.options.maxRuns) {
+            core_2.default.info(`Cron job "${this.name}" reached max runs (${this.options.maxRuns}), stopping`);
+            this.stop();
+            return;
+        }
+        this._isRunning = true;
+        this._lastExecution = new Date();
+        this._runCount++;
+        try {
+            core_2.default.debug(`Executing cron job "${this.name}" (run #${this._runCount})`);
+            await this.callback();
+            if (this.options.onComplete) {
+                this.options.onComplete();
+            }
+        }
+        catch (error) {
+            core_2.default.error(`Error executing cron job "${this.name}":`, error);
+            if (this.options.onError) {
+                this.options.onError(error);
+            }
+        }
+        finally {
+            this._isRunning = false;
+        }
+    }
+    /**
+     * Enable the job
+     */
+    enable() {
+        this._enabled = true;
+        core_2.default.info(`Cron job "${this.name}" enabled`);
+    }
+    /**
+     * Disable the job
+     */
+    disable() {
+        this._enabled = false;
+        this.stop();
+        core_2.default.info(`Cron job "${this.name}" disabled`);
+    }
+    /**
+     * Get job status
+     */
+    getStatus() {
+        return {
+            name: this.name,
+            isRunning: this._isRunning,
+            lastExecution: this._lastExecution,
+            nextExecution: this._nextExecution,
+            runCount: this._runCount,
+            enabled: this._enabled,
+        };
+    }
+}
+/**
+ * Cron service for managing scheduled jobs
+ */
+let CronService = class CronService {
+    constructor() {
+        this.jobs = new Map();
+    }
+    /**
+     * Register a new cron job
+     */
+    registerJob(name, cronExpression, callback, options = { cronTime: cronExpression }) {
+        if (this.jobs.has(name)) {
+            core_2.default.warn(`Cron job "${name}" already exists, replacing it`);
+            this.deleteJob(name);
+        }
+        const job = new CronJob(name, cronExpression, callback, options);
+        this.jobs.set(name, job);
+        // Auto-start if not explicitly disabled
+        if (options.enabled !== false) {
+            job.start();
+        }
+    }
+    /**
+     * Delete a cron job
+     */
+    deleteJob(name) {
+        const job = this.jobs.get(name);
+        if (job) {
+            job.stop();
+            this.jobs.delete(name);
+            core_2.default.info(`Cron job "${name}" deleted`);
+            return true;
+        }
+        return false;
+    }
+    /**
+     * Start a specific job
+     */
+    startJob(name) {
+        const job = this.jobs.get(name);
+        if (job) {
+            job.start();
+            return true;
+        }
+        core_2.default.warn(`Cron job "${name}" not found`);
+        return false;
+    }
+    /**
+     * Stop a specific job
+     */
+    stopJob(name) {
+        const job = this.jobs.get(name);
+        if (job) {
+            job.stop();
+            return true;
+        }
+        core_2.default.warn(`Cron job "${name}" not found`);
+        return false;
+    }
+    /**
+     * Enable a job
+     */
+    enableJob(name) {
+        const job = this.jobs.get(name);
+        if (job) {
+            job.enable();
+            return true;
+        }
+        core_2.default.warn(`Cron job "${name}" not found`);
+        return false;
+    }
+    /**
+     * Disable a job
+     */
+    disableJob(name) {
+        const job = this.jobs.get(name);
+        if (job) {
+            job.disable();
+            return true;
+        }
+        core_2.default.warn(`Cron job "${name}" not found`);
+        return false;
+    }
+    /**
+     * Get status of a specific job
+     */
+    getJobStatus(name) {
+        const job = this.jobs.get(name);
+        return job?.getStatus();
+    }
+    /**
+     * Get status of all jobs
+     */
+    getAllJobStatuses() {
+        return Array.from(this.jobs.values()).map((job) => job.getStatus());
+    }
+    /**
+     * Stop all jobs
+     */
+    stopAll() {
+        this.jobs.forEach((job) => job.stop());
+        core_2.default.info('All cron jobs stopped');
+    }
+    /**
+     * Start all jobs
+     */
+    startAll() {
+        this.jobs.forEach((job) => job.start());
+        core_2.default.info('All cron jobs started');
+    }
+    /**
+     * Clear all jobs
+     */
+    clearAll() {
+        this.stopAll();
+        this.jobs.clear();
+        core_2.default.info('All cron jobs cleared');
+    }
+    /**
+     * Get number of registered jobs
+     */
+    getJobCount() {
+        return this.jobs.size;
+    }
+};
+exports.CronService = CronService;
+exports.CronService = CronService = __decorate([
+    (0, core_1.Service)()
+], CronService);

package/dist/cron.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=cron.test.d.ts.map

package/dist/cron.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cron.test.d.ts","sourceRoot":"","sources":["../src/cron.test.ts"],"names":[],"mappings":""}