@warlock.js/scheduler 4.0.28

package/esm/cron-parser.js

@@ -0,0 +1,193 @@
+import dayjs from'dayjs';/**
+ * Cron expression parser
+ *
+ * Supports standard 5-field cron expressions:
+ * ```
+ * ┌───────────── minute (0-59)
+ * │ ┌───────────── hour (0-23)
+ * │ │ ┌───────────── day of month (1-31)
+ * │ │ │ ┌───────────── month (1-12)
+ * │ │ │ │ ┌───────────── day of week (0-6, Sunday = 0)
+ * │ │ │ │ │
+ * * * * * *
+ * ```
+ *
+ * Supports:
+ * - `*` - any value
+ * - `5` - specific value
+ * - `1,3,5` - list of values
+ * - `1-5` - range of values
+ * - `* /5` - step values (every 5)
+ * - `1-10/2` - range with step
+ *
+ * @example
+ * ```typescript
+ * const parser = new CronParser("0 9 * * 1-5"); // 9 AM weekdays
+ * const nextRun = parser.nextRun();
+ * ```
+ */
+class CronParser {
+    _expression;
+    _fields;
+    /**
+     * Creates a new CronParser instance
+     *
+     * @param expression - Standard 5-field cron expression
+     * @throws Error if expression is invalid
+     */
+    constructor(_expression) {
+        this._expression = _expression;
+        this._fields = this._parse(_expression);
+    }
+    /**
+     * Get the parsed cron fields
+     */
+    get fields() {
+        return this._fields;
+    }
+    /**
+     * Get the original expression
+     */
+    get expression() {
+        return this._expression;
+    }
+    /**
+     * Calculate the next run time from a given date
+     *
+     * @param from - Starting date (defaults to now)
+     * @returns Next run time as Dayjs
+     */
+    nextRun(from = dayjs()) {
+        let date = from.add(1, "minute").second(0).millisecond(0);
+        // Maximum iterations to prevent infinite loops
+        const maxIterations = 366 * 24 * 60; // 1 year of minutes
+        let iterations = 0;
+        while (iterations < maxIterations) {
+            iterations++;
+            // Check month
+            if (!this._fields.months.includes(date.month() + 1)) {
+                date = date.add(1, "month").date(1).hour(0).minute(0);
+                continue;
+            }
+            // Check day of month
+            if (!this._fields.daysOfMonth.includes(date.date())) {
+                date = date.add(1, "day").hour(0).minute(0);
+                continue;
+            }
+            // Check day of week
+            if (!this._fields.daysOfWeek.includes(date.day())) {
+                date = date.add(1, "day").hour(0).minute(0);
+                continue;
+            }
+            // Check hour
+            if (!this._fields.hours.includes(date.hour())) {
+                date = date.add(1, "hour").minute(0);
+                continue;
+            }
+            // Check minute
+            if (!this._fields.minutes.includes(date.minute())) {
+                date = date.add(1, "minute");
+                continue;
+            }
+            // All fields match!
+            return date;
+        }
+        throw new Error(`Could not find next run time for cron expression: ${this._expression}`);
+    }
+    /**
+     * Check if a given date matches the cron expression
+     *
+     * @param date - Date to check
+     * @returns true if the date matches
+     */
+    matches(date) {
+        return (this._fields.minutes.includes(date.minute()) &&
+            this._fields.hours.includes(date.hour()) &&
+            this._fields.daysOfMonth.includes(date.date()) &&
+            this._fields.months.includes(date.month() + 1) &&
+            this._fields.daysOfWeek.includes(date.day()));
+    }
+    /**
+     * Parse a cron expression into fields
+     */
+    _parse(expression) {
+        const parts = expression.trim().split(/\s+/);
+        if (parts.length !== 5) {
+            throw new Error(`Invalid cron expression: "${expression}". Expected 5 fields (minute hour day month weekday).`);
+        }
+        const [minute, hour, dayOfMonth, month, dayOfWeek] = parts;
+        return {
+            minutes: this._parseField(minute, 0, 59),
+            hours: this._parseField(hour, 0, 23),
+            daysOfMonth: this._parseField(dayOfMonth, 1, 31),
+            months: this._parseField(month, 1, 12),
+            daysOfWeek: this._parseField(dayOfWeek, 0, 6),
+        };
+    }
+    /**
+     * Parse a single cron field
+     *
+     * @param field - Field value (e.g., "*", "5", "1-5", "* /2", "1,3,5")
+     * @param min - Minimum allowed value
+     * @param max - Maximum allowed value
+     * @returns Array of matching values
+     */
+    _parseField(field, min, max) {
+        const values = new Set();
+        // Handle lists (e.g., "1,3,5")
+        const parts = field.split(",");
+        for (const part of parts) {
+            // Handle step values (e.g., "*/5" or "1-10/2")
+            const [range, stepStr] = part.split("/");
+            const step = stepStr ? parseInt(stepStr, 10) : 1;
+            if (isNaN(step) || step < 1) {
+                throw new Error(`Invalid step value in cron field: "${field}"`);
+            }
+            let rangeStart;
+            let rangeEnd;
+            if (range === "*") {
+                // Wildcard - all values
+                rangeStart = min;
+                rangeEnd = max;
+            }
+            else if (range.includes("-")) {
+                // Range (e.g., "1-5")
+                const [startStr, endStr] = range.split("-");
+                rangeStart = parseInt(startStr, 10);
+                rangeEnd = parseInt(endStr, 10);
+                if (isNaN(rangeStart) || isNaN(rangeEnd)) {
+                    throw new Error(`Invalid range in cron field: "${field}"`);
+                }
+                if (rangeStart < min || rangeEnd > max || rangeStart > rangeEnd) {
+                    throw new Error(`Range out of bounds in cron field: "${field}" (valid: ${min}-${max})`);
+                }
+            }
+            else {
+                // Single value
+                const value = parseInt(range, 10);
+                if (isNaN(value)) {
+                    throw new Error(`Invalid value in cron field: "${field}"`);
+                }
+                if (value < min || value > max) {
+                    throw new Error(`Value out of bounds in cron field: "${field}" (valid: ${min}-${max})`);
+                }
+                rangeStart = value;
+                rangeEnd = value;
+            }
+            // Add values with step
+            for (let i = rangeStart; i <= rangeEnd; i += step) {
+                values.add(i);
+            }
+        }
+        return Array.from(values).sort((a, b) => a - b);
+    }
+}
+/**
+ * Parse a cron expression string
+ *
+ * @param expression - Cron expression (5 fields)
+ * @returns CronParser instance
+ */
+function parseCron(expression) {
+    return new CronParser(expression);
+}export{CronParser,parseCron};//# sourceMappingURL=cron-parser.js.map

