openworkflow 0.4.0 → 0.4.1

package/dist/global.d.ts

@@ -0,0 +1,62 @@
+import type { OpenWorkflow } from "./sdk/sdk.js";
+/**
+ * Get the global OpenWorkflow client instance.
+ * This function lazily loads the configuration file and creates a singleton
+ * instance on first access.
+ *
+ * The global client is useful for:
+ * - Zero-config DX where you want a single shared client
+ * - CLI tools that need to access the configured client
+ * - Testing scenarios where you can override the client with setGlobalClient()
+ *
+ * Note: This function requires Node.js and will only work in Node environments.
+ * For non-Node environments (browser, edge), create OpenWorkflow instances manually.
+ *
+ * @returns The global OpenWorkflow client instance
+ * @throws Error if config file is not found or invalid
+ *
+ * @example
+ * ```typescript
+ * import { getGlobalClient } from 'openworkflow';
+ *
+ * const ow = await getGlobalClient();
+ * await ow.run(myWorkflow, { input: 'data' });
+ * ```
+ */
+export declare function getGlobalClient(): Promise<OpenWorkflow>;
+/**
+ * Set the global OpenWorkflow client instance.
+ * This is primarily useful for testing scenarios where you want to override
+ * the default client with a mock or test instance.
+ *
+ * @param client - The OpenWorkflow instance to set as the global client
+ *
+ * @example
+ * ```typescript
+ * import { setGlobalClient, OpenWorkflow } from 'openworkflow';
+ * import { BackendSqlite } from '@openworkflow/backend-sqlite';
+ *
+ * // In tests
+ * const testClient = new OpenWorkflow({
+ *   backend: BackendSqlite.connect(':memory:')
+ * });
+ * setGlobalClient(testClient);
+ * ```
+ */
+export declare function setGlobalClient(client: OpenWorkflow): void;
+/**
+ * Reset the global client to null.
+ * This is primarily useful for testing to ensure a clean state between tests.
+ *
+ * @example
+ * ```typescript
+ * import { resetGlobalClient } from 'openworkflow';
+ *
+ * // In test cleanup
+ * afterEach(() => {
+ *   resetGlobalClient();
+ * });
+ * ```
+ */
+export declare function resetGlobalClient(): void;
+//# sourceMappingURL=global.d.ts.map

package/dist/global.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"global.d.ts","sourceRoot":"","sources":["../global.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AASjD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAsB,eAAe,IAAI,OAAO,CAAC,YAAY,CAAC,CAQ7D;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAE1D;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,iBAAiB,IAAI,IAAI,CAExC"}

package/dist/global.js

@@ -0,0 +1,78 @@
+import { loadConfig } from "./config.js";
+/**
+ * Global singleton OpenWorkflow client instance.
+ * This is lazily initialized when getGlobalClient() is first called.
+ */
+let globalClient = null;
+/**
+ * Get the global OpenWorkflow client instance.
+ * This function lazily loads the configuration file and creates a singleton
+ * instance on first access.
+ *
+ * The global client is useful for:
+ * - Zero-config DX where you want a single shared client
+ * - CLI tools that need to access the configured client
+ * - Testing scenarios where you can override the client with setGlobalClient()
+ *
+ * Note: This function requires Node.js and will only work in Node environments.
+ * For non-Node environments (browser, edge), create OpenWorkflow instances manually.
+ *
+ * @returns The global OpenWorkflow client instance
+ * @throws Error if config file is not found or invalid
+ *
+ * @example
+ * ```typescript
+ * import { getGlobalClient } from 'openworkflow';
+ *
+ * const ow = await getGlobalClient();
+ * await ow.run(myWorkflow, { input: 'data' });
+ * ```
+ */
+export async function getGlobalClient() {
+    if (globalClient) {
+        return globalClient;
+    }
+    const config = await loadConfig();
+    globalClient = config.ow;
+    return globalClient;
+}
+/**
+ * Set the global OpenWorkflow client instance.
+ * This is primarily useful for testing scenarios where you want to override
+ * the default client with a mock or test instance.
+ *
+ * @param client - The OpenWorkflow instance to set as the global client
+ *
+ * @example
+ * ```typescript
+ * import { setGlobalClient, OpenWorkflow } from 'openworkflow';
+ * import { BackendSqlite } from '@openworkflow/backend-sqlite';
+ *
+ * // In tests
+ * const testClient = new OpenWorkflow({
+ *   backend: BackendSqlite.connect(':memory:')
+ * });
+ * setGlobalClient(testClient);
+ * ```
+ */
+export function setGlobalClient(client) {
+    globalClient = client;
+}
+/**
+ * Reset the global client to null.
+ * This is primarily useful for testing to ensure a clean state between tests.
+ *
+ * @example
+ * ```typescript
+ * import { resetGlobalClient } from 'openworkflow';
+ *
+ * // In test cleanup
+ * afterEach(() => {
+ *   resetGlobalClient();
+ * });
+ * ```
+ */
+export function resetGlobalClient() {
+    globalClient = null;
+}
+//# sourceMappingURL=global.js.map

