@tanstack/openai-base 0.1.0

package/dist/esm/adapters/image.js

@@ -0,0 +1,69 @@
+import { BaseImageAdapter } from "@tanstack/ai/adapters";
+import { generateId } from "@tanstack/ai-utils";
+import { createOpenAICompatibleClient } from "../utils/client.js";
+class OpenAICompatibleImageAdapter extends BaseImageAdapter {
+  constructor(config, model, name = "openai-compatible") {
+    super({}, model);
+    this.kind = "image";
+    this.name = name;
+    this.client = createOpenAICompatibleClient(config);
+  }
+  async generateImages(options) {
+    const { model, prompt, numberOfImages, size } = options;
+    this.validatePrompt({ prompt, model });
+    this.validateImageSize(model, size);
+    this.validateNumberOfImages(model, numberOfImages);
+    const request = this.buildRequest(options);
+    const response = await this.client.images.generate({
+      ...request,
+      stream: false
+    });
+    return this.transformResponse(model, response);
+  }
+  buildRequest(options) {
+    const { model, prompt, numberOfImages, size, modelOptions } = options;
+    return {
+      model,
+      prompt,
+      n: numberOfImages ?? 1,
+      size,
+      ...modelOptions
+    };
+  }
+  transformResponse(model, response) {
+    const images = (response.data ?? []).map((item) => ({
+      b64Json: item.b64_json,
+      url: item.url,
+      revisedPrompt: item.revised_prompt
+    }));
+    return {
+      id: generateId(this.name),
+      model,
+      images,
+      usage: response.usage ? {
+        inputTokens: response.usage.input_tokens,
+        outputTokens: response.usage.output_tokens,
+        totalTokens: response.usage.total_tokens
+      } : void 0
+    };
+  }
+  validatePrompt(options) {
+    if (options.prompt.length === 0) {
+      throw new Error("Prompt cannot be empty.");
+    }
+  }
+  validateImageSize(_model, _size) {
+  }
+  validateNumberOfImages(_model, numberOfImages) {
+    if (numberOfImages === void 0) return;
+    if (numberOfImages < 1 || numberOfImages > 10) {
+      throw new Error(
+        `Number of images must be between 1 and 10. Requested: ${numberOfImages}`
+      );
+    }
+  }
+}
+export {
+  OpenAICompatibleImageAdapter
+};
+//# sourceMappingURL=image.js.map

