@tanstack/ai 0.0.1 → 0.0.2

package/README.md

@@ -115,7 +115,7 @@ We're looking for TanStack AI Partners to join our mission! Partner with us to p
 
 - <a href="https://github.com/tanstack/config"><b>TanStack Config</b></a> – Tooling for JS/TS packages
 - <a href="https://github.com/tanstack/db"><b>TanStack DB</b></a> – Reactive sync client store
-- <a href="https://github.com/tanstack/devtools">TanStack Devtools</a> – Unified devtools panel
+- <a href="https://github.com/tanstack/devtools"><b>TanStack Devtools</b></a> – Unified devtools panel
 - <a href="https://github.com/tanstack/form"><b>TanStack Form</b></a> – Type‑safe form state
 - <a href="https://github.com/tanstack/pacer"><b>TanStack Pacer</b></a> – Debouncing, throttling, batching
 - <a href="https://github.com/tanstack/query"><b>TanStack Query</b></a> – Async state & caching

package/dist/esm/base-adapter.d.ts

@@ -12,6 +12,7 @@ import { AIAdapter, AIAdapterConfig, ChatOptions, DefaultMessageMetadataByModali
  * - TMessageMetadataByModality: Map from modality type to adapter-specific metadata types
  */
 export declare abstract class BaseAdapter<TChatModels extends ReadonlyArray<string> = ReadonlyArray<string>, TEmbeddingModels extends ReadonlyArray<string> = ReadonlyArray<string>, TChatProviderOptions extends Record<string, any> = Record<string, any>, TEmbeddingProviderOptions extends Record<string, any> = Record<string, any>, TModelProviderOptionsByName extends Record<string, any> = Record<string, any>, TModelInputModalitiesByName extends Record<string, ReadonlyArray<Modality>> = Record<string, ReadonlyArray<Modality>>, TMessageMetadataByModality extends {
+    text: unknown;
     image: unknown;
     audio: unknown;
     video: unknown;

package/dist/esm/base-adapter.js.map

@@ -1 +1 @@
-{"version":3,"file":"base-adapter.js","sources":["../../src/base-adapter.ts"],"sourcesContent":["import type {\n  AIAdapter,\n  AIAdapterConfig,\n  ChatOptions,\n  DefaultMessageMetadataByModality,\n  EmbeddingOptions,\n  EmbeddingResult,\n  Modality,\n  StreamChunk,\n  SummarizationOptions,\n  SummarizationResult,\n} from './types'\n\n/**\n * Base adapter class with support for endpoint-specific models and provider options.\n *\n * Generic parameters:\n * - TChatModels: Models that support chat/text completion\n * - TEmbeddingModels: Models that support embeddings\n * - TChatProviderOptions: Provider-specific options for chat endpoint\n * - TEmbeddingProviderOptions: Provider-specific options for embedding endpoint\n * - TModelProviderOptionsByName: Provider-specific options for model by name\n * - TModelInputModalitiesByName: Map from model name to its supported input modalities\n * - TMessageMetadataByModality: Map from modality type to adapter-specific metadata types\n */\nexport abstract class BaseAdapter<\n  TChatModels extends ReadonlyArray<string> = ReadonlyArray<string>,\n  TEmbeddingModels extends ReadonlyArray<string> = ReadonlyArray<string>,\n  TChatProviderOptions extends Record<string, any> = Record<string, any>,\n  TEmbeddingProviderOptions extends Record<string, any> = Record<string, any>,\n  TModelProviderOptionsByName extends Record<string, any> = Record<string, any>,\n  TModelInputModalitiesByName extends Record<\n    string,\n    ReadonlyArray<Modality>\n  > = Record<string, ReadonlyArray<Modality>>,\n  TMessageMetadataByModality extends {\n    image: unknown\n    audio: unknown\n    video: unknown\n    document: unknown\n  } = DefaultMessageMetadataByModality,\n> implements\n    AIAdapter<\n      TChatModels,\n      TEmbeddingModels,\n      TChatProviderOptions,\n      TEmbeddingProviderOptions,\n      TModelProviderOptionsByName,\n      TModelInputModalitiesByName,\n      TMessageMetadataByModality\n    >\n{\n  abstract name: string\n  abstract models: TChatModels\n  embeddingModels?: TEmbeddingModels\n  protected config: AIAdapterConfig\n\n  // These properties are used for type inference only, never assigned at runtime\n  _providerOptions?: TChatProviderOptions\n  _chatProviderOptions?: TChatProviderOptions\n  _embeddingProviderOptions?: TEmbeddingProviderOptions\n  // Type-only map; concrete adapters should override this with a precise type\n  _modelProviderOptionsByName!: TModelProviderOptionsByName\n  // Type-only map for model input modalities; concrete adapters should override this\n  _modelInputModalitiesByName?: TModelInputModalitiesByName\n  // Type-only map for message metadata types; concrete adapters should override this\n  _messageMetadataByModality?: TMessageMetadataByModality\n\n  constructor(config: AIAdapterConfig = {}) {\n    this.config = config\n  }\n\n  abstract chatStream(options: ChatOptions): AsyncIterable<StreamChunk>\n\n  abstract summarize(\n    options: SummarizationOptions,\n  ): Promise<SummarizationResult>\n  abstract createEmbeddings(options: EmbeddingOptions): Promise<EmbeddingResult>\n\n  protected generateId(): string {\n    return `${this.name}-${Date.now()}-${Math.random()\n      .toString(36)\n      .substring(7)}`\n  }\n}\n"],"names":[],"mappings":"AAyBO,MAAe,YA0BtB;AAAA,EAiBE,YAAY,SAA0B,IAAI;AACxC,SAAK,SAAS;AAAA,EAChB;AAAA,EASU,aAAqB;AAC7B,WAAO,GAAG,KAAK,IAAI,IAAI,KAAK,KAAK,IAAI,KAAK,OAAA,EACvC,SAAS,EAAE,EACX,UAAU,CAAC,CAAC;AAAA,EACjB;AACF;"}
+{"version":3,"file":"base-adapter.js","sources":["../../src/base-adapter.ts"],"sourcesContent":["import type {\n  AIAdapter,\n  AIAdapterConfig,\n  ChatOptions,\n  DefaultMessageMetadataByModality,\n  EmbeddingOptions,\n  EmbeddingResult,\n  Modality,\n  StreamChunk,\n  SummarizationOptions,\n  SummarizationResult,\n} from './types'\n\n/**\n * Base adapter class with support for endpoint-specific models and provider options.\n *\n * Generic parameters:\n * - TChatModels: Models that support chat/text completion\n * - TEmbeddingModels: Models that support embeddings\n * - TChatProviderOptions: Provider-specific options for chat endpoint\n * - TEmbeddingProviderOptions: Provider-specific options for embedding endpoint\n * - TModelProviderOptionsByName: Provider-specific options for model by name\n * - TModelInputModalitiesByName: Map from model name to its supported input modalities\n * - TMessageMetadataByModality: Map from modality type to adapter-specific metadata types\n */\nexport abstract class BaseAdapter<\n  TChatModels extends ReadonlyArray<string> = ReadonlyArray<string>,\n  TEmbeddingModels extends ReadonlyArray<string> = ReadonlyArray<string>,\n  TChatProviderOptions extends Record<string, any> = Record<string, any>,\n  TEmbeddingProviderOptions extends Record<string, any> = Record<string, any>,\n  TModelProviderOptionsByName extends Record<string, any> = Record<string, any>,\n  TModelInputModalitiesByName extends Record<\n    string,\n    ReadonlyArray<Modality>\n  > = Record<string, ReadonlyArray<Modality>>,\n  TMessageMetadataByModality extends {\n    text: unknown\n    image: unknown\n    audio: unknown\n    video: unknown\n    document: unknown\n  } = DefaultMessageMetadataByModality,\n> implements\n    AIAdapter<\n      TChatModels,\n      TEmbeddingModels,\n      TChatProviderOptions,\n      TEmbeddingProviderOptions,\n      TModelProviderOptionsByName,\n      TModelInputModalitiesByName,\n      TMessageMetadataByModality\n    >\n{\n  abstract name: string\n  abstract models: TChatModels\n  embeddingModels?: TEmbeddingModels\n  protected config: AIAdapterConfig\n\n  // These properties are used for type inference only, never assigned at runtime\n  _providerOptions?: TChatProviderOptions\n  _chatProviderOptions?: TChatProviderOptions\n  _embeddingProviderOptions?: TEmbeddingProviderOptions\n  // Type-only map; concrete adapters should override this with a precise type\n  _modelProviderOptionsByName!: TModelProviderOptionsByName\n  // Type-only map for model input modalities; concrete adapters should override this\n  _modelInputModalitiesByName?: TModelInputModalitiesByName\n  // Type-only map for message metadata types; concrete adapters should override this\n  _messageMetadataByModality?: TMessageMetadataByModality\n\n  constructor(config: AIAdapterConfig = {}) {\n    this.config = config\n  }\n\n  abstract chatStream(options: ChatOptions): AsyncIterable<StreamChunk>\n\n  abstract summarize(\n    options: SummarizationOptions,\n  ): Promise<SummarizationResult>\n  abstract createEmbeddings(options: EmbeddingOptions): Promise<EmbeddingResult>\n\n  protected generateId(): string {\n    return `${this.name}-${Date.now()}-${Math.random()\n      .toString(36)\n      .substring(7)}`\n  }\n}\n"],"names":[],"mappings":"AAyBO,MAAe,YA2BtB;AAAA,EAiBE,YAAY,SAA0B,IAAI;AACxC,SAAK,SAAS;AAAA,EAChB;AAAA,EASU,aAAqB;AAC7B,WAAO,GAAG,KAAK,IAAI,IAAI,KAAK,KAAK,IAAI,KAAK,OAAA,EACvC,SAAS,EAAE,EACX,UAAU,CAAC,CAAC;AAAA,EACjB;AACF;"}

package/dist/esm/types.d.ts

@@ -87,12 +87,12 @@ export interface DocumentPart<TMetadata = unknown> {
  * @template TVideoMeta - Provider-specific video metadata type
  * @template TDocumentMeta - Provider-specific document metadata type
  */
-export type ContentPart<TImageMeta = unknown, TAudioMeta = unknown, TVideoMeta = unknown, TDocumentMeta = unknown> = TextPart | ImagePart<TImageMeta> | AudioPart<TAudioMeta> | VideoPart<TVideoMeta> | DocumentPart<TDocumentMeta>;
+export type ContentPart<TImageMeta = unknown, TAudioMeta = unknown, TVideoMeta = unknown, TDocumentMeta = unknown, TTextMeta = unknown> = TextPart<TTextMeta> | ImagePart<TImageMeta> | AudioPart<TAudioMeta> | VideoPart<TVideoMeta> | DocumentPart<TDocumentMeta>;
 /**
  * Helper type to filter ContentPart union to only include specific modalities.
  * Used to constrain message content based on model capabilities.
  */
-export type ContentPartForModalities<TModalities extends Modality, TImageMeta = unknown, TAudioMeta = unknown, TVideoMeta = unknown, TDocumentMeta = unknown> = Extract<ContentPart<TImageMeta, TAudioMeta, TVideoMeta, TDocumentMeta>, {
+export type ContentPartForModalities<TModalities extends Modality, TImageMeta = unknown, TAudioMeta = unknown, TVideoMeta = unknown, TDocumentMeta = unknown, TTextMeta = unknown> = Extract<ContentPart<TImageMeta, TAudioMeta, TVideoMeta, TDocumentMeta, TTextMeta>, {
     type: TModalities;
 }>;
 /**
@@ -104,7 +104,7 @@ export type ModalitiesArrayToUnion<T extends ReadonlyArray<Modality>> = T[number
  * Type for message content constrained by supported modalities.
  * When modalities is ['text', 'image'], only TextPart and ImagePart are allowed in the array.
  */
-export type ConstrainedContent<TModalities extends ReadonlyArray<Modality>, TImageMeta = unknown, TAudioMeta = unknown, TVideoMeta = unknown, TDocumentMeta = unknown> = string | null | Array<ContentPartForModalities<ModalitiesArrayToUnion<TModalities>, TImageMeta, TAudioMeta, TVideoMeta, TDocumentMeta>>;
+export type ConstrainedContent<TModalities extends ReadonlyArray<Modality>, TImageMeta = unknown, TAudioMeta = unknown, TVideoMeta = unknown, TDocumentMeta = unknown, TTextMeta = unknown> = string | null | Array<ContentPartForModalities<ModalitiesArrayToUnion<TModalities>, TImageMeta, TAudioMeta, TVideoMeta, TDocumentMeta, TTextMeta>>;
 export interface ModelMessage<TContent extends string | null | Array<ContentPart> = string | null | Array<ContentPart>> {
     role: 'user' | 'assistant' | 'tool';
     content: TContent;
@@ -115,9 +115,10 @@ export interface ModelMessage<TContent extends string | null | Array<ContentPart
 /**
  * Message parts - building blocks of UIMessage
  */
-export interface TextPart {
+export interface TextPart<TMetadata = unknown> {
     type: 'text';
     content: string;
+    metadata?: TMetadata;
 }
 export interface ToolCallPart {
     type: 'tool-call';
@@ -160,8 +161,8 @@ export interface UIMessage {
  * A ModelMessage with content constrained to only allow content parts
  * matching the specified input modalities.
  */
-export type ConstrainedModelMessage<TModalities extends ReadonlyArray<Modality>, TImageMeta = unknown, TAudioMeta = unknown, TVideoMeta = unknown, TDocumentMeta = unknown> = Omit<ModelMessage, 'content'> & {
-    content: ConstrainedContent<TModalities, TImageMeta, TAudioMeta, TVideoMeta, TDocumentMeta>;
+export type ConstrainedModelMessage<TModalities extends ReadonlyArray<Modality>, TImageMeta = unknown, TAudioMeta = unknown, TVideoMeta = unknown, TDocumentMeta = unknown, TTextMeta = unknown> = Omit<ModelMessage, 'content'> & {
+    content: ConstrainedContent<TModalities, TImageMeta, TAudioMeta, TVideoMeta, TDocumentMeta, TTextMeta>;
 };
 /**
  * Tool/Function definition for function calling.
@@ -516,6 +517,7 @@ export interface EmbeddingResult {
  * Uses unknown for all modalities.
  */
 export interface DefaultMessageMetadataByModality {
+    text: unknown;
     image: unknown;
     audio: unknown;
     video: unknown;
@@ -534,6 +536,7 @@ export interface DefaultMessageMetadataByModality {
  * - TMessageMetadataByModality: Map from modality type to adapter-specific metadata types
  */
 export interface AIAdapter<TChatModels extends ReadonlyArray<string> = ReadonlyArray<string>, TEmbeddingModels extends ReadonlyArray<string> = ReadonlyArray<string>, TChatProviderOptions extends Record<string, any> = Record<string, any>, TEmbeddingProviderOptions extends Record<string, any> = Record<string, any>, TModelProviderOptionsByName extends Record<string, any> = Record<string, any>, TModelInputModalitiesByName extends Record<string, ReadonlyArray<Modality>> = Record<string, ReadonlyArray<Modality>>, TMessageMetadataByModality extends {
+    text: unknown;
     image: unknown;
     audio: unknown;
     video: unknown;
@@ -585,11 +588,12 @@ export type ChatStreamOptionsUnion<TAdapter extends AIAdapter<any, any, any, any
      * Metadata types are also constrained based on the adapter's metadata type definitions.
      */
     messages: TModel extends keyof ModelInputModalities ? ModelInputModalities[TModel] extends ReadonlyArray<Modality> ? MessageMetadata extends {
+        text: infer TTextMeta;
         image: infer TImageMeta;
         audio: infer TAudioMeta;
         video: infer TVideoMeta;
         document: infer TDocumentMeta;
-    } ? Array<ConstrainedModelMessage<ModelInputModalities[TModel], TImageMeta, TAudioMeta, TVideoMeta, TDocumentMeta>> : Array<ConstrainedModelMessage<ModelInputModalities[TModel]>> : Array<ModelMessage> : Array<ModelMessage>;
+    } ? Array<ConstrainedModelMessage<ModelInputModalities[TModel], TImageMeta, TAudioMeta, TVideoMeta, TDocumentMeta, TTextMeta>> : Array<ConstrainedModelMessage<ModelInputModalities[TModel]>> : Array<ModelMessage> : Array<ModelMessage>;
 } : never : never : never;
 /**
  * Chat options constrained by a specific model's capabilities.
@@ -606,11 +610,12 @@ export type ChatStreamOptionsForModel<TAdapter extends AIAdapter<any, any, any,
      * Metadata types are also constrained based on the adapter's metadata type definitions.
      */
     messages: TModel extends keyof ModelInputModalities ? ModelInputModalities[TModel] extends ReadonlyArray<Modality> ? MessageMetadata extends {
+        text: infer TTextMeta;
         image: infer TImageMeta;
         audio: infer TAudioMeta;
         video: infer TVideoMeta;
         document: infer TDocumentMeta;
-    } ? Array<ConstrainedModelMessage<ModelInputModalities[TModel], TImageMeta, TAudioMeta, TVideoMeta, TDocumentMeta>> : Array<ConstrainedModelMessage<ModelInputModalities[TModel]>> : Array<ModelMessage> : Array<ModelMessage>;
+    } ? Array<ConstrainedModelMessage<ModelInputModalities[TModel], TImageMeta, TAudioMeta, TVideoMeta, TDocumentMeta, TTextMeta>> : Array<ConstrainedModelMessage<ModelInputModalities[TModel]>> : Array<ModelMessage> : Array<ModelMessage>;
 } : never;
 export type ExtractModelsFromAdapter<T> = T extends AIAdapter<infer M, any, any, any, any, any> ? M[number] : never;
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/ai",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Core TanStack AI library - Open source AI SDK",
   "author": "Tanner Linsley",
   "license": "MIT",

package/src/base-adapter.ts

@@ -34,6 +34,7 @@ export abstract class BaseAdapter<
     ReadonlyArray<Modality>
   > = Record<string, ReadonlyArray<Modality>>,
   TMessageMetadataByModality extends {
+    text: unknown
     image: unknown
     audio: unknown
     video: unknown

package/src/types.ts

@@ -104,8 +104,9 @@ export type ContentPart<
   TAudioMeta = unknown,
   TVideoMeta = unknown,
   TDocumentMeta = unknown,
+  TTextMeta = unknown,
 > =
-  | TextPart
+  | TextPart<TTextMeta>
   | ImagePart<TImageMeta>
   | AudioPart<TAudioMeta>
   | VideoPart<TVideoMeta>
@@ -121,8 +122,9 @@ export type ContentPartForModalities<
   TAudioMeta = unknown,
   TVideoMeta = unknown,
   TDocumentMeta = unknown,
+  TTextMeta = unknown,
 > = Extract<
-  ContentPart<TImageMeta, TAudioMeta, TVideoMeta, TDocumentMeta>,
+  ContentPart<TImageMeta, TAudioMeta, TVideoMeta, TDocumentMeta, TTextMeta>,
   { type: TModalities }
 >
 
@@ -143,6 +145,7 @@ export type ConstrainedContent<
   TAudioMeta = unknown,
   TVideoMeta = unknown,
   TDocumentMeta = unknown,
+  TTextMeta = unknown,
 > =
   | string
   | null
@@ -152,7 +155,8 @@ export type ConstrainedContent<
         TImageMeta,
         TAudioMeta,
         TVideoMeta,
-        TDocumentMeta
+        TDocumentMeta,
+        TTextMeta
       >
     >
 
@@ -172,9 +176,10 @@ export interface ModelMessage<
 /**
  * Message parts - building blocks of UIMessage
  */
-export interface TextPart {
+export interface TextPart<TMetadata = unknown> {
   type: 'text'
   content: string
+  metadata?: TMetadata
 }
 
 export interface ToolCallPart {
@@ -232,13 +237,15 @@ export type ConstrainedModelMessage<
   TAudioMeta = unknown,
   TVideoMeta = unknown,
   TDocumentMeta = unknown,
+  TTextMeta = unknown,
 > = Omit<ModelMessage, 'content'> & {
   content: ConstrainedContent<
     TModalities,
     TImageMeta,
     TAudioMeta,
     TVideoMeta,
-    TDocumentMeta
+    TDocumentMeta,
+    TTextMeta
   >
 }
 
@@ -655,6 +662,7 @@ export interface EmbeddingResult {
  * Uses unknown for all modalities.
  */
 export interface DefaultMessageMetadataByModality {
+  text: unknown
   image: unknown
   audio: unknown
   video: unknown
@@ -684,6 +692,7 @@ export interface AIAdapter<
     ReadonlyArray<Modality>
   > = Record<string, ReadonlyArray<Modality>>,
   TMessageMetadataByModality extends {
+    text: unknown
     image: unknown
     audio: unknown
     video: unknown
@@ -770,6 +779,7 @@ export type ChatStreamOptionsUnion<
             messages: TModel extends keyof ModelInputModalities
               ? ModelInputModalities[TModel] extends ReadonlyArray<Modality>
                 ? MessageMetadata extends {
+                    text: infer TTextMeta
                     image: infer TImageMeta
                     audio: infer TAudioMeta
                     video: infer TVideoMeta
@@ -781,7 +791,8 @@ export type ChatStreamOptionsUnion<
                         TImageMeta,
                         TAudioMeta,
                         TVideoMeta,
-                        TDocumentMeta
+                        TDocumentMeta,
+                        TTextMeta
                       >
                     >
                   : Array<ConstrainedModelMessage<ModelInputModalities[TModel]>>
@@ -827,6 +838,7 @@ export type ChatStreamOptionsForModel<
         messages: TModel extends keyof ModelInputModalities
           ? ModelInputModalities[TModel] extends ReadonlyArray<Modality>
             ? MessageMetadata extends {
+                text: infer TTextMeta
                 image: infer TImageMeta
                 audio: infer TAudioMeta
                 video: infer TVideoMeta
@@ -838,7 +850,8 @@ export type ChatStreamOptionsForModel<
                     TImageMeta,
                     TAudioMeta,
                     TVideoMeta,
-                    TDocumentMeta
+                    TDocumentMeta,
+                    TTextMeta
                   >
                 >
               : Array<ConstrainedModelMessage<ModelInputModalities[TModel]>>