package/dist/global.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"global.js","sourceRoot":"","sources":["../global.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEzC;;;GAGG;AACH,IAAI,YAAY,GAAwB,IAAI,CAAC;AAE7C;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe;IACnC,IAAI,YAAY,EAAE,CAAC;QACjB,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,UAAU,EAAE,CAAC;IAClC,YAAY,GAAG,MAAM,CAAC,EAAE,CAAC;IACzB,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,eAAe,CAAC,MAAoB;IAClD,YAAY,GAAG,MAAM,CAAC;AACxB,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,iBAAiB;IAC/B,YAAY,GAAG,IAAI,CAAC;AACtB,CAAC"}

package/dist/index.d.ts

@@ -1,6 +1,10 @@
-export type { OpenWorkflowOptions } from "./client.js";
-export { OpenWorkflow } from "./client.js";
-export * from "./backend.js";
-export type { WorkerOptions } from "./worker.js";
-export { Worker } from "./worker.js";
+export type { OpenWorkflowOptions } from "./sdk/sdk.js";
+export { OpenWorkflow, declareWorkflow } from "./sdk/sdk.js";
+export type { WorkerOptions } from "./worker/worker.js";
+export { Worker } from "./worker/worker.js";
+export * from "./core/backend.js";
+export type { JsonValue } from "./core/json.js";
+export type { WorkflowRun } from "./core/workflow.js";
+export type { StepAttempt } from "./core/step.js";
+export { DEFAULT_RETRY_POLICY } from "./core/retry.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAE3C,cAAc,cAAc,CAAC;AAE7B,YAAY,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAE7D,YAAY,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAE5C,cAAc,mBAAmB,CAAC;AAClC,YAAY,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAChD,YAAY,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtD,YAAY,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC"}

package/dist/index.js

@@ -1,4 +1,5 @@
-export { OpenWorkflow } from "./client.js";
-export * from "./backend.js";
-export { Worker } from "./worker.js";
+export { OpenWorkflow, declareWorkflow } from "./sdk/sdk.js";
+export { Worker } from "./worker/worker.js";
+export * from "./core/backend.js";
+export { DEFAULT_RETRY_POLICY } from "./core/retry.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAE3C,cAAc,cAAc,CAAC;AAG7B,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAG7D,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAE5C,cAAc,mBAAmB,CAAC;AAIlC,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC"}

package/dist/sdk/sdk.d.ts

