@ai-sdk/harness-claude-code 0.0.0 → 1.0.0-canary.0

package/dist/index.d.ts

@@ -0,0 +1,376 @@
+import * as zod from 'zod';
+import { z } from 'zod';
+import * as _ai_sdk_provider_utils from '@ai-sdk/provider-utils';
+import * as _ai_sdk_harness from '@ai-sdk/harness';
+import { HarnessV1, HarnessV1BuiltinTool } from '@ai-sdk/harness';
+
+type ClaudeCodeAuthOptions = {
+    readonly anthropic?: {
+        readonly apiKey?: string;
+        readonly authToken?: string;
+        readonly baseUrl?: string;
+    };
+    readonly gateway?: {
+        readonly apiKey?: string;
+        readonly baseUrl?: string;
+    };
+};
+
+type ClaudeCodeHarnessSettings = {
+    readonly auth?: ClaudeCodeAuthOptions;
+    /**
+     * Anthropic model id the underlying `claude` CLI should use. Leaving this
+     * unset defers to the CLI's default.
+     */
+    readonly model?: string;
+    /**
+     * Hard cap on how many internal turns the CLI can take before yielding
+     * back to the caller. Unset means the CLI's default.
+     */
+    readonly maxTurns?: number;
+    /**
+     * Controls extended-thinking behavior. `'off'` disables thinking,
+     * `'on'` forces it on, `'adaptive'` lets the runtime decide.
+     */
+    readonly thinking?: 'off' | 'on' | 'adaptive';
+    /**
+     * Override the port the bridge binds inside the sandbox. By default the
+     * adapter uses the first port the sandbox declares via `sandbox.ports`.
+     * Only set this if the sandbox declares multiple ports and the first one
+     * is reserved for something else.
+     */
+    readonly port?: number;
+    /** Maximum milliseconds to wait for the bridge to advertise its port. Defaults to 120000. */
+    readonly startupTimeoutMs?: number;
+};
+declare const CLAUDE_CODE_BUILTIN_TOOLS: {
+    readonly read: HarnessV1BuiltinTool<{
+        file_path: string;
+        offset?: number | undefined;
+        limit?: number | undefined;
+        pages?: string | undefined;
+    }, unknown>;
+    readonly write: HarnessV1BuiltinTool<{
+        file_path: string;
+        content: string;
+    }, unknown>;
+    readonly edit: HarnessV1BuiltinTool<{
+        file_path: string;
+        old_string: string;
+        new_string: string;
+        replace_all?: boolean | undefined;
+    }, unknown>;
+    readonly bash: HarnessV1BuiltinTool<{
+        command: string;
+        description?: string | undefined;
+        timeout?: number | undefined;
+        run_in_background?: boolean | undefined;
+        dangerouslyDisableSandbox?: boolean | undefined;
+    }, unknown>;
+    readonly glob: HarnessV1BuiltinTool<{
+        pattern: string;
+        path?: string | undefined;
+    }, unknown>;
+    readonly grep: HarnessV1BuiltinTool<{
+        pattern: string;
+        glob?: string | undefined;
+        type?: string | undefined;
+        path?: string | undefined;
+        offset?: number | undefined;
+        output_mode?: "content" | "files_with_matches" | "count" | undefined;
+        '-B'?: number | undefined;
+        '-A'?: number | undefined;
+        '-C'?: number | undefined;
+        context?: number | undefined;
+        '-n'?: boolean | undefined;
+        '-i'?: boolean | undefined;
+        '-o'?: boolean | undefined;
+        head_limit?: number | undefined;
+        multiline?: boolean | undefined;
+    }, unknown>;
+    readonly webSearch: HarnessV1BuiltinTool<{
+        query: string;
+        allowed_domains?: string[] | undefined;
+        blocked_domains?: string[] | undefined;
+    }, unknown>;
+    readonly WebFetch: _ai_sdk_provider_utils.Tool<{
+        url: string;
+        prompt: string;
+    }, any, any>;
+    readonly NotebookEdit: _ai_sdk_provider_utils.Tool<{
+        notebook_path: string;
+        new_source: string;
+        cell_id?: string | undefined;
+        cell_type?: "code" | "markdown" | undefined;
+        edit_mode?: "replace" | "insert" | "delete" | undefined;
+    }, any, any>;
+    readonly TodoWrite: _ai_sdk_provider_utils.Tool<{
+        todos: {
+            status: "pending" | "in_progress" | "completed";
+            content: string;
+            activeForm: string;
+        }[];
+    }, any, any>;
+    readonly Agent: _ai_sdk_provider_utils.Tool<{
+        description: string;
+        prompt: string;
+        run_in_background?: boolean | undefined;
+        subagent_type?: string | undefined;
+        model?: "sonnet" | "opus" | "haiku" | undefined;
+        name?: string | undefined;
+        team_name?: string | undefined;
+        mode?: "acceptEdits" | "auto" | "bypassPermissions" | "default" | "dontAsk" | "plan" | undefined;
+        isolation?: "worktree" | undefined;
+    }, any, any>;
+    readonly TaskCreate: _ai_sdk_provider_utils.Tool<{
+        description: string;
+        subject: string;
+        metadata?: Record<string, unknown> | undefined;
+        activeForm?: string | undefined;
+    }, any, any>;
+    readonly TaskGet: _ai_sdk_provider_utils.Tool<{
+        taskId: string;
+    }, any, any>;
+    readonly TaskUpdate: _ai_sdk_provider_utils.Tool<{
+        taskId: string;
+        metadata?: Record<string, unknown> | undefined;
+        description?: string | undefined;
+        status?: "pending" | "in_progress" | "completed" | "deleted" | undefined;
+        activeForm?: string | undefined;
+        subject?: string | undefined;
+        addBlocks?: string[] | undefined;
+        addBlockedBy?: string[] | undefined;
+        owner?: string | undefined;
+    }, any, any>;
+    readonly TaskList: _ai_sdk_provider_utils.Tool<{}, any, any>;
+    readonly TaskStop: _ai_sdk_provider_utils.Tool<{
+        task_id?: string | undefined;
+        shell_id?: string | undefined;
+    }, any, any>;
+    readonly TaskOutput: _ai_sdk_provider_utils.Tool<{
+        timeout: number;
+        task_id: string;
+        block: boolean;
+    }, any, any>;
+    readonly ListMcpResources: _ai_sdk_provider_utils.Tool<{
+        server?: string | undefined;
+    }, any, any>;
+    readonly ReadMcpResource: _ai_sdk_provider_utils.Tool<{
+        server: string;
+        uri: string;
+    }, any, any>;
+    readonly ExitPlanMode: _ai_sdk_provider_utils.Tool<z.objectOutputType<{
+        allowedPrompts: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            tool: z.ZodLiteral<"Bash">;
+            prompt: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            prompt: string;
+            tool: "Bash";
+        }, {
+            prompt: string;
+            tool: "Bash";
+        }>, "many">>;
+    }, z.ZodTypeAny, "passthrough">, any, any>;
+    readonly EnterWorktree: _ai_sdk_provider_utils.Tool<{
+        path?: string | undefined;
+        name?: string | undefined;
+    }, any, any>;
+    readonly ExitWorktree: _ai_sdk_provider_utils.Tool<{
+        action: "keep" | "remove";
+        discard_changes?: boolean | undefined;
+    }, any, any>;
+    readonly AskUserQuestion: _ai_sdk_provider_utils.Tool<{
+        questions: {
+            options: {
+                description: string;
+                label: string;
+                preview?: string | undefined;
+            }[];
+            question: string;
+            header: string;
+            multiSelect: boolean;
+        }[];
+        metadata?: {
+            source?: string | undefined;
+        } | undefined;
+        answers?: Record<string, string> | undefined;
+        annotations?: Record<string, {
+            preview?: string | undefined;
+            notes?: string | undefined;
+        }> | undefined;
+    }, any, any>;
+    readonly Skill: _ai_sdk_provider_utils.Tool<{
+        skill: string;
+        args?: string | undefined;
+    }, any, any>;
+};
+declare function createClaudeCode(settings?: ClaudeCodeHarnessSettings): HarnessV1<typeof CLAUDE_CODE_BUILTIN_TOOLS>;
+
+/**
+ * Default `claude-code` harness instance with no overrides — suitable for the
+ * common case where the underlying `claude` CLI's defaults are fine.
+ * Equivalent to `createClaudeCode()`.
+ */
+declare const claudeCode: _ai_sdk_harness.HarnessV1<{
+    readonly read: _ai_sdk_harness.HarnessV1BuiltinTool<{
+        file_path: string;
+        offset?: number | undefined;
+        limit?: number | undefined;
+        pages?: string | undefined;
+    }, unknown>;
+    readonly write: _ai_sdk_harness.HarnessV1BuiltinTool<{
+        file_path: string;
+        content: string;
+    }, unknown>;
+    readonly edit: _ai_sdk_harness.HarnessV1BuiltinTool<{
+        file_path: string;
+        old_string: string;
+        new_string: string;
+        replace_all?: boolean | undefined;
+    }, unknown>;
+    readonly bash: _ai_sdk_harness.HarnessV1BuiltinTool<{
+        command: string;
+        description?: string | undefined;
+        timeout?: number | undefined;
+        run_in_background?: boolean | undefined;
+        dangerouslyDisableSandbox?: boolean | undefined;
+    }, unknown>;
+    readonly glob: _ai_sdk_harness.HarnessV1BuiltinTool<{
+        pattern: string;
+        path?: string | undefined;
+    }, unknown>;
+    readonly grep: _ai_sdk_harness.HarnessV1BuiltinTool<{
+        pattern: string;
+        glob?: string | undefined;
+        type?: string | undefined;
+        path?: string | undefined;
+        offset?: number | undefined;
+        output_mode?: "content" | "files_with_matches" | "count" | undefined;
+        '-B'?: number | undefined;
+        '-A'?: number | undefined;
+        '-C'?: number | undefined;
+        context?: number | undefined;
+        '-n'?: boolean | undefined;
+        '-i'?: boolean | undefined;
+        '-o'?: boolean | undefined;
+        head_limit?: number | undefined;
+        multiline?: boolean | undefined;
+    }, unknown>;
+    readonly webSearch: _ai_sdk_harness.HarnessV1BuiltinTool<{
+        query: string;
+        allowed_domains?: string[] | undefined;
+        blocked_domains?: string[] | undefined;
+    }, unknown>;
+    readonly WebFetch: _ai_sdk_provider_utils.Tool<{
+        url: string;
+        prompt: string;
+    }, any, any>;
+    readonly NotebookEdit: _ai_sdk_provider_utils.Tool<{
+        notebook_path: string;
+        new_source: string;
+        cell_id?: string | undefined;
+        cell_type?: "code" | "markdown" | undefined;
+        edit_mode?: "replace" | "insert" | "delete" | undefined;
+    }, any, any>;
+    readonly TodoWrite: _ai_sdk_provider_utils.Tool<{
+        todos: {
+            status: "pending" | "in_progress" | "completed";
+            content: string;
+            activeForm: string;
+        }[];
+    }, any, any>;
+    readonly Agent: _ai_sdk_provider_utils.Tool<{
+        description: string;
+        prompt: string;
+        run_in_background?: boolean | undefined;
+        subagent_type?: string | undefined;
+        model?: "sonnet" | "opus" | "haiku" | undefined;
+        name?: string | undefined;
+        team_name?: string | undefined;
+        mode?: "acceptEdits" | "auto" | "bypassPermissions" | "default" | "dontAsk" | "plan" | undefined;
+        isolation?: "worktree" | undefined;
+    }, any, any>;
+    readonly TaskCreate: _ai_sdk_provider_utils.Tool<{
+        description: string;
+        subject: string;
+        metadata?: Record<string, unknown> | undefined;
+        activeForm?: string | undefined;
+    }, any, any>;
+    readonly TaskGet: _ai_sdk_provider_utils.Tool<{
+        taskId: string;
+    }, any, any>;
+    readonly TaskUpdate: _ai_sdk_provider_utils.Tool<{
+        taskId: string;
+        metadata?: Record<string, unknown> | undefined;
+        description?: string | undefined;
+        status?: "pending" | "in_progress" | "completed" | "deleted" | undefined;
+        activeForm?: string | undefined;
+        subject?: string | undefined;
+        addBlocks?: string[] | undefined;
+        addBlockedBy?: string[] | undefined;
+        owner?: string | undefined;
+    }, any, any>;
+    readonly TaskList: _ai_sdk_provider_utils.Tool<{}, any, any>;
+    readonly TaskStop: _ai_sdk_provider_utils.Tool<{
+        task_id?: string | undefined;
+        shell_id?: string | undefined;
+    }, any, any>;
+    readonly TaskOutput: _ai_sdk_provider_utils.Tool<{
+        timeout: number;
+        task_id: string;
+        block: boolean;
+    }, any, any>;
+    readonly ListMcpResources: _ai_sdk_provider_utils.Tool<{
+        server?: string | undefined;
+    }, any, any>;
+    readonly ReadMcpResource: _ai_sdk_provider_utils.Tool<{
+        server: string;
+        uri: string;
+    }, any, any>;
+    readonly ExitPlanMode: _ai_sdk_provider_utils.Tool<zod.objectOutputType<{
+        allowedPrompts: zod.ZodOptional<zod.ZodArray<zod.ZodObject<{
+            tool: zod.ZodLiteral<"Bash">;
+            prompt: zod.ZodString;
+        }, "strip", zod.ZodTypeAny, {
+            prompt: string;
+            tool: "Bash";
+        }, {
+            prompt: string;
+            tool: "Bash";
+        }>, "many">>;
+    }, zod.ZodTypeAny, "passthrough">, any, any>;
+    readonly EnterWorktree: _ai_sdk_provider_utils.Tool<{
+        path?: string | undefined;
+        name?: string | undefined;
+    }, any, any>;
+    readonly ExitWorktree: _ai_sdk_provider_utils.Tool<{
+        action: "keep" | "remove";
+        discard_changes?: boolean | undefined;
+    }, any, any>;
+    readonly AskUserQuestion: _ai_sdk_provider_utils.Tool<{
+        questions: {
+            options: {
+                description: string;
+                label: string;
+                preview?: string | undefined;
+            }[];
+            question: string;
+            header: string;
+            multiSelect: boolean;
+        }[];
+        metadata?: {
+            source?: string | undefined;
+        } | undefined;
+        answers?: Record<string, string> | undefined;
+        annotations?: Record<string, {
+            preview?: string | undefined;
+            notes?: string | undefined;
+        }> | undefined;
+    }, any, any>;
+    readonly Skill: _ai_sdk_provider_utils.Tool<{
+        skill: string;
+        args?: string | undefined;
+    }, any, any>;
+}>;
+
+export { type ClaudeCodeAuthOptions, type ClaudeCodeHarnessSettings, claudeCode, createClaudeCode };