@sendbird/ai-agent-messenger-react 1.26.0 → 1.27.0

package/dist/index.d.ts

@@ -238,7 +238,7 @@ queryParams?: AIAgentQueryParams;
 * @public
 * @description AIAgent global default config.
 * */
-config?: AIAgentConfig;
+config?: DeepPartial<AIAgentConfig_2>;
 /** @internal */
 deskParams?: {
 customApiHost?: string;
@@ -426,69 +426,98 @@ declare type AIAgentCommonIconName =
 | 'download'
 | 'memory';
 
-export declare interface AIAgentConfig {
-    conversation?: {
-        /**
-         * Whether to show the "Start new conversation" button at the end of the message list.
-         * @default true
-         * */
-        isTalkToAgentViewEnabled?: boolean;
-        /**
-         * Controls the scroll behavior of the conversation.
-         * - `auto`: Automatically scrolls to bottom on new messages and streaming.
-         * - `fixed`: Pins new messages at viewport top, maintains position during streaming.
-         * @default 'auto'
-         * */
-        scrollMode?: ConversationScrollMode;
-        /**
-         * Whether to show the new message indicator button when scrolled away from bottom.
-         * @default true
-         * */
-        newMessageIndicatorEnabled?: boolean;
-        /**
-         * Whether to show the sender's avatar image next to each message.
-         * @default true
-         * */
-        senderAvatarEnabled?: boolean;
-        header?: {
+/**
+ * Public input shape for the AI Agent config. Deep-partial of the canonical
+ * resolved config the SDK consumes internally — every field is optional so
+ * callers only supply the values they want to override. `mergeAIAgentConfig`
+ * fills in the rest before reaching React contexts.
+ */
+export declare type AIAgentConfig = DeepPartial<AIAgentConfig_2>;
+
+/**
+ * Canonical AI Agent config — every field is required after `mergeAIAgentConfig`.
+ * User-facing input uses `DeepPartial<AIAgentConfig>`.
+ */
+declare interface AIAgentConfig_2 {
+    conversation: {
+        /** @deprecated Use `list.isTalkToAgentViewEnabled` instead. */
+        isTalkToAgentViewEnabled: boolean;
+        /** @deprecated Use `list.scrollMode` instead. */
+        scrollMode: ConversationScrollMode;
+        /** @deprecated Use `list.newMessageIndicatorEnabled` instead. */
+        newMessageIndicatorEnabled: boolean;
+        /** @deprecated Use `list.senderAvatarEnabled` instead. */
+        senderAvatarEnabled: boolean;
+        list: {
+            /**
+             * Whether to show the "Start new conversation" button at the end of the message list.
+             * @default true
+             * */
+            isTalkToAgentViewEnabled: boolean;
+            /**
+             * Controls the scroll behavior of the conversation.
+             * - `auto`: Automatically scrolls to bottom on new messages and streaming.
+             * - `fixed`: Pins new messages at viewport top, maintains position during streaming.
+             * @default 'auto'
+             * */
+            scrollMode: ConversationScrollMode;
+            /**
+             * Whether to show the new message indicator button when scrolled away from bottom.
+             * @default true
+             * */
+            newMessageIndicatorEnabled: boolean;
+            /**
+             * Whether to show the sender's avatar image next to each message.
+             * @default true
+             * */
+            senderAvatarEnabled: boolean;
+            /**
+             * Controls how markdown images are displayed while a message is streaming.
+             * - `default`: Renders partial markdown as-is.
+             * - `complete-only`: Hides incomplete image markdown until the image token is complete.
+             * @default 'default'
+             * */
+            markdownImageRenderMode: MarkdownImageRenderMode;
+        };
+        header: {
             /**
              * Whether to show the avatar in the conversation header.
              * @default true
              * */
-            avatarEnabled?: boolean;
+            avatarEnabled: boolean;
         };
-        input?: {
+        input: {
             /**
              * (React-Native only) Whether to enable the camera option in the attachment menu.
              * */
-            camera?: {
-                photoEnabled?: boolean;
+            camera: {
+                photoEnabled: boolean;
             };
             /**
              * Whether to enable the gallery/photo option in the attachment menu.
              * */
-            gallery?: {
-                photoEnabled?: boolean;
+            gallery: {
+                photoEnabled: boolean;
             };
             /**
              * Whether to enable the file option in the attachment menu.
              * */
-            fileEnabled?: boolean;
+            fileEnabled: boolean;
         };
         /**
          * (React only) Whether to play an alert sound when a message is received from the AI agent while the browser is not focused.
          * @default false
          * */
-        messageAlertSoundEnabled?: boolean;
+        messageAlertSoundEnabled: boolean;
         /**
          * File viewer configuration.
          * */
-        fileViewer?: {
+        fileViewer: {
             /**
              * Whether to show the download button in the file viewer.
              * @default true
              * */
-            downloadEnabled?: boolean;
+            downloadEnabled: boolean;
         };
     };
 }
@@ -513,7 +542,7 @@ declare interface AIAgentContextValue {
     networkStateAdapter?: NetworkStateAdapter;
 
     queryParams?: AIAgentQueryParams;
-    config?: AIAgentConfig;
+    config: AIAgentConfig_2;
 
     handlers?: AIAgentClientHandlers;
 }
@@ -651,9 +680,9 @@ declare interface AIAgentInterface {
     readonly session: AIAgentSession | null;
     /** The Desk client. Available after authenticate(). */
     readonly deskClient: DeskClientInterface;
-    // TODO: Change to `AIAgentConfig` (non-optional) once the context migration lands and all usages are updated
-    /** The AI Agent configuration */
-    config: AIAgentConfig | undefined;
+    /** The AI Agent configuration. */
+    get config(): AIAgentConfig_2;
+    set config(value: DeepPartial<AIAgentConfig_2> | undefined);
     /** The query parameters for AI Agent */
     queryParams?: AIAgentQueryParams;
     /** The adapter for detecting online/offline network state */
@@ -887,7 +916,7 @@ export declare type AIAgentProps = PropsWithChildren<{
      * @public
      * @description AIAgent global default config.
      * */
-    config?: AIAgentConfig;
+    config?: DeepPartial<AIAgentConfig_2>;
     /** @internal */
     deskParams?: {
         customApiHost?: string;
@@ -1100,6 +1129,7 @@ declare interface AIAgentStringSet {
         a11y_hint_open_conversation: string;
         a11y_hint_open_conversations: string;
         a11y_hint_close_conversation: string;
+        a11y_hint_close_messenger: string;
         a11y_hint_open_menu: string;
         a11y_hint_connect_to_agent: string;
         a11y_hint_attach_file: string;
@@ -1756,7 +1786,7 @@ export declare const ConversationLayout: {
 declare interface ConversationLayoutTemplateProps {
 }
 
-export declare const ConversationList: ({ conversationListLimit, conversationListFilter, children, onOpenConversationView, style, }: Props_4) => JSX.Element;
+export declare const ConversationList: ({ conversationListLimit, conversationListFilter, children, onOpenConversationView, announcementsEnabled, style, }: Props_4) => JSX.Element;
 
 /**
  * A collection for managing AI agent group channels with real-time updates and pagination.
@@ -2395,6 +2425,11 @@ export declare type DateSeparatorProps = SBUFoundationProps<{
     date?: Date | number;
 }>;
 
+/**
+ * Recursively makes every property of T optional, including nested objects.
+ */
+declare type DeepPartial<T> = T extends object ? { [K in keyof T]?: DeepPartial<T[K]> } : T;
+
 export declare const DefaultMessenger: ForwardRefExoticComponent<MessengerProps & RefAttributes<MessengerSessionRef>>;
 
 export declare interface DeskClientInterface {
@@ -2665,6 +2700,7 @@ BaseMessageProps<{
     isFeedbackEnabled?: boolean;
     isFeedbackCommentEnabled?: boolean;
     isSenderAvatarVisible?: boolean;
+    markdownImageRenderMode?: MarkdownImageRenderMode;
 
     // handlers
     onGetCachedMessageTemplate?: (templateKey: string) => string | null;
@@ -2744,6 +2780,7 @@ export declare const IncomingMessageLayout: {
                 isFeedbackEnabled?: boolean;
                 isFeedbackCommentEnabled?: boolean;
                 isSenderAvatarVisible?: boolean;
+                markdownImageRenderMode?: MarkdownImageRenderMode;
                 onGetCachedMessageTemplate?: (templateKey: string) => string | null;
                 onRequestMessageTemplate?: (templateKey: string) => Promise<string>;
                 onHandleTemplateInternalAction?: (action: Action) => void;
@@ -2817,6 +2854,7 @@ export declare const IncomingMessageLayout: {
                 isFeedbackEnabled?: boolean;
                 isFeedbackCommentEnabled?: boolean;
                 isSenderAvatarVisible?: boolean;
+                markdownImageRenderMode?: MarkdownImageRenderMode;
                 onGetCachedMessageTemplate?: (templateKey: string) => string | null;
                 onRequestMessageTemplate?: (templateKey: string) => Promise<string>;
                 onHandleTemplateInternalAction?: (action: Action) => void;
@@ -2890,6 +2928,7 @@ export declare const IncomingMessageLayout: {
                 isFeedbackEnabled?: boolean;
                 isFeedbackCommentEnabled?: boolean;
                 isSenderAvatarVisible?: boolean;
+                markdownImageRenderMode?: MarkdownImageRenderMode;
                 onGetCachedMessageTemplate?: (templateKey: string) => string | null;
                 onRequestMessageTemplate?: (templateKey: string) => Promise<string>;
                 onHandleTemplateInternalAction?: (action: Action) => void;
@@ -2994,6 +3033,7 @@ export declare const IncomingMessageLayout: {
     isFeedbackEnabled?: boolean;
     isFeedbackCommentEnabled?: boolean;
     isSenderAvatarVisible?: boolean;
+    markdownImageRenderMode?: MarkdownImageRenderMode;
     onGetCachedMessageTemplate?: (templateKey: string) => string | null;
     onRequestMessageTemplate?: (templateKey: string) => Promise<string>;
     onHandleTemplateInternalAction?: (action: Action) => void;
@@ -3067,6 +3107,7 @@ export declare const IncomingMessageLayout: {
     isFeedbackEnabled?: boolean;
     isFeedbackCommentEnabled?: boolean;
     isSenderAvatarVisible?: boolean;
+    markdownImageRenderMode?: MarkdownImageRenderMode;
     onGetCachedMessageTemplate?: (templateKey: string) => string | null;
     onRequestMessageTemplate?: (templateKey: string) => Promise<string>;
     onHandleTemplateInternalAction?: (action: Action) => void;
@@ -3140,6 +3181,7 @@ export declare const IncomingMessageLayout: {
     isFeedbackEnabled?: boolean;
     isFeedbackCommentEnabled?: boolean;
     isSenderAvatarVisible?: boolean;
+    markdownImageRenderMode?: MarkdownImageRenderMode;
     onGetCachedMessageTemplate?: (templateKey: string) => string | null;
     onRequestMessageTemplate?: (templateKey: string) => Promise<string>;
     onHandleTemplateInternalAction?: (action: Action) => void;
@@ -3239,6 +3281,7 @@ export declare const IncomingMessageLayout: {
     isFeedbackEnabled?: boolean;
     isFeedbackCommentEnabled?: boolean;
     isSenderAvatarVisible?: boolean;
+    markdownImageRenderMode?: MarkdownImageRenderMode;
     onGetCachedMessageTemplate?: (templateKey: string) => string | null;
     onRequestMessageTemplate?: (templateKey: string) => Promise<string>;
     onHandleTemplateInternalAction?: (action: Action) => void;
@@ -3312,6 +3355,7 @@ export declare const IncomingMessageLayout: {
     isFeedbackEnabled?: boolean;
     isFeedbackCommentEnabled?: boolean;
     isSenderAvatarVisible?: boolean;
+    markdownImageRenderMode?: MarkdownImageRenderMode;
     onGetCachedMessageTemplate?: (templateKey: string) => string | null;
     onRequestMessageTemplate?: (templateKey: string) => Promise<string>;
     onHandleTemplateInternalAction?: (action: Action) => void;
@@ -3385,6 +3429,7 @@ export declare const IncomingMessageLayout: {
     isFeedbackEnabled?: boolean;
     isFeedbackCommentEnabled?: boolean;
     isSenderAvatarVisible?: boolean;
+    markdownImageRenderMode?: MarkdownImageRenderMode;
     onGetCachedMessageTemplate?: (templateKey: string) => string | null;
     onRequestMessageTemplate?: (templateKey: string) => Promise<string>;
     onHandleTemplateInternalAction?: (action: Action) => void;
@@ -3507,6 +3552,7 @@ export declare const IncomingMessageLayout: {
             isFeedbackEnabled?: boolean;
             isFeedbackCommentEnabled?: boolean;
             isSenderAvatarVisible?: boolean;
+            markdownImageRenderMode?: MarkdownImageRenderMode;
             onGetCachedMessageTemplate?: (templateKey: string) => string | null;
             onRequestMessageTemplate?: (templateKey: string) => Promise<string>;
             onHandleTemplateInternalAction?: (action: Action) => void;
@@ -3580,6 +3626,7 @@ export declare const IncomingMessageLayout: {
             isFeedbackEnabled?: boolean;
             isFeedbackCommentEnabled?: boolean;
             isSenderAvatarVisible?: boolean;
+            markdownImageRenderMode?: MarkdownImageRenderMode;
             onGetCachedMessageTemplate?: (templateKey: string) => string | null;
             onRequestMessageTemplate?: (templateKey: string) => Promise<string>;
             onHandleTemplateInternalAction?: (action: Action) => void;
@@ -3653,6 +3700,7 @@ export declare const IncomingMessageLayout: {
             isFeedbackEnabled?: boolean;
             isFeedbackCommentEnabled?: boolean;
             isSenderAvatarVisible?: boolean;
+            markdownImageRenderMode?: MarkdownImageRenderMode;
             onGetCachedMessageTemplate?: (templateKey: string) => string | null;
             onRequestMessageTemplate?: (templateKey: string) => Promise<string>;
             onHandleTemplateInternalAction?: (action: Action) => void;
@@ -3851,6 +3899,8 @@ declare interface ManualSessionInfoParams {
     sessionHandler: AIAgentSessionHandler;
 }
 
+declare type MarkdownImageRenderMode = 'default' | 'complete-only';
+
 declare interface MemoryInfo {
     enabled: boolean;
     showIndicator: boolean;
@@ -4435,6 +4485,7 @@ declare type Props_4 = PropsWithChildren<{
     conversationListLimit?: number;
     conversationListFilter?: Partial<AIAgentGroupChannelFilter>;
     onOpenConversationView?: (channelUrl: string, status: 'open' | 'closed') => void;
+    announcementsEnabled?: boolean;
     /** Custom styles for the conversation list container. */
     style?: CSSProperties;
 }>;