@copilotkitnext/react 0.0.8 → 0.0.9-alpha.1

package/dist/index.d.mts

@@ -27,16 +27,14 @@ declare const CopilotChatDefaultLabels: {
 type CopilotChatLabels = typeof CopilotChatDefaultLabels;
 interface CopilotChatConfigurationValue {
     labels: CopilotChatLabels;
-    inputValue?: string;
-    onSubmitInput?: (value: string) => void;
-    onChangeInput?: (value: string) => void;
+    agentId: string;
+    threadId: string;
 }
 interface CopilotChatConfigurationProviderProps {
     children: ReactNode;
     labels?: Partial<CopilotChatLabels>;
-    inputValue?: string;
-    onSubmitInput?: (value: string) => void;
-    onChangeInput?: (value: string) => void;
+    agentId?: string;
+    threadId: string;
 }
 declare const CopilotChatConfigurationProvider: React__default.FC<CopilotChatConfigurationProviderProps>;
 declare const useCopilotChatConfiguration: () => CopilotChatConfigurationValue;
@@ -120,9 +118,9 @@ declare namespace CopilotChatInput {
 type CopilotChatToolCallsViewProps = {
     message: AssistantMessage;
     messages?: Message[];
-    isLoading?: boolean;
+    isRunning?: boolean;
 };
-declare function CopilotChatToolCallsView({ message, messages, isLoading, }: CopilotChatToolCallsViewProps): react_jsx_runtime.JSX.Element | null;
+declare function CopilotChatToolCallsView({ message, messages, isRunning, }: CopilotChatToolCallsViewProps): react_jsx_runtime.JSX.Element | null;
 
 type CopilotChatAssistantMessageProps = WithSlots<{
     markdownRenderer: typeof CopilotChatAssistantMessage.MarkdownRenderer;
@@ -140,11 +138,11 @@ type CopilotChatAssistantMessageProps = WithSlots<{
     onRegenerate?: (message: AssistantMessage) => void;
     message: AssistantMessage;
     messages?: Message[];
-    isLoading?: boolean;
+    isRunning?: boolean;
     additionalToolbarItems?: React.ReactNode;
     toolbarVisible?: boolean;
 } & React.HTMLAttributes<HTMLDivElement>>;
-declare function CopilotChatAssistantMessage({ message, messages, isLoading, onThumbsUp, onThumbsDown, onReadAloud, onRegenerate, additionalToolbarItems, toolbarVisible, markdownRenderer, toolbar, copyButton, thumbsUpButton, thumbsDownButton, readAloudButton, regenerateButton, toolCallsView, children, className, ...props }: CopilotChatAssistantMessageProps): react_jsx_runtime.JSX.Element;
+declare function CopilotChatAssistantMessage({ message, messages, isRunning, onThumbsUp, onThumbsDown, onReadAloud, onRegenerate, additionalToolbarItems, toolbarVisible, markdownRenderer, toolbar, copyButton, thumbsUpButton, thumbsDownButton, readAloudButton, regenerateButton, toolCallsView, children, className, ...props }: CopilotChatAssistantMessageProps): react_jsx_runtime.JSX.Element;
 declare namespace CopilotChatAssistantMessage {
     const MarkdownRenderer: React.FC<React.HTMLAttributes<HTMLDivElement> & {
         content: string;
@@ -212,16 +210,16 @@ type CopilotChatMessageViewProps = Omit<WithSlots<{
     userMessage: typeof CopilotChatUserMessage;
     cursor: typeof CopilotChatMessageView.Cursor;
 }, {
-    isLoading?: boolean;
+    isRunning?: boolean;
     messages?: Message[];
 } & React.HTMLAttributes<HTMLDivElement>>, "children"> & {
     children?: (props: {
-        isLoading: boolean;
+        isRunning: boolean;
         messages: Message[];
         messageElements: React.ReactElement[];
     }) => React.ReactElement;
 };
-declare function CopilotChatMessageView({ messages, assistantMessage, userMessage, cursor, isLoading, children, className, ...props }: CopilotChatMessageViewProps): react_jsx_runtime.JSX.Element;
+declare function CopilotChatMessageView({ messages, assistantMessage, userMessage, cursor, isRunning, children, className, ...props }: CopilotChatMessageViewProps): react_jsx_runtime.JSX.Element;
 declare namespace CopilotChatMessageView {
     var Cursor: ({ className, ...props }: React.HTMLAttributes<HTMLDivElement>) => react_jsx_runtime.JSX.Element;
 }
@@ -239,8 +237,10 @@ type CopilotChatViewProps = WithSlots<{
 }, {
     messages?: Message[];
     autoScroll?: boolean;
+    inputProps?: Partial<Omit<CopilotChatInputProps, "children">>;
+    isRunning?: boolean;
 } & React__default.HTMLAttributes<HTMLDivElement>>;
-declare function CopilotChatView({ messageView, input, scrollView, scrollToBottomButton, feather, inputContainer, disclaimer, messages, autoScroll, 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, messages, autoScroll, inputProps, isRunning, 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;
@@ -265,7 +265,7 @@ declare function CopilotChat({ agentId, threadId, ...props }: CopilotChatProps):
 interface UseRenderToolCallProps {
     toolCall: ToolCall;
     toolMessage?: ToolMessage;
-    isLoading: boolean;
+    isRunning: boolean;
 }
 /**
  * Hook that returns a function to render tool calls based on the render functions
@@ -273,7 +273,7 @@ interface UseRenderToolCallProps {
  *
  * @returns A function that takes a tool call and optional tool message and returns the rendered component
  */
-declare function useRenderToolCall(): ({ toolCall, toolMessage, isLoading, }: UseRenderToolCallProps) => React__default.ReactElement | null;
+declare function useRenderToolCall(): ({ toolCall, toolMessage, isRunning, }: UseRenderToolCallProps) => React__default.ReactElement | null;
 
 interface ReactToolCallRender<T> {
     name: string;
@@ -284,14 +284,17 @@ interface ReactToolCallRender<T> {
      */
     agentId?: string;
     render: React.ComponentType<{
+        name: string;
         args: Partial<T>;
         status: ToolCallStatus.InProgress;
         result: undefined;
     } | {
+        name: string;
         args: T;
         status: ToolCallStatus.Executing;
         result: undefined;
     } | {
+        name: string;
         args: T;
         status: ToolCallStatus.Complete;
         result: string;
@@ -331,12 +334,17 @@ type ReactHumanInTheLoop<T extends Record<string, unknown> = Record<string, unkn
 
 declare function useHumanInTheLoop<T extends Record<string, unknown> = Record<string, unknown>>(tool: ReactHumanInTheLoop<T>): void;
 
+declare enum UseAgentUpdate {
+    OnMessagesChanged = "OnMessagesChanged",
+    OnStateChanged = "OnStateChanged",
+    OnRunStatusChanged = "OnRunStatusChanged"
+}
 interface UseAgentProps {
     agentId?: string;
+    updates?: UseAgentUpdate[];
 }
-declare function useAgent({ agentId }?: UseAgentProps): {
+declare function useAgent({ agentId, updates }?: UseAgentProps): {
     agent: AbstractAgent | undefined;
-    isRunning: boolean;
 };
 
 declare function useAgentContext(context: Context): void;
@@ -360,4 +368,39 @@ 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, CopilotChatToolCallsView, type CopilotChatToolCallsViewProps, CopilotChatUserMessage, type CopilotChatUserMessageProps, CopilotChatView, type CopilotChatViewProps, type CopilotKitContextValue, CopilotKitProvider, type CopilotKitProviderProps, type ToolsMenuItem, useAgent, useAgentContext, useCopilotChatConfiguration, useCopilotKit, useFrontendTool, useHumanInTheLoop, useRenderToolCall };
+/**
+ * Helper to define a type-safe tool call render entry.
+ * - Accepts a single object whose keys match ReactToolCallRender's fields: { name, args, render, agentId? }.
+ * - Derives `args` type from the provided Zod schema.
+ * - Ensures the render function param type exactly matches ReactToolCallRender<T>["render"]'s param.
+ * - For wildcard tools (name: "*"), args is optional and defaults to z.any()
+ */
+type RenderProps<T> = {
+    name: string;
+    args: Partial<T>;
+    status: ToolCallStatus.InProgress;
+    result: undefined;
+} | {
+    name: string;
+    args: T;
+    status: ToolCallStatus.Executing;
+    result: undefined;
+} | {
+    name: string;
+    args: T;
+    status: ToolCallStatus.Complete;
+    result: string;
+};
+declare function defineToolCallRender(def: {
+    name: "*";
+    render: (props: RenderProps<any>) => React__default.ReactElement;
+    agentId?: string;
+}): ReactToolCallRender<any>;
+declare function defineToolCallRender<S extends z.ZodTypeAny>(def: {
+    name: string;
+    args: S;
+    render: (props: RenderProps<z.infer<S>>) => React__default.ReactElement;
+    agentId?: string;
+}): ReactToolCallRender<z.infer<S>>;
+
+export { AudioRecorderError, type AudioRecorderState, CopilotChat, CopilotChatAssistantMessage, type CopilotChatAssistantMessageProps, CopilotChatAudioRecorder, CopilotChatConfigurationProvider, type CopilotChatConfigurationProviderProps, type CopilotChatConfigurationValue, CopilotChatInput, type CopilotChatInputProps, type CopilotChatLabels, CopilotChatMessageView, type CopilotChatMessageViewProps, type CopilotChatProps, CopilotChatToolCallsView, type CopilotChatToolCallsViewProps, CopilotChatUserMessage, type CopilotChatUserMessageProps, CopilotChatView, type CopilotChatViewProps, type CopilotKitContextValue, CopilotKitProvider, type CopilotKitProviderProps, type ReactFrontendTool, type ReactHumanInTheLoop, type ReactToolCallRender, type ToolsMenuItem, defineToolCallRender, useAgent, useAgentContext, useCopilotChatConfiguration, useCopilotKit, useFrontendTool, useHumanInTheLoop, useRenderToolCall };

package/dist/index.d.ts

@@ -27,16 +27,14 @@ declare const CopilotChatDefaultLabels: {
 type CopilotChatLabels = typeof CopilotChatDefaultLabels;
 interface CopilotChatConfigurationValue {
     labels: CopilotChatLabels;
-    inputValue?: string;
-    onSubmitInput?: (value: string) => void;
-    onChangeInput?: (value: string) => void;
+    agentId: string;
+    threadId: string;
 }
 interface CopilotChatConfigurationProviderProps {
     children: ReactNode;
     labels?: Partial<CopilotChatLabels>;
-    inputValue?: string;
-    onSubmitInput?: (value: string) => void;
-    onChangeInput?: (value: string) => void;
+    agentId?: string;
+    threadId: string;
 }
 declare const CopilotChatConfigurationProvider: React__default.FC<CopilotChatConfigurationProviderProps>;
 declare const useCopilotChatConfiguration: () => CopilotChatConfigurationValue;
@@ -120,9 +118,9 @@ declare namespace CopilotChatInput {
 type CopilotChatToolCallsViewProps = {
     message: AssistantMessage;
     messages?: Message[];
-    isLoading?: boolean;
+    isRunning?: boolean;
 };
-declare function CopilotChatToolCallsView({ message, messages, isLoading, }: CopilotChatToolCallsViewProps): react_jsx_runtime.JSX.Element | null;
+declare function CopilotChatToolCallsView({ message, messages, isRunning, }: CopilotChatToolCallsViewProps): react_jsx_runtime.JSX.Element | null;
 
 type CopilotChatAssistantMessageProps = WithSlots<{
     markdownRenderer: typeof CopilotChatAssistantMessage.MarkdownRenderer;
@@ -140,11 +138,11 @@ type CopilotChatAssistantMessageProps = WithSlots<{
     onRegenerate?: (message: AssistantMessage) => void;
     message: AssistantMessage;
     messages?: Message[];
-    isLoading?: boolean;
+    isRunning?: boolean;
     additionalToolbarItems?: React.ReactNode;
     toolbarVisible?: boolean;
 } & React.HTMLAttributes<HTMLDivElement>>;
-declare function CopilotChatAssistantMessage({ message, messages, isLoading, onThumbsUp, onThumbsDown, onReadAloud, onRegenerate, additionalToolbarItems, toolbarVisible, markdownRenderer, toolbar, copyButton, thumbsUpButton, thumbsDownButton, readAloudButton, regenerateButton, toolCallsView, children, className, ...props }: CopilotChatAssistantMessageProps): react_jsx_runtime.JSX.Element;
+declare function CopilotChatAssistantMessage({ message, messages, isRunning, onThumbsUp, onThumbsDown, onReadAloud, onRegenerate, additionalToolbarItems, toolbarVisible, markdownRenderer, toolbar, copyButton, thumbsUpButton, thumbsDownButton, readAloudButton, regenerateButton, toolCallsView, children, className, ...props }: CopilotChatAssistantMessageProps): react_jsx_runtime.JSX.Element;
 declare namespace CopilotChatAssistantMessage {
     const MarkdownRenderer: React.FC<React.HTMLAttributes<HTMLDivElement> & {
         content: string;
@@ -212,16 +210,16 @@ type CopilotChatMessageViewProps = Omit<WithSlots<{
     userMessage: typeof CopilotChatUserMessage;
     cursor: typeof CopilotChatMessageView.Cursor;
 }, {
-    isLoading?: boolean;
+    isRunning?: boolean;
     messages?: Message[];
 } & React.HTMLAttributes<HTMLDivElement>>, "children"> & {
     children?: (props: {
-        isLoading: boolean;
+        isRunning: boolean;
         messages: Message[];
         messageElements: React.ReactElement[];
     }) => React.ReactElement;
 };
-declare function CopilotChatMessageView({ messages, assistantMessage, userMessage, cursor, isLoading, children, className, ...props }: CopilotChatMessageViewProps): react_jsx_runtime.JSX.Element;
+declare function CopilotChatMessageView({ messages, assistantMessage, userMessage, cursor, isRunning, children, className, ...props }: CopilotChatMessageViewProps): react_jsx_runtime.JSX.Element;
 declare namespace CopilotChatMessageView {
     var Cursor: ({ className, ...props }: React.HTMLAttributes<HTMLDivElement>) => react_jsx_runtime.JSX.Element;
 }
@@ -239,8 +237,10 @@ type CopilotChatViewProps = WithSlots<{
 }, {
     messages?: Message[];
     autoScroll?: boolean;
+    inputProps?: Partial<Omit<CopilotChatInputProps, "children">>;
+    isRunning?: boolean;
 } & React__default.HTMLAttributes<HTMLDivElement>>;
-declare function CopilotChatView({ messageView, input, scrollView, scrollToBottomButton, feather, inputContainer, disclaimer, messages, autoScroll, 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, messages, autoScroll, inputProps, isRunning, 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;
@@ -265,7 +265,7 @@ declare function CopilotChat({ agentId, threadId, ...props }: CopilotChatProps):
 interface UseRenderToolCallProps {
     toolCall: ToolCall;
     toolMessage?: ToolMessage;
-    isLoading: boolean;
+    isRunning: boolean;
 }
 /**
  * Hook that returns a function to render tool calls based on the render functions
@@ -273,7 +273,7 @@ interface UseRenderToolCallProps {
  *
  * @returns A function that takes a tool call and optional tool message and returns the rendered component
  */
-declare function useRenderToolCall(): ({ toolCall, toolMessage, isLoading, }: UseRenderToolCallProps) => React__default.ReactElement | null;
+declare function useRenderToolCall(): ({ toolCall, toolMessage, isRunning, }: UseRenderToolCallProps) => React__default.ReactElement | null;
 
 interface ReactToolCallRender<T> {
     name: string;
@@ -284,14 +284,17 @@ interface ReactToolCallRender<T> {
      */
     agentId?: string;
     render: React.ComponentType<{
+        name: string;
         args: Partial<T>;
         status: ToolCallStatus.InProgress;
         result: undefined;
     } | {
+        name: string;
         args: T;
         status: ToolCallStatus.Executing;
         result: undefined;
     } | {
+        name: string;
         args: T;
         status: ToolCallStatus.Complete;
         result: string;
@@ -331,12 +334,17 @@ type ReactHumanInTheLoop<T extends Record<string, unknown> = Record<string, unkn
 
 declare function useHumanInTheLoop<T extends Record<string, unknown> = Record<string, unknown>>(tool: ReactHumanInTheLoop<T>): void;
 
+declare enum UseAgentUpdate {
+    OnMessagesChanged = "OnMessagesChanged",
+    OnStateChanged = "OnStateChanged",
+    OnRunStatusChanged = "OnRunStatusChanged"
+}
 interface UseAgentProps {
     agentId?: string;
+    updates?: UseAgentUpdate[];
 }
-declare function useAgent({ agentId }?: UseAgentProps): {
+declare function useAgent({ agentId, updates }?: UseAgentProps): {
     agent: AbstractAgent | undefined;
-    isRunning: boolean;
 };
 
 declare function useAgentContext(context: Context): void;
@@ -360,4 +368,39 @@ 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, CopilotChatToolCallsView, type CopilotChatToolCallsViewProps, CopilotChatUserMessage, type CopilotChatUserMessageProps, CopilotChatView, type CopilotChatViewProps, type CopilotKitContextValue, CopilotKitProvider, type CopilotKitProviderProps, type ToolsMenuItem, useAgent, useAgentContext, useCopilotChatConfiguration, useCopilotKit, useFrontendTool, useHumanInTheLoop, useRenderToolCall };
+/**
+ * Helper to define a type-safe tool call render entry.
+ * - Accepts a single object whose keys match ReactToolCallRender's fields: { name, args, render, agentId? }.
+ * - Derives `args` type from the provided Zod schema.
+ * - Ensures the render function param type exactly matches ReactToolCallRender<T>["render"]'s param.
+ * - For wildcard tools (name: "*"), args is optional and defaults to z.any()
+ */
+type RenderProps<T> = {
+    name: string;
+    args: Partial<T>;
+    status: ToolCallStatus.InProgress;
+    result: undefined;
+} | {
+    name: string;
+    args: T;
+    status: ToolCallStatus.Executing;
+    result: undefined;
+} | {
+    name: string;
+    args: T;
+    status: ToolCallStatus.Complete;
+    result: string;
+};
+declare function defineToolCallRender(def: {
+    name: "*";
+    render: (props: RenderProps<any>) => React__default.ReactElement;
+    agentId?: string;
+}): ReactToolCallRender<any>;
+declare function defineToolCallRender<S extends z.ZodTypeAny>(def: {
+    name: string;
+    args: S;
+    render: (props: RenderProps<z.infer<S>>) => React__default.ReactElement;
+    agentId?: string;
+}): ReactToolCallRender<z.infer<S>>;
+
+export { AudioRecorderError, type AudioRecorderState, CopilotChat, CopilotChatAssistantMessage, type CopilotChatAssistantMessageProps, CopilotChatAudioRecorder, CopilotChatConfigurationProvider, type CopilotChatConfigurationProviderProps, type CopilotChatConfigurationValue, CopilotChatInput, type CopilotChatInputProps, type CopilotChatLabels, CopilotChatMessageView, type CopilotChatMessageViewProps, type CopilotChatProps, CopilotChatToolCallsView, type CopilotChatToolCallsViewProps, CopilotChatUserMessage, type CopilotChatUserMessageProps, CopilotChatView, type CopilotChatViewProps, type CopilotKitContextValue, CopilotKitProvider, type CopilotKitProviderProps, type ReactFrontendTool, type ReactHumanInTheLoop, type ReactToolCallRender, type ToolsMenuItem, defineToolCallRender, useAgent, useAgentContext, useCopilotChatConfiguration, useCopilotKit, useFrontendTool, useHumanInTheLoop, useRenderToolCall };