@ai-sdk/provider-utils 3.0.7 → 3.0.9

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @ai-sdk/provider-utils
 
+## 3.0.9
+
+### Patch Changes
+
+- 0294b58: feat(ai): set `ai`, `@ai-sdk/provider-utils`, and runtime in `user-agent` header
+
+## 3.0.8
+
+### Patch Changes
+
+- 99964ed: fix(provider-utils): fix type inference for toModelOutput
+
 ## 3.0.7
 
 ### Patch Changes

package/dist/index.d.mts

@@ -43,6 +43,20 @@ declare function extractResponseHeaders(response: Response): {
  */
 type FetchFunction = typeof globalThis.fetch;
 
+declare function getRuntimeEnvironmentUserAgent(globalThisAny?: any): string;
+
+/**
+ * Appends suffix parts to the `user-agent` header.
+ * If a `user-agent` header already exists, the suffix parts are appended to it.
+ * If no `user-agent` header exists, a new one is created with the suffix parts.
+ * Automatically removes undefined entries from the headers.
+ *
+ * @param headers - The original headers.
+ * @param userAgentSuffixParts - The parts to append to the `user-agent` header.
+ * @returns The new headers with the `user-agent` header set or updated.
+ */
+declare function withUserAgentSuffix(headers: HeadersInit | Record<string, string | undefined> | undefined, ...userAgentSuffixParts: string[]): Record<string, string>;
+
 /**
 Creates an ID generator.
 The total length of the ID is the sum of the prefix, separator, and random part length.
@@ -608,6 +622,20 @@ interface ToolCallOptions {
 }
 type ToolExecuteFunction<INPUT, OUTPUT> = (input: INPUT, options: ToolCallOptions) => AsyncIterable<OUTPUT> | PromiseLike<OUTPUT> | OUTPUT;
 type NeverOptional<N, T> = 0 extends 1 & N ? Partial<T> : [N] extends [never] ? Partial<Record<keyof T, undefined>> : T;
+type ToolOutputProperties<INPUT, OUTPUT> = NeverOptional<OUTPUT, {
+    /**
+An async function that is called with the arguments from the tool call and produces a result.
+If not provided, the tool will not be executed automatically.
+
+@args is the input of the tool call.
+@options.abortSignal is a signal that can be used to abort the tool call.
+  */
+    execute: ToolExecuteFunction<INPUT, OUTPUT>;
+    outputSchema?: FlexibleSchema<OUTPUT>;
+} | {
+    outputSchema: FlexibleSchema<OUTPUT>;
+    execute?: never;
+}>;
 /**
 A tool contains the description and the schema of the input that the tool expects.
 This enables the language model to generate the input.
@@ -652,27 +680,14 @@ type Tool<INPUT extends JSONValue | unknown | never = any, OUTPUT extends JSONVa
     onInputAvailable?: (options: {
         input: [INPUT] extends [never] ? undefined : INPUT;
     } & ToolCallOptions) => void | PromiseLike<void>;
-} & NeverOptional<OUTPUT, {
+} & ToolOutputProperties<INPUT, OUTPUT> & {
     /**
 Optional conversion function that maps the tool result to an output that can be used by the language model.
 
 If not provided, the tool result will be sent as a JSON object.
-      */
-    toModelOutput?: (output: OUTPUT) => LanguageModelV2ToolResultPart['output'];
-} & ({
-    /**
-An async function that is called with the arguments from the tool call and produces a result.
-If not provided, the tool will not be executed automatically.
-
-@args is the input of the tool call.
-@options.abortSignal is a signal that can be used to abort the tool call.
   */
-    execute: ToolExecuteFunction<INPUT, OUTPUT>;
-    outputSchema?: FlexibleSchema<OUTPUT>;
-} | {
-    outputSchema: FlexibleSchema<OUTPUT>;
-    execute?: never;
-})> & ({
+    toModelOutput?: (output: 0 extends 1 & OUTPUT ? any : [OUTPUT] extends [never] ? any : NoInfer<OUTPUT>) => LanguageModelV2ToolResultPart['output'];
+} & ({
     /**
 Tool with user-defined input and output schemas.
  */
@@ -891,4 +906,6 @@ interface ToolResult<NAME extends string, INPUT, OUTPUT> {
     dynamic?: boolean;
 }
 
-export { type AssistantContent, type AssistantModelMessage, type DataContent, type FetchFunction, type FilePart, type FlexibleSchema, type IdGenerator, type ImagePart, type InferSchema, type InferToolInput, type InferToolOutput, type ModelMessage, type ParseResult, type ProviderDefinedToolFactory, type ProviderDefinedToolFactoryWithOutputSchema, type ProviderOptions, type ReasoningPart, type Resolvable, type ResponseHandler, type Schema, type SystemModelMessage, type TextPart, type Tool, type ToolCall, type ToolCallOptions, type ToolCallPart, type ToolContent, type ToolExecuteFunction, type ToolModelMessage, type ToolResult, type ToolResultPart, type UserContent, type UserModelMessage, type ValidationResult, type Validator, asSchema, asValidator, combineHeaders, convertAsyncIteratorToReadableStream, convertBase64ToUint8Array, convertToBase64, convertUint8ArrayToBase64, createBinaryResponseHandler, createEventSourceResponseHandler, createIdGenerator, createJsonErrorResponseHandler, createJsonResponseHandler, createJsonStreamResponseHandler, createProviderDefinedToolFactory, createProviderDefinedToolFactoryWithOutputSchema, createStatusCodeErrorResponseHandler, delay, dynamicTool, executeTool, extractResponseHeaders, generateId, getErrorMessage, getFromApi, injectJsonInstructionIntoMessages, isAbortError, isParsableJson, isUrlSupported, isValidator, jsonSchema, loadApiKey, loadOptionalSetting, loadSetting, mediaTypeToExtension, parseJSON, parseJsonEventStream, parseProviderOptions, postFormDataToApi, postJsonToApi, postToApi, removeUndefinedEntries, resolve, safeParseJSON, safeValidateTypes, standardSchemaValidator, tool, validateTypes, validator, validatorSymbol, withoutTrailingSlash, zodSchema };
+declare const VERSION: string;
+
+export { type AssistantContent, type AssistantModelMessage, type DataContent, type FetchFunction, type FilePart, type FlexibleSchema, type IdGenerator, type ImagePart, type InferSchema, type InferToolInput, type InferToolOutput, type ModelMessage, type ParseResult, type ProviderDefinedToolFactory, type ProviderDefinedToolFactoryWithOutputSchema, type ProviderOptions, type ReasoningPart, type Resolvable, type ResponseHandler, type Schema, type SystemModelMessage, type TextPart, type Tool, type ToolCall, type ToolCallOptions, type ToolCallPart, type ToolContent, type ToolExecuteFunction, type ToolModelMessage, type ToolResult, type ToolResultPart, type UserContent, type UserModelMessage, VERSION, type ValidationResult, type Validator, asSchema, asValidator, combineHeaders, convertAsyncIteratorToReadableStream, convertBase64ToUint8Array, convertToBase64, convertUint8ArrayToBase64, createBinaryResponseHandler, createEventSourceResponseHandler, createIdGenerator, createJsonErrorResponseHandler, createJsonResponseHandler, createJsonStreamResponseHandler, createProviderDefinedToolFactory, createProviderDefinedToolFactoryWithOutputSchema, createStatusCodeErrorResponseHandler, delay, dynamicTool, executeTool, extractResponseHeaders, generateId, getErrorMessage, getFromApi, getRuntimeEnvironmentUserAgent, injectJsonInstructionIntoMessages, isAbortError, isParsableJson, isUrlSupported, isValidator, jsonSchema, loadApiKey, loadOptionalSetting, loadSetting, mediaTypeToExtension, parseJSON, parseJsonEventStream, parseProviderOptions, postFormDataToApi, postJsonToApi, postToApi, removeUndefinedEntries, resolve, safeParseJSON, safeValidateTypes, standardSchemaValidator, tool, validateTypes, validator, validatorSymbol, withUserAgentSuffix, withoutTrailingSlash, zodSchema };

package/dist/index.d.ts

@@ -43,6 +43,20 @@ declare function extractResponseHeaders(response: Response): {
  */
 type FetchFunction = typeof globalThis.fetch;
 
+declare function getRuntimeEnvironmentUserAgent(globalThisAny?: any): string;
+
+/**
+ * Appends suffix parts to the `user-agent` header.
+ * If a `user-agent` header already exists, the suffix parts are appended to it.
+ * If no `user-agent` header exists, a new one is created with the suffix parts.
+ * Automatically removes undefined entries from the headers.
+ *
+ * @param headers - The original headers.
+ * @param userAgentSuffixParts - The parts to append to the `user-agent` header.
+ * @returns The new headers with the `user-agent` header set or updated.
+ */
+declare function withUserAgentSuffix(headers: HeadersInit | Record<string, string | undefined> | undefined, ...userAgentSuffixParts: string[]): Record<string, string>;
+
 /**
 Creates an ID generator.
 The total length of the ID is the sum of the prefix, separator, and random part length.
@@ -608,6 +622,20 @@ interface ToolCallOptions {
 }
 type ToolExecuteFunction<INPUT, OUTPUT> = (input: INPUT, options: ToolCallOptions) => AsyncIterable<OUTPUT> | PromiseLike<OUTPUT> | OUTPUT;
 type NeverOptional<N, T> = 0 extends 1 & N ? Partial<T> : [N] extends [never] ? Partial<Record<keyof T, undefined>> : T;
+type ToolOutputProperties<INPUT, OUTPUT> = NeverOptional<OUTPUT, {
+    /**
+An async function that is called with the arguments from the tool call and produces a result.
+If not provided, the tool will not be executed automatically.
+
+@args is the input of the tool call.
+@options.abortSignal is a signal that can be used to abort the tool call.
+  */
+    execute: ToolExecuteFunction<INPUT, OUTPUT>;
+    outputSchema?: FlexibleSchema<OUTPUT>;
+} | {
+    outputSchema: FlexibleSchema<OUTPUT>;
+    execute?: never;
+}>;
 /**
 A tool contains the description and the schema of the input that the tool expects.
 This enables the language model to generate the input.
@@ -652,27 +680,14 @@ type Tool<INPUT extends JSONValue | unknown | never = any, OUTPUT extends JSONVa
     onInputAvailable?: (options: {
         input: [INPUT] extends [never] ? undefined : INPUT;
     } & ToolCallOptions) => void | PromiseLike<void>;
-} & NeverOptional<OUTPUT, {
+} & ToolOutputProperties<INPUT, OUTPUT> & {
     /**
 Optional conversion function that maps the tool result to an output that can be used by the language model.
 
 If not provided, the tool result will be sent as a JSON object.
-      */
-    toModelOutput?: (output: OUTPUT) => LanguageModelV2ToolResultPart['output'];
-} & ({
-    /**
-An async function that is called with the arguments from the tool call and produces a result.
-If not provided, the tool will not be executed automatically.
-
-@args is the input of the tool call.
-@options.abortSignal is a signal that can be used to abort the tool call.
   */
-    execute: ToolExecuteFunction<INPUT, OUTPUT>;
-    outputSchema?: FlexibleSchema<OUTPUT>;
-} | {
-    outputSchema: FlexibleSchema<OUTPUT>;
-    execute?: never;
-})> & ({
+    toModelOutput?: (output: 0 extends 1 & OUTPUT ? any : [OUTPUT] extends [never] ? any : NoInfer<OUTPUT>) => LanguageModelV2ToolResultPart['output'];
+} & ({
     /**
 Tool with user-defined input and output schemas.
  */
@@ -891,4 +906,6 @@ interface ToolResult<NAME extends string, INPUT, OUTPUT> {
     dynamic?: boolean;
 }
 
-export { type AssistantContent, type AssistantModelMessage, type DataContent, type FetchFunction, type FilePart, type FlexibleSchema, type IdGenerator, type ImagePart, type InferSchema, type InferToolInput, type InferToolOutput, type ModelMessage, type ParseResult, type ProviderDefinedToolFactory, type ProviderDefinedToolFactoryWithOutputSchema, type ProviderOptions, type ReasoningPart, type Resolvable, type ResponseHandler, type Schema, type SystemModelMessage, type TextPart, type Tool, type ToolCall, type ToolCallOptions, type ToolCallPart, type ToolContent, type ToolExecuteFunction, type ToolModelMessage, type ToolResult, type ToolResultPart, type UserContent, type UserModelMessage, type ValidationResult, type Validator, asSchema, asValidator, combineHeaders, convertAsyncIteratorToReadableStream, convertBase64ToUint8Array, convertToBase64, convertUint8ArrayToBase64, createBinaryResponseHandler, createEventSourceResponseHandler, createIdGenerator, createJsonErrorResponseHandler, createJsonResponseHandler, createJsonStreamResponseHandler, createProviderDefinedToolFactory, createProviderDefinedToolFactoryWithOutputSchema, createStatusCodeErrorResponseHandler, delay, dynamicTool, executeTool, extractResponseHeaders, generateId, getErrorMessage, getFromApi, injectJsonInstructionIntoMessages, isAbortError, isParsableJson, isUrlSupported, isValidator, jsonSchema, loadApiKey, loadOptionalSetting, loadSetting, mediaTypeToExtension, parseJSON, parseJsonEventStream, parseProviderOptions, postFormDataToApi, postJsonToApi, postToApi, removeUndefinedEntries, resolve, safeParseJSON, safeValidateTypes, standardSchemaValidator, tool, validateTypes, validator, validatorSymbol, withoutTrailingSlash, zodSchema };
+declare const VERSION: string;
+
+export { type AssistantContent, type AssistantModelMessage, type DataContent, type FetchFunction, type FilePart, type FlexibleSchema, type IdGenerator, type ImagePart, type InferSchema, type InferToolInput, type InferToolOutput, type ModelMessage, type ParseResult, type ProviderDefinedToolFactory, type ProviderDefinedToolFactoryWithOutputSchema, type ProviderOptions, type ReasoningPart, type Resolvable, type ResponseHandler, type Schema, type SystemModelMessage, type TextPart, type Tool, type ToolCall, type ToolCallOptions, type ToolCallPart, type ToolContent, type ToolExecuteFunction, type ToolModelMessage, type ToolResult, type ToolResultPart, type UserContent, type UserModelMessage, VERSION, type ValidationResult, type Validator, asSchema, asValidator, combineHeaders, convertAsyncIteratorToReadableStream, convertBase64ToUint8Array, convertToBase64, convertUint8ArrayToBase64, createBinaryResponseHandler, createEventSourceResponseHandler, createIdGenerator, createJsonErrorResponseHandler, createJsonResponseHandler, createJsonStreamResponseHandler, createProviderDefinedToolFactory, createProviderDefinedToolFactoryWithOutputSchema, createStatusCodeErrorResponseHandler, delay, dynamicTool, executeTool, extractResponseHeaders, generateId, getErrorMessage, getFromApi, getRuntimeEnvironmentUserAgent, injectJsonInstructionIntoMessages, isAbortError, isParsableJson, isUrlSupported, isValidator, jsonSchema, loadApiKey, loadOptionalSetting, loadSetting, mediaTypeToExtension, parseJSON, parseJsonEventStream, parseProviderOptions, postFormDataToApi, postJsonToApi, postToApi, removeUndefinedEntries, resolve, safeParseJSON, safeValidateTypes, standardSchemaValidator, tool, validateTypes, validator, validatorSymbol, withUserAgentSuffix, withoutTrailingSlash, zodSchema };

package/dist/index.js

@@ -32,6 +32,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var src_exports = {};
 __export(src_exports, {
   EventSourceParserStream: () => import_stream2.EventSourceParserStream,
+  VERSION: () => VERSION,
   asSchema: () => asSchema,
   asValidator: () => asValidator,
   combineHeaders: () => combineHeaders,
@@ -55,6 +56,7 @@ __export(src_exports, {
   generateId: () => generateId,
   getErrorMessage: () => getErrorMessage,
   getFromApi: () => getFromApi,
+  getRuntimeEnvironmentUserAgent: () => getRuntimeEnvironmentUserAgent,
   injectJsonInstructionIntoMessages: () => injectJsonInstructionIntoMessages,
   isAbortError: () => isAbortError,
   isParsableJson: () => isParsableJson,
@@ -80,6 +82,7 @@ __export(src_exports, {
   validateTypes: () => validateTypes,
   validator: () => validator,
   validatorSymbol: () => validatorSymbol,
+  withUserAgentSuffix: () => withUserAgentSuffix,
   withoutTrailingSlash: () => withoutTrailingSlash,
   zodSchema: () => zodSchema
 });
@@ -160,6 +163,45 @@ function extractResponseHeaders(response) {
   return Object.fromEntries([...response.headers]);
 }
 
+// src/get-runtime-environment-user-agent.ts
+function getRuntimeEnvironmentUserAgent(globalThisAny = globalThis) {
+  var _a, _b, _c;
+  if (globalThisAny.window) {
+    return `runtime/browser`;
+  }
+  if ((_a = globalThisAny.navigator) == null ? void 0 : _a.userAgent) {
+    return `runtime/${globalThisAny.navigator.userAgent.toLowerCase()}`;
+  }
+  if ((_c = (_b = globalThisAny.process) == null ? void 0 : _b.versions) == null ? void 0 : _c.node) {
+    return `runtime/node.js/${globalThisAny.process.version.substring(0)}`;
+  }
+  if (globalThisAny.EdgeRuntime) {
+    return `runtime/vercel-edge`;
+  }
+  return "runtime/unknown";
+}
+
+// src/remove-undefined-entries.ts
+function removeUndefinedEntries(record) {
+  return Object.fromEntries(
+    Object.entries(record).filter(([_key, value]) => value != null)
+  );
+}
+
+// src/with-user-agent-suffix.ts
+function withUserAgentSuffix(headers, ...userAgentSuffixParts) {
+  const cleanedHeaders = removeUndefinedEntries(
+    headers != null ? headers : {}
+  );
+  const normalizedHeaders = new Headers(cleanedHeaders);
+  const currentUserAgentHeader = normalizedHeaders.get("user-agent") || "";
+  normalizedHeaders.set(
+    "user-agent",
+    [currentUserAgentHeader, ...userAgentSuffixParts].filter(Boolean).join(" ")
+  );
+  return Object.fromEntries(normalizedHeaders);
+}
+
 // src/generate-id.ts
 var import_provider = require("@ai-sdk/provider");
 var createIdGenerator = ({
@@ -241,12 +283,8 @@ function handleFetchError({
   return error;
 }
 
-// src/remove-undefined-entries.ts
-function removeUndefinedEntries(record) {
-  return Object.fromEntries(
-    Object.entries(record).filter(([_key, value]) => value != null)
-  );
-}
+// src/version.ts
+var VERSION = true ? "3.0.9" : "0.0.0-test";
 
 // src/get-from-api.ts
 var getOriginalFetch = () => globalThis.fetch;
@@ -261,7 +299,11 @@ var getFromApi = async ({
   try {
     const response = await fetch(url, {
       method: "GET",
-      headers: removeUndefinedEntries(headers),
+      headers: withUserAgentSuffix(
+        headers,
+        `ai-sdk/provider-utils/${VERSION}`,
+        getRuntimeEnvironmentUserAgent()
+      ),
       signal: abortSignal
     });
     const responseHeaders = extractResponseHeaders(response);
@@ -727,7 +769,11 @@ var postToApi = async ({
   try {
     const response = await fetch(url, {
       method: "POST",
-      headers: removeUndefinedEntries(headers),
+      headers: withUserAgentSuffix(
+        headers,
+        `ai-sdk/provider-utils/${VERSION}`,
+        getRuntimeEnvironmentUserAgent()
+      ),
       body: body.content,
       signal: abortSignal
     });
@@ -2327,6 +2373,7 @@ var import_stream2 = require("eventsource-parser/stream");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   EventSourceParserStream,
+  VERSION,
   asSchema,
   asValidator,
   combineHeaders,
@@ -2350,6 +2397,7 @@ var import_stream2 = require("eventsource-parser/stream");
   generateId,
   getErrorMessage,
   getFromApi,
+  getRuntimeEnvironmentUserAgent,
   injectJsonInstructionIntoMessages,
   isAbortError,
   isParsableJson,
@@ -2375,6 +2423,7 @@ var import_stream2 = require("eventsource-parser/stream");
   validateTypes,
   validator,
   validatorSymbol,
+  withUserAgentSuffix,
   withoutTrailingSlash,
   zodSchema,
   ...require("@standard-schema/spec")