pipeai 0.8.0 → 0.8.2

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { Tool, ToolExecutionOptions, UIMessageStreamWriter, FlexibleSchema, streamText, generateText, Output, LanguageModel, ModelMessage, ToolChoice, ToolSet, StopCondition, OnStepFinishEvent, OnFinishEvent, GenerateTextResult as GenerateTextResult$1, StreamTextResult as StreamTextResult$1 } from 'ai';
+import { Tool, ToolExecutionOptions, UIMessageStreamWriter, FlexibleSchema, streamText, generateText, Output, LanguageModel, ModelMessage, ToolChoice, ToolSet, StopCondition, OnStepFinishEvent, OnFinishEvent, GenerateTextResult as GenerateTextResult$1, StreamTextResult as StreamTextResult$1, UIMessage, UIMessageStreamOnFinishCallback, IdGenerator } from 'ai';
 import { ZodType } from 'zod';
 
 declare const TOOL_PROVIDER_BRAND: unique symbol;
@@ -443,6 +443,7 @@ interface AgentStepHooks<TContext, TOutput, TNextOutput> {
         result: StreamTextResult<ToolSet, OutputType<TNextOutput>>;
         writer: UIMessageStreamWriter;
         ctx: Readonly<TContext>;
+        input: TOutput;
     }) => MaybePromise<void>;
 }
 type StepOptions<TContext, TOutput, TNextOutput> = AgentStepHooks<TContext, TOutput, TNextOutput> & {
@@ -490,9 +491,50 @@ interface WorkflowStreamResult<TOutput> {
     stream: ReadableStream;
     output: Promise<WorkflowResult<TOutput>>;
 }
-interface WorkflowStreamOptions {
+/**
+ * Options for `Workflow.stream` / `ResumedWorkflow.stream` /
+ * `CheckpointResumedWorkflow.stream`. Forwarded verbatim to the AI SDK's
+ * `createUIMessageStream`.
+ *
+ * Generic over the UI message shape so consumers with a custom
+ * `UIMessage<METADATA, DATA_PARTS, TOOLS>` get their narrowed type in
+ * `onFinish` / `originalMessages` instead of the unparameterized default.
+ *
+ * Note: AI SDK's `createUIMessageStream` ALSO accepts an `onStepFinish`
+ * (per-token-step) callback. We intentionally do NOT expose it here — there
+ * are already two clearer step-finish callbacks at different granularities:
+ * - `Agent.onStepFinish` for per-model-call observation, and
+ * - `WorkflowObservability.onStepFinish` for per-workflow-step observation.
+ * Adding a third one named the same thing on `WorkflowStreamOptions` would
+ * be confusing. Reach for one of the two above instead.
+ */
+interface WorkflowStreamOptions<UI_MESSAGE extends UIMessage = UIMessage> {
+    /**
+     * Map an unknown error into a user-visible string. Forwarded as-is to
+     * `createUIMessageStream`'s `onError`. Returning `string` is required by
+     * the AI SDK — the string is what the stream emits to clients.
+     */
     onError?: (error: unknown) => string;
-    onFinish?: () => MaybePromise<void>;
+    /**
+     * Prior `UIMessage`s the stream should continue from. When provided, the
+     * AI SDK assumes persistence mode and assigns a response-message id.
+     * Used for chat resumption / continuation flows.
+     */
+    originalMessages?: UI_MESSAGE[];
+    /**
+     * Fires once the stream finishes, with the full payload the AI SDK
+     * delivers: the updated `messages` array, the freshly-emitted
+     * `responseMessage`, `isAborted` / `isContinuation` flags, and the
+     * `finishReason`. Use this for persistence, analytics, or downstream
+     * notification.
+     */
+    onFinish?: UIMessageStreamOnFinishCallback<UI_MESSAGE>;
+    /**
+     * Override the response message-id generator. Forwarded to
+     * `createUIMessageStream`'s `generateId` option. Useful for deterministic
+     * IDs in tests or coordinating with a server-side ID space.
+     */
+    generateId?: IdGenerator;
 }
 type LoopPredicate<TContext, TOutput> = (params: {
     output: TOutput;
@@ -652,7 +694,7 @@ declare class SealedWorkflow<TContext, TInput = void, TOutput = void, TGates ext
     protected fireHook<K extends keyof WorkflowObservability, E extends Parameters<NonNullable<WorkflowObservability[K]>>[0]>(state: RuntimeState, name: K, event: E): MaybePromise<unknown>;
     private fireHookSlow;
     generate(ctx: TContext, ...args: TInput extends void ? [input?: TInput, opts?: RunOptions] : [input: TInput, opts?: RunOptions]): Promise<WorkflowResult<TOutput>>;
-    stream(ctx: TContext, ...args: TInput extends void ? [input?: TInput, options?: WorkflowStreamOptions, opts?: RunOptions] : [input: TInput, options?: WorkflowStreamOptions, opts?: RunOptions]): WorkflowStreamResult<TOutput>;
+    stream<UI_MESSAGE extends UIMessage = UIMessage>(ctx: TContext, ...args: TInput extends void ? [input?: TInput, options?: WorkflowStreamOptions<UI_MESSAGE>, opts?: RunOptions] : [input: TInput, options?: WorkflowStreamOptions<UI_MESSAGE>, opts?: RunOptions]): WorkflowStreamResult<TOutput>;
     protected buildResult(state: RuntimeState): WorkflowResult<TOutput>;
     protected execute(state: RuntimeState, startIndex?: number, opts?: RunOptions, initialError?: PendingError | null): Promise<void>;
     protected executeNestedWorkflow(state: RuntimeState, workflow: SealedWorkflow<TContext, unknown, unknown, any>): Promise<void>;
@@ -704,7 +746,7 @@ declare class ResumedWorkflow<TContext, TResponse = unknown, TOutput = void> ext
     constructor(steps: ReadonlyArray<StepNode>, startIndex: number, config: ResumedWorkflowConfig);
     private validateResponse;
     generate(ctx: TContext, ...args: TResponse extends void ? [response?: TResponse, opts?: RunOptions] : [response: TResponse, opts?: RunOptions]): Promise<WorkflowResult<TOutput>>;
-    stream(ctx: TContext, ...args: TResponse extends void ? [response?: TResponse, options?: WorkflowStreamOptions, opts?: RunOptions] : [response: TResponse, options?: WorkflowStreamOptions, opts?: RunOptions]): WorkflowStreamResult<TOutput>;
+    stream<UI_MESSAGE extends UIMessage = UIMessage>(ctx: TContext, ...args: TResponse extends void ? [response?: TResponse, options?: WorkflowStreamOptions<UI_MESSAGE>, opts?: RunOptions] : [response: TResponse, options?: WorkflowStreamOptions<UI_MESSAGE>, opts?: RunOptions]): WorkflowStreamResult<TOutput>;
 }
 declare class CheckpointResumedWorkflow<TContext, TOutput = void> extends SealedWorkflow<TContext, void, TOutput> {
     private readonly startIndex;
@@ -712,7 +754,7 @@ declare class CheckpointResumedWorkflow<TContext, TOutput = void> extends Sealed
     /** @internal */
     constructor(steps: ReadonlyArray<StepNode>, startIndex: number, config: ResumedWorkflowConfig);
     generate(ctx: TContext, ...args: [input?: void, opts?: RunOptions]): Promise<WorkflowResult<TOutput>>;
-    stream(ctx: TContext, ...args: [input?: void, options?: WorkflowStreamOptions, opts?: RunOptions]): WorkflowStreamResult<TOutput>;
+    stream<UI_MESSAGE extends UIMessage = UIMessage>(ctx: TContext, ...args: [input?: void, options?: WorkflowStreamOptions<UI_MESSAGE>, opts?: RunOptions]): WorkflowStreamResult<TOutput>;
 }
 declare class Workflow<TContext, TInput = void, TOutput = void, TGates extends Record<string, unknown> = {}> extends SealedWorkflow<TContext, TInput, TOutput, TGates> {
     /**
@@ -733,6 +775,7 @@ declare class Workflow<TContext, TInput = void, TOutput = void, TGates extends R
     step<TNextOutput>(id: string, fn: (params: {
         ctx: Readonly<TContext>;
         input: TOutput;
+        writer?: UIMessageStreamWriter;
     }) => MaybePromise<TNextOutput>): Workflow<TContext, TInput, TNextOutput, TGates>;
     gate<TResponse = TOutput, Id extends string = string>(id: Id & (Id extends keyof TGates ? never : Id), options?: {
         payload?: (params: {

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Tool, ToolExecutionOptions, UIMessageStreamWriter, FlexibleSchema, streamText, generateText, Output, LanguageModel, ModelMessage, ToolChoice, ToolSet, StopCondition, OnStepFinishEvent, OnFinishEvent, GenerateTextResult as GenerateTextResult$1, StreamTextResult as StreamTextResult$1 } from 'ai';
+import { Tool, ToolExecutionOptions, UIMessageStreamWriter, FlexibleSchema, streamText, generateText, Output, LanguageModel, ModelMessage, ToolChoice, ToolSet, StopCondition, OnStepFinishEvent, OnFinishEvent, GenerateTextResult as GenerateTextResult$1, StreamTextResult as StreamTextResult$1, UIMessage, UIMessageStreamOnFinishCallback, IdGenerator } from 'ai';
 import { ZodType } from 'zod';
 
 declare const TOOL_PROVIDER_BRAND: unique symbol;
@@ -443,6 +443,7 @@ interface AgentStepHooks<TContext, TOutput, TNextOutput> {
         result: StreamTextResult<ToolSet, OutputType<TNextOutput>>;
         writer: UIMessageStreamWriter;
         ctx: Readonly<TContext>;
+        input: TOutput;
     }) => MaybePromise<void>;
 }
 type StepOptions<TContext, TOutput, TNextOutput> = AgentStepHooks<TContext, TOutput, TNextOutput> & {
@@ -490,9 +491,50 @@ interface WorkflowStreamResult<TOutput> {
     stream: ReadableStream;
     output: Promise<WorkflowResult<TOutput>>;
 }
-interface WorkflowStreamOptions {
+/**
+ * Options for `Workflow.stream` / `ResumedWorkflow.stream` /
+ * `CheckpointResumedWorkflow.stream`. Forwarded verbatim to the AI SDK's
+ * `createUIMessageStream`.
+ *
+ * Generic over the UI message shape so consumers with a custom
+ * `UIMessage<METADATA, DATA_PARTS, TOOLS>` get their narrowed type in
+ * `onFinish` / `originalMessages` instead of the unparameterized default.
+ *
+ * Note: AI SDK's `createUIMessageStream` ALSO accepts an `onStepFinish`
+ * (per-token-step) callback. We intentionally do NOT expose it here — there
+ * are already two clearer step-finish callbacks at different granularities:
+ * - `Agent.onStepFinish` for per-model-call observation, and
+ * - `WorkflowObservability.onStepFinish` for per-workflow-step observation.
+ * Adding a third one named the same thing on `WorkflowStreamOptions` would
+ * be confusing. Reach for one of the two above instead.
+ */
+interface WorkflowStreamOptions<UI_MESSAGE extends UIMessage = UIMessage> {
+    /**
+     * Map an unknown error into a user-visible string. Forwarded as-is to
+     * `createUIMessageStream`'s `onError`. Returning `string` is required by
+     * the AI SDK — the string is what the stream emits to clients.
+     */
     onError?: (error: unknown) => string;
-    onFinish?: () => MaybePromise<void>;
+    /**
+     * Prior `UIMessage`s the stream should continue from. When provided, the
+     * AI SDK assumes persistence mode and assigns a response-message id.
+     * Used for chat resumption / continuation flows.
+     */
+    originalMessages?: UI_MESSAGE[];
+    /**
+     * Fires once the stream finishes, with the full payload the AI SDK
+     * delivers: the updated `messages` array, the freshly-emitted
+     * `responseMessage`, `isAborted` / `isContinuation` flags, and the
+     * `finishReason`. Use this for persistence, analytics, or downstream
+     * notification.
+     */
+    onFinish?: UIMessageStreamOnFinishCallback<UI_MESSAGE>;
+    /**
+     * Override the response message-id generator. Forwarded to
+     * `createUIMessageStream`'s `generateId` option. Useful for deterministic
+     * IDs in tests or coordinating with a server-side ID space.
+     */
+    generateId?: IdGenerator;
 }
 type LoopPredicate<TContext, TOutput> = (params: {
     output: TOutput;
@@ -652,7 +694,7 @@ declare class SealedWorkflow<TContext, TInput = void, TOutput = void, TGates ext
     protected fireHook<K extends keyof WorkflowObservability, E extends Parameters<NonNullable<WorkflowObservability[K]>>[0]>(state: RuntimeState, name: K, event: E): MaybePromise<unknown>;
     private fireHookSlow;
     generate(ctx: TContext, ...args: TInput extends void ? [input?: TInput, opts?: RunOptions] : [input: TInput, opts?: RunOptions]): Promise<WorkflowResult<TOutput>>;
-    stream(ctx: TContext, ...args: TInput extends void ? [input?: TInput, options?: WorkflowStreamOptions, opts?: RunOptions] : [input: TInput, options?: WorkflowStreamOptions, opts?: RunOptions]): WorkflowStreamResult<TOutput>;
+    stream<UI_MESSAGE extends UIMessage = UIMessage>(ctx: TContext, ...args: TInput extends void ? [input?: TInput, options?: WorkflowStreamOptions<UI_MESSAGE>, opts?: RunOptions] : [input: TInput, options?: WorkflowStreamOptions<UI_MESSAGE>, opts?: RunOptions]): WorkflowStreamResult<TOutput>;
     protected buildResult(state: RuntimeState): WorkflowResult<TOutput>;
     protected execute(state: RuntimeState, startIndex?: number, opts?: RunOptions, initialError?: PendingError | null): Promise<void>;
     protected executeNestedWorkflow(state: RuntimeState, workflow: SealedWorkflow<TContext, unknown, unknown, any>): Promise<void>;
@@ -704,7 +746,7 @@ declare class ResumedWorkflow<TContext, TResponse = unknown, TOutput = void> ext
     constructor(steps: ReadonlyArray<StepNode>, startIndex: number, config: ResumedWorkflowConfig);
     private validateResponse;
     generate(ctx: TContext, ...args: TResponse extends void ? [response?: TResponse, opts?: RunOptions] : [response: TResponse, opts?: RunOptions]): Promise<WorkflowResult<TOutput>>;
-    stream(ctx: TContext, ...args: TResponse extends void ? [response?: TResponse, options?: WorkflowStreamOptions, opts?: RunOptions] : [response: TResponse, options?: WorkflowStreamOptions, opts?: RunOptions]): WorkflowStreamResult<TOutput>;
+    stream<UI_MESSAGE extends UIMessage = UIMessage>(ctx: TContext, ...args: TResponse extends void ? [response?: TResponse, options?: WorkflowStreamOptions<UI_MESSAGE>, opts?: RunOptions] : [response: TResponse, options?: WorkflowStreamOptions<UI_MESSAGE>, opts?: RunOptions]): WorkflowStreamResult<TOutput>;
 }
 declare class CheckpointResumedWorkflow<TContext, TOutput = void> extends SealedWorkflow<TContext, void, TOutput> {
     private readonly startIndex;
@@ -712,7 +754,7 @@ declare class CheckpointResumedWorkflow<TContext, TOutput = void> extends Sealed
     /** @internal */
     constructor(steps: ReadonlyArray<StepNode>, startIndex: number, config: ResumedWorkflowConfig);
     generate(ctx: TContext, ...args: [input?: void, opts?: RunOptions]): Promise<WorkflowResult<TOutput>>;
-    stream(ctx: TContext, ...args: [input?: void, options?: WorkflowStreamOptions, opts?: RunOptions]): WorkflowStreamResult<TOutput>;
+    stream<UI_MESSAGE extends UIMessage = UIMessage>(ctx: TContext, ...args: [input?: void, options?: WorkflowStreamOptions<UI_MESSAGE>, opts?: RunOptions]): WorkflowStreamResult<TOutput>;
 }
 declare class Workflow<TContext, TInput = void, TOutput = void, TGates extends Record<string, unknown> = {}> extends SealedWorkflow<TContext, TInput, TOutput, TGates> {
     /**
@@ -733,6 +775,7 @@ declare class Workflow<TContext, TInput = void, TOutput = void, TGates extends R
     step<TNextOutput>(id: string, fn: (params: {
         ctx: Readonly<TContext>;
         input: TOutput;
+        writer?: UIMessageStreamWriter;
     }) => MaybePromise<TNextOutput>): Workflow<TContext, TInput, TNextOutput, TGates>;
     gate<TResponse = TOutput, Id extends string = string>(id: Id & (Id extends keyof TGates ? never : Id), options?: {
         payload?: (params: {

package/dist/index.js

@@ -677,7 +677,9 @@ var SealedWorkflow = class _SealedWorkflow {
         }
       },
       ...options?.onError ? { onError: options.onError } : {},
-      ...options?.onFinish ? { onFinish: options.onFinish } : {}
+      ...options?.onFinish ? { onFinish: options.onFinish } : {},
+      ...options?.originalMessages ? { originalMessages: options.originalMessages } : {},
+      ...options?.generateId ? { generateId: options.generateId } : {}
     });
     return {
       stream,
@@ -957,7 +959,7 @@ var SealedWorkflow = class _SealedWorkflow {
       await runWithWriter(writer, async () => {
         const result = await agent.stream(ctx, state.output, agentCallOpts);
         if (options?.handleStream) {
-          await options.handleStream({ result, writer, ctx });
+          await options.handleStream({ result, writer, ctx, input });
         } else {
           writer.merge(result.toUIMessageStream());
         }
@@ -1186,7 +1188,9 @@ var ResumedWorkflow = class extends SealedWorkflow {
         }
       },
       ...options?.onError ? { onError: options.onError } : {},
-      ...options?.onFinish ? { onFinish: options.onFinish } : {}
+      ...options?.onFinish ? { onFinish: options.onFinish } : {},
+      ...options?.originalMessages ? { originalMessages: options.originalMessages } : {},
+      ...options?.generateId ? { generateId: options.generateId } : {}
     });
     return { stream, output: outputPromise };
   }
@@ -1248,7 +1252,9 @@ var CheckpointResumedWorkflow = class extends SealedWorkflow {
         }
       },
       ...options?.onError ? { onError: options.onError } : {},
-      ...options?.onFinish ? { onFinish: options.onFinish } : {}
+      ...options?.onFinish ? { onFinish: options.onFinish } : {},
+      ...options?.originalMessages ? { originalMessages: options.originalMessages } : {},
+      ...options?.generateId ? { generateId: options.generateId } : {}
     });
     return { stream, output: outputPromise };
   }
@@ -1303,7 +1309,10 @@ var Workflow = class _Workflow extends SealedWorkflow {
         execute: async (state) => {
           state.output = await fn({
             ctx: state.ctx,
-            input: state.output
+            input: state.output,
+            // Present in stream mode (undefined in generate mode), letting the
+            // inline step emit UIMessageChunk parts onto the workflow's stream.
+            writer: state.writer
           });
         }
       };