@mastra/ai-sdk 1.5.1 → 1.6.0-alpha.0

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @mastra/ai-sdk
 
+## 1.6.0-alpha.0
+
+### Minor Changes
+
+- Added `workflowSnapshotToStream` utility to convert a `WorkflowState` (as returned by `getWorkflowRunById`) into an AI SDK-compatible stream. This lets you display historical workflow runs using the same `useChat`-powered UI components used for live workflow streams. ([#18453](https://github.com/mastra-ai/mastra/pull/18453))
+
+  **Example usage:**
+
+  ```ts
+  import { workflowSnapshotToStream } from '@mastra/ai-sdk';
+  import { createUIMessageStreamResponse } from 'ai';
+
+  const workflowRun = await mastra.getWorkflow('myWorkflow').getWorkflowRunById(runId);
+  const stream = workflowSnapshotToStream(workflowRun);
+  return createUIMessageStreamResponse({ stream });
+  ```
+
+### Patch Changes
+
+- Updated dependencies [[`bf3fe49`](https://github.com/mastra-ai/mastra/commit/bf3fe49f9467dbbdb8f9eaf74e0f7971ffb19559), [`24ceaea`](https://github.com/mastra-ai/mastra/commit/24ceaea0bdd8609cabbab764380608ca6621a194), [`6ccf67b`](https://github.com/mastra-ai/mastra/commit/6ccf67bf075753754927a57bc2e1734ba2c820c5), [`825d8de`](https://github.com/mastra-ai/mastra/commit/825d8def9fa64c2bcc3d8dd6b49e09342c3ac5c7), [`ffa09e7`](https://github.com/mastra-ai/mastra/commit/ffa09e772a5c92270eabe2090fc42d45bd8ec4b7), [`461a7c5`](https://github.com/mastra-ai/mastra/commit/461a7c501449295287f4f0ee4b0b42344f39fcf8), [`4211472`](https://github.com/mastra-ai/mastra/commit/4211472a5a2bd319c60cd2e42d9109c3eef7ac1c), [`9e45902`](https://github.com/mastra-ai/mastra/commit/9e4590208e745055cecca202e2db0e5c65e17d3c), [`5c0df77`](https://github.com/mastra-ai/mastra/commit/5c0df776c40efa420f8c07a2f3ee66010296618e)]:
+  - @mastra/core@1.47.0-alpha.3
+
 ## 1.5.1
 
 ### Patch Changes

package/dist/convert-snapshot.d.ts

@@ -0,0 +1,25 @@
+import type { WorkflowState } from '@mastra/core/workflows';
+import type { WorkflowDataPart, WorkflowStepDataPart } from './transformers.js';
+/**
+ * Converts a `WorkflowState` (as returned by `getWorkflowRunById` or the
+ * workflow runs API) into a `ReadableStream` of AI SDK UIMessage data parts —
+ * the same `WorkflowDataPart` and `WorkflowStepDataPart` chunks that the live
+ * workflow stream transformer produces. This lets you display historical
+ * workflow runs using the same `useChat`-powered components used for live runs.
+ *
+ * @example
+ * ```ts
+ * import { workflowSnapshotToStream } from '@mastra/ai-sdk';
+ * import { createUIMessageStreamResponse } from 'ai';
+ *
+ * const workflowRun = await mastra.getWorkflow('myWorkflow').getWorkflowRunById(runId);
+ * const stream = workflowSnapshotToStream(workflowRun);
+ * return createUIMessageStreamResponse({ stream });
+ * ```
+ */
+export declare function workflowSnapshotToStream(workflowRun: WorkflowState): ReadableStream<WorkflowDataPart | WorkflowStepDataPart | {
+    type: 'start';
+} | {
+    type: 'finish';
+}>;
+//# sourceMappingURL=convert-snapshot.d.ts.map

package/dist/convert-snapshot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"convert-snapshot.d.ts","sourceRoot":"","sources":["../src/convert-snapshot.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAA0D,MAAM,wBAAwB,CAAC;AACpH,OAAO,KAAK,EAAE,gBAAgB,EAAE,oBAAoB,EAAc,MAAM,gBAAgB,CAAC;AAGzF;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,wBAAwB,CACtC,WAAW,EAAE,aAAa,GACzB,cAAc,CAAC,gBAAgB,GAAG,oBAAoB,GAAG;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,CAAC,CAmClG"}

package/dist/index.cjs

@@ -14517,6 +14517,69 @@ function networkRoute({
     }
   });
 }
+
+// src/convert-snapshot.ts
+function workflowSnapshotToStream(workflowRun) {
+  const steps = workflowStateToSteps(workflowRun.steps ?? {});
+  const current = { name: workflowRun.workflowName, steps };
+  const runId = workflowRun.runId;
+  const status = workflowRun.status;
+  return new ReadableStream({
+    start(controller) {
+      controller.enqueue({ type: "start" });
+      controller.enqueue(
+        createWorkflowDataPart({
+          current,
+          runId,
+          status,
+          includeOutputs: true,
+          output: null
+        })
+      );
+      for (const stepId of Object.keys(steps)) {
+        controller.enqueue(
+          createWorkflowStepDataPart({
+            current,
+            runId,
+            status,
+            stepId
+          })
+        );
+      }
+      controller.enqueue({ type: "finish" });
+      controller.close();
+    }
+  });
+}
+function workflowStateToSteps(stateSteps) {
+  const steps = {};
+  for (const [key, value] of Object.entries(stateSteps)) {
+    const stepResult = Array.isArray(value) ? mergeForEachStepResult(value) : value;
+    if (!stepResult || typeof stepResult !== "object" || !("status" in stepResult)) continue;
+    steps[key] = {
+      name: key,
+      status: stepResult.status,
+      input: stepResult.payload ?? null,
+      output: stepResult.output ?? null,
+      suspendPayload: stepResult.suspendPayload ?? null,
+      resumePayload: stepResult.resumePayload ?? null
+    };
+  }
+  return steps;
+}
+function mergeForEachStepResult(results) {
+  const stepResults = results.filter(
+    (result) => !!result && typeof result === "object" && "status" in result
+  );
+  if (stepResults.length === 0) return void 0;
+  const representative = stepResults.find((result) => result.status === "suspended") ?? stepResults.find((result) => result.status === "failed") ?? stepResults[0];
+  if (!representative) return void 0;
+  return {
+    ...representative,
+    payload: stepResults.map((result) => result.payload),
+    output: stepResults.map((result) => result.output)
+  };
+}
 function withMastra(model, options = {}) {
   const { memory, inputProcessors = [], outputProcessors = [] } = options;
   const allInputProcessors = [...inputProcessors];
@@ -15216,5 +15279,6 @@ exports.toAISdkStream = toAISdkStream;
 exports.toAISdkV5Stream = toAISdkV5Stream;
 exports.withMastra = withMastra;
 exports.workflowRoute = workflowRoute;
+exports.workflowSnapshotToStream = workflowSnapshotToStream;
 //# sourceMappingURL=index.cjs.map
 //# sourceMappingURL=index.cjs.map