@igniter-js/jobs 0.1.0

package/dist/adapters/bullmq.adapter.d.mts

@@ -0,0 +1,131 @@
+import { Redis } from 'ioredis';
+import { I as IgniterJobsAdapter, A as AdapterDispatchParams, a as AdapterScheduleParams, b as IgniterJobInfo, c as IgniterJobStatus, d as IgniterJobLog, e as IgniterQueueInfo, f as IgniterQueueCleanOptions, g as IgniterJobCounts, h as IgniterJobSearchResult, i as IgniterJobEventHandler, j as IgniterJobUnsubscribeFn, k as AdapterWorkerConfig, l as AdapterJobHandler, m as AdapterWorkerHandle } from '../adapter-CcQCatSa.mjs';
+import '@igniter-js/core';
+
+/**
+ * @fileoverview BullMQ adapter for @igniter-js/jobs
+ * @module @igniter-js/jobs/adapters/bullmq
+ *
+ * @description
+ * Provides BullMQ-based implementation of the IgniterJobsAdapter interface.
+ * Requires Redis connection via ioredis.
+ *
+ * @example
+ * ```typescript
+ * import { BullMQAdapter } from '@igniter-js/jobs/adapters'
+ * import Redis from 'ioredis'
+ *
+ * const redis = new Redis()
+ * const adapter = BullMQAdapter.create({ redis })
+ *
+ * const jobs = IgniterJobs.create<AppContext>()
+ *   .withAdapter(adapter)
+ *   .build()
+ * ```
+ */
+
+/**
+ * BullMQ adapter options.
+ */
+interface BullMQAdapterOptions {
+    /**
+     * Redis connection (ioredis instance).
+     */
+    redis: Redis;
+}
+/**
+ * BullMQ implementation of IgniterJobsAdapter.
+ */
+declare class BullMQAdapter implements IgniterJobsAdapter {
+    private readonly redis;
+    private readonly queues;
+    private readonly workers;
+    private readonly queueEvents;
+    private BullMQ;
+    private constructor();
+    /**
+     * Create a new BullMQ adapter.
+     *
+     * @param options - Adapter options with Redis connection
+     * @returns A new BullMQAdapter instance
+     */
+    static create(options: BullMQAdapterOptions): BullMQAdapter;
+    /**
+     * Get the underlying Redis client.
+     */
+    get client(): Redis;
+    /**
+     * Lazily load BullMQ module.
+     */
+    private getBullMQ;
+    /**
+     * Get or create a queue instance.
+     */
+    private getOrCreateQueue;
+    /**
+     * Get or create queue events instance.
+     */
+    private getQueueEvents;
+    /**
+     * Convert BullMQ job state to IgniterJobStatus.
+     */
+    private mapJobState;
+    /**
+     * Convert BullMQ job to IgniterJobInfo.
+     */
+    private mapJobToInfo;
+    dispatch(params: AdapterDispatchParams): Promise<string>;
+    schedule(params: AdapterScheduleParams): Promise<string>;
+    getJob(queue: string, jobId: string): Promise<IgniterJobInfo | null>;
+    getJobState(queue: string, jobId: string): Promise<IgniterJobStatus | null>;
+    getJobProgress(queue: string, jobId: string): Promise<number>;
+    getJobLogs(queue: string, jobId: string): Promise<IgniterJobLog[]>;
+    retryJob(queue: string, jobId: string): Promise<void>;
+    removeJob(queue: string, jobId: string): Promise<void>;
+    promoteJob(queue: string, jobId: string): Promise<void>;
+    moveJob(queue: string, jobId: string, state: 'failed' | 'completed', reason?: string): Promise<void>;
+    retryJobs(queue: string, jobIds: string[]): Promise<void>;
+    removeJobs(queue: string, jobIds: string[]): Promise<void>;
+    getQueue(queue: string): Promise<IgniterQueueInfo>;
+    pauseQueue(queue: string): Promise<void>;
+    resumeQueue(queue: string): Promise<void>;
+    drainQueue(queue: string): Promise<number>;
+    cleanQueue(queue: string, options: IgniterQueueCleanOptions): Promise<number>;
+    obliterateQueue(queue: string, options?: {
+        force?: boolean;
+    }): Promise<void>;
+    retryAllFailed(queue: string): Promise<number>;
+    getJobCounts(queue: string): Promise<IgniterJobCounts>;
+    listJobs(queue: string, options?: {
+        status?: IgniterJobStatus[];
+        start?: number;
+        end?: number;
+    }): Promise<IgniterJobSearchResult[]>;
+    pauseJobType(queue: string, jobName: string): Promise<void>;
+    resumeJobType(queue: string, jobName: string): Promise<void>;
+    private config?;
+    subscribe(pattern: string, handler: IgniterJobEventHandler): Promise<IgniterJobUnsubscribeFn>;
+    private matchesPattern;
+    createWorker(config: AdapterWorkerConfig, handler: AdapterJobHandler): Promise<AdapterWorkerHandle>;
+    searchJobs(filter: {
+        status?: IgniterJobStatus[];
+        queue?: string;
+        jobName?: string;
+        scopeId?: string;
+        actorId?: string;
+        dateRange?: {
+            from?: Date;
+            to?: Date;
+        };
+        orderBy?: string;
+        limit?: number;
+        offset?: number;
+    }): Promise<IgniterJobSearchResult[]>;
+    searchQueues(filter: {
+        name?: string;
+        isPaused?: boolean;
+    }): Promise<IgniterQueueInfo[]>;
+    shutdown(): Promise<void>;
+}
+
+export { BullMQAdapter, type BullMQAdapterOptions };