package/esm/cron-parser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cron-parser.js","sources":["../src/cron-parser.ts"],"sourcesContent":[null],"names":[],"mappings":"yBAkBA;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BG;MACU,UAAU,CAAA;AASe,IAAA,WAAA,CAAA;AARnB,IAAA,OAAO,CAAa;AAErC;;;;;AAKG;AACH,IAAA,WAAA,CAAoC,WAAmB,EAAA;QAAnB,IAAW,CAAA,WAAA,GAAX,WAAW,CAAQ;QACrD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;KACzC;AAED;;AAEG;AACH,IAAA,IAAW,MAAM,GAAA;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;KACrB;AAED;;AAEG;AACH,IAAA,IAAW,UAAU,GAAA;QACnB,OAAO,IAAI,CAAC,WAAW,CAAC;KACzB;AAED;;;;;AAKG;IACI,OAAO,CAAC,IAAc,GAAA,KAAK,EAAE,EAAA;QAClC,IAAI,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;;QAG1D,MAAM,aAAa,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,CAAC;QACpC,IAAI,UAAU,GAAG,CAAC,CAAC;QAEnB,OAAO,UAAU,GAAG,aAAa,EAAE;AACjC,YAAA,UAAU,EAAE,CAAC;;AAGb,YAAA,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,EAAE;gBACnD,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;gBACtD,SAAS;AACV,aAAA;;AAGD,YAAA,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE;AACnD,gBAAA,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;gBAC5C,SAAS;AACV,aAAA;;AAGD,YAAA,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,EAAE;AACjD,gBAAA,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;gBAC5C,SAAS;AACV,aAAA;;AAGD,YAAA,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE;AAC7C,gBAAA,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;gBACrC,SAAS;AACV,aAAA;;AAGD,YAAA,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE;gBACjD,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;gBAC7B,SAAS;AACV,aAAA;;AAGD,YAAA,OAAO,IAAI,CAAC;AACb,SAAA;QAED,MAAM,IAAI,KAAK,CAAC,CAAA,kDAAA,EAAqD,IAAI,CAAC,WAAW,CAAE,CAAA,CAAC,CAAC;KAC1F;AAED;;;;;AAKG;AACI,IAAA,OAAO,CAAC,IAAW,EAAA;AACxB,QAAA,QACE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YAC5C,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACxC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;AAC9C,YAAA,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;AAC9C,YAAA,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,EAC5C;KACH;AAED;;AAEG;AACK,IAAA,MAAM,CAAC,UAAkB,EAAA;QAC/B,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AAE7C,QAAA,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;AACtB,YAAA,MAAM,IAAI,KAAK,CACb,6BAA6B,UAAU,CAAA,qDAAA,CAAuD,CAC/F,CAAC;AACH,SAAA;AAED,QAAA,MAAM,CAAC,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,SAAS,CAAC,GAAG,KAAK,CAAC;QAE3D,OAAO;YACL,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACxC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC;YACpC,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC,EAAE,EAAE,CAAC;YAChD,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;YACtC,UAAU,EAAE,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,CAAC;SAC9C,CAAC;KACH;AAED;;;;;;;AAOG;AACK,IAAA,WAAW,CAAC,KAAa,EAAE,GAAW,EAAE,GAAW,EAAA;AACzD,QAAA,MAAM,MAAM,GAAG,IAAI,GAAG,EAAU,CAAC;;QAGjC,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AAE/B,QAAA,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;;AAExB,YAAA,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AACzC,YAAA,MAAM,IAAI,GAAG,OAAO,GAAG,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC;YAEjD,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,GAAG,CAAC,EAAE;AAC3B,gBAAA,MAAM,IAAI,KAAK,CAAC,sCAAsC,KAAK,CAAA,CAAA,CAAG,CAAC,CAAC;AACjE,aAAA;AAED,YAAA,IAAI,UAAkB,CAAC;AACvB,YAAA,IAAI,QAAgB,CAAC;YAErB,IAAI,KAAK,KAAK,GAAG,EAAE;;gBAEjB,UAAU,GAAG,GAAG,CAAC;gBACjB,QAAQ,GAAG,GAAG,CAAC;AAChB,aAAA;AAAM,iBAAA,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;;AAE9B,gBAAA,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AAC5C,gBAAA,UAAU,GAAG,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;AACpC,gBAAA,QAAQ,GAAG,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;gBAEhC,IAAI,KAAK,CAAC,UAAU,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,EAAE;AACxC,oBAAA,MAAM,IAAI,KAAK,CAAC,iCAAiC,KAAK,CAAA,CAAA,CAAG,CAAC,CAAC;AAC5D,iBAAA;gBAED,IAAI,UAAU,GAAG,GAAG,IAAI,QAAQ,GAAG,GAAG,IAAI,UAAU,GAAG,QAAQ,EAAE;oBAC/D,MAAM,IAAI,KAAK,CAAC,CAAuC,oCAAA,EAAA,KAAK,CAAa,UAAA,EAAA,GAAG,CAAI,CAAA,EAAA,GAAG,CAAG,CAAA,CAAA,CAAC,CAAC;AACzF,iBAAA;AACF,aAAA;AAAM,iBAAA;;gBAEL,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;AAElC,gBAAA,IAAI,KAAK,CAAC,KAAK,CAAC,EAAE;AAChB,oBAAA,MAAM,IAAI,KAAK,CAAC,iCAAiC,KAAK,CAAA,CAAA,CAAG,CAAC,CAAC;AAC5D,iBAAA;AAED,gBAAA,IAAI,KAAK,GAAG,GAAG,IAAI,KAAK,GAAG,GAAG,EAAE;oBAC9B,MAAM,IAAI,KAAK,CAAC,CAAuC,oCAAA,EAAA,KAAK,CAAa,UAAA,EAAA,GAAG,CAAI,CAAA,EAAA,GAAG,CAAG,CAAA,CAAA,CAAC,CAAC;AACzF,iBAAA;gBAED,UAAU,GAAG,KAAK,CAAC;gBACnB,QAAQ,GAAG,KAAK,CAAC;AAClB,aAAA;;AAGD,YAAA,KAAK,IAAI,CAAC,GAAG,UAAU,EAAE,CAAC,IAAI,QAAQ,EAAE,CAAC,IAAI,IAAI,EAAE;AACjD,gBAAA,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AACf,aAAA;AACF,SAAA;QAED,OAAO,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;KACjD;AACF,CAAA;AAED;;;;;AAKG;AACG,SAAU,SAAS,CAAC,UAAkB,EAAA;AAC1C,IAAA,OAAO,IAAI,UAAU,CAAC,UAAU,CAAC,CAAC;AACpC"}

