@opencode/ai 2.0.31 → 2.1.0

package/dist/protocols/utils/tool-stream.d.ts

@@ -76,32 +76,20 @@ export declare const finish: <K extends StreamKey>(route: string, tools: State<K
     events?: undefined;
 } | {
     tools: Partial<Record<K, PendingTool>>;
-    events: readonly (({
-        readonly type: "compaction";
-        readonly provider: string & import("effect/Brand").Brand<"AI.ProviderID">;
-        readonly id?: string | undefined;
-        readonly text?: string | null | undefined;
-        readonly encrypted?: string | undefined;
-    } & ({
-        readonly encrypted: string;
-        readonly text?: never;
-    } | {
-        readonly text: string | null;
-        readonly encrypted?: never;
-    })) | {
+    events: readonly ({
         readonly type: "step-start";
         readonly index: number;
     } | {
-        readonly id: string;
         readonly type: "text-start";
+        readonly id: string;
         readonly providerMetadata?: {
             readonly [x: string]: {
                 readonly [x: string]: unknown;
             };
         } | undefined;
     } | {
-        readonly id: string;
         readonly type: "text-delta";
+        readonly id: string;
         readonly text: string;
         readonly providerMetadata?: {
             readonly [x: string]: {
@@ -109,8 +97,8 @@ export declare const finish: <K extends StreamKey>(route: string, tools: State<K
             };
         } | undefined;
     } | {
-        readonly id: string;
         readonly type: "text-end";
+        readonly id: string;
         readonly text?: string | undefined;
         readonly providerMetadata?: {
             readonly [x: string]: {
@@ -118,16 +106,16 @@ export declare const finish: <K extends StreamKey>(route: string, tools: State<K
             };
         } | undefined;
     } | {
-        readonly id: string;
         readonly type: "reasoning-start";
+        readonly id: string;
         readonly providerMetadata?: {
             readonly [x: string]: {
                 readonly [x: string]: unknown;
             };
         } | undefined;
     } | {
-        readonly id: string;
         readonly type: "reasoning-delta";
+        readonly id: string;
         readonly text: string;
         readonly providerMetadata?: {
             readonly [x: string]: {
@@ -135,8 +123,8 @@ export declare const finish: <K extends StreamKey>(route: string, tools: State<K
             };
         } | undefined;
     } | {
-        readonly id: string;
         readonly type: "reasoning-end";
+        readonly id: string;
         readonly text?: string | undefined;
         readonly providerMetadata?: {
             readonly [x: string]: {
@@ -144,55 +132,56 @@ export declare const finish: <K extends StreamKey>(route: string, tools: State<K
             };
         } | undefined;
     } | {
-        readonly id: string;
         readonly type: "tool-input-start";
+        readonly id: string;
         readonly name: string;
+        readonly namespace?: string | undefined;
+        readonly providerExecuted?: boolean | undefined;
         readonly providerMetadata?: {
             readonly [x: string]: {
                 readonly [x: string]: unknown;
             };
         } | undefined;
-        readonly namespace?: string | undefined;
-        readonly providerExecuted?: boolean | undefined;
     } | {
-        readonly id: string;
         readonly type: "tool-input-delta";
+        readonly id: string;
         readonly name: string;
+        readonly namespace?: string | undefined;
         readonly text: string;
         readonly input?: unknown;
-        readonly namespace?: string | undefined;
     } | {
-        readonly id: string;
         readonly type: "tool-input-end";
+        readonly id: string;
         readonly name: string;
+        readonly namespace?: string | undefined;
         readonly providerMetadata?: {
             readonly [x: string]: {
                 readonly [x: string]: unknown;
             };
         } | undefined;
-        readonly namespace?: string | undefined;
     } | {
-        readonly id: string;
         readonly type: "tool-input-error";
+        readonly id: string;
         readonly name: string;
-        readonly raw: string;
         readonly namespace?: string | undefined;
+        readonly raw: string;
     } | {
-        readonly id: string;
         readonly type: "tool-call";
+        readonly id: string;
         readonly name: string;
+        readonly namespace?: string | undefined;
         readonly input: unknown;
+        readonly providerExecuted?: boolean | undefined;
         readonly providerMetadata?: {
             readonly [x: string]: {
                 readonly [x: string]: unknown;
             };
         } | undefined;
-        readonly namespace?: string | undefined;
-        readonly providerExecuted?: boolean | undefined;
     } | {
-        readonly id: string;
         readonly type: "tool-result";
+        readonly id: string;
         readonly name: string;
+        readonly namespace?: string | undefined;
         readonly result: {
             readonly type: "json";
             readonly value: unknown;
@@ -226,28 +215,19 @@ export declare const finish: <K extends StreamKey>(route: string, tools: State<K
                 readonly name?: string | undefined;
             })[];
         } | undefined;
+        readonly providerExecuted?: boolean | undefined;
         readonly providerMetadata?: {
             readonly [x: string]: {
                 readonly [x: string]: unknown;
             };
         } | undefined;
-        readonly namespace?: string | undefined;
-        readonly providerExecuted?: boolean | undefined;
     } | {
-        readonly id: string;
         readonly type: "tool-error";
-        readonly message: string;
+        readonly id: string;
         readonly name: string;
-        readonly error?: unknown;
-        readonly providerMetadata?: {
-            readonly [x: string]: {
-                readonly [x: string]: unknown;
-            };
-        } | undefined;
         readonly namespace?: string | undefined;
-    } | {
-        readonly type: "media";
-        readonly media: import("../../media.js").Asset;
+        readonly message: string;
+        readonly error?: unknown;
         readonly providerMetadata?: {
             readonly [x: string]: {
                 readonly [x: string]: unknown;
@@ -255,33 +235,41 @@ export declare const finish: <K extends StreamKey>(route: string, tools: State<K
         } | undefined;
     } | {
         readonly type: "step-finish";
+        readonly index: number;
         readonly reason: {
-            readonly normalized: "length" | "stop" | "tool-calls" | "content-filter" | "error" | "unknown";
+            readonly normalized: "content-filter" | "error" | "length" | "stop" | "tool-calls" | "unknown";
             readonly raw?: string | undefined;
             readonly category?: string | undefined;
             readonly explanation?: string | undefined;
         };
-        readonly index: number;
+        readonly usage?: import("../../schema/events.js").Usage | undefined;
         readonly providerMetadata?: {
             readonly [x: string]: {
                 readonly [x: string]: unknown;
             };
         } | undefined;
-        readonly usage?: import("../../schema/events.js").Usage | undefined;
     } | {
         readonly type: "finish";
         readonly reason: {
-            readonly normalized: "length" | "stop" | "tool-calls" | "content-filter" | "error" | "unknown";
+            readonly normalized: "content-filter" | "error" | "length" | "stop" | "tool-calls" | "unknown";
             readonly raw?: string | undefined;
             readonly category?: string | undefined;
             readonly explanation?: string | undefined;
         };
+        readonly usage?: import("../../schema/events.js").Usage | undefined;
+        readonly providerMetadata?: {
+            readonly [x: string]: {
+                readonly [x: string]: unknown;
+            };
+        } | undefined;
+    } | {
+        readonly type: "media";
+        readonly media: import("../../media.js").Asset;
         readonly providerMetadata?: {
             readonly [x: string]: {
                 readonly [x: string]: unknown;
             };
         } | undefined;
-        readonly usage?: import("../../schema/events.js").Usage | undefined;
     } | {
         readonly type: "provider-error";
         readonly message: string;
@@ -291,44 +279,44 @@ export declare const finish: <K extends StreamKey>(route: string, tools: State<K
                 readonly [x: string]: unknown;
             };
         } | undefined;
-    })[];
-}, AIError, never>;
-/**
- * Finalize one pending tool call with an authoritative final input string.
- * OpenAI Responses can send accumulated deltas and then repeat the completed
- * arguments on `response.output_item.done`; the final value wins.
- */
-export declare const finishWithInput: <K extends StreamKey>(route: string, tools: State<K>, key: K, input: string) => Effect.Effect<{
-    tools: Partial<Record<K, PendingTool>>;
-    events?: undefined;
-} | {
-    tools: Partial<Record<K, PendingTool>>;
-    events: readonly (({
+    } | ({
         readonly type: "compaction";
         readonly provider: string & import("effect/Brand").Brand<"AI.ProviderID">;
         readonly id?: string | undefined;
-        readonly text?: string | null | undefined;
         readonly encrypted?: string | undefined;
+        readonly text?: string | null | undefined;
     } & ({
         readonly encrypted: string;
         readonly text?: never;
     } | {
         readonly text: string | null;
         readonly encrypted?: never;
-    })) | {
+    })))[];
+}, AIError, never>;
+/**
+ * Finalize one pending tool call with an authoritative final input string.
+ * OpenAI Responses can send accumulated deltas and then repeat the completed
+ * arguments on `response.output_item.done`; the final value wins.
+ */
+export declare const finishWithInput: <K extends StreamKey>(route: string, tools: State<K>, key: K, input: string) => Effect.Effect<{
+    events?: undefined;
+    tools: Partial<Record<K, PendingTool>>;
+} | {
+    tools: Partial<Record<K, PendingTool>>;
+    events: readonly ({
         readonly type: "step-start";
         readonly index: number;
     } | {
-        readonly id: string;
         readonly type: "text-start";
+        readonly id: string;
         readonly providerMetadata?: {
             readonly [x: string]: {
                 readonly [x: string]: unknown;
             };
         } | undefined;
     } | {
-        readonly id: string;
         readonly type: "text-delta";
+        readonly id: string;
         readonly text: string;
         readonly providerMetadata?: {
             readonly [x: string]: {
@@ -336,8 +324,8 @@ export declare const finishWithInput: <K extends StreamKey>(route: string, tools
             };
         } | undefined;
     } | {
-        readonly id: string;
         readonly type: "text-end";
+        readonly id: string;
         readonly text?: string | undefined;
         readonly providerMetadata?: {
             readonly [x: string]: {
@@ -345,16 +333,16 @@ export declare const finishWithInput: <K extends StreamKey>(route: string, tools
             };
         } | undefined;
     } | {
-        readonly id: string;
         readonly type: "reasoning-start";
+        readonly id: string;
         readonly providerMetadata?: {
             readonly [x: string]: {
                 readonly [x: string]: unknown;
             };
         } | undefined;
     } | {
-        readonly id: string;
         readonly type: "reasoning-delta";
+        readonly id: string;
         readonly text: string;
         readonly providerMetadata?: {
             readonly [x: string]: {
@@ -362,8 +350,8 @@ export declare const finishWithInput: <K extends StreamKey>(route: string, tools
             };
         } | undefined;
     } | {
-        readonly id: string;
         readonly type: "reasoning-end";
+        readonly id: string;
         readonly text?: string | undefined;
         readonly providerMetadata?: {
             readonly [x: string]: {
@@ -371,55 +359,56 @@ export declare const finishWithInput: <K extends StreamKey>(route: string, tools
             };
         } | undefined;
     } | {
-        readonly id: string;
         readonly type: "tool-input-start";
+        readonly id: string;
         readonly name: string;
+        readonly namespace?: string | undefined;
+        readonly providerExecuted?: boolean | undefined;
         readonly providerMetadata?: {
             readonly [x: string]: {
                 readonly [x: string]: unknown;
             };
         } | undefined;
-        readonly namespace?: string | undefined;
-        readonly providerExecuted?: boolean | undefined;
     } | {
-        readonly id: string;
         readonly type: "tool-input-delta";
+        readonly id: string;
         readonly name: string;
+        readonly namespace?: string | undefined;
         readonly text: string;
         readonly input?: unknown;
-        readonly namespace?: string | undefined;
     } | {
-        readonly id: string;
         readonly type: "tool-input-end";
+        readonly id: string;
         readonly name: string;
+        readonly namespace?: string | undefined;
         readonly providerMetadata?: {
             readonly [x: string]: {
                 readonly [x: string]: unknown;
             };
         } | undefined;
-        readonly namespace?: string | undefined;
     } | {
-        readonly id: string;
         readonly type: "tool-input-error";
+        readonly id: string;
         readonly name: string;
-        readonly raw: string;
         readonly namespace?: string | undefined;
+        readonly raw: string;
     } | {
-        readonly id: string;
         readonly type: "tool-call";
+        readonly id: string;
         readonly name: string;
+        readonly namespace?: string | undefined;
         readonly input: unknown;
+        readonly providerExecuted?: boolean | undefined;
         readonly providerMetadata?: {
             readonly [x: string]: {
                 readonly [x: string]: unknown;
             };
         } | undefined;
-        readonly namespace?: string | undefined;
-        readonly providerExecuted?: boolean | undefined;
     } | {
-        readonly id: string;
         readonly type: "tool-result";
+        readonly id: string;
         readonly name: string;
+        readonly namespace?: string | undefined;
         readonly result: {
             readonly type: "json";
             readonly value: unknown;
@@ -453,28 +442,19 @@ export declare const finishWithInput: <K extends StreamKey>(route: string, tools
                 readonly name?: string | undefined;
             })[];
         } | undefined;
+        readonly providerExecuted?: boolean | undefined;
         readonly providerMetadata?: {
             readonly [x: string]: {
                 readonly [x: string]: unknown;
             };
         } | undefined;
-        readonly namespace?: string | undefined;
-        readonly providerExecuted?: boolean | undefined;
     } | {
-        readonly id: string;
         readonly type: "tool-error";
-        readonly message: string;
+        readonly id: string;
         readonly name: string;
-        readonly error?: unknown;
-        readonly providerMetadata?: {
-            readonly [x: string]: {
-                readonly [x: string]: unknown;
-            };
-        } | undefined;
         readonly namespace?: string | undefined;
-    } | {
-        readonly type: "media";
-        readonly media: import("../../media.js").Asset;
+        readonly message: string;
+        readonly error?: unknown;
         readonly providerMetadata?: {
             readonly [x: string]: {
                 readonly [x: string]: unknown;
@@ -482,33 +462,41 @@ export declare const finishWithInput: <K extends StreamKey>(route: string, tools
         } | undefined;
     } | {
         readonly type: "step-finish";
+        readonly index: number;
         readonly reason: {
-            readonly normalized: "length" | "stop" | "tool-calls" | "content-filter" | "error" | "unknown";
+            readonly normalized: "content-filter" | "error" | "length" | "stop" | "tool-calls" | "unknown";
             readonly raw?: string | undefined;
             readonly category?: string | undefined;
             readonly explanation?: string | undefined;
         };
-        readonly index: number;
+        readonly usage?: import("../../schema/events.js").Usage | undefined;
         readonly providerMetadata?: {
             readonly [x: string]: {
                 readonly [x: string]: unknown;
             };
         } | undefined;
-        readonly usage?: import("../../schema/events.js").Usage | undefined;
     } | {
         readonly type: "finish";
         readonly reason: {
-            readonly normalized: "length" | "stop" | "tool-calls" | "content-filter" | "error" | "unknown";
+            readonly normalized: "content-filter" | "error" | "length" | "stop" | "tool-calls" | "unknown";
             readonly raw?: string | undefined;
             readonly category?: string | undefined;
             readonly explanation?: string | undefined;
         };
+        readonly usage?: import("../../schema/events.js").Usage | undefined;
+        readonly providerMetadata?: {
+            readonly [x: string]: {
+                readonly [x: string]: unknown;
+            };
+        } | undefined;
+    } | {
+        readonly type: "media";
+        readonly media: import("../../media.js").Asset;
         readonly providerMetadata?: {
             readonly [x: string]: {
                 readonly [x: string]: unknown;
             };
         } | undefined;
-        readonly usage?: import("../../schema/events.js").Usage | undefined;
     } | {
         readonly type: "provider-error";
         readonly message: string;
@@ -518,41 +506,41 @@ export declare const finishWithInput: <K extends StreamKey>(route: string, tools
                 readonly [x: string]: unknown;
             };
         } | undefined;
-    })[];
-}, AIError, never>;
-/**
- * Finalize every pending tool call at once. OpenAI Chat has this shape: it does
- * not emit per-tool stop events, so all accumulated calls finish independently
- * when the choice receives a terminal `finish_reason`.
- */
-export declare const finishAll: <K extends StreamKey>(route: string, tools: State<K>) => Effect.Effect<{
-    tools: Partial<Record<K, PendingTool>>;
-    events: (({
+    } | ({
         readonly type: "compaction";
         readonly provider: string & import("effect/Brand").Brand<"AI.ProviderID">;
         readonly id?: string | undefined;
-        readonly text?: string | null | undefined;
         readonly encrypted?: string | undefined;
+        readonly text?: string | null | undefined;
     } & ({
         readonly encrypted: string;
         readonly text?: never;
     } | {
         readonly text: string | null;
         readonly encrypted?: never;
-    })) | {
+    })))[];
+}, AIError, never>;
+/**
+ * Finalize every pending tool call at once. OpenAI Chat has this shape: it does
+ * not emit per-tool stop events, so all accumulated calls finish independently
+ * when the choice receives a terminal `finish_reason`.
+ */
+export declare const finishAll: <K extends StreamKey>(route: string, tools: State<K>) => Effect.Effect<{
+    tools: Partial<Record<K, PendingTool>>;
+    events: ({
         readonly type: "step-start";
         readonly index: number;
     } | {
-        readonly id: string;
         readonly type: "text-start";
+        readonly id: string;
         readonly providerMetadata?: {
             readonly [x: string]: {
                 readonly [x: string]: unknown;
             };
         } | undefined;
     } | {
-        readonly id: string;
         readonly type: "text-delta";
+        readonly id: string;
         readonly text: string;
         readonly providerMetadata?: {
             readonly [x: string]: {
@@ -560,8 +548,8 @@ export declare const finishAll: <K extends StreamKey>(route: string, tools: Stat
             };
         } | undefined;
     } | {
-        readonly id: string;
         readonly type: "text-end";
+        readonly id: string;
         readonly text?: string | undefined;
         readonly providerMetadata?: {
             readonly [x: string]: {
@@ -569,16 +557,16 @@ export declare const finishAll: <K extends StreamKey>(route: string, tools: Stat
             };
         } | undefined;
     } | {
-        readonly id: string;
         readonly type: "reasoning-start";
+        readonly id: string;
         readonly providerMetadata?: {
             readonly [x: string]: {
                 readonly [x: string]: unknown;
             };
         } | undefined;
     } | {
-        readonly id: string;
         readonly type: "reasoning-delta";
+        readonly id: string;
         readonly text: string;
         readonly providerMetadata?: {
             readonly [x: string]: {
@@ -586,8 +574,8 @@ export declare const finishAll: <K extends StreamKey>(route: string, tools: Stat
             };
         } | undefined;
     } | {
-        readonly id: string;
         readonly type: "reasoning-end";
+        readonly id: string;
         readonly text?: string | undefined;
         readonly providerMetadata?: {
             readonly [x: string]: {
@@ -595,55 +583,56 @@ export declare const finishAll: <K extends StreamKey>(route: string, tools: Stat
             };
         } | undefined;
     } | {
-        readonly id: string;
         readonly type: "tool-input-start";
+        readonly id: string;
         readonly name: string;
+        readonly namespace?: string | undefined;
+        readonly providerExecuted?: boolean | undefined;
         readonly providerMetadata?: {
             readonly [x: string]: {
                 readonly [x: string]: unknown;
             };
         } | undefined;
-        readonly namespace?: string | undefined;
-        readonly providerExecuted?: boolean | undefined;
     } | {
-        readonly id: string;
         readonly type: "tool-input-delta";
+        readonly id: string;
         readonly name: string;
+        readonly namespace?: string | undefined;
         readonly text: string;
         readonly input?: unknown;
-        readonly namespace?: string | undefined;
     } | {
-        readonly id: string;
         readonly type: "tool-input-end";
+        readonly id: string;
         readonly name: string;
+        readonly namespace?: string | undefined;
         readonly providerMetadata?: {
             readonly [x: string]: {
                 readonly [x: string]: unknown;
             };
         } | undefined;
-        readonly namespace?: string | undefined;
     } | {
-        readonly id: string;
         readonly type: "tool-input-error";
+        readonly id: string;
         readonly name: string;
-        readonly raw: string;
         readonly namespace?: string | undefined;
+        readonly raw: string;
     } | {
-        readonly id: string;
         readonly type: "tool-call";
+        readonly id: string;
         readonly name: string;
+        readonly namespace?: string | undefined;
         readonly input: unknown;
+        readonly providerExecuted?: boolean | undefined;
         readonly providerMetadata?: {
             readonly [x: string]: {
                 readonly [x: string]: unknown;
             };
         } | undefined;
-        readonly namespace?: string | undefined;
-        readonly providerExecuted?: boolean | undefined;
     } | {
-        readonly id: string;
         readonly type: "tool-result";
+        readonly id: string;
         readonly name: string;
+        readonly namespace?: string | undefined;
         readonly result: {
             readonly type: "json";
             readonly value: unknown;
@@ -677,28 +666,19 @@ export declare const finishAll: <K extends StreamKey>(route: string, tools: Stat
                 readonly name?: string | undefined;
             })[];
         } | undefined;
+        readonly providerExecuted?: boolean | undefined;
         readonly providerMetadata?: {
             readonly [x: string]: {
                 readonly [x: string]: unknown;
             };
         } | undefined;
-        readonly namespace?: string | undefined;
-        readonly providerExecuted?: boolean | undefined;
     } | {
-        readonly id: string;
         readonly type: "tool-error";
-        readonly message: string;
+        readonly id: string;
         readonly name: string;
-        readonly error?: unknown;
-        readonly providerMetadata?: {
-            readonly [x: string]: {
-                readonly [x: string]: unknown;
-            };
-        } | undefined;
         readonly namespace?: string | undefined;
-    } | {
-        readonly type: "media";
-        readonly media: import("../../media.js").Asset;
+        readonly message: string;
+        readonly error?: unknown;
         readonly providerMetadata?: {
             readonly [x: string]: {
                 readonly [x: string]: unknown;
@@ -706,33 +686,41 @@ export declare const finishAll: <K extends StreamKey>(route: string, tools: Stat
         } | undefined;
     } | {
         readonly type: "step-finish";
+        readonly index: number;
         readonly reason: {
-            readonly normalized: "length" | "stop" | "tool-calls" | "content-filter" | "error" | "unknown";
+            readonly normalized: "content-filter" | "error" | "length" | "stop" | "tool-calls" | "unknown";
             readonly raw?: string | undefined;
             readonly category?: string | undefined;
             readonly explanation?: string | undefined;
         };
-        readonly index: number;
+        readonly usage?: import("../../schema/events.js").Usage | undefined;
         readonly providerMetadata?: {
             readonly [x: string]: {
                 readonly [x: string]: unknown;
             };
         } | undefined;
-        readonly usage?: import("../../schema/events.js").Usage | undefined;
     } | {
         readonly type: "finish";
         readonly reason: {
-            readonly normalized: "length" | "stop" | "tool-calls" | "content-filter" | "error" | "unknown";
+            readonly normalized: "content-filter" | "error" | "length" | "stop" | "tool-calls" | "unknown";
             readonly raw?: string | undefined;
             readonly category?: string | undefined;
             readonly explanation?: string | undefined;
         };
+        readonly usage?: import("../../schema/events.js").Usage | undefined;
+        readonly providerMetadata?: {
+            readonly [x: string]: {
+                readonly [x: string]: unknown;
+            };
+        } | undefined;
+    } | {
+        readonly type: "media";
+        readonly media: import("../../media.js").Asset;
         readonly providerMetadata?: {
             readonly [x: string]: {
                 readonly [x: string]: unknown;
             };
         } | undefined;
-        readonly usage?: import("../../schema/events.js").Usage | undefined;
     } | {
         readonly type: "provider-error";
         readonly message: string;
@@ -742,6 +730,18 @@ export declare const finishAll: <K extends StreamKey>(route: string, tools: Stat
                 readonly [x: string]: unknown;
             };
         } | undefined;
-    })[];
+    } | ({
+        readonly type: "compaction";
+        readonly provider: string & import("effect/Brand").Brand<"AI.ProviderID">;
+        readonly id?: string | undefined;
+        readonly encrypted?: string | undefined;
+        readonly text?: string | null | undefined;
+    } & ({
+        readonly encrypted: string;
+        readonly text?: never;
+    } | {
+        readonly text: string | null;
+        readonly encrypted?: never;
+    })))[];
 }, AIError, never>;
 export * as ToolStream from "./tool-stream.js";