@opencode-ai/ai 0.0.0-beta-17492

package/dist/protocols/gemini.js

@@ -0,0 +1,512 @@
+import { Effect, Schema } from "effect";
+import { Tool } from "@opencode-ai/schema/tool";
+import { Route } from "../route/client.js";
+import { Auth } from "../route/auth.js";
+import { Endpoint } from "../route/endpoint.js";
+import { Framing } from "../route/framing.js";
+import { Protocol } from "../route/protocol.js";
+import { LLMEvent, Usage, } from "../schema/index.js";
+import { JsonObject, optionalArray, ProviderShared } from "./shared.js";
+import { GeminiToolSchema } from "./utils/gemini-tool-schema.js";
+import { Lifecycle } from "./utils/lifecycle.js";
+import { ToolSchemaProjection } from "./utils/tool-schema.js";
+const ADAPTER = "gemini";
+const MEDIA_MIMES = new Set(ProviderShared.MEDIA_MIMES);
+// Google documents this sentinel for replaying Gemini 3 function calls after their original signature was lost.
+const SKIP_THOUGHT_SIGNATURE_VALIDATOR = "skip_thought_signature_validator";
+export const DEFAULT_BASE_URL = "https://generativelanguage.googleapis.com/v1beta";
+// Gemini 3 rejects replayed function calls without a thought signature. Google's SDKs avoid that in normal chats by
+// retaining complete model responses, but OpenCode reconstructs durable history and may encounter an unsigned call
+// from an older or external session. Model IDs are open-ended, so unknown Gemini aliases inherit current behavior.
+const requiresThoughtSignatureFallback = (modelID) => {
+    if (!/(^|\/)gemini-/i.test(modelID))
+        return false;
+    if (/(^|\/)gemini-(?:1|2)(?:[.-]|$)/i.test(modelID))
+        return false;
+    if (/(^|\/)gemini-pro(?:-vision)?$/i.test(modelID))
+        return false;
+    return !/(^|\/)gemini-robotics-er-1\.5(?:[.-]|$)/i.test(modelID);
+};
+// =============================================================================
+// Request Body Schema
+// =============================================================================
+const GeminiTextPart = Schema.Struct({
+    text: Schema.String,
+    thought: Schema.optional(Schema.Boolean),
+    thoughtSignature: Schema.optional(Schema.String),
+});
+const GeminiInlineDataPart = Schema.Struct({
+    inlineData: Schema.Struct({
+        mimeType: Schema.String,
+        data: Schema.String,
+    }),
+});
+const GeminiFunctionCallPart = Schema.Struct({
+    functionCall: Schema.Struct({
+        id: Schema.optional(Schema.String),
+        name: Schema.String,
+        args: Schema.Unknown,
+    }),
+    thoughtSignature: Schema.optional(Schema.String),
+});
+const GeminiFunctionResponsePart = Schema.Struct({
+    functionResponse: Schema.Struct({
+        id: Schema.optional(Schema.String),
+        name: Schema.String,
+        response: Schema.Unknown,
+        parts: Schema.optional(Schema.Array(GeminiInlineDataPart)),
+    }),
+});
+const GeminiContentPart = Schema.Union([
+    GeminiTextPart,
+    GeminiInlineDataPart,
+    GeminiFunctionCallPart,
+    GeminiFunctionResponsePart,
+]);
+const GeminiContent = Schema.Struct({
+    role: Schema.Literals(["user", "model"]),
+    parts: Schema.Array(GeminiContentPart),
+});
+const GeminiSystemInstruction = Schema.Struct({
+    parts: Schema.Array(Schema.Struct({ text: Schema.String })),
+});
+const GeminiFunctionDeclaration = Schema.Struct({
+    name: Schema.String,
+    description: Schema.String,
+    parameters: Schema.optional(JsonObject),
+});
+const GeminiTool = Schema.Struct({
+    functionDeclarations: Schema.Array(GeminiFunctionDeclaration),
+});
+const GeminiToolConfig = Schema.Struct({
+    functionCallingConfig: Schema.Struct({
+        mode: Schema.Literals(["AUTO", "NONE", "ANY"]),
+        allowedFunctionNames: optionalArray(Schema.String),
+    }),
+});
+const GeminiThinkingConfig = Schema.Struct({
+    thinkingBudget: Schema.optional(Schema.Number),
+    includeThoughts: Schema.optional(Schema.Boolean),
+    thinkingLevel: Schema.optional(Schema.String),
+});
+const GeminiSafetySetting = Schema.Struct({
+    category: Schema.String,
+    threshold: Schema.String,
+});
+const GeminiGenerationConfig = Schema.Struct({
+    maxOutputTokens: Schema.optional(Schema.Number),
+    temperature: Schema.optional(Schema.Number),
+    topP: Schema.optional(Schema.Number),
+    topK: Schema.optional(Schema.Number),
+    frequencyPenalty: Schema.optional(Schema.Number),
+    presencePenalty: Schema.optional(Schema.Number),
+    seed: Schema.optional(Schema.Number),
+    stopSequences: optionalArray(Schema.String),
+    thinkingConfig: Schema.optional(GeminiThinkingConfig),
+});
+const GeminiBodyFields = {
+    cachedContent: Schema.optional(Schema.String),
+    contents: Schema.Array(GeminiContent),
+    safetySettings: optionalArray(GeminiSafetySetting),
+    serviceTier: Schema.optional(Schema.String),
+    systemInstruction: Schema.optional(GeminiSystemInstruction),
+    tools: optionalArray(GeminiTool),
+    toolConfig: Schema.optional(GeminiToolConfig),
+    generationConfig: Schema.optional(GeminiGenerationConfig),
+};
+const GeminiBody = Schema.Struct(GeminiBodyFields);
+const GeminiUsage = Schema.Struct({
+    cachedContentTokenCount: Schema.optional(Schema.Number),
+    thoughtsTokenCount: Schema.optional(Schema.Number),
+    promptTokenCount: Schema.optional(Schema.Number),
+    candidatesTokenCount: Schema.optional(Schema.Number),
+    totalTokenCount: Schema.optional(Schema.Number),
+});
+const GeminiCandidate = Schema.Struct({
+    content: Schema.optional(GeminiContent),
+    finishReason: Schema.optional(Schema.String),
+});
+const GeminiEvent = Schema.Struct({
+    candidates: optionalArray(GeminiCandidate),
+    usageMetadata: Schema.optional(GeminiUsage),
+});
+// =============================================================================
+// Tool Schema Conversion
+// =============================================================================
+// Tool-schema conversion has two distinct concerns:
+//
+// 1. Sanitize — fix common authoring mistakes Gemini rejects: integer/number
+//    enums (must be strings), `required` entries that don't match a property,
+//    untyped arrays (`items` must be present), and `properties`/`required`
+//    keys on non-object scalars. Mirrors OpenCode's historical Gemini rules.
+//
+// 2. Project — lossy mapping from JSON Schema to Gemini's schema dialect:
+//    drop empty root parameter schemas while preserving nested empty objects,
+//    expand type arrays into `anyOf`, derive `nullable: true` from null members,
+//    coerce `const` to `[const]` enum, recurse properties/items, and propagate
+//    only an allowlisted set of keys (description, required, format, type,
+//    nullable, enum, properties, items, allOf, anyOf, oneOf, minLength).
+//    Anything outside the allowlist (e.g. `additionalProperties`, `$ref`) is
+//    silently dropped.
+//
+// Sanitize runs first, then project. The implementation lives in
+// `utils/gemini-tool-schema` so this protocol keeps the same shape as the other
+// provider protocols.
+// =============================================================================
+// Request Lowering
+// =============================================================================
+const lowerTool = (tool, inputSchema) => ({
+    name: tool.name,
+    description: tool.description,
+    parameters: GeminiToolSchema.convert(inputSchema),
+});
+const lowerToolConfig = (toolChoice) => ProviderShared.matchToolChoice("Gemini", toolChoice, {
+    auto: () => ({ functionCallingConfig: { mode: "AUTO" } }),
+    none: () => ({ functionCallingConfig: { mode: "NONE" } }),
+    required: () => ({ functionCallingConfig: { mode: "ANY" } }),
+    tool: (name) => ({ functionCallingConfig: { mode: "ANY", allowedFunctionNames: [name] } }),
+});
+const lowerUserPart = Effect.fn("Gemini.lowerUserPart")(function* (part) {
+    if (part.type === "text")
+        return { text: part.text };
+    const media = yield* ProviderShared.validateMedia("Gemini", part, MEDIA_MIMES);
+    return { inlineData: { mimeType: media.mime, data: media.base64 } };
+});
+const googleMetadata = (metadata) => ({ google: metadata });
+const thoughtSignature = (providerMetadata) => {
+    const google = providerMetadata?.google;
+    return ProviderShared.isRecord(google) && typeof google.thoughtSignature === "string"
+        ? google.thoughtSignature
+        : undefined;
+};
+const functionCallId = (providerMetadata) => {
+    const google = providerMetadata?.google;
+    return ProviderShared.isRecord(google) && typeof google.functionCallId === "string"
+        ? google.functionCallId
+        : undefined;
+};
+const lowerToolCall = (part) => ({
+    functionCall: { id: functionCallId(part.providerMetadata), name: part.name, args: part.input },
+    thoughtSignature: thoughtSignature(part.providerMetadata),
+});
+const lowerMessages = Effect.fn("Gemini.lowerMessages")(function* (request) {
+    const contents = [];
+    for (const message of request.messages) {
+        if (message.role === "system") {
+            const part = yield* ProviderShared.wrappedSystemUpdate("Gemini", message);
+            const previous = contents.at(-1);
+            if (previous?.role === "user")
+                contents[contents.length - 1] = { role: "user", parts: [...previous.parts, { text: part.text }] };
+            else
+                contents.push({ role: "user", parts: [{ text: part.text }] });
+            continue;
+        }
+        if (message.role === "user") {
+            const parts = [];
+            for (const part of message.content) {
+                if (!ProviderShared.supportsContent(part, ["text", "media"]))
+                    return yield* ProviderShared.unsupportedContent("Gemini", "user", ["text", "media"]);
+                parts.push(yield* lowerUserPart(part));
+            }
+            contents.push({ role: "user", parts });
+            continue;
+        }
+        if (message.role === "assistant") {
+            const parts = [];
+            // Parallel Gemini 3 calls may carry one signature on the first call; unsigned sibling calls are valid.
+            let hasSignedToolCall = false;
+            for (const part of message.content) {
+                if (!ProviderShared.supportsContent(part, ["text", "reasoning", "tool-call"]))
+                    return yield* ProviderShared.unsupportedContent("Gemini", "assistant", ["text", "reasoning", "tool-call"]);
+                if (part.type === "text") {
+                    parts.push({ text: part.text });
+                    continue;
+                }
+                if (part.type === "reasoning") {
+                    parts.push({ text: part.text, thought: true, thoughtSignature: thoughtSignature(part.providerMetadata) });
+                    continue;
+                }
+                if (part.type === "tool-call") {
+                    const lowered = lowerToolCall(part);
+                    const signature = lowered.thoughtSignature;
+                    parts.push({
+                        ...lowered,
+                        thoughtSignature: signature ??
+                            (requiresThoughtSignatureFallback(request.model.id) && !hasSignedToolCall
+                                ? SKIP_THOUGHT_SIGNATURE_VALIDATOR
+                                : undefined),
+                    });
+                    if (signature !== undefined)
+                        hasSignedToolCall = true;
+                    continue;
+                }
+            }
+            contents.push({ role: "model", parts });
+            continue;
+        }
+        const parts = [];
+        for (const part of message.content) {
+            if (!ProviderShared.supportsContent(part, ["tool-result"]))
+                return yield* ProviderShared.unsupportedContent("Gemini", "tool", ["tool-result"]);
+            if (part.result.type !== "content") {
+                parts.push({
+                    functionResponse: {
+                        id: functionCallId(part.providerMetadata),
+                        name: part.name,
+                        response: {
+                            name: part.name,
+                            content: ProviderShared.toolResultText(part),
+                        },
+                    },
+                });
+                continue;
+            }
+            const content = part.result.value;
+            const text = content.filter((item) => item.type === "text").map((item) => item.text);
+            const media = [];
+            for (const item of content) {
+                if (item.type === "text")
+                    continue;
+                const value = yield* ProviderShared.validateToolFile("Gemini", item, MEDIA_MIMES);
+                media.push({ inlineData: { mimeType: value.mime, data: value.base64 } });
+            }
+            parts.push({
+                functionResponse: {
+                    id: functionCallId(part.providerMetadata),
+                    name: part.name,
+                    response: {
+                        name: part.name,
+                        content: text.join("\n"),
+                    },
+                    parts: media.length > 0 ? media : undefined,
+                },
+            });
+        }
+        contents.push({ role: "user", parts });
+    }
+    return contents;
+});
+const resolveOptions = (request) => {
+    const input = request.providerOptions?.gemini;
+    const value = input?.thinkingConfig;
+    const thinkingConfig = {
+        thinkingBudget: ProviderShared.isRecord(value) && typeof value.thinkingBudget === "number" ? value.thinkingBudget : undefined,
+        includeThoughts: ProviderShared.isRecord(value) && typeof value.includeThoughts === "boolean"
+            ? value.includeThoughts
+            : ProviderShared.isRecord(value)
+                ? true
+                : undefined,
+        thinkingLevel: ProviderShared.isRecord(value) && typeof value.thinkingLevel === "string" ? value.thinkingLevel : undefined,
+    };
+    return {
+        cachedContent: typeof input?.cachedContent === "string" ? input.cachedContent : undefined,
+        safetySettings: mapSafetySettings(input?.safetySettings),
+        serviceTier: typeof input?.serviceTier === "string" ? input.serviceTier : undefined,
+        thinkingConfig: Object.values(thinkingConfig).some((item) => item !== undefined) ? thinkingConfig : undefined,
+    };
+};
+function mapSafetySettings(value) {
+    if (!Array.isArray(value))
+        return undefined;
+    const settings = value.flatMap((item) => ProviderShared.isRecord(item) && typeof item.category === "string" && typeof item.threshold === "string"
+        ? [{ category: item.category, threshold: item.threshold }]
+        : []);
+    return settings;
+}
+const fromRequest = Effect.fn("Gemini.fromRequest")(function* (request) {
+    const hasTools = request.tools.length > 0;
+    const generation = request.generation;
+    const options = resolveOptions(request);
+    const toolSchemaCompatibility = request.model.compatibility?.toolSchema;
+    const generationConfig = {
+        maxOutputTokens: generation?.maxTokens,
+        temperature: generation?.temperature,
+        topP: generation?.topP,
+        topK: generation?.topK,
+        frequencyPenalty: generation?.frequencyPenalty,
+        presencePenalty: generation?.presencePenalty,
+        seed: generation?.seed,
+        stopSequences: generation?.stop,
+        thinkingConfig: options.thinkingConfig,
+    };
+    return {
+        cachedContent: options.cachedContent,
+        contents: yield* lowerMessages(request),
+        safetySettings: options.safetySettings,
+        serviceTier: options.serviceTier,
+        systemInstruction: request.system.length === 0 ? undefined : { parts: [{ text: ProviderShared.joinText(request.system) }] },
+        tools: hasTools
+            ? [
+                {
+                    functionDeclarations: request.tools.map((tool) => lowerTool(tool, ToolSchemaProjection.modelCompatibility(tool.inputSchema, toolSchemaCompatibility))),
+                },
+            ]
+            : undefined,
+        toolConfig: hasTools && request.toolChoice ? yield* lowerToolConfig(request.toolChoice) : undefined,
+        generationConfig: Object.values(generationConfig).some((value) => value !== undefined)
+            ? generationConfig
+            : undefined,
+    };
+});
+// =============================================================================
+// Stream Parsing
+// =============================================================================
+// Gemini reports `promptTokenCount` (inclusive total) with a
+// `cachedContentTokenCount` subset. `candidatesTokenCount` is *exclusive*
+// of `thoughtsTokenCount` — visible-only, not a total — so we sum the two
+// to produce the inclusive `outputTokens` the rest of the contract expects.
+const mapUsage = (usage) => {
+    if (!usage)
+        return undefined;
+    const cached = usage.cachedContentTokenCount;
+    const nonCached = ProviderShared.subtractTokens(usage.promptTokenCount, cached);
+    // `candidatesTokenCount` is visible-only; sum with thoughts to produce the
+    // inclusive `outputTokens` the contract expects. Only compute the total
+    // when the visible component is reported — otherwise we'd fabricate an
+    // inclusive number from a partial breakdown.
+    const outputTokens = usage.candidatesTokenCount !== undefined ? usage.candidatesTokenCount + (usage.thoughtsTokenCount ?? 0) : undefined;
+    return new Usage({
+        inputTokens: usage.promptTokenCount,
+        outputTokens,
+        nonCachedInputTokens: nonCached,
+        cacheReadInputTokens: cached,
+        reasoningTokens: usage.thoughtsTokenCount,
+        totalTokens: ProviderShared.totalTokens(usage.promptTokenCount, outputTokens, usage.totalTokenCount),
+        providerMetadata: { google: usage },
+    });
+};
+const mapFinishReason = (finishReason, hasToolCalls) => {
+    if (finishReason === undefined)
+        return hasToolCalls ? "tool-calls" : "unknown";
+    if (finishReason === "STOP")
+        return hasToolCalls ? "tool-calls" : "stop";
+    if (finishReason === "MAX_TOKENS")
+        return "length";
+    if (finishReason === "IMAGE_SAFETY" ||
+        finishReason === "RECITATION" ||
+        finishReason === "SAFETY" ||
+        finishReason === "BLOCKLIST" ||
+        finishReason === "PROHIBITED_CONTENT" ||
+        finishReason === "SPII" ||
+        finishReason === "MODEL_ARMOR" ||
+        finishReason === "IMAGE_PROHIBITED_CONTENT" ||
+        finishReason === "IMAGE_RECITATION" ||
+        finishReason === "LANGUAGE")
+        return "content-filter";
+    if (finishReason === "MALFORMED_FUNCTION_CALL" ||
+        finishReason === "UNEXPECTED_TOOL_CALL" ||
+        finishReason === "NO_IMAGE" ||
+        finishReason === "TOO_MANY_TOOL_CALLS" ||
+        finishReason === "MISSING_THOUGHT_SIGNATURE" ||
+        finishReason === "MALFORMED_RESPONSE")
+        return "error";
+    return "unknown";
+};
+const finish = (state) => state.finishReason || state.usage
+    ? (() => {
+        const events = [];
+        const lifecycle = state.reasoningSignature
+            ? Lifecycle.reasoningEnd(state.lifecycle, events, "reasoning-0", googleMetadata({ thoughtSignature: state.reasoningSignature }))
+            : state.lifecycle;
+        Lifecycle.finish(lifecycle, events, {
+            reason: {
+                normalized: mapFinishReason(state.finishReason, state.hasToolCalls),
+                raw: state.finishReason,
+            },
+            usage: state.usage,
+        });
+        return events;
+    })()
+    : [];
+const step = (state, event) => {
+    const nextState = {
+        ...state,
+        usage: event.usageMetadata ? (mapUsage(event.usageMetadata) ?? state.usage) : state.usage,
+    };
+    const candidate = event.candidates?.[0];
+    if (!candidate?.content)
+        return Effect.succeed([
+            { ...nextState, finishReason: candidate?.finishReason ?? nextState.finishReason },
+            [],
+        ]);
+    const events = [];
+    let hasToolCalls = nextState.hasToolCalls;
+    let lifecycle = nextState.lifecycle;
+    let nextToolCallId = nextState.nextToolCallId;
+    let reasoningSignature = nextState.reasoningSignature;
+    for (const part of candidate.content.parts) {
+        if ("thoughtSignature" in part && part.thoughtSignature && "thought" in part && part.thought)
+            reasoningSignature = part.thoughtSignature;
+        if ("text" in part && part.text.length > 0) {
+            if (part.thought) {
+                lifecycle = Lifecycle.reasoningDelta(lifecycle, events, "reasoning-0", part.text, part.thoughtSignature ? googleMetadata({ thoughtSignature: part.thoughtSignature }) : undefined);
+                continue;
+            }
+            lifecycle = Lifecycle.reasoningEnd(lifecycle, events, "reasoning-0", reasoningSignature ? googleMetadata({ thoughtSignature: reasoningSignature }) : undefined);
+            lifecycle = Lifecycle.textDelta(lifecycle, events, "text-0", part.text);
+            continue;
+        }
+        if ("functionCall" in part) {
+            const input = part.functionCall.args;
+            const id = `tool_${nextToolCallId++}`;
+            const metadata = {
+                ...(part.functionCall.id === undefined ? {} : { functionCallId: part.functionCall.id }),
+                ...(part.thoughtSignature === undefined ? {} : { thoughtSignature: part.thoughtSignature }),
+            };
+            lifecycle = Lifecycle.reasoningEnd(lifecycle, events, "reasoning-0", reasoningSignature ? googleMetadata({ thoughtSignature: reasoningSignature }) : undefined);
+            lifecycle = Lifecycle.stepStart(lifecycle, events);
+            events.push(LLMEvent.toolCall({
+                id,
+                name: part.functionCall.name,
+                input,
+                providerMetadata: Object.keys(metadata).length > 0 ? googleMetadata(metadata) : undefined,
+            }));
+            hasToolCalls = true;
+        }
+    }
+    return Effect.succeed([
+        {
+            ...nextState,
+            hasToolCalls,
+            lifecycle,
+            nextToolCallId,
+            reasoningSignature,
+            finishReason: candidate.finishReason ?? nextState.finishReason,
+        },
+        events,
+    ]);
+};
+// =============================================================================
+// Protocol And Gemini Route
+// =============================================================================
+/**
+ * The Gemini protocol — request body construction, body schema, and the
+ * streaming-event state machine. Used by Google AI Studio Gemini and (once
+ * registered) Vertex Gemini.
+ */
+export const protocol = Protocol.make({
+    id: ADAPTER,
+    body: {
+        schema: GeminiBody,
+        from: fromRequest,
+    },
+    stream: {
+        event: Protocol.jsonEvent(GeminiEvent),
+        initial: () => ({ hasToolCalls: false, nextToolCallId: 0, lifecycle: Lifecycle.initial() }),
+        step,
+        onHalt: finish,
+    },
+});
+export const route = Route.make({
+    id: ADAPTER,
+    provider: "google",
+    providerMetadataKey: "google",
+    protocol,
+    // Gemini's path embeds the model id and pins SSE framing at the URL level.
+    endpoint: Endpoint.path(({ request }) => `/models/${request.model.id}:streamGenerateContent?alt=sse`, {
+        baseURL: DEFAULT_BASE_URL,
+    }),
+    auth: Auth.none,
+    framing: Framing.sse,
+});
+export * as Gemini from "./gemini.js";

