@tanstack/ai-vercel-gateway 0.0.1

package/src/adapters/responses-text.ts

@@ -0,0 +1,99 @@
+import OpenAI from 'openai'
+import { OpenAIBaseResponsesTextAdapter } from '@tanstack/openai-base'
+import {
+  getVercelGatewayApiKeyFromEnv,
+  withVercelGatewayDefaults,
+} from '../utils/client'
+import { mapGatewayModelOptions } from '../utils/map-gateway-options'
+import type { Modality, TextOptions } from '@tanstack/ai'
+import type { ResponseCreateParams } from 'openai/resources/responses/responses'
+import type {
+  VERCEL_GATEWAY_CHAT_MODELS,
+  VercelGatewayChatModelToolCapabilitiesByName,
+  ResolveInputModalities,
+  ResolveProviderOptions,
+} from '../model-meta'
+import type { VercelGatewayMessageMetadataByModality } from '../message-types'
+import type { ExternalResponsesProviderOptions } from '../text/responses-provider-options'
+import type { VercelGatewayClientConfig } from '../utils/client'
+
+export interface VercelGatewayResponsesTextConfig extends VercelGatewayClientConfig {}
+
+export type VercelGatewayResponsesTextProviderOptions =
+  ExternalResponsesProviderOptions
+
+type ResolveToolCapabilities<TModel extends string> =
+  TModel extends keyof VercelGatewayChatModelToolCapabilitiesByName
+    ? NonNullable<VercelGatewayChatModelToolCapabilitiesByName[TModel]>
+    : readonly []
+
+/**
+ * Vercel AI Gateway Responses text adapter.
+ *
+ * Talks to the public OpenAI-compatible Responses API at
+ * `https://ai-gateway.vercel.sh/v1`.
+ */
+export class VercelGatewayResponsesTextAdapter<
+  TModel extends (typeof VERCEL_GATEWAY_CHAT_MODELS)[number],
+  TProviderOptions extends Record<string, any> = ResolveProviderOptions<TModel>,
+  TInputModalities extends ReadonlyArray<Modality> =
+    ResolveInputModalities<TModel>,
+  TToolCapabilities extends ReadonlyArray<string> =
+    ResolveToolCapabilities<TModel>,
+> extends OpenAIBaseResponsesTextAdapter<
+  TModel,
+  TProviderOptions,
+  TInputModalities,
+  VercelGatewayMessageMetadataByModality,
+  TToolCapabilities
+> {
+  override readonly kind = 'text' as const
+  override readonly name = 'vercel-gateway' as const
+
+  constructor(config: VercelGatewayResponsesTextConfig, model: TModel) {
+    super(
+      model,
+      'vercel-gateway',
+      new OpenAI(withVercelGatewayDefaults(config)),
+    )
+  }
+
+  protected override mapOptionsToRequest(
+    options: TextOptions<TProviderOptions>,
+  ): Omit<ResponseCreateParams, 'stream'> {
+    const request = super.mapOptionsToRequest({
+      ...options,
+      modelOptions: mapGatewayModelOptions(
+        options.modelOptions as Record<string, unknown> | undefined,
+      ) as TProviderOptions,
+    })
+    const { gateway: _gateway, ...rest } = request as typeof request & {
+      gateway?: unknown
+    }
+    void _gateway
+    return rest
+  }
+}
+
+export function createVercelGatewayResponsesText<
+  TModel extends (typeof VERCEL_GATEWAY_CHAT_MODELS)[number],
+>(
+  model: TModel,
+  apiKey: string,
+  config?: Omit<VercelGatewayResponsesTextConfig, 'apiKey'>,
+): VercelGatewayResponsesTextAdapter<TModel> {
+  return new VercelGatewayResponsesTextAdapter({ apiKey, ...config }, model)
+}
+
+export function vercelGatewayResponsesText<
+  TModel extends (typeof VERCEL_GATEWAY_CHAT_MODELS)[number],
+>(
+  model: TModel,
+  config?: Omit<VercelGatewayResponsesTextConfig, 'apiKey'>,
+): VercelGatewayResponsesTextAdapter<TModel> {
+  return createVercelGatewayResponsesText(
+    model,
+    getVercelGatewayApiKeyFromEnv(),
+    config,
+  )
+}

package/src/adapters/summarize.ts

