@ai-sdk/open-responses 2.0.52 → 2.0.55

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @ai-sdk/open-responses
 
+## 2.0.55
+
+### Patch Changes
+
+- 8cf3f5b: Allow extension codecs to explicitly opt in to exact bare tool, item, and event discriminator registration.
+- Updated dependencies [e3605f6]
+- Updated dependencies [525efc5]
+  - @ai-sdk/provider-utils@5.0.50
+  - @ai-sdk/provider@4.0.19
+
+## 2.0.54
+
+### Patch Changes
+
+- Updated dependencies [af9597b]
+- Updated dependencies [bc49f78]
+  - @ai-sdk/provider-utils@5.0.49
+
+## 2.0.53
+
+### Patch Changes
+
+- Updated dependencies [be877ff]
+  - @ai-sdk/provider-utils@5.0.48
+
 ## 2.0.52
 
 ### Patch Changes

package/dist/index.d.ts

@@ -5,14 +5,14 @@ import { MaybePromiseLike, FetchFunction, ResponseHandler, InferSchema } from '@
 declare const VERSION: string;
 
 type OpenResponsesNamespacedType = `${string}:${string}`;
-type OpenResponsesExtensionRecord = JSONObject & {
-    type: OpenResponsesNamespacedType;
+type OpenResponsesExtensionRecord<Type extends string = OpenResponsesNamespacedType> = JSONObject & {
+    type: Type;
 };
-type OpenResponsesExtensionItem = OpenResponsesExtensionRecord & {
+type OpenResponsesExtensionItem<Type extends string = OpenResponsesNamespacedType> = OpenResponsesExtensionRecord<Type> & {
     id: string;
     status: string;
 };
-type OpenResponsesExtensionEvent = OpenResponsesExtensionRecord & {
+type OpenResponsesExtensionEvent<Type extends string = OpenResponsesNamespacedType> = OpenResponsesExtensionRecord<Type> & {
     sequence_number: number;
 };
 type OpenResponsesExtensionInputPart = LanguageModelV4ToolCallPart | LanguageModelV4ToolResultPart;
@@ -25,7 +25,7 @@ type OpenResponsesExtensionStreamPart = Exclude<LanguageModelV4StreamPart, {
  *
  * Tool, item, and event codecs can be registered independently.
  */
-interface OpenResponsesExtension {
+interface OpenResponsesExtensionBase {
     /**
      * Extension ID in `<implementor>.<extension>` format. For extensions that
      * encode a provider tool, this is also the AI SDK provider-tool ID.
@@ -36,78 +36,135 @@ interface OpenResponsesExtension {
      * 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.
+     * cannot be encoded. The adapter adds the registered tool type 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`.
+     * Encodes a specific `toolChoice`. The adapter adds the registered tool type.
+     * The default is an object containing only that type.
      */
     encodeToolChoice?(options: {
         name: string;
         args: Record<string, unknown>;
     }): MaybePromiseLike<JSONObject | undefined>;
+}
+type OpenResponsesExtensionItemCodec<Type extends string> = {
     /**
-     * Decodes a completed namespaced item into AI SDK content parts. The adapter
+     * Namespaced item types decoded by this extension. Must be provided together
+     * with `decodeItem`.
+     */
+    itemTypes?: readonly OpenResponsesNamespacedType[];
+    /**
+     * Decodes a completed registered 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;
+        item: OpenResponsesExtensionItem<Type>;
         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`.
+     * Every returned item must use one of the registered item types.
      */
     encodeInputItem?(options: {
         part: OpenResponsesExtensionInputPart;
         tool: LanguageModelV4ProviderTool;
-    }): MaybePromiseLike<OpenResponsesExtensionItem | OpenResponsesExtensionItem[] | undefined>;
+    }): MaybePromiseLike<OpenResponsesExtensionItem<Type> | OpenResponsesExtensionItem<Type>[] | undefined>;
+};
+type OpenResponsesExtensionEventCodec<Type extends string> = {
+    /**
+     * Namespaced streaming event types decoded by this extension. Must be
+     * provided together with `decodeEvent`.
+     */
+    eventTypes?: readonly OpenResponsesNamespacedType[];
     /**
-     * Decodes a namespaced streaming event.
+     * Decodes a registered streaming event.
      *
      * `state` persists for the lifetime of one response stream.
      */
     decodeEvent?(options: {
-        event: OpenResponsesExtensionEvent;
+        event: OpenResponsesExtensionEvent<Type>;
         state: Map<string, unknown>;
     }): MaybePromiseLike<OpenResponsesExtensionStreamPart[] | undefined>;
+};
+/**
+ * Defines a portable Open Responses extension using namespaced wire types.
+ *
+ * This remains an interface so existing consumers can extend it from their own
+ * interfaces and implement it in classes.
+ */
+interface OpenResponsesExtension extends OpenResponsesExtensionBase, OpenResponsesExtensionItemCodec<OpenResponsesNamespacedType>, OpenResponsesExtensionEventCodec<OpenResponsesNamespacedType> {
+    allowBareTypes?: false;
+    bareToolType?: undefined;
+    bareItemTypes?: undefined;
+    bareEventTypes?: undefined;
 }
+/**
+ * Defines a non-portable Open Responses extension that explicitly registers
+ * exact bare wire types.
+ */
+type OpenResponsesBareExtension = OpenResponsesExtensionBase & OpenResponsesExtensionItemCodec<string> & OpenResponsesExtensionEventCodec<string> & {
+    /**
+     * Explicitly enables non-portable bare discriminator registration for this
+     * extension.
+     */
+    allowBareTypes: true;
+    /**
+     * Exact non-namespaced tool type used by a documented implementation
+     * extension. Must be provided together with `encodeTool` and cannot be used
+     * together with `toolType`.
+     */
+    bareToolType?: string;
+    /**
+     * Exact non-namespaced item types decoded by a documented implementation
+     * extension. Must be provided together with `decodeItem`.
+     */
+    bareItemTypes?: readonly string[];
+    /**
+     * Exact non-namespaced streaming event types decoded by this extension.
+     * Must be provided together with `decodeEvent`.
+     */
+    bareEventTypes?: readonly string[];
+} & ({
+    bareToolType: string;
+} | {
+    bareItemTypes: readonly string[];
+} | {
+    bareEventTypes: readonly string[];
+});
+type OpenResponsesExtensionRegistration = OpenResponsesExtension | OpenResponsesBareExtension;
 type OpenResponsesExtensionRegistry = {
-    byEventType: Map<OpenResponsesNamespacedType, OpenResponsesEventExtension>;
-    byExtensionId: Map<LanguageModelV4ProviderTool['id'], OpenResponsesExtension>;
-    byItemType: Map<OpenResponsesNamespacedType, OpenResponsesItemExtension>;
+    byEventType: Map<string, OpenResponsesEventExtension>;
+    byExtensionId: Map<LanguageModelV4ProviderTool['id'], OpenResponsesExtensionRegistration>;
+    byItemType: Map<string, OpenResponsesItemExtension>;
     byProviderToolId: Map<LanguageModelV4ProviderTool['id'], OpenResponsesToolExtension>;
-    byToolType: Map<OpenResponsesNamespacedType, OpenResponsesToolExtension>;
+    byToolType: Map<string, OpenResponsesToolExtension>;
 };
-type OpenResponsesToolExtension = OpenResponsesExtension & {
-    toolType: OpenResponsesNamespacedType;
-    encodeTool: NonNullable<OpenResponsesExtension['encodeTool']>;
+type OpenResponsesToolExtension = OpenResponsesExtensionRegistration & {
+    encodeTool: NonNullable<OpenResponsesExtensionRegistration['encodeTool']>;
+    encodeInputItem?: (options: {
+        part: OpenResponsesExtensionInputPart;
+        tool: LanguageModelV4ProviderTool;
+    }) => MaybePromiseLike<OpenResponsesExtensionItem<string> | OpenResponsesExtensionItem<string>[] | undefined>;
 };
-type OpenResponsesItemExtension = OpenResponsesExtension & {
-    itemTypes: readonly OpenResponsesNamespacedType[];
-    decodeItem: NonNullable<OpenResponsesExtension['decodeItem']>;
+type OpenResponsesItemExtension = OpenResponsesExtensionRegistration & {
+    decodeItem(options: {
+        item: OpenResponsesExtensionItem<string>;
+        mode: 'generate' | 'stream';
+    }): MaybePromiseLike<OpenResponsesExtensionContentPart[] | undefined>;
 };
-type OpenResponsesEventExtension = OpenResponsesExtension & {
-    eventTypes: readonly OpenResponsesNamespacedType[];
-    decodeEvent: NonNullable<OpenResponsesExtension['decodeEvent']>;
+type OpenResponsesEventExtension = OpenResponsesExtensionRegistration & {
+    decodeEvent(options: {
+        event: OpenResponsesExtensionEvent<string>;
+        state: Map<string, unknown>;
+    }): MaybePromiseLike<OpenResponsesExtensionStreamPart[] | undefined>;
 };
 
 type OpenResponsesCustomToolOptions = {
@@ -230,7 +287,7 @@ interface OpenResponsesProviderSettings {
      *
      * @experimental This API may change in a future release.
      */
-    experimental_extensions?: readonly OpenResponsesExtension[];
+    experimental_extensions?: readonly OpenResponsesExtensionRegistration[];
 }
 declare function createOpenResponses(options: OpenResponsesProviderSettings): OpenResponsesProvider;
 
@@ -240,4 +297,4 @@ declare const openResponsesLanguageModelOptions: _ai_sdk_provider_utils.LazySche
 }>;
 type OpenResponsesLanguageModelOptions = InferSchema<typeof openResponsesLanguageModelOptions>;
 
-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 OpenResponsesCustomToolOptions, type OpenResponsesLanguageModelOptions, type OpenResponsesLanguageModelOptions as OpenResponsesOptions, type OpenResponsesProvider, type OpenResponsesProviderSettings, VERSION, createOpenResponses };
+export { type OpenResponsesBareExtension as Experimental_OpenResponsesBareExtension, 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 OpenResponsesCustomToolOptions, type OpenResponsesLanguageModelOptions, type OpenResponsesLanguageModelOptions as OpenResponsesOptions, type OpenResponsesProvider, type OpenResponsesProviderSettings, VERSION, createOpenResponses };