openworkflow 0.4.0 → 0.5.0

package/dist/client.d.ts

@@ -1,9 +1,9 @@
-import type { Backend, WorkflowRun } from "./backend.js";
-import { DurationString } from "./duration.js";
-import { StandardSchemaV1 } from "./schema.js";
+import type { Backend } from "./backend.js";
+import type { StandardSchemaV1 } from "./core/schema.js";
+import type { SchemaInput, SchemaOutput, WorkflowRun } from "./core/workflow.js";
+import type { WorkflowFunction } from "./execution.js";
 import { Worker } from "./worker.js";
-type SchemaInput<TSchema, Fallback> = TSchema extends StandardSchemaV1 ? StandardSchemaV1.InferInput<TSchema> : Fallback;
-type SchemaOutput<TSchema, Fallback> = TSchema extends StandardSchemaV1 ? StandardSchemaV1.InferOutput<TSchema> : Fallback;
+import { type Workflow, type WorkflowSpec } from "./workflow.js";
 type WorkflowHandlerInput<TSchema, Input> = SchemaOutput<TSchema, Input>;
 type WorkflowRunInput<TSchema, Input> = SchemaInput<TSchema, Input>;
 /**
@@ -17,101 +17,76 @@ export interface OpenWorkflowOptions {
  */
 export declare class OpenWorkflow {
     private backend;
-    private registeredWorkflows;
+    private registry;
     constructor(options: OpenWorkflowOptions);
     /**
      * Create a new Worker with this client's backend and workflows.
+     * @param options - Worker options
+     * @param options.concurrency - Max concurrent workflow runs
+     * @returns Worker instance
      */
     newWorker(options?: {
-        concurrency?: number;
+        concurrency?: number | undefined;
     }): Worker;
     /**
-     * Define and register a new workflow.
-     */
-    defineWorkflow<Input, Output, TSchema extends StandardSchemaV1 | undefined = undefined>(config: WorkflowDefinitionConfig<TSchema>, fn: WorkflowFunction<WorkflowHandlerInput<TSchema, Input>, Output>): WorkflowDefinition<WorkflowHandlerInput<TSchema, Input>, Output, WorkflowRunInput<TSchema, Input>>;
-}
-/**
- * Options for WorkflowDefinition.
- */
-export interface WorkflowDefinitionOptions<Input, Output, RunInput = Input> {
-    backend: Backend;
-    name: string;
-    version?: string;
-    fn: WorkflowFunction<Input, Output>;
-    schema?: StandardSchemaV1<RunInput, Input> | undefined;
-}
-/**
- * Config passed to `defineWorkflow()` when defining a workflow.
- */
-export interface WorkflowDefinitionConfig<TSchema extends StandardSchemaV1 | undefined = undefined> {
-    /**
-     * The name of the workflow.
+     * Provide the implementation for a declared workflow. This links the workflow
+     * specification to its execution logic and registers it with this
+     * OpenWorkflow instance for worker execution.
+     * @param spec - Workflow spec
+     * @param fn - Workflow implementation
      */
-    name: string;
+    implementWorkflow<Input, Output, RunInput = Input>(spec: WorkflowSpec<Input, Output, RunInput>, fn: WorkflowFunction<Input, Output>): void;
     /**
-     * Optional version string for the workflow. Use this to enable zero-downtime
-     * deployments when changing workflow logic.
+     * Run a workflow from its specification. This is the primary way to schedule
+     * a workflow using only its WorkflowSpec.
+     * @param spec - Workflow spec
+     * @param input - Workflow input
+     * @param options - Run options
+     * @returns Handle for awaiting the result
+     * @example
+     * ```ts
+     * const handle = await ow.runWorkflow(emailWorkflow, { to: 'user@example.com' });
+     * const result = await handle.result();
+     * ```
      */
-    version?: string;
+    runWorkflow<Input, Output, RunInput = Input>(spec: WorkflowSpec<Input, Output, RunInput>, input?: RunInput, options?: WorkflowRunOptions): Promise<WorkflowRunHandle<Output>>;
     /**
-     * Optional schema used to validate inputs passed to `.run()`.
+     * Define and register a new workflow.
+     * @param spec - Workflow spec
+     * @param fn - Workflow implementation
+     * @returns Runnable workflow
+     * @example
+     * ```ts
+     * const workflow = ow.defineWorkflow(
+     *   { name: 'my-workflow' },
+     *   async ({ input, step }) => {
+     *     // workflow implementation
+     *   },
+     * );
+     * ```
      */
-    schema?: TSchema;
+    defineWorkflow<Input, Output, TSchema extends StandardSchemaV1 | undefined = undefined>(spec: WorkflowSpec<WorkflowHandlerInput<TSchema, Input>, Output, WorkflowRunInput<TSchema, Input>>, fn: WorkflowFunction<WorkflowHandlerInput<TSchema, Input>, Output>): RunnableWorkflow<WorkflowHandlerInput<TSchema, Input>, Output, WorkflowRunInput<TSchema, Input>>;
 }
 /**
- * Represents a workflow definition that can be used to start runs. Returned
- * from `client.defineWorkflow()`.
+ * A fully defined workflow with its implementation. This class is returned by
+ * `client.defineWorkflow` and provides the `.run()` method for scheduling
+ * workflow runs.
  */
