@voyant-travel/workflows 0.107.10

package/dist/runtime/ctx.d.ts

@@ -0,0 +1,111 @@
+import type { ServiceResolver } from "../driver.js";
+import type { RetryPolicy, WaitpointKind } from "../types.js";
+import type { EnvironmentContext, MetadataValue, RunContext, StepContext, StepFn, StepOptions, WorkflowContext } from "../workflow.js";
+import { type ClockState } from "./determinism.js";
+import type { JournalSlice, StepJournalEntry } from "./journal.js";
+/**
+ * Callbacks the executor provides for operations that must reach the
+ * orchestrator (over HTTP in production, in-memory in tests).
+ */
+export interface RuntimeCallbacks {
+    /** Run a new step and journal the result. Called only for steps not already in the journal. */
+    runStep(args: {
+        stepId: string;
+        attempt: number;
+        input: unknown;
+        options: StepOptions<unknown>;
+        fn: StepFn<unknown>;
+        stepCtx: StepContext;
+    }): Promise<StepJournalEntry>;
+    /**
+     * Called when a step completes successfully and had a `compensate`
+     * function declared. The executor collects these in completion order
+     * and runs them in reverse if the body throws or `ctx.compensate()`
+     * is invoked.
+     */
+    recordCompensable(args: {
+        stepId: string;
+        output: unknown;
+        compensate: (output: unknown) => Promise<void>;
+    }): void;
+    /** Current length of the compensable list. Used by `ctx.group` checkpoints. */
+    compensableLength(): number;
+    /**
+     * Remove and return compensables added since `fromIndex`. Used by
+     * `ctx.group` to run scoped rollback without touching outer
+     * compensables.
+     */
+    spliceCompensable(fromIndex: number): Array<{
+        stepId: string;
+        output: unknown;
+        compensate: (output: unknown) => Promise<void>;
+    }>;
+    /**
+     * Called by `ctx.stream()` for each chunk produced by the source.
+     * In production this emits a `stream.chunk` WebSocket event and
+     * journals the chunk; in tests the harness collects chunks.
+     */
+    pushStreamChunk(args: {
+        streamId: string;
+        seq: number;
+        encoding: "text" | "json" | "base64";
+        chunk: unknown;
+        final: boolean;
+    }): void;
+    /** Register a new waitpoint; execution will yield after this returns. */
+    registerWaitpoint(args: {
+        clientWaitpointId: string;
+        kind: WaitpointKind;
+        meta: Record<string, unknown>;
+        timeoutMs?: number;
+    }): void;
+    /** Push a metadata mutation; flushed on waitpoint yield and run completion. */
+    pushMetadata(op: {
+        op: "set" | "increment" | "append" | "remove";
+        key: string;
+        value?: unknown;
+        target?: "self" | "parent" | "root";
+    }): void;
+    /** Increment invocation counter when the body resumes after eviction. */
+    readonly invocationCount: number;
+    /** Cancellation signal exposed as `ctx.signal`. */
+    readonly abortSignal: AbortSignal;
+}
+export interface RuntimeEnvironment {
+    readonly run: RunContext;
+    readonly workflow: {
+        id: string;
+        version: string;
+    };
+    readonly environment: EnvironmentContext;
+    readonly project: {
+        id: string;
+        slug: string;
+    };
+    readonly organization: {
+        id: string;
+        slug: string;
+    };
+}
+export interface CtxBuildArgs {
+    env: RuntimeEnvironment;
+    journal: JournalSlice;
+    callbacks: RuntimeCallbacks;
+    clock: ClockState;
+    random: () => number;
+    /** Mutated as ctx.setRetry is called; each step option inherits. */
+    retryOverride: {
+        current: RetryPolicy | undefined;
+    };
+    /**
+     * Read-only service resolver exposed as `ctx.services`. When unset,
+     * `ctx.services.resolve(...)` throws with a clear message — workflows
+     * that don't need shared services keep working without configuration.
+     * Wired by the framework through `StepHandlerDeps.services` →
+     * `ExecuteWorkflowStepRequest.services` → here.
+     */
+    services?: ServiceResolver;
+}
+export declare function buildCtx(args: CtxBuildArgs): WorkflowContext<unknown>;
+export type { MetadataValue };
+//# sourceMappingURL=ctx.d.ts.map

