@lunora/workflow 1.0.0-alpha.10 → 1.0.0-alpha.12

package/dist/do/index.d.mts

@@ -1,22 +1,22 @@
 import { WorkflowEntrypoint, WorkflowEvent, WorkflowStep } from 'cloudflare:workers';
-import { W as WorkflowDefinition } from "../packem_shared/types.d-C9W6rEWv.mjs";
+import { W as WorkflowDefinition } from "../packem_shared/types.d-DZlXmeGi.mjs";
 import '@lunora/values';
 /**
-* Base class for the generated `WorkflowEntrypoint` classes. Applies a
-* `defineWorkflow` definition onto Cloudflare's `WorkflowEntrypoint`: `run`
-* assembles the Lunora context (native `step`/`event` + the `ctx.run` function
-* dispatcher + a logger) and invokes the user's handler.
-*
-* Generated subclasses stay one line of behavior:
-*
-* ```ts
-* export class OrderPipelineWorkflow extends LunoraWorkflow {
-*     constructor(ctx: ExecutionContext, env: Record<string, unknown>) {
-*         super(ctx, env, orderPipeline, "orderPipeline");
-*     }
-* }
-* ```
-*/
+ * Base class for the generated `WorkflowEntrypoint` classes. Applies a
+ * `defineWorkflow` definition onto Cloudflare's `WorkflowEntrypoint`: `run`
+ * assembles the Lunora context (native `step`/`event` + the `ctx.run` function
+ * dispatcher + a logger) and invokes the user's handler.
+ *
+ * Generated subclasses stay one line of behavior:
+ *
+ * ```ts
+ * export class OrderPipelineWorkflow extends LunoraWorkflow {
+ *     constructor(ctx: ExecutionContext, env: Record<string, unknown>) {
+ *         super(ctx, env, orderPipeline, "orderPipeline");
+ *     }
+ * }
+ * ```
+ */
 declare class LunoraWorkflow<Params = Record<string, unknown>, Output = unknown> extends WorkflowEntrypoint<Record<string, unknown>, Params> {
   #private;
   constructor(context: ConstructorParameters<typeof WorkflowEntrypoint>[0], env: Record<string, unknown>, definition: WorkflowDefinition<Params, Output>, exportName?: string);

package/dist/do/index.d.ts

@@ -1,22 +1,22 @@
 import { WorkflowEntrypoint, WorkflowEvent, WorkflowStep } from 'cloudflare:workers';
-import { W as WorkflowDefinition } from "../packem_shared/types.d-C9W6rEWv.js";
+import { W as WorkflowDefinition } from "../packem_shared/types.d-DZlXmeGi.js";
 import '@lunora/values';
 /**
-* Base class for the generated `WorkflowEntrypoint` classes. Applies a
-* `defineWorkflow` definition onto Cloudflare's `WorkflowEntrypoint`: `run`
-* assembles the Lunora context (native `step`/`event` + the `ctx.run` function
-* dispatcher + a logger) and invokes the user's handler.
-*
-* Generated subclasses stay one line of behavior:
-*
-* ```ts
-* export class OrderPipelineWorkflow extends LunoraWorkflow {
-*     constructor(ctx: ExecutionContext, env: Record<string, unknown>) {
-*         super(ctx, env, orderPipeline, "orderPipeline");
-*     }
-* }
-* ```
-*/
+ * Base class for the generated `WorkflowEntrypoint` classes. Applies a
+ * `defineWorkflow` definition onto Cloudflare's `WorkflowEntrypoint`: `run`
+ * assembles the Lunora context (native `step`/`event` + the `ctx.run` function
+ * dispatcher + a logger) and invokes the user's handler.
+ *
+ * Generated subclasses stay one line of behavior:
+ *
+ * ```ts
+ * export class OrderPipelineWorkflow extends LunoraWorkflow {
+ *     constructor(ctx: ExecutionContext, env: Record<string, unknown>) {
+ *         super(ctx, env, orderPipeline, "orderPipeline");
+ *     }
+ * }
+ * ```
+ */
 declare class LunoraWorkflow<Params = Record<string, unknown>, Output = unknown> extends WorkflowEntrypoint<Record<string, unknown>, Params> {
   #private;
   constructor(context: ConstructorParameters<typeof WorkflowEntrypoint>[0], env: Record<string, unknown>, definition: WorkflowDefinition<Params, Output>, exportName?: string);

package/dist/index.d.mts

@@ -1,5 +1,5 @@
-import { a as Workflows, L as LunoraWorkflowsOptions, S as StepArgsValidator, b as StepConfig, c as StepDefinition, d as WorkflowConfig, W as WorkflowDefinition, e as WorkflowBranch, f as WorkflowInstanceStatus, g as WorkflowEventLike, h as WorkflowStepLike, i as WorkflowRunContext, j as WorkflowLogger, k as WorkflowRunFunction, l as WorkflowRunStepFunction } from "./packem_shared/types.d-C9W6rEWv.mjs";
-export type { A as ArgsOf, B as BranchCompensationParams, F as FunctionReference, I as InferStepArgs, R as RunFunctionOptions, m as RunStepOptions, n as StepHandler, o as StepRollbackContext, p as StepRollbackHandler, q as StepRunContext, r as WorkflowBindingLike, s as WorkflowBranchOutputs, t as WorkflowCreateOptions, u as WorkflowHandle, v as WorkflowHandler, w as WorkflowInstanceLike, x as WorkflowParallelFunction, y as WorkflowRollbackContextLike, z as WorkflowRollbackHandlerLike, C as WorkflowSpawnFunction, D as WorkflowSpawnOptions, E as WorkflowStatusResult, G as WorkflowStepConfigLike, H as WorkflowStepContextLike, J as WorkflowStepRollbackOptionsLike } from "./packem_shared/types.d-C9W6rEWv.mjs";
+import { a as Workflows, L as LunoraWorkflowsOptions, S as StepArgsValidator, b as StepConfig, c as StepDefinition, d as WorkflowConfig, W as WorkflowDefinition, e as WorkflowBranch, f as WorkflowInstanceStatus, g as WorkflowEventLike, h as WorkflowStepLike, i as WorkflowRunContext, j as WorkflowLogger, k as WorkflowRunFunction, l as WorkflowRunStepFunction } from "./packem_shared/types.d-DZlXmeGi.mjs";
+export type { A as ArgsOf, B as BranchCompensationParams, F as FunctionReference, I as InferStepArgs, R as RunFunctionOptions, m as RunStepOptions, n as StepHandler, o as StepRollbackContext, p as StepRollbackHandler, q as StepRunContext, r as WorkflowBindingLike, s as WorkflowBranchOutputs, t as WorkflowCreateOptions, u as WorkflowHandle, v as WorkflowHandler, w as WorkflowInstanceLike, x as WorkflowParallelFunction, y as WorkflowRollbackContextLike, z as WorkflowRollbackHandlerLike, C as WorkflowSpawnFunction, D as WorkflowSpawnOptions, E as WorkflowStatusResult, G as WorkflowStepConfigLike, H as WorkflowStepContextLike, J as WorkflowStepRollbackOptionsLike } from "./packem_shared/types.d-DZlXmeGi.mjs";
 import { LunoraError } from '@lunora/errors';
 import '@lunora/values';
 /** Wiring info for one declared workflow, emitted by codegen into the generated shard. */
@@ -10,108 +10,108 @@ interface WorkflowBindingSpec {
   exportName: string;
 }
 /**
-* Build the `ctx.workflows` handle for a request: resolve every spec's
-* `env[binding]` into the `exportName → Workflow binding` map and wrap it in
-* {@link createWorkflows}. A spec whose binding is absent from `env` is skipped
-* here — the helpful "no workflow named …" error is raised lazily by
-* `workflows.get(name)` when the missing workflow is actually used.
-*/
+ * Build the `ctx.workflows` handle for a request: resolve every spec's
+ * `env[binding]` into the `exportName → Workflow binding` map and wrap it in
+ * {@link createWorkflows}. A spec whose binding is absent from `env` is skipped
+ * here — the helpful "no workflow named …" error is raised lazily by
+ * `workflows.get(name)` when the missing workflow is actually used.
+ */
 declare const createWorkflowContext: (env: Record<string, unknown>, specs: ReadonlyArray<WorkflowBindingSpec>) => Workflows;
 /**
-* Build the `ctx.workflows` handle from a map of `lunora/workflows.ts` export
-* name → Cloudflare `Workflow` binding. `get(name)` resolves the typed handle;
-* an unknown name throws with the list of declared workflows.
-*/
+ * Build the `ctx.workflows` handle from a map of `lunora/workflows.ts` export
+ * name → Cloudflare `Workflow` binding. `get(name)` resolves the typed handle;
+ * an unknown name throws with the list of declared workflows.
+ */
 declare const createWorkflows: (options: LunoraWorkflowsOptions) => Workflows;
 /**
-* Declare a reusable durable step. Same `args` map shape a Lunora `query` /
-* `mutation` / `action` uses, so a step reads like a function:
-*
-* ```ts
-* // lunora/steps.ts
-* import { defineStep } from "@lunora/workflow";
-* import { v } from "@lunora/values";
-*
-* export const fetchImage = defineStep("fetch image", {
-*     args: { imageKey: v.string() },
-*     returns: v.object({ data: v.bytes() }),
-*     handler: async (ctx, { imageKey }) => {
-*         const object = await (ctx.env.BUCKET as R2Bucket).get(imageKey);
-*         return { data: new Uint8Array(await object!.arrayBuffer()) };
-*     },
-*     rollback: async (ctx) => {
-*         await (ctx.env.BUCKET as R2Bucket).delete(`tmp/${ctx.args.imageKey}`);
-*     },
-* });
-* ```
-*
-* Then, inside a `defineWorkflow` handler:
-*
-* ```ts
-* const { data } = await ctx.runStep(fetchImage, { imageKey: ctx.params.imageKey });
-* ```
-*/
+ * Declare a reusable durable step. Same `args` map shape a Lunora `query` /
+ * `mutation` / `action` uses, so a step reads like a function:
+ *
+ * ```ts
+ * // lunora/steps.ts
+ * import { defineStep } from "@lunora/workflow";
+ * import { v } from "@lunora/values";
+ *
+ * export const fetchImage = defineStep("fetch image", {
+ *     args: { imageKey: v.string() },
+ *     returns: v.object({ data: v.bytes() }),
+ *     handler: async (ctx, { imageKey }) => {
+ *         const object = await (ctx.env.BUCKET as R2Bucket).get(imageKey);
+ *         return { data: new Uint8Array(await object!.arrayBuffer()) };
+ *     },
+ *     rollback: async (ctx) => {
+ *         await (ctx.env.BUCKET as R2Bucket).delete(`tmp/${ctx.args.imageKey}`);
+ *     },
+ * });
+ * ```
+ *
+ * Then, inside a `defineWorkflow` handler:
+ *
+ * ```ts
+ * const { data } = await ctx.runStep(fetchImage, { imageKey: ctx.params.imageKey });
+ * ```
+ */
 declare const defineStep: <A extends StepArgsValidator, Result>(name: string, config: StepConfig<A, Result>) => StepDefinition<A, Result>;
 /** True when a value is a `defineStep` result (the runtime brand check). */
 declare const isStepDefinition: (value: unknown) => value is StepDefinition;
 /**
-* The generated `WorkflowEntrypoint` class name for a `lunora/workflows.ts`
-* export: `orderPipeline` → `OrderPipelineWorkflow`. wrangler's
-* `workflows[].class_name` references it, so codegen and the config layer MUST
-* derive it identically — always via this helper.
-*/
+ * The generated `WorkflowEntrypoint` class name for a `lunora/workflows.ts`
+ * export: `orderPipeline` → `OrderPipelineWorkflow`. wrangler's
+ * `workflows[].class_name` references it, so codegen and the config layer MUST
+ * derive it identically — always via this helper.
+ */
 declare const workflowClassName: (exportName: string) => string;
 /**
-* The wrangler binding name for a workflow export: `orderPipeline` →
-* `WORKFLOW_ORDER_PIPELINE`, `etl` → `WORKFLOW_ETL`. The `WORKFLOW_` prefix
-* namespaces these away from `SHARD`/`SESSION`/`SCHEDULER`/`CONTAINER_*` so a
-* workflow export can never collide with the built-in bindings.
-*/
+ * The wrangler binding name for a workflow export: `orderPipeline` →
+ * `WORKFLOW_ORDER_PIPELINE`, `etl` → `WORKFLOW_ETL`. The `WORKFLOW_` prefix
+ * namespaces these away from `SHARD`/`SESSION`/`SCHEDULER`/`CONTAINER_*` so a
+ * workflow export can never collide with the built-in bindings.
+ */
 declare const workflowBindingName: (exportName: string) => string;
 /**
-* The stable workflow name wrangler registers (`workflows[].name`):
-* `orderPipeline` → `order-pipeline`. Used as the deployed workflow's
-* identifier when no explicit `name` override is given.
-*/
+ * The stable workflow name wrangler registers (`workflows[].name`):
+ * `orderPipeline` → `order-pipeline`. Used as the deployed workflow's
+ * identifier when no explicit `name` override is given.
+ */
 declare const workflowDefaultName: (exportName: string) => string;
 /**
-* Declare a durable workflow deployed alongside the app. Pure validation +
-* branding: codegen discovers the export, emits the `WorkflowEntrypoint`
-* subclass (`_generated/workflows.ts`), and wires the typed `ctx.workflows`
-* handle; the config layer reconciles the wrangler `workflows[]` entry from the
-* same definition.
-*
-* ```ts
-* // lunora/workflows.ts
-* import { defineWorkflow } from "@lunora/workflow";
-* import { api } from "./_generated/api";
-*
-* export const orderPipeline = defineWorkflow&lt;{ orderId: string }>({
-*     handler: async (ctx) => {
-*         const order = await ctx.step.do("load", () => ctx.run(api.orders.get, { id: ctx.params.orderId }));
-*         await ctx.step.sleep("cool-off", "1 minute");
-*         await ctx.step.do("charge", () => ctx.run(api.payments.charge, { orderId: ctx.params.orderId }));
-*         return order;
-*     },
-* });
-* ```
-*/
+ * Declare a durable workflow deployed alongside the app. Pure validation +
+ * branding: codegen discovers the export, emits the `WorkflowEntrypoint`
+ * subclass (`_generated/workflows.ts`), and wires the typed `ctx.workflows`
+ * handle; the config layer reconciles the wrangler `workflows[]` entry from the
+ * same definition.
+ *
+ * ```ts
+ * // lunora/workflows.ts
+ * import { defineWorkflow } from "@lunora/workflow";
+ * import { api } from "./_generated/api";
+ *
+ * export const orderPipeline = defineWorkflow&lt;{ orderId: string }>({
+ *     handler: async (ctx) => {
+ *         const order = await ctx.step.do("load", () => ctx.run(api.orders.get, { id: ctx.params.orderId }));
+ *         await ctx.step.sleep("cool-off", "1 minute");
+ *         await ctx.step.do("charge", () => ctx.run(api.payments.charge, { orderId: ctx.params.orderId }));
+ *         return order;
+ *     },
+ * });
+ * ```
+ */
 declare const defineWorkflow: <Params = Record<string, unknown>, Output = unknown>(config: WorkflowConfig<Params, Output>) => WorkflowDefinition<Params, Output>;
 /** True when a value is a `defineWorkflow` result (the runtime brand check). */
 declare const isWorkflowDefinition: (value: unknown) => value is WorkflowDefinition;
 /**
-* Throw from a workflow step (or handler) to fail the instance immediately
-* **without** retrying — the portable mirror of `cloudflare:workflows`'
-* `NonRetryableError`. Importable from Node, so workflow code stays unit-testable.
-*
-* ```ts
-* import { NonRetryableError } from "@lunora/workflow";
-*
-* if (order.status === "cancelled") {
-*     throw new NonRetryableError("order already cancelled — no point retrying");
-* }
-* ```
-*/
+ * Throw from a workflow step (or handler) to fail the instance immediately
+ * **without** retrying — the portable mirror of `cloudflare:workflows`'
+ * `NonRetryableError`. Importable from Node, so workflow code stays unit-testable.
+ *
+ * ```ts
+ * import { NonRetryableError } from "@lunora/workflow";
+ *
+ * if (order.status === "cancelled") {
+ *     throw new NonRetryableError("order already cancelled — no point retrying");
+ * }
+ * ```
+ */
 declare class NonRetryableError extends Error {
   constructor(message: string, name?: string);
 }
@@ -120,34 +120,31 @@ declare const isNonRetryableError: (value: unknown) => value is NonRetryableErro
 /** Constructor shape of `cloudflare:workflows`' native `NonRetryableError`. */
 type NativeNonRetryableErrorConstructor = new (message: string, name?: string) => Error;
 /**
-* Rebuild a portable {@link NonRetryableError} as the native Cloudflare one,
-* preserving its `name`, `message`, `cause`, and `stack`. Used at the `src/do`
-* boundary where the native constructor is available; everywhere else the
-* portable error is thrown unchanged (and still honored by name).
-*/
+ * Rebuild a portable {@link NonRetryableError} as the native Cloudflare one,
+ * preserving its `name`, `message`, `cause`, and `stack`. Used at the `src/do`
+ * boundary where the native constructor is available; everywhere else the
+ * portable error is thrown unchanged (and still honored by name).
+ */
 declare const toNativeNonRetryableError: (error: NonRetryableError, NativeNonRetryableError: NativeNonRetryableErrorConstructor) => Error;
 /**
-* If `error` is a portable {@link NonRetryableError} and a native constructor is
-* available, rethrow it as the native error; otherwise rethrow `error` as-is.
-* Always throws — the `never` return lets callers `return convertNonRetryableError(...)`.
-*/
+ * If `error` is a portable {@link NonRetryableError} and a native constructor is
+ * available, rethrow it as the native error; otherwise rethrow `error` as-is.
+ * Always throws — the `never` return lets callers `return convertNonRetryableError(...)`.
+ */
 declare const convertNonRetryableError: (error: unknown, NativeNonRetryableError: NativeNonRetryableErrorConstructor | undefined) => never;
 /** Hard cap on branches per `ctx.parallel` call — auto-scale, never silently spawn unbounded DOs. */
 declare const MAX_BRANCHES = 100;
-/** The params key the parent injects so a child knows to signal completion back. Stripped before the user handler sees `ctx.params`. */
-
 /**
-* Build a single fan-out branch: a declared child workflow referenced by its
-* `lunora/workflows.ts` export name, plus the params it is created with. Pass the
-* output type as the generic argument so `ctx.parallel(...)` infers the result
-* tuple — e.g. `branch("imageTag", { key })` typed as `branch` of `{ tags }`.
-*/
+ * Build a single fan-out branch: a declared child workflow referenced by its
+ * `lunora/workflows.ts` export name, plus the params it is created with. Pass the
+ * output type as the generic argument so `ctx.parallel(...)` infers the result
+ * tuple — e.g. `branch("imageTag", { key })` typed as `branch` of `{ tags }`.
+ */
 declare const branch: <Output = unknown>(workflow: string, params?: Record<string, unknown>, options?: {
   compensateWith?: string;
   id?: string;
   timeout?: number | string;
 }) => WorkflowBranch<Output>;
-/** Build the success outcome a completed branch reports to its parent. */
 /** The lifecycle mutations the REST API exposes via `PATCH .../instances/{id}`. */
 type WorkflowInstanceAction = "pause" | "resume" | "terminate";
 /** Configuration for a {@link WorkflowsRestClient}. */
@@ -219,11 +216,11 @@ interface WorkflowsRestClient {
   }>;
 }
 /**
-* Build a {@link WorkflowsRestClient}. Each call hits the account-scoped REST
-* endpoint with the bearer token, unwraps Cloudflare's
-* `{ success, errors, result, result_info }` envelope, and normalizes the
-* snake_case payload into the camelCase shapes the studio renders.
-*/
+ * Build a {@link WorkflowsRestClient}. Each call hits the account-scoped REST
+ * endpoint with the bearer token, unwraps Cloudflare's
+ * `{ success, errors, result, result_info }` envelope, and normalizes the
+ * snake_case payload into the camelCase shapes the studio renders.
+ */
 declare const createWorkflowsRestClient: (config: WorkflowsRestConfig) => WorkflowsRestClient;
 interface RunContextOptions<Params> {
   env: Record<string, unknown>;
@@ -237,12 +234,12 @@ interface RunContextOptions<Params> {
 /** Assemble the {@link WorkflowRunContext} passed to a `defineWorkflow` handler. */
 declare const createWorkflowRunContext: <Params = Record<string, unknown>>(options: RunContextOptions<Params>) => WorkflowRunContext<Params>;
 /**
-* Validate a step's args through its validator map, prefixing any
-* `ValidationError` with `step args.&lt;key>` so the failure points at the
-* offending field. Delegates to `@lunora/values`' shared {@link parseValidatorMap}
-* — the same parser the procedure builder and HTTP routes use — so the
-* optional-skip and error-prefix semantics stay in lockstep across the framework.
-*/
+ * Validate a step's args through its validator map, prefixing any
+ * `ValidationError` with `step args.&lt;key>` so the failure points at the
+ * offending field. Delegates to `@lunora/values`' shared {@link parseValidatorMap}
+ * — the same parser the procedure builder and HTTP routes use — so the
+ * optional-skip and error-prefix semantics stay in lockstep across the framework.
+ */
 declare const validateStepArgs: (validators: StepArgsValidator, source: Record<string, unknown>) => Record<string, unknown>;
 /** Dependencies needed to run a step: the native step API plus the workflow's env / runner / logger. */
 interface RunStepDeps {
@@ -258,10 +255,10 @@ interface RunStepDeps {
   step: WorkflowStepLike;
 }
 /**
-* Build the `ctx.runStep` function bound to one workflow invocation. Each call
-* runs the step through `step.do(...)`: validate args → run body → validate
-* result (when `returns` is declared), with any portable `NonRetryableError`
-* converted to the native one and any declared rollback forwarded to Cloudflare.
-*/
+ * Build the `ctx.runStep` function bound to one workflow invocation. Each call
+ * runs the step through `step.do(...)`: validate args → run body → validate
+ * result (when `returns` is declared), with any portable `NonRetryableError`
+ * converted to the native one and any declared rollback forwarded to Cloudflare.
+ */
 declare const createRunStep: (deps: RunStepDeps) => WorkflowRunStepFunction;
 export { type LunoraWorkflowsOptions, MAX_BRANCHES, type NativeNonRetryableErrorConstructor, NonRetryableError, type StepArgsValidator, type StepConfig, type StepDefinition, type WorkflowBindingSpec, type WorkflowBranch, type WorkflowConfig, type WorkflowDefinition, type WorkflowEventLike, type WorkflowInstanceAction, type WorkflowInstanceDetail, type WorkflowInstancePage, type WorkflowInstanceStatus, type WorkflowInstanceSummary, type WorkflowLogger, type WorkflowRunContext, type WorkflowRunFunction, type WorkflowRunStepFunction, type WorkflowStepDetail, type WorkflowStepLike, type Workflows, type WorkflowsRestClient, type WorkflowsRestConfig, WorkflowsRestError, branch, convertNonRetryableError, createRunStep, createWorkflowContext, createWorkflowRunContext, createWorkflows, createWorkflowsRestClient, defineStep, defineWorkflow, isNonRetryableError, isStepDefinition, isWorkflowDefinition, toNativeNonRetryableError, validateStepArgs, workflowBindingName, workflowClassName, workflowDefaultName };