@@ -0,0 +1,182 @@
+import type { Backend } from "../core/backend.js";
+import type { StandardSchemaV1 } from "../core/schema.js";
+import type { WorkflowRun } from "../core/workflow.js";
+import type { SchemaInput, SchemaOutput } from "../core/workflow.js";
+import type { WorkflowFunction } from "../execution/execution.js";
+import { Worker } from "../worker/worker.js";
+type WorkflowHandlerInput<TSchema, Input> = SchemaOutput<TSchema, Input>;
+type WorkflowRunInput<TSchema, Input> = SchemaInput<TSchema, Input>;
+/**
+ * Options for the OpenWorkflow client.
+ */
+export interface OpenWorkflowOptions {
+    backend: Backend;
+}
+/**
+ * Client used to register workflows and start runs.
+ */
+export declare class OpenWorkflow {
+    private backend;
+    private registeredWorkflows;
+    constructor(options: OpenWorkflowOptions);
+    /**
+     * Create a new Worker with this client's backend and workflows.
+     */
+    newWorker(options?: {
+        concurrency?: number | undefined;
+    }): Worker;
+    /**
+     * 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.
+     */
+    implementWorkflow<Input, Output, RunInput = Input>(spec: WorkflowSpec<Input, Output, RunInput>, fn: WorkflowFunction<Input, Output>): void;
+    /**
+     * Run a workflow from its specification. This is the primary way to schedule
+     * a workflow using only its WorkflowSpec.
+     *
+     * @example
+     * ```ts
+     * const handle = await ow.runWorkflow(emailWorkflow, { to: 'user@example.com' });
+     * const result = await handle.result();
+     * ```
+     */
+    runWorkflow<Input, Output, RunInput = Input>(spec: WorkflowSpec<Input, Output, RunInput>, input?: RunInput, options?: WorkflowRunOptions): Promise<WorkflowRunHandle<Output>>;
+    /**
+     * Define and register a new workflow.
+     *
+     * This is a convenience method that combines `declareWorkflow` and
+     * `implementWorkflow` into a single call. For better code splitting and to
+     * separate declaration from implementation, consider using those methods
+     * separately.
+     *
+     * @example
+     * ```ts
+     * const workflow = ow.defineWorkflow(
+     *   { name: 'my-workflow' },
+     *   async ({ input, step }) => {
+     *     // workflow implementation
+     *   },
+     * );
+     * ```
+     */
+    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>>;
+}
+/**
+ * Declare a workflow without providing its implementation (which is provided
+ * separately via `implementWorkflow`). Returns a lightweight WorkflowSpec
+ * that can be used to schedule workflow runs.
+ *
+ * @example
+ * ```ts
+ * export const emailWorkflow = declareWorkflow({
+ *   name: 'send-email',
+ *   schema: z.object({ to: z.string().email() }),
+ * });
+ * ```
+ */
+export declare function declareWorkflow<Input, Output, TSchema extends StandardSchemaV1 | undefined = undefined>(config: WorkflowDefinitionConfig<TSchema>): WorkflowSpec<WorkflowHandlerInput<TSchema, Input>, Output, WorkflowRunInput<TSchema, Input>>;
+/**
+ * Generate a composite key for workflow registration that includes both name
+ * and version.
+ *
+ * @param name - The workflow name
+ * @param version - The workflow version (null for unversioned)
+ * @returns A composite key string
+ */
+export declare function getWorkflowKey(name: string, version: string | null): string;
+/**
+ * Config for declaring a workflow via `declareWorkflow()` or
+ * `defineWorkflow()`.
+ */
+export interface WorkflowDefinitionConfig<TSchema extends StandardSchemaV1 | undefined = undefined> {
+    /**
+     * The name of the workflow.
+     */
+    name: string;
+    /**
+     * Optional version string for the workflow. Use this to enable zero-downtime
+     * deployments when changing workflow logic.
+     */
+    version?: string;
+    /**
+     * Optional schema used to validate inputs passed to `.run()`.
+     */
+    schema?: TSchema;
+}
+/**
+ * A lightweight, serializable specification for a workflow. This object can be
+ * shared between different parts of an application (e.g., API servers and
+ * workers) without bringing in implementation dependencies.
+ *
+ * Use `declareWorkflow()` to create a WorkflowSpec, and `ow.runWorkflow()`
+ * to schedule runs using only the spec.
+ */
+export interface WorkflowSpec<Input, Output, RunInput = Input> {
+    /** The name of the workflow. */
+    name: string;
+    /** The version of the workflow, or null if unversioned. */
+    version: string | null;
+    /** The schema used to validate inputs, or null if none. */
+    schema: StandardSchemaV1<RunInput, Input> | null;
+    _input?: Input;
+    _output?: Output;
+    _runInput?: RunInput;
+}
+/**
+ * A fully defined workflow with its implementation. This class is returned by
+ * `defineWorkflow` and provides the `.run()` method for scheduling workflow
+ * runs.
+ */
+export declare class WorkflowDefinition<Input, Output, RunInput = Input> {
+    private readonly ow;
+    readonly spec: WorkflowSpec<Input, Output, RunInput>;
+    readonly fn: WorkflowFunction<Input, Output>;
+    constructor(ow: OpenWorkflow, spec: WorkflowSpec<Input, Output, RunInput>, fn: WorkflowFunction<Input, Output>);
+    /**
+     * Starts a new workflow run.
+     */
+    run(input?: RunInput, options?: WorkflowRunOptions): Promise<WorkflowRunHandle<Output>>;
+}
+/**
+ * Options for creating a new workflow run from a workflow definition when
+ * calling `workflowDef.run()`.
+ */
+export interface WorkflowRunOptions {
+    /**
+     * Set a deadline for the workflow run. If the workflow exceeds this deadline,
+     * it will be marked as failed.
+     */
+    deadlineAt?: Date;
+}
+/**
+ * Options for WorkflowHandle.
+ */
+export interface WorkflowHandleOptions {
+    backend: Backend;
+    workflowRun: WorkflowRun;
+    resultPollIntervalMs: number;
+    resultTimeoutMs: number;
+}
+/**
+ * Represents a started workflow run and provides methods to await its result.
+ * Returned from `workflowDef.run()`.
+ */
+export declare class WorkflowRunHandle<Output> {
+    private backend;
+    readonly workflowRun: WorkflowRun;
+    private resultPollIntervalMs;
+    private resultTimeoutMs;
+    constructor(options: WorkflowHandleOptions);
+    /**
+     * Waits for the workflow run to complete and returns the result.
+     */
+    result(): Promise<Output>;
+    /**
+     * Cancels the workflow run. Only workflows in pending, running, or sleeping
+     * status can be canceled.
+     */
+    cancel(): Promise<void>;
+}
+export {};
+//# sourceMappingURL=sdk.d.ts.map

