@lunora/workflow 1.0.0-alpha.4 → 1.0.0-alpha.41

package/LICENSE.md

@@ -103,3 +103,9 @@ Unless required by applicable law or agreed to in writing, software distributed
 under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 CONDITIONS OF ANY KIND, either express or implied. See the License for the
 specific language governing permissions and limitations under the License.
+
+<!-- DEPENDENCIES -->
+<!-- /DEPENDENCIES -->
+
+<!-- TYPE_DEPENDENCIES -->
+<!-- /TYPE_DEPENDENCIES -->

package/README.md

@@ -85,10 +85,33 @@ The handler context bundles:
 - `ctx.step` — the native Cloudflare durable-step API (`do` / `sleep` / `sleepUntil` / `waitForEvent`).
 - `ctx.run(ref, args, opts?)` — call a Lunora query / mutation / action; wrap in `ctx.step.do(...)` for durability.
 - `ctx.runStep(step, args, opts?)` — run a reusable, schema-validated `defineStep` as a durable step (see below).
+- `ctx.waitForEvent(event, opts?)` — hibernate until a declared `defineWorkflowEvent` arrives; resolves with its validated payload (see below).
 - `ctx.event` / `ctx.params` — the triggering event and its payload.
 - `ctx.env` — the Worker bindings.
 - `ctx.log` — a workflow-prefixed logger surfaced in `wrangler tail` / Studio.
 
+### Declared events (`defineWorkflowEvent`)
+
+`step.waitForEvent(name, { type })` and `instance.sendEvent({ type })` match on a bare string, and the payload crosses as `unknown` — so a typo hibernates the instance until its timeout with no error anywhere, and a changed payload shape resumes the workflow on garbage. Declare the event once and both ends import the same value:
+
+```ts
+// lunora/events.ts
+import { defineWorkflowEvent } from "@lunora/workflow";
+import { v } from "@lunora/values";
+
+export const orderApproved = defineWorkflowEvent("order-approved", v.object({ approvedBy: v.string() }));
+```
+
+```ts
+// inside the workflow body — typed and parsed
+const { approvedBy } = await ctx.waitForEvent(orderApproved, { name: "await approval", timeout: "7 days" });
+
+// from a mutation/action — validated before the send
+await ctx.workflows.get("orderPipeline").sendEvent(instanceId, orderApproved, { approvedBy });
+```
+
+Pass a stable `{ name }` on any wait that can outlive a deploy: the step is otherwise labelled `event:<type>`, so renaming the event type also renames the durable step and an instance that already recorded the wait replays into a fresh one nothing will satisfy.
+
 ### Reusable steps (`defineStep`)
 
 A step authored inline with `ctx.step.do("name", () => …)` is fine for one-offs, but `defineStep` lets you define a step **once** — schema-validated and reusable across workflows. Args are validated (with `@lunora/values`) **before** the body runs, and the return value is validated **after** (when you declare `returns`), so a bad payload fails fast instead of corrupting later steps. Scaffold one with `vis generate lunora-step --name=chargeOrder` (appends to `lunora/steps.ts`), or write it by hand:
@@ -169,7 +192,7 @@ export const checkout = mutation.input({ orderId: v.string() }).mutation(async (
 });
 ```
 
-A handle exposes `create({ id?, params?, retention? })`, `createBatch([...])`, and `get(id)`. An instance handle exposes its lifecycle: `status()`, `pause()`, `resume()`, `terminate()`, and `sendEvent({ type, payload })` (to satisfy a `waitForEvent`).
+A handle exposes `create({ id?, params?, retention? })`, `createBatch([...])`, `get(id)`, and `sendEvent(instanceId, event, payload)` — the typed delivery of a declared event (see above). `create`/`get` return the native Cloudflare instance, which exposes its own lifecycle: `status()`, `pause()`, `resume()`, `restart()`, `terminate()`, and the untyped `sendEvent({ type, payload })`.
 
 ### Runtime requirements
 
@@ -223,7 +246,7 @@ const detail = await client.getInstance({ workflowName: "order-pipeline", instan
 await client.setInstanceStatus({ workflowName: "order-pipeline", instanceId: detail.id, action: "terminate" });
 ```
 