-export declare class WorkflowDefinition<Input, Output, RunInput = Input> {
-    private backend;
-    readonly name: string;
-    readonly version: string | null;
-    readonly fn: WorkflowFunction<Input, Output>;
-    private readonly schema;
-    constructor(options: WorkflowDefinitionOptions<Input, Output, RunInput>);
+export declare class RunnableWorkflow<Input, Output, RunInput = Input> {
+    private readonly ow;
+    readonly workflow: Workflow<Input, Output, RunInput>;
+    constructor(ow: OpenWorkflow, workflow: Workflow<Input, Output, RunInput>);
     /**
      * Starts a new workflow run.
+     * @param input - Workflow input
+     * @param options - Run options
+     * @returns Workflow run handle
      */
     run(input?: RunInput, options?: WorkflowRunOptions): Promise<WorkflowRunHandle<Output>>;
 }
 /**
- * Params passed to a workflow function for the user to use when defining steps.
- */
-export interface WorkflowFunctionParams<Input> {
-    input: Input;
-    step: StepApi;
-    version: string | null;
-}
-/**
- * The workflow definition's function (defined by the user) that the user uses
- * to define the workflow's steps.
- */
-export type WorkflowFunction<Input, Output> = (params: WorkflowFunctionParams<Input>) => Promise<Output> | Output;
-/**
- * Config for an individual step defined with `step.run()`.
- */
-export interface StepFunctionConfig {
-    /**
-     * The name of the step.
-     */
-    name: string;
-}
-/**
- * Represents the API for defining steps within a workflow. Used within a
- * workflow handler to define steps by calling `step.run()`.
- */
-export interface StepApi {
-    run<Output>(config: StepFunctionConfig, fn: StepFunction<Output>): Promise<Output>;
-    sleep(name: string, duration: DurationString): Promise<void>;
-}
-/**
- * The step definition (defined by the user) that executes user code. Can return
- * undefined (e.g., when using `return;`) which will be converted to null.
- */
-export type StepFunction<Output> = () => Promise<Output | undefined> | Output | undefined;
-/**
- * Options for creating a new workflow run from a workflow definition when
- * calling `workflowDef.run()`.
+ * Options for creating a new workflow run from a runnable workflow when calling
+ * `workflowDef.run()`.
  */
 export interface WorkflowRunOptions {
     /**
@@ -129,6 +104,17 @@ export interface WorkflowHandleOptions {
     resultPollIntervalMs: number;
     resultTimeoutMs: number;
 }
+/**
+ * Options for result() on a WorkflowRunHandle.
+ */
+export interface WorkflowRunHandleResultOptions {
+    /**
+     * Time to wait for a workflow run to complete. Throws an error if the timeout
+     * is exceeded.
+     * @default 300000 (5 minutes)
+     */
+    timeoutMs?: number;
+}
 /**
  * Represents a started workflow run and provides methods to await its result.
  * Returned from `workflowDef.run()`.
@@ -141,8 +127,10 @@ export declare class WorkflowRunHandle<Output> {
     constructor(options: WorkflowHandleOptions);
     /**
      * Waits for the workflow run to complete and returns the result.
+     * @param options - Options for waiting for the result
+     * @returns Workflow output
      */
-    result(): Promise<Output>;
+    result(options?: WorkflowRunHandleResultOptions): Promise<Output>;
     /**
      * Cancels the workflow run. Only workflows in pending, running, or sleeping
      * status can be canceled.

package/dist/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAKrC,KAAK,WAAW,CAAC,OAAO,EAAE,QAAQ,IAAI,OAAO,SAAS,gBAAgB,GAClE,gBAAgB,CAAC,UAAU,CAAC,OAAO,CAAC,GACpC,QAAQ,CAAC;AAEb,KAAK,YAAY,CAAC,OAAO,EAAE,QAAQ,IAAI,OAAO,SAAS,gBAAgB,GACnE,gBAAgB,CAAC,WAAW,CAAC,OAAO,CAAC,GACrC,QAAQ,CAAC;AAGb,KAAK,oBAAoB,CAAC,OAAO,EAAE,KAAK,IAAI,YAAY,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;AAGzE,KAAK,gBAAgB,CAAC,OAAO,EAAE,KAAK,IAAI,WAAW,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;AAEpE;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,OAAO,CAAU;IACzB,OAAO,CAAC,mBAAmB,CAGvB;gBAEQ,OAAO,EAAE,mBAAmB;IAIxC;;OAEG;IACH,SAAS,CAAC,OAAO,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,MAAM;IAQrD;;OAEG;IACH,cAAc,CACZ,KAAK,EACL,MAAM,EACN,OAAO,SAAS,gBAAgB,GAAG,SAAS,GAAG,SAAS,EAExD,MAAM,EAAE,wBAAwB,CAAC,OAAO,CAAC,EACzC,EAAE,EAAE,gBAAgB,CAAC,oBAAoB,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,MAAM,CAAC,GACjE,kBAAkB,CACnB,oBAAoB,CAAC,OAAO,EAAE,KAAK,CAAC,EACpC,MAAM,EACN,gBAAgB,CAAC,OAAO,EAAE,KAAK,CAAC,CACjC;CA+BF;AAMD;;GAEG;AACH,MAAM,WAAW,yBAAyB,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,GAAG,KAAK;IACxE,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,EAAE,EAAE,gBAAgB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACpC,MAAM,CAAC,EAAE,gBAAgB,CAAC,QAAQ,EAAE,KAAK,CAAC,GAAG,SAAS,CAAC;CACxD;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB,CACvC,OAAO,SAAS,gBAAgB,GAAG,SAAS,GAAG,SAAS;IAExD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;;GAGG;AACH,qBAAa,kBAAkB,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,GAAG,KAAK;IAC7D,OAAO,CAAC,OAAO,CAAU;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,QAAQ,CAAC,EAAE,EAAE,gBAAgB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAC7C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA2C;gBAEtD,OAAO,EAAE,yBAAyB,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC;IAQvE;;OAEG;IACG,GAAG,CACP,KAAK,CAAC,EAAE,QAAQ,EAChB,OAAO,CAAC,EAAE,kBAAkB,GAC3B,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;CAsCtC;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,sBAAsB,CAAC,KAAK,CAAC,KAClC,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;AAE9B;;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,kBAAkB,EAC1B,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;AAMd;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,UAAU,CAAC,EAAE,IAAI,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,WAAW,CAAC;IACzB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,eAAe,EAAE,MAAM,CAAC;CACzB;AAED;;;GAGG;AACH,qBAAa,iBAAiB,CAAC,MAAM;IACnC,OAAO,CAAC,OAAO,CAAU;IACzB,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAClC,OAAO,CAAC,oBAAoB,CAAS;IACrC,OAAO,CAAC,eAAe,CAAS;gBAEpB,OAAO,EAAE,qBAAqB;IAO1C;;OAEG;IACG,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC;IA0C/B;;;OAGG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CAK9B"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACzD,OAAO,KAAK,EACV,WAAW,EACX,YAAY,EACZ,WAAW,EACZ,MAAM,oBAAoB,CAAC;AAE5B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAEvD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAEL,KAAK,QAAQ,EACb,KAAK,YAAY,EAClB,MAAM,eAAe,CAAC;AAMvB,KAAK,oBAAoB,CAAC,OAAO,EAAE,KAAK,IAAI,YAAY,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;AAGzE,KAAK,gBAAgB,CAAC,OAAO,EAAE,KAAK,IAAI,WAAW,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;AAEpE;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,OAAO,CAAU;IACzB,OAAO,CAAC,QAAQ,CAA0B;gBAE9B,OAAO,EAAE,mBAAmB;IAIxC;;;;;OAKG;IACH,SAAS,CAAC,OAAO,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,GAAG,MAAM;IAQjE;;;;;;OAMG;IACH,iBAAiB,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,GAAG,KAAK,EAC/C,IAAI,EAAE,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,EAC3C,EAAE,EAAE,gBAAgB,CAAC,KAAK,EAAE,MAAM,CAAC,GAClC,IAAI;IASP;;;;;;;;;;;;OAYG;IACG,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,GAAG,KAAK,EAC/C,IAAI,EAAE,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,EAC3C,KAAK,CAAC,EAAE,QAAQ,EAChB,OAAO,CAAC,EAAE,kBAAkB,GAC3B,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;IA0BrC;;;;;;;;;;;;;;OAcG;IACH,cAAc,CACZ,KAAK,EACL,MAAM,EACN,OAAO,SAAS,gBAAgB,GAAG,SAAS,GAAG,SAAS,EAExD,IAAI,EAAE,YAAY,CAChB,oBAAoB,CAAC,OAAO,EAAE,KAAK,CAAC,EACpC,MAAM,EACN,gBAAgB,CAAC,OAAO,EAAE,KAAK,CAAC,CACjC,EACD,EAAE,EAAE,gBAAgB,CAAC,oBAAoB,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,MAAM,CAAC,GACjE,gBAAgB,CACjB,oBAAoB,CAAC,OAAO,EAAE,KAAK,CAAC,EACpC,MAAM,EACN,gBAAgB,CAAC,OAAO,EAAE,KAAK,CAAC,CACjC;CAOF;AAED;;;;GAIG;AACH,qBAAa,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,GAAG,KAAK;IAC3D,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAe;IAClC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;gBAEzC,EAAE,EAAE,YAAY,EAAE,QAAQ,EAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC;IAKzE;;;;;OAKG;IACG,GAAG,CACP,KAAK,CAAC,EAAE,QAAQ,EAChB,OAAO,CAAC,EAAE,kBAAkB,GAC3B,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;CAGtC;AAMD;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,UAAU,CAAC,EAAE,IAAI,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,WAAW,CAAC;IACzB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,eAAe,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,qBAAa,iBAAiB,CAAC,MAAM;IACnC,OAAO,CAAC,OAAO,CAAU;IACzB,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAClC,OAAO,CAAC,oBAAoB,CAAS;IACrC,OAAO,CAAC,eAAe,CAAS;gBAEpB,OAAO,EAAE,qBAAqB;IAO1C;;;;OAIG;IACG,MAAM,CAAC,OAAO,CAAC,EAAE,8BAA8B,GAAG,OAAO,CAAC,MAAM,CAAC;IA2CvE;;;OAGG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CAK9B"}

package/dist/client.js

@@ -1,4 +1,7 @@
+import { validateInput } from "./core/workflow.js";
+import { WorkflowRegistry } from "./registry.js";
 import { Worker } from "./worker.js";
+import { defineWorkflow, } from "./workflow.js";
 const DEFAULT_RESULT_POLL_INTERVAL_MS = 1000; // 1s
 const DEFAULT_RESULT_TIMEOUT_MS = 5 * 60 * 1000; // 5m
 /**
@@ -6,77 +9,59 @@ const DEFAULT_RESULT_TIMEOUT_MS = 5 * 60 * 1000; // 5m
  */
 export class OpenWorkflow {
     backend;
-    registeredWorkflows = new Map();
+    registry = new WorkflowRegistry();
     constructor(options) {
         this.backend = options.backend;
     }
     /**
      * Create a new Worker with this client's backend and workflows.
+     * @param options - Worker options
+     * @param options.concurrency - Max concurrent workflow runs
+     * @returns Worker instance
      */
     newWorker(options) {
         return new Worker({
             backend: this.backend,
-            workflows: [...this.registeredWorkflows.values()],
+            workflows: this.registry.getAll(),
             concurrency: options?.concurrency,
         });
     }
     /**
-     * Define and register a new workflow.
+     * Provide the implementation for a declared workflow. This links the workflow
+     * specification to its execution logic and registers it with this
+     * OpenWorkflow instance for worker execution.
+     * @param spec - Workflow spec
+     * @param fn - Workflow implementation
      */
-    defineWorkflow(config, fn) {
-        const { name, version } = config;
-        if (this.registeredWorkflows.has(name)) {
-            throw new Error(`Workflow "${name}" is already registered`);
-        }
-        const definition = new WorkflowDefinition({
-            backend: this.backend,
-            name,
-            ...(version !== undefined && { version }),
+    implementWorkflow(spec, fn) {
+        const workflow = {
+            spec,
             fn,
-            schema: config.schema,
-        });
-        this.registeredWorkflows.set(name, definition);
-        return definition;
-    }
-}
-/**
- * Represents a workflow definition that can be used to start runs. Returned
- * from `client.defineWorkflow()`.
- */
-export class WorkflowDefinition {
-    backend;
-    name;
-    version;
-    fn;
-    schema;
-    constructor(options) {
-        this.backend = options.backend;
-        this.name = options.name;
-        this.version = options.version ?? null;
-        this.fn = options.fn;
-        this.schema = options.schema ?? null;
+        };
+        this.registry.register(workflow);
     }
     /**
-     * Starts a new workflow run.
+     * Run a workflow from its specification. This is the primary way to schedule
+     * a workflow using only its WorkflowSpec.
+     * @param spec - Workflow spec
+     * @param input - Workflow input
+     * @param options - Run options
+     * @returns Handle for awaiting the result
+     * @example
+     * ```ts
+     * const handle = await ow.runWorkflow(emailWorkflow, { to: 'user@example.com' });
+     * const result = await handle.result();
+     * ```
      */
-    async run(input, options) {
-        let parsedInput = input;
-        if (this.schema) {
-            // https://standardschema.dev
-            const result = this.schema["~standard"].validate(input);
-            const resolved = await Promise.resolve(result);
-            if (resolved.issues) {
-                const messages = resolved.issues.length > 0
-                    ? resolved.issues.map((issue) => issue.message).join("; ")
-                    : "Validation failed";
-                throw new Error(messages);
-            }
-            parsedInput = resolved.value;
+    async runWorkflow(spec, input, options) {
+        const validationResult = await validateInput(spec.schema, input);
+        if (!validationResult.success) {
+            throw new Error(validationResult.error);
         }
-        // need to come back and support idempotency keys, scheduling, etc.
+        const parsedInput = validationResult.value;
         const workflowRun = await this.backend.createWorkflowRun({
-            workflowName: this.name,
-            version: this.version,
+            workflowName: spec.name,
+            version: spec.version ?? null,
             idempotencyKey: null,
             config: {},
             context: null,
@@ -91,6 +76,48 @@ export class WorkflowDefinition {
             resultTimeoutMs: DEFAULT_RESULT_TIMEOUT_MS,
         });
     }
+    /**
+     * Define and register a new workflow.
+     * @param spec - Workflow spec
+     * @param fn - Workflow implementation
+     * @returns Runnable workflow
+     * @example
+     * ```ts
+     * const workflow = ow.defineWorkflow(
+     *   { name: 'my-workflow' },
+     *   async ({ input, step }) => {
+     *     // workflow implementation
+     *   },
+     * );
+     * ```
+     */
+    defineWorkflow(spec, fn) {
+        const workflow = defineWorkflow(spec, fn);
+        this.registry.register(workflow);
+        return new RunnableWorkflow(this, workflow);
+    }
+}
+/**
+ * A fully defined workflow with its implementation. This class is returned by
+ * `client.defineWorkflow` and provides the `.run()` method for scheduling
+ * workflow runs.
+ */
+export class RunnableWorkflow {
+    ow;
+    workflow;
+    constructor(ow, workflow) {
+        this.ow = ow;
+        this.workflow = workflow;
+    }
+    /**
+     * Starts a new workflow run.
+     * @param input - Workflow input
+     * @param options - Run options
+     * @returns Workflow run handle
+     */
+    async run(input, options) {
+        return this.ow.runWorkflow(this.workflow.spec, input, options);
+    }
 }
 /**
  * Represents a started workflow run and provides methods to await its result.
@@ -109,9 +136,12 @@ export class WorkflowRunHandle {
     }
     /**
      * Waits for the workflow run to complete and returns the result.
+     * @param options - Options for waiting for the result
+     * @returns Workflow output
      */
-    async result() {
+    async result(options) {
         const start = Date.now();
+        const timeout = options?.timeoutMs ?? this.resultTimeoutMs;
         // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
         while (true) {
             const latest = await this.backend.getWorkflowRun({
@@ -130,7 +160,7 @@ export class WorkflowRunHandle {
             if (latest.status === "canceled") {
                 throw new Error(`Workflow ${this.workflowRun.workflowName} was canceled`);
             }
-            if (Date.now() - start > this.resultTimeoutMs) {
+            if (Date.now() - start > timeout) {
                 throw new Error(`Timed out waiting for workflow run ${this.workflowRun.id} to finish`);
             }
             await new Promise((resolve) => {

package/dist/client.js.map

@@ -1 +1 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../client.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,MAAM,+BAA+B,GAAG,IAAI,CAAC,CAAC,KAAK;AACnD,MAAM,yBAAyB,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,KAAK;AAuBtD;;GAEG;AACH,MAAM,OAAO,YAAY;IACf,OAAO,CAAU;IACjB,mBAAmB,GAAG,IAAI,GAAG,EAGlC,CAAC;IAEJ,YAAY,OAA4B;QACtC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,SAAS,CAAC,OAAkC;QAC1C,OAAO,IAAI,MAAM,CAAC;YAChB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,SAAS,EAAE,CAAC,GAAG,IAAI,CAAC,mBAAmB,CAAC,MAAM,EAAE,CAAC;YACjD,WAAW,EAAE,OAAO,EAAE,WAAW;SAClC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,cAAc,CAKZ,MAAyC,EACzC,EAAkE;QAMlE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAEjC,IAAI,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YACvC,MAAM,IAAI,KAAK,CAAC,aAAa,IAAI,yBAAyB,CAAC,CAAC;QAC9D,CAAC;QAED,MAAM,UAAU,GAAG,IAAI,kBAAkB,CAIvC;YACA,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,IAAI;YACJ,GAAG,CAAC,OAAO,KAAK,SAAS,IAAI,EAAE,OAAO,EAAE,CAAC;YACzC,EAAE;YACF,MAAM,EAAE,MAAM,CAAC,MAKF;SACd,CAAC,CAAC;QAEH,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAC1B,IAAI,EACJ,UAA2D,CAC5D,CAAC;QAEF,OAAO,UAAU,CAAC;IACpB,CAAC;CACF;AAsCD;;;GAGG;AACH,MAAM,OAAO,kBAAkB;IACrB,OAAO,CAAU;IAChB,IAAI,CAAS;IACb,OAAO,CAAgB;IACvB,EAAE,CAAkC;IAC5B,MAAM,CAA2C;IAElE,YAAY,OAA2D;QACrE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QACzB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,IAAI,CAAC;QACvC,IAAI,CAAC,EAAE,GAAG,OAAO,CAAC,EAAE,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,IAAI,CAAC;IACvC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,GAAG,CACP,KAAgB,EAChB,OAA4B;QAE5B,IAAI,WAAW,GAAG,KAAqC,CAAC;QAExD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,6BAA6B;YAC7B,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YACxD,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAE/C,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;gBACpB,MAAM,QAAQ,GACZ,QAAQ,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC;oBACxB,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;oBAC1D,CAAC,CAAC,mBAAmB,CAAC;gBAC1B,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC;YAC5B,CAAC;YAED,WAAW,GAAG,QAAQ,CAAC,KAAK,CAAC;QAC/B,CAAC;QAED,mEAAmE;QACnE,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC;YACvD,YAAY,EAAE,IAAI,CAAC,IAAI;YACvB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,cAAc,EAAE,IAAI;YACpB,MAAM,EAAE,EAAE;YACV,OAAO,EAAE,IAAI;YACb,KAAK,EAAE,WAAW,IAAI,IAAI;YAC1B,WAAW,EAAE,IAAI;YACjB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,IAAI;SACxC,CAAC,CAAC;QAEH,OAAO,IAAI,iBAAiB,CAAS;YACnC,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,WAAW,EAAE,WAAW;YACxB,oBAAoB,EAAE,+BAA+B;YACrD,eAAe,EAAE,yBAAyB;SAC3C,CAAC,CAAC;IACL,CAAC;CACF;AA4ED;;;GAGG;AACH,MAAM,OAAO,iBAAiB;IACpB,OAAO,CAAU;IAChB,WAAW,CAAc;IAC1B,oBAAoB,CAAS;IAC7B,eAAe,CAAS;IAEhC,YAAY,OAA8B;QACxC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,oBAAoB,GAAG,OAAO,CAAC,oBAAoB,CAAC;QACzD,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;IACjD,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM;QACV,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAEzB,uEAAuE;QACvE,OAAO,IAAI,EAAE,CAAC;YACZ,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC;gBAC/C,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,EAAE;aACnC,CAAC,CAAC;YAEH,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,MAAM,IAAI,KAAK,CAAC,gBAAgB,IAAI,CAAC,WAAW,CAAC,EAAE,mBAAmB,CAAC,CAAC;YAC1E,CAAC;YAED,mCAAmC;YACnC,IAAI,MAAM,CAAC,MAAM,KAAK,WAAW,IAAI,MAAM,CAAC,MAAM,KAAK,WAAW,EAAE,CAAC;gBACnE,OAAO,MAAM,CAAC,MAAgB,CAAC;YACjC,CAAC;YAED,IAAI,MAAM,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;gBAC/B,MAAM,IAAI,KAAK,CACb,YAAY,IAAI,CAAC,WAAW,CAAC,YAAY,YAAY,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CACpF,CAAC;YACJ,CAAC;YAED,IAAI,MAAM,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;gBACjC,MAAM,IAAI,KAAK,CACb,YAAY,IAAI,CAAC,WAAW,CAAC,YAAY,eAAe,CACzD,CAAC;YACJ,CAAC;YAED,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;gBAC9C,MAAM,IAAI,KAAK,CACb,sCAAsC,IAAI,CAAC,WAAW,CAAC,EAAE,YAAY,CACtE,CAAC;YACJ,CAAC;YAED,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;gBAC5B,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAC;YACjD,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM;QACV,MAAM,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC;YACnC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,EAAE;SACnC,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../client.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EACL,cAAc,GAGf,MAAM,eAAe,CAAC;AAEvB,MAAM,+BAA+B,GAAG,IAAI,CAAC,CAAC,KAAK;AACnD,MAAM,yBAAyB,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,KAAK;AAetD;;GAEG;AACH,MAAM,OAAO,YAAY;IACf,OAAO,CAAU;IACjB,QAAQ,GAAG,IAAI,gBAAgB,EAAE,CAAC;IAE1C,YAAY,OAA4B;QACtC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IACjC,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,OAA8C;QACtD,OAAO,IAAI,MAAM,CAAC;YAChB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE;YACjC,WAAW,EAAE,OAAO,EAAE,WAAW;SAClC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,iBAAiB,CACf,IAA2C,EAC3C,EAAmC;QAEnC,MAAM,QAAQ,GAAsC;YAClD,IAAI;YACJ,EAAE;SACH,CAAC;QAEF,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAA+C,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,WAAW,CACf,IAA2C,EAC3C,KAAgB,EAChB,OAA4B;QAE5B,MAAM,gBAAgB,GAAG,MAAM,aAAa,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QACjE,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QAC1C,CAAC;QACD,MAAM,WAAW,GAAG,gBAAgB,CAAC,KAAK,CAAC;QAE3C,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC;YACvD,YAAY,EAAE,IAAI,CAAC,IAAI;YACvB,OAAO,EAAE,IAAI,CAAC,OAAO,IAAI,IAAI;YAC7B,cAAc,EAAE,IAAI;YACpB,MAAM,EAAE,EAAE;YACV,OAAO,EAAE,IAAI;YACb,KAAK,EAAE,WAAW,IAAI,IAAI;YAC1B,WAAW,EAAE,IAAI;YACjB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,IAAI;SACxC,CAAC,CAAC;QAEH,OAAO,IAAI,iBAAiB,CAAS;YACnC,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,WAAW,EAAE,WAAW;YACxB,oBAAoB,EAAE,+BAA+B;YACrD,eAAe,EAAE,yBAAyB;SAC3C,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,cAAc,CAKZ,IAIC,EACD,EAAkE;QAMlE,MAAM,QAAQ,GAAG,cAAc,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAE1C,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAA+C,CAAC,CAAC;QAExE,OAAO,IAAI,gBAAgB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC9C,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,gBAAgB;IACV,EAAE,CAAe;IACzB,QAAQ,CAAoC;IAErD,YAAY,EAAgB,EAAE,QAA2C;QACvE,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,GAAG,CACP,KAAgB,EAChB,OAA4B;QAE5B,OAAO,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;CACF;AAwCD;;;GAGG;AACH,MAAM,OAAO,iBAAiB;IACpB,OAAO,CAAU;IAChB,WAAW,CAAc;IAC1B,oBAAoB,CAAS;IAC7B,eAAe,CAAS;IAEhC,YAAY,OAA8B;QACxC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,oBAAoB,GAAG,OAAO,CAAC,oBAAoB,CAAC;QACzD,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CAAC,OAAwC;QACnD,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACzB,MAAM,OAAO,GAAG,OAAO,EAAE,SAAS,IAAI,IAAI,CAAC,eAAe,CAAC;QAE3D,uEAAuE;QACvE,OAAO,IAAI,EAAE,CAAC;YACZ,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC;gBAC/C,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,EAAE;aACnC,CAAC,CAAC;YAEH,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,MAAM,IAAI,KAAK,CAAC,gBAAgB,IAAI,CAAC,WAAW,CAAC,EAAE,mBAAmB,CAAC,CAAC;YAC1E,CAAC;YAED,mCAAmC;YACnC,IAAI,MAAM,CAAC,MAAM,KAAK,WAAW,IAAI,MAAM,CAAC,MAAM,KAAK,WAAW,EAAE,CAAC;gBACnE,OAAO,MAAM,CAAC,MAAgB,CAAC;YACjC,CAAC;YAED,IAAI,MAAM,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;gBAC/B,MAAM,IAAI,KAAK,CACb,YAAY,IAAI,CAAC,WAAW,CAAC,YAAY,YAAY,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CACpF,CAAC;YACJ,CAAC;YAED,IAAI,MAAM,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;gBACjC,MAAM,IAAI,KAAK,CACb,YAAY,IAAI,CAAC,WAAW,CAAC,YAAY,eAAe,CACzD,CAAC;YACJ,CAAC;YAED,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,GAAG,OAAO,EAAE,CAAC;gBACjC,MAAM,IAAI,KAAK,CACb,sCAAsC,IAAI,CAAC,WAAW,CAAC,EAAE,YAAY,CACtE,CAAC;YACJ,CAAC;YAED,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;gBAC5B,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAC;YACjD,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM;QACV,MAAM,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC;YACnC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,EAAE;SACnC,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/config.d.ts

@@ -0,0 +1,34 @@
+import { Backend } from "./backend.js";
+import { WorkerOptions } from "./worker.js";
+export interface OpenWorkflowConfig {
+    backend: Backend;
+    worker?: WorkerConfig;
+    /**
+     * Directory or directories to scan for workflow files. All `.ts`, `.js`,
+     * `.mjs`, and `.cjs` files in these directories (recursively) will be loaded.
+     * Workflow files should export workflows created with `defineWorkflow()`.
+     * @example "./openworkflow"
+     * @example ["./openworkflow", "./src/openworkflow", "./workflows"]
+     */
+    dirs?: string | string[];
+}
+export type WorkerConfig = Pick<WorkerOptions, "concurrency">;
+/**
+ * Create a typed OpenWorkflow configuration.
+ * @param config - the config
+ * @returns the config
+ */
+export declare function defineConfig(config: OpenWorkflowConfig): OpenWorkflowConfig;
+interface LoadedConfig {
+    config: OpenWorkflowConfig;
+    configFile: string | undefined;
+}
+/**
+ * Load the OpenWorkflow config at openworkflow.config.{js,mjs,cjs}.
+ * @param rootDir - Optional root directory to search from (defaults to
+ * process.cwd())
+ * @returns The loaded configuration and metadata
+ */
+export declare function loadConfig(rootDir?: string): Promise<LoadedConfig>;
+export {};
+//# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAK5C,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;CAC1B;AAED,MAAM,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC;AAE9D;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,kBAAkB,GAAG,kBAAkB,CAE3E;AAED,UAAU,YAAY;IACpB,MAAM,EAAE,kBAAkB,CAAC;IAC3B,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;CAChC;AAKD;;;;;GAKG;AACH,wBAAsB,UAAU,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAqCxE"}

package/dist/config.js

@@ -0,0 +1,49 @@
+import { existsSync } from "node:fs";
+import path from "node:path";
+import { pathToFileURL } from "node:url";
+/**
+ * Create a typed OpenWorkflow configuration.
+ * @param config - the config
+ * @returns the config
+ */
+export function defineConfig(config) {
+    return config;
+}
+const CONFIG_NAME = "openworkflow.config";
+const CONFIG_EXTENSIONS = ["js", "mjs", "cjs"];
+/**
+ * Load the OpenWorkflow config at openworkflow.config.{js,mjs,cjs}.
+ * @param rootDir - Optional root directory to search from (defaults to
+ * process.cwd())
+ * @returns The loaded configuration and metadata
+ */
+export async function loadConfig(rootDir) {
+    const cwd = rootDir ?? process.cwd();
+    for (const ext of CONFIG_EXTENSIONS) {
+        const fileName = `${CONFIG_NAME}.${ext}`;
+        const filePath = path.join(cwd, fileName);
+        if (existsSync(filePath)) {
+            try {
+                const fileUrl = pathToFileURL(filePath).href;
+                const mod = (await import(fileUrl));
+                const config = mod.default ??
+                    mod;
+                return {
+                    config,
+                    configFile: filePath,
+                };
+            }
+            catch (error) {
+                throw new Error(`Failed to load config file ${filePath}: ${String(error)}`);
+            }
+        }
+    }
+    return {
+        // not great, but meant to match the c12 api since that is what was used in
+        // the initial implementation of loadConfig
+        // this can be easily refactored later
+        config: {},
+        configFile: undefined, // no config found
+    };
+}
+//# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../config.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAiBzC;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,MAA0B;IACrD,OAAO,MAAM,CAAC;AAChB,CAAC;AAOD,MAAM,WAAW,GAAG,qBAAqB,CAAC;AAC1C,MAAM,iBAAiB,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAU,CAAC;AAExD;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,OAAgB;IAC/C,MAAM,GAAG,GAAG,OAAO,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;IAErC,KAAK,MAAM,GAAG,IAAI,iBAAiB,EAAE,CAAC;QACpC,MAAM,QAAQ,GAAG,GAAG,WAAW,IAAI,GAAG,EAAE,CAAC;QACzC,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;QAE1C,IAAI,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YACzB,IAAI,CAAC;gBACH,MAAM,OAAO,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC;gBAE7C,MAAM,GAAG,GAAG,CAAC,MAAM,MAAM,CAAC,OAAO,CAAC,CAEZ,CAAC;gBACvB,MAAM,MAAM,GACT,GAAwC,CAAC,OAAO;oBAChD,GAA0B,CAAC;gBAE9B,OAAO;oBACL,MAAM;oBACN,UAAU,EAAE,QAAQ;iBACrB,CAAC;YACJ,CAAC;YAAC,OAAO,KAAc,EAAE,CAAC;gBACxB,MAAM,IAAI,KAAK,CACb,8BAA8B,QAAQ,KAAK,MAAM,CAAC,KAAK,CAAC,EAAE,CAC3D,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO;QACL,2EAA2E;QAC3E,2CAA2C;QAC3C,sCAAsC;QACtC,MAAM,EAAE,EAAmC;QAC3C,UAAU,EAAE,SAAS,EAAE,kBAAkB;KAC1C,CAAC;AACJ,CAAC"}

package/dist/{duration.d.ts → core/duration.d.ts}

@@ -1,3 +1,4 @@
+import type { Result } from "./result.js";
 type Years = "years" | "year" | "yrs" | "yr" | "y";
 type Months = "months" | "month" | "mo";
 type Weeks = "weeks" | "week" | "w";
@@ -10,10 +11,12 @@ type Unit = Years | Months | Weeks | Days | Hours | Minutes | Seconds | Millisec
 type UnitAnyCase = Capitalize<Unit> | Uppercase<Unit> | Lowercase<Unit>;
 export type DurationString = `${number}` | `${number}${UnitAnyCase}` | `${number} ${UnitAnyCase}`;
 /**
- * Parse a duration string into milliseconds. Exmaples:
+ * Parse a duration string into milliseconds. Examples:
  * - short units: "1ms", "5s", "30m", "2h", "7d", "3w", "1y"
  * - long units: "1 millisecond", "5 seconds", "30 minutes", "2 hours", "7 days", "3 weeks", "1 year"
+ * @param str - Duration string
+ * @returns Milliseconds
  */
-export declare function parseDuration(str: DurationString): number;
+export declare function parseDuration(str: DurationString): Result<number>;
 export {};
 //# sourceMappingURL=duration.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"duration.d.ts","sourceRoot":"","sources":["../../core/duration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAG1C,KAAK,KAAK,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,GAAG,IAAI,GAAG,GAAG,CAAC;AACnD,KAAK,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,IAAI,CAAC;AACxC,KAAK,KAAK,GAAG,OAAO,GAAG,MAAM,GAAG,GAAG,CAAC;AACpC,KAAK,IAAI,GAAG,MAAM,GAAG,KAAK,GAAG,GAAG,CAAC;AACjC,KAAK,KAAK,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,GAAG,IAAI,GAAG,GAAG,CAAC;AACnD,KAAK,OAAO,GAAG,SAAS,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK,GAAG,GAAG,CAAC;AAC3D,KAAK,OAAO,GAAG,SAAS,GAAG,QAAQ,GAAG,MAAM,GAAG,KAAK,GAAG,GAAG,CAAC;AAC3D,KAAK,YAAY,GAAG,cAAc,GAAG,aAAa,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,CAAC;AAC7E,KAAK,IAAI,GACL,KAAK,GACL,MAAM,GACN,KAAK,GACL,IAAI,GACJ,KAAK,GACL,OAAO,GACP,OAAO,GACP,YAAY,CAAC;AACjB,KAAK,WAAW,GAAG,UAAU,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;AACxE,MAAM,MAAM,cAAc,GACtB,GAAG,MAAM,EAAE,GACX,GAAG,MAAM,GAAG,WAAW,EAAE,GACzB,GAAG,MAAM,IAAI,WAAW,EAAE,CAAC;AAE/B;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,CAiEjE"}

package/dist/{duration.js → core/duration.js}

@@ -1,18 +1,21 @@
+import { ok, err } from "./result.js";
 /**
- * Parse a duration string into milliseconds. Exmaples:
+ * Parse a duration string into milliseconds. Examples:
  * - short units: "1ms", "5s", "30m", "2h", "7d", "3w", "1y"
  * - long units: "1 millisecond", "5 seconds", "30 minutes", "2 hours", "7 days", "3 weeks", "1 year"
+ * @param str - Duration string
+ * @returns Milliseconds
  */
 export function parseDuration(str) {
     if (typeof str !== "string") {
-        throw new TypeError("Invalid duration format: expected a string but received " + typeof str);
+        return err(new TypeError("Invalid duration format: expected a string but received " + typeof str));
     }
     if (str.length === 0) {
-        throw new Error('Invalid duration format: ""');
+        return err(new Error('Invalid duration format: ""'));
     }
     const match = /^(-?\.?\d+(?:\.\d+)?)\s*([a-z]+)?$/i.exec(str);
     if (!match?.[1]) {
-        throw new Error(`Invalid duration format: "${str}"`);
+        return err(new Error(`Invalid duration format: "${str}"`));
     }
     const numValue = Number.parseFloat(match[1]);
     const unit = match[2]?.toLowerCase() ?? "ms"; // default to ms if not provided
@@ -54,8 +57,8 @@ export function parseDuration(str) {
     };
     const multiplier = multipliers[unit];
     if (multiplier === undefined) {
-        throw new Error(`Invalid duration format: "${str}"`);
+        return err(new Error(`Invalid duration format: "${str}"`));
     }
-    return numValue * multiplier;
+    return ok(numValue * multiplier);
 }
 //# sourceMappingURL=duration.js.map

package/dist/core/duration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"duration.js","sourceRoot":"","sources":["../../core/duration.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,EAAE,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AAyBtC;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAAC,GAAmB;IAC/C,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC5B,OAAO,GAAG,CACR,IAAI,SAAS,CACX,0DAA0D,GAAG,OAAO,GAAG,CACxE,CACF,CAAC;IACJ,CAAC;IAED,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACrB,OAAO,GAAG,CAAC,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC,CAAC;IACvD,CAAC;IAED,MAAM,KAAK,GAAG,qCAAqC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAE9D,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAChB,OAAO,GAAG,CAAC,IAAI,KAAK,CAAC,6BAA6B,GAAG,GAAG,CAAC,CAAC,CAAC;IAC7D,CAAC;IAED,MAAM,QAAQ,GAAG,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7C,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,IAAI,IAAI,CAAC,CAAC,gCAAgC;IAE9E,MAAM,WAAW,GAA2B;QAC1C,WAAW,EAAE,CAAC;QACd,YAAY,EAAE,CAAC;QACf,IAAI,EAAE,CAAC;QACP,KAAK,EAAE,CAAC;QACR,EAAE,EAAE,CAAC;QACL,MAAM,EAAE,IAAI;QACZ,OAAO,EAAE,IAAI;QACb,GAAG,EAAE,IAAI;QACT,IAAI,EAAE,IAAI;QACV,CAAC,EAAE,IAAI;QACP,MAAM,EAAE,EAAE,GAAG,IAAI;QACjB,OAAO,EAAE,EAAE,GAAG,IAAI;QAClB,GAAG,EAAE,EAAE,GAAG,IAAI;QACd,IAAI,EAAE,EAAE,GAAG,IAAI;QACf,CAAC,EAAE,EAAE,GAAG,IAAI;QACZ,IAAI,EAAE,EAAE,GAAG,EAAE,GAAG,IAAI;QACpB,KAAK,EAAE,EAAE,GAAG,EAAE,GAAG,IAAI;QACrB,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,IAAI;QAClB,GAAG,EAAE,EAAE,GAAG,EAAE,GAAG,IAAI;QACnB,CAAC,EAAE,EAAE,GAAG,EAAE,GAAG,IAAI;QACjB,GAAG,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI;QACxB,IAAI,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI;QACzB,CAAC,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI;QACtB,IAAI,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI;QAC7B,KAAK,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI;QAC9B,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI;QAC1B,KAAK,EAAE,aAAa;QACpB,MAAM,EAAE,aAAa;QACrB,EAAE,EAAE,aAAa;QACjB,IAAI,EAAE,cAAc;QACpB,KAAK,EAAE,cAAc;QACrB,EAAE,EAAE,cAAc;QAClB,GAAG,EAAE,cAAc;QACnB,CAAC,EAAE,cAAc;KAClB,CAAC;IAEF,MAAM,UAAU,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IACrC,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC7B,OAAO,GAAG,CAAC,IAAI,KAAK,CAAC,6BAA6B,GAAG,GAAG,CAAC,CAAC,CAAC;IAC7D,CAAC;IAED,OAAO,EAAE,CAAC,QAAQ,GAAG,UAAU,CAAC,CAAC;AACnC,CAAC"}

package/dist/core/error.d.ts

@@ -0,0 +1,14 @@
+import type { JsonValue } from "./json.js";
+export interface SerializedError {
+    name?: string;
+    message: string;
+    stack?: string;
+    [key: string]: JsonValue;
+}
+/**
+ * Serialize an error to a JSON-compatible format.
+ * @param error - The error to serialize (can be Error instance or any value)
+ * @returns A JSON-serializable error object
+ */
+export declare function serializeError(error: unknown): SerializedError;
+//# sourceMappingURL=error.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../core/error.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAE3C,MAAM,WAAW,eAAe;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;CAC1B;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,eAAe,CAc9D"}

package/dist/core/error.js

@@ -0,0 +1,18 @@
+/**
+ * Serialize an error to a JSON-compatible format.
+ * @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) {
+        const { name, message, stack } = error;
+        if (stack) {
+            return { name, message, stack };
+        }
+        return { name, message };
+    }
+    return {
+        message: String(error),
+    };
+}
+//# sourceMappingURL=error.js.map

package/dist/core/error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../../core/error.ts"],"names":[],"mappings":"AASA;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,KAAc;IAC3C,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;QAC3B,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC;QAEvC,IAAI,KAAK,EAAE,CAAC;YACV,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;QAClC,CAAC;QAED,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;IAC3B,CAAC;IAED,OAAO;QACL,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC;KACvB,CAAC;AACJ,CAAC"}