pg-workflows 0.13.1 → 0.14.0

package/dist/client.entry.cjs

@@ -94,7 +94,7 @@ var isInvokeChildWorkflowTimelineEntry = (entry) => !!entry && typeof entry ===
 
 // src/db/migration.ts
 var MIGRATION_LOCK_ID = 738291645;
-var CURRENT_SCHEMA_VERSION = 5;
+var CURRENT_SCHEMA_VERSION = 6;
 async function runMigrations(db) {
   if (await isSchemaUpToDate(db)) {
     return;
@@ -102,6 +102,16 @@ async function runMigrations(db) {
   const currentVersion = await getCurrentVersion(db);
   const commands = [];
   if (currentVersion < 1) {
+    const existing = await db.executeSql(`SELECT
+         to_regclass('workflow_runs') IS NOT NULL AS has_runs_table,
+         to_regclass('workflow_schema_version') IS NOT NULL AS has_version_table`, []);
+    const row = existing.rows[0];
+    if (row?.has_runs_table && !row.has_version_table) {
+      throw new Error(`pg-workflows: a "workflow_runs" table already exists in this schema but was not ` + `created by pg-workflows. Point the workflow engine at a dedicated schema/database.`);
+    }
+    if (!row?.has_runs_table && row?.has_version_table) {
+      throw new Error(`pg-workflows: a "workflow_schema_version" table already exists in this schema but was not ` + `created by pg-workflows. Point the workflow engine at a dedicated schema/database.`);
+    }
     commands.push(`
       CREATE TABLE IF NOT EXISTS workflow_runs (
         id varchar(32) PRIMARY KEY NOT NULL,
@@ -160,6 +170,9 @@ async function runMigrations(db) {
   if (currentVersion < 5) {
     commands.push("ALTER TABLE workflow_runs ADD COLUMN IF NOT EXISTS scheduled_at timestamp with time zone");
   }
+  if (currentVersion < 6) {
+    commands.push("ALTER TABLE workflow_runs ADD COLUMN IF NOT EXISTS priority integer DEFAULT 0 NOT NULL");
+  }
   if (currentVersion === 0) {
     commands.push(`INSERT INTO workflow_schema_version (version) VALUES (${CURRENT_SCHEMA_VERSION})`);
   } else {
@@ -221,6 +234,7 @@ function mapRowToWorkflowRun(row) {
     timeoutAt: row.timeout_at ? new Date(row.timeout_at) : null,
     retryCount: row.retry_count,
     maxRetries: row.max_retries,
+    priority: row.priority,
     jobId: row.job_id,
     idempotencyKey: row.idempotency_key,
     parentRunId: row.parent_run_id,
@@ -236,6 +250,7 @@ async function insertWorkflowRun({
   status,
   input,
   maxRetries,
+  priority,
   timeoutAt,
   idempotencyKey,
   parentRunId,
@@ -253,6 +268,7 @@ async function insertWorkflowRun({
       status,
       input,
       max_retries,
+      priority,
       timeout_at,
       created_at,
       updated_at,
@@ -264,7 +280,7 @@ async function insertWorkflowRun({
       parent_resource_id,
       scheduled_at
     )
-    VALUES ($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12, $13, $14, $15, $16, $17)
+    VALUES ($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12, $13, $14, $15, $16, $17, $18)
     ON CONFLICT (idempotency_key) WHERE idempotency_key IS NOT NULL DO NOTHING
     RETURNING *`, [
     runId,
@@ -274,6 +290,7 @@ async function insertWorkflowRun({
     status,
     JSON.stringify(input),
     maxRetries,
+    priority,
     timeoutAt,
     now,
     now,
@@ -553,6 +570,30 @@ class WorkflowRunNotFoundError extends WorkflowEngineError {
   }
 }
 
+// src/priority.ts
+var PRIORITY_LEVELS = { high: 100, normal: 0, low: -100 };
+function priorityToInt(value) {
+  if (typeof value === "number") {
+    if (!Number.isInteger(value)) {
+      throw new WorkflowEngineError(`Invalid priority ${value}: numeric priority must be an integer.`);
+    }
+    return value;
+  }
+  const mapped = PRIORITY_LEVELS[value];
+  if (mapped === undefined) {
+    throw new WorkflowEngineError(`Invalid priority "${value}": expected one of ${Object.keys(PRIORITY_LEVELS).map((k) => `"${k}"`).join(", ")} or an integer.`);
+  }
+  return mapped;
+}
+function resolvePriority(...candidates) {
+  for (const candidate of candidates) {
+    if (candidate !== undefined) {
+      return priorityToInt(candidate);
+    }
+  }
+  return PRIORITY_LEVELS.normal;
+}
+
 // src/types.ts
 var WorkflowStatus;
 ((WorkflowStatus2) => {
@@ -563,6 +604,17 @@ var WorkflowStatus;
   WorkflowStatus2["FAILED"] = "failed";
   WorkflowStatus2["CANCELLED"] = "cancelled";
 })(WorkflowStatus ||= {});
+var _STEP_BASE_METHOD_TO_TYPE = {
+  run: "run" /* RUN */,
+  waitFor: "waitFor" /* WAIT_FOR */,
+  waitUntil: "waitUntil" /* WAIT_UNTIL */,
+  delay: "delay" /* DELAY */,
+  sleep: "delay" /* DELAY */,
+  pause: "pause" /* PAUSE */,
+  poll: "poll" /* POLL */,
+  invokeChildWorkflow: "invokeChildWorkflow" /* INVOKE_CHILD_WORKFLOW */
+};
+var STEP_BASE_METHOD_TYPES = new Map(Object.entries(_STEP_BASE_METHOD_TO_TYPE));
 
 // src/client.ts
 var LOG_PREFIX = "[WorkflowClient]";
@@ -657,6 +709,7 @@ class WorkflowClient {
         status: "running" /* RUNNING */,
         input,
         maxRetries: options?.retries ?? 0,
+        priority: resolvePriority(options?.priority),
         timeoutAt,
         idempotencyKey
       }, _db);
@@ -670,6 +723,7 @@ class WorkflowClient {
         await this.boss.send(WORKFLOW_RUN_QUEUE_NAME, job, {
           startAfter: new Date,
           expireInSeconds: options?.expireInSeconds ?? defaultExpireInSeconds,
+          priority: insertedRun.priority,
           db: _db
         });
       }
@@ -698,7 +752,8 @@ class WorkflowClient {
       }
     };
     await this.boss.send(WORKFLOW_RUN_QUEUE_NAME, job, {
-      expireInSeconds: options?.expireInSeconds ?? defaultExpireInSeconds
+      expireInSeconds: options?.expireInSeconds ?? defaultExpireInSeconds,
+      priority: run.priority
     });
     this.logger.log(`${LOG_PREFIX} Event ${eventName} sent for workflow run ${runId}`);
     return run;
@@ -877,6 +932,7 @@ function createWorkflowRef(id, options) {
     inputSchema: options?.inputSchema,
     timeout: defineOptions?.timeout,
     retries: defineOptions?.retries,
+    priority: defineOptions?.priority,
     schedule: defineOptions?.schedule,
     timezone: defineOptions?.timezone
   });
@@ -888,12 +944,13 @@ function createWorkflowRef(id, options) {
   return ref;
 }
 function createWorkflowFactory(plugins = []) {
-  const factory = (id, handler, { inputSchema, timeout, retries, schedule, timezone } = {}) => ({
+  const factory = (id, handler, { inputSchema, timeout, retries, priority, schedule, timezone } = {}) => ({
     id,
     handler,
     inputSchema,
     timeout,
     retries,
+    priority,
     schedule,
     timezone,
     plugins: plugins.length > 0 ? plugins : undefined
@@ -907,5 +964,5 @@ function createWorkflowFactory(plugins = []) {
 }
 var workflow = createWorkflowFactory();
 
-//# debugId=BBCF954233412F9C64756E2164756E21
+//# debugId=65B5E13A5C10F50064756E2164756E21
 //# sourceMappingURL=client.entry.js.map

package/dist/client.entry.d.cts

@@ -18,6 +18,8 @@ type WorkflowRun = {
 	timeoutAt: Date | null;
 	retryCount: number;
 	maxRetries: number;
+	/** Resolved scheduling priority (pg-boss integer; higher runs first). */
+	priority: number;
 	jobId: string | null;
 	idempotencyKey: string | null;
 	parentRunId: string | null;
@@ -35,6 +37,18 @@ type DurationObject = {
 	seconds?: number;
 };
 type Duration = string | DurationObject;
+/**
+* Named priority levels mapped to pg-boss integer priorities. Higher numbers
+* are fetched first (pg-boss orders by `priority DESC`), and `normal = 0`
+* matches pg-boss's own default. The ±100 spacing leaves room for numeric
+* tuning between tiers via the escape hatch.
+*/
+declare const PRIORITY_LEVELS: {
+	readonly high: 100;
+	readonly normal: 0;
+	readonly low: -100;
+};
+type WorkflowPriority = keyof typeof PRIORITY_LEVELS | number;
 type Schedule = string | Exclude<Duration, string>;
 declare enum WorkflowStatus {
 	PENDING = "pending",
@@ -52,11 +66,13 @@ type StartWorkflowOptions = {
 	retries?: number;
 	expireInSeconds?: number;
 	idempotencyKey?: string;
+	priority?: WorkflowPriority;
 };
 type WorkflowOptions<I extends InputParameters> = {
 	timeout?: number;
 	retries?: number;
 	inputSchema?: I;
+	priority?: WorkflowPriority;
 	/**
 	* Recurring schedule. Accepts a cron expression (`'0 9 * * 1-5'`),
 	* a duration string (`'5m'`, `'1 hour'`), or a `DurationObject`.
@@ -164,6 +180,7 @@ type WorkflowDefinition<TInput extends InputParameters = InputParameters> = {
 	inputSchema?: TInput;
 	timeout?: number;
 	retries?: number;
+	priority?: WorkflowPriority;
 	schedule?: Schedule;
 	timezone?: string;
 	plugins?: WorkflowPlugin[];

package/dist/client.entry.d.ts

@@ -18,6 +18,8 @@ type WorkflowRun = {
 	timeoutAt: Date | null;
 	retryCount: number;
 	maxRetries: number;
+	/** Resolved scheduling priority (pg-boss integer; higher runs first). */
+	priority: number;
 	jobId: string | null;
 	idempotencyKey: string | null;
 	parentRunId: string | null;
@@ -35,6 +37,18 @@ type DurationObject = {
 	seconds?: number;
 };
 type Duration = string | DurationObject;
+/**
+* Named priority levels mapped to pg-boss integer priorities. Higher numbers
+* are fetched first (pg-boss orders by `priority DESC`), and `normal = 0`
+* matches pg-boss's own default. The ±100 spacing leaves room for numeric
+* tuning between tiers via the escape hatch.
+*/
+declare const PRIORITY_LEVELS: {
+	readonly high: 100;
+	readonly normal: 0;
+	readonly low: -100;
+};
+type WorkflowPriority = keyof typeof PRIORITY_LEVELS | number;
 type Schedule = string | Exclude<Duration, string>;
 declare enum WorkflowStatus {
 	PENDING = "pending",
@@ -52,11 +66,13 @@ type StartWorkflowOptions = {
 	retries?: number;
 	expireInSeconds?: number;
 	idempotencyKey?: string;
+	priority?: WorkflowPriority;
 };
 type WorkflowOptions<I extends InputParameters> = {
 	timeout?: number;
 	retries?: number;
 	inputSchema?: I;
+	priority?: WorkflowPriority;
 	/**
 	* Recurring schedule. Accepts a cron expression (`'0 9 * * 1-5'`),
 	* a duration string (`'5m'`, `'1 hour'`), or a `DurationObject`.
@@ -164,6 +180,7 @@ type WorkflowDefinition<TInput extends InputParameters = InputParameters> = {
 	inputSchema?: TInput;
 	timeout?: number;
 	retries?: number;
+	priority?: WorkflowPriority;
 	schedule?: Schedule;
 	timezone?: string;
 	plugins?: WorkflowPlugin[];

package/dist/client.entry.js

@@ -4,7 +4,7 @@ import {
   WorkflowRunNotFoundError,
   WorkflowStatus,
   createWorkflowRef
-} from "./shared/chunk-5xswmve7.js";
+} from "./shared/chunk-w3qcrrwx.js";
 export {
   createWorkflowRef,
   WorkflowStatus,