openworkflow 0.4.1 → 0.6.0

package/dist/core/step.js

@@ -1,28 +1,8 @@
 import { parseDuration } from "./duration.js";
 import { err, ok } from "./result.js";
-/**
- * Serialize an error to a JSON-compatible format. Pure function that converts
- * any error into a SerializedError object.
- *
- * @param error - The error to serialize (can be Error instance or any value)
- * @returns A JSON-serializable error object
- */
-export function serializeError(error) {
-    if (error instanceof Error) {
-        return {
-            name: error.name,
-            message: error.message,
-            stack: error.stack ?? null,
-        };
-    }
-    return {
-        message: String(error),
-    };
-}
 /**
  * Create a step attempt cache from an array of attempts. Only includes
  * successful attempts (completed or succeeded status).
- *
  * @param attempts - Array of step attempts to cache
  * @returns An immutable map of step name to successful attempt
  */
@@ -33,7 +13,6 @@ export function createStepAttemptCacheFromAttempts(attempts) {
 }
 /**
  * Get a cached step attempt by name.
- *
  * @param cache - The step attempt cache
  * @param stepName - The name of the step to look up
  * @returns The cached attempt or undefined if not found
@@ -41,20 +20,9 @@ export function createStepAttemptCacheFromAttempts(attempts) {
 export function getCachedStepAttempt(cache, stepName) {
     return cache.get(stepName);
 }
-/**
- * Check if a step attempt is cached (has completed successfully).
- *
- * @param cache - The step attempt cache
- * @param stepName - The name of the step to check
- * @returns True if the step has a cached successful result
- */
-export function hasCompletedStep(cache, stepName) {
-    return cache.has(stepName);
-}
 /**
  * Add a step attempt to the cache (returns new cache, original unchanged). This
  * is an immutable operation.
- *
  * @param cache - The existing step attempt cache
  * @param attempt - The attempt to add
  * @returns A new cache with the attempt added
@@ -65,7 +33,6 @@ export function addToStepAttemptCache(cache, attempt) {
 /**
  * Convert a step function result to a JSON-compatible value. Undefined values
  * are converted to null for JSON serialization.
- *
  * @param result - The result from a step function
  * @returns A JSON-serializable value
  */
@@ -74,7 +41,6 @@ export function normalizeStepOutput(result) {
 }
 /**
  * Calculate the resume time for a sleep step.
- *
  * @param duration - The duration string to sleep for
  * @param now - The current timestamp (defaults to Date.now())
  * @returns A Result containing the resume Date or an Error
@@ -88,7 +54,6 @@ export function calculateSleepResumeAt(duration, now = Date.now()) {
 }
 /**
  * Create the context object for a sleep step attempt.
- *
  * @param resumeAt - The time when the sleep should resume
  * @returns The context object for the sleep step
  */
@@ -98,4 +63,3 @@ export function createSleepContext(resumeAt) {
         resumeAt: resumeAt.toISOString(),
     };
 }
-//# sourceMappingURL=step.js.map

package/dist/core/step.test.js

@@ -1,64 +1,6 @@
 import { ok } from "./result.js";
-import { serializeError, createStepAttemptCacheFromAttempts, getCachedStepAttempt, hasCompletedStep, addToStepAttemptCache, normalizeStepOutput, calculateSleepResumeAt, createSleepContext, } from "./step.js";
+import { createStepAttemptCacheFromAttempts, getCachedStepAttempt, addToStepAttemptCache, normalizeStepOutput, calculateSleepResumeAt, createSleepContext, } from "./step.js";
 import { describe, expect, test } from "vitest";