package/dist/runtime/ctx.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ctx.d.ts","sourceRoot":"","sources":["../../src/runtime/ctx.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AAEnD,OAAO,KAAK,EAAY,WAAW,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AACvE,OAAO,KAAK,EACV,kBAAkB,EAMlB,aAAa,EAEb,UAAU,EAEV,WAAW,EACX,MAAM,EACN,WAAW,EAOX,eAAe,EAEhB,MAAM,gBAAgB,CAAA;AACvB,OAAO,EAAkB,KAAK,UAAU,EAAyB,MAAM,kBAAkB,CAAA;AASzF,OAAO,KAAK,EAAE,YAAY,EAAE,gBAAgB,EAA4B,MAAM,cAAc,CAAA;AAE5F;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,+FAA+F;IAC/F,OAAO,CAAC,IAAI,EAAE;QACZ,MAAM,EAAE,MAAM,CAAA;QACd,OAAO,EAAE,MAAM,CAAA;QACf,KAAK,EAAE,OAAO,CAAA;QACd,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC,CAAA;QAC7B,EAAE,EAAE,MAAM,CAAC,OAAO,CAAC,CAAA;QACnB,OAAO,EAAE,WAAW,CAAA;KACrB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAE7B;;;;;OAKG;IACH,iBAAiB,CAAC,IAAI,EAAE;QACtB,MAAM,EAAE,MAAM,CAAA;QACd,MAAM,EAAE,OAAO,CAAA;QACf,UAAU,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;KAC/C,GAAG,IAAI,CAAA;IAER,+EAA+E;IAC/E,iBAAiB,IAAI,MAAM,CAAA;IAE3B;;;;OAIG;IACH,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,KAAK,CAAC;QAC1C,MAAM,EAAE,MAAM,CAAA;QACd,MAAM,EAAE,OAAO,CAAA;QACf,UAAU,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;KAC/C,CAAC,CAAA;IAEF;;;;OAIG;IACH,eAAe,CAAC,IAAI,EAAE;QACpB,QAAQ,EAAE,MAAM,CAAA;QAChB,GAAG,EAAE,MAAM,CAAA;QACX,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAA;QACpC,KAAK,EAAE,OAAO,CAAA;QACd,KAAK,EAAE,OAAO,CAAA;KACf,GAAG,IAAI,CAAA;IAER,yEAAyE;IACzE,iBAAiB,CAAC,IAAI,EAAE;QACtB,iBAAiB,EAAE,MAAM,CAAA;QACzB,IAAI,EAAE,aAAa,CAAA;QACnB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QAC7B,SAAS,CAAC,EAAE,MAAM,CAAA;KACnB,GAAG,IAAI,CAAA;IAER,+EAA+E;IAC/E,YAAY,CAAC,EAAE,EAAE;QACf,EAAE,EAAE,KAAK,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,CAAA;QAC7C,GAAG,EAAE,MAAM,CAAA;QACX,KAAK,CAAC,EAAE,OAAO,CAAA;QACf,MAAM,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,MAAM,CAAA;KACpC,GAAG,IAAI,CAAA;IAER,yEAAyE;IACzE,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAA;IAEhC,mDAAmD;IACnD,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAA;CAClC;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,GAAG,EAAE,UAAU,CAAA;IACxB,QAAQ,CAAC,QAAQ,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAA;IAClD,QAAQ,CAAC,WAAW,EAAE,kBAAkB,CAAA;IACxC,QAAQ,CAAC,OAAO,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;IAC9C,QAAQ,CAAC,YAAY,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;CACpD;AAED,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,kBAAkB,CAAA;IACvB,OAAO,EAAE,YAAY,CAAA;IACrB,SAAS,EAAE,gBAAgB,CAAA;IAC3B,KAAK,EAAE,UAAU,CAAA;IACjB,MAAM,EAAE,MAAM,MAAM,CAAA;IACpB,oEAAoE;IACpE,aAAa,EAAE;QAAE,OAAO,EAAE,WAAW,GAAG,SAAS,CAAA;KAAE,CAAA;IACnD;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,eAAe,CAAA;CAC3B;AAoBD,wBAAgB,QAAQ,CAAC,IAAI,EAAE,YAAY,GAAG,eAAe,CAAC,OAAO,CAAC,CAikBrE;AAsID,YAAY,EAAE,aAAa,EAAE,CAAA"}