pg-boss 12.3.0 → 12.3.1

package/dist/index.d.mts

@@ -1,7 +1,228 @@
-import { CommandResponse, ConnectionOptions, ConstructorOptions, Events, FetchOptions, IDatabase, InsertOptions, Job, JobFetchOptions, JobInsert, JobPollingOptions, JobStates, JobWithMetadata, MaintenanceOptions, OffWorkOptions, PgBossEventMap, Queue, QueuePolicy, QueueResult, Request, Schedule, ScheduleOptions, SchedulingOptions, SendOptions, StopOptions, UpdateQueueOptions, WipData, WorkHandler, WorkOptions, WorkWithMetadataHandler } from "./src/types.mjs";
-import { JOB_STATES, QUEUE_POLICIES } from "./src/plans.mjs";
 import EventEmitter from "node:events";
 
+//#region src/types.d.ts
+type JobStates = {
+  created: 'created';
+  retry: 'retry';
+  active: 'active';
+  completed: 'completed';
+  cancelled: 'cancelled';
+  failed: 'failed';
+};
+type Events = {
+  error: 'error';
+  warning: 'warning';
+  wip: 'wip';
+  stopped: 'stopped';
+};
+interface IDatabase {
+  executeSql(text: string, values?: unknown[]): Promise<{
+    rows: any[];
+  }>;
+}
+interface DatabaseOptions {
+  application_name?: string;
+  database?: string;
+  user?: string;
+  password?: string | (() => string) | (() => Promise<string>);
+  host?: string;
+  port?: number;
+  schema?: string;
+  ssl?: any;
+  connectionString?: string;
+  max?: number;
+  db?: IDatabase;
+  connectionTimeoutMillis?: number;
+}
+interface SchedulingOptions {
+  schedule?: boolean;
+  clockMonitorIntervalSeconds?: number;
+  cronWorkerIntervalSeconds?: number;
+  cronMonitorIntervalSeconds?: number;
+}
+interface MaintenanceOptions {
+  supervise?: boolean;
+  migrate?: boolean;
+  createSchema?: boolean;
+  warningSlowQuerySeconds?: number;
+  warningQueueSize?: number;
+  superviseIntervalSeconds?: number;
+  maintenanceIntervalSeconds?: number;
+  queueCacheIntervalSeconds?: number;
+  monitorIntervalSeconds?: number;
+}
+interface ConstructorOptions extends DatabaseOptions, SchedulingOptions, MaintenanceOptions {}
+interface QueueOptions {
+  expireInSeconds?: number;
+  retentionSeconds?: number;
+  deleteAfterSeconds?: number;
+  retryLimit?: number;
+  retryDelay?: number;
+  retryBackoff?: boolean;
+  retryDelayMax?: number;
+}
+interface JobOptions {
+  id?: string;
+  priority?: number;
+  startAfter?: number | string | Date;
+  singletonKey?: string;
+  singletonSeconds?: number;
+  singletonNextSlot?: boolean;
+  keepUntil?: number | string | Date;
+}
+interface ConnectionOptions {
+  db?: IDatabase;
+}
+type InsertOptions = ConnectionOptions;
+type SendOptions = JobOptions & QueueOptions & ConnectionOptions;
+type QueuePolicy = 'standard' | 'short' | 'singleton' | 'stately' | 'exclusive';
+interface Queue extends QueueOptions {
+  name: string;
+  policy?: QueuePolicy;
+  partition?: boolean;
+  deadLetter?: string;
+  warningQueueSize?: number;
+}
+interface QueueResult extends Queue {
+  deferredCount: number;
+  queuedCount: number;
+  activeCount: number;
+  totalCount: number;
+  table: string;
+  createdOn: Date;
+  updatedOn: Date;
+  singletonsActive: string[] | null;
+}
+type ScheduleOptions = SendOptions & {
+  tz?: string;
+  key?: string;
+};
+interface JobPollingOptions {
+  pollingIntervalSeconds?: number;
+}
+interface JobFetchOptions {
+  includeMetadata?: boolean;
+  priority?: boolean;
+  batchSize?: number;
+  ignoreStartAfter?: boolean;
+}
+type WorkOptions = JobFetchOptions & JobPollingOptions;
+type FetchOptions = JobFetchOptions & ConnectionOptions;
+interface WorkHandler<ReqData> {
+  (job: Job<ReqData>[]): Promise<any>;
+}
+interface WorkWithMetadataHandler<ReqData> {
+  (job: JobWithMetadata<ReqData>[]): Promise<any>;
+}
+interface Request {
+  name: string;
+  data?: object;
+  options?: SendOptions;
+}
+interface Schedule {
+  name: string;
+  key: string;
+  cron: string;
+  timezone: string;
+  data?: object;
+  options?: SendOptions;
+}
+interface Job<T = object> {
+  id: string;
+  name: string;
+  data: T;
+  expireInSeconds: number;
+}
+interface JobWithMetadata<T = object> extends Job<T> {
+  priority: number;
+  state: 'created' | 'retry' | 'active' | 'completed' | 'cancelled' | 'failed';
+  retryLimit: number;
+  retryCount: number;
+  retryDelay: number;
+  retryBackoff: boolean;
+  retryDelayMax?: number;
+  startAfter: Date;
+  startedOn: Date;
+  singletonKey: string | null;
+  singletonOn: Date | null;
+  expireInSeconds: number;
+  deleteAfterSeconds: number;
+  createdOn: Date;
+  completedOn: Date | null;
+  keepUntil: Date;
+  policy: QueuePolicy;
+  deadLetter: string;
+  output: object;
+}
+interface JobInsert<T = object> {
+  id?: string;
+  data?: T;
+  priority?: number;
+  retryLimit?: number;
+  retryDelay?: number;
+  retryBackoff?: boolean;
+  retryDelayMax?: number;
+  startAfter?: number | string | Date;
+  singletonKey?: string;
+  singletonSeconds?: number;
+  expireInSeconds?: number;
+  deleteAfterSeconds?: number;
+  retentionSeconds?: number;
+}
+type WorkerState = 'created' | 'active' | 'stopping' | 'stopped';
+interface WipData {
+  id: string;
+  name: string;
+  options: WorkOptions;
+  state: WorkerState;
+  count: number;
+  createdOn: number;
+  lastFetchedOn: number | null;
+  lastJobStartedOn: number | null;
+  lastJobEndedOn: number | null;
+  lastJobDuration: number | null;
+  lastError: object | null;
+  lastErrorOn: number | null;
+}
+interface StopOptions {
+  close?: boolean;
+  graceful?: boolean;
+  timeout?: number;
+}
+interface OffWorkOptions {
+  id?: string;
+  wait?: boolean;
+}
+type UpdateQueueOptions = Omit<Queue, 'name' | 'partition' | 'policy'>;
+interface Warning {
+  message: string;
+  data: object;
+}
+interface CommandResponse {}
+type PgBossEventMap = {
+  error: [error: Error];
+  warning: [warning: Warning];
+  wip: [data: WipData[]];
+  stopped: [];
+};
+//#endregion
+//#region src/plans.d.ts
+declare const JOB_STATES: Readonly<{
+  created: "created";
+  retry: "retry";
+  active: "active";
+  completed: "completed";
+  cancelled: "cancelled";
+  failed: "failed";
+}>;
+declare const QUEUE_POLICIES: Readonly<{
+  standard: "standard";
+  short: "short";
+  singleton: "singleton";
+  stately: "stately";
+  exclusive: "exclusive";
+}>;
+//#endregion
 //#region src/index.d.ts
 declare const events: Events;
 declare function getConstructionPlans(schema?: string): string;