@copilotkitnext/react 0.0.18 → 0.0.19-threads-and-attachements.0

package/dist/index.d.ts

@@ -1,12 +1,13 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as React$1 from 'react';
 import React__default, { ReactNode } from 'react';
-import { AssistantMessage, Message, UserMessage, ToolCall, ToolMessage } from '@ag-ui/core';
+import { AssistantMessage, Message, UserMessage, InputContent, ToolCall, ToolMessage } from '@ag-ui/core';
 import { Streamdown } from 'streamdown';
 import { Suggestion, CopilotKitCore, ToolCallStatus, FrontendTool, DynamicSuggestionsConfig, StaticSuggestionsConfig, CopilotKitCoreConfig, CopilotKitCoreSubscriber } from '@copilotkitnext/core';
+import { ThreadMetadata } from '@copilotkitnext/shared';
+export { ThreadMetadata } from '@copilotkitnext/shared';
 import { z } from 'zod';
 import * as _lit_labs_react from '@lit-labs/react';
-import { WebInspectorElement } from '@copilotkitnext/web-inspector';
 import { AbstractAgent, Context } from '@ag-ui/client';
 
 declare const CopilotChatDefaultLabels: {
@@ -35,6 +36,7 @@ interface CopilotChatConfigurationValue {
     labels: CopilotChatLabels;
     agentId: string;
     threadId: string;
+    setThreadId?: (threadId: string) => void;
     isModalOpen: boolean;
     setModalOpen: (open: boolean) => void;
     isModalDefaultOpen: boolean;
@@ -196,26 +198,29 @@ type CopilotChatUserMessageProps = WithSlots<{
 } & React.HTMLAttributes<HTMLDivElement>>;
 declare function CopilotChatUserMessage({ message, onEditMessage, branchIndex, numberOfBranches, onSwitchToBranch, additionalToolbarItems, messageRenderer, toolbar, copyButton, editButton, branchNavigation, children, className, ...props }: CopilotChatUserMessageProps): react_jsx_runtime.JSX.Element;
 declare namespace CopilotChatUserMessage {
-    const Container: React.FC<React.PropsWithChildren<React.HTMLAttributes<HTMLDivElement>>>;
-    const MessageRenderer: React.FC<{
+    export const Container: React.FC<React.PropsWithChildren<React.HTMLAttributes<HTMLDivElement>>>;
+    type MessageRendererProps = {
         content: string;
+        contents?: InputContent[];
         className?: string;
-    }>;
-    const Toolbar: React.FC<React.HTMLAttributes<HTMLDivElement>>;
-    const ToolbarButton: React.FC<React.ButtonHTMLAttributes<HTMLButtonElement> & {
+    };
+    export const MessageRenderer: React.FC<MessageRendererProps>;
+    export const Toolbar: React.FC<React.HTMLAttributes<HTMLDivElement>>;
+    export const ToolbarButton: React.FC<React.ButtonHTMLAttributes<HTMLButtonElement> & {
         title: string;
         children: React.ReactNode;
     }>;
-    const CopyButton: React.FC<React.ButtonHTMLAttributes<HTMLButtonElement> & {
+    export const CopyButton: React.FC<React.ButtonHTMLAttributes<HTMLButtonElement> & {
         copied?: boolean;
     }>;
-    const EditButton: React.FC<React.ButtonHTMLAttributes<HTMLButtonElement>>;
-    const BranchNavigation: React.FC<React.HTMLAttributes<HTMLDivElement> & {
+    export const EditButton: React.FC<React.ButtonHTMLAttributes<HTMLButtonElement>>;
+    export const BranchNavigation: React.FC<React.HTMLAttributes<HTMLDivElement> & {
         currentBranch?: number;
         numberOfBranches?: number;
         onSwitchToBranch?: (props: CopilotChatUserMessageOnSwitchToBranchProps) => void;
         message: UserMessage;
     }>;
+    export {  };
 }
 
 interface CopilotChatSuggestionPillProps extends React__default.ButtonHTMLAttributes<HTMLButtonElement> {
@@ -286,16 +291,26 @@ type CopilotChatViewProps = WithSlots<{
 }, {
     messages?: Message[];
     autoScroll?: boolean;
+    /**
+     * Controls scroll behavior:
+     * - "smooth": Always smooth scroll
+     * - "instant": Always instant scroll
+     * - "auto": Instant scroll on mount and thread switches, smooth scroll during generation (default)
+     */
+    scrollBehavior?: "smooth" | "instant" | "auto";
     inputProps?: Partial<Omit<CopilotChatInputProps, "children">>;
     isRunning?: boolean;
+    isSwitchingThread?: boolean;
     suggestions?: Suggestion[];
     suggestionLoadingIndexes?: ReadonlyArray<number>;
     onSelectSuggestion?: (suggestion: Suggestion, index: number) => void;
 } & React__default.HTMLAttributes<HTMLDivElement>>;
-declare function CopilotChatView({ messageView, input, scrollView, scrollToBottomButton, feather, inputContainer, disclaimer, suggestionView, messages, autoScroll, inputProps, isRunning, suggestions, suggestionLoadingIndexes, onSelectSuggestion, children, className, ...props }: CopilotChatViewProps): string | number | bigint | boolean | Iterable<React__default.ReactNode> | Promise<string | number | bigint | boolean | React__default.ReactPortal | React__default.ReactElement<unknown, string | React__default.JSXElementConstructor<any>> | Iterable<React__default.ReactNode> | null | undefined> | react_jsx_runtime.JSX.Element | null | undefined;
+declare function CopilotChatView({ messageView, input, scrollView, scrollToBottomButton, feather, inputContainer, disclaimer, suggestionView, messages, autoScroll, scrollBehavior, inputProps, isRunning, isSwitchingThread, suggestions, suggestionLoadingIndexes, onSelectSuggestion, children, className, ...props }: CopilotChatViewProps): string | number | bigint | boolean | Iterable<React__default.ReactNode> | Promise<string | number | bigint | boolean | React__default.ReactPortal | React__default.ReactElement<unknown, string | React__default.JSXElementConstructor<any>> | Iterable<React__default.ReactNode> | null | undefined> | react_jsx_runtime.JSX.Element | null | undefined;
 declare namespace CopilotChatView {
     const ScrollView: React__default.FC<React__default.HTMLAttributes<HTMLDivElement> & {
         autoScroll?: boolean;
+        scrollBehavior?: "smooth" | "instant" | "auto";
+        isSwitchingThread?: boolean;
         scrollToBottomButton?: React__default.FC<React__default.ButtonHTMLAttributes<HTMLButtonElement>>;
         inputContainerHeight?: number;
         isResizing?: boolean;
@@ -334,25 +349,41 @@ declare const CopilotChatToggleButton: React__default.ForwardRefExoticComponent<
 type HeaderSlots = {
     titleContent: typeof CopilotModalHeader.Title;
     closeButton: typeof CopilotModalHeader.CloseButton;
+    leftContent: typeof CopilotModalHeader.LeftContent;
 };
 type HeaderRestProps = {
     title?: string;
+    onThreadListClick?: () => void;
+    showThreadListButton?: boolean;
+    onNewThreadClick?: () => void;
+    showNewThreadButton?: boolean;
 } & Omit<React__default.HTMLAttributes<HTMLDivElement>, "children">;
 type CopilotModalHeaderProps = WithSlots<HeaderSlots, HeaderRestProps>;
-declare function CopilotModalHeader({ title, titleContent, closeButton, children, className, ...rest }: CopilotModalHeaderProps): string | number | bigint | boolean | Iterable<React__default.ReactNode> | Promise<string | number | bigint | boolean | React__default.ReactPortal | React__default.ReactElement<unknown, string | React__default.JSXElementConstructor<any>> | Iterable<React__default.ReactNode> | null | undefined> | react_jsx_runtime.JSX.Element | null | undefined;
+declare function CopilotModalHeader({ title, titleContent, closeButton, leftContent, onThreadListClick, showThreadListButton, onNewThreadClick, showNewThreadButton, children, className, ...rest }: CopilotModalHeaderProps): string | number | bigint | boolean | Iterable<React__default.ReactNode> | Promise<string | number | bigint | boolean | React__default.ReactPortal | React__default.ReactElement<unknown, string | React__default.JSXElementConstructor<any>> | Iterable<React__default.ReactNode> | null | undefined> | react_jsx_runtime.JSX.Element | null | undefined;
 declare namespace CopilotModalHeader {
     var displayName: string;
 }
 declare namespace CopilotModalHeader {
     const Title: React__default.FC<React__default.HTMLAttributes<HTMLDivElement>>;
     const CloseButton: React__default.FC<React__default.ButtonHTMLAttributes<HTMLButtonElement>>;
+    interface LeftContentProps {
+        onThreadListClick?: () => void;
+        showThreadListButton?: boolean;
+        onNewThreadClick?: () => void;
+        showNewThreadButton?: boolean;
+        className?: string;
+        children?: React__default.ReactNode;
+    }
+    const LeftContent: React__default.FC<LeftContentProps>;
 }
 
 type CopilotSidebarViewProps = CopilotChatViewProps & {
     header?: SlotValue<typeof CopilotModalHeader>;
     width?: number | string;
+    showThreadListButton?: boolean;
+    showNewThreadButton?: boolean;
 };
-declare function CopilotSidebarView({ header, width, ...props }: CopilotSidebarViewProps): react_jsx_runtime.JSX.Element;
+declare function CopilotSidebarView({ header, width, showThreadListButton, showNewThreadButton, ...props }: CopilotSidebarViewProps): react_jsx_runtime.JSX.Element;
 declare namespace CopilotSidebarView {
     var displayName: string;
 }
@@ -362,8 +393,10 @@ type CopilotPopupViewProps = CopilotChatViewProps & {
     width?: number | string;
     height?: number | string;
     clickOutsideToClose?: boolean;
+    showThreadListButton?: boolean;
+    showNewThreadButton?: boolean;
 };
-declare function CopilotPopupView({ header, width, height, clickOutsideToClose, className, ...restProps }: CopilotPopupViewProps): react_jsx_runtime.JSX.Element;
+declare function CopilotPopupView({ header, width, height, clickOutsideToClose, showThreadListButton, showNewThreadButton, className, ...restProps }: CopilotPopupViewProps): react_jsx_runtime.JSX.Element;
 declare namespace CopilotPopupView {
     var displayName: string;
 }
@@ -372,8 +405,10 @@ type CopilotSidebarProps = Omit<CopilotChatProps, "chatView"> & {
     header?: CopilotSidebarViewProps["header"];
     defaultOpen?: boolean;
     width?: number | string;
+    showThreadListButton?: boolean;
+    showNewThreadButton?: boolean;
 };
-declare function CopilotSidebar({ header, defaultOpen, width, ...chatProps }: CopilotSidebarProps): react_jsx_runtime.JSX.Element;
+declare function CopilotSidebar({ header, defaultOpen, width, showThreadListButton, showNewThreadButton, ...chatProps }: CopilotSidebarProps): react_jsx_runtime.JSX.Element;
 declare namespace CopilotSidebar {
     var displayName: string;
 }
@@ -384,20 +419,79 @@ type CopilotPopupProps = Omit<CopilotChatProps, "chatView"> & {
     width?: CopilotPopupViewProps["width"];
     height?: CopilotPopupViewProps["height"];
     clickOutsideToClose?: CopilotPopupViewProps["clickOutsideToClose"];
+    showThreadListButton?: boolean;
+    showNewThreadButton?: boolean;
 };
-declare function CopilotPopup({ header, defaultOpen, width, height, clickOutsideToClose, ...chatProps }: CopilotPopupProps): react_jsx_runtime.JSX.Element;
+declare function CopilotPopup({ header, defaultOpen, width, height, clickOutsideToClose, showThreadListButton, showNewThreadButton, ...chatProps }: CopilotPopupProps): react_jsx_runtime.JSX.Element;
 declare namespace CopilotPopup {
     var displayName: string;
 }
 
+interface CopilotThreadListProps {
+    /**
+     * Number of threads to load initially
+     */
+    limit?: number;
+    /**
+     * Callback when a thread is selected
+     */
+    onThreadSelect?: (threadId: string) => void;
+    /**
+     * Custom className for the container
+     */
+    className?: string;
+    /**
+     * Slot for customizing thread items
+     */
+    threadItem?: SlotValue<typeof ThreadListItem>;
+    /**
+     * Slot for customizing the new thread button
+     */
+    newThreadButton?: SlotValue<typeof NewThreadButton>;
+    /**
+     * Slot for customizing the container
+     */
+    container?: SlotValue<typeof Container>;
+    /**
+     * Interval in milliseconds for auto-refreshing threads when a thread is running or unnamed.
+     * @default 2000
+     */
+    refreshInterval?: number;
+    /**
+     * Disable automatic polling/refresh of threads.
+     * Use this when you have external invalidation mechanisms (e.g., React Query, SWR).
+     * @default false
+     */
+    disableAutoRefresh?: boolean;
+}
+declare const Container: React__default.FC<React__default.HTMLAttributes<HTMLDivElement>>;
+declare const NewThreadButton: React__default.FC<React__default.ButtonHTMLAttributes<HTMLButtonElement>>;
+interface ThreadListItemProps {
+    thread: ThreadMetadata;
+    isActive?: boolean;
+    onClick?: () => void;
+    onDelete?: () => void;
+}
+declare const ThreadListItem: React__default.FC<ThreadListItemProps>;
+declare function CopilotThreadList(props: CopilotThreadListProps): react_jsx_runtime.JSX.Element;
+declare namespace CopilotThreadList {
+    var displayName: string;
+    var ThreadItem: React__default.FC<ThreadListItemProps>;
+    var NewThreadButton: React__default.FC<React__default.ButtonHTMLAttributes<HTMLButtonElement>>;
+    var Container: React__default.FC<React__default.HTMLAttributes<HTMLDivElement>>;
+}
+
 declare const WildcardToolCallRender: ReactToolCallRenderer<any>;
 
-declare const CopilotKitInspectorBase: _lit_labs_react.ReactWebComponent<WebInspectorElement, {}>;
+type WebInspectorElementInstance = HTMLElement & {
+    core: CopilotKitCore | null;
+};
+declare const CopilotKitInspectorBase: _lit_labs_react.ReactWebComponent<HTMLElement, {}>;
 type CopilotKitInspectorBaseProps = React$1.ComponentProps<typeof CopilotKitInspectorBase>;
 interface CopilotKitInspectorProps extends Omit<CopilotKitInspectorBaseProps, "core"> {
     core?: CopilotKitCore | null;
 }
-declare const CopilotKitInspector: React$1.ForwardRefExoticComponent<Omit<CopilotKitInspectorProps, "ref"> & React$1.RefAttributes<WebInspectorElement>>;
+declare const CopilotKitInspector: React$1.ForwardRefExoticComponent<Omit<CopilotKitInspectorProps, "ref"> & React$1.RefAttributes<WebInspectorElementInstance>>;
 
 interface UseRenderToolCallProps {
     toolCall: ToolCall;
@@ -527,6 +621,62 @@ interface UseConfigureSuggestionsOptions {
 }
 declare function useConfigureSuggestions(config: SuggestionsConfigInput | null | undefined, options?: UseConfigureSuggestionsOptions): void;
 
+interface UseThreadsOptions {
+    limit?: number;
+    autoFetch?: boolean;
+}
+interface UseThreadsResult {
+    threads: ThreadMetadata[];
+    total: number;
+    isLoading: boolean;
+    error: Error | null;
+    fetchThreads: (offset?: number) => Promise<void>;
+    getThreadMetadata: (threadId: string) => Promise<ThreadMetadata | null>;
+    refresh: () => Promise<void>;
+    addOptimisticThread: (threadId: string) => void;
+    deleteThread: (threadId: string) => Promise<void>;
+    currentThreadId?: string;
+}
+/**
+ * Hook for managing and retrieving threads from the CopilotKit runtime.
+ *
+ * @example
+ * ```tsx
+ * const { threads, isLoading, fetchThreads } = useThreads({ limit: 20 });
+ *
+ * // Manually fetch threads
+ * await fetchThreads();
+ *
+ * // Paginate
+ * await fetchThreads(20); // offset = 20
+ * ```
+ */
+declare function useThreads(options?: UseThreadsOptions): UseThreadsResult;
+
+/**
+ * Hook to programmatically switch threads.
+ *
+ * This is a simple wrapper around the configuration context's setThreadId.
+ * The actual disconnect/connect logic is handled by CopilotChat.
+ *
+ * @example
+ * ```tsx
+ * function MyComponent() {
+ *   const { switchThread, currentThreadId } = useThreadSwitch();
+ *
+ *   return (
+ *     <button onClick={() => switchThread('new-thread-id')}>
+ *       Switch Thread
+ *     </button>
+ *   );
+ * }
+ * ```
+ */
+declare function useThreadSwitch(): {
+    switchThread: (threadId: string) => void;
+    currentThreadId: string | undefined;
+};
+
 /**
  * Helper to define a type-safe tool call renderer entry.
  * - Accepts a single object whose keys match ReactToolCallRenderer's fields: { name, args, render, agentId? }.
@@ -585,12 +735,39 @@ declare class CopilotKitCoreReact extends CopilotKitCore {
 
 interface CopilotKitContextValue {
     copilotkit: CopilotKitCoreReact;
+    /**
+     * Set the resource ID(s) dynamically.
+     * Use this to update resource scoping when the user switches context (e.g., workspace switcher).
+     *
+     * @example
+     * ```tsx
+     * const { setResourceId } = useCopilotKit();
+     * setResourceId(newWorkspaceId);
+     * ```
+     */
+    setResourceId: (resourceId: string | string[] | undefined) => void;
 }
 interface CopilotKitProviderProps {
     children: ReactNode;
     runtimeUrl?: string;
     headers?: Record<string, string>;
     properties?: Record<string, unknown>;
+    /**
+     * Resource ID(s) for thread access control.
+     *
+     * This value is sent to the server as a hint for thread scoping.
+     * The server's `resolveThreadsScope` validates and enforces access control.
+     *
+     * @example
+     * ```tsx
+     * // Single resource
+     * <CopilotKitProvider resourceId={userId}>
+     *
+     * // Multiple resources (thread accessible by any of these)
+     * <CopilotKitProvider resourceId={[userId, workspaceId]}>
+     * ```
+     */
+    resourceId?: string | string[];
     agents__unsafe_dev_only?: Record<string, AbstractAgent>;
     renderToolCalls?: ReactToolCallRenderer<any>[];
     renderCustomMessages?: ReactCustomMessageRenderer[];
@@ -601,4 +778,4 @@ interface CopilotKitProviderProps {
 declare const CopilotKitProvider: React__default.FC<CopilotKitProviderProps>;
 declare const useCopilotKit: () => CopilotKitContextValue;
 
-export { AudioRecorderError, type AudioRecorderState, CopilotChat, CopilotChatAssistantMessage, type CopilotChatAssistantMessageProps, CopilotChatAudioRecorder, CopilotChatConfigurationProvider, type CopilotChatConfigurationProviderProps, type CopilotChatConfigurationValue, CopilotChatInput, type CopilotChatInputProps, type CopilotChatLabels, CopilotChatMessageView, type CopilotChatMessageViewProps, type CopilotChatProps, CopilotChatSuggestionPill, type CopilotChatSuggestionPillProps, CopilotChatSuggestionView, type CopilotChatSuggestionViewProps, CopilotChatToggleButton, DefaultCloseIcon as CopilotChatToggleButtonCloseIcon, DefaultOpenIcon as CopilotChatToggleButtonOpenIcon, type CopilotChatToggleButtonProps, CopilotChatToolCallsView, type CopilotChatToolCallsViewProps, CopilotChatUserMessage, type CopilotChatUserMessageProps, CopilotChatView, type CopilotChatViewProps, type CopilotKitContextValue, CopilotKitCoreReact, type CopilotKitCoreReactConfig, type CopilotKitCoreReactSubscriber, CopilotKitInspector, type CopilotKitInspectorBaseProps, type CopilotKitInspectorProps, CopilotKitProvider, type CopilotKitProviderProps, CopilotModalHeader, type CopilotModalHeaderProps, CopilotPopup, type CopilotPopupProps, CopilotPopupView, type CopilotPopupViewProps, CopilotSidebar, type CopilotSidebarProps, CopilotSidebarView, type CopilotSidebarViewProps, type ReactCustomMessageRenderer, type ReactCustomMessageRendererPosition, type ReactFrontendTool, type ReactHumanInTheLoop, type ReactToolCallRenderer, type ToolsMenuItem, WildcardToolCallRender, defineToolCallRenderer, useAgent, useAgentContext, useConfigureSuggestions, useCopilotChatConfiguration, useCopilotKit, useFrontendTool, useHumanInTheLoop, useRenderCustomMessages, useRenderToolCall, useSuggestions };
+export { AudioRecorderError, type AudioRecorderState, CopilotChat, CopilotChatAssistantMessage, type CopilotChatAssistantMessageProps, CopilotChatAudioRecorder, CopilotChatConfigurationProvider, type CopilotChatConfigurationProviderProps, type CopilotChatConfigurationValue, CopilotChatInput, type CopilotChatInputProps, type CopilotChatLabels, CopilotChatMessageView, type CopilotChatMessageViewProps, type CopilotChatProps, CopilotChatSuggestionPill, type CopilotChatSuggestionPillProps, CopilotChatSuggestionView, type CopilotChatSuggestionViewProps, CopilotChatToggleButton, DefaultCloseIcon as CopilotChatToggleButtonCloseIcon, DefaultOpenIcon as CopilotChatToggleButtonOpenIcon, type CopilotChatToggleButtonProps, CopilotChatToolCallsView, type CopilotChatToolCallsViewProps, CopilotChatUserMessage, type CopilotChatUserMessageProps, CopilotChatView, type CopilotChatViewProps, type CopilotKitContextValue, CopilotKitCoreReact, type CopilotKitCoreReactConfig, type CopilotKitCoreReactSubscriber, CopilotKitInspector, type CopilotKitInspectorBaseProps, type CopilotKitInspectorProps, CopilotKitProvider, type CopilotKitProviderProps, CopilotModalHeader, type CopilotModalHeaderProps, CopilotPopup, type CopilotPopupProps, CopilotPopupView, type CopilotPopupViewProps, CopilotSidebar, type CopilotSidebarProps, CopilotSidebarView, type CopilotSidebarViewProps, CopilotThreadList, type CopilotThreadListProps, type ReactCustomMessageRenderer, type ReactCustomMessageRendererPosition, type ReactFrontendTool, type ReactHumanInTheLoop, type ReactToolCallRenderer, type ToolsMenuItem, type UseThreadsOptions, type UseThreadsResult, WildcardToolCallRender, defineToolCallRenderer, useAgent, useAgentContext, useConfigureSuggestions, useCopilotChatConfiguration, useCopilotKit, useFrontendTool, useHumanInTheLoop, useRenderCustomMessages, useRenderToolCall, useSuggestions, useThreadSwitch, useThreads };