ai-sdk-provider-claude-code 0.2.1 → 1.0.0-beta.1

package/README.md

@@ -1,8 +1,36 @@
-# AI SDK Provider for Claude Code (Alpha)
+<p align="center">
+  <img src="https://img.shields.io/badge/status-beta-FF6700" alt="beta status">
+  <a href="https://www.npmjs.com/package/ai-sdk-provider-claude-code"><img src="https://img.shields.io/npm/v/ai-sdk-provider-claude-code/beta?color=00A79E" alt="npm beta version" /></a>
+  <a href="https://www.npmjs.com/package/ai-sdk-provider-claude-code"><img src="https://img.shields.io/npm/unpacked-size/ai-sdk-provider-claude-code?color=00A79E" alt="install size" /></a>
+  <a href="https://www.npmjs.com/package/ai-sdk-provider-claude-code"><img src="https://img.shields.io/npm/dy/ai-sdk-provider-claude-code.svg?color=00A79E" alt="npm downloads" /></a>
+  <a href="https://nodejs.org/en/about/releases/"><img src="https://img.shields.io/badge/node-%3E%3D18-00A79E" alt="Node.js ≥ 18" /></a>
+  <a href="https://www.npmjs.com/package/ai-sdk-provider-claude-code"><img src="https://img.shields.io/npm/l/ai-sdk-provider-claude-code?color=00A79E" alt="License: MIT" /></a>
+</p>
 
-> **Warning**: This package is experimental and subject to change.
+# AI SDK Provider for Claude Code SDK
 
