@maydotinc/q-studio 0.1.1 → 0.8.0

package/dist/types-DhcUr9Xm.d.ts

@@ -1,377 +0,0 @@
-import { Queue, RedisOptions } from 'bullmq';
-
-/**
- * Job status types matching BullMQ states
- */
-type JobStatus = "waiting" | "active" | "completed" | "failed" | "delayed" | "paused" | "unknown";
-/**
- * Group/folder of related BullMQ queues.
- */
-interface QueueGroup {
-    name: string;
-    queues: Queue[];
-}
-/**
- * Configuration options for Workbench
- */
-interface WorkbenchOptions {
-    /** BullMQ Queue instances to display */
-    queues?: Queue[];
-    /** Named groups/folders of BullMQ Queue instances to display together */
-    queueGroups?: QueueGroup[];
-    /** Alias for queueGroups */
-    groups?: QueueGroup[];
-    /** 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[];
-}
-/**
- * Queue information for API responses
- */
-interface QueueInfo {
-    name: string;
-    group?: string;
-    counts: {
-        waiting: number;
-        active: number;
-        completed: number;
-        failed: number;
-        delayed: number;
-        paused: number;
-    };
-    isPaused: boolean;
-}
-/**
- * Queue group information for API responses
- */
-interface QueueGroupInfo {
-    name: string;
-    queues: string[];
-}
-/**
- * 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;
-    };
-}
-/**
- * BullMQ log lines for a job.
- */
-interface JobLogsResponse {
-    logs: string[];
-    count: number;
-    start: number;
-    end: number;
-}
-/**
- * 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;
-}
-
-export type { ActivityBucket as A, CreateFlowChildRequest as C, DelayedJobInfo as D, FailingJobType as F, HourlyBucket as H, JobInfo as J, MetricsResponse as M, OverviewStats as O, PaginatedResponse as P, QueueGroup as Q, RepeatableSortField as R, SchedulerInfo as S, TestJobRequest as T, WorkbenchOptions as W, ActivityStatsResponse as a, CreateFlowRequest as b, DelayedSortField as c, FlowNode as d, FlowSummary as e, JobLogsResponse as f, JobStatus as g, JobTags as h, QueueGroupInfo as i, QueueInfo as j, QueueMetrics as k, RunInfo as l, RunInfoList as m, RunSortField as n, SearchResult as o, SlowestJob as p, SortDirection as q, SortOptions as r, WorkerInfo as s };