@workflow/core 5.0.0-beta.39 → 5.0.0-beta.40

package/dist/workflow.d.ts

@@ -1,11 +1,57 @@
 import type { Event, WorkflowRun, WorldCapabilities } from '@workflow/world';
+import { WorkflowSuspension } from './global.js';
 import { ReplayPayloadCache } from './replay-payload-cache.js';
 import type { PayloadKey } from './serialization/encryption.js';
+/** Everything needed to cold-start a workflow VM over an event log. */
+interface WorkflowSessionOptions {
+    readonly workflowCode: string;
+    readonly workflowRun: WorkflowRun;
+    readonly events: Event[];
+    readonly encryptionKey: PayloadKey | undefined;
+    readonly replayPayloadCache: ReplayPayloadCache;
+    readonly runReadyBarrier?: Promise<unknown>;
+    readonly worldCapabilities?: WorldCapabilities;
+}
+/**
+ * A live workflow VM, parked at a suspension boundary. `resume` advances it
+ * by appending events instead of replaying from scratch.
+ */
+export interface WorkflowSession {
+    readonly workflowRun: WorkflowRun;
+    readonly argumentCount: number;
+    resume(events: Event[]): Promise<WorkflowResumeResult>;
+}
+/** A finished execution attempt: the workflow's output or a live boundary. */
+export type WorkflowResult = {
+    readonly type: 'completed';
+    readonly output: unknown;
+    /** `typeof` the raw return value, for telemetry. */
+    readonly resultType: string;
+} | {
+    readonly type: 'suspended';
+    readonly suspension: WorkflowSuspension;
+    readonly session: WorkflowSession;
+};
+/**
+ * `resume` can additionally decline — `{ type: 'replay' }` means "this
+ * session is unusable, cold-replay instead". A fresh replay never declines.
+ */
+export type WorkflowResumeResult = WorkflowResult | {
+    readonly type: 'replay';
+};
+/** Cold-start: build a fresh VM session and replay it over `events`. */
+export declare function replayWorkflow(options: WorkflowSessionOptions): Promise<WorkflowResult>;
+/** Warm-start: advance a retained session by appending events. */
+export declare function resumeWorkflow(session: WorkflowSession, events: Event[]): Promise<WorkflowResumeResult>;
+/**
+ * Single-shot replay: execute the workflow over `events` and either return
+ * its output or throw its suspension. Kept for the extensive existing test
+ * suites — production code goes through `replayWorkflow`/`resumeWorkflow`.
+ */
 export declare function runWorkflow(workflowCode: string, workflowRun: WorkflowRun, events: Event[], encryptionKey: PayloadKey | undefined, 
 /**
  * Optional per-run cache for replay payload preparation and immutable final
- * values. Owned by the inline replay loop so it survives fresh VM contexts
- * created by successive iterations of this invocation.
+ * values. Owned by the inline execution loop for this invocation.
  */
 replayPayloadCache?: ReplayPayloadCache, 
 /**
@@ -20,4 +66,5 @@ runReadyBarrier?: Promise<unknown>,
  * capabilities are treated as unsupported.
  */
 worldCapabilities?: WorldCapabilities): Promise<Uint8Array | unknown>;
+export {};
 //# sourceMappingURL=workflow.d.ts.map

package/dist/workflow.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"workflow.d.ts","sourceRoot":"","sources":["../src/workflow.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAS7E,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAK/D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AA4FhE,wBAAsB,WAAW,CAC/B,YAAY,EAAE,MAAM,EACpB,WAAW,EAAE,WAAW,EACxB,MAAM,EAAE,KAAK,EAAE,EACf,aAAa,EAAE,UAAU,GAAG,SAAS;AACrC;;;;GAIG;AACH,kBAAkB,GAAE,kBAEnB;AACD;;;;;GAKG;AACH,eAAe,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC;AAClC;;;GAGG;AACH,iBAAiB,CAAC,EAAE,iBAAiB,GACpC,OAAO,CAAC,UAAU,GAAG,OAAO,CAAC,CAquB/B"}
+{"version":3,"file":"workflow.d.ts","sourceRoot":"","sources":["../src/workflow.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAU7E,OAAO,EAAW,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAG1D,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAK/D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AA4FhE,uEAAuE;AACvE,UAAU,sBAAsB;IAC9B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAClC,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC;IACzB,QAAQ,CAAC,aAAa,EAAE,UAAU,GAAG,SAAS,CAAC;IAC/C,QAAQ,CAAC,kBAAkB,EAAE,kBAAkB,CAAC;IAChD,QAAQ,CAAC,eAAe,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IAC5C,QAAQ,CAAC,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;CAChD;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAClC,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,MAAM,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;CACxD;AAED,8EAA8E;AAC9E,MAAM,MAAM,cAAc,GACtB;IACE,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAC3B,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,oDAAoD;IACpD,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B,GACD;IACE,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAC3B,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAC;IACxC,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC;CACnC,CAAC;AAEN;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,cAAc,GAAG;IAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;CAAE,CAAC;AAYhF,wEAAwE;AACxE,wBAAgB,cAAc,CAC5B,OAAO,EAAE,sBAAsB,GAC9B,OAAO,CAAC,cAAc,CAAC,CAazB;AAED,kEAAkE;AAClE,wBAAgB,cAAc,CAC5B,OAAO,EAAE,eAAe,EACxB,MAAM,EAAE,KAAK,EAAE,GACd,OAAO,CAAC,oBAAoB,CAAC,CAa/B;AAkCD;;;;GAIG;AACH,wBAAsB,WAAW,CAC/B,YAAY,EAAE,MAAM,EACpB,WAAW,EAAE,WAAW,EACxB,MAAM,EAAE,KAAK,EAAE,EACf,aAAa,EAAE,UAAU,GAAG,SAAS;AACrC;;;GAGG;AACH,kBAAkB,GAAE,kBAEnB;AACD;;;;;GAKG;AACH,eAAe,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC;AAClC;;;GAGG;AACH,iBAAiB,CAAC,EAAE,iBAAiB,GACpC,OAAO,CAAC,UAAU,GAAG,OAAO,CAAC,CAY/B"}