-**ai-sdk-provider-claude-code** lets you use Claude via the [Vercel AI SDK](https://sdk.vercel.ai/docs) through the official `@anthropic-ai/claude-code` CLI.
+> **Beta Release**: This is the v5-beta compatible version. For AI SDK v4 support, use version 0.2.x.
+
+**ai-sdk-provider-claude-code** lets you use Claude via the [Vercel AI SDK](https://sdk.vercel.ai/docs) through the official `@anthropic-ai/claude-code` SDK/CLI.
+
+## Version Compatibility
+
+| Provider Version | AI SDK Version | Status | Branch |
+|-----------------|----------------|---------|---------|
+| 0.x | v4 | Stable | [`ai-sdk-v4`](https://github.com/ben-vargas/ai-sdk-provider-claude-code/tree/ai-sdk-v4) |
+| 1.x-beta | v5-beta | Beta | `main` |
+
+### Installing the Right Version
+
+**For AI SDK v4 (stable):**
+```bash
+npm install ai-sdk-provider-claude-code@^0.2.2 ai@^4.3.16
+```
+
+**For AI SDK v5-beta:**
+```bash
+npm install ai-sdk-provider-claude-code@beta ai@beta
+```
 
 ## Installation
 
@@ -14,14 +42,18 @@ claude login
 
 ### 2. Add the provider
 ```bash
-npm install ai-sdk-provider-claude-code ai
+# For v5-beta
+npm install ai-sdk-provider-claude-code@beta ai@beta
+
+# For v4 (stable)
+npm install ai-sdk-provider-claude-code@^0.2.2 ai@^4.3.16
 ```
 
 ## Disclaimer
 
 **This is an unofficial community provider** and is not affiliated with or endorsed by Anthropic or Vercel. By using this provider:
 
-- You understand that your data will be sent to Anthropic's servers through the Claude Code CLI
+- You understand that your data will be sent to Anthropic's servers through the Claude Code SDK
 - You agree to comply with [Anthropic's Terms of Service](https://www.anthropic.com/legal/consumer-terms)
 - You acknowledge this software is provided "as is" without warranties of any kind
 
@@ -29,6 +61,21 @@ Please ensure you have appropriate permissions and comply with all applicable te
 
 ## Quick Start
 
+### AI SDK v5-beta
+```typescript
+import { streamText } from 'ai';
+import { claudeCode } from 'ai-sdk-provider-claude-code';
+
+const result = streamText({
+  model: claudeCode('sonnet'),
+  prompt: 'Hello, Claude!'
+});
+
+const text = await result.text;
+console.log(text);
+```
+
+### AI SDK v4
 ```typescript
 import { generateText } from 'ai';
 import { claudeCode } from 'ai-sdk-provider-claude-code';
@@ -41,6 +88,16 @@ const { text } = await generateText({
 console.log(text);
 ```
 
+## Breaking Changes in v1.x-beta
+
+See [Breaking Changes Guide](docs/ai-sdk-v5/V5_BREAKING_CHANGES.md) for details on migrating from v0.x to v1.x-beta.
+
+Key changes:
+- Requires AI SDK v5-beta
+- New streaming API pattern
+- Updated token usage properties
+- Changed message types
+
 ## Models
 
 - **`opus`** - Claude 4 Opus (most capable)
@@ -48,13 +105,14 @@ console.log(text);
 
 ## Documentation
 
-- **[Usage Guide](docs/GUIDE.md)** - Comprehensive examples and configuration
-- **[Troubleshooting](docs/TROUBLESHOOTING.md)** - Common issues and solutions
+- **[Usage Guide](docs/ai-sdk-v5/GUIDE.md)** - Comprehensive examples and configuration
+- **[Breaking Changes](docs/ai-sdk-v5/V5_BREAKING_CHANGES.md)** - v0.x to v1.x migration guide
+- **[Troubleshooting](docs/ai-sdk-v5/TROUBLESHOOTING.md)** - Common issues and solutions
 - **[Examples](examples/)** - Sample scripts and patterns
 
 ## Core Features
 
-- 🚀 Full Vercel AI SDK compatibility
+- 🚀 Vercel AI SDK compatibility
 - 🔄 Streaming support
 - 💬 Multi-turn conversations
 - 🎯 Object generation with JSON schemas
@@ -75,9 +133,9 @@ We welcome contributions, especially:
 - Better error handling
 - Additional examples
 
-See [Contributing Guidelines](docs/GUIDE.md#contributing) for details.
+See [Contributing Guidelines](docs/ai-sdk-v5/GUIDE.md#contributing) for details.
 
-For development status and technical details, see [Development Status](docs/DEVELOPMENT-STATUS.md).
+For development status and technical details, see [Development Status](docs/ai-sdk-v5/DEVELOPMENT-STATUS.md).
 
 ## License
 

package/dist/index.cjs

@@ -40,7 +40,7 @@ var import_provider2 = require("@ai-sdk/provider");
 var import_provider_utils = require("@ai-sdk/provider-utils");
 
 // src/convert-to-claude-code-messages.ts
-function convertToClaudeCodeMessages(prompt, mode) {
+function convertToClaudeCodeMessages(prompt, mode = { type: "regular" }, jsonSchema) {
   const messages = [];
   const warnings = [];
   let systemPrompt;
@@ -59,26 +59,33 @@ function convertToClaudeCodeMessages(prompt, mode) {
           }
           const imageParts = message.content.filter((part) => part.type === "image");
           if (imageParts.length > 0) {
-            warnings.push("Claude Code CLI does not support image inputs. Images will be ignored.");
+            warnings.push("Claude Code SDK does not support image inputs. Images will be ignored.");
           }
         }
         break;
-      case "assistant":
+      case "assistant": {
+        let assistantContent = "";
         if (typeof message.content === "string") {
-          messages.push(`Assistant: ${message.content}`);
+          assistantContent = message.content;
         } else {
           const textParts = message.content.filter((part) => part.type === "text").map((part) => part.text).join("\n");
           if (textParts) {
-            messages.push(`Assistant: ${textParts}`);
+            assistantContent = textParts;
           }
           const toolCalls = message.content.filter((part) => part.type === "tool-call");
           if (toolCalls.length > 0) {
-            messages.push(`Assistant: [Tool calls made]`);
+            assistantContent += `
+[Tool calls made]`;
           }
         }
+        messages.push(`Assistant: ${assistantContent}`);
         break;
+      }
       case "tool":
-        messages.push(`Tool Result (${message.content[0].toolName}): ${JSON.stringify(message.content[0].result)}`);
+        for (const tool of message.content) {
+          const resultText = tool.output.type === "text" ? tool.output.value : JSON.stringify(tool.output.value);
+          messages.push(`Tool Result (${tool.toolName}): ${resultText}`);
+        }
         break;
     }
   }
@@ -103,19 +110,20 @@ function convertToClaudeCodeMessages(prompt, mode) {
   } else {
     finalPrompt = formattedMessages.join("\n\n");
   }
-  if (mode?.type === "object-json") {
-    finalPrompt = `${finalPrompt}
+  if (mode?.type === "object-json" && jsonSchema) {
+    const schemaStr = JSON.stringify(jsonSchema, null, 2);
+    finalPrompt = `CRITICAL: You MUST respond with ONLY a JSON object. NO other text, NO explanations, NO questions.
+
+Your response MUST start with { and end with }
+
+The JSON MUST match this EXACT schema:
+${schemaStr}
+
+Now, based on the following conversation, generate ONLY the JSON object with the exact fields specified above:
 
-CRITICAL INSTRUCTION: You MUST respond with ONLY valid JSON. Follow these rules EXACTLY:
-1. Start your response with an opening brace {
-2. End your response with a closing brace }
-3. Do NOT include any text before the opening brace
-4. Do NOT include any text after the closing brace
-5. Do NOT use markdown code blocks or backticks
-6. Do NOT include explanations or commentary
-7. The ENTIRE response must be valid JSON that can be parsed with JSON.parse()
+${finalPrompt}
 
-Begin your response with { and end with }`;
+Remember: Your ENTIRE response must be ONLY the JSON object, starting with { and ending with }`;
   }
   return {
     messagesPrompt: finalPrompt,
@@ -239,7 +247,7 @@ function createAuthenticationError({
   message
 }) {
   return new import_provider.LoadAPIKeyError({
-    message: message || "Authentication failed. Please ensure Claude Code CLI is properly authenticated."
+    message: message || "Authentication failed. Please ensure Claude Code SDK is properly authenticated."
   });
 }
 function createTimeoutError({
@@ -432,9 +440,10 @@ var modelMap = {
   "sonnet": "sonnet"
 };
 var ClaudeCodeLanguageModel = class {
-  specificationVersion = "v1";
+  specificationVersion = "v2";
   defaultObjectGenerationMode = "json";
   supportsImageUrls = false;
+  supportedUrls = {};
   supportsStructuredOutputs = false;
   modelId;
   settings;
@@ -469,7 +478,6 @@ var ClaudeCodeLanguageModel = class {
     const warnings = [];
     const unsupportedParams = [];
     if (options.temperature !== void 0) unsupportedParams.push("temperature");
-    if (options.maxTokens !== void 0) unsupportedParams.push("maxTokens");
     if (options.topP !== void 0) unsupportedParams.push("topP");
     if (options.topK !== void 0) unsupportedParams.push("topK");
     if (options.presencePenalty !== void 0) unsupportedParams.push("presencePenalty");
@@ -481,7 +489,7 @@ var ClaudeCodeLanguageModel = class {
         warnings.push({
           type: "unsupported-setting",
           setting: param,
-          details: `Claude Code CLI does not support the ${param} parameter. It will be ignored.`
+          details: `Claude Code SDK does not support the ${param} parameter. It will be ignored.`
         });
       }
     }
@@ -550,7 +558,7 @@ var ClaudeCodeLanguageModel = class {
     const isAuthError = authErrorPatterns.some((pattern) => errorMessage.includes(pattern)) || exitCode === 401;
     if (isAuthError) {
       return createAuthenticationError({
-        message: isErrorWithMessage(error) && error.message ? error.message : "Authentication failed. Please ensure Claude Code CLI is properly authenticated."
+        message: isErrorWithMessage(error) && error.message ? error.message : "Authentication failed. Please ensure Claude Code SDK is properly authenticated."
       });
     }
     const errorCode = isErrorWithCode(error) && typeof error.code === "string" ? error.code : "";
@@ -564,7 +572,7 @@ var ClaudeCodeLanguageModel = class {
     }
     const isRetryable = errorCode === "ENOENT" || errorCode === "ECONNREFUSED" || errorCode === "ETIMEDOUT" || errorCode === "ECONNRESET";
     return createAPICallError({
-      message: isErrorWithMessage(error) && error.message ? error.message : "Claude Code CLI error",
+      message: isErrorWithMessage(error) && error.message ? error.message : "Claude Code SDK error",
       code: errorCode || void 0,
       exitCode,
       stderr: isErrorWithCode(error) && typeof error.stderr === "string" ? error.stderr : void 0,
@@ -603,7 +611,12 @@ var ClaudeCodeLanguageModel = class {
     }
   }
   async doGenerate(options) {
-    const { messagesPrompt, warnings: messageWarnings } = convertToClaudeCodeMessages(options.prompt, options.mode);
+    const mode = options.responseFormat?.type === "json" ? { type: "object-json" } : { type: "regular" };
+    const { messagesPrompt, warnings: messageWarnings } = convertToClaudeCodeMessages(
+      options.prompt,
+      mode,
+      options.responseFormat?.type === "json" ? options.responseFormat.schema : void 0
+    );
     const abortController = new AbortController();
     let abortListener;
     if (options.abortSignal) {
@@ -612,7 +625,7 @@ var ClaudeCodeLanguageModel = class {
     }
     const queryOptions = this.createQueryOptions(abortController);
     let text = "";
-    let usage = { promptTokens: 0, completionTokens: 0 };
+    let usage = { inputTokens: 0, outputTokens: 0, totalTokens: 0 };
     let finishReason = "stop";
     let costUsd;
     let durationMs;
@@ -643,8 +656,9 @@ var ClaudeCodeLanguageModel = class {
           if ("usage" in message) {
             rawUsage = message.usage;
             usage = {
-              promptTokens: (message.usage.cache_creation_input_tokens ?? 0) + (message.usage.cache_read_input_tokens ?? 0) + (message.usage.input_tokens ?? 0),
-              completionTokens: message.usage.output_tokens ?? 0
+              inputTokens: (message.usage.cache_creation_input_tokens ?? 0) + (message.usage.cache_read_input_tokens ?? 0) + (message.usage.input_tokens ?? 0),
+              outputTokens: message.usage.output_tokens ?? 0,
+              totalTokens: (message.usage.cache_creation_input_tokens ?? 0) + (message.usage.cache_read_input_tokens ?? 0) + (message.usage.input_tokens ?? 0) + (message.usage.output_tokens ?? 0)
             };
           }
           finishReason = mapClaudeCodeFinishReason(message.subtype);
@@ -662,7 +676,7 @@ var ClaudeCodeLanguageModel = class {
         options.abortSignal.removeEventListener("abort", abortListener);
       }
     }
-    if (options.mode?.type === "object-json" && text) {
+    if (options.responseFormat?.type === "json" && text) {
       const extracted = extractJson(text);
       const validation = this.validateJsonExtraction(text, extracted);
       if (!validation.valid && validation.warning) {
@@ -671,14 +685,10 @@ var ClaudeCodeLanguageModel = class {
       text = extracted;
     }
     return {
-      text: text || void 0,
+      content: [{ type: "text", text }],
       usage,
       finishReason,
-      rawCall: {
-        rawPrompt: messagesPrompt,
-        rawSettings: queryOptions
-      },
-      warnings: warnings.length > 0 ? warnings : void 0,
+      warnings,
       response: {
         id: (0, import_provider_utils.generateId)(),
         timestamp: /* @__PURE__ */ new Date(),
@@ -698,7 +708,12 @@ var ClaudeCodeLanguageModel = class {
     };
   }
   async doStream(options) {
-    const { messagesPrompt, warnings: messageWarnings } = convertToClaudeCodeMessages(options.prompt, options.mode);
+    const mode = options.responseFormat?.type === "json" ? { type: "object-json" } : { type: "regular" };
+    const { messagesPrompt, warnings: messageWarnings } = convertToClaudeCodeMessages(
+      options.prompt,
+      mode,
+      options.responseFormat?.type === "json" ? options.responseFormat.schema : void 0
+    );
     const abortController = new AbortController();
     let abortListener;
     if (options.abortSignal) {
@@ -718,21 +733,31 @@ var ClaudeCodeLanguageModel = class {
     const stream = new ReadableStream({
       start: async (controller) => {
         try {
+          controller.enqueue({ type: "stream-start", warnings });
           const response = (0, import_claude_code.query)({
             prompt: messagesPrompt,
             options: queryOptions
           });
-          let usage = { promptTokens: 0, completionTokens: 0 };
+          let usage = { inputTokens: 0, outputTokens: 0, totalTokens: 0 };
           let accumulatedText = "";
+          let textPartId;
           for await (const message of response) {
             if (message.type === "assistant") {
               const text = message.message.content.map((c) => c.type === "text" ? c.text : "").join("");
               if (text) {
                 accumulatedText += text;
-                if (options.mode?.type !== "object-json") {
+                if (options.responseFormat?.type !== "json") {
+                  if (!textPartId) {
+                    textPartId = (0, import_provider_utils.generateId)();
+                    controller.enqueue({
+                      type: "text-start",
+                      id: textPartId
+                    });
+                  }
                   controller.enqueue({
                     type: "text-delta",
-                    textDelta: text
+                    id: textPartId,
+                    delta: text
                   });
                 }
               }
@@ -741,18 +766,34 @@ var ClaudeCodeLanguageModel = class {
               if ("usage" in message) {
                 rawUsage = message.usage;
                 usage = {
-                  promptTokens: (message.usage.cache_creation_input_tokens ?? 0) + (message.usage.cache_read_input_tokens ?? 0) + (message.usage.input_tokens ?? 0),
-                  completionTokens: message.usage.output_tokens ?? 0
+                  inputTokens: (message.usage.cache_creation_input_tokens ?? 0) + (message.usage.cache_read_input_tokens ?? 0) + (message.usage.input_tokens ?? 0),
+                  outputTokens: message.usage.output_tokens ?? 0,
+                  totalTokens: (message.usage.cache_creation_input_tokens ?? 0) + (message.usage.cache_read_input_tokens ?? 0) + (message.usage.input_tokens ?? 0) + (message.usage.output_tokens ?? 0)
                 };
               }
               const finishReason = mapClaudeCodeFinishReason(message.subtype);
               this.setSessionId(message.session_id);
-              if (options.mode?.type === "object-json" && accumulatedText) {
+              if (options.responseFormat?.type === "json" && accumulatedText) {
                 const extractedJson = extractJson(accumulatedText);
                 this.validateJsonExtraction(accumulatedText, extractedJson);
+                const jsonTextId = (0, import_provider_utils.generateId)();
+                controller.enqueue({
+                  type: "text-start",
+                  id: jsonTextId
+                });
                 controller.enqueue({
                   type: "text-delta",
-                  textDelta: extractedJson
+                  id: jsonTextId,
+                  delta: extractedJson
+                });
+                controller.enqueue({
+                  type: "text-end",
+                  id: jsonTextId
+                });
+              } else if (textPartId) {
+                controller.enqueue({
+                  type: "text-end",
+                  id: textPartId
                 });
               }
               controller.enqueue({
@@ -805,11 +846,6 @@ var ClaudeCodeLanguageModel = class {
     });
     return {
       stream,
-      rawCall: {
-        rawPrompt: messagesPrompt,
-        rawSettings: queryOptions
-      },
-      warnings: warnings.length > 0 ? warnings : void 0,
       request: {
         body: messagesPrompt
       }
@@ -860,6 +896,12 @@ function createClaudeCode(options = {}) {
       modelType: "textEmbeddingModel"
     });
   };
+  provider.imageModel = (modelId) => {
+    throw new import_provider3.NoSuchModelError({
+      modelId,
+      modelType: "imageModel"
+    });
+  };
   return provider;
 }
 var claudeCode = createClaudeCode();