@ai-sdk/openai 3.0.101 → 3.0.102

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @ai-sdk/openai
 
+## 3.0.102
+
+### Patch Changes
+
+- 087d7e2: Signal schema-invalid known Responses stream events and preserve the error finish reason.
+
 ## 3.0.101
 
 ### Patch Changes

package/dist/index.d.mts

@@ -314,6 +314,18 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
     type: "response.output_item.added";
     output_index: number;
     item: {
+        type: "local_shell_call";
+        id: string;
+        call_id: string;
+        action: {
+            type: "exec";
+            command: string[];
+            timeout_ms?: number | undefined;
+            user?: string | undefined;
+            working_directory?: string | undefined;
+            env?: Record<string, string> | undefined;
+        };
+    } | {
         type: "message";
         id: string;
         phase?: "commentary" | "final_answer" | null | undefined;
@@ -431,6 +443,18 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
     type: "response.output_item.done";
     output_index: number;
     item: {
+        type: "local_shell_call";
+        id: string;
+        call_id: string;
+        action: {
+            type: "exec";
+            command: string[];
+            timeout_ms?: number | undefined;
+            user?: string | undefined;
+            working_directory?: string | undefined;
+            env?: Record<string, string> | undefined;
+        };
+    } | {
         type: "message";
         id: string;
         phase?: "commentary" | "final_answer" | null | undefined;
@@ -503,18 +527,6 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
             score: number;
             text: string;
         }[] | null | undefined;
-    } | {
-        type: "local_shell_call";
-        id: string;
-        call_id: string;
-        action: {
-            type: "exec";
-            command: string[];
-            timeout_ms?: number | undefined;
-            user?: string | undefined;
-            working_directory?: string | undefined;
-            env?: Record<string, string> | undefined;
-        };
     } | {
         type: "computer_call";
         id: string;
@@ -617,6 +629,11 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
     item_id: string;
     output_index: number;
     delta: string;
+} | {
+    type: "response.function_call_arguments.done";
+    item_id: string;
+    output_index: number;
+    arguments: string;
 } | {
     type: "response.custom_tool_call_input.delta";
     item_id: string;

package/dist/index.d.ts

@@ -314,6 +314,18 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
     type: "response.output_item.added";
     output_index: number;
     item: {
+        type: "local_shell_call";
+        id: string;
+        call_id: string;
+        action: {
+            type: "exec";
+            command: string[];
+            timeout_ms?: number | undefined;
+            user?: string | undefined;
+            working_directory?: string | undefined;
+            env?: Record<string, string> | undefined;
+        };
+    } | {
         type: "message";
         id: string;
         phase?: "commentary" | "final_answer" | null | undefined;
@@ -431,6 +443,18 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
     type: "response.output_item.done";
     output_index: number;
     item: {
+        type: "local_shell_call";
+        id: string;
+        call_id: string;
+        action: {
+            type: "exec";
+            command: string[];
+            timeout_ms?: number | undefined;
+            user?: string | undefined;
+            working_directory?: string | undefined;
+            env?: Record<string, string> | undefined;
+        };
+    } | {
         type: "message";
         id: string;
         phase?: "commentary" | "final_answer" | null | undefined;
@@ -503,18 +527,6 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
             score: number;
             text: string;
         }[] | null | undefined;
-    } | {
-        type: "local_shell_call";
-        id: string;
-        call_id: string;
-        action: {
-            type: "exec";
-            command: string[];
-            timeout_ms?: number | undefined;
-            user?: string | undefined;
-            working_directory?: string | undefined;
-            env?: Record<string, string> | undefined;
-        };
     } | {
         type: "computer_call";
         id: string;
@@ -617,6 +629,11 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
     item_id: string;
     output_index: number;
     delta: string;
+} | {
+    type: "response.function_call_arguments.done";
+    item_id: string;
+    output_index: number;
+    arguments: string;
 } | {
     type: "response.custom_tool_call_input.delta";
     item_id: string;

package/dist/index.js

@@ -3942,6 +3942,22 @@ var jsonValueSchema2 = import_v422.z.lazy(
     import_v422.z.record(import_v422.z.string(), jsonValueSchema2.optional())
   ])
 );
