@sendbird/ai-agent-messenger-react 1.21.2 → 1.22.0

package/dist/index.d.ts

@@ -4,6 +4,7 @@ import { AIAgentGroupChannelListQuery } from '@sendbird/chat/aiAgent';
 import { AIAgentModule } from '@sendbird/chat/aiAgent';
 import { BaseChannel } from '@sendbird/chat';
 import { BaseMessage } from '@sendbird/chat/message';
+import type { CollectionEventSource } from '@sendbird/chat';
 import { ComponentType } from 'react';
 import { ConnectionHandler } from '@sendbird/chat';
 import { Context } from 'react';
@@ -188,6 +189,7 @@ rootElement?: HTMLElement;
 theme?: {
 palette?: Partial<PaletteShape>;
 typography?: Partial<{ [K in keyof TypographyShape]: Partial<TypographyShape[K]>; }>;
+colors?: ColorSetInput;
 };
 /**
 * @public
@@ -286,7 +288,7 @@ __internalVariables?: InternalMessageTemplateVariables;
 children?: ReactNode | undefined;
 } & RefAttributes<MessengerSessionRef>>;
 
-export declare function AgentUIProviderContainer({ appearance, rootElement, logger, language, stringSet, children, messageTemplate, theme, }: Props): JSX.Element;
+export declare function AgentUIProviderContainer({ appearance, rootElement, logger, language, languageCode, stringSet, children, messageTemplate, theme, }: Props): JSX.Element;
 
 declare abstract class AIAgentBaseStats {
     protected timers: Map<string, TimerData> = new Map();
@@ -485,6 +487,7 @@ declare interface AIAgentConversationContextValue {
         messages: BaseMessage[];
         newMessages: BaseMessage[];
         initialized: boolean;
+        subscribeMessageEvents: (listener: (event: ConversationMessageEvent) => void) => () => void;
         loadPrevious: () => Promise<void>;
         loadNext: () => Promise<void>;
         sendUserMessage: (params: UserMessageCreateParams) => Promise<UserMessage>;
@@ -760,6 +763,7 @@ export declare type AIAgentProps = PropsWithChildren<{
         typography?: Partial<{
             [K in keyof TypographyShape]: Partial<TypographyShape[K]>;
         }>;
+        colors?: ColorSetInput;
     };
     /**
      * @public
@@ -954,6 +958,7 @@ declare interface AIAgentStringSet {
     conversation: {
         input_placeholder: string;
         input_placeholder_disabled: string;
+        input_placeholder_steward: string;
         input_placeholder_wait_ai_agent_response: string;
         input_placeholder_active_form: string;
         input_placeholder_reconnecting: string;
@@ -973,14 +978,61 @@ declare interface AIAgentStringSet {
         a11y_message_list: string;
         a11y_scroll_to_bottom: string;
         a11y_scroll_to_new_messages: string;
+        /** @deprecated Use a11y_menu instead. */
         a11y_open_conversation_list: string;