-describe("serializeError", () => {
-    test("serializes Error instance with name, message, and stack", () => {
-        const error = new Error("Something went wrong");
-        const result = serializeError(error);
-        expect(result.name).toBe("Error");
-        expect(result.message).toBe("Something went wrong");
-        expect(result.stack).toBeDefined();
-        expect(typeof result.stack).toBe("string");
-    });
-    test("serializes TypeError with correct name", () => {
-        const error = new TypeError("Invalid type");
-        const result = serializeError(error);
-        expect(result.name).toBe("TypeError");
-        expect(result.message).toBe("Invalid type");
-    });
-    test("serializes custom Error subclass", () => {
-        class CustomError extends Error {
-            constructor(message) {
-                super(message);
-                this.name = "CustomError";
-            }
-        }
-        const error = new CustomError("Custom error message");
-        const result = serializeError(error);
-        expect(result.name).toBe("CustomError");
-        expect(result.message).toBe("Custom error message");
-    });
-    test("serializes Error without stack as null", () => {
-        const error = new Error("No stack");
-        // @ts-expect-error testing edge case
-        error.stack = undefined;
-        const result = serializeError(error);
-        expect(result.stack).toBeNull();
-    });
-    test("serializes string to message", () => {
-        const result = serializeError("string error");
-        expect(result.message).toBe("string error");
-        expect(result.name).toBeUndefined();
-        expect(result.stack).toBeUndefined();
-    });
-    test("serializes number to message", () => {
-        const result = serializeError(42);
-        expect(result.message).toBe("42");
-    });
-    test("serializes null to message", () => {
-        const result = serializeError(null);
-        expect(result.message).toBe("null");
-    });
-    test("serializes undefined to message", () => {
-        // eslint-disable-next-line unicorn/no-useless-undefined
-        const result = serializeError(undefined);
-        expect(result.message).toBe("undefined");
-    });
-    test("serializes object to message using String()", () => {
-        const result = serializeError({ foo: "bar" });
-        expect(result.message).toBe("[object Object]");
-    });
-});
 describe("createStepAttemptCacheFromAttempts", () => {
     test("creates empty cache from empty array", () => {
         const cache = createStepAttemptCacheFromAttempts([]);
@@ -151,21 +93,6 @@ describe("getCachedStepAttempt", () => {
         expect(getCachedStepAttempt(cache, "step-1 ")).toBeUndefined();
     });
 });
-describe("hasCompletedStep", () => {
-    test("returns true when step is in cache", () => {
-        const attempt = createMockStepAttempt({ stepName: "step-x" });
-        const cache = new Map([["step-x", attempt]]);
-        expect(hasCompletedStep(cache, "step-x")).toBe(true);
-    });
-    test("returns false when step is not in cache", () => {
-        const cache = new Map();
-        expect(hasCompletedStep(cache, "step-y")).toBe(false);
-    });
-    test("returns false for empty cache", () => {
-        const cache = new Map();
-        expect(hasCompletedStep(cache, "any-step")).toBe(false);
-    });
-});
 describe("addToStepAttemptCache", () => {
     test("adds attempt to empty cache", () => {
         const cache = new Map();
@@ -337,4 +264,3 @@ function createMockStepAttempt(overrides = {}) {
         ...overrides,
     };
 }
-//# sourceMappingURL=step.test.js.map

package/dist/core/workflow.d.ts

@@ -1,3 +1,4 @@
+import type { SerializedError } from "./error.js";
 import { JsonValue } from "./json.js";
 import type { StandardSchemaV1 } from "./schema.js";
 /**
@@ -18,7 +19,7 @@ export interface WorkflowRun {
     context: JsonValue | null;
     input: JsonValue | null;
     output: JsonValue | null;
-    error: JsonValue | null;
+    error: SerializedError | null;
     attempts: number;
     parentStepAttemptNamespaceId: string | null;
     parentStepAttemptId: string | null;
@@ -49,30 +50,9 @@ export type ValidationResult<T> = {
     success: false;
     error: string;
 };
-/**
- * Configuration options for a workflow definition.
- */
-export interface WorkflowConfig<TSchema extends StandardSchemaV1 | undefined = undefined> {
-    /** The unique name of the workflow. */
-    name: string;
-    /** Optional version string for zero-downtime deployments. */
-    version?: string;
-    /** Optional schema for input validation (Standard Schema v1). */
-    schema?: TSchema;
-}
-/**
- * Default configuration for result polling when awaiting workflow completion.
- */
-export declare const DEFAULT_WORKFLOW_RESULT_CONFIG: {
-    /** Polling interval in milliseconds (1 second) */
-    readonly pollIntervalMs: 1000;
-    /** Timeout in milliseconds (5 minutes) */
-    readonly timeoutMs: number;
-};
 /**
  * Validate input against a Standard Schema. Pure async function that validates
  * input and returns a ValidationResult.
- *
  * @param schema - The Standard Schema to validate against (or null/undefined
  * for no validation)
  * @param input - The input value to validate
@@ -80,29 +60,4 @@ export declare const DEFAULT_WORKFLOW_RESULT_CONFIG: {
  * message
  */
 export declare function validateInput<RunInput, Input>(schema: StandardSchemaV1<RunInput, Input> | null | undefined, input: RunInput | undefined): Promise<ValidationResult<Input>>;
-/**
- * Create a workflow configuration object with defaults applied.
- *
- * @param config - The user-provided workflow configuration
- * @returns A normalized workflow configuration
- */
-export declare function createWorkflowConfig<TSchema extends StandardSchemaV1 | undefined = undefined>(config: Readonly<WorkflowConfig<TSchema>>): Readonly<{
-    name: string;
-    version: string | null;
-    schema: TSchema | null;
-}>;
-/**
- * Check if a workflow definition has a schema for validation.
- *
- * @param config - The workflow configuration
- * @returns True if the workflow has a schema configured
- */
-export declare function hasSchema<TSchema extends StandardSchemaV1 | undefined>(config: Readonly<WorkflowConfig<TSchema>>): boolean;
-/**
- * Check if a workflow run status represents a terminal state.
- *
- * @param status - The workflow run status
- * @returns True if the status is terminal (completed, failed, or canceled)
- */
-export declare function isTerminalStatus(status: string): status is "succeeded" | "completed" | "failed" | "canceled";
 //# sourceMappingURL=workflow.d.ts.map

package/dist/core/workflow.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"workflow.d.ts","sourceRoot":"","sources":["../../core/workflow.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAEpD;;GAEG;AACH,MAAM,MAAM,iBAAiB,GACzB,SAAS,GACT,SAAS,GACT,UAAU,GACV,WAAW,GACX,WAAW,GACX,QAAQ,GACR,UAAU,CAAC;AAEf;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,MAAM,EAAE,iBAAiB,CAAC;IAC1B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,MAAM,EAAE,SAAS,CAAC;IAClB,OAAO,EAAE,SAAS,GAAG,IAAI,CAAC;IAC1B,KAAK,EAAE,SAAS,GAAG,IAAI,CAAC;IACxB,MAAM,EAAE,SAAS,GAAG,IAAI,CAAC;IACzB,KAAK,EAAE,SAAS,GAAG,IAAI,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,4BAA4B,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5C,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,WAAW,EAAE,IAAI,GAAG,IAAI,CAAC;IACzB,UAAU,EAAE,IAAI,GAAG,IAAI,CAAC;IACxB,SAAS,EAAE,IAAI,GAAG,IAAI,CAAC;IACvB,UAAU,EAAE,IAAI,GAAG,IAAI,CAAC;IACxB,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,OAAO,EAAE,QAAQ,IAAI,OAAO,SAAS,gBAAgB,GACzE,gBAAgB,CAAC,UAAU,CAAC,OAAO,CAAC,GACpC,QAAQ,CAAC;AAEb;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,OAAO,EAAE,QAAQ,IAAI,OAAO,SAAS,gBAAgB,GAC1E,gBAAgB,CAAC,WAAW,CAAC,OAAO,CAAC,GACrC,QAAQ,CAAC;AAEb;;;GAGG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAC1B;IAAE,OAAO,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,CAAC,CAAA;CAAE,GAC3B;IAAE,OAAO,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtC;;GAEG;AACH,MAAM,WAAW,cAAc,CAC7B,OAAO,SAAS,gBAAgB,GAAG,SAAS,GAAG,SAAS;IAExD,uCAAuC;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,6DAA6D;IAC7D,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iEAAiE;IACjE,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,eAAO,MAAM,8BAA8B;IACzC,kDAAkD;;IAElD,0CAA0C;;CAElC,CAAC;AAEX;;;;;;;;;GASG;AACH,wBAAsB,aAAa,CAAC,QAAQ,EAAE,KAAK,EACjD,MAAM,EAAE,gBAAgB,CAAC,QAAQ,EAAE,KAAK,CAAC,GAAG,IAAI,GAAG,SAAS,EAC5D,KAAK,EAAE,QAAQ,GAAG,SAAS,GAC1B,OAAO,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CA4BlC;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAClC,OAAO,SAAS,gBAAgB,GAAG,SAAS,GAAG,SAAS,EAExD,MAAM,EAAE,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,GACxC,QAAQ,CAAC;IACV,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,MAAM,EAAE,OAAO,GAAG,IAAI,CAAC;CACxB,CAAC,CAMD;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,OAAO,SAAS,gBAAgB,GAAG,SAAS,EACpE,MAAM,EAAE,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,GACxC,OAAO,CAET;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,MAAM,GACb,MAAM,IAAI,WAAW,GAAG,WAAW,GAAG,QAAQ,GAAG,UAAU,CAO7D"}
+{"version":3,"file":"workflow.d.ts","sourceRoot":"","sources":["../../core/workflow.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAEpD;;GAEG;AACH,MAAM,MAAM,iBAAiB,GACzB,SAAS,GACT,SAAS,GACT,UAAU,GACV,WAAW,GACX,WAAW,GACX,QAAQ,GACR,UAAU,CAAC;AAEf;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,MAAM,EAAE,iBAAiB,CAAC;IAC1B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,MAAM,EAAE,SAAS,CAAC;IAClB,OAAO,EAAE,SAAS,GAAG,IAAI,CAAC;IAC1B,KAAK,EAAE,SAAS,GAAG,IAAI,CAAC;IACxB,MAAM,EAAE,SAAS,GAAG,IAAI,CAAC;IACzB,KAAK,EAAE,eAAe,GAAG,IAAI,CAAC;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,4BAA4B,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5C,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,WAAW,EAAE,IAAI,GAAG,IAAI,CAAC;IACzB,UAAU,EAAE,IAAI,GAAG,IAAI,CAAC;IACxB,SAAS,EAAE,IAAI,GAAG,IAAI,CAAC;IACvB,UAAU,EAAE,IAAI,GAAG,IAAI,CAAC;IACxB,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,OAAO,EAAE,QAAQ,IAAI,OAAO,SAAS,gBAAgB,GACzE,gBAAgB,CAAC,UAAU,CAAC,OAAO,CAAC,GACpC,QAAQ,CAAC;AAEb;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,OAAO,EAAE,QAAQ,IAAI,OAAO,SAAS,gBAAgB,GAC1E,gBAAgB,CAAC,WAAW,CAAC,OAAO,CAAC,GACrC,QAAQ,CAAC;AAEb;;;GAGG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAC1B;IAAE,OAAO,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,CAAC,CAAA;CAAE,GAC3B;IAAE,OAAO,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtC;;;;;;;;GAQG;AACH,wBAAsB,aAAa,CAAC,QAAQ,EAAE,KAAK,EACjD,MAAM,EAAE,gBAAgB,CAAC,QAAQ,EAAE,KAAK,CAAC,GAAG,IAAI,GAAG,SAAS,EAC5D,KAAK,EAAE,QAAQ,GAAG,SAAS,GAC1B,OAAO,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CA4BlC"}

package/dist/core/workflow.js

@@ -1,16 +1,6 @@
-/**
- * Default configuration for result polling when awaiting workflow completion.
- */
-export const DEFAULT_WORKFLOW_RESULT_CONFIG = {
-    /** Polling interval in milliseconds (1 second) */
-    pollIntervalMs: 1000,
-    /** Timeout in milliseconds (5 minutes) */
-    timeoutMs: 5 * 60 * 1000,
-};
 /**
  * Validate input against a Standard Schema. Pure async function that validates
  * input and returns a ValidationResult.
- *
  * @param schema - The Standard Schema to validate against (or null/undefined
  * for no validation)
  * @param input - The input value to validate
@@ -42,38 +32,3 @@ export async function validateInput(schema, input) {
         value: resolved.value,
     };
 }
-/**
- * Create a workflow configuration object with defaults applied.
- *
- * @param config - The user-provided workflow configuration
- * @returns A normalized workflow configuration
- */
-export function createWorkflowConfig(config) {
-    return {
-        name: config.name,
-        version: config.version ?? null,
-        schema: config.schema ?? null,
-    };
-}
-/**
- * Check if a workflow definition has a schema for validation.
- *
- * @param config - The workflow configuration
- * @returns True if the workflow has a schema configured
- */
-export function hasSchema(config) {
-    return Boolean(config.schema);
-}
-/**
- * Check if a workflow run status represents a terminal state.
- *
- * @param status - The workflow run status
- * @returns True if the status is terminal (completed, failed, or canceled)
- */
-export function isTerminalStatus(status) {
-    return (status === "succeeded" ||
-        status === "completed" ||
-        status === "failed" ||
-        status === "canceled");
-}
-//# sourceMappingURL=workflow.js.map

package/dist/core/workflow.test.js

@@ -1,4 +1,4 @@
-import { validateInput, createWorkflowConfig, hasSchema, isTerminalStatus, DEFAULT_WORKFLOW_RESULT_CONFIG, } from "./workflow.js";
+import { validateInput } from "./workflow.js";
 import { describe, expect, test } from "vitest";
 describe("validateInput", () => {
     test("returns success with input when no schema provided (null)", async () => {
@@ -102,108 +102,6 @@ describe("validateInput", () => {
         }
     });
 });
-describe("createWorkflowConfig", () => {
-    test("creates config with required name", () => {
-        const config = createWorkflowConfig({ name: "my-workflow" });
-        expect(config.name).toBe("my-workflow");
-        expect(config.version).toBeNull();
-        expect(config.schema).toBeNull();
-    });
-    test("preserves provided version", () => {
-        const config = createWorkflowConfig({
-            name: "versioned-workflow",
-            version: "1.0.0",
-        });
-        expect(config.name).toBe("versioned-workflow");
-        expect(config.version).toBe("1.0.0");
-    });
-    test("preserves provided schema", () => {
-        const schema = createMockSchema({
-            validate: (input) => ({ value: input }),
-        });
-        const config = createWorkflowConfig({
-            name: "validated-workflow",
-            schema,
-        });
-        expect(config.name).toBe("validated-workflow");
-        expect(config.schema).toBe(schema);
-    });
-    test("creates config with all options", () => {
-        const schema = createMockSchema({
-            validate: (input) => ({ value: input }),
-        });
-        const config = createWorkflowConfig({
-            name: "full-workflow",
-            version: "2.5.0",
-            schema,
-        });
-        expect(config.name).toBe("full-workflow");
-        expect(config.version).toBe("2.5.0");
-        expect(config.schema).toBe(schema);
-    });
-    test("returns frozen/readonly config object", () => {
-        const config = createWorkflowConfig({ name: "readonly-workflow" });
-        expect(config.name).toBe("readonly-workflow");
-        // The function signature specifies Readonly<>, so we trust type safety
-    });
-});
-describe("hasSchema", () => {
-    test("returns false when no schema provided", () => {
-        const config = { name: "no-schema-workflow" };
-        expect(hasSchema(config)).toBe(false);
-    });
-    test("returns false when schema is undefined", () => {
-        const config = { name: "undefined-schema", schema: undefined };
-        expect(hasSchema(config)).toBe(false);
-    });
-    test("returns true when schema is provided", () => {
-        const schema = createMockSchema({
-            validate: (input) => ({ value: input }),
-        });
-        const config = { name: "with-schema", schema };
-        expect(hasSchema(config)).toBe(true);
-    });
-    test("returns true for any truthy schema value", () => {
-        const config = { name: "truthy-schema", schema: {} };
-        expect(hasSchema(config)).toBe(true);
-    });
-});
-describe("isTerminalStatus", () => {
-    test("returns true for 'completed' status", () => {
-        expect(isTerminalStatus("completed")).toBe(true);
-    });
-    test("returns true for 'succeeded' status (deprecated)", () => {
-        expect(isTerminalStatus("succeeded")).toBe(true);
-    });
-    test("returns true for 'failed' status", () => {
-        expect(isTerminalStatus("failed")).toBe(true);
-    });
-    test("returns true for 'canceled' status", () => {
-        expect(isTerminalStatus("canceled")).toBe(true);
-    });
-    test("returns false for 'pending' status", () => {
-        expect(isTerminalStatus("pending")).toBe(false);
-    });
-    test("returns false for 'running' status", () => {
-        expect(isTerminalStatus("running")).toBe(false);
-    });
-    test("returns false for 'sleeping' status", () => {
-        expect(isTerminalStatus("sleeping")).toBe(false);
-    });
-    test("returns false for unknown status strings", () => {
-        expect(isTerminalStatus("unknown")).toBe(false);
-        expect(isTerminalStatus("")).toBe(false);
-        expect(isTerminalStatus("COMPLETED")).toBe(false);
-    });
-});
-describe("DEFAULT_WORKFLOW_RESULT_CONFIG", () => {
-    test("has expected poll interval", () => {
-        expect(DEFAULT_WORKFLOW_RESULT_CONFIG.pollIntervalMs).toBe(1000);
-    });
-    test("has expected timeout (5 minutes)", () => {
-        expect(DEFAULT_WORKFLOW_RESULT_CONFIG.timeoutMs).toBe(5 * 60 * 1000);
-    });
-});
 function createMockSchema(options) {
     return {
         "~standard": {
@@ -213,4 +111,3 @@ function createMockSchema(options) {
         },
     };
 }
-//# sourceMappingURL=workflow.test.js.map

package/dist/driver.d.ts

@@ -0,0 +1,116 @@
+/**
+ * Drizzle-style driver model for OpenWorkflow backends.
+ *
+ * This module provides a driver abstraction layer that separates the database
+ * client (driver) from the backend operations. It follows the Drizzle ORM
+ * pattern where:
+ *
+ * 1. A `Driver` wraps the low-level database client
+ * 2. A `DriverConfig` specifies connection and namespace options
+ * 3. The `openworkflow()` factory function creates an `OpenWorkflow` instance
+ *
+ * Example usage with PostgreSQL:
+ * ```ts
+ * import { openworkflow } from 'openworkflow';
+ * import { postgres } from 'openworkflow/postgres';
+ *
+ * // Simple usage with connection string
+ * const ow = openworkflow(postgres(process.env.DATABASE_URL));
+ *
+ * // With config options
+ * const ow = openworkflow(postgres({
+ *   connection: process.env.DATABASE_URL,
+ *   namespace: 'my-app',
+ * }));
+ * ```
+ *
+ * Example usage with SQLite:
+ * ```ts
+ * import { openworkflow } from 'openworkflow';
+ * import { sqlite } from 'openworkflow/sqlite';
+ *
+ * const ow = openworkflow(sqlite(':memory:'));
+ * ```
+ */
+import type { Backend } from "./backend.js";
+/**
+ * A driver creates Backend instances from database connections.
+ * This is the core abstraction that allows OpenWorkflow to work with
+ * different database backends using the same API.
+ *
+ * Drivers are typically created using helper functions like:
+ * - `postgres()` from 'openworkflow/postgres'
+ * - `sqlite()` from 'openworkflow/sqlite'
+ */
+export interface Driver {
+    /**
+     * Unique identifier for this driver type.
+     */
+    readonly dialect: DriverDialect;
+    /**
+     * Creates a new Backend instance from this driver.
+     * This method handles connection setup and migrations.
+     */
+    createBackend(): Promise<Backend> | Backend;
+    /**
+     * The underlying database client, if available.
+     * This can be used for advanced operations or debugging.
+     */
+    readonly $client?: unknown;
+}
+/**
+ * Supported driver dialects.
+ */
+export type DriverDialect = "postgres" | "sqlite";
+/**
+ * Common configuration options for all drivers.
+ */
+export interface DriverConfig {
+    /**
+     * The namespace for workflow runs. Defaults to 'default'.
+     * This allows multiple applications to share the same database.
+     */
+    namespace?: string;
+    /**
+     * Whether to automatically run migrations on connection.
+     * Defaults to true.
+     */
+    runMigrations?: boolean;
+    /**
+     * Optional logger for debugging.
+     */
+    logger?: DriverLogger;
+}
+/**
+ * Logger interface for driver operations.
+ */
+export interface DriverLogger {
+    /**
+     * Log a message at info level.
+     */
+    logQuery?(query: string, params?: unknown[]): void;
+    /**
+     * Log a message at error level.
+     */
+    error?(message: string, error?: unknown): void;
+}
+/**
+ * Configuration options for the openworkflow factory function.
+ */
+export interface OpenWorkflowConfig {
+    /**
+     * Optional logger for debugging.
+     */
+    logger?: DriverLogger;
+}
+/**
+ * A driver that is ready to create backends.
+ * This type is used to ensure the driver has been properly configured.
+ */
+export interface PreparedDriver<TClient = unknown> extends Driver {
+    /**
+     * The underlying database client.
+     */
+    readonly $client: TClient;
+}
+//# sourceMappingURL=driver.d.ts.map

package/dist/driver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"driver.d.ts","sourceRoot":"","sources":["../driver.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAE5C;;;;;;;;GAQG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC;IAEhC;;;OAGG;IACH,aAAa,IAAI,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC;IAE5C;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,UAAU,GAAG,QAAQ,CAAC;AAElD;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,MAAM,CAAC,EAAE,YAAY,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,QAAQ,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAEnD;;OAEG;IACH,KAAK,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAChD;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,CAAC,EAAE,YAAY,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc,CAAC,OAAO,GAAG,OAAO,CAAE,SAAQ,MAAM;IAC/D;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC3B"}

package/dist/driver.js

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

package/dist/{execution/execution.d.ts → execution.d.ts}

@@ -1,7 +1,7 @@
-import type { Backend } from "../core/backend.js";
-import type { DurationString } from "../core/duration.js";
-import type { StepAttempt } from "../core/step.js";
-import type { WorkflowRun } from "../core/workflow.js";
+import type { Backend } from "./backend.js";
+import type { DurationString } from "./core/duration.js";
+import type { StepAttempt } from "./core/step.js";
+import type { WorkflowRun } from "./core/workflow.js";
 /**
  * Config for an individual step defined with `step.run()`.
  */
@@ -37,14 +37,6 @@ export interface WorkflowFunctionParams<Input> {
  * to define the workflow's steps.
  */
 export type WorkflowFunction<Input, Output> = (params: Readonly<WorkflowFunctionParams<Input>>) => Promise<Output> | Output;
-/**
- * Signal thrown when a workflow needs to sleep. Contains the time when the
- * workflow should resume.
- */
-export declare class SleepSignal extends Error {
-    readonly resumeAt: Date;
-    constructor(resumeAt: Readonly<Date>);
-}
 /**
  * Configures the options for a StepExecutor.
  */
@@ -54,19 +46,6 @@ export interface StepExecutorOptions {
     workerId: string;
     attempts: StepAttempt[];
 }
-/**
- * Replays prior step attempts and persists new ones while memoizing
- * deterministic step outputs.
- */
-export declare class StepExecutor implements StepApi {
-    private readonly backend;
-    private readonly workflowRunId;
-    private readonly workerId;
-    private cache;
-    constructor(options: Readonly<StepExecutorOptions>);
-    run<Output>(config: Readonly<StepFunctionConfig>, fn: StepFunction<Output>): Promise<Output>;
-    sleep(name: string, duration: DurationString): Promise<void>;
-}
 /**
  * Parameters for the workflow execution use case.
  */
@@ -84,7 +63,6 @@ export interface ExecuteWorkflowParams {
  * - Creating the step executor
  * - Executing the workflow function
  * - Completing, failing, or sleeping the workflow run based on the outcome
- *
  * @param params - The execution parameters
  */
 export declare function executeWorkflow(params: Readonly<ExecuteWorkflowParams>): Promise<void>;

package/dist/execution.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"execution.d.ts","sourceRoot":"","sources":["../execution.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAGzD,OAAO,KAAK,EAAE,WAAW,EAAoB,MAAM,gBAAgB,CAAC;AASpE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEtD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB,GAAG,CAAC,MAAM,EACR,MAAM,EAAE,QAAQ,CAAC,kBAAkB,CAAC,EACpC,EAAE,EAAE,YAAY,CAAC,MAAM,CAAC,GACvB,OAAO,CAAC,MAAM,CAAC,CAAC;IACnB,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9D;AAED;;;GAGG;AACH,MAAM,MAAM,YAAY,CAAC,MAAM,IAAI,MAC/B,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,GAC3B,MAAM,GACN,SAAS,CAAC;AAEd;;GAEG;AACH,MAAM,WAAW,sBAAsB,CAAC,KAAK;IAC3C,KAAK,EAAE,KAAK,CAAC;IACb,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,MAAM,gBAAgB,CAAC,KAAK,EAAE,MAAM,IAAI,CAC5C,MAAM,EAAE,QAAQ,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC,KAC5C,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;AAgB9B;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,OAAO,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,WAAW,EAAE,CAAC;CACzB;AAoGD;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,WAAW,CAAC;IACzB,UAAU,EAAE,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC/C,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;GAQG;AACH,wBAAsB,eAAe,CACnC,MAAM,EAAE,QAAQ,CAAC,qBAAqB,CAAC,GACtC,OAAO,CAAC,IAAI,CAAC,CA4Ff"}

package/dist/{execution/execution.js → execution.js}

@@ -1,9 +1,10 @@
-import { serializeError, createStepAttemptCacheFromAttempts, getCachedStepAttempt, addToStepAttemptCache, normalizeStepOutput, calculateSleepResumeAt, createSleepContext, } from "../core/step.js";
+import { serializeError } from "./core/error.js";
+import { createStepAttemptCacheFromAttempts, getCachedStepAttempt, addToStepAttemptCache, normalizeStepOutput, calculateSleepResumeAt, createSleepContext, } from "./core/step.js";
 /**
  * Signal thrown when a workflow needs to sleep. Contains the time when the
  * workflow should resume.
  */
-export class SleepSignal extends Error {
+class SleepSignal extends Error {
     resumeAt;
     constructor(resumeAt) {
         super("SleepSignal");
@@ -15,7 +16,7 @@ export class SleepSignal extends Error {
  * Replays prior step attempts and persists new ones while memoizing
  * deterministic step outputs.
  */
-export class StepExecutor {
+class StepExecutor {
     backend;
     workflowRunId;
     workerId;
@@ -101,7 +102,6 @@ export class StepExecutor {
  * - Creating the step executor
  * - Executing the workflow function
  * - Completing, failing, or sleeping the workflow run based on the outcome
- *
  * @param params - The execution parameters
  */
 export async function executeWorkflow(params) {
@@ -185,4 +185,3 @@ export async function executeWorkflow(params) {
         });
     }
 }
-//# sourceMappingURL=execution.js.map

package/dist/execution.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"execution.test.d.ts","sourceRoot":"","sources":["../execution.test.ts"],"names":[],"mappings":""}