@ai-sdk/workflow 1.0.4 → 1.0.6

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @ai-sdk/workflow
 
+## 1.0.6
+
+### Patch Changes
+
+- 4a9f4d5: `WorkflowChatTransport` now repairs UI message stream part framing, so duplicated or interleaved durable stream writes no longer crash the AI SDK consumer with `Received text-delta for missing text part`.
+- 4016539: Forward `reasoning` generation settings from `WorkflowAgent` to model calls.
+- Updated dependencies [989402d]
+  - ai@7.0.6
+
+## 1.0.5
+
+### Patch Changes
+
+- Updated dependencies [a2750db]
+  - ai@7.0.5
+
 ## 1.0.4
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { LanguageModelV4, SharedV4ProviderOptions, LanguageModelV4CallOptions, LanguageModelV4Prompt, LanguageModelV4StreamPart } from '@ai-sdk/provider';
+import { LanguageModelV4, LanguageModelV4CallOptions, SharedV4ProviderOptions, LanguageModelV4Prompt, LanguageModelV4StreamPart } from '@ai-sdk/provider';
 import { Context, HasRequiredKey, InferToolSetContext } from '@ai-sdk/provider-utils';
 import { ToolSet, LanguageModel, Instructions, ToolChoice, TelemetryOptions as TelemetryOptions$1, StopCondition, ActiveTools, LanguageModelResponseMetadata, LanguageModelUsage, FinishReason, ToolCallRepairFunction, Experimental_SandboxSession, StepResult, GenerateTextOnStepEndCallback, ModelMessage, Experimental_LanguageModelStreamPart, UIMessage, UIMessageChunk, ChatTransport, PrepareSendMessagesRequest, PrepareReconnectToStreamRequest, ChatRequestOptions } from 'ai';
 export { Experimental_LanguageModelStreamPart as ModelCallStreamPart, Output, ToolCallRepairFunction } from 'ai';
