@ai-sdk/open-responses 2.0.34 → 2.0.36

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @ai-sdk/open-responses
 
+## 2.0.36
+
+### Patch Changes
+
+- Updated dependencies [aa45741]
+  - @ai-sdk/provider@4.0.9
+  - @ai-sdk/provider-utils@5.0.34
+
+## 2.0.35
+
+### Patch Changes
+
+- 9a68261: add experimental codecs for Open Responses extension tools, items, and events, including lossless history replay
+- Updated dependencies [90192f1]
+  - @ai-sdk/provider-utils@5.0.33
+
 ## 2.0.34
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,9 +1,96 @@
-import { ProviderV4, LanguageModelV4 } from '@ai-sdk/provider';
+import { LanguageModelV4ProviderTool, JSONObject, LanguageModelV4Content, LanguageModelV4StreamPart, LanguageModelV4ToolCallPart, LanguageModelV4ToolResultPart, ProviderV4, LanguageModelV4 } from '@ai-sdk/provider';
 import * as _ai_sdk_provider_utils from '@ai-sdk/provider-utils';
-import { FetchFunction, InferSchema } from '@ai-sdk/provider-utils';
+import { MaybePromiseLike, FetchFunction, InferSchema } from '@ai-sdk/provider-utils';
 
 declare const VERSION: string;
 
+type OpenResponsesNamespacedType = `${string}:${string}`;
+type OpenResponsesExtensionRecord = JSONObject & {
+    type: OpenResponsesNamespacedType;
+};
+type OpenResponsesExtensionItem = OpenResponsesExtensionRecord & {
+    id: string;
+    status: string;
+};
+type OpenResponsesExtensionEvent = OpenResponsesExtensionRecord & {
+    sequence_number: number;
+};
+type OpenResponsesExtensionInputPart = LanguageModelV4ToolCallPart | LanguageModelV4ToolResultPart;
+type OpenResponsesExtensionContentPart = Extract<LanguageModelV4Content, LanguageModelV4StreamPart>;
+type OpenResponsesExtensionStreamPart = Exclude<LanguageModelV4StreamPart, {
+    type: 'error' | 'finish' | 'raw' | 'response-metadata' | 'stream-start';
+}>;
+/**
+ * Defines how the provider encodes and decodes an Open Responses extension.
+ *
+ * Tool, item, and event codecs can be registered independently.
+ */
+interface OpenResponsesExtension {
+    /**
+     * Extension ID in `<implementor>.<extension>` format. For extensions that
+     * encode a provider tool, this is also the AI SDK provider-tool ID.
+     */
+    id: LanguageModelV4ProviderTool['id'];
+    /**
+     * Namespaced Open Responses tool type, in `<implementor>:<tool>` format.
+     * Must be provided together with `encodeTool`.
+     */
+    toolType?: OpenResponsesNamespacedType;
+    /**
+     * Namespaced item types decoded by this extension. Must be provided together
+     * with `decodeItem`.
+     */
+    itemTypes?: readonly OpenResponsesNamespacedType[];
+    /**
+     * Namespaced streaming event types decoded by this extension. Must be
+     * provided together with `decodeEvent`.
+     */
+    eventTypes?: readonly OpenResponsesNamespacedType[];
+    /**
+     * Encodes an AI SDK provider tool. Return `undefined` when its arguments
+     * cannot be encoded. The adapter adds `toolType` and omits a specific tool
+     * choice that selects the omitted tool.
+     */
+    encodeTool?(options: {
+        name: string;
+        args: Record<string, unknown>;
+    }): MaybePromiseLike<JSONObject | undefined>;
+    /**
+     * Encodes a specific `toolChoice`. The adapter adds `toolType`. The default
+     * is an object containing only `toolType`.
+     */
+    encodeToolChoice?(options: {
+        name: string;
+        args: Record<string, unknown>;
+    }): MaybePromiseLike<JSONObject | undefined>;
+    /**
+     * Decodes a completed namespaced item into AI SDK content parts. The adapter
+     * adds a custom replay part containing the original item and reference
+     * metadata to the returned parts.
+     */
+    decodeItem?(options: {
+        item: OpenResponsesExtensionItem;
+        mode: 'generate' | 'stream';
+    }): MaybePromiseLike<OpenResponsesExtensionContentPart[] | undefined>;
+    /**
+     * Encodes an AI SDK history part when no original wire item is available.
+     * Every returned item must use one of `itemTypes`.
+     */
+    encodeInputItem?(options: {
+        part: OpenResponsesExtensionInputPart;
+        tool: LanguageModelV4ProviderTool;
+    }): MaybePromiseLike<OpenResponsesExtensionItem | OpenResponsesExtensionItem[] | undefined>;
+    /**
+     * Decodes a namespaced streaming event.
+     *
+     * `state` persists for the lifetime of one response stream.
+     */
+    decodeEvent?(options: {
+        event: OpenResponsesExtensionEvent;
+        state: Map<string, unknown>;
+    }): MaybePromiseLike<OpenResponsesExtensionStreamPart[] | undefined>;
+}
+
 interface OpenResponsesProvider extends ProviderV4 {
     (modelId: string): LanguageModelV4;
 }
@@ -29,6 +116,12 @@ interface OpenResponsesProviderSettings {
      * or to provide a custom fetch implementation for e.g. testing.
      */
     fetch?: FetchFunction;
+    /**
+     * Codecs for Open Responses extension tools, items, and streaming events.
+     *
+     * @experimental This API may change in a future release.
+     */
+    experimental_extensions?: readonly OpenResponsesExtension[];
 }
 declare function createOpenResponses(options: OpenResponsesProviderSettings): OpenResponsesProvider;
 
@@ -38,4 +131,4 @@ declare const openResponsesLanguageModelOptions: _ai_sdk_provider_utils.LazySche
 }>;
 type OpenResponsesLanguageModelOptions = InferSchema<typeof openResponsesLanguageModelOptions>;
 
-export { type OpenResponsesLanguageModelOptions, type OpenResponsesLanguageModelOptions as OpenResponsesOptions, type OpenResponsesProvider, type OpenResponsesProviderSettings, VERSION, createOpenResponses };
+export { type OpenResponsesExtension as Experimental_OpenResponsesExtension, type OpenResponsesExtensionContentPart as Experimental_OpenResponsesExtensionContentPart, type OpenResponsesExtensionEvent as Experimental_OpenResponsesExtensionEvent, type OpenResponsesExtensionInputPart as Experimental_OpenResponsesExtensionInputPart, type OpenResponsesExtensionItem as Experimental_OpenResponsesExtensionItem, type OpenResponsesExtensionRecord as Experimental_OpenResponsesExtensionRecord, type OpenResponsesExtensionStreamPart as Experimental_OpenResponsesExtensionStreamPart, type OpenResponsesNamespacedType as Experimental_OpenResponsesNamespacedType, type OpenResponsesLanguageModelOptions, type OpenResponsesLanguageModelOptions as OpenResponsesOptions, type OpenResponsesProvider, type OpenResponsesProviderSettings, VERSION, createOpenResponses };