bunqueue 2.8.53 → 2.8.56

package/dist/domain/types/jobs/model.d.ts

@@ -0,0 +1,152 @@
+export type JobId = string & {
+    readonly __brand: 'JobId';
+};
+export type LockToken = string & {
+    readonly __brand: 'LockToken';
+};
+export declare const enum JobState {
+    Waiting = "waiting",
+    Prioritized = "prioritized",
+    Delayed = "delayed",
+    Active = "active",
+    Completed = "completed",
+    Failed = "failed"
+}
+export interface RepeatConfig {
+    readonly every?: number;
+    readonly limit?: number;
+    readonly pattern?: string;
+    count: number;
+    readonly startDate?: number;
+    readonly endDate?: number;
+    readonly tz?: string;
+    readonly immediately?: boolean;
+    prevMillis?: number;
+    readonly offset?: number;
+    readonly jobId?: string;
+}
+export interface BackoffConfig {
+    readonly type: 'fixed' | 'exponential';
+    readonly delay: number;
+    readonly maxDelay?: number;
+}
+export interface JobTimelineEntry {
+    readonly state: string;
+    readonly timestamp: number;
+    readonly worker?: string;
+    readonly error?: string;
+    readonly attempt?: number;
+}
+export interface Job {
+    readonly id: JobId;
+    readonly queue: string;
+    readonly name: string;
+    readonly data: unknown;
+    readonly priority: number;
+    readonly createdAt: number;
+    readonly lifo: boolean;
+    runAt: number;
+    startedAt: number | null;
+    completedAt: number | null;
+    attempts: number;
+    readonly maxAttempts: number;
+    readonly backoff: number;
+    readonly backoffConfig: BackoffConfig | null;
+    readonly ttl: number | null;
+    readonly timeout: number | null;
+    readonly uniqueKey: string | null;
+    readonly customId: string | null;
+    readonly dependsOn: JobId[];
+    readonly parentId: JobId | null;
+    childrenIds: JobId[];
+    childrenCompleted: number;
+    readonly tags: string[];
+    readonly groupId: string | null;
+    progress: number;
+    progressMessage: string | null;
+    stacktrace: string[] | null;
+    readonly removeOnComplete: boolean;
+    readonly removeOnFail: boolean;
+    readonly repeat: RepeatConfig | null;
+    lastHeartbeat: number;
+    readonly stallTimeout: number | null;
+    stallCount: number;
+    readonly stackTraceLimit: number;
+    readonly keepLogs: number | null;
+    readonly sizeLimit: number | null;
+    readonly failParentOnFailure: boolean;
+    readonly removeDependencyOnFailure: boolean;
+    readonly continueParentOnFailure: boolean;
+    readonly ignoreDependencyOnFailure: boolean;
+    readonly deduplicationTtl: number | null;
+    readonly deduplicationExtend: boolean;
+    readonly deduplicationReplace: boolean;
+    readonly debounceId: string | null;
+    readonly debounceTtl: number | null;
+    /** Whether each generation bypasses the persistence write buffer. */
+    readonly durable?: boolean;
+    timeline: JobTimelineEntry[];
+}
+export interface JobInput {
+    name?: string;
+    data: unknown;
+    priority?: number;
+    delay?: number;
+    maxAttempts?: number;
+    backoff?: number | {
+        type: 'fixed' | 'exponential';
+        delay: number;
+    };
+    ttl?: number;
+    timeout?: number;
+    uniqueKey?: string;
+    customId?: string;
+    dependsOn?: JobId[];
+    childrenIds?: JobId[];
+    parentId?: JobId;
+    tags?: string[];
+    groupId?: string;
+    lifo?: boolean;
+    removeOnComplete?: boolean;
+    removeOnFail?: boolean;
+    stallTimeout?: number;
+    repeat?: {
+        every?: number;
+        limit?: number;
+        pattern?: string;
+        count?: number;
+        startDate?: number;
+        endDate?: number;
+        tz?: string;
+        immediately?: boolean;
+        prevMillis?: number;
+        offset?: number;
+        jobId?: string;
+    };
+    dedup?: {
+        ttl?: number;
+        extend?: boolean;
+        replace?: boolean;
+    };
+    durable?: boolean;
+    stackTraceLimit?: number;
+    keepLogs?: number;
+    sizeLimit?: number;
+    failParentOnFailure?: boolean;
+    removeDependencyOnFailure?: boolean;
+    continueParentOnFailure?: boolean;
+    ignoreDependencyOnFailure?: boolean;
+    debounceId?: string;
+    debounceTtl?: number;
+    timestamp?: number;
+}
+export interface JobLock {
+    readonly jobId: JobId;
+    readonly token: LockToken;
+    readonly owner: string;
+    readonly createdAt: number;
+    expiresAt: number;
+    lastRenewalAt: number;
+    renewalCount: number;
+    readonly ttl: number;
+}