@@ -151,6 +151,11 @@ interface GenerationSettings {
      * Only applicable for HTTP-based providers.
      */
     headers?: Record<string, string | undefined>;
+    /**
+     * Reasoning effort level for the model. Controls how much reasoning
+     * the model performs before generating a response.
+     */
+    reasoning?: LanguageModelV4CallOptions['reasoning'];
     /**
      * Additional provider-specific options. They are passed through
      * to the provider from the AI SDK and enable provider-specific
@@ -1106,4 +1111,56 @@ declare class WorkflowChatTransport<UI_MESSAGE extends UIMessage> implements Cha
     private onFinish;
 }
 
-export { type CompatibleLanguageModel, type DownloadFunction, type GenerationSettings, type InferWorkflowAgentTools, type InferWorkflowAgentUIMessage, type OutputSpecification, type PrepareCallCallback, type PrepareCallOptions, type PrepareCallResult, type PrepareStepCallback, type PrepareStepInfo, type PrepareStepResult, type ProviderOptions, type ReconnectToStreamOptions, type SendMessagesOptions, type StreamTextTransform, type TelemetryOptions, WorkflowAgent, type WorkflowAgentOnAbortCallback, type WorkflowAgentOnEndCallback, type WorkflowAgentOnErrorCallback, type WorkflowAgentOnFinishCallback, type WorkflowAgentOnStartCallback, type WorkflowAgentOnStepEndCallback, type WorkflowAgentOnStepFinishCallback, type WorkflowAgentOnStepStartCallback, type WorkflowAgentOnToolExecutionEndCallback, type WorkflowAgentOnToolExecutionStartCallback, type WorkflowAgentOptions, type WorkflowAgentStreamOptions, type WorkflowAgentStreamResult, WorkflowChatTransport, type WorkflowChatTransportOptions, createModelCallToUIChunkTransform, toUIMessageChunk };
+/**
+ * Normalizes the part framing of a UI message stream so it is always
+ * well-formed for the AI SDK's stream consumer (`processUIMessageStream`,
+ * which backs `useChat`/`readUIMessageStream`).
+ *
+ * ## Why this exists
+ *
+ * The consumer maintains a map of "active" text/reasoning parts keyed by id.
+ * A `text-delta`/`text-end` for an id that has no open part is a fatal error
+ * (`Received text-delta for missing text part with ID "0" ...`) that kills the
+ * whole turn. Two properties of the durable streaming model make that error
+ * reachable:
+ *
+ * - A workflow run owns a single shared stream, and the consumer resets its
+ *   active-part maps on every `finish-step`. Multi-step turns reuse the same
+ *   part id (commonly `"0"`) in each step, so a single dropped or duplicated
+ *   `*-start` across a step boundary orphans the rest of that step's content.
+ * - The same stream is read across reconnects, and a stream-producing step can
+ *   run more than once (retry/redelivery, or the concurrent-worker duplication
+ *   tracked in vercel/workflow#2331 and #2039). Either can interleave or
+ *   duplicate chunks on the shared stream — e.g. a `finish-step` landing in the
+ *   middle of another execution's text part.
+ *
+ * Since the content is still flowing and only the framing is damaged, repairing
+ * the framing here degrades the worst case to "text begins slightly into the
+ * step" or "a duplicated tail is dropped" instead of a dead turn.
+ *
+ * ## What it does
+ *
+ * Mirrors the consumer's part-lifetime state machine, per part type, per step:
+ * - resets tracking on `finish-step` (exactly where the consumer resets);
+ * - synthesizes a missing `*-start` when an orphaned `*-delta`/`*-end` arrives;
+ * - drops a re-delivered `*-start`/`*-delta`/`*-end` for a part already
+ *   open or ended in the current step (reconnect/replay overlap).
+ *
+ * A well-formed stream passes through unchanged.
+ *
+ * ## Scope: text and reasoning only
+ *
+ * `tool-input-delta` raises the same class of fatal error (`Received
+ * tool-input-delta for missing tool call ...`), but tool parts are deliberately
+ * left untouched: the consumer does not reset its tool-call map on `finish-step`
+ * and tool-call ids are unique, so the step-boundary id-reuse orphaning that
+ * makes text/reasoning fragile does not apply to them. If a future duplication
+ * mode is found to orphan tool-input parts, extend the same machine to that
+ * family rather than special-casing it.
+ *
+ * @param source the raw UI message chunk stream to normalize.
+ * @yields the framing-corrected UI message chunks.
+ */
+declare function normalizeUIMessageStreamParts(source: AsyncIterable<UIMessageChunk>): AsyncGenerator<UIMessageChunk>;
+
+export { type CompatibleLanguageModel, type DownloadFunction, type GenerationSettings, type InferWorkflowAgentTools, type InferWorkflowAgentUIMessage, type OutputSpecification, type PrepareCallCallback, type PrepareCallOptions, type PrepareCallResult, type PrepareStepCallback, type PrepareStepInfo, type PrepareStepResult, type ProviderOptions, type ReconnectToStreamOptions, type SendMessagesOptions, type StreamTextTransform, type TelemetryOptions, WorkflowAgent, type WorkflowAgentOnAbortCallback, type WorkflowAgentOnEndCallback, type WorkflowAgentOnErrorCallback, type WorkflowAgentOnFinishCallback, type WorkflowAgentOnStartCallback, type WorkflowAgentOnStepEndCallback, type WorkflowAgentOnStepFinishCallback, type WorkflowAgentOnStepStartCallback, type WorkflowAgentOnToolExecutionEndCallback, type WorkflowAgentOnToolExecutionStartCallback, type WorkflowAgentOptions, type WorkflowAgentStreamOptions, type WorkflowAgentStreamResult, WorkflowChatTransport, type WorkflowChatTransportOptions, createModelCallToUIChunkTransform, normalizeUIMessageStreamParts, toUIMessageChunk };

package/dist/index.mjs

@@ -160,6 +160,7 @@ async function doStreamStep(conversationPrompt, modelInit, writable, serializedT
     providerOptions: options == null ? void 0 : options.providerOptions,
     abortSignal: options == null ? void 0 : options.abortSignal,
     headers: options == null ? void 0 : options.headers,
+    reasoning: options == null ? void 0 : options.reasoning,
     maxOutputTokens: options == null ? void 0 : options.maxOutputTokens,
     temperature: options == null ? void 0 : options.temperature,
     topP: options == null ? void 0 : options.topP,
@@ -492,6 +493,12 @@ async function* streamTextIterator({
           headers: prepareResult.headers
         };
       }
+      if ((prepareResult == null ? void 0 : prepareResult.reasoning) !== void 0) {
+        currentGenerationSettings = {
+          ...currentGenerationSettings,
+          reasoning: prepareResult.reasoning
+        };
+      }
       if ((prepareResult == null ? void 0 : prepareResult.providerOptions) !== void 0) {
         currentGenerationSettings = {
           ...currentGenerationSettings,
@@ -551,6 +558,7 @@ async function* streamTextIterator({
         frequencyPenalty: currentGenerationSettings.frequencyPenalty,
         stopSequences: currentGenerationSettings.stopSequences,
         seed: currentGenerationSettings.seed,
+        reasoning: currentGenerationSettings.reasoning,
         providerOptions: currentGenerationSettings.providerOptions,
         headers: currentGenerationSettings.headers
       }));
@@ -745,6 +753,7 @@ var WorkflowAgent = class {
       maxRetries: options.maxRetries,
       abortSignal: options.abortSignal,
       headers: options.headers,
+      reasoning: options.reasoning,
       providerOptions: options.providerOptions
     };
   }
@@ -809,6 +818,8 @@ var WorkflowAgent = class {
         effectiveGenerationSettings.seed = prepared.seed;
       if (prepared.headers !== void 0)
         effectiveGenerationSettings.headers = prepared.headers;
+      if (prepared.reasoning !== void 0)
+        effectiveGenerationSettings.reasoning = prepared.reasoning;
       if (prepared.providerOptions !== void 0)
         effectiveGenerationSettings.providerOptions = prepared.providerOptions;
     }
@@ -1110,6 +1121,7 @@ var WorkflowAgent = class {
         abortSignal: effectiveAbortSignal
       },
       ...options.headers !== void 0 && { headers: options.headers },
+      ...options.reasoning !== void 0 && { reasoning: options.reasoning },
       ...options.providerOptions !== void 0 && {
         providerOptions: options.providerOptions
       }
@@ -1183,6 +1195,7 @@ var WorkflowAgent = class {
       maxRetries: (_t = mergedGenerationSettings.maxRetries) != null ? _t : 2,
       timeout: void 0,
       headers: mergedGenerationSettings.headers,
+      reasoning: mergedGenerationSettings.reasoning,
       providerOptions: mergedGenerationSettings.providerOptions,
       output: (_u = options.output) != null ? _u : this.output,
       runtimeContext,
@@ -2159,6 +2172,83 @@ import {
   getErrorMessage as getErrorMessage2
 } from "@ai-sdk/provider-utils";
 import { createAsyncIterableStream } from "ai/internal";
+
+// src/normalize-ui-message-stream.ts
+var newPartFrameState = () => ({
+  open: /* @__PURE__ */ new Set(),
+  ended: /* @__PURE__ */ new Set()
+});
+function* repairPart(kind, id, chunk, state, startType) {
+  if (kind === "start") {
+    if (state.open.has(id) || state.ended.has(id)) {
+      return;
+    }
+    state.open.add(id);
+    yield chunk;
+    return;
+  }
+  if (state.ended.has(id)) {
+    return;
+  }
+  if (!state.open.has(id)) {
+    state.open.add(id);
+    yield { type: startType, id };
+  }
+  if (kind === "end") {
+    state.open.delete(id);
+    state.ended.add(id);
+  }
+  yield chunk;
+}
+async function* normalizeUIMessageStreamParts(source) {
+  const text = newPartFrameState();
+  const reasoning = newPartFrameState();
+  for await (const chunk of source) {
+    switch (chunk.type) {
+      case "finish-step":
+        text.open.clear();
+        text.ended.clear();
+        reasoning.open.clear();
+        reasoning.ended.clear();
+        yield chunk;
+        break;
+      case "text-start":
+        yield* repairPart("start", chunk.id, chunk, text, "text-start");
+        break;
+      case "text-delta":
+        yield* repairPart("delta", chunk.id, chunk, text, "text-start");
+        break;
+      case "text-end":
+        yield* repairPart("end", chunk.id, chunk, text, "text-start");
+        break;
+      case "reasoning-start":
+        yield* repairPart(
+          "start",
+          chunk.id,
+          chunk,
+          reasoning,
+          "reasoning-start"
+        );
+        break;
+      case "reasoning-delta":
+        yield* repairPart(
+          "delta",
+          chunk.id,
+          chunk,
+          reasoning,
+          "reasoning-start"
+        );
+        break;
+      case "reasoning-end":
+        yield* repairPart("end", chunk.id, chunk, reasoning, "reasoning-start");
+        break;
+      default:
+        yield chunk;
+    }
+  }
+}
+
+// src/workflow-chat-transport.ts
 var WorkflowChatTransport = class {
   /**
    * Creates a new WorkflowChatTransport instance.
@@ -2203,7 +2293,7 @@ var WorkflowChatTransport = class {
    */
   async sendMessages(options) {
     return convertAsyncIteratorToReadableStream(
-      this.sendMessagesIterator(options)
+      normalizeUIMessageStreamParts(this.sendMessagesIterator(options))
     );
   }
   async *sendMessagesIterator(options) {
@@ -2281,7 +2371,9 @@ var WorkflowChatTransport = class {
    * @throws Error if the reconnection request fails or returns a non-OK status
    */
   async reconnectToStream(options) {
-    const reconnectIterator = this.reconnectToStreamIterator(options);
+    const reconnectIterator = normalizeUIMessageStreamParts(
+      this.reconnectToStreamIterator(options)
+    );
     return convertAsyncIteratorToReadableStream(reconnectIterator);
   }
   async *reconnectToStreamIterator(options, workflowRunId, initialChunkIndex = 0) {
@@ -2374,6 +2466,7 @@ export {
   WorkflowAgent,
   WorkflowChatTransport,
   createModelCallToUIChunkTransform,
+  normalizeUIMessageStreamParts,
   toUIMessageChunk
 };
 //# sourceMappingURL=index.mjs.map