-> This README covers the basics. For the full API, options, and guides, see the **[documentation](https://lunora.sh/docs/addons/workflows)**.
+> This README covers the basics. For the full API, options, and guides, see the **[documentation](https://lunora.sh/docs/packages/workflow)**.
 
 ## Related
 

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-Fdeu2P2C.mjs";
+import { W as WorkflowDefinition } from "../packem_shared/types.d-C7jti0tm.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-Fdeu2P2C.js";
+import { W as WorkflowDefinition } from "../packem_shared/types.d-C7jti0tm.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/do/index.mjs

@@ -1,44 +1 @@
-import { WorkflowEntrypoint } from 'cloudflare:workers';
-import { NonRetryableError } from 'cloudflare:workflows';
-import { convertNonRetryableError } from '../packem_shared/NonRetryableError-Dn2dTyBS.mjs';
-import { stripBranchMarker, signalBranchParent, extractBranchMarker, errorOutcome, okOutcome } from '../packem_shared/MAX_BRANCHES-C9MJIFii.mjs';
-import { createWorkflowRunContext } from '../packem_shared/createWorkflowRunContext-BsMyGuMR.mjs';
-
-class LunoraWorkflow extends WorkflowEntrypoint {
-  /** The `lunora/workflows.ts` export name, for log correlation. */
-  #lunoraName;
-  /** The `defineWorkflow` result this entrypoint runs. */
-  #definition;
-  constructor(context, env, definition, exportName) {
-    super(context, env);
-    this.#definition = definition;
-    this.#lunoraName = exportName ?? "workflow";
-  }
-  async run(event, step) {
-    const nativeStep = step;
-    const marker = extractBranchMarker(event.payload);
-    const handlerEvent = marker ? { ...event, payload: stripBranchMarker(event.payload) } : event;
-    const context = createWorkflowRunContext({
-      env: this.env,
-      event: handlerEvent,
-      exportName: this.#lunoraName,
-      nonRetryableErrorClass: NonRetryableError,
-      step: nativeStep
-    });
-    let output;
-    try {
-      output = await this.#definition.handler(context);
-    } catch (error) {
-      if (marker) {
-        await signalBranchParent({ env: this.env, step: nativeStep }, marker, errorOutcome(error));
-      }
-      return convertNonRetryableError(error, NonRetryableError);
-    }
-    if (marker) {
-      await signalBranchParent({ env: this.env, step: nativeStep }, marker, okOutcome(output));
-    }
-    return output;
-  }
-}
-
-export { LunoraWorkflow as default };
+import{WorkflowEntrypoint as p}from"cloudflare:workers";import{NonRetryableError as i}from"cloudflare:workflows";import{convertNonRetryableError as m}from"../packem_shared/NonRetryableError-9ZqDUzwT.mjs";import{extractBranchMarker as f,stripBranchMarker as h,signalBranchParentSafe as l,errorOutcome as u,okOutcome as y}from"../packem_shared/MAX_BRANCHES-C05O5LY9.mjs";import{createWorkflowRunContext as d}from"../packem_shared/createWorkflowRunContext-C83Yp2Qp.mjs";class N extends p{#r;#t;constructor(t,e,o,r){super(t,e),this.#t=o,this.#r=r??"workflow"}async run(t,e){const o=e,r=f(t.payload),c=r?{...t,payload:h(t.payload)}:t,a=d({env:this.env,event:c,exportName:this.#r,nonRetryableErrorClass:i,step:o});let n;try{n=await this.#t.handler(a)}catch(s){return r&&await l({env:this.env,log:a.log,step:o},r,u(s)),m(s,i)}return r&&await l({env:this.env,log:a.log,step:o},r,y(n)),n}}export{N as default};

package/dist/index.d.mts

@@ -1,6 +1,7 @@
-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-Fdeu2P2C.mjs";
-export type { A as ArgsOf, 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, B as WorkflowSpawnFunction, C as WorkflowSpawnOptions, D as WorkflowStatusResult, E as WorkflowStepConfigLike, G as WorkflowStepContextLike, H as WorkflowStepRollbackOptionsLike } from "./packem_shared/types.d-Fdeu2P2C.mjs";
-import '@lunora/values';
+import { a as Workflows, L as LunoraWorkflowsOptions, b as WorkflowEventDefinition, S as StepArgsValidator, c as StepConfig, d as StepDefinition, e as WorkflowConfig, W as WorkflowDefinition, f as WorkflowBranch, g as WorkflowInstanceStatus, h as WorkflowEventLike, i as WorkflowStepLike, j as WorkflowRunContext, k as WorkflowLogger, l as WorkflowRunFunction, m as WorkflowRunStepFunction, n as WorkflowWaitForEventFunction } from "./packem_shared/types.d-C7jti0tm.mjs";
+export type { A as ArgsOf, B as BranchCompensationParams, F as FunctionKind, o as FunctionReference, I as InferStepArgs, R as RunFunctionOptions, p as RunStepOptions, q as StepHandler, r as StepRollbackContext, s as StepRollbackHandler, t as StepRunContext, u as WaitForEventOptions, v as WorkflowBindingLike, w as WorkflowBranchOutputs, x as WorkflowCreateOptions, y as WorkflowHandle, z as WorkflowHandler, C as WorkflowInstanceLike, D as WorkflowParallelFunction, E as WorkflowRollbackContextLike, G as WorkflowRollbackHandlerLike, H as WorkflowSpawnFunction, J as WorkflowSpawnOptions, K as WorkflowStatusResult, M as WorkflowStepConfigLike, N as WorkflowStepContextLike, O as WorkflowStepRollbackOptionsLike } from "./packem_shared/types.d-C7jti0tm.mjs";
+import { Validator } from '@lunora/values';
+import { LunoraError } from '@lunora/errors';
 /** Wiring info for one declared workflow, emitted by codegen into the generated shard. */
 interface WorkflowBindingSpec {
   /** The Cloudflare `Workflow` binding name, e.g. `WORKFLOW_ORDER_PIPELINE`. */
@@ -9,108 +10,138 @@ 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 an external event, its wire type, and its payload shape.
+ *
+ * ```ts
+ * // lunora/events.ts
+ * import { defineWorkflowEvent } from "@lunora/workflow";
+ * import { v } from "@lunora/values";
+ *
+ * export const orderApproved = defineWorkflowEvent("order-approved", v.object({ approvedBy: v.string() }));
+ * ```
+ *
+ * Wait on it inside a workflow body — the payload is typed and validated:
+ *
+ * ```ts
+ * const { approvedBy } = await ctx.waitForEvent(orderApproved, { name: "await approval", timeout: "7 days" });
+ * ```
+ *
+ * …and send it from a mutation/action with the same definition:
+ *
+ * ```ts
+ * await ctx.workflows.get("orderPipeline").sendEvent(instanceId, orderApproved, { approvedBy });
+ * ```
+ */
+declare const defineWorkflowEvent: <Payload>(type: string, payload: Validator<Payload>) => WorkflowEventDefinition<Payload>;
+/**
+ * True when a value is usable as an event definition. The brand alone is not the
+ * test: the predicate hands the caller a `type` and a `payload.parse`, so it checks
+ * for both (and for the reserved namespace) rather than trusting a public boolean.
+ */
+declare const isWorkflowEventDefinition: (value: unknown) => value is WorkflowEventDefinition;
+/**
+ * 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<{ 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);
 }
@@ -119,33 +150,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}. */
@@ -193,8 +222,7 @@ interface WorkflowInstancePage {
   totalCount?: number;
 }
 /** Thrown when the REST API responds non-2xx or `success: false`; carries the status plus body for the caller to surface. */
-declare class WorkflowsRestError extends Error {
-  readonly status: number;
+declare class WorkflowsRestError extends LunoraError {
   constructor(status: number, body: string);
 }
 /** The observe client: list instances, read one instance's steps, and (with Edit scope) mutate its status. */
@@ -218,11 +246,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>;
@@ -236,12 +264,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.<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 {
@@ -257,10 +285,29 @@ 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 };
+/** Dependencies one workflow invocation's `ctx.waitForEvent` closes over. */
+interface WaitForEventDeps {
+  /** Native `cloudflare:workflows` `NonRetryableError` constructor — injected by `src/do`; absent in Node tests. */
+  nonRetryableErrorClass?: NativeNonRetryableErrorConstructor;
+  /** The native Cloudflare durable-step API. */
+  step: WorkflowStepLike;
+}
+/**
+ * Build `ctx.waitForEvent` for one workflow invocation.
+ *
+ * Every failure here is **non-retryable**. A malformed definition or a reserved
+ * step name is a deterministic programmer error, and a payload that fails the
+ * validator has already consumed the event — replaying the wait cannot produce a
+ * different value, it can only hibernate the instance until its timeout. Each is
+ * raised through the shared {@link raiseNonRetryable}, the same classification path
+ * `ctx.runStep` uses, so the native error reaches Cloudflare and the instance fails
+ * fast.
+ */
+declare const createWaitForEvent: (deps: WaitForEventDeps) => WorkflowWaitForEventFunction;
+export { type LunoraWorkflowsOptions, MAX_BRANCHES, type NativeNonRetryableErrorConstructor, NonRetryableError, type StepArgsValidator, type StepConfig, type StepDefinition, type WorkflowBindingSpec, type WorkflowBranch, type WorkflowConfig, type WorkflowDefinition, type WorkflowEventDefinition, 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 WorkflowWaitForEventFunction, type Workflows, type WorkflowsRestClient, type WorkflowsRestConfig, WorkflowsRestError, branch, convertNonRetryableError, createRunStep, createWaitForEvent, createWorkflowContext, createWorkflowRunContext, createWorkflows, createWorkflowsRestClient, defineStep, defineWorkflow, defineWorkflowEvent, isNonRetryableError, isStepDefinition, isWorkflowDefinition, isWorkflowEventDefinition, toNativeNonRetryableError, validateStepArgs, workflowBindingName, workflowClassName, workflowDefaultName };