package/dist/sdk/sdk.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sdk.d.ts","sourceRoot":"","sources":["../../sdk/sdk.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAC1D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAErE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAClE,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAM7C,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,GAAG,SAAS,CAAA;KAAE,GAAG,MAAM;IAQjE;;;;OAIG;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;IAqBP;;;;;;;;;OASG;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;;;;;;;;;;;;;;;;;OAiBG;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;CAcF;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,eAAe,CAC7B,KAAK,EACL,MAAM,EACN,OAAO,SAAS,gBAAgB,GAAG,SAAS,GAAG,SAAS,EAExD,MAAM,EAAE,wBAAwB,CAAC,OAAO,CAAC,GACxC,YAAY,CACb,oBAAoB,CAAC,OAAO,EAAE,KAAK,CAAC,EACpC,MAAM,EACN,gBAAgB,CAAC,OAAO,EAAE,KAAK,CAAC,CACjC,CAYA;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM,CAE3E;AAMD;;;GAGG;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;;;;;;;GAOG;AACH,MAAM,WAAW,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,GAAG,KAAK;IAC3D,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,2DAA2D;IAC3D,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,2DAA2D;IAC3D,MAAM,EAAE,gBAAgB,CAAC,QAAQ,EAAE,KAAK,CAAC,GAAG,IAAI,CAAC;IAGjD,MAAM,CAAC,EAAE,KAAK,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,QAAQ,CAAC;CACtB;AAMD;;;;GAIG;AACH,qBAAa,kBAAkB,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,GAAG,KAAK;IAC7D,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAe;IAClC,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IACrD,QAAQ,CAAC,EAAE,EAAE,gBAAgB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;gBAG3C,EAAE,EAAE,YAAY,EAChB,IAAI,EAAE,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,EAC3C,EAAE,EAAE,gBAAgB,CAAC,KAAK,EAAE,MAAM,CAAC;IAOrC;;OAEG;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;;;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"}

package/dist/sdk/sdk.js