package/dist/domain/types/jobs/model.js

@@ -0,0 +1 @@
+export {};

package/dist/domain/types/metrics.d.ts

@@ -0,0 +1,16 @@
+export type QueueMetricType = 'completed' | 'failed';
+export interface QueueMetricsMeta {
+    /** Cumulative number of terminal jobs since the queue metrics were created. */
+    readonly count: number;
+    /** Timestamp of the most recently recorded terminal job. */
+    readonly prevTS: number;
+    /** Count in the most recently updated one-minute bucket. */
+    readonly prevCount: number;
+}
+export interface QueueMetrics {
+    readonly meta: QueueMetricsMeta;
+    /** One-minute job-count buckets, newest first. */
+    readonly data: number[];
+    /** Total number of available buckets before start/end pagination. */
+    readonly count: number;
+}

package/dist/domain/types/metrics.js

@@ -0,0 +1 @@
+export {};

package/dist/domain/types/priorityQueue.d.ts

@@ -0,0 +1,12 @@
+import type { Job, JobId } from './job';
+export interface HeapEntry {
+    jobId: JobId;
+    priority: number;
+    runAt: number;
+    lifo: boolean;
+    generation: bigint;
+}
+export interface IndexedJob {
+    job: Job;
+    generation: bigint;
+}

package/dist/domain/types/priorityQueue.js

@@ -0,0 +1 @@
+export {};

package/dist/domain/types/protocol.d.ts

@@ -0,0 +1,5 @@
+/** Current TCP wire protocol revision advertised by the server and Bun client. */
+export declare const PROTOCOL_VERSION: 3;
+/** Capabilities implemented by protocol revision 3. */
+export declare const PROTOCOL_CAPABILITIES: readonly ["pipelining", "separate-job-name"];
+export type ProtocolCapability = (typeof PROTOCOL_CAPABILITIES)[number];

package/dist/domain/types/protocol.js

@@ -0,0 +1,4 @@
+/** Current TCP wire protocol revision advertised by the server and Bun client. */
+export const PROTOCOL_VERSION = 3;
+/** Capabilities implemented by protocol revision 3. */
+export const PROTOCOL_CAPABILITIES = ['pipelining', 'separate-job-name'];

package/dist/domain/types/queue.d.ts