package/dist/esm/adapters/image.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"image.js","sources":["../../../src/adapters/image.ts"],"sourcesContent":["import { BaseImageAdapter } from '@tanstack/ai/adapters'\nimport { generateId } from '@tanstack/ai-utils'\nimport { createOpenAICompatibleClient } from '../utils/client'\nimport type {\n  GeneratedImage,\n  ImageGenerationOptions,\n  ImageGenerationResult,\n} from '@tanstack/ai'\nimport type OpenAI_SDK from 'openai'\nimport type { OpenAICompatibleClientConfig } from '../types/config'\n\n/**\n * OpenAI-Compatible Image Generation Adapter\n *\n * A generalized base class for providers that implement OpenAI-compatible image\n * generation APIs. Providers like OpenAI, Grok, and others can extend this class\n * and only need to:\n * - Set `baseURL` in the config\n * - Lock the generic type parameters to provider-specific types\n * - Override validation or request building methods for provider-specific constraints\n *\n * All methods that validate inputs, build requests, or transform responses are\n * `protected` so subclasses can override them.\n */\nexport class OpenAICompatibleImageAdapter<\n  TModel extends string,\n  TProviderOptions extends object = Record<string, any>,\n  TModelProviderOptionsByName extends Record<string, any> = Record<string, any>,\n  TModelSizeByName extends Record<string, string> = Record<string, string>,\n> extends BaseImageAdapter<\n  TModel,\n  TProviderOptions,\n  TModelProviderOptionsByName,\n  TModelSizeByName\n> {\n  readonly kind = 'image' as const\n  readonly name: string\n\n  protected client: OpenAI_SDK\n\n  constructor(\n    config: OpenAICompatibleClientConfig,\n    model: TModel,\n    name: string = 'openai-compatible',\n  ) {\n    super({}, model)\n    this.name = name\n    this.client = createOpenAICompatibleClient(config)\n  }\n\n  async generateImages(\n    options: ImageGenerationOptions<TProviderOptions>,\n  ): Promise<ImageGenerationResult> {\n    const { model, prompt, numberOfImages, size } = options\n\n    // Validate inputs\n    this.validatePrompt({ prompt, model })\n    this.validateImageSize(model, size)\n    this.validateNumberOfImages(model, numberOfImages)\n\n    // Build request based on model type\n    const request = this.buildRequest(options)\n\n    const response = await this.client.images.generate({\n      ...request,\n      stream: false,\n    })\n\n    return this.transformResponse(model, response)\n  }\n\n  protected buildRequest(\n    options: ImageGenerationOptions<TProviderOptions>,\n  ): OpenAI_SDK.Images.ImageGenerateParams {\n    const { model, prompt, numberOfImages, size, modelOptions } = options\n\n    return {\n      model,\n      prompt,\n      n: numberOfImages ?? 1,\n      size: size as OpenAI_SDK.Images.ImageGenerateParams['size'],\n      ...modelOptions,\n    }\n  }\n\n  protected transformResponse(\n    model: string,\n    response: OpenAI_SDK.Images.ImagesResponse,\n  ): ImageGenerationResult {\n    const images: Array<GeneratedImage> = (response.data ?? []).map((item) => ({\n      b64Json: item.b64_json,\n      url: item.url,\n      revisedPrompt: item.revised_prompt,\n    }))\n\n    return {\n      id: generateId(this.name),\n      model,\n      images,\n      usage: response.usage\n        ? {\n            inputTokens: response.usage.input_tokens,\n            outputTokens: response.usage.output_tokens,\n            totalTokens: response.usage.total_tokens,\n          }\n        : undefined,\n    }\n  }\n\n  protected validatePrompt(options: { prompt: string; model: string }): void {\n    if (options.prompt.length === 0) {\n      throw new Error('Prompt cannot be empty.')\n    }\n  }\n\n  protected validateImageSize(_model: string, _size: string | undefined): void {\n    // Default: no size validation — subclasses can override\n  }\n\n  protected validateNumberOfImages(\n    _model: string,\n    numberOfImages: number | undefined,\n  ): void {\n    if (numberOfImages === undefined) return\n\n    if (numberOfImages < 1 || numberOfImages > 10) {\n      throw new Error(\n        `Number of images must be between 1 and 10. Requested: ${numberOfImages}`,\n      )\n    }\n  }\n}\n"],"names":[],"mappings":";;;AAwBO,MAAM,qCAKH,iBAKR;AAAA,EAMA,YACE,QACA,OACA,OAAe,qBACf;AACA,UAAM,CAAA,GAAI,KAAK;AAVjB,SAAS,OAAO;AAWd,SAAK,OAAO;AACZ,SAAK,SAAS,6BAA6B,MAAM;AAAA,EACnD;AAAA,EAEA,MAAM,eACJ,SACgC;AAChC,UAAM,EAAE,OAAO,QAAQ,gBAAgB,SAAS;AAGhD,SAAK,eAAe,EAAE,QAAQ,MAAA,CAAO;AACrC,SAAK,kBAAkB,OAAO,IAAI;AAClC,SAAK,uBAAuB,OAAO,cAAc;AAGjD,UAAM,UAAU,KAAK,aAAa,OAAO;AAEzC,UAAM,WAAW,MAAM,KAAK,OAAO,OAAO,SAAS;AAAA,MACjD,GAAG;AAAA,MACH,QAAQ;AAAA,IAAA,CACT;AAED,WAAO,KAAK,kBAAkB,OAAO,QAAQ;AAAA,EAC/C;AAAA,EAEU,aACR,SACuC;AACvC,UAAM,EAAE,OAAO,QAAQ,gBAAgB,MAAM,iBAAiB;AAE9D,WAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA,GAAG,kBAAkB;AAAA,MACrB;AAAA,MACA,GAAG;AAAA,IAAA;AAAA,EAEP;AAAA,EAEU,kBACR,OACA,UACuB;AACvB,UAAM,UAAiC,SAAS,QAAQ,CAAA,GAAI,IAAI,CAAC,UAAU;AAAA,MACzE,SAAS,KAAK;AAAA,MACd,KAAK,KAAK;AAAA,MACV,eAAe,KAAK;AAAA,IAAA,EACpB;AAEF,WAAO;AAAA,MACL,IAAI,WAAW,KAAK,IAAI;AAAA,MACxB;AAAA,MACA;AAAA,MACA,OAAO,SAAS,QACZ;AAAA,QACE,aAAa,SAAS,MAAM;AAAA,QAC5B,cAAc,SAAS,MAAM;AAAA,QAC7B,aAAa,SAAS,MAAM;AAAA,MAAA,IAE9B;AAAA,IAAA;AAAA,EAER;AAAA,EAEU,eAAe,SAAkD;AACzE,QAAI,QAAQ,OAAO,WAAW,GAAG;AAC/B,YAAM,IAAI,MAAM,yBAAyB;AAAA,IAC3C;AAAA,EACF;AAAA,EAEU,kBAAkB,QAAgB,OAAiC;AAAA,EAE7E;AAAA,EAEU,uBACR,QACA,gBACM;AACN,QAAI,mBAAmB,OAAW;AAElC,QAAI,iBAAiB,KAAK,iBAAiB,IAAI;AAC7C,YAAM,IAAI;AAAA,QACR,yDAAyD,cAAc;AAAA,MAAA;AAAA,IAE3E;AAAA,EACF;AACF;"}

