ai 5.0.98 → 5.0.99

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # ai
 
+## 5.0.99
+
+### Patch Changes
+
+- 15cfac8: feat: export GatewayModelId and use to type LanguageModel
+
 ## 5.0.98
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,4 +1,5 @@
-export { createGateway, gateway } from '@ai-sdk/gateway';
+import { GatewayModelId } from '@ai-sdk/gateway';
+export { GatewayModelId, createGateway, gateway } from '@ai-sdk/gateway';
 import * as _ai_sdk_provider_utils from '@ai-sdk/provider-utils';
 import { ModelMessage, Tool, InferToolInput, InferToolOutput, AssistantModelMessage, ToolModelMessage, ReasoningPart, FlexibleSchema, SystemModelMessage, UserModelMessage, ProviderOptions, IdGenerator, ToolCall, InferSchema, DataContent, Validator, StandardSchemaV1, TextPart, FilePart, Resolvable, FetchFunction } from '@ai-sdk/provider-utils';
 export { AssistantContent, AssistantModelMessage, DataContent, FilePart, IdGenerator, ImagePart, InferToolInput, InferToolOutput, ModelMessage, Schema, SystemModelMessage, TextPart, Tool, ToolCallOptions, ToolCallPart, ToolContent, ToolExecuteFunction, ToolModelMessage, ToolResultPart, UserContent, UserModelMessage, asSchema, createIdGenerator, dynamicTool, generateId, jsonSchema, parseJsonEventStream, tool, zodSchema } from '@ai-sdk/provider-utils';
@@ -196,10 +197,50 @@ type ImageModelResponseMetadata = {
 
 type JSONValue = JSONValue$1;
 
+declare global {
+    /**
+     * Global interface that can be augmented by third-party packages to register custom model IDs.
+     *
+     * You can register model IDs in two ways:
+     *
+     * 1. Register baesd on Model IDs from a provider package:
+     * @example
+     * ```typescript
+     * import { openai } from '@ai-sdk/openai';
+     * type OpenAIResponsesModelId = Parameters<typeof openai>[0];
+     *
+     * declare global {
+     *   interface RegisteredProviderModels {
+     *     openai: OpenAIResponsesModelId;
+     *   }
+     * }
+     * ```
+     *
+     * 2. Register individual model IDs directly as keys:
+     * @example
+     * ```typescript
+     * declare global {
+     *   interface RegisteredProviderModels {
+     *     'my-provider:my-model': any;
+     *     'my-provider:another-model': any;
+     *   }
+     * }
+     * ```
+     */
+    interface RegisteredProviderModels {
+    }
+}
+/**
+ * Global provider model ID type that defaults to GatewayModelId but can be augmented
+ * by third-party packages via declaration merging.
+ */
+type GlobalProviderModelId = [keyof RegisteredProviderModels] extends [
+    never
+] ? GatewayModelId : keyof RegisteredProviderModels | RegisteredProviderModels[keyof RegisteredProviderModels];
 /**
 Language model that is used by the AI SDK Core functions.
 */
-type LanguageModel = string | LanguageModelV2;
+type LanguageModel = GlobalProviderModelId | LanguageModelV2;
 /**
 Reason why a language model finished generating a response.
 

package/dist/index.d.ts

@@ -1,4 +1,5 @@
-export { createGateway, gateway } from '@ai-sdk/gateway';
+import { GatewayModelId } from '@ai-sdk/gateway';
+export { GatewayModelId, createGateway, gateway } from '@ai-sdk/gateway';
 import * as _ai_sdk_provider_utils from '@ai-sdk/provider-utils';
 import { ModelMessage, Tool, InferToolInput, InferToolOutput, AssistantModelMessage, ToolModelMessage, ReasoningPart, FlexibleSchema, SystemModelMessage, UserModelMessage, ProviderOptions, IdGenerator, ToolCall, InferSchema, DataContent, Validator, StandardSchemaV1, TextPart, FilePart, Resolvable, FetchFunction } from '@ai-sdk/provider-utils';
 export { AssistantContent, AssistantModelMessage, DataContent, FilePart, IdGenerator, ImagePart, InferToolInput, InferToolOutput, ModelMessage, Schema, SystemModelMessage, TextPart, Tool, ToolCallOptions, ToolCallPart, ToolContent, ToolExecuteFunction, ToolModelMessage, ToolResultPart, UserContent, UserModelMessage, asSchema, createIdGenerator, dynamicTool, generateId, jsonSchema, parseJsonEventStream, tool, zodSchema } from '@ai-sdk/provider-utils';
@@ -196,10 +197,50 @@ type ImageModelResponseMetadata = {
 
 type JSONValue = JSONValue$1;
 
+declare global {
+    /**
+     * Global interface that can be augmented by third-party packages to register custom model IDs.
+     *
+     * You can register model IDs in two ways:
+     *
+     * 1. Register baesd on Model IDs from a provider package:
+     * @example
+     * ```typescript
+     * import { openai } from '@ai-sdk/openai';
+     * type OpenAIResponsesModelId = Parameters<typeof openai>[0];
+     *
+     * declare global {
+     *   interface RegisteredProviderModels {
+     *     openai: OpenAIResponsesModelId;
+     *   }
+     * }
+     * ```
+     *
+     * 2. Register individual model IDs directly as keys:
+     * @example
+     * ```typescript
+     * declare global {
+     *   interface RegisteredProviderModels {
+     *     'my-provider:my-model': any;
+     *     'my-provider:another-model': any;
+     *   }
+     * }
+     * ```
+     */
+    interface RegisteredProviderModels {
+    }
+}
+/**
+ * Global provider model ID type that defaults to GatewayModelId but can be augmented
+ * by third-party packages via declaration merging.
+ */
+type GlobalProviderModelId = [keyof RegisteredProviderModels] extends [
+    never
+] ? GatewayModelId : keyof RegisteredProviderModels | RegisteredProviderModels[keyof RegisteredProviderModels];
 /**
 Language model that is used by the AI SDK Core functions.
 */
-type LanguageModel = string | LanguageModelV2;
+type LanguageModel = GlobalProviderModelId | LanguageModelV2;
 /**
 Reason why a language model finished generating a response.
 

package/dist/index.js

@@ -777,7 +777,7 @@ function detectMediaType({
 var import_provider_utils2 = require("@ai-sdk/provider-utils");
 
 // src/version.ts
-var VERSION = true ? "5.0.98" : "0.0.0-test";
+var VERSION = true ? "5.0.99" : "0.0.0-test";
 
 // src/util/download/download.ts
 var download = async ({ url }) => {