@getworkbench/core 0.2.1 → 0.3.1

package/dist/workbench-Btnvit1t.d.ts

@@ -0,0 +1,696 @@
+import { Queue, RedisOptions } from 'bullmq';
+
+/**
+ * Job status types matching BullMQ states
+ */
+type JobStatus = "active" | "waiting" | "waiting-children" | "prioritized" | "completed" | "failed" | "delayed" | "paused" | "unknown";
+/**
+ * Configuration options for Workbench
+ */
+interface WorkbenchOptions {
+    /** BullMQ Queue instances to display */
+    queues?: Queue[];
+    /** Redis connection for auto-discovery of queues */
+    redis?: string | RedisOptions;
+    /** Basic auth credentials */
+    auth?: {
+        username: string;
+        password: string;
+    };
+    /** Dashboard title */
+    title?: string;
+    /** Logo URL */
+    logo?: string;
+    /** Override base path detection */
+    basePath?: string;
+    /** Disable actions (retry, remove, promote) */
+    readonly?: boolean;
+    /** Fields from job.data to extract as filterable tags (e.g., ['teamId', 'userId']) */
+    tags?: string[];
+    /**
+     * BullMQ key prefix used during queue auto-discovery from `redis`. Ignored
+     * when `queues` is set explicitly. Defaults to `"bull"`.
+     */
+    prefix?: string;
+    /**
+     * Maximum number of queues to keep when auto-discovering from `redis`.
+     * Prevents connection storms on very large Redis deployments. Defaults to
+     * 100. Ignored when `queues` is set explicitly.
+     */
+    maxQueues?: number;
+}
+/**
+ * Queue information for API responses
+ */
+interface QueueInfo {
+    name: string;
+    counts: {
+        waiting: number;
+        active: number;
+        completed: number;
+        failed: number;
+        delayed: number;
+        prioritized: number;
+        "waiting-children": number;
+        paused: number;
+    };
+    isPaused: boolean;
+}
+/**
+ * Worker information from BullMQ
+ */
+interface WorkerInfo {
+    id: string;
+    name: string;
+    addr: string;
+    age: number;
+    idle: number;
+    started: number;
+    queueName: string;
+}
+/**
+ * Extracted tag key-value pairs from job data
+ */
+type JobTags = Record<string, string | number | boolean | null>;
+/**
+ * Job information for API responses
+ */
+interface JobInfo {
+    id: string;
+    name: string;
+    data: unknown;
+    opts: {
+        attempts?: number;
+        delay?: number;
+        priority?: number;
+    };
+    progress: number | object;
+    attemptsMade: number;
+    processedOn?: number;
+    finishedOn?: number;
+    timestamp: number;
+    failedReason?: string;
+    stacktrace?: string[];
+    returnvalue?: unknown;
+    status: JobStatus;
+    duration?: number;
+    /** Extracted tag values from job.data based on configured tag fields */
+    tags?: JobTags;
+    /** Parent job info if this job is part of a flow */
+    parent?: {
+        id: string;
+        queueName: string;
+    };
+}
+/**
+ * Overview stats for dashboard
+ */
+interface OverviewStats {
+    totalJobs: number;
+    activeJobs: number;
+    failedJobs: number;
+    completedToday: number;
+    avgDuration: number;
+    queues: QueueInfo[];
+}
+/**
+ * Paginated response wrapper
+ */
+interface PaginatedResponse<T> {
+    data: T[];
+    total: number;
+    cursor?: string;
+    hasMore: boolean;
+}
+/**
+ * Search result item
+ */
+interface SearchResult {
+    queue: string;
+    job: JobInfo;
+}
+/**
+ * Run item - job execution with queue context
+ */
+interface RunInfo extends JobInfo {
+    queueName: string;
+}
+/**
+ * Lightweight run info for list view - only fields needed for table display
+ * Excludes large fields like full job.data, opts, progress, etc.
+ */
+interface RunInfoList {
+    id: string;
+    name: string;
+    status: JobStatus;
+    queueName: string;
+    tags?: JobTags;
+    processedOn?: number;
+    timestamp: number;
+    duration?: number;
+}
+/**
+ * Scheduler info for repeatable jobs
+ */
+interface SchedulerInfo {
+    key: string;
+    name: string;
+    queueName: string;
+    pattern?: string;
+    every?: number;
+    next?: number;
+    endDate?: number;
+    tz?: string;
+}
+/**
+ * Delayed job info
+ */
+interface DelayedJobInfo {
+    id: string;
+    name: string;
+    queueName: string;
+    delay: number;
+    processAt: number;
+    data: unknown;
+}
+/**
+ * Test job request
+ */
+interface TestJobRequest {
+    queueName: string;
+    jobName: string;
+    data: unknown;
+    opts?: {
+        delay?: number;
+        priority?: number;
+        attempts?: number;
+    };
+}
+/**
+ * Sort direction
+ */
+type SortDirection = "asc" | "desc";
+/**
+ * Sort options for API requests
+ */
+interface SortOptions {
+    field: string;
+    direction: SortDirection;
+}
+/**
+ * Valid sort fields for runs/jobs
+ */
+type RunSortField = "timestamp" | "name" | "status" | "duration" | "queueName";
+/**
+ * Valid sort fields for repeatable schedulers
+ */
+type RepeatableSortField = "name" | "queueName" | "pattern" | "next" | "tz";
+/**
+ * Valid sort fields for delayed schedulers
+ */
+type DelayedSortField = "name" | "queueName" | "processAt" | "delay";
+/**
+ * Hourly bucket for metrics aggregation
+ */
+interface HourlyBucket {
+    /** Unix timestamp (start of hour) */
+    hour: number;
+    /** Number of completed jobs */
+    completed: number;
+    /** Number of failed jobs */
+    failed: number;
+    /** Average processing duration in ms */
+    avgDuration: number;
+    /** Average queue wait time in ms */
+    avgWaitTime: number;
+}
+/**
+ * Metrics for a single queue
+ */
+interface QueueMetrics {
+    queueName: string;
+    buckets: HourlyBucket[];
+    summary: {
+        totalCompleted: number;
+        totalFailed: number;
+        /** Error rate as 0-1 */
+        errorRate: number;
+        /** Average processing duration in ms */
+        avgDuration: number;
+        /** Average queue wait time in ms */
+        avgWaitTime: number;
+        /** Average throughput per hour */
+        throughputPerHour: number;
+    };
+}
+/**
+ * Slowest job entry
+ */
+interface SlowestJob {
+    name: string;
+    queueName: string;
+    duration: number;
+    jobId: string;
+}
+/**
+ * Most failing job type entry
+ */
+interface FailingJobType {
+    name: string;
+    queueName: string;
+    failCount: number;
+    totalCount: number;
+    errorRate: number;
+}
+/**
+ * Complete metrics response
+ */
+interface MetricsResponse {
+    /** Metrics per queue */
+    queues: QueueMetrics[];
+    /** Aggregated metrics across all queues */
+    aggregate: Omit<QueueMetrics, "queueName"> & {
+        queueName: "all";
+    };
+    /** Top 10 slowest jobs */
+    slowestJobs: SlowestJob[];
+    /** Top 10 most failing job types */
+    mostFailingTypes: FailingJobType[];
+    /** Timestamp when metrics were computed */
+    computedAt: number;
+}
+/**
+ * A node in a flow tree representing a job and its children
+ */
+interface FlowNode {
+    job: JobInfo;
+    queueName: string;
+    children?: FlowNode[];
+}
+/**
+ * Flow summary for list view
+ */
+interface FlowSummary {
+    /** Root job ID */
+    id: string;
+    /** Root job name */
+    name: string;
+    /** Queue containing root job */
+    queueName: string;
+    /** Root job status */
+    status: JobStatus;
+    /** Total number of jobs in flow */
+    totalJobs: number;
+    /** Number of completed jobs */
+    completedJobs: number;
+    /** Number of failed jobs */
+    failedJobs: number;
+    /** When flow was created */
+    timestamp: number;
+    /** Duration if completed */
+    duration?: number;
+}
+/**
+ * Request to create a test flow
+ */
+interface CreateFlowRequest {
+    name: string;
+    queueName: string;
+    data?: unknown;
+    children: CreateFlowChildRequest[];
+}
+/**
+ * Child job in a flow creation request
+ */
+interface CreateFlowChildRequest {
+    name: string;
+    queueName: string;
+    data?: unknown;
+    children?: CreateFlowChildRequest[];
+}
+/**
+ * Activity bucket for timeline
+ */
+interface ActivityBucket {
+    /** Unix timestamp (start of bucket) */
+    time: number;
+    /** Number of completed jobs */
+    completed: number;
+    /** Number of failed jobs */
+    failed: number;
+}
+/**
+ * Activity stats response for the 7-day timeline
+ */
+interface ActivityStatsResponse {
+    /** Activity buckets (4-hour intervals over 7 days) */
+    buckets: ActivityBucket[];
+    /** Start time of the first bucket */
+    startTime: number;
+    /** End time (now) */
+    endTime: number;
+    /** Size of each bucket in ms */
+    bucketSize: number;
+    /** Total completed in period */
+    totalCompleted: number;
+    /** Total failed in period */
+    totalFailed: number;
+    /** Timestamp when stats were computed */
+    computedAt: number;
+}
+
+/**
+ * Manages queue operations for the Workbench dashboard
+ */
+declare class QueueManager {
+    private queues;
+    private tagFields;
+    private flowProducer;
+    private cache;
+    private readonly CACHE_TTL;
+    constructor(queues: Queue[], tagFields?: string[]);
+    /**
+     * Get cached value or compute and cache
+     */
+    private cached;
+    /**
+     * Execute a promise with a timeout
+     */
+    private withTimeout;
+    /**
+     * Get jobs by time range using Redis sorted sets (ZRANGEBYSCORE)
+     * This is more efficient than fetching all jobs and filtering in memory
+     */
+    private getJobsByTimeRange;
+    /**
+     * Cache for job state lookups to avoid repeated Redis calls
+     */
+    private jobStateCache;
+    /**
+     * Cache for job counts to avoid repeated Redis calls
+     * Short TTL since counts change frequently but are expensive to fetch
+     */
+    private countCache;
+    /**
+     * Get job counts with caching
+     */
+    private getCachedJobCounts;
+    /**
+     * Invalidate caches related to a job or queue
+     */
+    private invalidateJobCache;
+    /**
+     * Clear cache (useful after mutations)
+     */
+    clearCache(prefix?: string): void;
+    /**
+     * Get quick job counts across all queues (lightweight, for smart polling)
+     * Returns total counts per status - cached and very fast
+     */
+    getQuickCounts(): Promise<{
+        waiting: number;
+        active: number;
+        completed: number;
+        failed: number;
+        delayed: number;
+        prioritized: number;
+        "waiting-children": number;
+        total: number;
+        timestamp: number;
+    }>;
+    /**
+     * Get configured tag field names
+     */
+    getTagFields(): string[];
+    /**
+     * Get just queue names (very fast, no Redis calls)
+     * Used for sidebar initial render
+     */
+    getQueueNames(): string[];
+    /**
+     * Get a queue by name
+     */
+    getQueue(name: string): Queue | undefined;
+    /**
+     * Get information for all queues (cached)
+     */
+    getQueues(): Promise<QueueInfo[]>;
+    /**
+     * Get overview statistics (cached)
+     */
+    getOverview(): Promise<OverviewStats>;
+    /**
+     * Pause a queue - stops processing new jobs
+     */
+    pauseQueue(queueName: string): Promise<void>;
+    /**
+     * Resume a paused queue
+     */
+    resumeQueue(queueName: string): Promise<void>;
+    /**
+     * Check if a queue is paused
+     */
+    isQueuePaused(queueName: string): Promise<boolean>;
+    /**
+     * Get metrics for the last 24 hours (cached - expensive operation)
+     */
+    getMetrics(): Promise<MetricsResponse>;
+    /**
+     * Get activity stats for the last 7 days (cached)
+     * Returns 4-hour buckets for the activity timeline
+     */
+    getActivityStats(): Promise<ActivityStatsResponse>;
+    /**
+     * Get jobs for a specific queue with pagination and sorting
+     */
+    getJobs(queueName: string, status?: JobStatus, limit?: number, start?: number, sort?: SortOptions): Promise<PaginatedResponse<JobInfo>>;
+    /**
+     * Get a single job by ID
+     */
+    getJob(queueName: string, jobId: string): Promise<JobInfo | null>;
+    /**
+     * Retry a failed job
+     */
+    retryJob(queueName: string, jobId: string): Promise<boolean>;
+    /**
+     * Remove a job
+     */
+    removeJob(queueName: string, jobId: string): Promise<boolean>;
+    /**
+     * Promote a delayed job to waiting
+     */
+    promoteJob(queueName: string, jobId: string): Promise<boolean>;
+    /**
+     * Parse search query for field:value filters
+     * Returns { filters: { field: value }, text: remainingText }
+     */
+    private parseSearchQuery;
+    /**
+     * Check if a raw job matches all provided filters (before conversion)
+     * This is more efficient than converting to JobInfo first
+     */
+    private jobMatchesAllFilters;
+    /**
+     * Check if a job matches the given tag filters
+     */
+    private jobMatchesFilters;
+    /**
+     * Search jobs across all queues
+     * Supports field:value syntax (e.g., "teamId:abc-123 invoice")
+     * Optimized with parallel processing, early exits, and count checks
+     */
+    search(query: string, limit?: number): Promise<SearchResult[]>;
+    /**
+     * Clean jobs from a queue
+     */
+    cleanJobs(queueName: string, status: "completed" | "failed", grace?: number): Promise<number>;
+    /**
+     * FAST PATH: Get latest runs without filters
+     * Optimized for the common case of viewing newest jobs (timestamp desc, no filters)
+     * - Single getJobs call per queue (not per status type)
+     * - No count checks needed
+     * - Minimal Redis round-trips
+     */
+    private getLatestRuns;
+    /**
+     * Get all runs (jobs) across all queues with sorting and filtering
+     * Uses fast path for common case (no filters, timestamp desc)
+     */
+    getAllRuns(limit?: number, start?: number, sort?: SortOptions, filters?: {
+        status?: JobStatus;
+        tags?: Record<string, string>;
+        text?: string;
+        timeRange?: {
+            start: number;
+            end: number;
+        };
+    }): Promise<PaginatedResponse<RunInfoList>>;
+    /**
+     * Get all schedulers (repeatable and delayed jobs) with sorting
+     */
+    getSchedulers(repeatableSort?: SortOptions, delayedSort?: SortOptions): Promise<{
+        repeatable: SchedulerInfo[];
+        delayed: DelayedJobInfo[];
+    }>;
+    /**
+     * Enqueue a new job (for testing)
+     */
+    enqueueJob(request: TestJobRequest): Promise<{
+        id: string;
+    }>;
+    /**
+     * Extract tag values from job data based on configured tag fields
+     */
+    private extractTags;
+    /**
+     * Get unique values for a specific tag field across all jobs
+     */
+    getTagValues(field: string, limit?: number): Promise<{
+        value: string;
+        count: number;
+    }[]>;
+    /**
+     * Get sortable value from JobInfo/RunInfo
+     */
+    private getSortValue;
+    /**
+     * Get sortable value from RunInfoList (lightweight version)
+     */
+    private getSortValueForList;
+    /**
+     * Get sortable value from SchedulerInfo
+     */
+    private getSchedulerSortValue;
+    /**
+     * Get sortable value from DelayedJobInfo
+     */
+    private getDelayedSortValue;
+    /**
+     * Convert a BullMQ Job to JobInfo or RunInfoList
+     * @param job - The BullMQ job to convert
+     * @param fields - "list" for lightweight list view, "full" for complete job details
+     * @param knownState - Optional: skip getState() call if state is already known from fetch
+     */
+    private jobToInfo;
+    /**
+     * Retry multiple jobs across queues
+     * Processed in parallel for better performance
+     */
+    bulkRetry(jobs: {
+        queueName: string;
+        jobId: string;
+    }[]): Promise<{
+        success: number;
+        failed: number;
+    }>;
+    /**
+     * Delete multiple jobs across queues
+     * Processed in parallel for better performance
+     */
+    bulkDelete(jobs: {
+        queueName: string;
+        jobId: string;
+    }[]): Promise<{
+        success: number;
+        failed: number;
+    }>;
+    /**
+     * Promote multiple delayed jobs across queues (move to waiting)
+     * Processed in parallel for better performance
+     */
+    bulkPromote(jobs: {
+        queueName: string;
+        jobId: string;
+    }[]): Promise<{
+        success: number;
+        failed: number;
+    }>;
+    /**
+     * Get all flows (jobs that have children or are part of a flow) - cached
+     * Optimized to focus on waiting-children type first and early exit
+     */
+    getFlows(limit?: number): Promise<FlowSummary[]>;
+    /**
+     * Get a single flow tree by root job ID
+     */
+    getFlow(queueName: string, jobId: string): Promise<FlowNode | null>;
+    /**
+     * Create a new flow
+     */
+    createFlow(request: CreateFlowRequest): Promise<{
+        id: string;
+    }>;
+    /**
+     * Build a FlowJob from CreateFlowRequest or CreateFlowChildRequest
+     */
+    private buildFlowJob;
+    /**
+     * Convert BullMQ flow tree to our FlowNode structure
+     */
+    private convertFlowTree;
+    /**
+     * Count statistics for a flow tree
+     */
+    private countFlowStats;
+}
+
+/**
+ * Internal metadata produced by {@link WorkbenchCore.fromOptions} when queues
+ * are auto-discovered from a Redis connection.
+ */
+interface DiscoveryMeta {
+    /** Total number of queues found on the connection (before capping). */
+    total: number;
+    /** True if the result was capped at `maxQueues`. */
+    capped: boolean;
+    /** The cap that was applied. */
+    cap: number;
+}
+/**
+ * Core Workbench class that manages the dashboard
+ */
+declare class WorkbenchCore {
+    readonly options: Required<Pick<WorkbenchOptions, "title" | "readonly">> & WorkbenchOptions;
+    readonly queueManager: QueueManager;
+    readonly discovery: DiscoveryMeta | null;
+    constructor(options: WorkbenchOptions | Queue[], discovery?: DiscoveryMeta | null);
+    /**
+     * Async factory: build a `WorkbenchCore` from `WorkbenchOptions`, performing
+     * BullMQ queue auto-discovery via `SCAN <prefix>:*:meta` when `queues` is
+     * not provided.
+     *
+     * - When `queues` is set explicitly, behaves like `new WorkbenchCore(opts)`.
+     * - When only `redis` is set, scans the connection for queues, caps at
+     *   `maxQueues` (default 100) to avoid connection storms with very large
+     *   deployments, and constructs the core with the resulting list.
+     * - When no queues are discovered, the core is constructed with an empty
+     *   queue map so the dashboard can render an "empty" state instead of
+     *   erroring out.
+     */
+    static fromOptions(opts: WorkbenchOptions): Promise<WorkbenchCore>;
+    /**
+     * Get the queue manager instance
+     */
+    getQueueManager(): QueueManager;
+    /**
+     * Check if authentication is required
+     */
+    requiresAuth(): boolean;
+    /**
+     * Validate authentication credentials
+     */
+    validateAuth(username: string, password: string): boolean;
+    /**
+     * Get dashboard configuration for the UI
+     */
+    getConfig(): {
+        title: string;
+        logo: string | undefined;
+        readonly: boolean;
+        queues: string[];
+        tags: string[];
+        discovery: DiscoveryMeta | null;
+    };
+}
+
+export { type ActivityBucket as A, type CreateFlowChildRequest as C, type DelayedJobInfo as D, type FailingJobType as F, type HourlyBucket as H, type JobInfo as J, type MetricsResponse as M, type OverviewStats as O, type PaginatedResponse as P, type QueueInfo as Q, type RepeatableSortField as R, type SchedulerInfo as S, type TestJobRequest as T, WorkbenchCore as W, type ActivityStatsResponse as a, type CreateFlowRequest as b, type DelayedSortField as c, type DiscoveryMeta as d, type FlowNode as e, type FlowSummary as f, type JobStatus as g, type JobTags as h, QueueManager as i, type QueueMetrics as j, type RunInfo as k, type RunInfoList as l, type RunSortField as m, type SearchResult as n, type SlowestJob as o, type SortDirection as p, type SortOptions as q, type WorkbenchOptions as r, type WorkerInfo as s };