package/esm/index.d.ts

@@ -0,0 +1,44 @@
+/**
+ * @warlock.js/scheduler
+ *
+ * A production-ready job scheduler with cron-like functionality.
+ *
+ * @example
+ * ```typescript
+ * import { Scheduler, job } from "@warlock.js/scheduler";
+ *
+ * const scheduler = new Scheduler();
+ *
+ * // Add observability
+ * scheduler.on('job:error', (name, error) => console.error(`${name} failed:`, error));
+ *
+ * // Schedule jobs with fluent API
+ * scheduler.addJob(
+ *   job("cleanup", async () => {
+ *     await cleanupExpiredTokens();
+ *   })
+ *     .daily()
+ *     .at("03:00")
+ *     .inTimezone("America/New_York")
+ *     .preventOverlap()
+ *     .retry(3, 1000)
+ * );
+ *
+ * // Or use cron expressions
+ * scheduler.addJob(
+ *   job("reports", sendReports).cron("0 9 * * 1-5")  // 9 AM weekdays
+ * );
+ *
+ * // Start and handle graceful shutdown
+ * scheduler.start();
+ * process.on('SIGTERM', () => scheduler.shutdown());
+ * ```
+ *
+ * @packageDocumentation
+ */
+export { CronParser, parseCron } from "./cron-parser";
+export { Job, job } from "./job";
+export { Scheduler, scheduler } from "./scheduler";
+export type { CronFields } from "./cron-parser";
+export type { Day, JobIntervals, JobResult, JobStatus, RetryConfig, SchedulerEvents, TimeType, } from "./types";
+//# sourceMappingURL=index.d.ts.map

