@ai-sdk/anthropic 2.0.32 → 2.0.34

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @ai-sdk/anthropic
 
+## 2.0.34
+
+### Patch Changes
+
+- 65f2628: feat(provider/anthropic): expose container from response in provider metadata
+
+## 2.0.33
+
+### Patch Changes
+
+- 28c9c6a: feat(anthropic): add prompt caching validation
+
 ## 2.0.32
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,8 +1,47 @@
+import { JSONObject, ProviderV2, LanguageModelV2 } from '@ai-sdk/provider';
 import { z } from 'zod/v4';
-import { ProviderV2, LanguageModelV2 } from '@ai-sdk/provider';
 import * as _ai_sdk_provider_utils from '@ai-sdk/provider-utils';
 import { FetchFunction } from '@ai-sdk/provider-utils';
 
+interface AnthropicMessageMetadata {
+    usage: JSONObject;
+    cacheCreationInputTokens: number | null;
+    stopSequence: string | null;
+    /**
+     * Information about the container used in this request.
+     *
+     * This will be non-null if a container tool (e.g., code execution) was used.
+     * Information about the container used in the request (for the code execution tool).
+     */
+    container: {
+        /**
+         * The time at which the container will expire (RFC3339 timestamp).
+         */
+        expiresAt: string;
+        /**
+         * Identifier for the container used in this request.
+         */
+        id: string;
+        /**
+         * Skills loaded in the container.
+         */
+        skills: Array<{
+            /**
+             * Type of skill: either 'anthropic' (built-in) or 'custom' (user-defined).
+             */
+            type: 'anthropic' | 'custom';
+            /**
+             * Skill ID (1-64 characters).
+             */
+            skillId: string;
+            /**
+             * Skill version or 'latest' for most recent version (1-64 characters).
+             */
+            version: string;
+        }> | null;
+    } | null;
+}
+
 type AnthropicMessagesModelId = 'claude-haiku-4-5' | 'claude-haiku-4-5-20251001' | 'claude-sonnet-4-5' | 'claude-sonnet-4-5-20250929' | 'claude-opus-4-1' | 'claude-opus-4-0' | 'claude-sonnet-4-0' | 'claude-opus-4-1-20250805' | 'claude-opus-4-20250514' | 'claude-sonnet-4-20250514' | 'claude-3-7-sonnet-latest' | 'claude-3-7-sonnet-20250219' | 'claude-3-5-haiku-latest' | 'claude-3-5-haiku-20241022' | 'claude-3-haiku-20240307' | (string & {});
 declare const anthropicProviderOptions: z.ZodObject<{
     sendReasoning: z.ZodOptional<z.ZodBoolean>;
@@ -504,4 +543,4 @@ declare const anthropic: AnthropicProvider;
 
 declare const VERSION: string;
 
-export { type AnthropicProvider, type AnthropicProviderOptions, type AnthropicProviderSettings, VERSION, anthropic, createAnthropic };
+export { type AnthropicMessageMetadata, type AnthropicProvider, type AnthropicProviderOptions, type AnthropicProviderSettings, VERSION, anthropic, createAnthropic };

package/dist/index.d.ts

@@ -1,8 +1,47 @@
+import { JSONObject, ProviderV2, LanguageModelV2 } from '@ai-sdk/provider';
 import { z } from 'zod/v4';
-import { ProviderV2, LanguageModelV2 } from '@ai-sdk/provider';
 import * as _ai_sdk_provider_utils from '@ai-sdk/provider-utils';
 import { FetchFunction } from '@ai-sdk/provider-utils';
 
+interface AnthropicMessageMetadata {
+    usage: JSONObject;
+    cacheCreationInputTokens: number | null;
+    stopSequence: string | null;
+    /**
+     * Information about the container used in this request.
+     *
+     * This will be non-null if a container tool (e.g., code execution) was used.
+     * Information about the container used in the request (for the code execution tool).
+     */
+    container: {
+        /**
+         * The time at which the container will expire (RFC3339 timestamp).
+         */
+        expiresAt: string;
+        /**
+         * Identifier for the container used in this request.
+         */
+        id: string;
+        /**
+         * Skills loaded in the container.
+         */
+        skills: Array<{
+            /**
+             * Type of skill: either 'anthropic' (built-in) or 'custom' (user-defined).
+             */
+            type: 'anthropic' | 'custom';
+            /**
+             * Skill ID (1-64 characters).
+             */
+            skillId: string;
+            /**
+             * Skill version or 'latest' for most recent version (1-64 characters).
+             */
+            version: string;
+        }> | null;
+    } | null;
+}
+
 type AnthropicMessagesModelId = 'claude-haiku-4-5' | 'claude-haiku-4-5-20251001' | 'claude-sonnet-4-5' | 'claude-sonnet-4-5-20250929' | 'claude-opus-4-1' | 'claude-opus-4-0' | 'claude-sonnet-4-0' | 'claude-opus-4-1-20250805' | 'claude-opus-4-20250514' | 'claude-sonnet-4-20250514' | 'claude-3-7-sonnet-latest' | 'claude-3-7-sonnet-20250219' | 'claude-3-5-haiku-latest' | 'claude-3-5-haiku-20241022' | 'claude-3-haiku-20240307' | (string & {});
 declare const anthropicProviderOptions: z.ZodObject<{
     sendReasoning: z.ZodOptional<z.ZodBoolean>;
@@ -504,4 +543,4 @@ declare const anthropic: AnthropicProvider;
 
 declare const VERSION: string;
 
-export { type AnthropicProvider, type AnthropicProviderOptions, type AnthropicProviderSettings, VERSION, anthropic, createAnthropic };
+export { type AnthropicMessageMetadata, type AnthropicProvider, type AnthropicProviderOptions, type AnthropicProviderSettings, VERSION, anthropic, createAnthropic };

package/dist/index.js

@@ -31,7 +31,7 @@ var import_provider4 = require("@ai-sdk/provider");
 var import_provider_utils20 = require("@ai-sdk/provider-utils");
 
 // src/version.ts
-var VERSION = true ? "2.0.32" : "0.0.0-test";
+var VERSION = true ? "2.0.34" : "0.0.0-test";
 
 // src/anthropic-messages-language-model.ts
 var import_provider3 = require("@ai-sdk/provider");
@@ -245,7 +245,18 @@ var anthropicMessagesResponseSchema = (0, import_provider_utils2.lazySchema)(
         output_tokens: import_v42.z.number(),
         cache_creation_input_tokens: import_v42.z.number().nullish(),
         cache_read_input_tokens: import_v42.z.number().nullish()
-      })
+      }),
+      container: import_v42.z.object({
+        expires_at: import_v42.z.string(),
+        id: import_v42.z.string(),
+        skills: import_v42.z.array(
+          import_v42.z.object({
+            type: import_v42.z.union([import_v42.z.literal("anthropic"), import_v42.z.literal("custom")]),
+            skill_id: import_v42.z.string(),
+            version: import_v42.z.string()
+          })
+        ).nullish()
+      }).nullish()
     })
   )
 );
