@tanstack/ai-client 0.12.0 → 0.13.0

package/dist/esm/devtools.d.ts

@@ -0,0 +1,276 @@
+import { AnyClientTool, StreamChunk } from '@tanstack/ai';
+import { ChatClientEventContext, ChatClientEventEmitter, ChatClientRunEventContext } from './events.js';
+import { ChatClientState, ConnectionStatus, UIMessage } from './types.js';
+export interface AIDevtoolsDisplayOptions {
+    name?: string;
+}
+export interface AIDevtoolsClientMetadata extends AIDevtoolsDisplayOptions {
+    framework?: string;
+    hookName: string;
+    outputKind?: 'chat' | 'text' | 'structured' | 'image' | 'video' | 'audio';
+}
+export interface AIDevtoolsGenerationProgress {
+    value: number;
+    message?: string;
+}
+export interface AIDevtoolsGenerationMediaItem {
+    src: string;
+    sourceType: 'url' | 'base64';
+    mimeType?: string;
+    format?: string;
+    duration?: number;
+}
+export interface AIDevtoolsGenerationVideoJob {
+    jobId: string;
+    status?: string;
+    progress?: number;
+    error?: string;
+}
+export type AIDevtoolsGenerationPreview = {
+    kind: 'image';
+    items: Array<AIDevtoolsGenerationMediaItem>;
+} | {
+    kind: 'audio';
+    items: Array<AIDevtoolsGenerationMediaItem>;
+} | {
+    kind: 'video';
+    items: Array<AIDevtoolsGenerationMediaItem>;
+    job?: AIDevtoolsGenerationVideoJob;
+} | {
+    kind: 'text';
+    text: string;
+} | {
+    kind: 'structured';
+    value: unknown;
+} | {
+    kind: 'empty';
+};
+export type AIDevtoolsGenerationRunStatus = 'idle' | 'generating' | 'success' | 'error' | 'cancelled';
+export interface AIDevtoolsGenerationRunSnapshot<TOutput = unknown> {
+    id: string;
+    input: unknown;
+    result: TOutput | null;
+    preview: AIDevtoolsGenerationPreview;
+    progress: AIDevtoolsGenerationProgress | null;
+    status: AIDevtoolsGenerationRunStatus;
+    isLoading: boolean;
+    startedAt: number;
+    updatedAt: number;
+    completedAt?: number;
+    error?: string;
+    jobId?: string | null;
+    videoStatus?: unknown;
+}
+export interface AIDevtoolsGenerationPreviewInput {
+    outputKind?: AIDevtoolsClientMetadata['outputKind'];
+    result: unknown;
+    videoStatus?: unknown;
+}
+export interface AIDevtoolsChatSnapshot {
+    [key: string]: unknown;
+    messages: Array<UIMessage>;
+    status: ChatClientState;
+    isLoading: boolean;
+    isSubscribed: boolean;
+    connectionStatus: ConnectionStatus;
+    sessionGenerating: boolean;
+    activeRunIds: Array<string>;
+    error?: string;
+}
+export declare function createAIDevtoolsGenerationPreview(input: AIDevtoolsGenerationPreviewInput): AIDevtoolsGenerationPreview;
+export interface AIDevtoolsToolFixture {
+    fixtureId?: string;
+    hookId?: string;
+    threadId?: string;
+    runId?: string;
+    toolName: string;
+    input: unknown;
+    output: unknown;
+    execute?: boolean;
+    message?: {
+        id: string;
+        role: UIMessage['role'];
+        parts: Array<unknown>;
+        createdAt?: number | string;
+    };
+    toolCallId?: string;
+    messageId?: string;
+    errorText?: string;
+}
+type AIDevtoolsRunEventType = 'run:created' | 'run:started' | 'run:updated' | 'run:completed' | 'run:errored' | 'run:cancelled';
+type AIDevtoolsRunStatus = 'created' | 'started' | 'updated' | 'completed' | 'errored' | 'cancelled';
+export interface AIDevtoolsBridgeOptions<TSnapshot extends object> {
+    hookId: string;
+    threadId?: string;
+    clientId: string;
+    metadata: AIDevtoolsClientMetadata;
+    getSnapshot: () => TSnapshot;
+    getTools?: () => Iterable<AnyClientTool>;
+    applyToolFixture?: (fixture: AIDevtoolsToolFixture) => void | Promise<void>;
+}
+export declare class ClientDevtoolsBridge<TSnapshot extends object> {
+    protected readonly options: AIDevtoolsBridgeOptions<TSnapshot>;
+    private readonly bridgeId;
+    private readonly unsubscribers;
+    private disposed;
+    private superseded;
+    private registered;
+    constructor(options: AIDevtoolsBridgeOptions<TSnapshot>);
+    emitRegistered(): void;
+    emitUpdated(): void;
+    emitSnapshot(): void;
+    emitToolsRegistered(): void;
+    emitRunLifecycle(eventType: AIDevtoolsRunEventType, runId: string, status: AIDevtoolsRunStatus, options?: {
+        error?: string;
+    }): void;
+    deactivate(): void;
+    supersede(): void;
+    dispose(): void;
+    private prepareForEmit;
+    private prepareForMountEmit;
+    private activate;
+    private handleRequestState;
+    private handleToolFixtureApply;
+    private matchesFixtureTarget;
+    private createEnvelope;
+    private createMetadataPayload;
+}
+export interface ChatDevtoolsBridgeOptions extends AIDevtoolsBridgeOptions<AIDevtoolsChatSnapshot> {
+    getMessages: () => Array<UIMessage>;
+    setMessages: (messages: Array<UIMessage>) => void;
+    addToolResult: (toolCallId: string, output: unknown, errorText?: string) => void;
+    generateId: (prefix: string) => string;
+}
+export declare class ChatDevtoolsBridge extends ClientDevtoolsBridge<AIDevtoolsChatSnapshot> {
+    readonly events: ChatClientEventEmitter;
+    private readonly chatOptions;
+    private currentRunId;
+    private currentRunThreadId;
+    private currentStreamId;
+    private lastStreamId;
+    private lastRunEventContext;
+    constructor(options: ChatDevtoolsBridgeOptions);
+    setCurrentStreamId(streamId: string | null): void;
+    /**
+     * Called by the auto-attaching emitter every time it sees a non-empty
+     * streamId pass through. Lets devtools track the latest stream id
+     * without the chat client wiring it up explicitly.
+     */
+    recordStreamId(streamId: string): void;
+    mountWithTools(initialMessageCount: number): void;
+    notifyToolsChanged(): void;
+    getCurrentStreamId(): string | null;
+    getLastStreamId(): string | null;
+    resolveStreamId(): string;
+    beginRun(runId: string, threadId: string): void;
+    observeChunk(chunk: StreamChunk): void;
+    getCurrentRunEventContext(): ChatClientRunEventContext | undefined;
+    getCurrentOrLastRunEventContext(): ChatClientRunEventContext | undefined;
+    findToolCallContext(toolCallId: string): ChatClientEventContext;
+    /**
+     * Entry point invoked when the devtools panel emits
+     * `devtools:tool-fixture:apply`. The chat client never calls this
+     * directly; it is wired through the base bridge's fixture subscription.
+     */
+    applyFixture(fixture: AIDevtoolsToolFixture): Promise<void>;
+    private executeFixture;
+    private addToolResultForFixture;
+    private createReplayMessageFromFixture;
+    private cloneFixtureSourceMessage;
+    private createFixtureToolCallIdMap;
+    private resolveFixtureMessageId;
+    private resolveFixtureToolCallId;
+    private findClientTool;
+}
+export interface AIDevtoolsGenerationSnapshotBase<TOutput> {
+    input: unknown;
+    result: TOutput | null;
+    preview: AIDevtoolsGenerationPreview;
+    progress: AIDevtoolsGenerationProgress | null;
+    status: AIDevtoolsGenerationRunStatus;
+    isLoading: boolean;
+    activeRunId: string | null;
+    runs: Array<AIDevtoolsGenerationRunSnapshot<TOutput>>;
+    error?: string;
+}
+export interface GenerationDevtoolsBridgeOptions<TOutput> extends Omit<AIDevtoolsBridgeOptions<AIDevtoolsGenerationSnapshotBase<TOutput>>, 'getSnapshot'> {
+    getCoreState: () => GenerationDevtoolsCoreState<TOutput>;
+    maxRuns?: number;
+}
+export interface GenerationDevtoolsCoreState<TOutput> {
+    input: unknown;
+    result: TOutput | null;
+    progress: AIDevtoolsGenerationProgress | null;
+    status: AIDevtoolsGenerationRunStatus;
+    isLoading: boolean;
+    error?: string;
+}
+export interface GenerationRunPatch<TOutput> {
+    input?: unknown;
+    result?: TOutput | null;
+    preview?: AIDevtoolsGenerationPreview;
+    progress?: AIDevtoolsGenerationProgress | null;
+    status?: AIDevtoolsGenerationRunStatus;
+    isLoading?: boolean;
+    completedAt?: number;
+    error?: string;
+    clearError?: boolean;
+}
+export declare class GenerationDevtoolsBridge<TOutput> extends ClientDevtoolsBridge<AIDevtoolsGenerationSnapshotBase<TOutput>> {
+    protected activeRunId: string | null;
+    protected activeRunStarted: boolean;
+    protected devtoolsRuns: Array<AIDevtoolsGenerationRunSnapshot<TOutput>>;
+    protected readonly maxRuns: number;
+    protected readonly getCoreState: () => GenerationDevtoolsCoreState<TOutput>;
+    constructor(options: GenerationDevtoolsBridgeOptions<TOutput>);
+    beginRun(input: unknown): string;
+    ensureRunStarted(runId: string): void;
+    finishRun(runId: string, eventType: 'run:completed' | 'run:errored' | 'run:cancelled', status: 'completed' | 'errored' | 'cancelled', error?: string): void;
+    getActiveRunId(): string | null;
+    /** Clear all per-run history. Called when the client `reset()`s. */
+    resetRuns(): void;
+    /** Record state changes from the client and emit the matching snapshot. */
+    recordResultChange(): void;
+    recordLoadingChange(): void;
+    recordErrorChange(error: Error | undefined): void;
+    recordStatusChange(status: AIDevtoolsGenerationRunStatus): void;
+    recordProgressChange(): void;
+    /** Emit the latest snapshot without touching run state. */
+    emitState(): void;
+    protected buildSnapshot(): AIDevtoolsGenerationSnapshotBase<TOutput>;
+    protected updateActiveRun(patch: GenerationRunPatch<TOutput>): void;
+    protected upsertRun(runId: string, patch: GenerationRunPatch<TOutput>): void;
+    protected renameRun(previousRunId: string, nextRunId: string): void;
+    protected getProgress(): AIDevtoolsGenerationProgress | null;
+    protected completeProgress(): AIDevtoolsGenerationProgress | null;
+    protected createPreview(result: TOutput | null): AIDevtoolsGenerationPreview;
+    protected generateRunId(): string;
+}
+export interface AIDevtoolsVideoSnapshotBase<TOutput> extends AIDevtoolsGenerationSnapshotBase<TOutput> {
+    jobId: string | null;
+    videoStatus: unknown;
+}
+export interface VideoDevtoolsCoreState<TOutput> extends GenerationDevtoolsCoreState<TOutput> {
+    jobId: string | null;
+    videoStatus: unknown;
+}
+export interface VideoDevtoolsBridgeOptions<TOutput> extends Omit<GenerationDevtoolsBridgeOptions<TOutput>, 'getCoreState'> {
+    getCoreState: () => VideoDevtoolsCoreState<TOutput>;
+}
+export interface VideoRunPatch<TOutput> extends GenerationRunPatch<TOutput> {
+    jobId?: string | null;
+    videoStatus?: unknown;
+}
+export declare class VideoDevtoolsBridge<TOutput> extends GenerationDevtoolsBridge<TOutput> {
+    constructor(options: VideoDevtoolsBridgeOptions<TOutput>);
+    recordJobIdChange(): void;
+    recordVideoStatusChange(): void;
+    protected buildSnapshot(): AIDevtoolsVideoSnapshotBase<TOutput>;
+    protected upsertRun(runId: string, patch: VideoRunPatch<TOutput>): void;
+    protected createPreview(result: TOutput | null): AIDevtoolsGenerationPreview;
+    private createVideoPreview;
+}
+export declare function createChatDevtoolsBridge(options: ChatDevtoolsBridgeOptions): ChatDevtoolsBridge;
+export declare function createGenerationDevtoolsBridge<TOutput>(options: GenerationDevtoolsBridgeOptions<TOutput>): GenerationDevtoolsBridge<TOutput>;
+export declare function createVideoDevtoolsBridge<TOutput>(options: VideoDevtoolsBridgeOptions<TOutput>): VideoDevtoolsBridge<TOutput>;
+export {};