+function isRecord(value) {
+  return value != null && typeof value === "object" && !Array.isArray(value);
+}
+var openaiResponsesLocalShellCallSchema = import_v422.z.object({
+  type: import_v422.z.literal("local_shell_call"),
+  id: import_v422.z.string(),
+  call_id: import_v422.z.string(),
+  action: import_v422.z.object({
+    type: import_v422.z.literal("exec"),
+    command: import_v422.z.array(import_v422.z.string()),
+    timeout_ms: import_v422.z.number().optional(),
+    user: import_v422.z.string().optional(),
+    working_directory: import_v422.z.string().optional(),
+    env: import_v422.z.record(import_v422.z.string(), import_v422.z.string()).optional()
+  })
+});
 var openaiResponsesNestedErrorChunkSchema = import_v422.z.object({
   type: import_v422.z.literal("error"),
   sequence_number: import_v422.z.number(),
@@ -3959,6 +3975,60 @@ var openaiResponsesErrorChunkSchema = import_v422.z.object({
   message: import_v422.z.string(),
   param: import_v422.z.string().nullish()
 });
+var openaiResponsesModeledChunkTypes = /* @__PURE__ */ new Set([
+  "error",
+  "response.apply_patch_call_operation_diff.delta",
+  "response.apply_patch_call_operation_diff.done",
+  "response.code_interpreter_call_code.delta",
+  "response.code_interpreter_call_code.done",
+  "response.completed",
+  "response.created",
+  "response.custom_tool_call_input.delta",
+  "response.failed",
+  "response.function_call_arguments.delta",
+  "response.function_call_arguments.done",
+  "response.image_generation_call.partial_image",
+  "response.incomplete",
+  "response.output_item.added",
+  "response.output_item.done",
+  "response.output_text.annotation.added",
+  "response.output_text.delta",
+  "response.reasoning_summary_part.added",
+  "response.reasoning_summary_part.done",
+  "response.reasoning_summary_text.delta"
+]);
+var openaiResponsesModeledOutputItemTypes = /* @__PURE__ */ new Set([
+  "apply_patch_call",
+  "code_interpreter_call",
+  "computer_call",
+  "custom_tool_call",
+  "file_search_call",
+  "function_call",
+  "image_generation_call",
+  "local_shell_call",
+  "mcp_approval_request",
+  "mcp_call",
+  "mcp_list_tools",
+  "message",
+  "reasoning",
+  "shell_call",
+  "shell_call_output",
+  "tool_search_call",
+  "tool_search_output",
+  "web_search_call"
+]);
+function isModeledOpenAIResponsesChunk(value) {
+  if (typeof value.type !== "string" || !openaiResponsesModeledChunkTypes.has(value.type)) {
+    return false;
+  }
+  if (value.type !== "response.output_item.added" && value.type !== "response.output_item.done") {
+    return true;
+  }
+  if (!isRecord(value.item) || typeof value.item.type !== "string") {
+    return true;
+  }
+  return openaiResponsesModeledOutputItemTypes.has(value.item.type);
+}
 var openaiResponsesChunkSchema = (0, import_provider_utils28.lazySchema)(
   () => (0, import_provider_utils28.zodSchema)(
     import_v422.z.union([
@@ -4077,6 +4147,7 @@ var openaiResponsesChunkSchema = (0, import_provider_utils28.lazySchema)(
             type: import_v422.z.literal("file_search_call"),
             id: import_v422.z.string()
           }),
+          openaiResponsesLocalShellCallSchema,
           import_v422.z.object({
             type: import_v422.z.literal("image_generation_call"),
             id: import_v422.z.string()
@@ -4275,19 +4346,7 @@ var openaiResponsesChunkSchema = (0, import_provider_utils28.lazySchema)(
               })
             ).nullish()
           }),
-          import_v422.z.object({
-            type: import_v422.z.literal("local_shell_call"),
-            id: import_v422.z.string(),
-            call_id: import_v422.z.string(),
-            action: import_v422.z.object({
-              type: import_v422.z.literal("exec"),
-              command: import_v422.z.array(import_v422.z.string()),
-              timeout_ms: import_v422.z.number().optional(),
-              user: import_v422.z.string().optional(),
-              working_directory: import_v422.z.string().optional(),
-              env: import_v422.z.record(import_v422.z.string(), import_v422.z.string()).optional()
-            })
-          }),
+          openaiResponsesLocalShellCallSchema,
           import_v422.z.object({
             type: import_v422.z.literal("computer_call"),
             id: import_v422.z.string(),
@@ -4414,6 +4473,14 @@ var openaiResponsesChunkSchema = (0, import_provider_utils28.lazySchema)(
         output_index: import_v422.z.number(),
         delta: import_v422.z.string()
       }),
+      import_v422.z.object({
+        // `name` is documented as required but omitted from live API events:
+        // https://github.com/openai/openai-openapi/issues/545
+        type: import_v422.z.literal("response.function_call_arguments.done"),
+        item_id: import_v422.z.string(),
+        output_index: import_v422.z.number(),
+        arguments: import_v422.z.string()
+      }),
       import_v422.z.object({
         type: import_v422.z.literal("response.custom_tool_call_input.delta"),
         item_id: import_v422.z.string(),
@@ -4500,7 +4567,9 @@ var openaiResponsesChunkSchema = (0, import_provider_utils28.lazySchema)(
       }),
       openaiResponsesNestedErrorChunkSchema,
       openaiResponsesErrorChunkSchema,
-      import_v422.z.object({ type: import_v422.z.string() }).loose().transform((value) => ({
+      import_v422.z.object({ type: import_v422.z.string() }).loose().refine((value) => !isModeledOpenAIResponsesChunk(value), {
+        message: "Known response chunk failed schema validation"
+      }).transform((value) => ({
         type: "unknown_chunk",
         message: value.type
       }))
@@ -4640,19 +4709,7 @@ var openaiResponsesResponseSchema = (0, import_provider_utils28.lazySchema)(
             id: import_v422.z.string(),
             result: import_v422.z.string()
           }),
-          import_v422.z.object({
-            type: import_v422.z.literal("local_shell_call"),
-            id: import_v422.z.string(),
-            call_id: import_v422.z.string(),
-            action: import_v422.z.object({
-              type: import_v422.z.literal("exec"),
-              command: import_v422.z.array(import_v422.z.string()),
-              timeout_ms: import_v422.z.number().optional(),
-              user: import_v422.z.string().optional(),
-              working_directory: import_v422.z.string().optional(),
-              env: import_v422.z.record(import_v422.z.string(), import_v422.z.string()).optional()
-            })
-          }),
+          openaiResponsesLocalShellCallSchema,
           import_v422.z.object({
             type: import_v422.z.literal("function_call"),
             call_id: import_v422.z.string(),
@@ -6411,6 +6468,7 @@ var OpenAIResponsesLanguageModel = class {
                 requestBodyValues: body,
                 responseHeaders
               }) : chunk.error;
+              encounteredStreamError = true;
               finishReason = { unified: "error", raw: void 0 };
               controller.enqueue({ type: "error", error });
               return;
@@ -7210,13 +7268,15 @@ var OpenAIResponsesLanguageModel = class {
                 activeReasoning[value.item_id].summaryParts[value.summary_index] = "can-conclude";
               }
             } else if (isResponseFinishedChunk(value)) {
-              finishReason = {
-                unified: mapOpenAIResponseFinishReason({
-                  finishReason: (_x = value.response.incomplete_details) == null ? void 0 : _x.reason,
-                  hasFunctionCall
-                }),
-                raw: (_z = (_y = value.response.incomplete_details) == null ? void 0 : _y.reason) != null ? _z : void 0
-              };
+              if (!encounteredStreamError) {
+                finishReason = {
+                  unified: mapOpenAIResponseFinishReason({
+                    finishReason: (_x = value.response.incomplete_details) == null ? void 0 : _x.reason,
+                    hasFunctionCall
+                  }),
+                  raw: (_z = (_y = value.response.incomplete_details) == null ? void 0 : _y.reason) != null ? _z : void 0
+                };
+              }
               usage = value.response.usage;
               if (typeof value.response.service_tier === "string") {
                 serviceTier = value.response.service_tier;
@@ -7817,7 +7877,7 @@ var OpenAITranscriptionModel = class {
 };
 
 // src/version.ts
-var VERSION = true ? "3.0.101" : "0.0.0-test";
+var VERSION = true ? "3.0.102" : "0.0.0-test";
 
 // src/openai-provider.ts
 function createOpenAI(options = {}) {