package/esm/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AAGH,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AACtD,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AACjC,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGnD,YAAY,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAEhD,YAAY,EACV,GAAG,EACH,YAAY,EACZ,SAAS,EACT,SAAS,EACT,WAAW,EACX,eAAe,EACf,QAAQ,GACT,MAAM,SAAS,CAAC"}

package/esm/index.js

@@ -0,0 +1 @@
+export{CronParser,parseCron}from'./cron-parser.js';export{Job,job}from'./job.js';export{Scheduler,scheduler}from'./scheduler.js';//# sourceMappingURL=index.js.map

package/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/esm/job.d.ts

@@ -0,0 +1,331 @@
+import { type Dayjs } from "dayjs";
+import type { Day, JobIntervals, JobResult, TimeType } from "./types";
+/**
+ * Job class represents a scheduled task with configurable timing and execution options.
+ *
+ * @example
+ * ```typescript
+ * const job = new Job("cleanup", async () => {
+ *   await cleanupOldFiles();
+ * })
+ *   .everyDay()
+ *   .at("03:00")
+ *   .inTimezone("America/New_York")
+ *   .preventOverlap()
+ *   .retry(3, 1000);
+ * ```
+ */
+export declare class Job {
+    readonly name: string;
+    private readonly _callback;
+    /**
+     * Interval configuration for scheduling
+     */
+    private _intervals;
+    /**
+     * Last execution timestamp
+     */
+    private _lastRun;
+    /**
+     * Whether the job is currently executing
+     */
+    private _isRunning;
+    /**
+     * Skip execution if job is already running
+     */
+    private _skipIfRunning;
+    /**
+     * Retry configuration
+     */
+    private _retryConfig;
+    /**
+     * Timezone for scheduling (defaults to system timezone)
+     */
+    private _timezone;
+    /**
+     * Cron expression parser (mutually exclusive with interval config)
+     */
+    private _cronParser;
+    /**
+     * Promise resolver for completion waiting
+     */
+    private _completionResolver;
+    /**
+     * Next scheduled execution time
+     */
+    nextRun: Dayjs | null;
+    /**
+     * Creates a new Job instance
+     *
+     * @param name - Unique identifier for the job
+     * @param callback - Function to execute when the job runs
+     */
+    constructor(name: string, _callback: (job: Job) => Promise<unknown> | unknown);
+    /**
+     * Returns true if the job is currently executing
+     */
+    get isRunning(): boolean;
+    /**
+     * Returns the last execution timestamp
+     */
+    get lastRun(): Dayjs | null;
+    /**
+     * Returns the current interval configuration (readonly)
+     */
+    get intervals(): Readonly<JobIntervals>;
+    /**
+     * Set a custom interval for job execution
+     *
+     * @param value - Number of time units
+     * @param timeType - Type of time unit
+     * @returns this for chaining
+     *
+     * @example
+     * ```typescript
+     * job.every(5, "minute"); // Run every 5 minutes
+     * job.every(2, "hour");   // Run every 2 hours
+     * ```
+     */
+    every(value: number, timeType: TimeType): this;
+    /**
+     * Run job every second (use with caution - high frequency)
+     */
+    everySecond(): this;
+    /**
+     * Run job every specified number of seconds
+     */
+    everySeconds(seconds: number): this;
+    /**
+     * Run job every minute
+     */
+    everyMinute(): this;
+    /**
+     * Run job every specified number of minutes
+     */
+    everyMinutes(minutes: number): this;
+    /**
+     * Run job every hour
+     */
+    everyHour(): this;
+    /**
+     * Run job every specified number of hours
+     */
+    everyHours(hours: number): this;
+    /**
+     * Run job every day at midnight
+     */
+    everyDay(): this;
+    /**
+     * Alias for everyDay()
+     */
+    daily(): this;
+    /**
+     * Run job twice a day (every 12 hours)
+     */
+    twiceDaily(): this;
+    /**
+     * Run job every week
+     */
+    everyWeek(): this;
+    /**
+     * Alias for everyWeek()
+     */
+    weekly(): this;
+    /**
+     * Run job every month
+     */
+    everyMonth(): this;
+    /**
+     * Alias for everyMonth()
+     */
+    monthly(): this;
+    /**
+     * Run job every year
+     */
+    everyYear(): this;
+    /**
+     * Alias for everyYear()
+     */
+    yearly(): this;
+    /**
+     * Alias for everyMinute() - job runs continuously every minute
+     */
+    always(): this;
+    /**
+     * Schedule job using a cron expression
+     *
+     * Supports standard 5-field cron syntax:
+     * ```
+     * ┌───────────── minute (0-59)
+     * │ ┌───────────── hour (0-23)
+     * │ │ ┌───────────── day of month (1-31)
+     * │ │ │ ┌───────────── month (1-12)
+     * │ │ │ │ ┌───────────── day of week (0-6, Sunday = 0)
+     * │ │ │ │ │
+     * * * * * *
+     * ```
+     *
+     * Supports:
+     * - '*' - any value
+     * - '5' - specific value
+     * - '1,3,5' - list of values
+     * - '1-5' - range of values
+     * - 'x/5' - step values (every 5)
+     * - '1-10/2' - range with step
+     *
+     * @param expression - Standard 5-field cron expression
+     * @returns this for chaining
+     *
+     * @example
+     * ```typescript
+     * job.cron("0 9 * * 1-5");   // 9 AM weekdays
+     * job.cron("x/5 * * * *");   // Every 5 minutes
+     * job.cron("0 0 1 * *");     // First day of month at midnight
+     * job.cron("0 x/2 * * *");   // Every 2 hours
+     * ```
+     */
+    cron(expression: string): this;
+    /**
+     * Get the cron expression if one is set
+     */
+    get cronExpression(): string | null;
+    /**
+     * Schedule job on a specific day
+     *
+     * @param day - Day of week (string) or day of month (number 1-31)
+     * @returns this for chaining
+     *
+     * @example
+     * ```typescript
+     * job.on("monday");  // Run on Mondays
+     * job.on(15);        // Run on the 15th of each month
+     * ```
+     */
+    on(day: Day | number): this;
+    /**
+     * Schedule job at a specific time
+     *
+     * @param time - Time in HH:mm or HH:mm:ss format
+     * @returns this for chaining
+     *
+     * @example
+     * ```typescript
+     * job.daily().at("09:00");    // Run daily at 9 AM
+     * job.weekly().at("14:30");   // Run weekly at 2:30 PM
+     * ```
+     */
+    at(time: string): this;
+    /**
+     * Run task at the beginning of the specified time period
+     *
+     * @param type - Time type (day, month, year)
+     */
+    beginOf(type: TimeType): this;
+    /**
+     * Run task at the end of the specified time period
+     *
+     * @param type - Time type (day, month, year)
+     */
+    endOf(type: TimeType): this;
+    /**
+     * Set the timezone for this job's scheduling
+     *
+     * @param tz - IANA timezone string (e.g., "America/New_York", "Europe/London")
+     * @returns this for chaining
+     *
+     * @example
+     * ```typescript
+     * job.daily().at("09:00").inTimezone("America/New_York");
+     * ```
+     */
+    inTimezone(tz: string): this;
+    /**
+     * Prevent overlapping executions of this job
+     *
+     * When enabled, if the job is already running when it's scheduled to run again,
+     * the new execution will be skipped.
+     *
+     * @param skip - Whether to skip if already running (default: true)
+     * @returns this for chaining
+     */
+    preventOverlap(skip?: boolean): this;
+    /**
+     * Configure automatic retry on failure
+     *
+     * @param maxRetries - Maximum number of retry attempts
+     * @param delay - Delay between retries in milliseconds
+     * @param backoffMultiplier - Optional multiplier for exponential backoff
+     * @returns this for chaining
+     *
+     * @example
+     * ```typescript
+     * job.retry(3, 1000);           // Retry 3 times with 1s delay
+     * job.retry(5, 1000, 2);        // Exponential backoff: 1s, 2s, 4s, 8s, 16s
+     * ```
+     */
+    retry(maxRetries: number, delay?: number, backoffMultiplier?: number): this;
+    /**
+     * Terminate the job and clear all scheduling data
+     */
+    terminate(): this;
+    /**
+     * Prepare the job by calculating the next run time
+     * Called by the scheduler when starting
+     */
+    prepare(): void;
+    /**
+     * Determine if the job should run now
+     *
+     * @returns true if the job should execute
+     */
+    shouldRun(): boolean;
+    /**
+     * Execute the job
+     *
+     * @returns Promise resolving to the job result
+     */
+    run(): Promise<JobResult>;
+    /**
+     * Wait for the job to complete
+     * Useful for graceful shutdown
+     *
+     * @returns Promise that resolves when the job completes
+     */
+    waitForCompletion(): Promise<void>;
+    /**
+     * Get current time, respecting timezone if set
+     */
+    private _now;
+    /**
+     * Execute the callback with retry logic
+     */
+    private _executeWithRetry;
+    /**
+     * Calculate retry delay with optional exponential backoff
+     */
+    private _calculateRetryDelay;
+    /**
+     * Sleep for specified milliseconds
+     */
+    private _sleep;
+    /**
+     * Calculate the next run time based on interval or cron configuration
+     */
+    private _determineNextRun;
+}
+/**
+ * Factory function to create a new Job instance
+ *
+ * @param name - Unique identifier for the job
+ * @param callback - Function to execute when the job runs
+ * @returns New Job instance
+ *
+ * @example
+ * ```typescript
+ * const cleanupJob = job("cleanup", async () => {
+ *   await db.deleteExpiredTokens();
+ * }).daily().at("03:00");
+ * ```
+ */
+export declare function job(name: string, callback: (job: Job) => Promise<unknown> | unknown): Job;
+//# sourceMappingURL=job.d.ts.map

