bunqueue 2.8.53 → 2.8.56

package/dist/mcp/adapter.d.ts

@@ -1,404 +1,6 @@
-/**
- * MCP Backend Adapter
- * Abstraction layer for embedded (SQLite direct) and TCP (remote server) modes.
- */
-import type { CronJobInput } from '../domain/types/cron';
-import type { JobLogEntry } from '../domain/types/worker';
-/** Job counts per state */
-export interface JobCounts {
-    waiting: number;
-    prioritized: number;
-    delayed: number;
-    active: number;
-    completed: number;
-    failed: number;
-    paused: number;
-}
-/** Serialized job for MCP responses */
-export interface SerializedJob {
-    id: string;
-    queue: string;
-    data: unknown;
-    priority: number;
-    state?: string;
-    progress: number;
-    attempts: number;
-    maxAttempts: number;
-    createdAt: string;
-    startedAt?: string;
-}
-/** Serialized cron for MCP responses */
-export interface SerializedCron {
-    name: string;
-    queue: string;
-    schedule?: string;
-    repeatEvery?: number;
-    nextRun: string | null;
-    executions: number;
-}
-/** Webhook info */
-export interface WebhookInfo {
-    id: string;
-    url: string;
-    events: string[];
-    queue?: string;
-    enabled: boolean;
-}
-/** Worker info */
-export interface WorkerInfo {
-    id: string;
-    name: string;
-    queues: string[];
-    active: number;
-    processed: number;
-    failed: number;
-    lastHeartbeat: number;
-}
-/** Flow job input for creating flow trees */
-export interface FlowJobInput {
-    name: string;
-    queueName: string;
-    data?: Record<string, unknown>;
-    opts?: {
-        priority?: number;
-        delay?: number;
-        attempts?: number;
-    };
-    children?: FlowJobInput[];
-}
-/** Flow step input for chains and fan-out/fan-in */
-export interface FlowStepInput {
-    name: string;
-    queueName: string;
-    data: Record<string, unknown>;
-    opts?: {
-        priority?: number;
-        delay?: number;
-        attempts?: number;
-    };
-}
-/** Flow node result (recursive tree) */
-export interface FlowNodeResult {
-    jobId: string;
-    name: string;
-    queueName: string;
-    children?: FlowNodeResult[];
-}
-/** Common backend interface - all methods async for TCP compatibility */
-export interface McpBackend {
-    addJob(queue: string, name: string, data: unknown, opts?: {
-        priority?: number;
-        delay?: number;
-        attempts?: number;
-    }): Promise<{
-        jobId: string;
-    }>;
-    addJobsBulk(queue: string, jobs: Array<{
-        name: string;
-        data: unknown;
-        priority?: number;
-        delay?: number;
-    }>): Promise<{
-        jobIds: string[];
-    }>;
-    getJob(jobId: string): Promise<SerializedJob | null>;
-    getJobState(jobId: string): Promise<string>;
-    getJobResult(jobId: string): Promise<unknown>;
-    getProgress(jobId: string): Promise<{
-        progress: number;
-        message: string | null;
-    } | null>;
-    cancelJob(jobId: string): Promise<boolean>;
-    promoteJob(jobId: string): Promise<boolean>;
-    updateProgress(jobId: string, progress: number, message?: string): Promise<boolean>;
-    updateJobData(jobId: string, data: unknown): Promise<boolean>;
-    changeJobPriority(jobId: string, priority: number): Promise<boolean>;
-    moveToDelayed(jobId: string, delay: number): Promise<boolean>;
-    changeDelay(jobId: string, delay: number): Promise<boolean>;
-    discardJob(jobId: string): Promise<boolean>;
-    getChildrenValues(parentJobId: string): Promise<Record<string, unknown>>;
-    getJobByCustomId(customId: string): Promise<SerializedJob | null>;
-    waitForJobCompletion(jobId: string, timeoutMs: number): Promise<boolean>;
-    pullJob(queue: string, timeoutMs?: number): Promise<SerializedJob | null>;
-    pullJobBatch(queue: string, count: number, timeoutMs?: number): Promise<SerializedJob[]>;
-    ackJob(jobId: string, result?: unknown): Promise<void>;
-    ackJobBatch(jobIds: string[]): Promise<void>;
-    failJob(jobId: string, error?: string): Promise<void>;
-    jobHeartbeat(jobId: string): Promise<boolean>;
-    jobHeartbeatBatch(jobIds: string[]): Promise<number>;
-    extendLock(jobId: string, token: string, duration: number): Promise<boolean>;
-    getJobs(queue: string, opts?: {
-        state?: string;
-        start?: number;
-        end?: number;
-    }): Promise<SerializedJob[]>;
-    getJobCounts(queue: string): Promise<JobCounts>;
-    pauseQueue(queue: string): Promise<void>;
-    resumeQueue(queue: string): Promise<void>;
-    drainQueue(queue: string): Promise<number>;
-    obliterateQueue(queue: string): Promise<void>;
-    listQueues(): Promise<string[]>;
-    countJobs(queue: string): Promise<number>;
-    cleanQueue(queue: string, graceMs: number, state?: string, limit?: number): Promise<string[]>;
-    isPaused(queue: string): Promise<boolean>;
-    getCountsPerPriority(queue: string): Promise<Record<number, number>>;
-    getDlq(queue: string, limit?: number): Promise<SerializedJob[]>;
-    retryDlq(queue: string, jobId?: string): Promise<number>;
-    purgeDlq(queue: string): Promise<number>;
-    retryCompleted(queue: string, jobId?: string): Promise<number>;
-    setRateLimit(queue: string, limit: number): Promise<void>;
-    clearRateLimit(queue: string): Promise<void>;
-    setConcurrency(queue: string, limit: number): Promise<void>;
-    clearConcurrency(queue: string): Promise<void>;
-    addCron(input: CronJobInput): Promise<SerializedCron>;
-    getCron(name: string): Promise<SerializedCron | null>;
-    listCrons(): Promise<SerializedCron[]>;
-    deleteCron(name: string): Promise<boolean>;
-    addWebhook(url: string, events: string[], queue?: string): Promise<WebhookInfo>;
-    removeWebhook(id: string): Promise<boolean>;
-    listWebhooks(): Promise<WebhookInfo[]>;
-    setWebhookEnabled(id: string, enabled: boolean): Promise<boolean>;
-    registerWorker(name: string, queues: string[]): Promise<WorkerInfo>;
-    unregisterWorker(id: string): Promise<boolean>;
-    workerHeartbeat(id: string): Promise<boolean>;
-    listWorkers(): Promise<WorkerInfo[]>;
-    getStats(): Promise<Record<string, unknown>>;
-    getPerQueueStats(): Promise<Record<string, unknown>>;
-    getMemoryStats(): Promise<Record<string, unknown>>;
-    getPrometheusMetrics(): Promise<string>;
-    getStorageStatus(): Promise<{
-        diskFull: boolean;
-        error: string | null;
-    }>;
-    getJobLogs(jobId: string): Promise<JobLogEntry[]>;
-    addJobLog(jobId: string, message: string, level?: 'info' | 'warn' | 'error'): Promise<boolean>;
-    clearJobLogs(jobId: string, keepLogs?: number): Promise<void>;
-    compactMemory(): Promise<void>;
-    addFlow(flow: FlowJobInput): Promise<FlowNodeResult>;
-    addFlowChain(steps: FlowStepInput[]): Promise<{
-        jobIds: string[];
-    }>;
-    addFlowBulkThen(parallel: FlowStepInput[], final: FlowStepInput): Promise<{
-        parallelIds: string[];
-        finalId: string;
-    }>;
-    getFlow(jobId: string, queueName: string, depth?: number, maxChildren?: number): Promise<FlowNodeResult | null>;
-    shutdown(): void;
-}
-export declare class EmbeddedBackend implements McpBackend {
-    private flowProducer;
-    private getFlowProducer;
-    private get manager();
-    addJob(queue: string, name: string, data: unknown, opts?: {
-        priority?: number;
-        delay?: number;
-        attempts?: number;
-    }): Promise<{
-        jobId: string;
-    }>;
-    addJobsBulk(queue: string, jobs: Array<{
-        name: string;
-        data: unknown;
-        priority?: number;
-        delay?: number;
-    }>): Promise<{
-        jobIds: string[];
-    }>;
-    getJob(id: string): Promise<SerializedJob | null>;
-    getJobState(id: string): Promise<string>;
-    getJobResult(id: string): Promise<unknown>;
-    cancelJob(id: string): Promise<boolean>;
-    promoteJob(id: string): Promise<boolean>;
-    updateProgress(id: string, progress: number, message?: string): Promise<boolean>;
-    updateJobData(id: string, data: unknown): Promise<boolean>;
-    changeJobPriority(id: string, priority: number): Promise<boolean>;
-    moveToDelayed(id: string, delay: number): Promise<boolean>;
-    discardJob(id: string): Promise<boolean>;
-    getChildrenValues(parentJobId: string): Promise<Record<string, unknown>>;
-    getJobByCustomId(customId: string): Promise<SerializedJob | null>;
-    waitForJobCompletion(id: string, timeoutMs: number): Promise<boolean>;
-    pullJob(queue: string, timeoutMs?: number): Promise<SerializedJob | null>;
-    pullJobBatch(queue: string, count: number, timeoutMs?: number): Promise<SerializedJob[]>;
-    ackJob(id: string, result?: unknown): Promise<void>;
-    ackJobBatch(ids: string[]): Promise<void>;
-    failJob(id: string, error?: string): Promise<void>;
-    jobHeartbeat(id: string): Promise<boolean>;
-    jobHeartbeatBatch(ids: string[]): Promise<number>;
-    getProgress(id: string): Promise<{
-        progress: number;
-        message: string | null;
-    } | null>;
-    changeDelay(id: string, delay: number): Promise<boolean>;
-    extendLock(id: string, token: string, duration: number): Promise<boolean>;
-    getJobs(queue: string, opts?: {
-        state?: string;
-        start?: number;
-        end?: number;
-    }): Promise<SerializedJob[]>;
-    getJobCounts(queue: string): Promise<JobCounts>;
-    pauseQueue(queue: string): Promise<void>;
-    resumeQueue(queue: string): Promise<void>;
-    drainQueue(queue: string): Promise<number>;
-    obliterateQueue(queue: string): Promise<void>;
-    listQueues(): Promise<string[]>;
-    countJobs(queue: string): Promise<number>;
-    cleanQueue(queue: string, graceMs: number, state?: string, limit?: number): Promise<import("../domain/types").JobId[]>;
-    isPaused(queue: string): Promise<boolean>;
-    getCountsPerPriority(queue: string): Promise<Record<number, number>>;
-    getDlq(queue: string, limit?: number): Promise<SerializedJob[]>;
-    retryDlq(queue: string, id?: string): Promise<number>;
-    purgeDlq(queue: string): Promise<number>;
-    retryCompleted(queue: string, id?: string): Promise<number>;
-    setRateLimit(queue: string, limit: number): Promise<void>;
-    clearRateLimit(queue: string): Promise<void>;
-    setConcurrency(queue: string, limit: number): Promise<void>;
-    clearConcurrency(queue: string): Promise<void>;
-    addCron(input: CronJobInput): Promise<SerializedCron>;
-    listCrons(): Promise<SerializedCron[]>;
-    getCron(name: string): Promise<SerializedCron | null>;
-    deleteCron(name: string): Promise<boolean>;
-    addWebhook(url: string, events: string[], queue?: string): Promise<WebhookInfo>;
-    removeWebhook(id: string): Promise<boolean>;
-    listWebhooks(): Promise<WebhookInfo[]>;
-    setWebhookEnabled(id: string, enabled: boolean): Promise<boolean>;
-    registerWorker(name: string, queues: string[]): Promise<WorkerInfo>;
-    unregisterWorker(id: string): Promise<boolean>;
-    workerHeartbeat(id: string): Promise<boolean>;
-    getStats(): Promise<Record<string, unknown>>;
-    listWorkers(): Promise<WorkerInfo[]>;
-    getJobLogs(id: string): Promise<JobLogEntry[]>;
-    addJobLog(id: string, message: string, level?: 'info' | 'warn' | 'error'): Promise<boolean>;
-    getPerQueueStats(): Promise<Record<string, unknown>>;
-    getMemoryStats(): Promise<Record<string, unknown>>;
-    getPrometheusMetrics(): Promise<string>;
-    getStorageStatus(): Promise<{
-        diskFull: boolean;
-        error: string | null;
-    }>;
-    clearJobLogs(id: string, keepLogs?: number): Promise<void>;
-    compactMemory(): Promise<void>;
-    addFlow(flow: FlowJobInput): Promise<FlowNodeResult>;
-    addFlowChain(steps: FlowStepInput[]): Promise<{
-        jobIds: string[];
-    }>;
-    addFlowBulkThen(parallel: FlowStepInput[], final: FlowStepInput): Promise<{
-        parallelIds: string[];
-        finalId: string;
-    }>;
-    getFlow(id: string, queueName: string, depth?: number, maxChildren?: number): Promise<FlowNodeResult | null>;
-    shutdown(): void;
-}
-export declare class TcpBackend implements McpBackend {
-    private pool;
-    private flowProducer;
-    private readonly connOpts;
-    constructor(opts: {
-        host?: string;
-        port?: number;
-        token?: string;
-    });
-    connect(): Promise<void>;
-    private getFlowProducer;
-    private send;
-    private parseJob;
-    addJob(queue: string, name: string, data: unknown, opts?: {
-        priority?: number;
-        delay?: number;
-        attempts?: number;
-    }): Promise<{
-        jobId: string;
-    }>;
-    addJobsBulk(queue: string, jobs: Array<{
-        name: string;
-        data: unknown;
-        priority?: number;
-        delay?: number;
-    }>): Promise<{
-        jobIds: string[];
-    }>;
-    getJob(id: string): Promise<SerializedJob | null>;
-    getJobState(id: string): Promise<string>;
-    getJobResult(id: string): Promise<unknown>;
-    cancelJob(id: string): Promise<boolean>;
-    promoteJob(id: string): Promise<boolean>;
-    updateProgress(id: string, progress: number, message?: string): Promise<boolean>;
-    updateJobData(id: string, data: unknown): Promise<boolean>;
-    changeJobPriority(id: string, priority: number): Promise<boolean>;
-    moveToDelayed(id: string, delay: number): Promise<boolean>;
-    discardJob(id: string): Promise<boolean>;
-    getChildrenValues(parentJobId: string): Promise<Record<string, unknown>>;
-    getJobByCustomId(customId: string): Promise<SerializedJob | null>;
-    waitForJobCompletion(id: string, timeoutMs: number): Promise<boolean>;
-    getProgress(id: string): Promise<{
-        progress: number;
-        message: string | null;
-    } | null>;
-    changeDelay(id: string, delay: number): Promise<boolean>;
-    extendLock(id: string, token: string, duration: number): Promise<boolean>;
-    pullJob(queue: string, timeoutMs?: number): Promise<SerializedJob | null>;
-    pullJobBatch(queue: string, count: number, timeoutMs?: number): Promise<SerializedJob[]>;
-    ackJob(id: string, result?: unknown): Promise<void>;
-    ackJobBatch(ids: string[]): Promise<void>;
-    failJob(id: string, error?: string): Promise<void>;
-    jobHeartbeat(id: string): Promise<boolean>;
-    jobHeartbeatBatch(ids: string[]): Promise<number>;
-    getJobs(queue: string, opts?: {
-        state?: string;
-        start?: number;
-        end?: number;
-    }): Promise<SerializedJob[]>;
-    getJobCounts(queue: string): Promise<JobCounts>;
-    pauseQueue(queue: string): Promise<void>;
-    resumeQueue(queue: string): Promise<void>;
-    drainQueue(queue: string): Promise<number>;
-    obliterateQueue(queue: string): Promise<void>;
-    listQueues(): Promise<string[]>;
-    countJobs(queue: string): Promise<number>;
-    cleanQueue(queue: string, graceMs: number, state?: string, limit?: number): Promise<string[]>;
-    isPaused(queue: string): Promise<boolean>;
-    getCountsPerPriority(queue: string): Promise<Record<number, number>>;
-    getDlq(queue: string, limit?: number): Promise<SerializedJob[]>;
-    retryDlq(queue: string, id?: string): Promise<number>;
-    purgeDlq(queue: string): Promise<number>;
-    retryCompleted(queue: string, id?: string): Promise<number>;
-    setRateLimit(queue: string, limit: number): Promise<void>;
-    clearRateLimit(queue: string): Promise<void>;
-    setConcurrency(queue: string, limit: number): Promise<void>;
-    clearConcurrency(queue: string): Promise<void>;
-    addCron(input: CronJobInput): Promise<SerializedCron>;
-    listCrons(): Promise<SerializedCron[]>;
-    getCron(name: string): Promise<SerializedCron | null>;
-    deleteCron(name: string): Promise<boolean>;
-    addWebhook(url: string, events: string[], queue?: string): Promise<WebhookInfo>;
-    removeWebhook(id: string): Promise<boolean>;
-    listWebhooks(): Promise<WebhookInfo[]>;
-    getStats(): Promise<Record<string, unknown>>;
-    listWorkers(): Promise<WorkerInfo[]>;
-    getJobLogs(id: string): Promise<JobLogEntry[]>;
-    addJobLog(id: string, message: string, level?: 'info' | 'warn' | 'error'): Promise<boolean>;
-    setWebhookEnabled(id: string, enabled: boolean): Promise<boolean>;
-    registerWorker(name: string, queues: string[]): Promise<WorkerInfo>;
-    unregisterWorker(id: string): Promise<boolean>;
-    workerHeartbeat(id: string): Promise<boolean>;
-    getPerQueueStats(): Promise<Record<string, unknown>>;
-    getMemoryStats(): Promise<Record<string, unknown>>;
-    getPrometheusMetrics(): Promise<string>;
-    clearJobLogs(id: string, _keepLogs?: number): Promise<void>;
-    compactMemory(): Promise<void>;
-    getStorageStatus(): Promise<{
-        diskFull: boolean;
-        error: string | null;
-    }>;
-    addFlow(flow: FlowJobInput): Promise<FlowNodeResult>;
-    addFlowChain(steps: FlowStepInput[]): Promise<{
-        jobIds: string[];
-    }>;
-    addFlowBulkThen(parallel: FlowStepInput[], final: FlowStepInput): Promise<{
-        parallelIds: string[];
-        finalId: string;
-    }>;
-    getFlow(id: string, queueName: string, depth?: number, maxChildren?: number): Promise<FlowNodeResult | null>;
-    shutdown(): void;
-}
-/** Create backend based on environment configuration */
+/** MCP backend selection and public adapter API. */
+import type { McpBackend } from './types/adapter';
+export { EmbeddedBackend } from './backend/embedded';
+export { TcpBackend } from './backend/tcp';
+export type { FlowJobInput, FlowNodeResult, FlowStepInput, JobCounts, McpBackend, SerializedCron, SerializedJob, WebhookInfo, WorkerInfo, } from './types/adapter';
 export declare function createBackend(): Promise<McpBackend>;