package/dist/adapters/bullmq.adapter.d.ts

@@ -0,0 +1,131 @@
+import { Redis } from 'ioredis';
+import { I as IgniterJobsAdapter, A as AdapterDispatchParams, a as AdapterScheduleParams, b as IgniterJobInfo, c as IgniterJobStatus, d as IgniterJobLog, e as IgniterQueueInfo, f as IgniterQueueCleanOptions, g as IgniterJobCounts, h as IgniterJobSearchResult, i as IgniterJobEventHandler, j as IgniterJobUnsubscribeFn, k as AdapterWorkerConfig, l as AdapterJobHandler, m as AdapterWorkerHandle } from '../adapter-CcQCatSa.js';
+import '@igniter-js/core';
+
+/**
+ * @fileoverview BullMQ adapter for @igniter-js/jobs
+ * @module @igniter-js/jobs/adapters/bullmq
+ *
+ * @description
+ * Provides BullMQ-based implementation of the IgniterJobsAdapter interface.
+ * Requires Redis connection via ioredis.
+ *
+ * @example
+ * ```typescript
+ * import { BullMQAdapter } from '@igniter-js/jobs/adapters'
+ * import Redis from 'ioredis'
+ *
+ * const redis = new Redis()
+ * const adapter = BullMQAdapter.create({ redis })
+ *
+ * const jobs = IgniterJobs.create<AppContext>()
+ *   .withAdapter(adapter)
+ *   .build()
+ * ```
+ */
+
+/**
+ * BullMQ adapter options.
+ */
+interface BullMQAdapterOptions {
+    /**
+     * Redis connection (ioredis instance).
+     */
+    redis: Redis;
+}
+/**
+ * BullMQ implementation of IgniterJobsAdapter.
+ */
+declare class BullMQAdapter implements IgniterJobsAdapter {
+    private readonly redis;
+    private readonly queues;
+    private readonly workers;
+    private readonly queueEvents;
+    private BullMQ;
+    private constructor();
+    /**
+     * Create a new BullMQ adapter.
+     *
+     * @param options - Adapter options with Redis connection
+     * @returns A new BullMQAdapter instance
+     */
+    static create(options: BullMQAdapterOptions): BullMQAdapter;
+    /**
+     * Get the underlying Redis client.
+     */
+    get client(): Redis;
+    /**
+     * Lazily load BullMQ module.
+     */
+    private getBullMQ;
+    /**
+     * Get or create a queue instance.
+     */
+    private getOrCreateQueue;
+    /**
+     * Get or create queue events instance.
+     */
+    private getQueueEvents;
+    /**
+     * Convert BullMQ job state to IgniterJobStatus.
+     */
+    private mapJobState;
+    /**
+     * Convert BullMQ job to IgniterJobInfo.
+     */
+    private mapJobToInfo;
+    dispatch(params: AdapterDispatchParams): Promise<string>;
+    schedule(params: AdapterScheduleParams): Promise<string>;
+    getJob(queue: string, jobId: string): Promise<IgniterJobInfo | null>;
+    getJobState(queue: string, jobId: string): Promise<IgniterJobStatus | null>;
+    getJobProgress(queue: string, jobId: string): Promise<number>;
+    getJobLogs(queue: string, jobId: string): Promise<IgniterJobLog[]>;
+    retryJob(queue: string, jobId: string): Promise<void>;
+    removeJob(queue: string, jobId: string): Promise<void>;
+    promoteJob(queue: string, jobId: string): Promise<void>;
+    moveJob(queue: string, jobId: string, state: 'failed' | 'completed', reason?: string): Promise<void>;
+    retryJobs(queue: string, jobIds: string[]): Promise<void>;
+    removeJobs(queue: string, jobIds: string[]): Promise<void>;
+    getQueue(queue: string): Promise<IgniterQueueInfo>;
+    pauseQueue(queue: string): Promise<void>;
+    resumeQueue(queue: string): Promise<void>;
+    drainQueue(queue: string): Promise<number>;
+    cleanQueue(queue: string, options: IgniterQueueCleanOptions): Promise<number>;
+    obliterateQueue(queue: string, options?: {
+        force?: boolean;
+    }): Promise<void>;
+    retryAllFailed(queue: string): Promise<number>;
+    getJobCounts(queue: string): Promise<IgniterJobCounts>;
+    listJobs(queue: string, options?: {
+        status?: IgniterJobStatus[];
+        start?: number;
+        end?: number;
+    }): Promise<IgniterJobSearchResult[]>;
+    pauseJobType(queue: string, jobName: string): Promise<void>;
+    resumeJobType(queue: string, jobName: string): Promise<void>;
+    private config?;
+    subscribe(pattern: string, handler: IgniterJobEventHandler): Promise<IgniterJobUnsubscribeFn>;
+    private matchesPattern;
+    createWorker(config: AdapterWorkerConfig, handler: AdapterJobHandler): Promise<AdapterWorkerHandle>;
+    searchJobs(filter: {
+        status?: IgniterJobStatus[];
+        queue?: string;
+        jobName?: string;
+        scopeId?: string;
+        actorId?: string;
+        dateRange?: {
+            from?: Date;
+            to?: Date;
+        };
+        orderBy?: string;
+        limit?: number;
+        offset?: number;
+    }): Promise<IgniterJobSearchResult[]>;
+    searchQueues(filter: {
+        name?: string;
+        isPaused?: boolean;
+    }): Promise<IgniterQueueInfo[]>;
+    shutdown(): Promise<void>;
+}
+
+export { BullMQAdapter, type BullMQAdapterOptions };