@@ -0,0 +1,44 @@
+import { ChatStreamSummarizeAdapter } from '@tanstack/ai/adapters'
+import { getVercelGatewayApiKeyFromEnv } from '../utils/client'
+import { VercelGatewayTextAdapter } from './text'
+import type { InferTextProviderOptions } from '@tanstack/ai/adapters'
+import type { VERCEL_GATEWAY_CHAT_MODELS } from '../model-meta'
+import type { VercelGatewayClientConfig } from '../utils/client'
+
+export interface VercelGatewaySummarizeConfig extends VercelGatewayClientConfig {}
+
+export type VercelGatewaySummarizeModel =
+  (typeof VERCEL_GATEWAY_CHAT_MODELS)[number]
+
+export function createVercelGatewaySummarize<
+  TModel extends VercelGatewaySummarizeModel,
+>(
+  model: TModel,
+  apiKey: string,
+  config?: Omit<VercelGatewaySummarizeConfig, 'apiKey'>,
+): ChatStreamSummarizeAdapter<
+  TModel,
+  InferTextProviderOptions<VercelGatewayTextAdapter<TModel>>
+> {
+  return new ChatStreamSummarizeAdapter(
+    new VercelGatewayTextAdapter({ apiKey, ...config }, model),
+    model,
+    'vercel-gateway',
+  )
+}
+
+export function vercelGatewaySummarize<
+  TModel extends VercelGatewaySummarizeModel,
+>(
+  model: TModel,
+  config?: Omit<VercelGatewaySummarizeConfig, 'apiKey'>,
+): ChatStreamSummarizeAdapter<
+  TModel,
+  InferTextProviderOptions<VercelGatewayTextAdapter<TModel>>
+> {
+  return createVercelGatewaySummarize(
+    model,
+    getVercelGatewayApiKeyFromEnv(),
+    config,
+  )
+}

package/src/adapters/text.ts

@@ -0,0 +1,68 @@
+import OpenAI from 'openai'
+import { OpenAIBaseChatCompletionsTextAdapter } from '@tanstack/openai-base'
+import { withVercelGatewayDefaults } from '../utils/client'
+import { mapGatewayModelOptions } from '../utils/map-gateway-options'
+import type { Modality, TextOptions } from '@tanstack/ai'
+import type {
+  VERCEL_GATEWAY_CHAT_MODELS,
+  VercelGatewayChatModelToolCapabilitiesByName,
+  ResolveInputModalities,
+  ResolveProviderOptions,
+} from '../model-meta'
+import type { VercelGatewayMessageMetadataByModality } from '../message-types'
+import type { VercelGatewayClientConfig } from '../utils/client'
+
+type ResolveToolCapabilities<TModel extends string> =
+  TModel extends keyof VercelGatewayChatModelToolCapabilitiesByName
+    ? NonNullable<VercelGatewayChatModelToolCapabilitiesByName[TModel]>
+    : readonly []
+
+export interface VercelGatewayTextConfig extends VercelGatewayClientConfig {}
+
+export type { ExternalTextProviderOptions as VercelGatewayTextProviderOptions } from '../text/text-provider-options'
+
+/**
+ * Vercel AI Gateway text adapter.
+ *
+ * Talks to the public OpenAI-compatible Chat Completions API at
+ * `https://ai-gateway.vercel.sh/v1`.
+ */
+export class VercelGatewayTextAdapter<
+  TModel extends (typeof VERCEL_GATEWAY_CHAT_MODELS)[number],
+  TProviderOptions extends Record<string, any> = ResolveProviderOptions<TModel>,
+  TInputModalities extends ReadonlyArray<Modality> =
+    ResolveInputModalities<TModel>,
+  TToolCapabilities extends ReadonlyArray<string> =
+    ResolveToolCapabilities<TModel>,
+> extends OpenAIBaseChatCompletionsTextAdapter<
+  TModel,
+  TProviderOptions,
+  TInputModalities,
+  VercelGatewayMessageMetadataByModality,
+  TToolCapabilities
+> {
+  override readonly kind = 'text' as const
+  override readonly name = 'vercel-gateway' as const
+
+  constructor(config: VercelGatewayTextConfig, model: TModel) {
+    super(
+      model,
+      'vercel-gateway',
+      new OpenAI(withVercelGatewayDefaults(config)),
+    )
+  }
+
+  protected override mapOptionsToRequest(options: TextOptions) {
+    const request = super.mapOptionsToRequest({
+      ...options,
+      modelOptions: mapGatewayModelOptions(
+        options.modelOptions as Record<string, unknown> | undefined,
+      ) as TextOptions['modelOptions'],
+    })
+    const { gateway: _gateway, ...rest } = request as typeof request & {
+      gateway?: unknown
+    }
+    void _gateway
+    return rest
+  }
+}

package/src/embedding/embedding-provider-options.ts

@@ -0,0 +1,6 @@
+import type { VercelGatewayRoutingOptions } from '../text/text-provider-options'
+
+export interface VercelGatewayEmbeddingProviderOptions {
+  user?: string
+  gateway?: VercelGatewayRoutingOptions
+}

package/src/image/image-provider-options.ts