package/esm/job.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"job.d.ts","sourceRoot":"","sources":["../src/job.ts"],"names":[],"mappings":"AAAA,OAAc,EAAE,KAAK,KAAK,EAAE,MAAM,OAAO,CAAC;AAI1C,OAAO,KAAK,EAAE,GAAG,EAAE,YAAY,EAAE,SAAS,EAAe,QAAQ,EAAE,MAAM,SAAS,CAAC;AAmBnF;;;;;;;;;;;;;;GAcG;AACH,qBAAa,GAAG;aAiEI,IAAI,EAAE,MAAM;IAC5B,OAAO,CAAC,QAAQ,CAAC,SAAS;IA7D5B;;OAEG;IACH,OAAO,CAAC,UAAU,CAAoB;IAEtC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAsB;IAEtC;;OAEG;IACH,OAAO,CAAC,UAAU,CAAS;IAE3B;;OAEG;IACH,OAAO,CAAC,cAAc,CAAS;IAE/B;;OAEG;IACH,OAAO,CAAC,YAAY,CAA4B;IAEhD;;OAEG;IACH,OAAO,CAAC,SAAS,CAAuB;IAExC;;OAEG;IACH,OAAO,CAAC,WAAW,CAA2B;IAE9C;;OAEG;IACH,OAAO,CAAC,mBAAmB,CAA6B;IAMxD;;OAEG;IACI,OAAO,EAAE,KAAK,GAAG,IAAI,CAAQ;IAMpC;;;;;OAKG;gBAEe,IAAI,EAAE,MAAM,EACX,SAAS,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO;IAOtE;;OAEG;IACH,IAAW,SAAS,IAAI,OAAO,CAE9B;IAED;;OAEG;IACH,IAAW,OAAO,IAAI,KAAK,GAAG,IAAI,CAEjC;IAED;;OAEG;IACH,IAAW,SAAS,IAAI,QAAQ,CAAC,YAAY,CAAC,CAE7C;IAMD;;;;;;;;;;;;OAYG;IACI,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,IAAI;IAKrD;;OAEG;IACI,WAAW,IAAI,IAAI;IAI1B;;OAEG;IACI,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAI1C;;OAEG;IACI,WAAW,IAAI,IAAI;IAI1B;;OAEG;IACI,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAI1C;;OAEG;IACI,SAAS,IAAI,IAAI;IAIxB;;OAEG;IACI,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAItC;;OAEG;IACI,QAAQ,IAAI,IAAI;IAIvB;;OAEG;IACI,KAAK,IAAI,IAAI;IAIpB;;OAEG;IACI,UAAU,IAAI,IAAI;IAIzB;;OAEG;IACI,SAAS,IAAI,IAAI;IAIxB;;OAEG;IACI,MAAM,IAAI,IAAI;IAIrB;;OAEG;IACI,UAAU,IAAI,IAAI;IAIzB;;OAEG;IACI,OAAO,IAAI,IAAI;IAItB;;OAEG;IACI,SAAS,IAAI,IAAI;IAIxB;;OAEG;IACI,MAAM,IAAI,IAAI;IAIrB;;OAEG;IACI,MAAM,IAAI,IAAI;IAIrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACI,IAAI,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IAOrC;;OAEG;IACH,IAAW,cAAc,IAAI,MAAM,GAAG,IAAI,CAEzC;IAMD;;;;;;;;;;;OAWG;IACI,EAAE,CAAC,GAAG,EAAE,GAAG,GAAG,MAAM,GAAG,IAAI;IASlC;;;;;;;;;;;OAWG;IACI,EAAE,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAU7B;;;;OAIG;IACI,OAAO,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI;IAoBpC;;;;OAIG;IACI,KAAK,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI;IAyBlC;;;;;;;;;;OAUG;IACI,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IASnC;;;;;;;;OAQG;IACI,cAAc,CAAC,IAAI,UAAO,GAAG,IAAI;IAKxC;;;;;;;;;;;;;OAaG;IACI,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,KAAK,SAAO,EAAE,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI;IAahF;;OAEG;IACI,SAAS,IAAI,IAAI;IAQxB;;;OAGG;IACI,OAAO,IAAI,IAAI;IAItB;;;;OAIG;IACI,SAAS,IAAI,OAAO;IAS3B;;;;OAIG;IACU,GAAG,IAAI,OAAO,CAAC,SAAS,CAAC;IAkCtC;;;;;OAKG;IACI,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC;IAczC;;OAEG;IACH,OAAO,CAAC,IAAI;IAIZ;;OAEG;YACW,iBAAiB;IAuB/B;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAY5B;;OAEG;IACH,OAAO,CAAC,MAAM;IAId;;OAEG;IACH,OAAO,CAAC,iBAAiB;CA+C1B;AAMD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,GAAG,GAAG,CAEzF"}