@agents24/chat-react 0.1.6 → 0.1.8

package/dist/index.d.ts

@@ -1,466 +1,10 @@
-import * as react from 'react';
-import { ReactNode, RefObject, UIEvent } from 'react';
-
-type ChatRunStatus = "queued" | "running" | "completed" | "cancelled" | "failed" | string;
-type ChatContextWindow = {
-    stage?: string;
-    label?: string;
-    usedTokens?: number;
-    maxTokens?: number;
-    [key: string]: unknown;
-};
-type ChatCitation = {
-    title: string;
-    url: string;
-    description: string;
-    sourceRef?: string;
-    ref?: string;
-    firstRef?: string;
-    totalSegments?: number;
-    rangeRef?: string;
-};
-type ChatAttachment = {
-    url?: string;
-    filename?: string;
-    mediaType?: string;
-    contentType?: string;
-    [key: string]: unknown;
-};
-type ChatReasoningStep = {
-    label: string;
-    status: "active" | "complete" | "pending";
-    icon?: unknown;
-    description?: string;
-    citations?: ChatCitation[];
-    query?: string;
-    sources?: Array<Record<string, unknown>>;
-};
-type ChatToolState = "input-streaming" | "input-available" | "output-available" | "output-error" | "cancelled";
-type ToolPresentation = {
-    title?: string | null;
-    activity?: string | null;
-    detail?: string | null;
-    category?: string | null;
-    groupKey?: string | null;
-    groupLabel?: string | null;
-    showOutput?: boolean;
-    outputView?: Record<string, unknown> | null;
-    [key: string]: unknown;
-};
-type ChatTextPart = {
-    id: string;
-    type: "text";
-    kind: "text";
-    text: string;
-    raw?: Record<string, unknown>;
-};
-type ChatToolPart = {
-    id: string;
-    type: `tool-${string}`;
-    kind: "tool";
-    toolName: string;
-    toolCallId?: string | null;
-    state: ChatToolState;
-    input?: unknown;
-    output?: unknown;
-    errorText?: string | null;
-    presentation?: ToolPresentation | null;
-    raw: Record<string, unknown>;
-};
-type ChatReasoningPart = {
-    id: string;
-    type: "reasoning";
-    kind: "reasoning";
-    label?: string | null;
-    text?: string | null;
-    status?: string | null;
-    raw: Record<string, unknown>;
-};
-type ChatUiBlocksPart = {
-    id: string;
-    type: "ui-blocks";
-    kind: "ui-blocks";
-    state: ChatToolState;
-    toolCallId?: string | null;
-    contractVersion?: string | null;
-    bundle?: Record<string, unknown> | null;
-    errorText?: string | null;
-    raw: Record<string, unknown>;
-};
-type ChatApprovalPart = {
-    id: string;
-    type: "approval";
-    kind: "approval";
-    raw: Record<string, unknown>;
-};
-type ChatErrorPart = {
-    id: string;
-    type: "error";
-    kind: "error";
-    errorText: string;
-    raw: Record<string, unknown>;
-};
-type ChatDataPart = {
-    id: string;
-    type: "data";
-    kind: "data";
-    name: string;
-    data: Record<string, unknown>;
-    raw: Record<string, unknown>;
-};
-type ChatPart = ChatTextPart | ChatToolPart | ChatReasoningPart | ChatUiBlocksPart | ChatApprovalPart | ChatErrorPart | ChatDataPart;
-type ToolRenderer = (props: {
-    part: ChatToolPart;
-    message: ChatMessage;
-}) => ReactNode;
-type Agents24ChatRenderOptions = {
-    renderPart?: (part: ChatPart, message: ChatMessage) => ReactNode;
-    toolRenderers?: Partial<Record<`tool-${string}`, ToolRenderer>>;
-    fallbackToolRenderer?: ToolRenderer;
-};
-type ChatMessage = {
-    id: string;
-    role: "user" | "assistant";
-    runId?: string | null;
-    content: string;
-    createdAt: Date;
-    isFinal?: boolean;
-    parts: ChatPart[];
-    attachments?: ChatAttachment[];
-    citations?: ChatCitation[];
-    reasoningSteps?: ChatReasoningStep[];
-    thinkingDurationMs?: number;
-    liked?: boolean;
-    disliked?: boolean;
-    messageIndex?: number;
-    isVoice?: boolean;
-};
-type ChatRuntimeEvent = {
-    version?: string;
-    seq?: number;
-    ts?: string;
-    event: string;
-    run_id?: string;
-    stage?: string;
-    payload?: Record<string, unknown>;
-    diagnostics?: Array<Record<string, unknown>>;
-};
-type ChatActiveRun = {
-    run_id?: string | null;
-    status?: string | null;
-    started_at?: string | null;
-    created_at?: string | null;
-};
-type ChatThreadSummary = {
-    id: string;
-    title?: string | null;
-    status?: string | null;
-    surface?: string | null;
-    agent_id?: string | null;
-    last_run_id?: string | null;
-    last_run_status?: string | null;
-    active_run?: ChatActiveRun | null;
-    activeRun?: ChatActiveRun | null;
-    updated_at?: string | null;
-    last_activity_at?: string | null;
-    created_at?: string | null;
-    messages?: ChatMessage[];
-    isHydrated?: boolean;
-    hasOlderTurns?: boolean;
-    nextBeforeTurnIndex?: number | null;
-    lastRunId?: string | null;
-    lastRunStatus?: string | null;
-    lastEventSeq?: number | null;
-    isRunning?: boolean;
-    [key: string]: unknown;
-};
-type ChatThreadTurn = {
-    id?: string;
-    run_id?: string;
-    turn_index?: number;
-    status?: string | null;
-    user_input_text?: string | null;
-    assistant_output_text?: string | null;
-    final_output?: unknown;
-    response_blocks?: Array<Record<string, unknown>>;
-    run_events?: ChatRuntimeEvent[];
-    context_window?: unknown;
-    attachments?: Array<Record<string, unknown>>;
-    created_at?: string | null;
-    completed_at?: string | null;
-};
-type ChatThreadDetail = ChatThreadSummary & {
-    turns?: ChatThreadTurn[];
-    context_window?: unknown;
-    paging?: {
-        has_more?: boolean;
-        next_before_turn_index?: number | null;
-    };
-};
-type ChatTransport = {
-    listThreads: (input?: {
-        signal?: AbortSignal;
-    }) => Promise<{
-        items: ChatThreadSummary[];
-        total?: number;
-    }>;
-    getThread: (input: {
-        threadId: string;
-        limit?: number;
-        beforeTurnIndex?: number | null;
-        includeRunEvents?: boolean;
-        signal?: AbortSignal;
-    }) => Promise<ChatThreadDetail>;
-    streamMessage: (input: {
-        text: string;
-        threadId?: string | null;
-        files?: ChatAttachment[];
-        signal?: AbortSignal;
-    }, onEvent: (event: ChatRuntimeEvent) => void | Promise<void>) => Promise<ChatStreamResult>;
-    attachRun: (input: {
-        runId: string;
-        signal?: AbortSignal;
-    }, onEvent: (event: ChatRuntimeEvent) => void | Promise<void>) => Promise<ChatStreamResult>;
-    cancelRun: (input: {
-        runId: string;
-        assistantOutputText?: string;
-    }) => Promise<{
-        run_id?: string;
-        status?: string;
-    }>;
-    deleteThread?: (input: {
-        threadId: string;
-    }) => Promise<{
-        deleted?: boolean;
-    }>;
-    uploadAttachment?: (input: {
-        file: File;
-        signal?: AbortSignal;
-    }) => Promise<ChatAttachment>;
-};
-type ChatStreamResult = {
-    threadId?: string | null;
-    runId?: string | null;
-};
-type StoredChatThread = ChatThreadSummary & {
-    messages: ChatMessage[];
-    isHydrated?: boolean;
-    hasOlderTurns?: boolean;
-    nextBeforeTurnIndex?: number | null;
-};
-type ChatStorageAdapter = {
-    listThreads: () => StoredChatThread[];
-    setThreads: (threads: StoredChatThread[]) => void;
-    getThread: (threadId: string) => StoredChatThread | undefined;
-    upsertThread: (thread: StoredChatThread) => void;
-    deleteThread?: (threadId: string) => void;
-    getActiveThreadId?: () => string | null;
-    setActiveThreadId?: (threadId: string | null) => void;
-};
-type ChatController = {
-    messages: ChatMessage[];
-    streamingContent: string;
-    streamingMessageId: string | null;
-    contextStatus: ChatContextWindow | null;
-    currentReasoning: ChatReasoningStep[];
-    isLoading: boolean;
-    isLoadingHistory: boolean;
-    isLoadingOlder: boolean;
-    hasOlderTurns: boolean;
-    liked: Record<string, boolean>;
-    disliked: Record<string, boolean>;
-    copiedMessageId: string | null;
-    lastThinkingDurationMs: number | null;
-    activeRunId: string | null;
-    handleSubmit: (message: {
-        text: string;
-        files?: ChatAttachment[];
-    }) => Promise<void>;
-    handleStop: () => void;
-    handleCopy: (content: string, messageId: string) => void;
-    handleLike: (msg: ChatMessage) => Promise<void>;
-    handleDislike: (msg: ChatMessage) => Promise<void>;
-    handleRetry: (msg: ChatMessage) => Promise<void>;
-    handleSourceClick: (citations: ChatMessage["citations"]) => void;
-    upsertLiveVoiceMessage: (input: {
-        role: "user" | "assistant";
-        content: string;
-        isFinal?: boolean;
-        citations?: ChatCitation[];
-        reasoningSteps?: ChatReasoningStep[];
-    }) => void;
-    loadOlderTurns: () => Promise<void>;
-    refresh: () => Promise<void>;
-    textareaRef: RefObject<HTMLTextAreaElement | null>;
-};
-
-type UseAgents24ChatControllerOptions = {
-    transport: ChatTransport;
-    storage: ChatStorageAdapter;
-    activeThreadId?: string | null;
-    pageSize?: number;
-    storageKey?: unknown;
-    createId?: () => string;
-    onActiveThreadIdChange?: (threadId: string | null) => void;
-    onSourceClick?: (citations: ChatMessage["citations"]) => void;
-    onStreamErrorMessage?: (error: unknown) => string;
-};
-declare function useAgents24ChatController({ transport, storage, activeThreadId: controlledActiveThreadId, pageSize, storageKey, createId, onActiveThreadIdChange, onSourceClick, onStreamErrorMessage, }: UseAgents24ChatControllerOptions): ChatController;
-
-declare const DEFAULT_THREAD_PAGE_SIZE = 5;
-declare const isRunningThreadStatus: (status?: string | null) => boolean;
-declare const createChatId: () => string;
-declare const titleFromMessage: (text: string, files?: Array<{
-    filename?: string;
-}>) => string;
-declare const threadActivityDate: (thread: ChatThreadSummary) => string;
-declare const assistantTextFromResponseBlocks: (blocks?: Array<Record<string, unknown>>) => string;
-declare const assistantTextFromParts: (parts?: ChatPart[]) => string;
-declare const textFromFinalOutput: (value: unknown) => string;
-declare const toolStateFromStatus: (status?: unknown) => ChatToolState;
-declare const partsFromResponseBlocks: (blocks?: Array<Record<string, unknown>>, fallbackText?: string) => ChatPart[];
-declare const mergeReasoningSteps: (steps?: ChatReasoningStep[], options?: {
-    finalize?: boolean;
-}) => ChatReasoningStep[];
-declare const reasoningStepsFromParts: (parts?: ChatPart[]) => ChatReasoningStep[];
-declare const threadDetailToMessages: (thread: ChatThreadDetail) => ChatMessage[];
-declare const threadPaging: (thread: ChatThreadDetail) => {
-    hasOlderTurns: boolean;
-    nextBeforeTurnIndex: number | null;
-};
-declare const latestContextWindowFromThread: (thread: ChatThreadDetail) => ChatContextWindow | null;
-declare const activeRunIdFromThread: (thread?: Partial<ChatThreadSummary> | null) => string | null;
-declare const hasUnfinishedAssistantMessage: (messages?: ChatMessage[]) => boolean;
-declare const hasStaleUnfinishedAssistantCache: (thread?: (Partial<ChatThreadSummary> & {
-    messages?: ChatMessage[];
-}) | null) => boolean;
-declare const activeRunIdFromThreadDetail: (thread?: ChatThreadDetail | null) => string | null;
-
-declare const DefaultToolPart: ({ part }: {
-    part: ChatToolPart;
-}) => react.JSX.Element;
-declare const DefaultChatPart: ({ part, message, renderOptions, }: {
-    part: ChatPart;
-    message: ChatMessage;
-    renderOptions?: Agents24ChatRenderOptions;
-}) => react.JSX.Element;
-declare const renderChatPart: (part: ChatPart, message: ChatMessage, renderOptions?: Agents24ChatRenderOptions) => react.JSX.Element;
-
-declare const parseSseBlock: (block: string) => ChatRuntimeEvent | null;
-declare const consumeSseResponse: (response: Response, onEvent: (event: ChatRuntimeEvent) => void | Promise<void>) => Promise<ChatStreamResult>;
-
-type StreamingTextMode = "streaming" | "static";
-type StreamingTextCache = {
-    get: (id: string) => string | undefined;
-    set: (id: string, text: string) => void;
-};
-type UseStreamingTextOptions = {
-    id: string;
-    isStreaming: boolean;
-    text: string;
-    cache?: StreamingTextCache | false;
-    charsPerSecond?: number;
-    catchupThreshold?: number;
-    maxCatchupChars?: number;
-};
-type UseStreamingTextResult = {
-    displayedText: string;
-    isAnimating: boolean;
-    mode: StreamingTextMode;
-    parseIncompleteMarkdown: boolean;
-};
-declare const getActiveStreamingTextPartId: (message: ChatMessage, streamingMessageId: string | null) => string | null;
-declare const isActiveStreamingTextPart: (message: ChatMessage, part: ChatPart, streamingMessageId: string | null) => boolean;
-declare function useStreamingText({ id, isStreaming, text, cache, charsPerSecond, catchupThreshold, maxCatchupChars, }: UseStreamingTextOptions): UseStreamingTextResult;
-
-type MaybePromise<T> = T | Promise<T>;
-type FetchChatTransportRoutes = {
-    listThreads: () => string;
-    getThread: (input: {
-        threadId: string;
-        limit?: number;
-        beforeTurnIndex?: number | null;
-        includeRunEvents?: boolean;
-    }) => string;
-    streamMessage: () => string;
-    attachRun: (input: {
-        runId: string;
-    }) => string;
-    cancelRun: (input: {
-        runId: string;
-    }) => string;
-    deleteThread?: (input: {
-        threadId: string;
-    }) => string;
-};
-type FetchChatTransportOptions = {
-    routes: FetchChatTransportRoutes;
-    fetchImpl?: typeof fetch;
-    headers?: () => MaybePromise<HeadersInit>;
-    streamBody?: (input: {
-        text: string;
-        threadId?: string | null;
-        files?: ChatAttachment[];
-    }) => unknown;
-};
-declare const createFetchChatTransport: ({ routes, fetchImpl, headers, streamBody, }: FetchChatTransportOptions) => ChatTransport;
-
-type LatestFollowState = "following" | "detached";
-declare const isScrollable: (element: Pick<HTMLDivElement, "scrollHeight" | "clientHeight">) => boolean;
-declare const isAtTimelineLatestEdge: (element: Pick<HTMLDivElement, "scrollHeight" | "clientHeight" | "scrollTop">, isTopOrigin: boolean) => boolean;
-declare const shouldPrefetchOlder: (element: Pick<HTMLDivElement, "scrollHeight" | "clientHeight" | "scrollTop">) => boolean;
-declare const getLatestScrollTop: (element: Pick<HTMLDivElement, "scrollHeight" | "clientHeight">, isTopOrigin: boolean) => number;
-declare const shouldUseTopOriginTimeline: ({ hasOlder, itemCount, topOriginMaxItems, }: {
-    hasOlder: boolean;
-    itemCount: number;
-    topOriginMaxItems?: number;
-}) => boolean;
-declare const nextLatestFollowStateOnScroll: ({ atLatest, current, isProgrammatic, }: {
-    atLatest: boolean;
-    current: LatestFollowState;
-    isProgrammatic: boolean;
-}) => LatestFollowState;
-type UseLatestThreadViewportOptions = {
-    itemCount: number;
-    hasOlder: boolean;
-    isLoadingOlder: boolean;
-    onLoadOlder: () => Promise<void> | void;
-    activeStreamKey?: string | null;
-    shouldAutoFollow?: boolean;
-    topOriginMaxItems?: number;
-};
-type LatestThreadViewportState = {
-    scrollContainerRef: RefObject<HTMLDivElement | null>;
-    isAtLatest: boolean;
-    isFollowingLatest: boolean;
-    isTopOrigin: boolean;
-    shouldShowLatestButton: boolean;
-    handleScroll: (event: UIEvent<HTMLDivElement>) => void;
-    handleUserScrollIntent: () => void;
-    scrollToLatest: (options?: {
-        reattach?: boolean;
-    }) => void;
-    detachFromLatest: () => void;
-    reattachToLatest: () => void;
-    preserveIntrinsicResize: () => void;
-};
-declare function useLatestThreadViewport({ itemCount, hasOlder, isLoadingOlder, onLoadOlder, activeStreamKey, shouldAutoFollow, topOriginMaxItems, }: UseLatestThreadViewportOptions): LatestThreadViewportState;
-type LatestThreadViewportRenderContext = {
-    preserveIntrinsicResize: () => void;
-    isFollowingLatest: boolean;
-    isTopOrigin: boolean;
-};
-type LatestThreadViewportProps<T> = {
-    items: T[];
-    hasOlder: boolean;
-    isLoadingOlder: boolean;
-    onLoadOlder: () => Promise<void> | void;
-    activeStreamKey?: string | null;
-    className?: string;
-    latestSpacer?: ReactNode;
-    trailingSpacer?: ReactNode;
-    renderItem: (item: T, context: LatestThreadViewportRenderContext) => ReactNode;
-};
-declare function LatestThreadViewport<T>({ items, hasOlder, isLoadingOlder, onLoadOlder, activeStreamKey, className, latestSpacer, trailingSpacer, renderItem, }: LatestThreadViewportProps<T>): react.JSX.Element;
-
-export { type Agents24ChatRenderOptions, type ChatActiveRun, type ChatApprovalPart, type ChatAttachment, type ChatCitation, type ChatContextWindow, type ChatController, type ChatDataPart, type ChatErrorPart, type ChatMessage, type ChatPart, type ChatReasoningPart, type ChatReasoningStep, type ChatRunStatus, type ChatRuntimeEvent, type ChatStorageAdapter, type ChatStreamResult, type ChatTextPart, type ChatThreadDetail, type ChatThreadSummary, type ChatThreadTurn, type ChatToolPart, type ChatToolState, type ChatTransport, type ChatUiBlocksPart, DEFAULT_THREAD_PAGE_SIZE, DefaultChatPart, DefaultToolPart, type FetchChatTransportOptions, type FetchChatTransportRoutes, type LatestFollowState, LatestThreadViewport, type LatestThreadViewportProps, type LatestThreadViewportRenderContext, type LatestThreadViewportState, type StoredChatThread, type StreamingTextCache, type StreamingTextMode, type ToolPresentation, type ToolRenderer, type UseAgents24ChatControllerOptions, type UseLatestThreadViewportOptions, type UseStreamingTextOptions, type UseStreamingTextResult, activeRunIdFromThread, activeRunIdFromThreadDetail, assistantTextFromParts, assistantTextFromResponseBlocks, consumeSseResponse, createChatId, createFetchChatTransport, getActiveStreamingTextPartId, getLatestScrollTop, hasStaleUnfinishedAssistantCache, hasUnfinishedAssistantMessage, isActiveStreamingTextPart, isAtTimelineLatestEdge, isRunningThreadStatus, isScrollable, latestContextWindowFromThread, mergeReasoningSteps, nextLatestFollowStateOnScroll, parseSseBlock, partsFromResponseBlocks, reasoningStepsFromParts, renderChatPart, shouldPrefetchOlder, shouldUseTopOriginTimeline, textFromFinalOutput, threadActivityDate, threadDetailToMessages, threadPaging, titleFromMessage, toolStateFromStatus, useAgents24ChatController, useLatestThreadViewport, useStreamingText };
+export * from "./controller";
+export * from "./context-window";
+export * from "./latest-thread-scroller";
+export * from "./model";
+export * from "./renderers";
+export * from "./sse";
+export * from "./streaming-text";
+export * from "./transport";
+export * from "./types";
+export * from "./viewport";