@copilotkitnext/react 0.0.17 → 0.0.19-alpha.0

package/dist/index.d.mts

@@ -1,7 +1,7 @@
 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, ToolCall, ToolMessage, ActivityMessage } from '@ag-ui/core';
 import { Streamdown } from 'streamdown';
 import { Suggestion, CopilotKitCore, ToolCallStatus, FrontendTool, DynamicSuggestionsConfig, StaticSuggestionsConfig, CopilotKitCoreConfig, CopilotKitCoreSubscriber } from '@copilotkitnext/core';
 import { z } from 'zod';
@@ -432,6 +432,8 @@ interface UseRenderCustomMessagesParams {
 }
 declare function useRenderCustomMessages(): ((params: UseRenderCustomMessagesParams) => react_jsx_runtime.JSX.Element | null) | null;
 
+declare function useRenderActivityMessage(): (message: ActivityMessage) => React.ReactElement | null;
+
 interface ReactToolCallRenderer<T> {
     name: string;
     args: z.ZodSchema<T>;
@@ -527,6 +529,29 @@ interface UseConfigureSuggestionsOptions {
 }
 declare function useConfigureSuggestions(config: SuggestionsConfigInput | null | undefined, options?: UseConfigureSuggestionsOptions): void;
 
+interface ReactActivityMessageRenderer<TActivityContent> {
+    /**
+     * Activity type to match when rendering. Use "*" as a wildcard renderer.
+     */
+    activityType: string;
+    /**
+     * Optional agent ID to scope the renderer to a particular agent.
+     */
+    agentId?: string;
+    /**
+     * Schema describing the activity content payload.
+     */
+    content: z.ZodSchema<TActivityContent>;
+    /**
+     * React component invoked to render the activity message.
+     */
+    render: React.ComponentType<{
+        activityType: string;
+        content: TActivityContent;
+        message: ActivityMessage;
+    }>;
+}
+
 /**
  * Helper to define a type-safe tool call renderer entry.
  * - Accepts a single object whose keys match ReactToolCallRenderer's fields: { name, args, render, agentId? }.
@@ -564,6 +589,7 @@ declare function defineToolCallRenderer<S extends z.ZodTypeAny>(def: {
 
 interface CopilotKitCoreReactConfig extends CopilotKitCoreConfig {
     renderToolCalls?: ReactToolCallRenderer<any>[];
+    renderActivityMessages?: ReactActivityMessageRenderer<any>[];
     renderCustomMessages?: ReactCustomMessageRenderer[];
 }
 interface CopilotKitCoreReactSubscriber extends CopilotKitCoreSubscriber {
@@ -575,8 +601,10 @@ interface CopilotKitCoreReactSubscriber extends CopilotKitCoreSubscriber {
 declare class CopilotKitCoreReact extends CopilotKitCore {
     private _renderToolCalls;
     private _renderCustomMessages;
+    private _renderActivityMessages;
     constructor(config: CopilotKitCoreReactConfig);
     get renderCustomMessages(): Readonly<ReactCustomMessageRenderer[]>;
+    get renderActivityMessages(): Readonly<ReactActivityMessageRenderer<any>>[];
     get renderToolCalls(): Readonly<ReactToolCallRenderer<any>>[];
     setRenderToolCalls(renderToolCalls: ReactToolCallRenderer<any>[]): void;
     subscribe(subscriber: CopilotKitCoreReactSubscriber): () => void;
@@ -593,6 +621,7 @@ interface CopilotKitProviderProps {
     properties?: Record<string, unknown>;
     agents__unsafe_dev_only?: Record<string, AbstractAgent>;
     renderToolCalls?: ReactToolCallRenderer<any>[];
+    renderActivityMessages?: ReactActivityMessageRenderer<any>[];
     renderCustomMessages?: ReactCustomMessageRenderer[];
     frontendTools?: ReactFrontendTool[];
     humanInTheLoop?: ReactHumanInTheLoop[];
@@ -601,4 +630,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, type ReactActivityMessageRenderer, type ReactCustomMessageRenderer, type ReactCustomMessageRendererPosition, type ReactFrontendTool, type ReactHumanInTheLoop, type ReactToolCallRenderer, type ToolsMenuItem, WildcardToolCallRender, defineToolCallRenderer, useAgent, useAgentContext, useConfigureSuggestions, useCopilotChatConfiguration, useCopilotKit, useFrontendTool, useHumanInTheLoop, useRenderActivityMessage, useRenderCustomMessages, useRenderToolCall, useSuggestions };

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 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, ToolCall, ToolMessage, ActivityMessage } from '@ag-ui/core';
 import { Streamdown } from 'streamdown';
 import { Suggestion, CopilotKitCore, ToolCallStatus, FrontendTool, DynamicSuggestionsConfig, StaticSuggestionsConfig, CopilotKitCoreConfig, CopilotKitCoreSubscriber } from '@copilotkitnext/core';
 import { z } from 'zod';
@@ -432,6 +432,8 @@ interface UseRenderCustomMessagesParams {
 }
 declare function useRenderCustomMessages(): ((params: UseRenderCustomMessagesParams) => react_jsx_runtime.JSX.Element | null) | null;
 
+declare function useRenderActivityMessage(): (message: ActivityMessage) => React.ReactElement | null;
+
 interface ReactToolCallRenderer<T> {
     name: string;
     args: z.ZodSchema<T>;
@@ -527,6 +529,29 @@ interface UseConfigureSuggestionsOptions {
 }
 declare function useConfigureSuggestions(config: SuggestionsConfigInput | null | undefined, options?: UseConfigureSuggestionsOptions): void;
 
+interface ReactActivityMessageRenderer<TActivityContent> {
+    /**
+     * Activity type to match when rendering. Use "*" as a wildcard renderer.
+     */
+    activityType: string;
+    /**
+     * Optional agent ID to scope the renderer to a particular agent.
+     */
+    agentId?: string;
+    /**
+     * Schema describing the activity content payload.
+     */
+    content: z.ZodSchema<TActivityContent>;
+    /**
+     * React component invoked to render the activity message.
+     */
+    render: React.ComponentType<{
+        activityType: string;
+        content: TActivityContent;
+        message: ActivityMessage;
+    }>;
+}
+
 /**
  * Helper to define a type-safe tool call renderer entry.
  * - Accepts a single object whose keys match ReactToolCallRenderer's fields: { name, args, render, agentId? }.
@@ -564,6 +589,7 @@ declare function defineToolCallRenderer<S extends z.ZodTypeAny>(def: {
 
 interface CopilotKitCoreReactConfig extends CopilotKitCoreConfig {
     renderToolCalls?: ReactToolCallRenderer<any>[];
+    renderActivityMessages?: ReactActivityMessageRenderer<any>[];
     renderCustomMessages?: ReactCustomMessageRenderer[];
 }
 interface CopilotKitCoreReactSubscriber extends CopilotKitCoreSubscriber {
@@ -575,8 +601,10 @@ interface CopilotKitCoreReactSubscriber extends CopilotKitCoreSubscriber {
 declare class CopilotKitCoreReact extends CopilotKitCore {
     private _renderToolCalls;
     private _renderCustomMessages;
+    private _renderActivityMessages;
     constructor(config: CopilotKitCoreReactConfig);
     get renderCustomMessages(): Readonly<ReactCustomMessageRenderer[]>;
+    get renderActivityMessages(): Readonly<ReactActivityMessageRenderer<any>>[];
     get renderToolCalls(): Readonly<ReactToolCallRenderer<any>>[];
     setRenderToolCalls(renderToolCalls: ReactToolCallRenderer<any>[]): void;
     subscribe(subscriber: CopilotKitCoreReactSubscriber): () => void;
@@ -593,6 +621,7 @@ interface CopilotKitProviderProps {
     properties?: Record<string, unknown>;
     agents__unsafe_dev_only?: Record<string, AbstractAgent>;
     renderToolCalls?: ReactToolCallRenderer<any>[];
+    renderActivityMessages?: ReactActivityMessageRenderer<any>[];
     renderCustomMessages?: ReactCustomMessageRenderer[];
     frontendTools?: ReactFrontendTool[];
     humanInTheLoop?: ReactHumanInTheLoop[];
@@ -601,4 +630,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, type ReactActivityMessageRenderer, type ReactCustomMessageRenderer, type ReactCustomMessageRendererPosition, type ReactFrontendTool, type ReactHumanInTheLoop, type ReactToolCallRenderer, type ToolsMenuItem, WildcardToolCallRender, defineToolCallRenderer, useAgent, useAgentContext, useConfigureSuggestions, useCopilotChatConfiguration, useCopilotKit, useFrontendTool, useHumanInTheLoop, useRenderActivityMessage, useRenderCustomMessages, useRenderToolCall, useSuggestions };