@copilotkitnext/react 0.0.13-alpha.0 → 0.0.13

package/dist/index.d.mts

@@ -2,8 +2,10 @@ 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 { Suggestion, ToolCallStatus, FrontendTool, DynamicSuggestionsConfig, StaticSuggestionsConfig, CopilotKitCore } from '@copilotkitnext/core';
+import { Suggestion, CopilotKitCore, ToolCallStatus, FrontendTool, DynamicSuggestionsConfig, StaticSuggestionsConfig, CopilotKitCoreConfig, CopilotKitCoreSubscriber } from '@copilotkitnext/core';
 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: {
@@ -359,7 +361,14 @@ declare namespace CopilotSidebar {
     var displayName: string;
 }
 
-declare const WildcardToolCallRender: ReactToolCallRender<any>;
+declare const WildcardToolCallRender: ReactToolCallRenderer<any>;
+
+declare const WebInspectorBase: _lit_labs_react.ReactWebComponent<WebInspectorElement, {}>;
+type WebInspectorBaseProps = React$1.ComponentProps<typeof WebInspectorBase>;
+interface WebInspectorProps extends Omit<WebInspectorBaseProps, "core"> {
+    core?: CopilotKitCore | null;
+}
+declare const WebInspector: React$1.ForwardRefExoticComponent<Omit<WebInspectorProps, "ref"> & React$1.RefAttributes<WebInspectorElement>>;
 
 interface UseRenderToolCallProps {
     toolCall: ToolCall;
@@ -373,12 +382,33 @@ interface UseRenderToolCallProps {
  */
 declare function useRenderToolCall(): ({ toolCall, toolMessage, }: UseRenderToolCallProps) => React__default.ReactElement | null;
 
-interface ReactToolCallRender<T> {
+type ReactCustomMessageRendererPosition = "before" | "after";
+interface ReactCustomMessageRenderer {
+    agentId?: string;
+    render: React.ComponentType<{
+        message: Message;
+        position: ReactCustomMessageRendererPosition;
+        runId: string;
+        messageIndex: number;
+        messageIndexInRun: number;
+        numberOfMessagesInRun: number;
+        agentId: string;
+        stateSnapshot: any;
+    }> | null;
+}
+
+interface UseRenderCustomMessagesParams {
+    message: Message;
+    position: ReactCustomMessageRendererPosition;
+}
+declare function useRenderCustomMessages(): ((params: UseRenderCustomMessagesParams) => react_jsx_runtime.JSX.Element | null) | null;
+
+interface ReactToolCallRenderer<T> {
     name: string;
     args: z.ZodSchema<T>;
     /**
-     * Optional agent ID to constrain this tool render to a specific agent.
-     * If specified, this render will only be used for the specified agent.
+     * Optional agent ID to constrain this tool renderer to a specific agent.
+     * If specified, this renderer will only be used for the specified agent.
      */
     agentId?: string;
     render: React.ComponentType<{
@@ -400,7 +430,7 @@ interface ReactToolCallRender<T> {
 }
 
 type ReactFrontendTool<T extends Record<string, unknown> = Record<string, unknown>> = FrontendTool<T> & {
-    render?: ReactToolCallRender<T>["render"];
+    render?: ReactToolCallRenderer<T>["render"];
 };
 
 declare function useFrontendTool<T extends Record<string, unknown> = Record<string, unknown>>(tool: ReactFrontendTool<T>): void;
@@ -468,30 +498,11 @@ interface UseConfigureSuggestionsOptions {
 }
 declare function useConfigureSuggestions(config: SuggestionsConfigInput | null | undefined, options?: UseConfigureSuggestionsOptions): void;
 
-interface CopilotKitContextValue {
-    copilotkit: CopilotKitCore;
-    renderToolCalls: ReactToolCallRender<any>[];
-    currentRenderToolCalls: ReactToolCallRender<unknown>[];
-    setCurrentRenderToolCalls: React__default.Dispatch<React__default.SetStateAction<ReactToolCallRender<unknown>[]>>;
-}
-interface CopilotKitProviderProps {
-    children: ReactNode;
-    runtimeUrl?: string;
-    headers?: Record<string, string>;
-    properties?: Record<string, unknown>;
-    agents__unsafe_dev_only?: Record<string, AbstractAgent>;
-    renderToolCalls?: ReactToolCallRender<any>[];
-    frontendTools?: ReactFrontendTool[];
-    humanInTheLoop?: ReactHumanInTheLoop[];
-}
-declare const CopilotKitProvider: React__default.FC<CopilotKitProviderProps>;
-declare const useCopilotKit: () => CopilotKitContextValue;
-
 /**
- * Helper to define a type-safe tool call render entry.
- * - Accepts a single object whose keys match ReactToolCallRender's fields: { name, args, render, agentId? }.
+ * Helper to define a type-safe tool call renderer entry.
+ * - Accepts a single object whose keys match ReactToolCallRenderer'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.
+ * - Ensures the render function param type exactly matches ReactToolCallRenderer<T>["render"]'s param.
  * - For wildcard tools (name: "*"), args is optional and defaults to z.any()
  */
 type RenderProps<T> = {
@@ -510,16 +521,55 @@ type RenderProps<T> = {
     status: ToolCallStatus.Complete;
     result: string;
 };
-declare function defineToolCallRender(def: {
+declare function defineToolCallRenderer(def: {
     name: "*";
     render: (props: RenderProps<any>) => React__default.ReactElement;
     agentId?: string;
-}): ReactToolCallRender<any>;
-declare function defineToolCallRender<S extends z.ZodTypeAny>(def: {
+}): ReactToolCallRenderer<any>;
+declare function defineToolCallRenderer<S extends z.ZodTypeAny>(def: {
     name: string;
     args: S;
     render: (props: RenderProps<z.infer<S>>) => React__default.ReactElement;
     agentId?: string;
-}): ReactToolCallRender<z.infer<S>>;
+}): ReactToolCallRenderer<z.infer<S>>;
+
+interface CopilotKitCoreReactConfig extends CopilotKitCoreConfig {
+    renderToolCalls?: ReactToolCallRenderer<any>[];
+    renderCustomMessages?: ReactCustomMessageRenderer[];
+}
+interface CopilotKitCoreReactSubscriber extends CopilotKitCoreSubscriber {
+    onRenderToolCallsChanged?: (event: {
+        copilotkit: CopilotKitCore;
+        renderToolCalls: ReactToolCallRenderer<any>[];
+    }) => void | Promise<void>;
+}
+declare class CopilotKitCoreReact extends CopilotKitCore {
+    private _renderToolCalls;
+    private _renderCustomMessages;
+    constructor(config: CopilotKitCoreReactConfig);
+    get renderCustomMessages(): Readonly<ReactCustomMessageRenderer[]>;
+    get renderToolCalls(): Readonly<ReactToolCallRenderer<any>>[];
+    setRenderToolCalls(renderToolCalls: ReactToolCallRenderer<any>[]): void;
+    subscribe(subscriber: CopilotKitCoreReactSubscriber): () => void;
+    unsubscribe(subscriber: CopilotKitCoreReactSubscriber): void;
+}
+
+interface CopilotKitContextValue {
+    copilotkit: CopilotKitCoreReact;
+}
+interface CopilotKitProviderProps {
+    children: ReactNode;
+    runtimeUrl?: string;
+    headers?: Record<string, string>;
+    properties?: Record<string, unknown>;
+    agents__unsafe_dev_only?: Record<string, AbstractAgent>;
+    renderToolCalls?: ReactToolCallRenderer<any>[];
+    renderCustomMessages?: ReactCustomMessageRenderer[];
+    frontendTools?: ReactFrontendTool[];
+    humanInTheLoop?: ReactHumanInTheLoop[];
+    showDevConsole?: boolean | "auto";
+}
+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, CopilotKitProvider, type CopilotKitProviderProps, CopilotModalHeader, type CopilotModalHeaderProps, CopilotSidebar, type CopilotSidebarProps, CopilotSidebarView, type CopilotSidebarViewProps, type ReactFrontendTool, type ReactHumanInTheLoop, type ReactToolCallRender, type ToolsMenuItem, WildcardToolCallRender, defineToolCallRender, useAgent, useAgentContext, useConfigureSuggestions, useCopilotChatConfiguration, useCopilotKit, useFrontendTool, useHumanInTheLoop, 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, CopilotKitProvider, type CopilotKitProviderProps, CopilotModalHeader, type CopilotModalHeaderProps, CopilotSidebar, type CopilotSidebarProps, CopilotSidebarView, type CopilotSidebarViewProps, type ReactCustomMessageRenderer, type ReactCustomMessageRendererPosition, type ReactFrontendTool, type ReactHumanInTheLoop, type ReactToolCallRenderer, type ToolsMenuItem, WebInspector, type WebInspectorBaseProps, type WebInspectorProps, WildcardToolCallRender, defineToolCallRenderer, useAgent, useAgentContext, useConfigureSuggestions, useCopilotChatConfiguration, useCopilotKit, useFrontendTool, useHumanInTheLoop, useRenderCustomMessages, useRenderToolCall, useSuggestions };

package/dist/index.d.ts

@@ -2,8 +2,10 @@ 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 { Suggestion, ToolCallStatus, FrontendTool, DynamicSuggestionsConfig, StaticSuggestionsConfig, CopilotKitCore } from '@copilotkitnext/core';
+import { Suggestion, CopilotKitCore, ToolCallStatus, FrontendTool, DynamicSuggestionsConfig, StaticSuggestionsConfig, CopilotKitCoreConfig, CopilotKitCoreSubscriber } from '@copilotkitnext/core';
 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: {
@@ -359,7 +361,14 @@ declare namespace CopilotSidebar {
     var displayName: string;
 }
 
-declare const WildcardToolCallRender: ReactToolCallRender<any>;
+declare const WildcardToolCallRender: ReactToolCallRenderer<any>;
+
+declare const WebInspectorBase: _lit_labs_react.ReactWebComponent<WebInspectorElement, {}>;
+type WebInspectorBaseProps = React$1.ComponentProps<typeof WebInspectorBase>;
+interface WebInspectorProps extends Omit<WebInspectorBaseProps, "core"> {
+    core?: CopilotKitCore | null;
+}
+declare const WebInspector: React$1.ForwardRefExoticComponent<Omit<WebInspectorProps, "ref"> & React$1.RefAttributes<WebInspectorElement>>;
 
 interface UseRenderToolCallProps {
     toolCall: ToolCall;
@@ -373,12 +382,33 @@ interface UseRenderToolCallProps {
  */
 declare function useRenderToolCall(): ({ toolCall, toolMessage, }: UseRenderToolCallProps) => React__default.ReactElement | null;
 
-interface ReactToolCallRender<T> {
+type ReactCustomMessageRendererPosition = "before" | "after";
+interface ReactCustomMessageRenderer {
+    agentId?: string;
+    render: React.ComponentType<{
+        message: Message;
+        position: ReactCustomMessageRendererPosition;
+        runId: string;
+        messageIndex: number;
+        messageIndexInRun: number;
+        numberOfMessagesInRun: number;
+        agentId: string;
+        stateSnapshot: any;
+    }> | null;
+}
+
+interface UseRenderCustomMessagesParams {
+    message: Message;
+    position: ReactCustomMessageRendererPosition;
+}
+declare function useRenderCustomMessages(): ((params: UseRenderCustomMessagesParams) => react_jsx_runtime.JSX.Element | null) | null;
+
+interface ReactToolCallRenderer<T> {
     name: string;
     args: z.ZodSchema<T>;
     /**
-     * Optional agent ID to constrain this tool render to a specific agent.
-     * If specified, this render will only be used for the specified agent.
+     * Optional agent ID to constrain this tool renderer to a specific agent.
+     * If specified, this renderer will only be used for the specified agent.
      */
     agentId?: string;
     render: React.ComponentType<{
@@ -400,7 +430,7 @@ interface ReactToolCallRender<T> {
 }
 
 type ReactFrontendTool<T extends Record<string, unknown> = Record<string, unknown>> = FrontendTool<T> & {
-    render?: ReactToolCallRender<T>["render"];
+    render?: ReactToolCallRenderer<T>["render"];
 };
 
 declare function useFrontendTool<T extends Record<string, unknown> = Record<string, unknown>>(tool: ReactFrontendTool<T>): void;
@@ -468,30 +498,11 @@ interface UseConfigureSuggestionsOptions {
 }
 declare function useConfigureSuggestions(config: SuggestionsConfigInput | null | undefined, options?: UseConfigureSuggestionsOptions): void;
 
-interface CopilotKitContextValue {
-    copilotkit: CopilotKitCore;
-    renderToolCalls: ReactToolCallRender<any>[];
-    currentRenderToolCalls: ReactToolCallRender<unknown>[];
-    setCurrentRenderToolCalls: React__default.Dispatch<React__default.SetStateAction<ReactToolCallRender<unknown>[]>>;
-}
-interface CopilotKitProviderProps {
-    children: ReactNode;
-    runtimeUrl?: string;
-    headers?: Record<string, string>;
-    properties?: Record<string, unknown>;
-    agents__unsafe_dev_only?: Record<string, AbstractAgent>;
-    renderToolCalls?: ReactToolCallRender<any>[];
-    frontendTools?: ReactFrontendTool[];
-    humanInTheLoop?: ReactHumanInTheLoop[];
-}
-declare const CopilotKitProvider: React__default.FC<CopilotKitProviderProps>;
-declare const useCopilotKit: () => CopilotKitContextValue;
-
 /**
- * Helper to define a type-safe tool call render entry.
- * - Accepts a single object whose keys match ReactToolCallRender's fields: { name, args, render, agentId? }.
+ * Helper to define a type-safe tool call renderer entry.
+ * - Accepts a single object whose keys match ReactToolCallRenderer'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.
+ * - Ensures the render function param type exactly matches ReactToolCallRenderer<T>["render"]'s param.
  * - For wildcard tools (name: "*"), args is optional and defaults to z.any()
  */
 type RenderProps<T> = {
@@ -510,16 +521,55 @@ type RenderProps<T> = {
     status: ToolCallStatus.Complete;
     result: string;
 };
-declare function defineToolCallRender(def: {
+declare function defineToolCallRenderer(def: {
     name: "*";
     render: (props: RenderProps<any>) => React__default.ReactElement;
     agentId?: string;
-}): ReactToolCallRender<any>;
-declare function defineToolCallRender<S extends z.ZodTypeAny>(def: {
+}): ReactToolCallRenderer<any>;
+declare function defineToolCallRenderer<S extends z.ZodTypeAny>(def: {
     name: string;
     args: S;
     render: (props: RenderProps<z.infer<S>>) => React__default.ReactElement;
     agentId?: string;
-}): ReactToolCallRender<z.infer<S>>;
+}): ReactToolCallRenderer<z.infer<S>>;
+
+interface CopilotKitCoreReactConfig extends CopilotKitCoreConfig {
+    renderToolCalls?: ReactToolCallRenderer<any>[];
+    renderCustomMessages?: ReactCustomMessageRenderer[];
+}
+interface CopilotKitCoreReactSubscriber extends CopilotKitCoreSubscriber {
+    onRenderToolCallsChanged?: (event: {
+        copilotkit: CopilotKitCore;
+        renderToolCalls: ReactToolCallRenderer<any>[];
+    }) => void | Promise<void>;
+}
+declare class CopilotKitCoreReact extends CopilotKitCore {
+    private _renderToolCalls;
+    private _renderCustomMessages;
+    constructor(config: CopilotKitCoreReactConfig);
+    get renderCustomMessages(): Readonly<ReactCustomMessageRenderer[]>;
+    get renderToolCalls(): Readonly<ReactToolCallRenderer<any>>[];
+    setRenderToolCalls(renderToolCalls: ReactToolCallRenderer<any>[]): void;
+    subscribe(subscriber: CopilotKitCoreReactSubscriber): () => void;
+    unsubscribe(subscriber: CopilotKitCoreReactSubscriber): void;
+}
+
+interface CopilotKitContextValue {
+    copilotkit: CopilotKitCoreReact;
+}
+interface CopilotKitProviderProps {
+    children: ReactNode;
+    runtimeUrl?: string;
+    headers?: Record<string, string>;
+    properties?: Record<string, unknown>;
+    agents__unsafe_dev_only?: Record<string, AbstractAgent>;
+    renderToolCalls?: ReactToolCallRenderer<any>[];
+    renderCustomMessages?: ReactCustomMessageRenderer[];
+    frontendTools?: ReactFrontendTool[];
+    humanInTheLoop?: ReactHumanInTheLoop[];
+    showDevConsole?: boolean | "auto";
+}
+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, CopilotKitProvider, type CopilotKitProviderProps, CopilotModalHeader, type CopilotModalHeaderProps, CopilotSidebar, type CopilotSidebarProps, CopilotSidebarView, type CopilotSidebarViewProps, type ReactFrontendTool, type ReactHumanInTheLoop, type ReactToolCallRender, type ToolsMenuItem, WildcardToolCallRender, defineToolCallRender, useAgent, useAgentContext, useConfigureSuggestions, useCopilotChatConfiguration, useCopilotKit, useFrontendTool, useHumanInTheLoop, 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, CopilotKitProvider, type CopilotKitProviderProps, CopilotModalHeader, type CopilotModalHeaderProps, CopilotSidebar, type CopilotSidebarProps, CopilotSidebarView, type CopilotSidebarViewProps, type ReactCustomMessageRenderer, type ReactCustomMessageRendererPosition, type ReactFrontendTool, type ReactHumanInTheLoop, type ReactToolCallRenderer, type ToolsMenuItem, WebInspector, type WebInspectorBaseProps, type WebInspectorProps, WildcardToolCallRender, defineToolCallRenderer, useAgent, useAgentContext, useConfigureSuggestions, useCopilotChatConfiguration, useCopilotKit, useFrontendTool, useHumanInTheLoop, useRenderCustomMessages, useRenderToolCall, useSuggestions };