@tanstack/ai 0.46.0 → 0.47.2

package/dist/esm/activities/chat/index.d.ts

@@ -1,3 +1,4 @@
+import { InterruptDefinition } from '../../interrupt-definition.js';
 import { AnyTextAdapter } from './adapter.js';
 import { AnyTool, ConstrainedModelMessage, InferSchemaType, LazyToolsConfig, ModelMessage, ProviderTool, SchemaInput, StructuredOutputStream, TextOptions, TypedStreamChunk, UIMessage } from '../../types.js';
 import { AnyChatMiddleware, ChatMiddleware } from './middleware/types.js';
@@ -19,19 +20,36 @@ type ContextFromInputs<TTools, TMiddleware> = MergeContext<ContextFromArray<NonN
 type InferredContext<TTools, TMiddleware> = [
     ContextFromInputs<TTools, TMiddleware>
 ] extends [never] ? unknown : ContextFromInputs<TTools, TMiddleware>;
-type RequiredContextFromInputs<TTools, TMiddleware> = [
-    ContextFromInputs<TTools, TMiddleware>
+type RegistryInterrupt<TInterrupts extends ReadonlyArray<InterruptDefinition<any, any, any, any>>> = [TInterrupts[number]] extends [never] ? never : TInterrupts[number];
+type DuplicateInterruptDefinitionId<TInterrupts extends ReadonlyArray<InterruptDefinition<any, any, any, any>>, TSeenIds extends string = never> = TInterrupts extends readonly [infer THead, ...infer TTail] ? THead extends InterruptDefinition<infer TId, any, any, any> ? string extends TId ? TTail extends ReadonlyArray<InterruptDefinition<any, any, any, any>> ? DuplicateInterruptDefinitionId<TTail, TSeenIds> : never : TId extends TSeenIds ? TId : TTail extends ReadonlyArray<InterruptDefinition<any, any, any, any>> ? DuplicateInterruptDefinitionId<TTail, TSeenIds | TId> : never : never : never;
+type CheckUniqueInterruptDefinitions<TInterrupts extends ReadonlyArray<InterruptDefinition<any, any, any, any>>> = [DuplicateInterruptDefinitionId<TInterrupts>] extends [never] ? unknown : {
+    readonly '✖ Duplicate interrupt definition id in chat({ interrupts }).': never;
+};
+type InlineChatContext<TTools, TContext> = MergeContext<ContextFromArray<NonNullable<TTools>>, TContext>;
+type RegistryChatMiddleware<TContext, TInterrupts extends ReadonlyArray<InterruptDefinition<any, any, any, any>>> = ChatMiddleware<TContext, RegistryInterrupt<TInterrupts>>;
+type MiddlewareInterruptDefinitions<TMiddleware> = TMiddleware extends ReadonlyArray<infer TMiddlewareItem> ? TMiddlewareItem extends ChatMiddleware<any, infer TDefinitions> ? TDefinitions : never : never;
+type IsAny<TValue> = 0 extends 1 & TValue ? true : false;
+type CheckInterruptRegistry<TInterrupts extends ReadonlyArray<InterruptDefinition<any, any, any, any>>, TMiddleware> = IsAny<MiddlewareInterruptDefinitions<TMiddleware>> extends true ? unknown : [MiddlewareInterruptDefinitions<TMiddleware>] extends [never] ? unknown : [
+    Exclude<MiddlewareInterruptDefinitions<TMiddleware>, RegistryInterrupt<TInterrupts>>
+] extends [never] ? unknown : {
+    readonly '✖ Middleware emits an interrupt definition that is not registered in chat({ interrupts }).': never;
+};
+type RuntimeContextOption<TTools, TMiddleware, TContext> = [
+    MergeContext<ContextFromInputs<TTools, TMiddleware>, TContext>
 ] extends [never] ? {
-    context?: unknown;
-} : undefined extends ContextFromInputs<TTools, TMiddleware> ? {
-    context?: ContextFromInputs<TTools, TMiddleware>;
+    context?: TContext;
+} : undefined extends MergeContext<ContextFromInputs<TTools, TMiddleware>, TContext> ? {
+    context?: MergeContext<ContextFromInputs<TTools, TMiddleware>, TContext>;
 } : {
-    context: ContextFromInputs<TTools, TMiddleware>;
+    context: MergeContext<ContextFromInputs<TTools, TMiddleware>, TContext>;
 };
-type TextActivityOptionsWithContext<TAdapter extends AnyTextAdapter, TSchema extends SchemaInput | undefined, TStream extends boolean, TTools extends TextActivityOptions<TAdapter, TSchema, TStream, any>['tools'], TMiddleware extends TextActivityOptions<TAdapter, TSchema, TStream, any>['middleware']> = Omit<TextActivityOptions<TAdapter, TSchema, TStream, any>, 'tools' | 'middleware' | 'context'> & {
+type ExactMiddlewareOption<TTools, TContext, TInterrupts extends ReadonlyArray<InterruptDefinition<any, any, any, any>>, TMiddleware extends Array<unknown> | undefined> = [TMiddleware] extends [undefined] ? Array<RegistryChatMiddleware<InlineChatContext<TTools, TContext>, NoInfer<TInterrupts>>> : TMiddleware & (TMiddleware extends Array<RegistryChatMiddleware<InlineChatContext<TTools, NoInfer<TContext>>, NoInfer<TInterrupts>>> ? Array<RegistryChatMiddleware<InlineChatContext<TTools, TContext>, NoInfer<TInterrupts>>> : CheckInterruptRegistry<TInterrupts, TMiddleware>) & CheckCoverage<Extract<TMiddleware, ReadonlyArray<AnyChatMiddleware>>>;
+type TextActivityOptionsWithContext<TAdapter extends AnyTextAdapter, TSchema extends SchemaInput | undefined, TStream extends boolean, TTools extends TextActivityOptions<TAdapter, TSchema, TStream, any>['tools'], TInterrupts extends ReadonlyArray<InterruptDefinition<any, any, any, any>> = [
+], TContext = unknown, TMiddleware extends Array<unknown> | undefined = undefined> = Omit<TextActivityOptions<TAdapter, TSchema, TStream, any>, 'tools' | 'middleware' | 'context' | 'interrupts'> & {
     tools?: TTools;
-    middleware?: TMiddleware & CheckCoverage<Extract<TMiddleware, ReadonlyArray<AnyChatMiddleware>>>;
-} & RequiredContextFromInputs<TTools, TMiddleware>;
+    interrupts?: TInterrupts & CheckUniqueInterruptDefinitions<TInterrupts>;
+    middleware?: ExactMiddlewareOption<TTools, TContext, TInterrupts, TMiddleware>;
+} & RuntimeContextOption<TTools, TMiddleware, TContext>;
 /**
  * Options for the text activity.
  * Types are extracted directly from the adapter (which has pre-resolved generics).
@@ -168,6 +186,11 @@ export interface TextActivityOptions<TAdapter extends AnyTextAdapter, TSchema ex
      * ```
      */
     middleware?: Array<ChatMiddleware<TContext>>;
+    /**
+     * First-party generic interrupt definitions for this chat call.
+     * Register the same definitions on the client to type payloads and answers.
+     */
+    interrupts?: ReadonlyArray<InterruptDefinition<any, any, any, any>>;
     /**
      * Runtime context value passed to middleware hooks and server tools.
      */
@@ -193,8 +216,10 @@ export interface TextActivityOptions<TAdapter extends AnyTextAdapter, TSchema ex
  * const stream = chat({ ...chatOptions, messages })
  * ```
  */
-export declare function createChatOptions<TAdapter extends AnyTextAdapter, TSchema extends SchemaInput | undefined = undefined, TStream extends boolean = true, const TTools extends TextActivityOptions<TAdapter, TSchema, TStream, any>['tools'] = TextActivityOptions<TAdapter, TSchema, TStream, any>['tools'], const TMiddleware extends TextActivityOptions<TAdapter, TSchema, TStream, any>['middleware'] = TextActivityOptions<TAdapter, TSchema, TStream, any>['middleware']>(options: TextActivityOptionsWithContext<TAdapter, TSchema, TStream, TTools, TMiddleware>): Omit<TextActivityOptions<TAdapter, TSchema, TStream, InferredContext<TTools, TMiddleware>>, 'tools'> & {
+export declare function createChatOptions<TAdapter extends AnyTextAdapter, TSchema extends SchemaInput | undefined = undefined, TStream extends boolean = true, const TTools extends TextActivityOptions<TAdapter, TSchema, TStream, any>['tools'] = TextActivityOptions<TAdapter, TSchema, TStream, any>['tools'], const TInterrupts extends ReadonlyArray<InterruptDefinition<any, any, any, any>> = [], TContext = unknown, const TMiddleware extends Array<unknown> | undefined = undefined>(options: TextActivityOptionsWithContext<TAdapter, TSchema, TStream, TTools, TInterrupts, TContext, TMiddleware>): Omit<TextActivityOptions<TAdapter, TSchema, TStream, InferredContext<TTools, TMiddleware>>, 'tools' | 'middleware' | 'interrupts'> & {
     tools?: TTools;
+    interrupts?: TInterrupts;
+    middleware?: ExactMiddlewareOption<TTools, TContext, TInterrupts, TMiddleware>;
 };
 /**
  * Result type for the text activity.
@@ -277,6 +302,6 @@ export type TextActivityResult<TSchema extends SchemaInput | undefined, TStream
  * // result is { summary: string, keyPoints: string[] }
  * ```
  */
-export declare function chat<TAdapter extends AnyTextAdapter, TSchema extends SchemaInput | undefined = undefined, TStream extends boolean = boolean, const TTools extends TextActivityOptions<TAdapter, TSchema, TStream, any>['tools'] = TextActivityOptions<TAdapter, TSchema, TStream, any>['tools'], const TMiddleware extends TextActivityOptions<TAdapter, TSchema, TStream, any>['middleware'] = TextActivityOptions<TAdapter, TSchema, TStream, any>['middleware']>(options: TextActivityOptionsWithContext<TAdapter, TSchema, TStream, TTools, TMiddleware>): TextActivityResult<TSchema, TStream, TTools>;
+export declare function chat<TAdapter extends AnyTextAdapter, TSchema extends SchemaInput | undefined = undefined, TStream extends boolean = boolean, const TTools extends TextActivityOptions<TAdapter, TSchema, TStream, any>['tools'] = TextActivityOptions<TAdapter, TSchema, TStream, any>['tools'], const TInterrupts extends ReadonlyArray<InterruptDefinition<any, any, any, any>> = [], TContext = unknown, const TMiddleware extends Array<unknown> | undefined = undefined>(options: TextActivityOptionsWithContext<TAdapter, TSchema, TStream, TTools, TInterrupts, TContext, TMiddleware>): TextActivityResult<TSchema, TStream, TTools>;
 export type { TextAdapter, TextAdapterConfig, StructuredOutputOptions, StructuredOutputResult, } from './adapter.js';
 export { BaseTextAdapter } from './adapter.js';