package/dist/esm/adapters/responses-text.d.ts

@@ -0,0 +1,115 @@
+import { BaseTextAdapter, StructuredOutputOptions, StructuredOutputResult } from '@tanstack/ai/adapters';
+import { default as OpenAI_SDK } from 'openai';
+import { Responses } from 'openai/resources';
+import { ContentPart, DefaultMessageMetadataByModality, Modality, ModelMessage, StreamChunk, TextOptions } from '@tanstack/ai';
+import { OpenAICompatibleClientConfig } from '../types/config.js';
+/**
+ * OpenAI-compatible Responses API Text Adapter
+ *
+ * A generalized base class for providers that use the OpenAI Responses API
+ * (`/v1/responses`). Providers like OpenAI (native), Azure OpenAI, and others
+ * that implement the Responses API can extend this class and only need to:
+ * - Set `baseURL` in the config
+ * - Lock the generic type parameters to provider-specific types
+ * - Override specific methods for quirks
+ *
+ * Key differences from the Chat Completions adapter:
+ * - Uses `client.responses.create()` instead of `client.chat.completions.create()`
+ * - Messages use `ResponseInput` format
+ * - System prompts go in `instructions` field, not as array messages
+ * - Streaming events are completely different (9+ event types vs simple delta chunks)
+ * - Supports reasoning/thinking tokens via `response.reasoning_text.delta`
+ * - Structured output uses `text.format` in the request (not `response_format`)
+ * - Tool calls use `response.function_call_arguments.delta`
+ * - Content parts are `input_text`, `input_image`, `input_file`
+ *
+ * All methods that build requests or process responses are `protected` so subclasses
+ * can override them.
+ */
+export declare class OpenAICompatibleResponsesTextAdapter<TModel extends string, TProviderOptions extends Record<string, any> = Record<string, any>, TInputModalities extends ReadonlyArray<Modality> = ReadonlyArray<Modality>, TMessageMetadata extends DefaultMessageMetadataByModality = DefaultMessageMetadataByModality> extends BaseTextAdapter<TModel, TProviderOptions, TInputModalities, TMessageMetadata> {
+    readonly kind: "text";
+    readonly name: string;
+    protected client: OpenAI_SDK;
+    constructor(config: OpenAICompatibleClientConfig, model: TModel, name?: string);
+    chatStream(options: TextOptions<TProviderOptions>): AsyncIterable<StreamChunk>;
+    /**
+     * Generate structured output using the provider's native JSON Schema response format.
+     * Uses stream: false to get the complete response in one call.
+     *
+     * OpenAI-compatible Responses APIs have strict requirements for structured output:
+     * - All properties must be in the `required` array
+     * - Optional fields should have null added to their type union
+     * - additionalProperties must be false for all objects
+     *
+     * The outputSchema is already JSON Schema (converted in the ai layer).
+     * We apply provider-specific transformations for structured output compatibility.
+     */
+    structuredOutput(options: StructuredOutputOptions<TProviderOptions>): Promise<StructuredOutputResult<unknown>>;
+    /**
+     * Applies provider-specific transformations for structured output compatibility.
+     * Override this in subclasses to handle provider-specific quirks.
+     */
+    protected makeStructuredOutputCompatible(schema: Record<string, any>, originalRequired: Array<string>): Record<string, any>;
+    /**
+     * Extract text content from a non-streaming Responses API response.
+     * Override this in subclasses for provider-specific response shapes.
+     */
+    protected extractTextFromResponse(response: OpenAI_SDK.Responses.Response): string;
+    /**
+     * Processes streamed chunks from the Responses API and yields AG-UI events.
+     * Override this in subclasses to handle provider-specific stream behavior.
+     *
+     * Handles the following event types:
+     * - response.created / response.incomplete / response.failed
+     * - response.output_text.delta
+     * - response.reasoning_text.delta
+     * - response.reasoning_summary_text.delta
+     * - response.content_part.added / response.content_part.done
+     * - response.output_item.added
+     * - response.function_call_arguments.delta / response.function_call_arguments.done
+     * - response.completed
+     * - error
+     */
+    protected processStreamChunks(stream: AsyncIterable<OpenAI_SDK.Responses.ResponseStreamEvent>, toolCallMetadata: Map<string, {
+        index: number;
+        name: string;
+        callId: string;
+        started: boolean;
+    }>, options: TextOptions, aguiState: {
+        runId: string;
+        messageId: string;
+        timestamp: number;
+        hasEmittedRunStarted: boolean;
+    }): AsyncIterable<StreamChunk>;
+    /**
+     * Maps common TextOptions to Responses API request format.
+     * Override this in subclasses to add provider-specific options.
+     */
+    protected mapOptionsToRequest(options: TextOptions): Omit<OpenAI_SDK.Responses.ResponseCreateParams, 'stream'>;
+    /**
+     * Converts ModelMessage[] to Responses API ResponseInput format.
+     * Override this in subclasses for provider-specific message format quirks.
+     *
+     * Key differences from Chat Completions:
+     * - Tool results use `function_call_output` type (not `tool` role)
+     * - Assistant tool calls are `function_call` objects (not nested in `tool_calls`)
+     * - User content uses `input_text`, `input_image`, `input_file` types
+     * - System prompts go in `instructions`, not as messages
+     */
+    protected convertMessagesToInput(messages: Array<ModelMessage>): Responses.ResponseInput;
+    /**
+     * Converts a ContentPart to Responses API input content item.
+     * Handles text, image, and audio content parts.
+     * Override this in subclasses for additional content types or provider-specific metadata.
+     */
+    protected convertContentPartToInput(part: ContentPart): Responses.ResponseInputContent;
+    /**
+     * Normalizes message content to an array of ContentPart.
+     * Handles backward compatibility with string content.
+     */
+    protected normalizeContent(content: string | null | Array<ContentPart>): Array<ContentPart>;
+    /**
+     * Extracts text content from a content value that may be string, null, or ContentPart array.
+     */
+    protected extractTextContent(content: string | null | Array<ContentPart>): string;
+}