pg-workflows 0.10.0 → 0.11.0

package/dist/index.d.ts

@@ -33,7 +33,6 @@ type DurationObject = {
 	seconds?: number;
 };
 type Duration = string | DurationObject;
-declare function parseDuration(duration: Duration): number;
 declare enum WorkflowStatus {
 	PENDING = "pending",
 	RUNNING = "running",
@@ -53,7 +52,7 @@ declare enum StepType {
 }
 type InputParameters = StandardSchemaV1;
 type InferInputParameters<P extends InputParameters> = StandardSchemaV1.InferOutput<P>;
-type WorkflowRunOptions = {
+type StartWorkflowOptions = {
 	resourceId?: string;
 	timeout?: number;
 	retries?: number;
@@ -107,13 +106,13 @@ type StepBaseContext = {
 		<
 			TInput extends InputParameters,
 			TOutput = unknown
-		>(stepId: string, ref: WorkflowRef<TInput, TOutput>, input: InferInputParameters<TInput>, options?: WorkflowRunOptions): Promise<TOutput>;
+		>(stepId: string, ref: WorkflowRef<TInput, TOutput>, input: InferInputParameters<TInput>, options?: StartWorkflowOptions): Promise<TOutput>;
 		<TOutput = unknown>(stepId: string, params: {
 			workflowId: string;
 			input: unknown;
 			resourceId?: string;
 			idempotencyKey?: string;
-			options?: WorkflowRunOptions;
+			options?: StartWorkflowOptions;
 		}): Promise<TOutput>;
 	};
 };
@@ -197,14 +196,6 @@ interface WorkflowLogger {
 	log(message: string): void;
 	error(message: string, ...args: unknown[]): void;
 }
-type WorkflowInternalLoggerContext = {
-	runId?: string;
-	workflowId?: string;
-};
-interface WorkflowInternalLogger {
-	log(message: string, context?: WorkflowInternalLoggerContext): void;
-	error(message: string, error: Error, context?: WorkflowInternalLoggerContext): void;
-}
 type WorkflowClientOptions = {
 	logger?: WorkflowLogger;
 	/**
@@ -221,7 +212,6 @@ type WorkflowClientOptions = {
 	connectionString: string;
 	pool?: never;
 });
-type StartWorkflowOptions = WorkflowRunOptions;
 declare class WorkflowClient {
 	private boss;
 	private db;
@@ -306,9 +296,6 @@ declare function createWorkflowRef<
 declare const workflow: WorkflowFactory;
 import pg2 from "pg";
 import { Db, PgBoss as PgBoss2 } from "pg-boss";
-type StartWorkflowOptions2 = WorkflowRunOptions & {
-	batchSize?: number;
-};
 type WorkflowEngineOptions = {
 	workflows?: WorkflowDefinition[];
 	logger?: WorkflowLogger;
@@ -339,13 +326,13 @@ declare class WorkflowEngine {
 	unregisterWorkflow(workflowId: string): Promise<WorkflowEngine>;
 	unregisterAllWorkflows(): Promise<WorkflowEngine>;
 	private resolveWorkflowRunParameters;
-	startWorkflow<TInput extends InputParameters>(ref: WorkflowRef<TInput>, input: InferInputParameters<TInput>, options?: StartWorkflowOptions2): Promise<WorkflowRun>;
+	startWorkflow<TInput extends InputParameters>(ref: WorkflowRef<TInput>, input: InferInputParameters<TInput>, options?: StartWorkflowOptions): Promise<WorkflowRun>;
 	startWorkflow(params: {
 		resourceId?: string;
 		workflowId: string;
 		input: unknown;
 		idempotencyKey?: string;
-		options?: StartWorkflowOptions2;
+		options?: StartWorkflowOptions;
 	}): Promise<WorkflowRun>;
 	private createWorkflowRun;
 	private enqueueWorkflowRun;
@@ -455,8 +442,6 @@ declare class WorkflowEngine {
 	}>;
 }
 import { StandardSchemaV1 as StandardSchemaV12 } from "@standard-schema/spec";
-declare function validateWorkflowId(workflowId: string): void;
-declare function validateResourceId(resourceId: string | undefined | null): void;
 declare class WorkflowEngineError extends Error {
 	readonly workflowId?: string | undefined;
 	readonly runId?: string | undefined;
@@ -467,4 +452,4 @@ declare class WorkflowEngineError extends Error {
 declare class WorkflowRunNotFoundError extends WorkflowEngineError {
 	constructor(runId?: string, workflowId?: string);
 }
-export { workflow, validateWorkflowId, validateResourceId, parseDuration, createWorkflowRef, WorkflowStatus, WorkflowRunProgress, WorkflowRunOptions, WorkflowRunNotFoundError, WorkflowRef, WorkflowPlugin, WorkflowOptions, WorkflowLogger, WorkflowInternalLoggerContext, WorkflowInternalLogger, WorkflowInternalDefinition, WorkflowFactory, WorkflowEngineOptions, WorkflowEngineError, WorkflowEngine, WorkflowDefinition, WorkflowContext, WorkflowClientOptions, WorkflowClient, StepType, StepInternalDefinition, StepBaseContext, StartWorkflowOptions, InputParameters, InferInputParameters, DurationObject, Duration };
+export { workflow, createWorkflowRef, WorkflowStatus, WorkflowRunProgress, WorkflowRunNotFoundError, WorkflowRun, WorkflowRef, WorkflowPlugin, WorkflowOptions, WorkflowLogger, WorkflowEngineOptions, WorkflowEngineError, WorkflowEngine, WorkflowDefinition, WorkflowContext, WorkflowClientOptions, WorkflowClient, StepBaseContext, StartWorkflowOptions, InputParameters, InferInputParameters, Duration };

package/dist/index.js

@@ -1,7 +1,6 @@
 import {
   DEFAULT_PGBOSS_SCHEMA,
   PAUSE_EVENT_NAME,
-  StepType,
   WORKFLOW_RUN_DLQ_QUEUE_NAME,
   WORKFLOW_RUN_QUEUE_NAME,
   WorkflowClient,
@@ -21,32 +20,7 @@ import {
   waitForTimelineKey,
   withPostgresTransaction,
   workflow
-} from "./shared/chunk-nygamc7b.js";
-// src/duration.ts
-import parse from "parse-duration";
-var MS_PER_SECOND = 1000;
-var MS_PER_MINUTE = 60 * MS_PER_SECOND;
-var MS_PER_HOUR = 60 * MS_PER_MINUTE;
-var MS_PER_DAY = 24 * MS_PER_HOUR;
-var MS_PER_WEEK = 7 * MS_PER_DAY;
-function parseDuration(duration) {
-  if (typeof duration === "string") {
-    if (duration.trim() === "") {
-      throw new WorkflowEngineError("Invalid duration: empty string");
-    }
-    const ms2 = parse(duration);
-    if (ms2 == null || ms2 <= 0) {
-      throw new WorkflowEngineError(`Invalid duration: "${duration}"`);
-    }
-    return ms2;
-  }
-  const { weeks = 0, days = 0, hours = 0, minutes = 0, seconds = 0 } = duration;
-  const ms = weeks * MS_PER_WEEK + days * MS_PER_DAY + hours * MS_PER_HOUR + minutes * MS_PER_MINUTE + seconds * MS_PER_SECOND;
-  if (ms <= 0) {
-    throw new WorkflowEngineError("Invalid duration: must be a positive value");
-  }
-  return ms;
-}
+} from "./shared/chunk-ahxqsytt.js";
 // src/engine.ts
 import { merge } from "es-toolkit";
 import pg from "pg";
@@ -122,6 +96,32 @@ function parseWorkflowHandler(handler) {
   return { steps: Array.from(steps.values()) };
 }
 
+// src/duration.ts
+import parse from "parse-duration";
+var MS_PER_SECOND = 1000;
+var MS_PER_MINUTE = 60 * MS_PER_SECOND;
+var MS_PER_HOUR = 60 * MS_PER_MINUTE;
+var MS_PER_DAY = 24 * MS_PER_HOUR;
+var MS_PER_WEEK = 7 * MS_PER_DAY;
+function parseDuration(duration) {
+  if (typeof duration === "string") {
+    if (duration.trim() === "") {
+      throw new WorkflowEngineError("Invalid duration: empty string");
+    }
+    const ms2 = parse(duration);
+    if (ms2 == null || ms2 <= 0) {
+      throw new WorkflowEngineError(`Invalid duration: "${duration}"`);
+    }
+    return ms2;
+  }
+  const { weeks = 0, days = 0, hours = 0, minutes = 0, seconds = 0 } = duration;
+  const ms = weeks * MS_PER_WEEK + days * MS_PER_DAY + hours * MS_PER_HOUR + minutes * MS_PER_MINUTE + seconds * MS_PER_SECOND;
+  if (ms <= 0) {
+    throw new WorkflowEngineError("Invalid duration: must be a positive value");
+  }
+  return ms;
+}
+
 // src/engine.ts
 var LOG_PREFIX = "[WorkflowEngine]";
 var StepTypeToIcon = {
@@ -271,7 +271,7 @@ class WorkflowEngine {
   async startWorkflow(refOrParams, inputArg, optionsArg) {
     const { workflowId, input, resourceId, idempotencyKey, options } = this.resolveWorkflowRunParameters(refOrParams, inputArg, optionsArg);
     if (!this._started) {
-      await this.start(false, { batchSize: options?.batchSize ?? 1 });
+      await this.start(false);
     }
     const { run } = await this.createWorkflowRun({
       workflowId,
@@ -740,7 +740,9 @@ class WorkflowEngine {
         input: run.input,
         workflowId: run.workflowId,
         runId: run.id,
-        timeline: run.timeline,
+        get timeline() {
+          return run?.timeline ?? {};
+        },
         logger: this.logger,
         step
       };
@@ -1037,7 +1039,7 @@ class WorkflowEngine {
         if (output === undefined) {
           output = {};
         }
-        run = await this.updateRun({
+        const updated = await this.updateRun({
           runId: run.id,
           resourceId: run.resourceId ?? undefined,
           data: {
@@ -1049,6 +1051,7 @@ class WorkflowEngine {
             })
           }
         }, { db });
+        Object.assign(run, updated);
         return output;
       } catch (error) {
         this.logger.error(`Step ${stepId} failed:`, error, {
@@ -1278,17 +1281,13 @@ ${error.stack}` : String(error)
 }
 export {
   workflow,
-  validateWorkflowId,
-  validateResourceId,
-  parseDuration,
   createWorkflowRef,
   WorkflowStatus,
   WorkflowRunNotFoundError,
   WorkflowEngineError,
   WorkflowEngine,
-  WorkflowClient,
-  StepType
+  WorkflowClient
 };
 
-//# debugId=F3273B34BE68C60E64756E2164756E21
+//# debugId=F9D6596295A7020B64756E2164756E21
 //# sourceMappingURL=index.js.map