@@ -0,0 +1,13 @@
+import type { VercelGatewayRoutingOptions } from '../text/text-provider-options'
+
+export interface VercelGatewayImageProviderOptions {
+  quality?: 'standard' | 'hd'
+  style?: 'vivid' | 'natural'
+  gateway?: VercelGatewayRoutingOptions
+}
+
+export type VercelGatewayImageSize =
+  | '1024x1024'
+  | '1536x1024'
+  | '1024x1536'
+  | 'auto'

package/src/index.ts

@@ -0,0 +1,78 @@
+/**
+ * @module @tanstack/ai-vercel-gateway
+ *
+ * Vercel AI Gateway adapter for TanStack AI.
+ */
+
+export {
+  VercelGatewayTextAdapter,
+  type VercelGatewayTextConfig,
+  type VercelGatewayTextProviderOptions,
+} from './adapters/text'
+
+export {
+  createVercelGatewayText,
+  vercelGatewayText,
+  type VercelGatewayTextApi,
+  type VercelGatewayResponsesApiConfig,
+  type VercelGatewayChatApiConfig,
+} from './adapters/factory'
+
+export {
+  VercelGatewayResponsesTextAdapter,
+  createVercelGatewayResponsesText,
+  vercelGatewayResponsesText,
+  type VercelGatewayResponsesTextConfig,
+  type VercelGatewayResponsesTextProviderOptions,
+} from './adapters/responses-text'
+
+export {
+  createVercelGatewaySummarize,
+  vercelGatewaySummarize,
+  type VercelGatewaySummarizeConfig,
+  type VercelGatewaySummarizeModel,
+} from './adapters/summarize'
+
+export {
+  VercelGatewayEmbeddingAdapter,
+  createVercelGatewayEmbedding,
+  vercelGatewayEmbedding,
+  type VercelGatewayEmbeddingConfig,
+} from './adapters/embedding'
+
+export {
+  VercelGatewayImageAdapter,
+  createVercelGatewayImage,
+  vercelGatewayImage,
+  type VercelGatewayImageConfig,
+} from './adapters/image'
+
+export type { VercelGatewayEmbeddingProviderOptions } from './embedding/embedding-provider-options'
+export type { VercelGatewayImageProviderOptions } from './image/image-provider-options'
+export type {
+  VercelGatewayBaseOptions,
+  VercelGatewayCommonOptions,
+  VercelGatewayRoutingOptions,
+} from './text/text-provider-options'
+
+export {
+  VERCEL_GATEWAY_CHAT_MODELS,
+  VERCEL_GATEWAY_EMBEDDING_MODELS,
+  VERCEL_GATEWAY_IMAGE_MODELS,
+  VERCEL_GATEWAY_MODEL_TAGS,
+  VERCEL_GATEWAY_PROVIDERS,
+} from './model-meta'
+export type {
+  VercelGatewayChatModel,
+  VercelGatewayChatModelProviderOptionsByName,
+  VercelGatewayEmbeddingModel,
+  VercelGatewayImageModel,
+  VercelGatewayModelInputModalitiesByName,
+  VercelGatewayModelTag,
+  VercelGatewayProvider,
+} from './model-meta'
+
+export {
+  getVercelGatewayApiKeyFromEnv,
+  type VercelGatewayClientConfig,
+} from './utils/client'

package/src/message-types.ts

@@ -0,0 +1,45 @@
+/**
+ * Metadata for Vercel AI Gateway document content parts.
+ */
+export interface VercelGatewayDocumentMetadata {}
+
+/**
+ * Metadata for Vercel AI Gateway text content parts.
+ */
+export interface VercelGatewayTextMetadata {}
+
+/**
+ * Metadata for Vercel AI Gateway image content parts.
+ */
+export interface VercelGatewayImageMetadata {
+  /**
+   * Specifies the detail level of the image.
+   * - 'auto': Let the model decide based on image size and content
+   * - 'low': Use low resolution processing (faster, cheaper, less detail)
+   * - 'high': Use high resolution processing (slower, more expensive, more detail)
+   *
+   * @default 'auto'
+   */
+  detail?: 'auto' | 'low' | 'high'
+}
+
+/**
+ * Metadata for Vercel AI Gateway audio content parts.
+ */
+export interface VercelGatewayAudioMetadata {}
+
+/**
+ * Metadata for Vercel AI Gateway video content parts.
+ */
+export interface VercelGatewayVideoMetadata {}
+
+/**
+ * Map of modality types to their Vercel AI Gateway metadata types.
+ */
+export interface VercelGatewayMessageMetadataByModality {
+  text: VercelGatewayTextMetadata
+  image: VercelGatewayImageMetadata
+  audio: VercelGatewayAudioMetadata
+  video: VercelGatewayVideoMetadata
+  document: VercelGatewayDocumentMetadata
+}