@@ -475,7 +486,21 @@ var anthropicMessagesChunkSchema = (0, import_provider_utils2.lazySchema)(
         type: import_v42.z.literal("message_delta"),
         delta: import_v42.z.object({
           stop_reason: import_v42.z.string().nullish(),
-          stop_sequence: import_v42.z.string().nullish()
+          stop_sequence: import_v42.z.string().nullish(),
+          container: import_v42.z.object({
+            expires_at: import_v42.z.string(),
+            id: import_v42.z.string(),
+            skills: import_v42.z.array(
+              import_v42.z.object({
+                type: import_v42.z.union([
+                  import_v42.z.literal("anthropic"),
+                  import_v42.z.literal("custom")
+                ]),
+                skill_id: import_v42.z.string(),
+                version: import_v42.z.string()
+              })
+            ).nullish()
+          }).nullish()
         }),
         usage: import_v42.z.looseObject({
           output_tokens: import_v42.z.number(),
@@ -565,12 +590,46 @@ var anthropicProviderOptions = import_v43.z.object({
 var import_provider = require("@ai-sdk/provider");
 
 // src/get-cache-control.ts
+var MAX_CACHE_BREAKPOINTS = 4;
 function getCacheControl(providerMetadata) {
   var _a;
   const anthropic2 = providerMetadata == null ? void 0 : providerMetadata.anthropic;
   const cacheControlValue = (_a = anthropic2 == null ? void 0 : anthropic2.cacheControl) != null ? _a : anthropic2 == null ? void 0 : anthropic2.cache_control;
   return cacheControlValue;
 }
+var CacheControlValidator = class {
+  constructor() {
+    this.breakpointCount = 0;
+    this.warnings = [];
+  }
+  getCacheControl(providerMetadata, context) {
+    const cacheControlValue = getCacheControl(providerMetadata);
+    if (!cacheControlValue) {
+      return void 0;
+    }
+    if (!context.canCache) {
+      this.warnings.push({
+        type: "unsupported-setting",
+        setting: "cacheControl",
+        details: `cache_control cannot be set on ${context.type}. It will be ignored.`
+      });
+      return void 0;
+    }
+    this.breakpointCount++;
+    if (this.breakpointCount > MAX_CACHE_BREAKPOINTS) {
+      this.warnings.push({
+        type: "unsupported-setting",
+        setting: "cacheControl",
+        details: `Maximum ${MAX_CACHE_BREAKPOINTS} cache breakpoints exceeded (found ${this.breakpointCount}). This breakpoint will be ignored.`
+      });
+      return void 0;
+    }
+    return cacheControlValue;
+  }
+  getWarnings() {
+    return this.warnings;
+  }
+};
 
 // src/tool/text-editor_20250728.ts
 var import_provider_utils3 = require("@ai-sdk/provider-utils");
@@ -716,11 +775,13 @@ var import_provider_utils7 = require("@ai-sdk/provider-utils");
 async function prepareTools({
   tools,
   toolChoice,
-  disableParallelToolUse
+  disableParallelToolUse,
+  cacheControlValidator
 }) {
   tools = (tools == null ? void 0 : tools.length) ? tools : void 0;
   const toolWarnings = [];
   const betas = /* @__PURE__ */ new Set();
+  const validator = cacheControlValidator || new CacheControlValidator();
   if (tools == null) {
     return { tools: void 0, toolChoice: void 0, toolWarnings, betas };
   }
@@ -728,7 +789,10 @@ async function prepareTools({
   for (const tool of tools) {
     switch (tool.type) {
       case "function": {
-        const cacheControl = getCacheControl(tool.providerOptions);
+        const cacheControl = validator.getCacheControl(tool.providerOptions, {
+          type: "tool definition",
+          canCache: true
+        });
         anthropicTools2.push({
           name: tool.name,
           description: tool.description,
@@ -743,7 +807,8 @@ async function prepareTools({
             betas.add("code-execution-2025-05-22");
             anthropicTools2.push({
               type: "code_execution_20250522",
-              name: "code_execution"
+              name: "code_execution",
+              cache_control: void 0
             });
             break;
           }
@@ -762,7 +827,8 @@ async function prepareTools({
               type: "computer_20250124",
               display_width_px: tool.args.displayWidthPx,
               display_height_px: tool.args.displayHeightPx,
-              display_number: tool.args.displayNumber
+              display_number: tool.args.displayNumber,
+              cache_control: void 0
             });
             break;
           }
@@ -773,7 +839,8 @@ async function prepareTools({
               type: "computer_20241022",
               display_width_px: tool.args.displayWidthPx,
               display_height_px: tool.args.displayHeightPx,
-              display_number: tool.args.displayNumber
+              display_number: tool.args.displayNumber,
+              cache_control: void 0
             });
             break;
           }
@@ -781,7 +848,8 @@ async function prepareTools({
             betas.add("computer-use-2025-01-24");
             anthropicTools2.push({
               name: "str_replace_editor",
-              type: "text_editor_20250124"
+              type: "text_editor_20250124",
+              cache_control: void 0
             });
             break;
           }
@@ -789,7 +857,8 @@ async function prepareTools({
             betas.add("computer-use-2024-10-22");
             anthropicTools2.push({
               name: "str_replace_editor",
-              type: "text_editor_20241022"
+              type: "text_editor_20241022",
+              cache_control: void 0
             });
             break;
           }
@@ -797,7 +866,8 @@ async function prepareTools({
             betas.add("computer-use-2025-01-24");
             anthropicTools2.push({
               name: "str_replace_based_edit_tool",
-              type: "text_editor_20250429"
+              type: "text_editor_20250429",
+              cache_control: void 0
             });
             break;
           }
@@ -809,7 +879,8 @@ async function prepareTools({
             anthropicTools2.push({
               name: "str_replace_based_edit_tool",
               type: "text_editor_20250728",
-              max_characters: args.maxCharacters
+              max_characters: args.maxCharacters,
+              cache_control: void 0
             });
             break;
           }
@@ -817,7 +888,8 @@ async function prepareTools({
             betas.add("computer-use-2025-01-24");
             anthropicTools2.push({
               name: "bash",
-              type: "bash_20250124"
+              type: "bash_20250124",
+              cache_control: void 0
             });
             break;
           }
@@ -825,7 +897,8 @@ async function prepareTools({
             betas.add("computer-use-2024-10-22");
             anthropicTools2.push({
               name: "bash",
-              type: "bash_20241022"
+              type: "bash_20241022",
+              cache_control: void 0
             });
             break;
           }
@@ -850,7 +923,8 @@ async function prepareTools({
               allowed_domains: args.allowedDomains,
               blocked_domains: args.blockedDomains,
               citations: args.citations,
-              max_content_tokens: args.maxContentTokens
+              max_content_tokens: args.maxContentTokens,
+              cache_control: void 0
             });
             break;
           }
@@ -865,7 +939,8 @@ async function prepareTools({
               max_uses: args.maxUses,
               allowed_domains: args.allowedDomains,
               blocked_domains: args.blockedDomains,
-              user_location: args.userLocation
+              user_location: args.userLocation,
+              cache_control: void 0
             });
             break;
           }
@@ -1077,11 +1152,13 @@ function convertToString(data) {
 async function convertToAnthropicMessagesPrompt({
   prompt,
   sendReasoning,
-  warnings
+  warnings,
+  cacheControlValidator
 }) {
   var _a, _b, _c, _d, _e;
   const betas = /* @__PURE__ */ new Set();
   const blocks = groupIntoBlocks(prompt);
+  const validator = cacheControlValidator || new CacheControlValidator();
   let system = void 0;
   const messages = [];
   async function shouldEnableCitations(providerMetadata) {
@@ -1118,7 +1195,10 @@ async function convertToAnthropicMessagesPrompt({
         system = block.messages.map(({ content, providerOptions }) => ({
           type: "text",
           text: content,
-          cache_control: getCacheControl(providerOptions)
+          cache_control: validator.getCacheControl(providerOptions, {
+            type: "system message",
+            canCache: true
+          })
         }));
         break;
       }
@@ -1131,7 +1211,13 @@ async function convertToAnthropicMessagesPrompt({
               for (let j = 0; j < content.length; j++) {
                 const part = content[j];
                 const isLastPart = j === content.length - 1;
-                const cacheControl = (_a = getCacheControl(part.providerOptions)) != null ? _a : isLastPart ? getCacheControl(message.providerOptions) : void 0;
+                const cacheControl = (_a = validator.getCacheControl(part.providerOptions, {
+                  type: "user message part",
+                  canCache: true
+                })) != null ? _a : isLastPart ? validator.getCacheControl(message.providerOptions, {
+                  type: "user message",
+                  canCache: true
+                }) : void 0;
                 switch (part.type) {
                   case "text": {
                     anthropicContent.push({
@@ -1219,7 +1305,13 @@ async function convertToAnthropicMessagesPrompt({
               for (let i2 = 0; i2 < content.length; i2++) {
                 const part = content[i2];
                 const isLastPart = i2 === content.length - 1;
-                const cacheControl = (_d = getCacheControl(part.providerOptions)) != null ? _d : isLastPart ? getCacheControl(message.providerOptions) : void 0;
+                const cacheControl = (_d = validator.getCacheControl(part.providerOptions, {
+                  type: "tool result part",
+                  canCache: true
+                })) != null ? _d : isLastPart ? validator.getCacheControl(message.providerOptions, {
+                  type: "tool result message",
+                  canCache: true
+                }) : void 0;
                 const output = part.output;
                 let contentValue;
                 switch (output.type) {
@@ -1229,8 +1321,7 @@ async function convertToAnthropicMessagesPrompt({
                         case "text":
                           return {
                             type: "text",
-                            text: contentPart.text,
-                            cache_control: void 0
+                            text: contentPart.text
                           };
                         case "media": {
                           if (contentPart.mediaType.startsWith("image/")) {
@@ -1240,8 +1331,7 @@ async function convertToAnthropicMessagesPrompt({
                                 type: "base64",
                                 media_type: contentPart.mediaType,
                                 data: contentPart.data
-                              },
-                              cache_control: void 0
+                              }
                             };
                           }
                           if (contentPart.mediaType === "application/pdf") {
@@ -1252,8 +1342,7 @@ async function convertToAnthropicMessagesPrompt({
                                 type: "base64",
                                 media_type: contentPart.mediaType,
                                 data: contentPart.data
-                              },
-                              cache_control: void 0
+                              }
                             };
                           }
                           throw new import_provider2.UnsupportedFunctionalityError({
@@ -1301,7 +1390,13 @@ async function convertToAnthropicMessagesPrompt({
           for (let k = 0; k < content.length; k++) {
             const part = content[k];
             const isLastContentPart = k === content.length - 1;
-            const cacheControl = (_e = getCacheControl(part.providerOptions)) != null ? _e : isLastContentPart ? getCacheControl(message.providerOptions) : void 0;
+            const cacheControl = (_e = validator.getCacheControl(part.providerOptions, {
+              type: "assistant message part",
+              canCache: true
+            })) != null ? _e : isLastContentPart ? validator.getCacheControl(message.providerOptions, {
+              type: "assistant message",
+              canCache: true
+            }) : void 0;
             switch (part.type) {
               case "text": {
                 anthropicContent.push({
@@ -1325,17 +1420,23 @@ async function convertToAnthropicMessagesPrompt({
                   });
                   if (reasoningMetadata != null) {
                     if (reasoningMetadata.signature != null) {
+                      validator.getCacheControl(part.providerOptions, {
+                        type: "thinking block",
+                        canCache: false
+                      });
                       anthropicContent.push({
                         type: "thinking",
                         thinking: part.text,
-                        signature: reasoningMetadata.signature,
-                        cache_control: cacheControl
+                        signature: reasoningMetadata.signature
                       });
                     } else if (reasoningMetadata.redactedData != null) {
+                      validator.getCacheControl(part.providerOptions, {
+                        type: "redacted thinking block",
+                        canCache: false
+                      });
                       anthropicContent.push({
                         type: "redacted_thinking",
-                        data: reasoningMetadata.redactedData,
-                        cache_control: cacheControl
+                        data: reasoningMetadata.redactedData
                       });
                     } else {
                       warnings.push({
@@ -1710,10 +1811,12 @@ var AnthropicMessagesLanguageModel = class {
       providerOptions,
       schema: anthropicProviderOptions
     });
+    const cacheControlValidator = new CacheControlValidator();
     const { prompt: messagesPrompt, betas } = await convertToAnthropicMessagesPrompt({
       prompt,
       sendReasoning: (_a = anthropicOptions == null ? void 0 : anthropicOptions.sendReasoning) != null ? _a : true,
-      warnings
+      warnings,
+      cacheControlValidator
     });
     const isThinking = ((_b = anthropicOptions == null ? void 0 : anthropicOptions.thinking) == null ? void 0 : _b.type) === "enabled";
     const thinkingBudget = (_c = anthropicOptions == null ? void 0 : anthropicOptions.thinking) == null ? void 0 : _c.budgetTokens;
@@ -1811,20 +1914,23 @@ var AnthropicMessagesLanguageModel = class {
       jsonResponseTool != null ? {
         tools: [jsonResponseTool],
         toolChoice: { type: "tool", toolName: jsonResponseTool.name },
-        disableParallelToolUse: true
+        disableParallelToolUse: true,
+        cacheControlValidator
       } : {
         tools: tools != null ? tools : [],
         toolChoice,
-        disableParallelToolUse: anthropicOptions == null ? void 0 : anthropicOptions.disableParallelToolUse
+        disableParallelToolUse: anthropicOptions == null ? void 0 : anthropicOptions.disableParallelToolUse,
+        cacheControlValidator
       }
     );
+    const cacheWarnings = cacheControlValidator.getWarnings();
     return {
       args: {
         ...baseArgs,
         tools: anthropicTools2,
         tool_choice: anthropicToolChoice
       },
-      warnings: [...warnings, ...toolWarnings],
+      warnings: [...warnings, ...toolWarnings, ...cacheWarnings],
       betas: /* @__PURE__ */ new Set([...betas, ...toolsBetas]),
       usesJsonResponseTool: jsonResponseTool != null
     };
@@ -1871,7 +1977,7 @@ var AnthropicMessagesLanguageModel = class {
     });
   }
   async doGenerate(options) {
-    var _a, _b, _c, _d, _e, _f;
+    var _a, _b, _c, _d, _e, _f, _g, _h;
     const { args, warnings, betas, usesJsonResponseTool } = await this.getArgs(options);
     const citationDocuments = this.extractCitationDocuments(options.prompt);
     const {
@@ -2122,7 +2228,16 @@ var AnthropicMessagesLanguageModel = class {
         anthropic: {
           usage: response.usage,
           cacheCreationInputTokens: (_e = response.usage.cache_creation_input_tokens) != null ? _e : null,
-          stopSequence: (_f = response.stop_sequence) != null ? _f : null
+          stopSequence: (_f = response.stop_sequence) != null ? _f : null,
+          container: response.container ? {
+            expiresAt: response.container.expires_at,
+            id: response.container.id,
+            skills: (_h = (_g = response.container.skills) == null ? void 0 : _g.map((skill) => ({
+              type: skill.type,
+              skillId: skill.skill_id,
+              version: skill.version
+            }))) != null ? _h : null
+          } : null
         }
       }
     };
@@ -2152,6 +2267,7 @@ var AnthropicMessagesLanguageModel = class {
     let rawUsage = void 0;
     let cacheCreationInputTokens = null;
     let stopSequence = null;
+    let container = null;
     let blockType = void 0;
     const generateId3 = this.generateId;
     return {
@@ -2161,7 +2277,7 @@ var AnthropicMessagesLanguageModel = class {
             controller.enqueue({ type: "stream-start", warnings });
           },
           transform(chunk, controller) {
-            var _a, _b, _c, _d, _e, _f, _g, _h;
+            var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j;
             if (options.includeRawChunks) {
               controller.enqueue({ type: "raw", rawValue: chunk.rawValue });
             }
@@ -2542,6 +2658,15 @@ var AnthropicMessagesLanguageModel = class {
                   isJsonResponseFromTool: usesJsonResponseTool
                 });
                 stopSequence = (_h = value.delta.stop_sequence) != null ? _h : null;
+                container = value.delta.container != null ? {
+                  expiresAt: value.delta.container.expires_at,
+                  id: value.delta.container.id,
+                  skills: (_j = (_i = value.delta.container.skills) == null ? void 0 : _i.map((skill) => ({
+                    type: skill.type,
+                    skillId: skill.skill_id,
+                    version: skill.version
+                  }))) != null ? _j : null
+                } : null;
                 rawUsage = {
                   ...rawUsage,
                   ...value.usage
@@ -2557,7 +2682,8 @@ var AnthropicMessagesLanguageModel = class {
                     anthropic: {
                       usage: rawUsage != null ? rawUsage : null,
                       cacheCreationInputTokens,
-                      stopSequence
+                      stopSequence,
+                      container
                     }
                   }
                 });