@bunny-agent/sdk 0.9.28

package/dist/index.d.ts

@@ -0,0 +1,241 @@
+import { BunnyAgentOptions, SandboxAdapter, RunnerSpec } from '@bunny-agent/manager';
+export { DEFAULT_BUNNY_AGENT_DAEMON_URL, IsBunnyAgentDaemonHealthyOptions, LocalSandbox, LocalSandboxOptions, Message, RunnerEnvParams, RunnerType, SandboxAdapter, SandboxHandle, TranscriptEntry, buildRunnerEnv, isBunnyAgentDaemonHealthy } from '@bunny-agent/manager';
+import { LanguageModelV3StreamPart, LanguageModelV3, LanguageModelV3CallOptions, LanguageModelV3GenerateResult, LanguageModelV3StreamResult, ProviderV3, EmbeddingModelV3, ImageModelV3 } from '@ai-sdk/provider';
+export { LanguageModelV3StreamPart } from '@ai-sdk/provider';
+
+/**
+ * Artifact Processor result
+ */
+interface ArtifactResult {
+    artifactId: string;
+    content: string;
+    mimeType?: string;
+}
+/**
+ * Stream writer interface for writing data parts
+ */
+interface StreamWriter {
+    write(chunk: {
+        type: string;
+        id?: string;
+        data?: unknown;
+        transient?: boolean;
+    }): void;
+}
+/**
+ * Artifact Processor interface
+ */
+interface ArtifactProcessor {
+    /**
+     * Invoked when a stream part is received
+     * @param event - Stream part event
+     * @param sessionId - Current session ID (taskId)
+     */
+    onChange(event: LanguageModelV3StreamPart, sessionId: string): Promise<void>;
+}
+/**
+ * Question structure for AskUserQuestion tool
+ */
+interface Question {
+    question: string;
+    header?: string;
+    options?: Array<{
+        label: string;
+        description?: string;
+    }>;
+    multiSelect?: boolean;
+}
+/**
+ * Parameters for submitting an answer
+ */
+interface SubmitAnswerParams {
+    /** Tool call ID from the AskUserQuestion tool */
+    toolCallId: string;
+    /** Original questions from the tool */
+    questions: Question[];
+    /** User's answers keyed by question text */
+    answers: Record<string, string>;
+}
+/**
+ * Logger interface for custom logging.
+ */
+interface Logger {
+    debug: (message: string) => void;
+    info: (message: string) => void;
+    warn: (message: string) => void;
+    error: (message: string) => void;
+}
+/**
+ * CLI runner type passed to `bunny-agent run --runner <runnerType>`.
+ */
+type BunnyAgentRunnerType = "claude" | "pi" | "codex" | "gemini" | "opencode";
+/**
+ * AI Provider specific settings that extend BunnyAgentOptions.
+ * Requires a `sandbox`. Optional `daemonUrl` streams via bunny-agent-daemon HTTP
+ * (`POST /api/coding/run`) inside the sandbox. The SDK does **not** probe `/healthz`
+ * on each request — call `isBunnyAgentDaemonHealthy` (re-exported from
+ * `@bunny-agent/sdk`) when you want to check readiness and omit `daemonUrl` to fall
+ * back to the CLI runner, or set `daemonUrl` and handle HTTP errors yourself.
+ */
+interface BunnyAgentProviderSettings extends Omit<BunnyAgentOptions, "runner" | "sandboxId" | "sandbox"> {
+    /** Required. All transports run relative to this adapter. */
+    sandbox: SandboxAdapter;
+    /**
+     * bunny-agent-daemon base URL **inside** the sandbox (e.g. BunnyAgent image:
+     * `http://127.0.0.1:3080`). When set, the SDK uses HTTP streaming only (no
+     * automatic health probe or CLI fallback).
+     */
+    daemonUrl?: string;
+    /**
+     * Which runner implementation to use: claude (default), pi, codex, gemini, opencode.
+     * Maps to `bunny-agent run --runner <runnerType>`.
+     */
+    runnerType?: BunnyAgentRunnerType;
+    /** Working directory for CLI operations inside the sandbox. */
+    cwd?: string;
+    /** Resume session ID for multi-turn conversation. */
+    resume?: string;
+    /** Enable verbose logging for debugging. */
+    verbose?: boolean;
+    /** Custom logger for handling warnings and errors. */
+    logger?: Logger | false;
+    /** Artifact processors for handling artifact events. */
+    artifactProcessors?: ArtifactProcessor[];
+    /** Limit the number of back-and-forth iterations */
+    maxTurns?: number;
+    /** Optional system prompt override (overrides template's default) */
+    systemPrompt?: string;
+    /** Additional skill paths (files or directories) for pi runner */
+    skillPaths?: string[];
+    /** Allowed tools for the runner (undefined = template defaults). */
+    allowedTools?: string[];
+    /** Skip tool approval checks (bypass permissions). */
+    yolo?: boolean;
+}
+/**
+ * Model identifier: user passes whatever the runner expects (e.g. Claude model id, Pi model id).
+ */
+type BunnyAgentModelId = string;
+
+/**
+ * Options for creating a BunnyAgent language model instance.
+ */
+interface BunnyAgentLanguageModelOptions {
+    id: BunnyAgentModelId;
+    options: BunnyAgentProviderSettings & {
+        runner: RunnerSpec;
+    };
+}
+/**
+ * BunnyAgent Language Model implementation for AI SDK.
+ */
+declare class BunnyAgentLanguageModel implements LanguageModelV3 {
+    readonly specificationVersion: "v3";
+    readonly provider: string;
+    readonly modelId: string;
+    readonly supportedUrls: Record<string, RegExp[]>;
+    private readonly options;
+    private readonly logger;
+    private sessionId;
+    private toolNameMap;
+    private legacyTextPartCounter;
+    constructor(modelOptions: BunnyAgentLanguageModelOptions);
+    doGenerate(options: LanguageModelV3CallOptions): Promise<LanguageModelV3GenerateResult>;
+    doStream(options: LanguageModelV3CallOptions): Promise<LanguageModelV3StreamResult>;
+    private resetStreamState;
+    private buildCodingRunBody;
+    private buildStreamResult;
+    private createLanguageModelStreamFromSseReader;
+    private parseSSEBuffer;
+    private parseSSEData;
+    private convertPromptToMessages;
+    private mapFinishReason;
+    private convertUsage;
+}
+
+/**
+ * BunnyAgent provider interface that extends the AI SDK's ProviderV3.
+ */
+interface BunnyAgentProvider extends ProviderV3 {
+    (modelId: BunnyAgentModelId, options?: Partial<BunnyAgentProviderSettings>): LanguageModelV3;
+    languageModel(modelId: BunnyAgentModelId, options?: Partial<BunnyAgentProviderSettings>): LanguageModelV3;
+    chat(modelId: BunnyAgentModelId, options?: Partial<BunnyAgentProviderSettings>): LanguageModelV3;
+    embeddingModel(modelId: string): EmbeddingModelV3;
+    textEmbeddingModel(modelId: string): EmbeddingModelV3;
+    imageModel(modelId: string): ImageModelV3;
+}
+/**
+ * Creates a BunnyAgent provider instance with the specified configuration.
+ *
+ * @example
+ * ```typescript
+ * import { createBunnyAgent } from '@bunny-agent/sdk';
+ * import { E2BSandbox } from '@bunny-agent/sandbox-e2b';
+ * import { generateText } from 'ai';
+ *
+ * const bunnyAgent = createBunnyAgent({
+ *   sandbox: new E2BSandbox({ apiKey: process.env.E2B_API_KEY! }),
+ *   env: {
+ *     ANTHROPIC_API_KEY: process.env.ANTHROPIC_API_KEY!,
+ *   },
+ * });
+ *
+ * const { text } = await generateText({
+ *   model: bunnyAgent('sonnet'),
+ *   prompt: 'Create a hello world program',
+ * });
+ * ```
+ */
+declare function createBunnyAgent(defaultOptions: BunnyAgentProviderSettings): BunnyAgentProvider;
+
+/**
+ * Options for submitAnswer
+ */
+interface SubmitAnswerOptions {
+    /**
+     * Optional base path prefix for approval files
+     * @default ".bunny-agent/approvals"
+     */
+    basePath?: string;
+}
+/**
+ * Submit user's answer for an AskUserQuestion tool call.
+ * Writes the answer file to `.bunny-agent/approvals/{toolCallId}.json` in the sandbox workdir.
+ *
+ * @example
+ * ```typescript
+ * import { submitAnswer } from "@bunny-agent/sdk";
+ *
+ * await submitAnswer(sandbox, {
+ *   toolCallId: "tool-456",
+ *   questions: [...],
+ *   answers: { "Question 1": "Answer 1" },
+ * });
+ * ```
+ */
+declare function submitAnswer(sandbox: SandboxAdapter, params: SubmitAnswerParams, options?: SubmitAnswerOptions): Promise<void>;
+
+/**
+ * @bunny-agent/sdk
+ *
+ * BunnyAgent SDK - AI Provider and React hooks for building AI chat interfaces.
+ *
+ * Main entry point exports the AI provider (backend).
+ * React hooks are available via "@bunny-agent/sdk/react".
+ *
+ * @example
+ * ```typescript
+ * // Backend - Provider
+ * import { createBunnyAgent } from "@bunny-agent/sdk";
+ * const bunnyAgent = createBunnyAgent({ sandbox, env });
+ * const model = bunnyAgent("sonnet");
+ *
+ * // Frontend - React hooks
+ * import { useBunnyAgentChat } from "@bunny-agent/sdk/react";
+ * const { messages, sendMessage } = useBunnyAgentChat({ apiEndpoint: "/api/ai" });
+ * ```
+ */
+
+declare const VERSION = "0.1.0";
+
+export { type ArtifactProcessor, type ArtifactResult, BunnyAgentLanguageModel, type BunnyAgentLanguageModelOptions, type BunnyAgentModelId, type BunnyAgentProvider, type BunnyAgentProviderSettings, type Logger, type Question, type StreamWriter, type SubmitAnswerOptions, type SubmitAnswerParams, VERSION, createBunnyAgent, submitAnswer };