@@ -29,6 +29,11 @@ export declare class RateLimiter {
     private refill;
     /** Get current token count */
     getTokens(): number;
+    /**
+     * Milliseconds until the bucket can admit another job. When `maxJobs` is
+     * provided, report 0 until at least that many tokens have been consumed.
+     */
+    getTtl(maxJobs?: number): number;
 }
 /** Concurrency limiter */
 export declare class ConcurrencyLimiter {
@@ -91,6 +96,8 @@ export interface JobEvent {
     readonly prev?: string;
     /** Delay in ms (for delayed event) */
     readonly delay?: number;
+    /** Internal marker used to exclude retry-attempt failures from terminal metrics. */
+    readonly terminal?: boolean;
 }
 /** Webhook configuration */
 export interface Webhook {

package/dist/domain/types/queue.js

@@ -48,6 +48,19 @@ export class RateLimiter {
         this.refill();
         return this.tokens;
     }
+    /**
+     * Milliseconds until the bucket can admit another job. When `maxJobs` is
+     * provided, report 0 until at least that many tokens have been consumed.
+     */
+    getTtl(maxJobs) {
+        const tokens = this.getTokens();
+        const consumed = this.capacity - tokens;
+        if (maxJobs !== undefined && consumed < maxJobs)
+            return 0;
+        if (tokens >= 1 || this.refillRate <= 0)
+            return 0;
+        return Math.ceil(((1 - tokens) / this.refillRate) * 1000);
+    }
 }
 /** Concurrency limiter */
 export class ConcurrencyLimiter {

package/dist/domain/types/response.d.ts

@@ -1,192 +1,3 @@
-/**
- * Protocol responses
- * All response types for TCP/HTTP protocol
- */
-import type { Job, JobState } from './job';
-/** Base response interface */
-interface BaseResponse {
-    readonly ok: boolean;
-    readonly reqId?: string;
-}
-/** Success response with job ID */
-export interface OkResponse extends BaseResponse {
-    readonly ok: true;
-    readonly id?: string;
-}
-/** Batch success response */
-export interface BatchResponse extends BaseResponse {
-    readonly ok: true;
-    readonly ids: string[];
-}
-/** Single job response */
-export interface JobResponse extends BaseResponse {
-    readonly ok: true;
-    readonly job: Job;
-}
-/** Nullable job response (for pull with timeout) */
-export interface NullableJobResponse extends BaseResponse {
-    readonly ok: true;
-    readonly job: Job | null;
-}
-/** Pulled job response (includes lock token for ownership) */
-export interface PulledJobResponse extends BaseResponse {
-    readonly ok: true;
-    readonly job: Job | null;
-    readonly token: string | null;
-}
-/** Pulled jobs batch response (includes lock tokens) */
-export interface PulledJobsResponse extends BaseResponse {
-    readonly ok: true;
-    readonly jobs: Job[];
-    readonly tokens: string[];
-}
-/** Multiple jobs response */
-export interface JobsResponse extends BaseResponse {
-    readonly ok: true;
-    readonly jobs: Job[];
-}
-/** Job state response */
-export interface StateResponse extends BaseResponse {
-    readonly ok: true;
-    readonly id: string;
-    readonly state: JobState;
-}
-/** Job result response */
-export interface ResultResponse extends BaseResponse {
-    readonly ok: true;
-    readonly id: string;
-    readonly result: unknown;
-}
-/** Job counts by state */
-export interface JobCounts {
-    readonly waiting: number;
-    readonly prioritized: number;
-    readonly delayed: number;
-    readonly active: number;
-    readonly completed: number;
-    readonly failed: number;
-    readonly 'waiting-children': number;
-    readonly paused: number;
-}
-/** Job counts response */
-export interface JobCountsResponse extends BaseResponse {
-    readonly ok: true;
-    readonly counts: JobCounts;
-}
-/** Queue info */
-export interface QueueInfo {
-    readonly name: string;
-    readonly waiting: number;
-    readonly delayed: number;
-    readonly active: number;
-    readonly paused: boolean;
-}
-/** Queue list response */
-export interface QueuesResponse extends BaseResponse {
-    readonly ok: true;
-    readonly queues: QueueInfo[];
-}
-/** Progress response */
-export interface ProgressResponse extends BaseResponse {
-    readonly ok: true;
-    readonly progress: number;
-    readonly message: string | null;
-}
-/** Boolean response */
-export interface BoolResponse extends BaseResponse {
-    readonly ok: true;
-    readonly value: boolean;
-}
-/** Count response */
-export interface CountResponse extends BaseResponse {
-    readonly ok: true;
-    readonly count: number;
-    /** Populated by Clean handler with the JobIds that were removed */
-    readonly ids?: string[];
-}
-/** Stats response */
-export interface StatsData {
-    readonly waiting: number;
-    readonly active: number;
-    readonly delayed: number;
-    readonly dlq: number;
-    readonly completed: number;
-    readonly failed: number;
-    readonly uptime: number;
-    readonly pushPerSec: number;
-    readonly pullPerSec: number;
-}
-export interface StatsResponse extends BaseResponse {
-    readonly ok: true;
-    readonly stats: StatsData;
-}
-/** Metrics response */
-export interface MetricsData {
-    readonly totalPushed: number;
-    readonly totalPulled: number;
-    readonly totalCompleted: number;
-    readonly totalFailed: number;
-    readonly avgLatencyMs: number;
-    readonly avgProcessingMs: number;
-    readonly memoryUsageMb: number;
-    readonly sqliteSizeMb: number;
-    readonly activeConnections: number;
-}
-export interface MetricsResponse extends BaseResponse {
-    readonly ok: true;
-    readonly metrics: MetricsData;
-}
-/** Cron job info */
-export interface CronInfo {
-    readonly name: string;
-    readonly queue: string;
-    readonly schedule: string | null;
-    readonly repeatEvery: number | null;
-    readonly nextRun: number;
-    readonly executions: number;
-}
-/** Cron list response */
-export interface CronListResponse extends BaseResponse {
-    readonly ok: true;
-    readonly crons: CronInfo[];
-}
-/** Error response */
-export interface ErrorResponse extends BaseResponse {
-    readonly ok: false;
-    readonly error: string;
-}
-/** Protocol capability */
-export type ProtocolCapability = 'pipelining';
-/** Hello response for protocol negotiation */
-export interface HelloResponse extends BaseResponse {
-    readonly ok: true;
-    /** Server protocol version */
-    readonly protocolVersion: number;
-    /** Supported capabilities */
-    readonly capabilities: ProtocolCapability[];
-    /** Server name */
-    readonly server: string;
-    /** Server version */
-    readonly version: string;
-}
-/** Union of all responses */
-export type Response = OkResponse | BatchResponse | JobResponse | NullableJobResponse | PulledJobResponse | PulledJobsResponse | JobsResponse | StateResponse | ResultResponse | JobCountsResponse | QueuesResponse | ProgressResponse | BoolResponse | CountResponse | StatsResponse | MetricsResponse | CronListResponse | HelloResponse | ErrorResponse | DataResponse<unknown>;
-export declare function ok(id?: string, reqId?: string): OkResponse;
-export declare function batch(ids: string[], reqId?: string): BatchResponse;
-export declare function job(j: Job, reqId?: string): JobResponse;
-export declare function nullableJob(j: Job | null, reqId?: string): NullableJobResponse;
-export declare function pulledJob(j: Job | null, token: string | null, reqId?: string): PulledJobResponse;
-export declare function pulledJobs(list: Job[], tokens: string[], reqId?: string): PulledJobsResponse;
-export declare function jobs(list: Job[], reqId?: string): JobsResponse;
-export declare function error(message: string, reqId?: string): ErrorResponse;
-export declare function hello(protocolVersion: number, capabilities: ProtocolCapability[], server: string, version: string, reqId?: string): HelloResponse;
-/** Generic success response with data payload */
-export interface DataResponse<T> extends BaseResponse {
-    readonly ok: true;
-    readonly data: T;
-}
-export declare function data<T>(payload: T, reqId?: string): DataResponse<T>;
-export declare function counts(c: JobCounts, reqId?: string): JobCountsResponse;
-export declare function stats(s: StatsData, reqId?: string): StatsResponse;
-export declare function metrics(m: MetricsData, reqId?: string): MetricsResponse;
-export {};
+/** Stable import surface for protocol response types and builders. */
+export * from './responses/model';
+export * from '../response/builders';

package/dist/domain/types/response.js

@@ -1,101 +1,3 @@
-/**
- * Protocol responses
- * All response types for TCP/HTTP protocol
- */
-// ============ Response Builders ============
-export function ok(id, reqId) {
-    return {
-        ok: true,
-        id,
-        reqId,
-    };
-}
-export function batch(ids, reqId) {
-    return {
-        ok: true,
-        ids,
-        reqId,
-    };
-}
-export function job(j, reqId) {
-    return {
-        ok: true,
-        job: j,
-        reqId,
-    };
-}
-export function nullableJob(j, reqId) {
-    return {
-        ok: true,
-        job: j,
-        reqId,
-    };
-}
-export function pulledJob(j, token, reqId) {
-    return {
-        ok: true,
-        job: j,
-        token,
-        reqId,
-    };
-}
-export function pulledJobs(list, tokens, reqId) {
-    return {
-        ok: true,
-        jobs: list,
-        tokens,
-        reqId,
-    };
-}
-export function jobs(list, reqId) {
-    return {
-        ok: true,
-        jobs: list,
-        reqId,
-    };
-}
-export function error(message, reqId) {
-    return {
-        ok: false,
-        error: message,
-        reqId,
-    };
-}
-export function hello(protocolVersion, capabilities, server, version, reqId) {
-    return {
-        ok: true,
-        protocolVersion,
-        capabilities,
-        server,
-        version,
-        reqId,
-    };
-}
-export function data(payload, reqId) {
-    return {
-        ok: true,
-        data: payload,
-        reqId,
-    };
-}
-export function counts(c, reqId) {
-    return {
-        ok: true,
-        counts: c,
-        reqId,
-    };
-}
-export function stats(s, reqId) {
-    return {
-        ok: true,
-        stats: s,
-        reqId,
-    };
-}
-export function metrics(m, reqId) {
-    return {
-        ok: true,
-        metrics: m,
-        reqId,
-    };
-}
+/** Stable import surface for protocol response types and builders. */
+export * from './responses/model';
+export * from '../response/builders';

package/dist/domain/types/responses/model.d.ts

@@ -0,0 +1,152 @@
+import type { Job, JobState } from '../job';
+import type { ProtocolCapability } from '../protocol';
+export type { ProtocolCapability } from '../protocol';
+interface BaseResponse {
+    readonly ok: boolean;
+    readonly reqId?: string;
+}
+export interface OkResponse extends BaseResponse {
+    readonly ok: true;
+    readonly id?: string;
+}
+export interface BatchResponse extends BaseResponse {
+    readonly ok: true;
+    readonly ids: string[];
+}
+export interface JobResponse extends BaseResponse {
+    readonly ok: true;
+    readonly job: Job;
+}
+export interface NullableJobResponse extends BaseResponse {
+    readonly ok: true;
+    readonly job: Job | null;
+}
+export interface PulledJobResponse extends BaseResponse {
+    readonly ok: true;
+    readonly job: Job | null;
+    readonly token: string | null;
+}
+export interface PulledJobsResponse extends BaseResponse {
+    readonly ok: true;
+    readonly jobs: Job[];
+    readonly tokens: string[];
+}
+export interface JobsResponse extends BaseResponse {
+    readonly ok: true;
+    readonly jobs: Job[];
+}
+export interface StateResponse extends BaseResponse {
+    readonly ok: true;
+    readonly id: string;
+    readonly state: JobState;
+}
+export interface ResultResponse extends BaseResponse {
+    readonly ok: true;
+    readonly id: string;
+    readonly result: unknown;
+}
+export interface JobCounts {
+    readonly waiting: number;
+    readonly prioritized: number;
+    readonly delayed: number;
+    readonly active: number;
+    readonly completed: number;
+    readonly failed: number;
+    readonly 'waiting-children': number;
+    readonly paused: number;
+}
+export interface JobCountsResponse extends BaseResponse {
+    readonly ok: true;
+    readonly counts: JobCounts;
+}
+export interface QueueInfo {
+    readonly name: string;
+    readonly waiting: number;
+    readonly delayed: number;
+    readonly active: number;
+    readonly paused: boolean;
+}
+export interface QueuesResponse extends BaseResponse {
+    readonly ok: true;
+    readonly queues: QueueInfo[];
+}
+export interface ProgressResponse extends BaseResponse {
+    readonly ok: true;
+    readonly progress: number;
+    readonly message: string | null;
+}
+export interface BoolResponse extends BaseResponse {
+    readonly ok: true;
+    readonly value: boolean;
+}
+export interface CountResponse extends BaseResponse {
+    readonly ok: true;
+    readonly count: number;
+    readonly ids?: string[];
+}
+export interface StatsData {
+    readonly waiting: number;
+    readonly active: number;
+    readonly delayed: number;
+    readonly dlq: number;
+    readonly completed: number;
+    readonly failed: number;
+    readonly uptime: number;
+    readonly pushPerSec: number;
+    readonly pullPerSec: number;
+}
+export interface StatsResponse extends BaseResponse {
+    readonly ok: true;
+    readonly stats: StatsData;
+}
+export interface MetricsData {
+    readonly totalPushed: number;
+    readonly totalPulled: number;
+    readonly totalCompleted: number;
+    readonly totalFailed: number;
+    readonly avgLatencyMs: number;
+    readonly avgProcessingMs: number;
+    readonly memoryUsageMb: number;
+    readonly sqliteSizeMb: number;
+    readonly activeConnections: number;
+}
+export interface MetricsResponse extends BaseResponse {
+    readonly ok: true;
+    readonly metrics: MetricsData;
+}
+export interface CronInfo {
+    readonly name: string;
+    readonly jobName?: string;
+    readonly queue: string;
+    readonly schedule: string | null;
+    readonly repeatEvery: number | null;
+    readonly nextRun: number;
+    readonly executions: number;
+    readonly maxLimit?: number | null;
+    readonly timezone?: string | null;
+    readonly priority?: number;
+}
+export interface CronResponse extends BaseResponse {
+    readonly ok: true;
+    readonly cron: CronInfo;
+}
+export interface CronListResponse extends BaseResponse {
+    readonly ok: true;
+    readonly crons: CronInfo[];
+}
+export interface ErrorResponse extends BaseResponse {
+    readonly ok: false;
+    readonly error: string;
+}
+export interface HelloResponse extends BaseResponse {
+    readonly ok: true;
+    readonly protocolVersion: number;
+    readonly capabilities: ProtocolCapability[];
+    readonly server: string;
+    readonly version: string;
+}
+export interface DataResponse<T> extends BaseResponse {
+    readonly ok: true;
+    readonly data: T;
+}
+export type Response = OkResponse | BatchResponse | JobResponse | NullableJobResponse | PulledJobResponse | PulledJobsResponse | JobsResponse | StateResponse | ResultResponse | JobCountsResponse | QueuesResponse | ProgressResponse | BoolResponse | CountResponse | StatsResponse | MetricsResponse | CronResponse | CronListResponse | HelloResponse | ErrorResponse | DataResponse<unknown>;

package/dist/domain/types/responses/model.js

@@ -0,0 +1 @@
+export {};