pipeai 0.8.0 → 0.8.2

package/README.md

@@ -299,6 +299,23 @@ const pipeline = Workflow.create<Ctx>()
   });
 ```
 
+An inline `.step(id, fn)` handler receives `{ ctx, input, writer? }`. When the workflow runs via `.stream(...)`, `writer` is the same `UIMessageStreamWriter` the agent steps merge into — so an inline step can surface mid-pipeline progress (status/data parts) to the client before the terminal agent starts emitting tokens. `writer` is `undefined` in generate mode (`.generate(...)`), so guard with `?.`:
+
+```ts
+const pipeline = Workflow.create<Ctx>()
+  .step("plan", async ({ ctx, input, writer }) => {
+    writer?.write({ type: "data-status", data: { phase: "planning" } });
+    return planner.run(ctx, input);
+  })
+  .step("search", async ({ ctx, input, writer }) => {
+    writer?.write({ type: "data-status", data: { phase: "searching", queries: input.queries.length } });
+    return ctx.search.run(input.queries);
+  })
+  .step(synthesizerAgent); // terminal streaming agent
+```
+
+For ambient writer access from helper functions called *inside* a step, compose the AI SDK's `createUIMessageStream` directly — pipeai only threads `writer` into the inline step handler itself.
+
 ### Running a workflow
 
 ```ts

package/dist/index.cjs

@@ -710,7 +710,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,
@@ -990,7 +992,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());
         }
@@ -1219,7 +1221,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 };
   }
@@ -1281,7 +1285,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 };
   }
@@ -1336,7 +1342,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
           });
         }
       };