@quave/agenda 1.0.0

package/dist/cjs/index.js

@@ -0,0 +1,776 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.when = exports.combine = exports.exponential = exports.linear = exports.constant = exports.backoffStrategies = exports.isWithinDateRange = exports.shouldSkipDay = exports.applySkipDays = exports.applyDateRangeConstraints = exports.applyAllDateConstraints = exports.Agenda = void 0;
+const events_1 = require("events");
+const debug_1 = __importDefault(require("debug"));
+const Job_js_1 = require("./Job.js");
+const priority_js_1 = require("./utils/priority.js");
+const JobProcessor_js_1 = require("./JobProcessor.js");
+const processEvery_js_1 = require("./utils/processEvery.js");
+const stack_js_1 = require("./utils/stack.js");
+const log = (0, debug_1.default)('agenda');
+const DefaultOptions = {
+    processEvery: 5000,
+    defaultConcurrency: 5,
+    maxConcurrency: 20,
+    defaultLockLimit: 0,
+    lockLimit: 0,
+    defaultLockLifetime: 10 * 60 * 1000,
+    forkHelper: { path: 'dist/childWorker.js' },
+    removeOnComplete: false
+};
+/**
+ * @class
+ */
+class Agenda extends events_1.EventEmitter {
+    // Implementation (eslint-disable needed because overloads provide the public type safety)
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    on(event, listener) {
+        if (this.forkedWorker && event !== 'ready' && event !== 'error') {
+            const warning = new Error(`calling on(${event}) during a forkedWorker has no effect!`);
+            log('WARNING: %s %s', warning.message, warning.stack);
+            return this;
+        }
+        return super.on(event, listener);
+    }
+    isActiveJobProcessor() {
+        return !!this.jobProcessor;
+    }
+    async runForkedJob(jobId) {
+        const jobData = await this.db.getJobById(jobId);
+        if (!jobData) {
+            throw new Error('db entry not found');
+        }
+        const job = new Job_js_1.Job(this, jobData);
+        await job.runJob();
+    }
+    async getRunningStats(fullDetails = false) {
+        if (!this.jobProcessor) {
+            throw new Error('agenda not running!');
+        }
+        const status = await this.jobProcessor.getStatus(fullDetails);
+        // Add backend info (stored in Agenda, not JobProcessor)
+        status.backend = {
+            name: this.backend.name,
+            hasNotificationChannel: this.hasNotificationChannel()
+        };
+        return status;
+    }
+    /**
+     * @param config - Agenda configuration with backend
+     * @param cb - Optional callback after Agenda is ready
+     */
+    constructor(config, cb) {
+        super();
+        this.definitions = {};
+        // Prevent unhandled 'error' events from crashing the process.
+        // Users can still attach their own 'error' listener to handle errors.
+        this.on('error', () => { });
+        this.attrs = {
+            name: config.name || '',
+            processEvery: (0, processEvery_js_1.calculateProcessEvery)(config.processEvery) || DefaultOptions.processEvery,
+            defaultConcurrency: config.defaultConcurrency || DefaultOptions.defaultConcurrency,
+            maxConcurrency: config.maxConcurrency || DefaultOptions.maxConcurrency,
+            defaultLockLimit: config.defaultLockLimit || DefaultOptions.defaultLockLimit,
+            lockLimit: config.lockLimit || DefaultOptions.lockLimit,
+            defaultLockLifetime: config.defaultLockLifetime || DefaultOptions.defaultLockLifetime,
+            removeOnComplete: config.removeOnComplete ?? DefaultOptions.removeOnComplete
+        };
+        this.forkedWorker = config.forkedWorker;
+        this.forkHelper = config.forkHelper;
+        // Initialize persistent job logger: disabled by default
+        if (config.logging === true) {
+            // Use backend's built-in logger, all jobs logged
+            this.jobLogger = config.backend.logger;
+            this.loggingDefault = true;
+        }
+        else if (config.logging && typeof config.logging === 'object' && 'log' in config.logging) {
+            // Passed a JobLogger instance directly — all jobs logged
+            this.jobLogger = config.logging;
+            this.loggingDefault = true;
+        }
+        else if (config.logging && typeof config.logging === 'object') {
+            // Options object: { logger?, default? }
+            const opts = config.logging;
+            this.jobLogger = opts.logger ?? config.backend.logger;
+            this.loggingDefault = opts.default ?? true;
+        }
+        else {
+            // Logging disabled (false / omitted)
+            this.loggingDefault = true;
+        }
+        // Store backend and get repository
+        this.backend = config.backend;
+        this.db = config.backend.repository;
+        // Notification channel priority: explicit config > backend's channel
+        this.notificationChannel = config.notificationChannel ?? config.backend.notificationChannel;
+        // Ready promise settles when the backend connection attempt finishes
+        this.ready = new Promise((resolve, reject) => {
+            this.once('ready', resolve);
+            // Connect the backend. A failed connection rejects `ready` (and
+            // emits 'error' when someone listens) instead of leaving an
+            // unhandled rejection and a forever-pending ready promise.
+            this.backend.connect().then(() => this.emit('ready'), (error) => {
+                log('backend connection failed', error);
+                if (this.listenerCount('error') > 0) {
+                    this.emit('error', error);
+                }
+                reject(error);
+            });
+        });
+        if (cb) {
+            // cb is only invoked on success; the ready rejection is already
+            // surfaced above, so avoid a second unhandled rejection here.
+            this.ready.then(() => cb(), () => { });
+        }
+    }
+    /**
+     * Cancels any jobs matching the passed options, and removes them from the database.
+     * @param options Options for which jobs to cancel
+     */
+    async cancel(options) {
+        log('attempting to cancel all Agenda jobs', options);
+        await this.ready;
+        try {
+            const amountOfRemovedJobs = await this.db.removeJobs(options);
+            log('%s jobs cancelled', amountOfRemovedJobs);
+            return amountOfRemovedJobs;
+        }
+        catch (error) {
+            log('error trying to delete jobs from database');
+            throw error;
+        }
+    }
+    /**
+     * Disables any jobs matching the passed options, preventing them from being run.
+     * @param options Options for which jobs to disable
+     * @returns Number of jobs disabled
+     */
+    async disable(options) {
+        log('attempting to disable Agenda jobs', options);
+        await this.ready;
+        try {
+            const numDisabled = await this.db.disableJobs(options);
+            log('%s jobs disabled', numDisabled);
+            return numDisabled;
+        }
+        catch (error) {
+            log('error trying to disable jobs');
+            throw error;
+        }
+    }
+    /**
+     * Enables any jobs matching the passed options, allowing them to be run.
+     * @param options Options for which jobs to enable
+     * @returns Number of jobs enabled
+     */
+    async enable(options) {
+        log('attempting to enable Agenda jobs', options);
+        await this.ready;
+        try {
+            const numEnabled = await this.db.enableJobs(options);
+            log('%s jobs enabled', numEnabled);
+            return numEnabled;
+        }
+        catch (error) {
+            log('error trying to enable jobs');
+            throw error;
+        }
+    }
+    /**
+     * Set name of queue
+     * @param name
+     */
+    name(name) {
+        log('Agenda.name(%s)', name);
+        this.attrs.name = name;
+        return this;
+    }
+    /**
+     * Set the time how often the job processor checks for new jobs to process
+     * @param time
+     */
+    processEvery(time) {
+        if (this.jobProcessor) {
+            throw new Error('job processor is already running, you need to set processEvery before calling start');
+        }
+        log('Agenda.processEvery(%d)', time);
+        this.attrs.processEvery = (0, processEvery_js_1.calculateProcessEvery)(time);
+        return this;
+    }
+    /**
+     * Set the concurrency for jobs (globally), type does not matter
+     * @param num
+     */
+    maxConcurrency(num) {
+        log('Agenda.maxConcurrency(%d)', num);
+        this.attrs.maxConcurrency = num;
+        return this;
+    }
+    /**
+     * Set the default concurrency for each job
+     * @param num number of max concurrency
+     */
+    defaultConcurrency(num) {
+        log('Agenda.defaultConcurrency(%d)', num);
+        this.attrs.defaultConcurrency = num;
+        return this;
+    }
+    /**
+     * Set the default amount jobs that are allowed to be locked at one time (GLOBAL)
+     * @param num
+     */
+    lockLimit(num) {
+        log('Agenda.lockLimit(%d)', num);
+        this.attrs.lockLimit = num;
+        return this;
+    }
+    /**
+     * Set default lock limit per job type
+     * @param num
+     */
+    defaultLockLimit(num) {
+        log('Agenda.defaultLockLimit(%d)', num);
+        this.attrs.defaultLockLimit = num;
+        return this;
+    }
+    /**
+     * Set the default lock time (in ms)
+     * Default is 10 * 60 * 1000 ms (10 minutes)
+     * @param ms
+     */
+    defaultLockLifetime(ms) {
+        log('Agenda.defaultLockLifetime(%d)', ms);
+        this.attrs.defaultLockLifetime = ms;
+        return this;
+    }
+    /**
+     * Set a notification channel for real-time job notifications
+     * @param channel - The notification channel implementation
+     */
+    notifyVia(channel) {
+        if (this.jobProcessor) {
+            throw new Error('job processor is already running, you need to set notificationChannel before calling start');
+        }
+        log('Agenda.notifyVia([NotificationChannel])');
+        this.notificationChannel = channel;
+        return this;
+    }
+    /**
+     * Check if a notification channel is configured
+     */
+    hasNotificationChannel() {
+        return !!this.notificationChannel;
+    }
+    /**
+     * Check if persistent job logging is enabled
+     */
+    hasJobLogger() {
+        return !!this.jobLogger;
+    }
+    /**
+     * Log a job lifecycle event to the persistent job logger (fire-and-forget).
+     * Does nothing if no job logger is configured or if logging is disabled
+     * for the job definition (respects per-definition `logging` and the global `loggingDefault`).
+     * @internal
+     */
+    logJobEvent(entry) {
+        if (!this.jobLogger)
+            return;
+        // Per-definition logging overrides the global default.
+        // If definition.logging is undefined, fall back to loggingDefault.
+        const definition = this.definitions[entry.jobName];
+        const enabled = definition?.logging ?? this.loggingDefault;
+        if (!enabled)
+            return;
+        this.jobLogger
+            .log({
+            ...entry,
+            timestamp: new Date(),
+            agendaName: this.attrs.name || undefined
+        })
+            .catch(err => {
+            log('failed to write job log entry: %O', err);
+        });
+    }
+    /**
+     * Query persistent job logs.
+     * Returns empty result if no job logger is configured.
+     */
+    async getLogs(query) {
+        if (!this.jobLogger) {
+            return { entries: [], total: 0 };
+        }
+        return this.jobLogger.getLogs(query);
+    }
+    /**
+     * Clear persistent job logs matching the query.
+     * Returns 0 if no job logger is configured.
+     */
+    async clearLogs(query) {
+        if (!this.jobLogger) {
+            return 0;
+        }
+        return this.jobLogger.clearLogs(query);
+    }
+    /**
+     * Publish a job notification to the notification channel
+     * @internal
+     */
+    async publishJobNotification(job) {
+        if (!this.notificationChannel || this.notificationChannel.state !== 'connected') {
+            // Channel not configured or not connected - skip publishing
+            return;
+        }
+        const notification = {
+            jobId: job.attrs._id,
+            jobName: job.attrs.name,
+            nextRunAt: job.attrs.nextRunAt,
+            priority: job.attrs.priority,
+            timestamp: new Date(),
+            source: this.attrs.name || undefined
+        };
+        try {
+            await this.notificationChannel.publish(notification);
+            log('published job notification for [%s:%s]', job.attrs.name, job.attrs._id);
+        }
+        catch (error) {
+            log('failed to publish job notification for [%s:%s]', job.attrs.name, job.attrs._id, error);
+            this.emit('error', error);
+        }
+    }
+    /**
+     * Publish a job state notification to the notification channel.
+     * This enables bi-directional communication so that all subscribers
+     * can receive job lifecycle events (start, success, fail, complete, etc.)
+     * @internal
+     */
+    publishJobStateNotification(job, type, extra) {
+        if (!this.notificationChannel ||
+            this.notificationChannel.state !== 'connected' ||
+            !this.notificationChannel.publishState) {
+            // Channel not configured, not connected, or doesn't support state notifications
+            return;
+        }
+        const notification = {
+            type,
+            jobId: job.attrs._id,
+            jobName: job.attrs.name,
+            timestamp: new Date(),
+            source: this.attrs.name || undefined,
+            ...extra
+        };
+        // fire+forget
+        this.notificationChannel
+            .publishState(notification)
+            .then(() => {
+            log('published job state notification [%s] for [%s:%s]', type, job.attrs.name, job.attrs._id);
+        })
+            .catch(error => {
+            log('failed to publish job state notification [%s] for [%s:%s]', type, job.attrs.name, job.attrs._id, error);
+            this.emit('error', error);
+        });
+    }
+    /**
+     * Subscribe to state notifications and re-emit them as regular events.
+     * This allows `agenda.on('success:jobName', ...)` to work across processes.
+     * @internal
+     */
+    subscribeToStateNotifications() {
+        if (!this.notificationChannel?.subscribeState) {
+            return () => { };
+        }
+        return this.notificationChannel.subscribeState(notification => {
+            // Skip events from our own instance to avoid double-firing
+            // (we already emit locally in Job.run())
+            // Handle both empty strings and undefined as "same source" when both are falsy
+            const notificationSource = notification.source || '';
+            const ourSource = this.attrs.name || '';
+            if (notificationSource === ourSource) {
+                return;
+            }
+            log('received remote state notification [%s] for [%s:%s]', notification.type, notification.jobName, notification.jobId);
+            // Use nextTick to ensure local events are processed first
+            // This prevents race conditions where remote events arrive before local processing completes
+            process.nextTick(() => {
+                // Re-emit as regular events with remote=true flag
+                // For 'fail' events, the first argument is the error
+                if (notification.type === 'fail') {
+                    this.emit('fail', notification.error, notification, true);
+                    this.emit(`fail:${notification.jobName}`, notification.error, notification, true);
+                }
+                else if (notification.type === 'retry') {
+                    // For 'retry' events, pass retry details as second argument
+                    const retryDetails = {
+                        attempt: notification.retryAttempt || 1,
+                        delay: 0, // Not available in notification
+                        nextRunAt: notification.retryAt || new Date(),
+                        error: new Error(notification.error || 'Unknown error')
+                    };
+                    this.emit('retry', notification, retryDetails, true);
+                    this.emit(`retry:${notification.jobName}`, notification, retryDetails, true);
+                }
+                else {
+                    this.emit(notification.type, notification, true);
+                    this.emit(`${notification.type}:${notification.jobName}`, notification, true);
+                }
+            });
+        });
+    }
+    /**
+     * Query jobs with database-agnostic options.
+     * Returns jobs with computed states and supports filtering by state.
+     *
+     * @param options - Query options (name, state, search, pagination)
+     * @returns Jobs with computed states and total count
+     */
+    async queryJobs(options) {
+        await this.ready;
+        return this.db.queryJobs(options);
+    }
+    /**
+     * Get overview statistics for jobs grouped by name.
+     * Returns counts of jobs in each state for each job name.
+     *
+     * @returns Array of job overviews with state counts
+     */
+    async getJobsOverview() {
+        await this.ready;
+        return this.db.getJobsOverview();
+    }
+    /**
+     * Removes all orphaned jobs (jobs whose names are not currently defined).
+     * @note: Only use after defining your jobs
+     */
+    async purge() {
+        const definedNames = Object.keys(this.definitions);
+        log('Agenda.purge(%o)', definedNames);
+        return this.cancel({ notNames: definedNames });
+    }
+    /**
+     * Removes ALL jobs from the database unconditionally.
+     * Use with caution — this cannot be undone.
+     * @returns Number of jobs removed
+     */
+    async cancelAll() {
+        log('Agenda.cancelAll()');
+        await this.ready;
+        try {
+            const removed = await this.db.purgeAllJobs();
+            log('%s jobs cancelled', removed);
+            return removed;
+        }
+        catch (error) {
+            log('error trying to cancel all jobs from database');
+            throw error;
+        }
+    }
+    define(name, processor, options) {
+        if (this.definitions[name]) {
+            log('overwriting already defined agenda job', name);
+        }
+        const filePath = (0, stack_js_1.getCallerFilePath)();
+        this.definitions[name] = {
+            fn: processor,
+            filePath,
+            concurrency: options?.concurrency || this.attrs.defaultConcurrency,
+            lockLimit: options?.lockLimit || this.attrs.defaultLockLimit,
+            priority: (0, priority_js_1.parsePriority)(options?.priority),
+            lockLifetime: options?.lockLifetime || this.attrs.defaultLockLifetime,
+            backoff: options?.backoff,
+            removeOnComplete: options?.removeOnComplete ?? this.attrs.removeOnComplete,
+            logging: options?.logging
+        };
+        log('job [%s] defined with following options: \n%O', name, this.definitions[name]);
+    }
+    /**
+     * Internal helper method that uses createJob to create jobs for an array of names
+     * @param names - Job names to schedule
+     * @param createJob - Factory function to create each job
+     * @returns Array of created jobs
+     */
+    async createJobs(names, createJob) {
+        try {
+            const jobs = await Promise.all(names.map(name => createJob(name)));
+            log('createJobs() -> all jobs created successfully');
+            return jobs;
+        }
+        catch (error) {
+            log('createJobs() -> error creating one or more of the jobs', error);
+            throw error;
+        }
+    }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    create(name, data) {
+        log('Agenda.create(%s, [Object])', name);
+        const priority = this.definitions[name] ? this.definitions[name].priority : 0;
+        return new Job_js_1.Job(this, { name, data, type: 'normal', priority });
+    }
+    async every(interval, names, data, options) {
+        log('Agenda.every(%s, %O, %O)', interval, names, options);
+        /** Internal method to setup job that gets run every interval */
+        const createJob = async (name) => {
+            const job = this.create(name, data);
+            job.attrs.type = 'single';
+            // Apply date constraints before repeatEvery (so they're used in nextRunAt computation)
+            if (options?.startDate) {
+                job.startDate(options.startDate);
+            }
+            if (options?.endDate) {
+                job.endDate(options.endDate);
+            }
+            if (options?.skipDays) {
+                job.skipDays(options.skipDays);
+            }
+            job.repeatEvery(interval, options);
+            if (options?.forkMode) {
+                job.forkMode(options.forkMode);
+            }
+            await job.save();
+            return job;
+        };
+        if (typeof names === 'string') {
+            return createJob(names);
+        }
+        log('Agenda.every(%s, %s, %O)', interval, names, options);
+        return this.createJobs(names, createJob);
+    }
+    async schedule(when, names, data, options) {
+        const createJob = async (name) => {
+            const job = this.create(name, data);
+            // Apply date constraints before scheduling
+            if (options?.startDate) {
+                job.startDate(options.startDate);
+            }
+            if (options?.endDate) {
+                job.endDate(options.endDate);
+            }
+            if (options?.skipDays) {
+                job.skipDays(options.skipDays);
+            }
+            await job.schedule(when).save();
+            return job;
+        };
+        if (typeof names === 'string') {
+            log('Agenda.schedule(%s, %O, [%O])', when, names);
+            return createJob(names);
+        }
+        log('Agenda.schedule(%s, %O, [%O])', when, names);
+        return this.createJobs(names, createJob);
+    }
+    async now(name, data) {
+        log('Agenda.now(%s, [Object])', name);
+        try {
+            const job = this.create(name, data);
+            job.schedule(new Date());
+            await job.save();
+            return job;
+        }
+        catch (error) {
+            log('error trying to create a job for this exact moment');
+            throw error;
+        }
+    }
+    /**
+     * Create a debounced job that combines rapid submissions into a single execution.
+     * Requires a unique key to identify which jobs should be debounced together.
+     *
+     * @param name - Job name
+     * @param data - Job data
+     * @param uniqueKey - Unique constraint to identify jobs (e.g., { 'data.userId': 123 })
+     * @param debounceMs - Debounce delay in milliseconds
+     * @param options - Optional debounce options (maxWait, strategy)
+     *
+     * @example
+     * ```ts
+     * // Debounce search index updates by entity type
+     * await agenda.nowDebounced(
+     *   'updateSearchIndex',
+     *   { entityType: 'products' },
+     *   { 'data.entityType': 'products' },
+     *   2000
+     * );
+     *
+     * // With maxWait to guarantee execution within 30s
+     * await agenda.nowDebounced(
+     *   'syncUser',
+     *   { userId: 123 },
+     *   { 'data.userId': 123 },
+     *   5000,
+     *   { maxWait: 30000 }
+     * );
+     * ```
+     */
+    async nowDebounced(name, data, uniqueKey, debounceMs, options) {
+        log('Agenda.nowDebounced(%s, [Object], %O, %d)', name, uniqueKey, debounceMs);
+        try {
+            const job = this.create(name, data);
+            job.schedule(new Date()).unique(uniqueKey).debounce(debounceMs, options);
+            await job.save();
+            return job;
+        }
+        catch (error) {
+            log('error trying to create a debounced job');
+            throw error;
+        }
+    }
+    /**
+     * Starts processing jobs using processJobs() methods, storing an interval ID
+     * This method will only resolve if a db has been set up beforehand.
+     */
+    async start() {
+        log('Agenda.start called, waiting for agenda to be initialized (db connection)', this.attrs.processEvery);
+        await this.ready;
+        if (this.jobProcessor) {
+            log('Agenda.start was already called, ignoring');
+            return;
+        }
+        // Connect notification channel if configured
+        if (this.notificationChannel) {
+            log('Agenda.start connecting notification channel');
+            await this.notificationChannel.connect();
+            // Subscribe to state notifications for cross-process event propagation
+            this.stateSubscriptionUnsubscribe = this.subscribeToStateNotifications();
+        }
+        this.jobProcessor = new JobProcessor_js_1.JobProcessor(this, this.attrs.maxConcurrency, this.attrs.lockLimit, this.attrs.processEvery, this.notificationChannel);
+    }
+    /**
+     * Clear the interval that processes the jobs and unlocks all currently locked jobs
+     * @param closeConnection - Whether to close the database connection.
+     *   Defaults to backend.ownsConnection (true if backend created the connection,
+     *   false if connection was passed in by user).
+     */
+    async stop(closeConnection) {
+        if (!this.jobProcessor) {
+            log('Agenda.stop called, but agenda has never started!');
+            return;
+        }
+        log('Agenda.stop called, clearing interval for processJobs()');
+        const lockedJobs = this.jobProcessor.stop();
+        log('Agenda._unlockJobs()');
+        const jobIds = lockedJobs?.map(job => job.attrs._id) || [];
+        if (jobIds.length > 0) {
+            log('about to unlock jobs with ids: %O', jobIds);
+            await this.db.unlockJobs(jobIds);
+        }
+        // Unsubscribe from state notifications
+        if (this.stateSubscriptionUnsubscribe) {
+            this.stateSubscriptionUnsubscribe();
+            this.stateSubscriptionUnsubscribe = undefined;
+        }
+        // Disconnect notification channel if configured (we always disconnect since we connected it in start)
+        if (this.notificationChannel) {
+            log('Agenda.stop disconnecting notification channel');
+            await this.notificationChannel.disconnect();
+        }
+        // Determine whether to close backend connection
+        const shouldClose = closeConnection ?? this.backend.ownsConnection ?? true;
+        // Disconnect the backend
+        if (shouldClose) {
+            log('Agenda.stop disconnecting backend');
+            await this.backend.disconnect();
+        }
+        this.jobProcessor = undefined;
+    }
+    /**
+     * Waits for all currently running jobs to finish before stopping.
+     * This allows for a graceful shutdown where jobs complete their work.
+     * Unlike stop(), this method waits for running jobs to complete instead of unlocking them.
+     *
+     * @param options - Drain options or timeout in milliseconds
+     *   - `timeout`: Maximum time to wait for jobs to complete
+     *   - `signal`: AbortSignal to cancel the drain operation
+     *   - `closeConnection`: Whether to close the database connection (default: backend.ownsConnection)
+     * @returns DrainResult with completion statistics
+     *
+     * @example
+     * // Wait indefinitely for all jobs to complete
+     * await agenda.drain();
+     *
+     * @example
+     * // Wait up to 30 seconds
+     * const result = await agenda.drain(30000);
+     * if (result.timedOut) console.log(`${result.running} jobs still running`);
+     *
+     * @example
+     * // Use AbortSignal for external control
+     * const controller = new AbortController();
+     * setTimeout(() => controller.abort(), 30000);
+     * await agenda.drain({ signal: controller.signal });
+     */
+    async drain(options) {
+        if (!this.jobProcessor) {
+            log('Agenda.drain called, but agenda has never started!');
+            return { completed: 0, running: 0, timedOut: false, aborted: false };
+        }
+        // Normalize options
+        const opts = typeof options === 'number' ? { timeout: options } : options ?? {};
+        log('Agenda.drain called, waiting for jobs to finish');
+        const result = await this.jobProcessor.drain(opts);
+        // Unsubscribe from state notifications
+        if (this.stateSubscriptionUnsubscribe) {
+            this.stateSubscriptionUnsubscribe();
+            this.stateSubscriptionUnsubscribe = undefined;
+        }
+        // Disconnect notification channel if configured (we always disconnect since we connected it in start)
+        if (this.notificationChannel) {
+            log('Agenda.drain disconnecting notification channel');
+            await this.notificationChannel.disconnect();
+        }
+        // Determine whether to close backend connection
+        const shouldClose = opts.closeConnection ?? this.backend.ownsConnection ?? true;
+        // Disconnect the backend
+        if (shouldClose) {
+            log('Agenda.drain disconnecting backend');
+            await this.backend.disconnect();
+        }
+        this.jobProcessor = undefined;
+        return result;
+    }
+}
+exports.Agenda = Agenda;
+__exportStar(require("./types/AgendaConfig.js"), exports);
+__exportStar(require("./types/JobDefinition.js"), exports);
+__exportStar(require("./types/JobParameters.js"), exports);
+__exportStar(require("./types/DbOptions.js"), exports);
+__exportStar(require("./Job.js"), exports);
+__exportStar(require("./types/JobQuery.js"), exports);
+__exportStar(require("./types/JobRepository.js"), exports);
+__exportStar(require("./types/NotificationChannel.js"), exports);
+__exportStar(require("./types/AgendaBackend.js"), exports);
+__exportStar(require("./types/AgendaStatus.js"), exports);
+__exportStar(require("./types/DrainOptions.js"), exports);
+__exportStar(require("./notifications/index.js"), exports);
+__exportStar(require("./types/JobLogger.js"), exports);
+var dateConstraints_js_1 = require("./utils/dateConstraints.js");
+Object.defineProperty(exports, "applyAllDateConstraints", { enumerable: true, get: function () { return dateConstraints_js_1.applyAllDateConstraints; } });
+Object.defineProperty(exports, "applyDateRangeConstraints", { enumerable: true, get: function () { return dateConstraints_js_1.applyDateRangeConstraints; } });
+Object.defineProperty(exports, "applySkipDays", { enumerable: true, get: function () { return dateConstraints_js_1.applySkipDays; } });
+Object.defineProperty(exports, "shouldSkipDay", { enumerable: true, get: function () { return dateConstraints_js_1.shouldSkipDay; } });
+Object.defineProperty(exports, "isWithinDateRange", { enumerable: true, get: function () { return dateConstraints_js_1.isWithinDateRange; } });
+__exportStar(require("./decorators/index.js"), exports);
+var backoff_js_1 = require("./utils/backoff.js");
+Object.defineProperty(exports, "backoffStrategies", { enumerable: true, get: function () { return backoff_js_1.backoffStrategies; } });
+Object.defineProperty(exports, "constant", { enumerable: true, get: function () { return backoff_js_1.constant; } });
+Object.defineProperty(exports, "linear", { enumerable: true, get: function () { return backoff_js_1.linear; } });
+Object.defineProperty(exports, "exponential", { enumerable: true, get: function () { return backoff_js_1.exponential; } });
+Object.defineProperty(exports, "combine", { enumerable: true, get: function () { return backoff_js_1.combine; } });
+Object.defineProperty(exports, "when", { enumerable: true, get: function () { return backoff_js_1.when; } });
+//# sourceMappingURL=index.js.map