@voyant-travel/workflows 0.107.10

package/dist/testing/index.d.ts

@@ -0,0 +1,117 @@
+import type { SerializedError } from "../protocol/index.js";
+import { type CompensationReport, type StreamChunk, type WaitpointRegistration } from "../runtime/executor.js";
+import type { JournalSlice } from "../runtime/journal.js";
+import type { RunStatus } from "../types.js";
+import type { EnvironmentContext, MetadataValue, StepContext, WorkflowHandle } from "../workflow.js";
+export interface TestOptions<_TIn> {
+    /** Map of stepId → function run in place of the real step body. */
+    steps?: Record<string, (stepCtx: StepContext) => unknown | Promise<unknown>>;
+    /**
+     * Map of eventType → payload (or payload array). First
+     * match-per-eventType wins.
+     */
+    waitForEvent?: Record<string, unknown | unknown[]>;
+    /** Map of signalName → payload. */
+    waitForSignal?: Record<string, unknown>;
+    /** Map of tokenId → payload. */
+    waitForToken?: Record<string, unknown>;
+    /** Workflow invoke stubs keyed by child workflow id. */
+    invoke?: Record<string, unknown>;
+    /** Fake env bindings, passed through to `ctx.environment` for tests. */
+    env?: Record<string, unknown>;
+    environment?: Partial<EnvironmentContext>;
+    /** Fixed wall-clock basis for the run. Defaults to Date.now(). */
+    now?: () => number;
+    random?: () => number;
+    /** Max resumption cycles. Defaults to 16 — guards runaway loops. */
+    maxInvocations?: number;
+    /**
+     * When true, the harness stops and returns a "waiting" TestResult as
+     * soon as any registered waitpoint has no fixture resolution (instead
+     * of throwing). Callers can then persist the run and resume it later
+     * via `resumeWorkflowForTest` once the waitpoint is resolved from a
+     * live source (e.g. a dashboard HTTP injection).
+     *
+     * DATETIME waitpoints (sleeps) are always auto-resolved regardless of
+     * this flag, since a local dev loop is not the right place to
+     * synthesize wall-clock delays.
+     */
+    pauseOnWait?: boolean;
+}
+export interface TestResult<TOut> {
+    status: Extract<RunStatus, "completed" | "failed" | "cancelled" | "compensated" | "compensation_failed" | "waiting">;
+    output?: TOut;
+    error?: {
+        category: SerializedError["category"];
+        code: string;
+        message: string;
+    };
+    steps: {
+        id: string;
+        status: "ok" | "err" | "skipped";
+        duration: number;
+        output?: unknown;
+    }[];
+    events: {
+        type: string;
+        at: number;
+        data: unknown;
+    }[];
+    metadata: Record<string, MetadataValue>;
+    compensations: CompensationReport[];
+    /** Chunks emitted via `ctx.stream()` / `ctx.stream.{text,json,bytes}`, grouped by streamId in emission order. */
+    streams: Record<string, StreamChunk[]>;
+    invocations: number;
+    /**
+     * Populated when `status === "waiting"`. Holds the persisted executor
+     * state needed to resume the run via `resumeWorkflowForTest`.
+     */
+    pause?: {
+        journal: JournalSlice;
+        pendingWaitpoints: WaitpointRegistration[];
+        startedAt: number;
+        invocationCount: number;
+        metadataAppliedCount: number;
+        fixtureCursors: {
+            event: Record<string, number>;
+            signal: Record<string, number>;
+        };
+    };
+}
+export declare function runWorkflowForTest<TIn, TOut>(workflow: WorkflowHandle<TIn, TOut>, input: TIn, opts?: TestOptions<TIn>): Promise<TestResult<TOut>>;
+/**
+ * A single injected waitpoint resolution — the tenant-side analogue of
+ * the orchestrator delivering an event, signal, or token payload to a
+ * parked run. The matcher (`kind` + `key`) identifies which pending
+ * waitpoint to resolve; `payload` is the value surfaced to the body.
+ */
+export type WaitpointInjection = {
+    kind: "EVENT";
+    eventType: string;
+    payload?: unknown;
+} | {
+    kind: "SIGNAL";
+    name: string;
+    payload?: unknown;
+} | {
+    kind: "MANUAL";
+    tokenId: string;
+    payload?: unknown;
+};
+export interface ResumeOptions<TIn> extends TestOptions<TIn> {
+    /** Persisted pause state returned from a previous `runWorkflowForTest` or `resumeWorkflowForTest`. */
+    pause: NonNullable<TestResult<unknown>["pause"]>;
+    /** The single waitpoint resolution to inject on resume. */
+    injection: WaitpointInjection;
+}
+/**
+ * Resume a parked run. Matches the injection against one of the
+ * `pause.pendingWaitpoints`, records it in the journal, and re-enters
+ * the executor loop until the next pause or terminal state.
+ */
+export declare function resumeWorkflowForTest<TIn, TOut>(workflow: WorkflowHandle<TIn, TOut>, input: TIn, opts: ResumeOptions<TIn>): Promise<TestResult<TOut>>;
+export interface FixtureCursors {
+    event: Map<string, number>;
+    signal: Map<string, number>;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/testing/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/testing/index.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAC3D,OAAO,EACL,KAAK,kBAAkB,EAIvB,KAAK,WAAW,EAChB,KAAK,qBAAqB,EAC3B,MAAM,wBAAwB,CAAA;AAC/B,OAAO,KAAK,EACV,YAAY,EAGb,MAAM,uBAAuB,CAAA;AAE9B,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAC5C,OAAO,KAAK,EACV,kBAAkB,EAClB,aAAa,EACb,WAAW,EAEX,cAAc,EACf,MAAM,gBAAgB,CAAA;AAOvB,MAAM,WAAW,WAAW,CAAC,IAAI;IAC/B,mEAAmE;IACnE,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,WAAW,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAA;IAC5E;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,EAAE,CAAC,CAAA;IAClD,mCAAmC;IACnC,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACvC,gCAAgC;IAChC,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACtC,wDAAwD;IACxD,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChC,wEAAwE;IACxE,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC7B,WAAW,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAA;IACzC,kEAAkE;IAClE,GAAG,CAAC,EAAE,MAAM,MAAM,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,MAAM,CAAA;IACrB,oEAAoE;IACpE,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB;;;;;;;;;;OAUG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;CACtB;AAED,MAAM,WAAW,UAAU,CAAC,IAAI;IAC9B,MAAM,EAAE,OAAO,CACb,SAAS,EACT,WAAW,GAAG,QAAQ,GAAG,WAAW,GAAG,aAAa,GAAG,qBAAqB,GAAG,SAAS,CACzF,CAAA;IACD,MAAM,CAAC,EAAE,IAAI,CAAA;IACb,KAAK,CAAC,EAAE;QAAE,QAAQ,EAAE,eAAe,CAAC,UAAU,CAAC,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAA;IAChF,KAAK,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,IAAI,GAAG,KAAK,GAAG,SAAS,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,EAAE,CAAA;IAC7F,MAAM,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,OAAO,CAAA;KAAE,EAAE,CAAA;IACrD,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;IACvC,aAAa,EAAE,kBAAkB,EAAE,CAAA;IACnC,iHAAiH;IACjH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,EAAE,CAAC,CAAA;IACtC,WAAW,EAAE,MAAM,CAAA;IACnB;;;OAGG;IACH,KAAK,CAAC,EAAE;QACN,OAAO,EAAE,YAAY,CAAA;QACrB,iBAAiB,EAAE,qBAAqB,EAAE,CAAA;QAC1C,SAAS,EAAE,MAAM,CAAA;QACjB,eAAe,EAAE,MAAM,CAAA;QACvB,oBAAoB,EAAE,MAAM,CAAA;QAC5B,cAAc,EAAE;YAAE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;SAAE,CAAA;KAClF,CAAA;CACF;AAED,wBAAsB,kBAAkB,CAAC,GAAG,EAAE,IAAI,EAChD,QAAQ,EAAE,cAAc,CAAC,GAAG,EAAE,IAAI,CAAC,EACnC,KAAK,EAAE,GAAG,EACV,IAAI,GAAE,WAAW,CAAC,GAAG,CAAM,GAC1B,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAqL3B;AAED;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAC1B;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,GACvD;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,GACnD;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,CAAA;AAE1D,MAAM,WAAW,aAAa,CAAC,GAAG,CAAE,SAAQ,WAAW,CAAC,GAAG,CAAC;IAC1D,sGAAsG;IACtG,KAAK,EAAE,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAA;IAChD,2DAA2D;IAC3D,SAAS,EAAE,kBAAkB,CAAA;CAC9B;AAED;;;;GAIG;AACH,wBAAsB,qBAAqB,CAAC,GAAG,EAAE,IAAI,EACnD,QAAQ,EAAE,cAAc,CAAC,GAAG,EAAE,IAAI,CAAC,EACnC,KAAK,EAAE,GAAG,EACV,IAAI,EAAE,aAAa,CAAC,GAAG,CAAC,GACvB,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAwM3B;AAoND,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC1B,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC5B"}