@sonamu-kit/tasks 0.2.0 → 0.3.0

package/dist/client.d.ts

@@ -1,99 +1,101 @@
-import type { Backend } from "./backend";
-import type { StandardSchemaV1 } from "./core/schema";
-import type { SchemaInput, SchemaOutput, WorkflowRun } from "./core/workflow";
-import type { WorkflowFunction } from "./execution";
-import { Worker } from "./worker";
-import { defineWorkflowSpec, type Workflow, type WorkflowSpec } from "./workflow";
+import { StandardSchemaV1 } from "./core/schema.js";
+import { SchemaInput, SchemaOutput, WorkflowRun } from "./core/workflow.js";
+import { Backend } from "./backend.js";
+import { WorkflowFunction } from "./execution.js";
+import { Workflow, WorkflowSpec, defineWorkflowSpec } from "./workflow.js";
+import { Worker } from "./worker.js";
+
+//#region src/client.d.ts
 type WorkflowHandlerInput<TSchema, Input> = SchemaOutput<TSchema, Input>;
 type WorkflowRunInput<TSchema, Input> = SchemaInput<TSchema, Input>;
 /**
  * Options for the OpenWorkflow client.
  */
-export interface OpenWorkflowOptions {
-    backend: Backend;
+interface OpenWorkflowOptions {
+  backend: Backend;
 }
 /**
  * Client used to register workflows and start runs.
  */
-export declare class OpenWorkflow {
-    private backend;
-    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 | undefined;
-        usePubSub?: boolean;
-        listenDelay?: number;
-    }): 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.
-     * @param spec - Workflow spec
-     * @param fn - Workflow implementation
-     */
-    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.
-     * @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();
-     * ```
-     */
-    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.
-     * @param config - Workflow config
-     * @param fn - Workflow implementation
-     * @returns Runnable workflow
-     * @example
-     * ```ts
-     * const workflow = ow.defineWorkflow(
-     *   { name: 'my-workflow' },
-     *   async ({ input, step }) => {
-     *     // workflow implementation
-     *   },
-     * );
-     * ```
-     */
-    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>>;
-    /**
-     * Unregister a workflow from the registry.
-     * @param name - The workflow name
-     * @param version - The workflow version (null for unversioned)
-     * @example
-     * ```ts
-     * ow.unregisterWorkflow("my-workflow", "v1");
-     * ```
-     */
-    unregisterWorkflow(name: string, version: string | null): void;
-    /**
-     * Check if a workflow is registered in the registry.
-     * @param name - The workflow name
-     * @param version - The workflow version (null for unversioned)
-     * @returns True if the workflow is registered, false otherwise
-     * @example
-     * ```ts
-     * ow.isWorkflowRegistered("my-workflow", "v1");
-     * ```
-     */
-    isWorkflowRegistered(name: string, version: string | null): boolean;
+declare class OpenWorkflow {
+  private backend;
+  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 | undefined;
+    usePubSub?: boolean;
+    listenDelay?: number;
+  }): 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.
+   * @param spec - Workflow spec
+   * @param fn - Workflow implementation
+   */
+  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.
+   * @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();
+   * ```
+   */
+  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.
+   * @param config - Workflow config
+   * @param fn - Workflow implementation
+   * @returns Runnable workflow
+   * @example
+   * ```ts
+   * const workflow = ow.defineWorkflow(
+   *   { name: 'my-workflow' },
+   *   async ({ input, step }) => {
+   *     // workflow implementation
+   *   },
+   * );
+   * ```
+   */
+  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>>;
+  /**
+   * Unregister a workflow from the registry.
+   * @param name - The workflow name
+   * @param version - The workflow version (null for unversioned)
+   * @example
+   * ```ts
+   * ow.unregisterWorkflow("my-workflow", "v1");
+   * ```
+   */
+  unregisterWorkflow(name: string, version: string | null): void;
+  /**
+   * Check if a workflow is registered in the registry.
+   * @param name - The workflow name
+   * @param version - The workflow version (null for unversioned)
+   * @returns True if the workflow is registered, false otherwise
+   * @example
+   * ```ts
+   * ow.isWorkflowRegistered("my-workflow", "v1");
+   * ```
+   */
+  isWorkflowRegistered(name: string, version: string | null): boolean;
 }
 /**
  * Declare a workflow without providing its implementation (which is provided
@@ -109,69 +111,80 @@ export declare class OpenWorkflow {
  * });
  * ```
  */