+        a11y_open_conversation: string;
+        a11y_open_conversations: string;
+        a11y_close_conversation: string;
+        a11y_close_conversations: string;
+        a11y_menu: string;
+        a11y_message_input: string;
+        a11y_send_message: string;
+        a11y_attach_file: string;
+        a11y_close_messenger: string;
+        a11y_expand_messenger: string;
+        a11y_collapse_messenger: string;
+        a11y_connect_agent: string;
+        a11y_message_sender_you: string;
+        a11y_suggested_reply: string;
+        a11y_typing_indicator: string;
+        a11y_code_block_placeholder: string;
+        a11y_typing_format: (name: string) => string;
+        a11y_message_failed: string;
+        a11y_new_messages_received: (count: number) => string;
+        a11y_new_messages_received_from_sender: (sender: string, count: number) => string;
+        a11y_agent_connected: (name: string) => string;
+        a11y_conversation_closed: string;
+        a11y_file_image: (name: string) => string;
+        a11y_file_video: (name: string) => string;
+        a11y_file_document: (name: string) => string;
+        a11y_screen_conversation: string;
+        a11y_screen_conversation_with_agent: (name: string) => string;
+        a11y_screen_conversation_list_no_count: string;
+        a11y_csat_displayed: string;
+        a11y_empty_conversation: string;
+        a11y_input_disabled: string;
+        a11y_file_size_exceeded: (maxSizeMB: number) => string;
+        a11y_csat_form_error: string;
+        a11y_hint_send_message: string;
+        a11y_hint_open_conversation: string;
+        a11y_hint_open_conversations: string;
+        a11y_hint_close_conversation: string;
+        a11y_hint_open_menu: string;
+        a11y_hint_connect_to_agent: string;
+        a11y_hint_attach_file: string;
+        a11y_hint_view_new_messages: string;
+        a11y_hint_open_file: string;
+        a11y_hint_open_image: string;
+        a11y_hint_send_reply: string;
     };
 
     conversation_list: {
         header_title: string;
         ended: string;
+        system_message: string;
         footer_title: string;
         multiple_files_count: (count: number) => string;
+        a11y_conversation_item: (agent: string, status: string, time: string, count: number) => string;
     };
 
     date_format: {
@@ -1002,6 +1054,8 @@ declare interface AIAgentStringSet {
         question: string;
         submit_label: string;
         submission_expired: string;
+        a11y_rating_label: (score: number, label: string) => string;
+        a11y_hint_select_rating: string;
     };
 
     form: {
@@ -1028,6 +1082,13 @@ declare interface AIAgentStringSet {
         edit: string;
         remove: string;
     };
+
+    handoff: {
+        confirm_title: string;
+        confirm_description: string;
+        confirm_cancel: string;
+        confirm_handoff: string;
+    };
 }
 
 declare type AnonUserSessionData = { userId: string; authToken: string; expireAt: number };
@@ -1099,6 +1160,55 @@ declare interface CloseConversationCommandParams {
     channelUrl: string;
 }
 
+/**
+ * Output type — the resolved shape of theme.colors.
+ * All values are plain strings. This is what components consume.
+ */
+declare interface ColorSet {
+    base: {
+        primary: string;
+        primaryContrastContent: string;
+        background: string;
+        headerBackground: string;
+        modalContentBackground: string;
+    };
+    messageInput: {
+        text: string;
+        placeholderText: string;
+        background: string;
+    };
+    messageIncoming: {
+        text: string;
+        background: string;
+    };
+    messageOutgoing: {
+        text: string;
+        background: string;
+    };
+    csat: {
+        background: string;
+    };
+}
+
+/**
+ * Input type — what users pass via the colors prop.
+ * Each string field is replaced with ColorValue for light/dark support.
+ * All fields are optional (partial override).
+ */
+declare type ColorSetInput = {
+    [K in keyof ColorSet]?: {
+        [P in keyof ColorSet[K]]?: ColorValue;
+    };
+};
+
+/**
+ * A color value that can be:
+ * - A single hex string (applied to both light and dark themes)
+ * - An object with optional light/dark hex strings (theme-specific).
+ *   When only one side is provided, the other falls back to the auto-generated value.
+ */
+declare type ColorValue = HexColor | { light?: HexColor; dark?: HexColor };
+
 declare interface CommandPayloads {
     [CommandType.ConversationClose]: undefined | CloseConversationCommandParams;
     [CommandType.MessengerSettingsUpdated]: MessengerSettingsUpdatedParams;
@@ -1129,7 +1239,7 @@ declare interface ContextObject {
     context: Record<string, string>;
 }
 
-export declare const Conversation: ({ children, onNavigateToConversationList, channelUrl, onClearChannelUrl, shouldMarkAsRead, style, closedChannelUrl, onClearClosedChannelUrl, }: Props_3) => JSX.Element;
+export declare const Conversation: ({ children, onNavigateToConversationList, channelUrl, onClearChannelUrl, shouldMarkAsRead, announcementsEnabled, style, closedChannelUrl, onClearClosedChannelUrl, }: Props_3) => JSX.Element;
 
 export declare const ConversationContext: Context<ConversationContextValue | null>;
 
@@ -1379,7 +1489,7 @@ declare class ConversationInitialRenderStatsTracker {
 export declare const ConversationLayout: {
     (props: PropsWithChildren): ReactNode;
     defaults: {
-        template: ComponentType<unknown>;
+        template: ComponentType<ConversationLayoutTemplateProps>;
         components: {
             Header: () => ReactNode;
             Body: () => JSX.Element;
@@ -1387,15 +1497,15 @@ export declare const ConversationLayout: {
         };
     };
     Template: ({ template, children }: {
-        template?: ComponentType<unknown> | undefined;
+        template?: ComponentType<ConversationLayoutTemplateProps> | undefined;
         children?: ReactNode;
     }) => JSX.Element;
-    Context: Context<LayoutContextValue<unknown, {
+    Context: Context<LayoutContextValue<ConversationLayoutTemplateProps, {
     Header: () => ReactNode;
     Body: () => JSX.Element;
     Footer: () => JSX.Element;
     }>>;
-    useContext: () => LayoutContextValue<unknown, {
+    useContext: () => LayoutContextValue<ConversationLayoutTemplateProps, {
     Header: () => ReactNode;
     Body: () => JSX.Element;
     Footer: () => JSX.Element;
@@ -1412,6 +1522,9 @@ export declare const ConversationLayout: {
     }) => null;
 };
 
+declare interface ConversationLayoutTemplateProps {
+}
+
 export declare const ConversationList: ({ conversationListLimit, conversationListFilter, children, onOpenConversationView, style, }: Props_4) => JSX.Element;
 
 /**
@@ -1931,6 +2044,25 @@ export declare const ConversationListLayout: {
     }) => null;
 };
 
+declare type ConversationMessageEvent = ConversationMessageEventPayload & { id: number };
+
+declare type ConversationMessageEventPayload =
+| {
+    kind: 'messagesAdded';
+    source: CollectionEventSource;
+    messages: BaseMessage[];
+}
+| {
+    kind: 'messagesUpdated';
+    source: CollectionEventSource;
+    messages: BaseMessage[];
+}
+| {
+    kind: 'initialized';
+    source: 'cache' | 'api';
+    messages: BaseMessage[];
+};
+
 declare interface ConversationScrollContextValue {
     ref: RefObject<HTMLDivElement | null> | ((element: HTMLDivElement | null) => void);
     state: {
@@ -2112,7 +2244,7 @@ export declare interface ExtendedMessagePayload {
         url: string;
     };
     suggested_replies: string[];
-    user_input_disabled_by: 'suggested_replies';
+    user_input_disabled_by: 'suggested_replies' | 'steward' | 'system';
     message_template: MessageTemplateShape;
     custom_message_templates: CustomMessageTemplateData[];
     csat: {
@@ -2167,6 +2299,7 @@ export declare interface ExtendedMessagePayload {
     citations?: CitationInfo[];
     feedback?: FeedbackInfo;
     form?: Form;
+    steward?: Steward;
 
     // logs
     groundedness: GroundednessInfo[];
@@ -2264,6 +2397,13 @@ export declare interface GroundednessInfo {
     preview_title: string;
 }
 
+/**
+ * Hex color string type. Enforces '#' prefix at compile time.
+ * Only validates the prefix — does not guarantee valid hex digits or length.
+ * Invalid values (e.g. '#zzz') will produce undefined rendering behavior.
+ */
+declare type HexColor = `#${string}`;
+
 /**
  * frequently used icons are imported statically, and others are imported dynamically.
  * */
@@ -2282,6 +2422,9 @@ declare const icons: {
     readonly 'chevron-down': LazyExoticComponent<FC<SVGProps<SVGElement>>>;
     readonly 'chevron-right': LazyExoticComponent<FC<SVGProps<SVGElement>>>;
     readonly done: LazyExoticComponent<FC<SVGProps<SVGElement>>>;
+    readonly 'done-circle': LazyExoticComponent<FC<SVGProps<SVGElement>>>;
+    readonly stop: LazyExoticComponent<FC<SVGProps<SVGElement>>>;
+    readonly 'stop-circle': LazyExoticComponent<FC<SVGProps<SVGElement>>>;
     readonly user: LazyExoticComponent<FC<SVGProps<SVGElement>>>;
     readonly 'file-document': LazyExoticComponent<FC<SVGProps<SVGElement>>>;
     readonly download: LazyExoticComponent<FC<SVGProps<SVGElement>>>;
@@ -3431,6 +3574,8 @@ declare type InputState = {
     | 'ai_responding'
     | 'conversation_closed'
     | 'suggested_replies'
+    | 'steward'
+    | 'system'
     | 'reconnecting'
     | 'handoff_pending'
     | (string & {});
@@ -3450,7 +3595,7 @@ declare interface LanguageSet extends Omit<AIAgentLanguageSet, 'strings'> {
     stringSet: StringSet;
 }
 
-export declare function LauncherBase({ className, isOpened, onClick, type, imageUrl, dir, animated, backgroundColor, size, }: LauncherProps): JSX.Element;
+export declare function LauncherBase({ className, children, isOpened, onClick, ariaLabel, 'aria-label': ariaLabelProp, 'aria-describedby': ariaDescribedBy, type, imageUrl, dir, animated, backgroundColor, size, }: LauncherProps): JSX.Element;
 
 declare type LauncherImageType = 'default_icon' | 'custom_image';
 
@@ -3461,8 +3606,12 @@ declare interface LauncherInfo {
 
 declare type LauncherProps = {
     className?: string;
+    children?: ReactNode;
     isOpened: boolean;
     onClick?: () => void;
+    ariaLabel?: string;
+    'aria-label'?: string;
+    'aria-describedby'?: string;
     type: LauncherImageType;
     imageUrl: string;
     backgroundColor: string;
@@ -3480,6 +3629,7 @@ declare interface LayoutContextValue<Props, Components extends Record<string, Co
 
 declare interface LocalizationContextValue extends LanguageSet {
     format: typeof format;
+    defaultStringSet: StringSet;
 }
 
 declare interface Loggable {
@@ -4025,11 +4175,14 @@ declare type Props = {
     logger?: Loggable;
     stringSet?: Partial<StringSet>;
     language?: string;
+    /** @internal DO NOT USE THIS **/
+    languageCode?: string;
     theme?: {
         palette?: Partial<PaletteShape>;
         typography?: Partial<{
             [K in keyof TypographyShape]: Partial<TypographyShape[K]>;
         }>;
+        colors?: ColorSetInput;
     };
     /** @internal DO NOT USE THIS **/
     messageTemplate?: {
@@ -4066,6 +4219,7 @@ declare type Props_3 = PropsWithChildren<{
     onClearChannelUrl?: () => void;
     onNavigateToConversationList?: () => void;
     shouldMarkAsRead?: boolean;
+    announcementsEnabled?: boolean;
     /** Custom styles for the conversation container. */
     style?: CSSProperties;
     /** @deprecated Please use `channelUrl` instead. **/
@@ -4113,6 +4267,39 @@ declare type SingleSelectField = {
 
 declare type StatsAppendCallback = (type: string, data: AIAgentStatPayload) => boolean;
 
+declare interface Steward {
+    title: string;
+    description?: string;
+    status?: StewardStatus;
+    cancellation_option?: StewardCancellationOption;
+    tasks: StewardTask[];
+}
+
+declare interface StewardCancellationOption {
+    title: string;
+    description: string;
+    positive_text: string;
+    negative_text: string;
+}
+
+declare enum StewardStatus {
+    IN_PROGRESS = 'IN_PROGRESS',
+    COMPLETED = 'COMPLETED',
+    CANCELED = 'CANCELED',
+}
+
+declare interface StewardTask {
+    id: string;
+    user_facing_title: string;
+    status: StewardTaskStatus;
+}
+
+declare enum StewardTaskStatus {
+    IN_PROGRESS = 'IN_PROGRESS',
+    COMPLETED = 'COMPLETED',
+    CANCELED = 'CANCELED',
+}
+
 /**
  * StringSet type for React components
  * Uses SNAKE_CASE keys for backward compatibility
@@ -4126,6 +4313,7 @@ declare type StringSet = {
     MESSAGE_INPUT__PLACE_HOLDER__WAIT_AI_AGENT_RESPONSE: string;
     MESSAGE_INPUT__PLACE_HOLDER__SUGGESTED_REPLIES: string;
     MESSAGE_INPUT__PLACE_HOLDER__DISABLED: string;
+    MESSAGE_INPUT__PLACE_HOLDER__STEWARD: string;
     MESSAGE_INPUT__PLACE_HOLDER__RECONNECTING: string;
     BUTTON__CANCEL: string;
     BUTTON__SUBMIT: string;
@@ -4174,6 +4362,7 @@ declare type StringSet = {
     CONVERSATION_LIST__HEADER_TITLE: string;
     CONVERSATION_LIST__NO_CONVERSATIONS: string;
     CONVERSATION_LIST__ENDED: string;
+    CONVERSATION_LIST__SYSTEM_MESSAGE: string;
     CONVERSATION_LIST__MULTIPLE_FILES_COUNT: (count: number) => string;
     CITATION_SOURCE_TITLE: string;
     FORM_PLACEHOLDER: string;
@@ -4202,13 +4391,70 @@ declare type StringSet = {
     A11Y_MESSAGE_LIST: string;
     A11Y_SCROLL_TO_BOTTOM: string;
     A11Y_SCROLL_TO_NEW_MESSAGES: string;
+    /** @deprecated Use A11Y_MENU instead. */
     A11Y_OPEN_CONVERSATION_LIST: string;
+    A11Y_OPEN_CONVERSATION: string;
+    A11Y_OPEN_CONVERSATIONS: string;
+    A11Y_CLOSE_CONVERSATION: string;
+    A11Y_CLOSE_CONVERSATIONS: string;
+    A11Y_MENU: string;
+    A11Y_MESSAGE_INPUT: string;
+    A11Y_SEND_MESSAGE: string;
     A11Y_IMAGE_VIEWER_CLOSE: string;
     A11Y_IMAGE_VIEWER_PREVIOUS: string;
     A11Y_IMAGE_VIEWER_NEXT: string;
     A11Y_IMAGE_VIEWER_DOWNLOAD: string;
     A11Y_ATTACH_FILE: string;
+    A11Y_MESSAGE_SENDER_YOU: string;
+    A11Y_SUGGESTED_REPLY: string;
+    A11Y_TYPING_INDICATOR: string;
+    A11Y_CODE_BLOCK_PLACEHOLDER: string;
+    A11Y_CSAT_RATING_LABEL: (score: number, label: string) => string;
+    A11Y_FILE_UPLOAD_OPTIONS: string;
+    A11Y_FAILED_MESSAGE_OPTIONS: string;
+    A11Y_FEEDBACK_OPTIONS: string;
+    A11Y_TYPING_FORMAT: (name: string) => string;
+    A11Y_MESSAGE_FAILED: string;
+    A11Y_NEW_MESSAGES_RECEIVED: (count: number) => string;
+    A11Y_NEW_MESSAGES_RECEIVED_FROM_SENDER: (sender: string, count: number) => string;
+    A11Y_AGENT_CONNECTED: (name: string) => string;
+    A11Y_CONVERSATION_CLOSED: string;
+    A11Y_FILE_IMAGE: (name: string) => string;
+    A11Y_FILE_VIDEO: (name: string) => string;
+    A11Y_FILE_DOCUMENT: (name: string) => string;
+    A11Y_FILE_SELECTED?: (label: string) => string;
+    A11Y_FILE_REMOVE_BUTTON: (name: string) => string;
+    A11Y_SCREEN_CONVERSATION: string;
+    A11Y_SCREEN_CONVERSATION_WITH_AGENT: (name: string) => string;
+    A11Y_SCREEN_CONVERSATION_LIST_NO_COUNT: string;
+    A11Y_CSAT_DISPLAYED: string;
+    A11Y_EMPTY_CONVERSATION: string;
+    A11Y_INPUT_DISABLED: string;
+    A11Y_FILE_SIZE_EXCEEDED: (maxSizeMB: number) => string;
+    A11Y_CSAT_FORM_ERROR: string;
+    A11Y_CONVERSATION_ITEM: (agent: string, status: string, time: string, count: number) => string;
+    A11Y_RATING_LABEL: (score: number, label: string) => string;
+    A11Y_CONNECT_AGENT: string;
+    A11Y_CLOSE_MESSENGER: string;
+    A11Y_EXPAND_MESSENGER: string;
+    A11Y_COLLAPSE_MESSENGER: string;
+    A11Y_HINT_SEND_MESSAGE: string;
+    A11Y_HINT_OPEN_CONVERSATION: string;
+    A11Y_HINT_OPEN_CONVERSATIONS: string;
+    A11Y_HINT_CLOSE_CONVERSATION: string;
+    A11Y_HINT_OPEN_MENU: string;
+    A11Y_HINT_CONNECT_TO_AGENT: string;
+    A11Y_HINT_ATTACH_FILE: string;
+    A11Y_HINT_VIEW_NEW_MESSAGES: string;
+    A11Y_HINT_OPEN_FILE: string;
+    A11Y_HINT_OPEN_IMAGE: string;
+    A11Y_HINT_SEND_REPLY: string;
+    A11Y_HINT_SELECT_RATING: string;
     SCROLL_TO_NEW_MESSAGES_LABEL: (messages: BaseMessage[]) => string;
+    HANDOFF_CONFIRM__TITLE: string;
+    HANDOFF_CONFIRM__DESCRIPTION: string;
+    HANDOFF_CONFIRM__CANCEL: string;
+    HANDOFF_CONFIRM__HANDOFF: string;
     /** @deprecated Please use DATE_FORMAT__DATE_SHORT instead. **/
     DATE_FORMAT__CONVERSATION_LIST__LIST_ITEM_TITLE: string;
     /** @deprecated Unused string **/