package/dist/protocols/google-images.d.ts

@@ -0,0 +1,30 @@
+import { ImageModel } from "../image.js";
+import { type Definition as AuthDefinition } from "../route/auth.js";
+import { type HttpOptions } from "../schema/index.js";
+export declare const DEFAULT_BASE_URL = "https://generativelanguage.googleapis.com/v1beta";
+export type GoogleImageString<Known extends string> = Known | (string & {});
+export type GoogleImageOptions = {
+    readonly aspectRatio?: GoogleImageString<"1:1" | "2:3" | "3:2" | "3:4" | "4:3" | "4:5" | "5:4" | "9:16" | "16:9" | "21:9">;
+    readonly imageSize?: GoogleImageString<"1K" | "2K" | "4K">;
+    readonly seed?: number;
+    readonly thinkingLevel?: GoogleImageString<"MINIMAL" | "LOW" | "MEDIUM" | "HIGH">;
+    readonly includeThoughts?: boolean;
+} & Record<string, unknown>;
+export type GoogleImageBody = Record<string, unknown> & {
+    readonly contents: ReadonlyArray<{
+        readonly role: "user";
+        readonly parts: ReadonlyArray<Record<string, unknown>>;
+    }>;
+    readonly generationConfig: Record<string, unknown>;
+};
+export interface ModelInput {
+    readonly id: string;
+    readonly auth: AuthDefinition;
+    readonly baseURL?: string;
+    readonly headers?: Record<string, string>;
+    readonly http?: HttpOptions;
+}
+export declare const model: (input: ModelInput) => ImageModel<GoogleImageOptions>;
+export declare const GoogleImages: {
+    readonly model: (input: ModelInput) => ImageModel<GoogleImageOptions>;
+};