@@ -0,0 +1,208 @@
+import { validateInput } from "../core/workflow.js";
+import { Worker } from "../worker/worker.js";
+const DEFAULT_RESULT_POLL_INTERVAL_MS = 1000; // 1s
+const DEFAULT_RESULT_TIMEOUT_MS = 5 * 60 * 1000; // 5m
+/**
+ * Client used to register workflows and start runs.
+ */
+export class OpenWorkflow {
+    backend;
+    registeredWorkflows = new Map();
+    constructor(options) {
+        this.backend = options.backend;
+    }
+    /**
+     * Create a new Worker with this client's backend and workflows.
+     */
+    newWorker(options) {
+        return new Worker({
+            backend: this.backend,
+            workflows: this.registeredWorkflows,
+            concurrency: options?.concurrency,
+        });
+    }
+    /**
+     * 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.
+     */
+    implementWorkflow(spec, fn) {
+        const key = getWorkflowKey(spec.name, spec.version);
+        if (this.registeredWorkflows.has(key)) {
+            const versionStr = spec.version ? ` (version: ${spec.version})` : "";
+            throw new Error(`Workflow "${spec.name}"${versionStr} is already registered`);
+        }
+        const definition = new WorkflowDefinition(this, spec, fn);
+        this.registeredWorkflows.set(key, definition);
+    }
+    /**
+     * Run a workflow from its specification. This is the primary way to schedule
+     * a workflow using only its WorkflowSpec.
+     *
+     * @example
+     * ```ts
+     * const handle = await ow.runWorkflow(emailWorkflow, { to: 'user@example.com' });
+     * const result = await handle.result();
+     * ```
+     */
+    async runWorkflow(spec, input, options) {
+        const validationResult = await validateInput(spec.schema, input);
+        if (!validationResult.success) {
+            throw new Error(validationResult.error);
+        }
+        const parsedInput = validationResult.value;
+        const workflowRun = await this.backend.createWorkflowRun({
+            workflowName: spec.name,
+            version: spec.version,
+            idempotencyKey: null,
+            config: {},
+            context: null,
+            input: parsedInput ?? null,
+            availableAt: null,
+            deadlineAt: options?.deadlineAt ?? null,
+        });
+        return new WorkflowRunHandle({
+            backend: this.backend,
+            workflowRun: workflowRun,
+            resultPollIntervalMs: DEFAULT_RESULT_POLL_INTERVAL_MS,
+            resultTimeoutMs: DEFAULT_RESULT_TIMEOUT_MS,
+        });
+    }
+    /**
+     * Define and register a new workflow.
+     *
+     * This is a convenience method that combines `declareWorkflow` and
+     * `implementWorkflow` into a single call. For better code splitting and to
+     * separate declaration from implementation, consider using those methods
+     * separately.
+     *
+     * @example
+     * ```ts
+     * const workflow = ow.defineWorkflow(
+     *   { name: 'my-workflow' },
+     *   async ({ input, step }) => {
+     *     // workflow implementation
+     *   },
+     * );
+     * ```
+     */
+    defineWorkflow(config, fn) {
+        const spec = declareWorkflow(config);
+        const key = getWorkflowKey(spec.name, spec.version);
+        const definition = new WorkflowDefinition(this, spec, fn);
+        this.registeredWorkflows.set(key, definition);
+        return definition;
+    }
+}
+/**
+ * Declare a workflow without providing its implementation (which is provided
+ * separately via `implementWorkflow`). Returns a lightweight WorkflowSpec
+ * that can be used to schedule workflow runs.
+ *
+ * @example
+ * ```ts
+ * export const emailWorkflow = declareWorkflow({
+ *   name: 'send-email',
+ *   schema: z.object({ to: z.string().email() }),
+ * });
+ * ```
+ */
+export function declareWorkflow(config) {
+    return {
+        name: config.name,
+        version: config.version ?? null,
+        schema: config.schema ?? null,
+    };
+}
+/**
+ * Generate a composite key for workflow registration that includes both name
+ * and version.
+ *
+ * @param name - The workflow name
+ * @param version - The workflow version (null for unversioned)
+ * @returns A composite key string
+ */
+export function getWorkflowKey(name, version) {
+    return version ? `${name}@${version}` : name;
+}
+//
+// --- Workflow Definition
+//
+/**
+ * A fully defined workflow with its implementation. This class is returned by
+ * `defineWorkflow` and provides the `.run()` method for scheduling workflow
+ * runs.
+ */
+export class WorkflowDefinition {
+    ow;
+    spec;
+    fn;
+    constructor(ow, spec, fn) {
+        this.ow = ow;
+        this.spec = spec;
+        this.fn = fn;
+    }
+    /**
+     * Starts a new workflow run.
+     */
+    async run(input, options) {
+        return this.ow.runWorkflow(this.spec, input, options);
+    }
+}
+/**
+ * Represents a started workflow run and provides methods to await its result.
+ * Returned from `workflowDef.run()`.
+ */
+export class WorkflowRunHandle {
+    backend;
+    workflowRun;
+    resultPollIntervalMs;
+    resultTimeoutMs;
+    constructor(options) {
+        this.backend = options.backend;
+        this.workflowRun = options.workflowRun;
+        this.resultPollIntervalMs = options.resultPollIntervalMs;
+        this.resultTimeoutMs = options.resultTimeoutMs;
+    }
+    /**
+     * Waits for the workflow run to complete and returns the result.
+     */
+    async result() {
+        const start = Date.now();
+        // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+        while (true) {
+            const latest = await this.backend.getWorkflowRun({
+                workflowRunId: this.workflowRun.id,
+            });
+            if (!latest) {
+                throw new Error(`Workflow run ${this.workflowRun.id} no longer exists`);
+            }
+            // 'succeeded' status is deprecated
+            if (latest.status === "succeeded" || latest.status === "completed") {
+                return latest.output;
+            }
+            if (latest.status === "failed") {
+                throw new Error(`Workflow ${this.workflowRun.workflowName} failed: ${JSON.stringify(latest.error)}`);
+            }
+            if (latest.status === "canceled") {
+                throw new Error(`Workflow ${this.workflowRun.workflowName} was canceled`);
+            }
+            if (Date.now() - start > this.resultTimeoutMs) {
+                throw new Error(`Timed out waiting for workflow run ${this.workflowRun.id} to finish`);
+            }
+            await new Promise((resolve) => {
+                setTimeout(resolve, this.resultPollIntervalMs);
+            });
+        }
+    }
+    /**
+     * Cancels the workflow run. Only workflows in pending, running, or sleeping
+     * status can be canceled.
+     */
+    async cancel() {
+        await this.backend.cancelWorkflowRun({
+            workflowRunId: this.workflowRun.id,
+        });
+    }
+}
+//# sourceMappingURL=sdk.js.map

