@ai-sdk/openai-compatible 3.0.59 → 3.0.60

package/dist/internal/index.d.ts

@@ -1,216 +1,224 @@
-import * as _ai_sdk_provider from '@ai-sdk/provider';
-import { JSONValue, LanguageModelV4Prompt, LanguageModelV4Usage, LanguageModelV4FinishReason, LanguageModelV4CallOptions, SharedV4Warning, SharedV4ProviderMetadata, LanguageModelV4 } from '@ai-sdk/provider';
-import { FetchFunction } from '@ai-sdk/provider-utils';
-import { ZodType, z } from 'zod/v4';
-
+import { JSONValue, LanguageModelV4, LanguageModelV4CallOptions, LanguageModelV4FinishReason, LanguageModelV4Prompt, LanguageModelV4Usage, SharedV4ProviderMetadata, SharedV4Warning } from "@ai-sdk/provider";
+import { FetchFunction } from "@ai-sdk/provider-utils";
+import { ZodType, z } from "zod/v4";
+//#region src/chat/openai-compatible-api-types.d.ts
 type OpenAICompatibleChatPrompt = Array<OpenAICompatibleMessage>;
 type OpenAICompatibleMessage = OpenAICompatibleSystemMessage | OpenAICompatibleUserMessage | OpenAICompatibleAssistantMessage | OpenAICompatibleToolMessage;
 type JsonRecord<T = never> = Record<string, JSONValue | JSONValue[] | T | T[] | undefined>;
 interface OpenAICompatibleSystemMessage extends JsonRecord {
-    role: 'system';
-    content: string;
+  role: 'system';
+  content: string;
 }
 interface OpenAICompatibleUserMessage extends JsonRecord<OpenAICompatibleContentPart> {
-    role: 'user';
-    content: string | Array<OpenAICompatibleContentPart>;
+  role: 'user';
+  content: string | Array<OpenAICompatibleContentPart>;
 }
 type OpenAICompatibleContentPart = OpenAICompatibleContentPartText | OpenAICompatibleContentPartImage | OpenAICompatibleContentPartVideo | OpenAICompatibleContentPartInputAudio | OpenAICompatibleContentPartFile;
 interface OpenAICompatibleContentPartText extends JsonRecord {
-    type: 'text';
-    text: string;
+  type: 'text';
+  text: string;
 }
 interface OpenAICompatibleContentPartImage extends JsonRecord {
-    type: 'image_url';
-    image_url: {
-        url: string;
-    };
+  type: 'image_url';
+  image_url: {
+    url: string;
+  };
 }
 interface OpenAICompatibleContentPartVideo extends JsonRecord {
-    type: 'video_url';
-    video_url: {
-        url: string;
-    };
+  type: 'video_url';
+  video_url: {
+    url: string;
+  };
 }
 interface OpenAICompatibleContentPartInputAudio extends JsonRecord {
-    type: 'input_audio';
-    input_audio: {
-        data: string;
-        format: 'wav' | 'mp3';
-    };
+  type: 'input_audio';
+  input_audio: {
+    data: string;
+    format: 'wav' | 'mp3';
+  };
 }
 interface OpenAICompatibleContentPartFile extends JsonRecord {
-    type: 'file';
-    file: {
-        filename: string;
-        file_data: string;
-    };
+  type: 'file';
+  file: {
+    filename: string;
+    file_data: string;
+  };
 }
 interface OpenAICompatibleAssistantMessage extends JsonRecord<OpenAICompatibleMessageToolCall> {
-    role: 'assistant';
-    content?: string | null;
-    reasoning_content?: string;
-    tool_calls?: Array<OpenAICompatibleMessageToolCall>;
+  role: 'assistant';
+  content?: string | null;
+  reasoning_content?: string;
+  tool_calls?: Array<OpenAICompatibleMessageToolCall>;
 }
 interface OpenAICompatibleMessageToolCall extends JsonRecord {
-    type: 'function';
-    id: string;
-    function: {
-        arguments: string;
-        name: string;
-    };
-    /**
-     * Additional content for provider-specific features.
-     * Used by Google Gemini for thought signatures via OpenAI compatibility.
-     */
-    extra_content?: {
-        google?: {
-            thought_signature?: string;
-        };
+  type: 'function';
+  id: string;
+  function: {
+    arguments: string;
+    name: string;
+  };
+  /**
+   * Additional content for provider-specific features.
+   * Used by Google Gemini for thought signatures via OpenAI compatibility.
+   */
+  extra_content?: {
+    google?: {
+      thought_signature?: string;
     };
+  };
 }
 interface OpenAICompatibleToolMessage extends JsonRecord {
-    role: 'tool';
-    content: string;
-    tool_call_id: string;
+  role: 'tool';
+  content: string;
+  tool_call_id: string;
 }
-
-declare function convertToOpenAICompatibleChatMessages(prompt: LanguageModelV4Prompt, { providerOptionsKey }?: {
-    providerOptionsKey?: string;
+//#endregion
+//#region src/chat/convert-to-openai-compatible-chat-messages.d.ts
+export declare function convertToOpenAICompatibleChatMessages(prompt: LanguageModelV4Prompt, { providerOptionsKey }?: {
+  providerOptionsKey?: string;
 }): OpenAICompatibleChatPrompt;
-
-declare function convertOpenAICompatibleChatUsage(usage: {
-    prompt_tokens?: number | null;
-    completion_tokens?: number | null;
-    prompt_tokens_details?: {
-        cached_tokens?: number | null;
-    } | null;
-    completion_tokens_details?: {
-        reasoning_tokens?: number | null;
-    } | null;
+//#endregion
+//#region src/chat/convert-openai-compatible-chat-usage.d.ts
+export declare function convertOpenAICompatibleChatUsage(usage: {
+  prompt_tokens?: number | null;
+  completion_tokens?: number | null;
+  prompt_tokens_details?: {
+    cached_tokens?: number | null;
+  } | null;
+  completion_tokens_details?: {
+    reasoning_tokens?: number | null;
+  } | null;
 } | undefined | null): LanguageModelV4Usage;
-
-declare function mapOpenAICompatibleFinishReason(finishReason: string | null | undefined): LanguageModelV4FinishReason['unified'];
-
-declare function getResponseMetadata({ id, model, created, }: {
-    id?: string | null;
-    model?: string | null;
-    created?: number | null;
-}): _ai_sdk_provider.LanguageModelV4ResponseMetadata;
-
-declare function prepareTools({ tools, toolChoice, }: {
-    tools: LanguageModelV4CallOptions['tools'];
-    toolChoice?: LanguageModelV4CallOptions['toolChoice'];
+//#endregion
+//#region src/chat/map-openai-compatible-finish-reason.d.ts
+export declare function mapOpenAICompatibleFinishReason(finishReason: string | null | undefined): LanguageModelV4FinishReason['unified'];
+//#endregion
+//#region src/chat/get-response-metadata.d.ts
+export declare function getResponseMetadata({ id, model, created }: {
+  id?: string | null;
+  model?: string | null;
+  created?: number | null;
+}): import("@ai-sdk/provider").LanguageModelV4ResponseMetadata;
+//#endregion
+//#region src/chat/openai-compatible-prepare-tools.d.ts
+export declare function prepareTools({ tools, toolChoice }: {
+  tools: LanguageModelV4CallOptions['tools'];
+  toolChoice?: LanguageModelV4CallOptions['toolChoice'];
 }): {
-    tools: undefined | Array<{
-        type: 'function';
-        function: {
-            name: string;
-            description: string | undefined;
-            parameters: unknown;
-            strict?: boolean;
-        };
-    }>;
-    toolChoice: {
-        type: 'function';
-        function: {
-            name: string;
-        };
-    } | 'auto' | 'none' | 'required' | undefined;
-    toolWarnings: SharedV4Warning[];
+  tools: undefined | Array<{
+    type: 'function';
+    function: {
+      name: string;
+      description: string | undefined;
+      parameters: unknown;
+      strict?: boolean;
+    };
+  }>;
+  toolChoice: {
+    type: 'function';
+    function: {
+      name: string;
+    };
+  } | 'auto' | 'none' | 'required' | undefined;
+  toolWarnings: SharedV4Warning[];
 };
-
+//#endregion
+//#region src/openai-compatible-error.d.ts
 type ProviderErrorStructure<T> = {
-    errorSchema: ZodType<T>;
-    errorToMessage: (error: T) => string;
-    isRetryable?: (response: Response, error?: T) => boolean;
+  errorSchema: ZodType<T>;
+  errorToMessage: (error: T) => string;
+  isRetryable?: (response: Response, error?: T) => boolean;
 };
-
+//#endregion
+//#region src/chat/openai-compatible-metadata-extractor.d.ts
 /**
  * Extracts provider-specific metadata from API responses.
  * Used to standardize metadata handling across different LLM providers while allowing
  * provider-specific metadata to be captured.
  */
 type MetadataExtractor = {
+  /**
+   * Extracts provider metadata from a complete, non-streaming response.
+   *
+   * @param parsedBody - The parsed response JSON body from the provider's API.
+   *
+   * @returns Provider-specific metadata or undefined if no metadata is available.
+   *          The metadata should be under a key indicating the provider id.
+   */
+  extractMetadata: ({ parsedBody }: {
+    parsedBody: unknown;
+  }) => Promise<SharedV4ProviderMetadata | undefined>;
+  /**
+   * Creates an extractor for handling streaming responses. The returned object provides
+   * methods to process individual chunks and build the final metadata from the accumulated
+   * stream data.
+   *
+   * @returns An object with methods to process chunks and build metadata from a stream
+   */
+  createStreamExtractor: () => {
     /**
-     * Extracts provider metadata from a complete, non-streaming response.
+     * Process an individual chunk from the stream. Called for each chunk in the response stream
+     * to accumulate metadata throughout the streaming process.
      *
-     * @param parsedBody - The parsed response JSON body from the provider's API.
-     *
-     * @returns Provider-specific metadata or undefined if no metadata is available.
-     *          The metadata should be under a key indicating the provider id.
+     * @param parsedChunk - The parsed JSON response chunk from the provider's API
      */
-    extractMetadata: ({ parsedBody, }: {
-        parsedBody: unknown;
-    }) => Promise<SharedV4ProviderMetadata | undefined>;
+    processChunk(parsedChunk: unknown): void;
     /**
-     * Creates an extractor for handling streaming responses. The returned object provides
-     * methods to process individual chunks and build the final metadata from the accumulated
-     * stream data.
+     * Builds the metadata object after all chunks have been processed.
+     * Called at the end of the stream to generate the complete provider metadata.
      *
-     * @returns An object with methods to process chunks and build metadata from a stream
+     * @returns Provider-specific metadata or undefined if no metadata is available.
+     *          The metadata should be under a key indicating the provider id.
      */
-    createStreamExtractor: () => {
-        /**
-         * Process an individual chunk from the stream. Called for each chunk in the response stream
-         * to accumulate metadata throughout the streaming process.
-         *
-         * @param parsedChunk - The parsed JSON response chunk from the provider's API
-         */
-        processChunk(parsedChunk: unknown): void;
-        /**
-         * Builds the metadata object after all chunks have been processed.
-         * Called at the end of the stream to generate the complete provider metadata.
-         *
-         * @returns Provider-specific metadata or undefined if no metadata is available.
-         *          The metadata should be under a key indicating the provider id.
-         */
-        buildMetadata(): SharedV4ProviderMetadata | undefined;
-    };
+    buildMetadata(): SharedV4ProviderMetadata | undefined;
+  };
 };
-
+//#endregion
+//#region src/chat/openai-compatible-chat-language-model.d.ts
 type OpenAICompatibleChatConfig = {
-    provider: string;
-    headers?: () => Record<string, string | undefined>;
-    url: (options: {
-        modelId: string;
-        path: string;
-    }) => string;
-    fetch?: FetchFunction;
-    includeUsage?: boolean;
-    errorStructure?: ProviderErrorStructure<any>;
-    metadataExtractor?: MetadataExtractor;
-    /**
-     * Whether the model supports structured outputs.
-     */
-    supportsStructuredOutputs?: boolean;
-    /**
-     * The supported URLs for the model.
-     */
-    supportedUrls?: () => LanguageModelV4['supportedUrls'];
-    /**
-     * Optional function to transform the request body before sending it to the API.
-     * This is useful for proxy providers that may require a different request format
-     * than the official OpenAI API.
-     */
-    transformRequestBody?: (args: Record<string, any>) => Record<string, any>;
-    /**
-     * Optional usage converter for OpenAI-compatible providers with different
-     * token accounting semantics.
-     */
-    convertUsage?: (usage: z.infer<typeof openaiCompatibleTokenUsageSchema>) => LanguageModelV4Usage;
+  provider: string;
+  headers?: () => Record<string, string | undefined>;
+  url: (options: {
+    modelId: string;
+    path: string;
+  }) => string;
+  fetch?: FetchFunction;
+  includeUsage?: boolean;
+  errorStructure?: ProviderErrorStructure<any>;
+  metadataExtractor?: MetadataExtractor;
+  /**
+   * Whether the model supports structured outputs.
+   */
+  supportsStructuredOutputs?: boolean;
+  /**
+   * The supported URLs for the model.
+   */
+  supportedUrls?: () => LanguageModelV4['supportedUrls'];
+  /**
+   * Optional function to transform the request body before sending it to the API.
+   * This is useful for proxy providers that may require a different request format
+   * than the official OpenAI API.
+   */
+  transformRequestBody?: (args: Record<string, any>) => Record<string, any>;
+  /**
+   * Optional usage converter for OpenAI-compatible providers with different
+   * token accounting semantics.
+   */
+  convertUsage?: (usage: z.infer<typeof openaiCompatibleTokenUsageSchema>) => LanguageModelV4Usage;
 };
 declare const openaiCompatibleTokenUsageSchema: z.ZodOptional<z.ZodNullable<z.ZodObject<{
-    prompt_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
-    completion_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
-    total_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
-    prompt_tokens_details: z.ZodOptional<z.ZodNullable<z.ZodObject<{
-        cached_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
-    }, z.core.$loose>>>;
-    completion_tokens_details: z.ZodOptional<z.ZodNullable<z.ZodObject<{
-        reasoning_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
-        accepted_prediction_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
-        rejected_prediction_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
-    }, z.core.$loose>>>;
+  prompt_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+  completion_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+  total_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+  prompt_tokens_details: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+    cached_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+  }, z.core.$loose>>>;
+  completion_tokens_details: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+    reasoning_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    accepted_prediction_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    rejected_prediction_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+  }, z.core.$loose>>>;
 }, z.core.$loose>>>;
-
-export { type OpenAICompatibleChatConfig, convertOpenAICompatibleChatUsage, convertToOpenAICompatibleChatMessages, getResponseMetadata, mapOpenAICompatibleFinishReason, prepareTools };
+//#endregion
+export type { OpenAICompatibleChatConfig };
+//# sourceMappingURL=index.d.ts.map

package/dist/internal/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../../src/chat/openai-compatible-api-types.ts","../../src/chat/convert-to-openai-compatible-chat-messages.ts","../../src/chat/convert-openai-compatible-chat-usage.ts","../../src/chat/map-openai-compatible-finish-reason.ts","../../src/chat/get-response-metadata.ts","../../src/chat/openai-compatible-prepare-tools.ts","../../src/openai-compatible-error.ts","../../src/chat/openai-compatible-metadata-extractor.ts","../../src/chat/openai-compatible-chat-language-model.ts"],"mappings":";;;;KAEY,6BAA6B,MAAM;KAEnC,0BACR,gCACA,8BACA,mCACA;KAIC,WAAW,aAAa,eAE3B,YAAY,cAAc,IAAI;UAGf,sCAAsC;EACrD;EACA;;UAGe,oCAAoC,WAAW;EAC9D;EACA,kBAAkB,MAAM;;KAGd,8BACR,kCACA,mCACA,mCACA,wCACA;UAEa,wCAAwC;EACvD;EACA;;UAGe,yCAAyC;EACxD;EACA;IAAa;;;UAIE,yCAAyC;EACxD;EACA;IAAa;;;UAIE,8CAA8C;EAC7D;EACA;IAAe;IAAc;;;UAId,wCAAwC;EACvD;EACA;IAAQ;IAAkB;;;UAGX,yCAAyC,WAAW;EACnE;EACA;EACA;EACA,aAAa,MAAM;;UAGJ,wCAAwC;EACvD;EACA;EACA;IACE;IACA;;;;;;EAMF;IACE;MACE;;;;UAKW,oCAAoC;EACnD;EACA;EACA;;;;wBC3Dc,sCACd,QAAQ,yBACN;EAAmC;IACpC;;;wBC/Ba,iCACd;EAEM;EACA;EACA;IACE;;EAEF;IACE;;uBAKP;;;wBCfa,gCACd,0CACC;;;wBCFa,sBACd,IACA,OACA;EAEA;EACA;EACA;+BACD;;;wBCLe,eACd,OACA;EAEA,OAAO;EACP,aAAa;;EAEb,mBAEI;IACE;IACA;MACE;MACA;MACA;MACA;;;EAGR;IACM;IAAkB;MAAY;;;EAKpC,cAAc;;;;KCXJ,uBAAuB;EACjC,aAAa,QAAQ;EACrB,iBAAiB,OAAO;EACxB,eAAe,UAAU,UAAU,QAAQ;;;;;;;;;KCdjC;;;;;;;;;EASV,oBACE;IAEA;QACI,QAAQ;;;;;;;;EASd;;;;;;;IAOE,aAAa;;;;;;;;IASb,iBAAiB;;;;;KCgBT;EACV;EACA,gBAAgB;EAChB,MAAM;IAAW;IAAiB;;EAClC,QAAQ;EACR;EACA,iBAAiB;EACjB,oBAAoB;;;;EAKpB;;;;EAKA,sBAAsB;;;;;;EAOtB,wBAAwB,MAAM,wBAAwB;;;;;EAMtD,gBACE,OAAO,EAAE,aAAa,sCACnB;;cAqqBD,kCAAgC,EAAA,YAAA,EAAA,YAAA,EAAA;;;;;;;;;;;;GAkB1B,EAAA,KAAA"}