-export declare const declareWorkflow: typeof defineWorkflowSpec;
+declare const declareWorkflow: typeof defineWorkflowSpec;
 /**
  * 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 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>>;
+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>>;
 }
 /**
  * Options for creating a new workflow run from a runnable workflow when calling
  * `workflow.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;
-    /**
-     * Publish when the workflow run is created to the channel.
-     * Default: true
-     */
-    publishToChannel?: boolean;
+interface WorkflowRunOptions {
+  /**
+   * Set a deadline for the workflow run. If the workflow exceeds this deadline,
+   * it will be marked as failed.
+   */
+  deadlineAt?: Date;
+  /**
+   * Publish when the workflow run is created to the channel.
+   * Default: true
+   */
+  publishToChannel?: boolean;
 }
 /**
  * Options for WorkflowHandle.
  */
-export interface WorkflowHandleOptions {
-    backend: Backend;
-    workflowRun: WorkflowRun;
-    resultPollIntervalMs: number;
-    resultTimeoutMs: number;
+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.
-     * @returns Workflow output
-     */
-    result(): Promise<Output>;
-    /**
-     * Cancels the workflow run. Only workflows in pending, running, or sleeping
-     * status can be canceled.
-     */
-    cancel(): Promise<void>;
+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.
+   * @returns Workflow output
+   */
+  result(): Promise<Output>;
+  /**
+   * Cancels the workflow run. Only workflows in pending, running, sleeping,
+   * or paused status can be canceled.
+   */
+  cancel(): Promise<void>;
+  /**
+   * Pauses the workflow run. Only workflows in pending, running, or sleeping
+   * status can be paused.
+   */
+  pause(): Promise<void>;
+  /**
+   * Resumes a paused workflow run. Sets the status back to pending so that
+   * a worker can reclaim it.
+   */
+  resume(): Promise<void>;
 }
-export {};
+//#endregion
+export { OpenWorkflow, OpenWorkflowOptions, RunnableWorkflow, WorkflowHandleOptions, WorkflowRunHandle, WorkflowRunOptions, declareWorkflow };
 //# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACtD,OAAO,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAE9E,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAEpD,OAAO,EAAE,MAAM,EAAsB,MAAM,UAAU,CAAC;AACtD,OAAO,EAAkB,kBAAkB,EAAE,KAAK,QAAQ,EAAE,KAAK,YAAY,EAAE,MAAM,YAAY,CAAC;AAMlG,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;QAClB,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QACjC,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,GAAG,MAAM;IAUV;;;;;;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;IAKP;;;;;;;;;;;;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;IA8BrC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,SAAS,gBAAgB,GAAG,SAAS,GAAG,SAAS,EACpF,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;IAMD;;;;;;;;OAQG;IACH,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI;IAI9D;;;;;;;;;OASG;IACH,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO;CAGpE;AAED;;;;;;;;;;;;;GAaG;AAGH,eAAO,MAAM,eAAe,2BAAqB,CAAC;AAMlD;;;;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,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;CAG9F;AAMD;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,UAAU,CAAC,EAAE,IAAI,CAAC;IAElB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;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;;;OAGG;IACG,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC;IAsC/B;;;OAGG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CAK9B"}