package/dist/sdk/sdk.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sdk.js","sourceRoot":"","sources":["../../sdk/sdk.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAE7C,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,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,OAA8C;QACtD,OAAO,IAAI,MAAM,CAAC;YAChB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,SAAS,EAAE,IAAI,CAAC,mBAAmB;YACnC,WAAW,EAAE,OAAO,EAAE,WAAW;SAClC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,iBAAiB,CACf,IAA2C,EAC3C,EAAmC;QAEnC,MAAM,GAAG,GAAG,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACpD,IAAI,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YACtC,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,cAAc,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;YACrE,MAAM,IAAI,KAAK,CACb,aAAa,IAAI,CAAC,IAAI,IAAI,UAAU,wBAAwB,CAC7D,CAAC;QACJ,CAAC;QAED,MAAM,UAAU,GAAG,IAAI,kBAAkB,CACvC,IAAI,EACJ,IAAI,EACJ,EAAE,CACH,CAAC;QAEF,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAC1B,GAAG,EACH,UAA2D,CAC5D,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;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;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;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,cAAc,CAKZ,MAAyC,EACzC,EAAkE;QAMlE,MAAM,IAAI,GAAG,eAAe,CAAyB,MAAM,CAAC,CAAC;QAC7D,MAAM,GAAG,GAAG,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACpD,MAAM,UAAU,GAAG,IAAI,kBAAkB,CAIvC,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;QAClB,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAC1B,GAAG,EACH,UAA2D,CAC5D,CAAC;QACF,OAAO,UAAU,CAAC;IACpB,CAAC;CACF;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,eAAe,CAK7B,MAAyC;IAMzC,OAAO;QACL,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,OAAO,EAAE,MAAM,CAAC,OAAO,IAAI,IAAI;QAC/B,MAAM,EACH,MAAM,CAAC,MAKM,IAAI,IAAI;KACzB,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc,CAAC,IAAY,EAAE,OAAsB;IACjE,OAAO,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;AAC/C,CAAC;AAkDD,EAAE;AACF,0BAA0B;AAC1B,EAAE;AAEF;;;;GAIG;AACH,MAAM,OAAO,kBAAkB;IACZ,EAAE,CAAe;IACzB,IAAI,CAAwC;IAC5C,EAAE,CAAkC;IAE7C,YACE,EAAgB,EAChB,IAA2C,EAC3C,EAAmC;QAEnC,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;IACf,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,GAAG,CACP,KAAgB,EAChB,OAA4B;QAE5B,OAAO,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;CACF;AA4BD;;;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"}

package/dist/sdk/sdk.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=sdk.test.d.ts.map

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

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