@opencode-ai/ai 0.0.0-next-16210 → 0.0.0-next-16214

package/dist/protocols/open-responses.d.ts

@@ -1,7 +1,7 @@
 import { Effect, Schema } from "effect";
 import { HttpTransport } from "../route/transport";
 import { Protocol } from "../route/protocol";
-import { LLMError, LLMEvent, type LLMRequest, type MediaPart, type ProviderMetadata, type ToolDefinition } from "../schema";
+import { LLMError, LLMEvent, Usage, type LLMRequest, type MediaPart, type ProviderMetadata, type ToolDefinition } from "../schema";
 import { ProviderShared } from "./shared";
 import { Lifecycle } from "./utils/lifecycle";
 import { ToolStream } from "./utils/tool-stream";
@@ -16,6 +16,73 @@ declare const MediaInput: Schema.Union<readonly [Schema.Struct<{
     readonly mime_type: Schema.optional<Schema.String>;
 }>]>;
 export type MediaInput = Schema.Schema.Type<typeof MediaInput>;
+export declare const MessagePhase: Schema.Literals<readonly ["commentary", "final_answer"]>;
+type MessagePhase = Schema.Schema.Type<typeof MessagePhase>;
+export declare const InputItem: Schema.Union<readonly [Schema.Struct<{
+    readonly role: Schema.tag<"system">;
+    readonly content: Schema.String;
+}>, Schema.Struct<{
+    readonly role: Schema.tag<"user">;
+    readonly content: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
+        readonly type: Schema.tag<"input_text">;
+        readonly text: Schema.String;
+    }>, Schema.Union<readonly [Schema.Struct<{
+        readonly type: Schema.tag<"input_image">;
+        readonly image_url: Schema.String;
+    }>, Schema.Struct<{
+        readonly type: Schema.tag<"input_file">;
+        readonly filename: Schema.String;
+        readonly file_data: Schema.String;
+        readonly mime_type: Schema.optional<Schema.String>;
+    }>]>]>>;
+}>, Schema.Struct<{
+    readonly role: Schema.tag<"assistant">;
+    readonly content: Schema.$Array<Schema.Struct<{
+        readonly type: Schema.tag<"output_text">;
+        readonly text: Schema.String;
+    }>>;
+    readonly phase: Schema.optionalKey<Schema.Literals<readonly ["commentary", "final_answer"]>>;
+}>, Schema.Struct<{
+    readonly type: Schema.tag<"reasoning">;
+    readonly id: Schema.optionalKey<Schema.String>;
+    readonly summary: Schema.$Array<Schema.Struct<{
+        readonly type: Schema.tag<"summary_text">;
+        readonly text: Schema.String;
+    }>>;
+    readonly encrypted_content: Schema.optional<Schema.NullOr<Schema.String>>;
+}>, Schema.Struct<{
+    readonly type: Schema.tag<"item_reference">;
+    readonly id: Schema.String;
+}>, Schema.Struct<{
+    readonly type: Schema.tag<"function_call">;
+    readonly call_id: Schema.String;
+    readonly name: Schema.String;
+    readonly arguments: Schema.String;
+}>, Schema.Struct<{
+    readonly type: Schema.tag<"function_call_output">;
+    readonly call_id: Schema.String;
+    readonly output: Schema.Union<readonly [Schema.String, Schema.$Array<Schema.Union<readonly [Schema.Struct<{
+        readonly type: Schema.tag<"input_text">;
+        readonly text: Schema.String;
+    }>, Schema.Struct<{
+        readonly type: Schema.tag<"input_image">;
+        readonly image_url: Schema.String;
+    }>, Schema.Struct<{
+        readonly type: Schema.tag<"input_file">;
+        readonly filename: Schema.String;
+        readonly file_data: Schema.String;
+        readonly mime_type: Schema.optional<Schema.String>;
+    }>]>>]>;
+}>]>;
+type OpenResponsesInputItem = Schema.Schema.Type<typeof InputItem>;
+type LoweredInputItem = OpenResponsesInputItem | {
+    readonly role: "assistant";
+    readonly content: ReadonlyArray<{
+        readonly type: "output_text";
+        readonly text: string;
+    }>;
+    readonly phase?: MessagePhase | null;
+};
 export declare const Tool: Schema.Struct<{
     readonly type: Schema.tag<"function">;
     readonly name: Schema.String;
@@ -52,6 +119,7 @@ export declare const coreFields: {
             readonly type: Schema.tag<"output_text">;
             readonly text: Schema.String;
         }>>;
+        readonly phase: Schema.optionalKey<Schema.Literals<readonly ["commentary", "final_answer"]>>;
     }>, Schema.Struct<{
         readonly type: Schema.tag<"reasoning">;
         readonly id: Schema.optionalKey<Schema.String>;
@@ -137,6 +205,7 @@ declare const OpenResponsesBody: Schema.Struct<{
             readonly type: Schema.tag<"output_text">;
             readonly text: Schema.String;
         }>>;
+        readonly phase: Schema.optionalKey<Schema.Literals<readonly ["commentary", "final_answer"]>>;
     }>, Schema.Struct<{
         readonly type: Schema.tag<"reasoning">;
         readonly id: Schema.optionalKey<Schema.String>;
@@ -209,6 +278,7 @@ export type StreamItem = Schema.Schema.Type<typeof StreamItem>;
 export declare const Event: Schema.StructWithRest<Schema.Struct<{
     readonly type: Schema.String;
     readonly delta: Schema.optional<Schema.String>;
+    readonly text: Schema.optional<Schema.String>;
     readonly item_id: Schema.optional<Schema.String>;
     readonly summary_index: Schema.optional<Schema.Number>;
     readonly item: Schema.optional<Schema.StructWithRest<Schema.Struct<{
@@ -261,6 +331,7 @@ export interface Extension {
         readonly media: ProviderShared.ValidatedMedia;
         readonly request: LLMRequest;
     }) => MediaInput | undefined;
+    readonly messagePhase?: (value: unknown) => MessagePhase | null | undefined;
 }
 export interface ParserState {
     readonly id: string;
@@ -269,6 +340,9 @@ export interface ParserState {
     readonly tools: ToolStream.State<string>;
     readonly hasFunctionCall: boolean;
     readonly lifecycle: Lifecycle.State;
+    readonly messageItems: ReadonlySet<string>;
+    readonly messagePhase: (value: unknown) => MessagePhase | null | undefined;
+    readonly messagePhases: Readonly<Record<string, MessagePhase | null>>;
     readonly reasoningItems: Readonly<Record<string, ReasoningStreamItem>>;
     readonly store: boolean | undefined;
 }
@@ -292,7 +366,7 @@ export declare const lowerToolChoice: (protocolName: string, toolChoice: NonNull
     type: "function";
     name: string;
 }, LLMError, never>;
-export declare const fromRequest: (request: LLMRequest, extension?: Extension | undefined) => Effect.Effect<{
+export declare const fromRequestWithExtension: (request: LLMRequest, extension: Extension) => Effect.Effect<{
     service_tier?: "auto" | "default" | "flex" | "priority" | undefined;
     text?: {
         verbosity: "low" | "medium" | "high";
@@ -306,7 +380,27 @@ export declare const fromRequest: (request: LLMRequest, extension?: Extension |
     store?: boolean | undefined;
     instructions?: string | undefined;
     model: string & import("effect/Brand").Brand<"LLM.ModelID">;
-    input: ({
+    input: LoweredInputItem[];
+    tools: {
+        type: "function";
+        name: string;
+        description: string;
+        parameters: {
+            readonly [x: string]: unknown;
+        };
+        strict: boolean;
+    }[] | undefined;
+    tool_choice: "required" | "none" | "auto" | {
+        type: "function";
+        name: string;
+    } | undefined;
+    stream: true;
+    max_output_tokens: number | undefined;
+    temperature: number | undefined;
+    top_p: number | undefined;
+}, LLMError, never>;
+export declare const fromRequest: (request: LLMRequest) => Effect.Effect<{
+    readonly input: readonly ({
         readonly type: "reasoning";
         readonly summary: readonly Schema.Struct.ReadonlySide<{
             readonly type: Schema.tag<"summary_text">;
@@ -334,13 +428,14 @@ export declare const fromRequest: (request: LLMRequest, extension?: Extension |
             readonly file_data: Schema.String;
             readonly mime_type: Schema.optional<Schema.String>;
         }>]>]>>;
-    }, "Type"> | Schema.Struct.ReadonlySide<{
-        readonly role: Schema.tag<"assistant">;
-        readonly content: Schema.$Array<Schema.Struct<{
+    }, "Type"> | {
+        readonly content: readonly Schema.Struct.ReadonlySide<{
             readonly type: Schema.tag<"output_text">;
             readonly text: Schema.String;
-        }>>;
-    }, "Type"> | Schema.Struct.ReadonlySide<{
+        }, "Type">[];
+        readonly role: "assistant";
+        readonly phase?: "commentary" | "final_answer" | undefined;
+    } | Schema.Struct.ReadonlySide<{
         readonly type: Schema.tag<"function_call">;
         readonly call_id: Schema.String;
         readonly name: Schema.String;
@@ -361,30 +456,224 @@ export declare const fromRequest: (request: LLMRequest, extension?: Extension |
             readonly mime_type: Schema.optional<Schema.String>;
         }>]>>]>;
     }, "Type">)[];
-    tools: {
-        type: "function";
-        name: string;
-        description: string;
-        parameters: {
+    readonly model: string;
+    readonly stream: true;
+    readonly text?: {
+        readonly verbosity?: "low" | "medium" | "high" | undefined;
+    } | undefined;
+    readonly reasoning?: {
+        readonly effort?: string | undefined;
+        readonly summary?: "auto" | "concise" | "detailed" | undefined;
+    } | undefined;
+    readonly tools?: readonly {
+        readonly type: "function";
+        readonly name: string;
+        readonly description: string;
+        readonly parameters: {
             readonly [x: string]: unknown;
         };
-        strict: boolean;
+        readonly strict?: boolean | undefined;
     }[] | undefined;
-    tool_choice: "required" | "none" | "auto" | {
-        type: "function";
-        name: string;
-    } | undefined;
-    stream: true;
-    max_output_tokens: number | undefined;
-    temperature: number | undefined;
-    top_p: number | undefined;
+    readonly temperature?: number | undefined;
+    readonly tool_choice?: "required" | "none" | "auto" | Schema.Struct.ReadonlySide<{
+        readonly type: Schema.tag<"function">;
+        readonly name: Schema.String;
+    }, "Type"> | undefined;
+    readonly top_p?: number | undefined;
+    readonly include?: readonly ("file_search_call.results" | "web_search_call.results" | "web_search_call.action.sources" | "message.input_image.image_url" | "computer_call_output.output.image_url" | "code_interpreter_call.outputs" | "reasoning.encrypted_content" | "message.output_text.logprobs")[] | undefined;
+    readonly instructions?: string | undefined;
+    readonly store?: boolean | undefined;
+    readonly service_tier?: "auto" | "default" | "flex" | "priority" | undefined;
+    readonly prompt_cache_key?: string | undefined;
+    readonly max_output_tokens?: number | undefined;
 }, LLMError, never>;
 export declare const providerMetadata: (state: ParserState, metadata: Record<string, unknown>) => ProviderMetadata;
 export type StepResult = readonly [ParserState, ReadonlyArray<LLMEvent>];
 export declare const terminal: (event: Event) => boolean;
-export declare const onReasoningDelta: (state: ParserState, event: Event) => StepResult;
+export declare const onReasoningDelta: (state: ParserState, event: Event, itemID: string) => StepResult;
 export declare const onReasoningDone: (state: ParserState, _event: Event) => StepResult;
-export declare const step: (state: ParserState, event: Event) => LLMError | Effect.Effect<StepResult, LLMError, never>;
+export declare const step: (state: ParserState, event: Event) => LLMError | Effect.Effect<StepResult, never, never> | Effect.Effect<[ParserState, readonly (Schema.Struct.ReadonlySide<{
+    readonly type: Schema.tag<"step-start">;
+    readonly index: Schema.Number;
+}, "Type"> | {
+    readonly type: "text-start";
+    readonly id: string;
+    readonly providerMetadata?: {
+        readonly [x: string]: {
+            readonly [x: string]: unknown;
+        };
+    } | undefined;
+} | {
+    readonly type: "text-delta";
+    readonly text: string;
+    readonly id: string;
+    readonly providerMetadata?: {
+        readonly [x: string]: {
+            readonly [x: string]: unknown;
+        };
+    } | undefined;
+} | {
+    readonly type: "text-end";
+    readonly id: string;
+    readonly providerMetadata?: {
+        readonly [x: string]: {
+            readonly [x: string]: unknown;
+        };
+    } | undefined;
+} | {
+    readonly type: "reasoning-start";
+    readonly id: string;
+    readonly providerMetadata?: {
+        readonly [x: string]: {
+            readonly [x: string]: unknown;
+        };
+    } | undefined;
+} | {
+    readonly type: "reasoning-delta";
+    readonly text: string;
+    readonly id: string;
+    readonly providerMetadata?: {
+        readonly [x: string]: {
+            readonly [x: string]: unknown;
+        };
+    } | undefined;
+} | {
+    readonly type: "reasoning-end";
+    readonly id: string;
+    readonly providerMetadata?: {
+        readonly [x: string]: {
+            readonly [x: string]: unknown;
+        };
+    } | undefined;
+} | {
+    readonly type: "tool-input-start";
+    readonly name: string;
+    readonly id: string;
+    readonly providerMetadata?: {
+        readonly [x: string]: {
+            readonly [x: string]: unknown;
+        };
+    } | undefined;
+    readonly providerExecuted?: boolean | undefined;
+} | Schema.Struct.ReadonlySide<{
+    readonly type: Schema.tag<"tool-input-delta">;
+    readonly id: Schema.String;
+    readonly name: Schema.String;
+    readonly text: Schema.String;
+}, "Type"> | {
+    readonly type: "tool-input-end";
+    readonly name: string;
+    readonly id: string;
+    readonly providerMetadata?: {
+        readonly [x: string]: {
+            readonly [x: string]: unknown;
+        };
+    } | undefined;
+} | Schema.Struct.ReadonlySide<{
+    readonly type: Schema.tag<"tool-input-error">;
+    readonly id: Schema.String;
+    readonly name: Schema.String;
+    readonly raw: Schema.String;
+}, "Type"> | {
+    readonly type: "tool-call";
+    readonly name: string;
+    readonly id: string;
+    readonly input: unknown;
+    readonly providerMetadata?: {
+        readonly [x: string]: {
+            readonly [x: string]: unknown;
+        };
+    } | undefined;
+    readonly providerExecuted?: boolean | undefined;
+} | {
+    readonly type: "tool-result";
+    readonly name: string;
+    readonly id: string;
+    readonly result: Schema.Struct.ReadonlySide<{
+        readonly type: Schema.Literal<"json">;
+        readonly value: Schema.Unknown;
+    }, "Type"> | Schema.Struct.ReadonlySide<{
+        readonly type: Schema.Literal<"text">;
+        readonly value: Schema.Unknown;
+    }, "Type"> | Schema.Struct.ReadonlySide<{
+        readonly type: Schema.Literal<"error">;
+        readonly value: Schema.Unknown;
+    }, "Type"> | Schema.Struct.ReadonlySide<{
+        readonly type: Schema.Literal<"content">;
+        readonly value: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
+            readonly type: Schema.Literal<"text">;
+            readonly text: Schema.String;
+        }>, Schema.Struct<{
+            readonly type: Schema.Literal<"file">;
+            readonly uri: Schema.String;
+            readonly mime: Schema.String;
+            readonly name: Schema.decodeTo<Schema.optional<Schema.toType<Schema.String>>, Schema.optionalKey<Schema.String>, never, never>;
+        }>]>>;
+    }, "Type">;
+    readonly providerMetadata?: {
+        readonly [x: string]: {
+            readonly [x: string]: unknown;
+        };
+    } | undefined;
+    readonly providerExecuted?: boolean | undefined;
+    readonly output?: Schema.Struct.ReadonlySide<{
+        readonly structured: Schema.Unknown;
+        readonly content: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
+            readonly type: Schema.Literal<"text">;
+            readonly text: Schema.String;
+        }>, Schema.Struct<{
+            readonly type: Schema.Literal<"file">;
+            readonly uri: Schema.String;
+            readonly mime: Schema.String;
+            readonly name: Schema.decodeTo<Schema.optional<Schema.toType<Schema.String>>, Schema.optionalKey<Schema.String>, never, never>;
+        }>]>>;
+    }, "Type"> | undefined;
+} | {
+    readonly type: "tool-error";
+    readonly name: string;
+    readonly id: string;
+    readonly message: string;
+    readonly error?: unknown;
+    readonly providerMetadata?: {
+        readonly [x: string]: {
+            readonly [x: string]: unknown;
+        };
+    } | undefined;
+} | {
+    readonly type: "step-finish";
+    readonly reason: {
+        readonly normalized: "length" | "stop" | "tool-calls" | "content-filter" | "error" | "unknown";
+        readonly raw?: string | undefined;
+    };
+    readonly index: number;
+    readonly providerMetadata?: {
+        readonly [x: string]: {
+            readonly [x: string]: unknown;
+        };
+    } | undefined;
+    readonly usage?: Usage | undefined;
+} | {
+    readonly type: "finish";
+    readonly reason: {
+        readonly normalized: "length" | "stop" | "tool-calls" | "content-filter" | "error" | "unknown";
+        readonly raw?: string | undefined;
+    };
+    readonly providerMetadata?: {
+        readonly [x: string]: {
+            readonly [x: string]: unknown;
+        };
+    } | undefined;
+    readonly usage?: Usage | undefined;
+} | {
+    readonly type: "provider-error";
+    readonly message: string;
+    readonly providerMetadata?: {
+        readonly [x: string]: {
+            readonly [x: string]: unknown;
+        };
+    } | undefined;
+    readonly classification?: "context-overflow" | undefined;
+})[]], LLMError, never>;
 /**
  * The provider-neutral Open Responses protocol. Provider-specific Responses
  * implementations compose this baseline with their own tools and event variants.
@@ -419,13 +708,14 @@ export declare const protocol: Protocol<{
             readonly file_data: Schema.String;
             readonly mime_type: Schema.optional<Schema.String>;
         }>]>]>>;
-    }, "Type"> | Schema.Struct.ReadonlySide<{
-        readonly role: Schema.tag<"assistant">;
-        readonly content: Schema.$Array<Schema.Struct<{
+    }, "Type"> | {
+        readonly content: readonly Schema.Struct.ReadonlySide<{
             readonly type: Schema.tag<"output_text">;
             readonly text: Schema.String;
-        }>>;
-    }, "Type"> | Schema.Struct.ReadonlySide<{
+        }, "Type">[];
+        readonly role: "assistant";
+        readonly phase?: "commentary" | "final_answer" | undefined;
+    } | Schema.Struct.ReadonlySide<{
         readonly type: Schema.tag<"function_call">;
         readonly call_id: Schema.String;
         readonly name: Schema.String;
@@ -484,6 +774,7 @@ export declare const protocol: Protocol<{
         readonly code?: string | null | undefined;
         readonly param?: string | null | undefined;
     } | null | undefined;
+    readonly text?: string | undefined;
     readonly response?: {
         readonly [x: string]: unknown;
         readonly error?: {
@@ -554,13 +845,14 @@ export declare const httpTransport: HttpTransport.HttpJsonTransport<{
             readonly file_data: Schema.String;
             readonly mime_type: Schema.optional<Schema.String>;
         }>]>]>>;
-    }, "Type"> | Schema.Struct.ReadonlySide<{
-        readonly role: Schema.tag<"assistant">;
-        readonly content: Schema.$Array<Schema.Struct<{
+    }, "Type"> | {
+        readonly content: readonly Schema.Struct.ReadonlySide<{
             readonly type: Schema.tag<"output_text">;
             readonly text: Schema.String;
-        }>>;
-    }, "Type"> | Schema.Struct.ReadonlySide<{
+        }, "Type">[];
+        readonly role: "assistant";
+        readonly phase?: "commentary" | "final_answer" | undefined;
+    } | Schema.Struct.ReadonlySide<{
         readonly type: Schema.tag<"function_call">;
         readonly call_id: Schema.String;
         readonly name: Schema.String;