+{"version":3,"file":"client.d.ts","names":[],"sources":["../src/client.ts"],"sourcesContent":[],"mappings":";;;;;;;;KAgBK,uCAAuC,aAAa,SAAS;AANJ,KASzD,gBAHA,CAAA,OAAoB,EAAA,KAAA,CAAA,GAGe,WAHf,CAG2B,OAH3B,EAGoC,KAHpC,CAAA;;;;AAAmB,UAQ3B,mBAAA,CAR2B;EAAY,OAAA,EAS7C,OAT6C;AAAA;;;;AAGhB,cAY3B,YAAA,CAZ2B;EAAW,QAAA,OAAA;EAKlC,QAAA,QAAA;EAOJ,WAAA,CAAA,OAAY,EAIF,mBAJE;EAAA;;;;;;WAoCa,CAAA,QAAA,EAAA;IAA5B,WAAA,CAAA,EAAA,MAAA,GAAA,SAAA;IACe,SAAA,CAAA,EAAA,OAAA;IAAO,WAAA,CAAA,EAAA,MAAA;MAnB1B,MAmBE;;;;;;;;mBAuBuB,CAAA,KAAA,EAAA,MAAA,EAAA,WAzBe,KAyBf,CAAA,CAAA,IAAA,EAxBrB,YAwBqB,CAxBR,KAwBQ,EAxBD,MAwBC,EAxBO,QAwBP,CAAA,EAAA,EAAA,EAvBvB,gBAuBuB,CAvBN,KAuBM,EAvBC,MAuBD,CAAA,CAAA,EAAA,IAAA;;;;;;;;;;;;;;aAwDN,CAAA,KAAA,EAAA,MAAA,EAAA,WA5DqB,KA4DrB,CAAA,CAAA,IAAA,EA3Df,YA2De,CA3DF,KA2DE,EA3DK,MA2DL,EA3Da,QA2Db,CAAA,EAAA,KAAA,CAAA,EA1Db,QA0Da,EAAA,OAAA,CAAA,EAzDX,kBAyDW,CAAA,EAxDpB,OAwDoB,CAxDZ,iBAwDY,CAxDM,MAwDN,CAAA,CAAA;;;;;;;;;;;;AAuDzB;AAWA;;;;;;;;gBAImD,CAAA,KAAA,EAAA,MAAA,EAAA,gBA5EH,gBA4EG,GAAA,SAAA,GAAA,SAAA,CAAA,CAAA,IAAA,EA3EzC,YA2EyC,CA1E7C,oBA0E6C,CA1ExB,OA0EwB,EA1Ef,KA0Ee,CAAA,EAzE7C,MAyE6C,EAxE7C,gBAwE6C,CAxE5B,OAwE4B,EAxEnB,KAwEmB,CAAA,CAAA,EAAA,EAAA,EAtE3C,gBAsE2C,CAtE1B,oBAsE0B,CAtEL,OAsEK,EAtEI,KAsEJ,CAAA,EAtEY,MAsEZ,CAAA,CAAA,EArE9C,gBAqE8C,CApE/C,oBAoE+C,CApE1B,OAoE0B,EApEjB,KAoEiB,CAAA,EAnE/C,MAmE+C,EAlE/C,gBAkE+C,CAlE9B,OAkE8B,EAlErB,KAkEqB,CAAA,CAAA;;;;;;;;;;EAwBlC,kBAAA,CAAA,IAAkB,EAAA,MAAA,EAKpB,OAAI,EAAA,MAAA,GAAA,IAAA,CAAA,EAAA,IAAA;EAYF;;;;;AAWjB;;;;;sBAiBkB,CAAA,IAAA,EAAA,MAAA,EAAA,OAAA,EAAA,MAAA,GAAA,IAAA,CAAA,EAAA,OAAA;;;;;;;;;;;;;;;;cApFL,wBAAe;;;;;;cAWf,2CAA2C;;qBAEnC,SAAS,OAAO,QAAQ;kBAE3B,wBAAwB,SAAS,OAAO,QAAQ;;;;;;;cAW9C,oBAAoB,qBAAqB,QAAQ,kBAAkB;;;;;;UAatE,kBAAA;;;;;eAKF;;;;;;;;;;UAYE,qBAAA;WACN;eACI;;;;;;;;cASF;;wBAEW;;;uBAID;;;;;YAWL,QAAQ;;;;;YA0CR;;;;;WAUD;;;;;YAUC"}