@sendbird/ai-agent-messenger-react 1.25.0 → 1.26.1

package/dist/index.d.ts

@@ -423,7 +423,8 @@ declare type AIAgentCommonIconName =
 | 'photo'
 | 'add'
 | 'document'
-| 'download';
+| 'download'
+| 'memory';
 
 export declare interface AIAgentConfig {
     conversation?: {
@@ -520,6 +521,10 @@ declare interface AIAgentContextValue {
 declare interface AIAgentConversationContextValue {
     conversation: ChatSDKConversation | undefined;
 
+    actions: {
+        setUserMemoryState: (params: { enabled: boolean }) => Promise<MemoryInfo>;
+    };
+
     channelSource: {
         channel: ChatSDKGroupChannel | undefined;
         error: ChatSDKSendbirdError | undefined;
@@ -692,10 +697,15 @@ declare interface AIAgentInterface {
     updateContext: (channelUrl: string, context: Record<string, string>) => Promise<ContextObject>;
     /** Retrieves the context data for the specified channel */
     getContextObject: (channelUrl: string) => Promise<ContextObject>;
+    /** Clears memories saved for the current user */
+    clearUserMemories: (params?: ClearUserMemoriesParams) => Promise<void>;
 
     /** @internal Refreshes the active channel by re-requesting messenger settings */
     refreshActiveChannel: (options?: { useKnownActiveChannelUrl?: boolean }) => Promise<string>;
 
+    /** @internal Sets whether the current user uses memory */
+    setUserMemoryState: (params: SetUserMemoryStateParams) => Promise<MemoryInfo>;
+
     /** @internal Initializes a conversation on the channel if needed (AI Agent channel without conversation). */
     initConversationIfNeeded: (channel: ChatSDKGroupChannel) => Promise<void>;
 
@@ -727,6 +737,7 @@ declare interface AIAgentMessengerSessionContextValue {
     userSession: null | UserSession;
     aiAgentInfo: null | AIAgentInfo;
     launcherInfo: null | LauncherInfo;
+    memoryInfo: null | MemoryInfo;
 
     connectionError?: Error;
 
@@ -1072,6 +1083,10 @@ declare interface AIAgentStringSet {
         a11y_file_image: (name: string) => string;
         a11y_file_video: (name: string) => string;
         a11y_file_document: (name: string) => string;
+        a11y_received_file_image: string;
+        a11y_received_file_video: string;
+        a11y_received_file_pdf: (name: string) => string;
+        a11y_received_files_image_count: (count: number) => string;
         a11y_screen_conversation: string;
         a11y_screen_conversation_with_agent: (name: string) => string;
         a11y_screen_conversation_list_no_count: string;
@@ -1130,7 +1145,7 @@ declare interface AIAgentStringSet {
         question: string;
         submit_label: string;
         submission_expired: string;
-        a11y_rating_label: (score: number, label: string) => string;
+        a11y_csat_rating_label: (score: number, label: string) => string;
         a11y_hint_select_rating: string;
     };
 
@@ -1168,6 +1183,24 @@ declare interface AIAgentStringSet {
         confirm_handoff: string;
     };
 
+    memory: {
+        dialog_title: string;
+        desc_on: string;
+        desc_off: string;
+        button_use: string;
+        button_dont_use: string;
+        button_keep_using: string;
+        button_disable: string;
+        button_disable_and_delete: string;
+        button_keep_off: string;
+        button_enable: string;
+        button_cancel: string;
+        error_message: string;
+        a11y_indicator_manage: string;
+        a11y_indicator_on: string;
+        a11y_indicator_off: string;
+    };
+
     connection_delay: {
         title: string;
         description: (formattedTime: string) => string;
@@ -1229,6 +1262,14 @@ declare type BaseMessageProps<T> = T & {
     children?: ReactNode;
 };
 
+/**
+ * Settings shape persisted in the cache layer. The server always returns `memory`,
+ * but caches written before the field was introduced may not have it.
+ */
+declare type CachedMessengerSettings = Omit<MessengerSettingsResponse, 'memory'> & {
+    memory?: MessengerSettingsResponse['memory'];
+};
+
 declare type ChatSDKAIAgentChannelFilter = AIAgentChannelFilter;
 
 declare type ChatSDKAIAgentGroupChannelListQuery = AIAgentGroupChannelListQuery;
@@ -1295,6 +1336,10 @@ export declare interface CitationInfo {
     link: string;
 }
 
+declare interface ClearUserMemoriesParams {
+    contextAiAgentId?: string;
+}
+
 declare interface CloseConversationCommandParams {
     channelUrl: string;
 }
@@ -1327,6 +1372,17 @@ declare interface ColorSet {
     csat: {
         background: string;
     };
+    memoryDialog: {
+        titleText: string;
+        markdownBodyText: string;
+        markdownLinkText: string;
+        positiveBackground: string;
+        positiveText: string;
+        positiveBorderColor: string;
+        negativeBackground: string;
+        negativeText: string;
+        negativeBorderColor: string;
+    };
 }
 
 /**
@@ -1444,6 +1500,7 @@ export declare const ConversationHeaderLayout: {
             EndArea: () => ReactNode;
             MenuButton: () => ReactNode;
             Title: () => ReactNode;
+            MemoryIndicator: () => ReactNode;
             HandoffButton: () => ReactNode;
             ConversationCloseButton: () => ReactNode;
             ExpandButton: () => ReactNode;
@@ -1460,6 +1517,7 @@ export declare const ConversationHeaderLayout: {
     EndArea: () => ReactNode;
     MenuButton: () => ReactNode;
     Title: () => ReactNode;
+    MemoryIndicator: () => ReactNode;
     HandoffButton: () => ReactNode;
     ConversationCloseButton: () => ReactNode;
     ExpandButton: () => ReactNode;
@@ -1471,6 +1529,7 @@ export declare const ConversationHeaderLayout: {
     EndArea: () => ReactNode;
     MenuButton: () => ReactNode;
     Title: () => ReactNode;
+    MemoryIndicator: () => ReactNode;
     HandoffButton: () => ReactNode;
     ConversationCloseButton: () => ReactNode;
     ExpandButton: () => ReactNode;
@@ -1492,6 +1551,9 @@ export declare const ConversationHeaderLayout: {
     Title: (props: {
         component: () => ReactNode;
     }) => null;
+    MemoryIndicator: (props: {
+        component: () => ReactNode;
+    }) => null;
     HandoffButton: (props: {
         component: () => ReactNode;
     }) => null;
@@ -1694,7 +1756,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.
@@ -2093,12 +2155,14 @@ declare interface ConversationListContextProps {
     conversationListLimit?: number;
     conversationListFilter?: Partial<AIAgentGroupChannelFilter>;
     onOpenConversationView?: (channelUrl: string, status: 'open' | 'closed') => void;
+    announcementsEnabled?: boolean;
 }
 
-export declare function ConversationListContextProvider({ conversationListLimit, conversationListFilter, onOpenConversationView, children, }: PropsWithChildren<ConversationListContextProps>): JSX.Element;
+export declare function ConversationListContextProvider({ conversationListLimit, conversationListFilter, onOpenConversationView, announcementsEnabled, children, }: PropsWithChildren<ConversationListContextProps>): JSX.Element;
 
 declare interface ConversationListContextValue extends AIAgentConversationListContextValue {
     onOpenConversationView: (channelUrl: string, status: 'open' | 'closed') => void;
+    announcementsEnabled: boolean;
 }
 
 export declare const ConversationListHeaderLayout: {
@@ -3789,6 +3853,14 @@ declare interface ManualSessionInfoParams {
     sessionHandler: AIAgentSessionHandler;
 }
 
+declare interface MemoryInfo {
+    enabled: boolean;
+    showIndicator: boolean;
+    toggleAllowed: boolean;
+    deleteOnOff: boolean;
+    consentDialog: MessengerSettingsResponse['memory']['consent_dialog'];
+}
+
 /**
  * @description
  * - single: The message is standalone (not grouped with adjacent messages).
@@ -3933,7 +4005,7 @@ declare interface MessengerProps extends AIAgentProps {
 }
 
 declare interface MessengerSessionCache {
-    getSettings(userId: string): MessengerSettingsResponse | null;
+    getSettings(userId: string): CachedMessengerSettings | null;
     setSettings(userId: string, value: MessengerSettingsResponse): void;
     getAnonUser(): AnonUserSessionData | null;
     setAnonUser(value: AnonUserSessionData): void;
@@ -3992,6 +4064,13 @@ declare interface MessengerSettingsResponse {
         image_url: string;
         auto_open: boolean;
     };
+    memory: {
+        enabled: boolean;
+        show_indicator: boolean;
+        toggle_allowed: boolean;
+        delete_on_off: boolean;
+        consent_dialog: { body: string } | null;
+    };
     auto_created_user?: {
         user_id: string;
         session_token: string;
@@ -4008,10 +4087,9 @@ declare interface MessengerSettingsResponse {
     country: string | null;
 }
 
-declare interface MessengerSettingsUpdatedParams {
-    settings: MessengerSettingsResponse;
-    source: 'cache' | 'server';
-}
+declare type MessengerSettingsUpdatedParams =
+| { settings: MessengerSettingsResponse; source: 'server' }
+| { settings: CachedMessengerSettings; source: 'cache' };
 
 declare type MultiSelectField = {
     key: string;
@@ -4359,6 +4437,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;
 }>;
@@ -4392,6 +4471,11 @@ declare interface SearchConversationParams {
     context: Record<string, string>;
 }
 
+declare interface SetUserMemoryStateParams {
+    enabled: boolean;
+    contextAiAgentId?: string;
+}
+
 declare type SingleSelectField = {
     key: string;
     type: 'single-select';
@@ -4564,6 +4648,10 @@ declare type StringSet = {
     A11Y_FILE_IMAGE: (name: string) => string;
     A11Y_FILE_VIDEO: (name: string) => string;
     A11Y_FILE_DOCUMENT: (name: string) => string;
+    A11Y_RECEIVED_FILE_IMAGE: string;
+    A11Y_RECEIVED_FILE_VIDEO: string;
+    A11Y_RECEIVED_FILE_PDF: (name: string) => string;
+    A11Y_RECEIVED_FILES_IMAGE_COUNT: (count: number) => string;
     A11Y_FILE_SELECTED?: (label: string) => string;
     A11Y_FILE_REMOVE_BUTTON: (name: string) => string;
     A11Y_SCREEN_CONVERSATION: string;
@@ -4576,7 +4664,6 @@ declare type StringSet = {
     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;
@@ -4598,6 +4685,21 @@ declare type StringSet = {
     HANDOFF_CONFIRM__DESCRIPTION: string;
     HANDOFF_CONFIRM__CANCEL: string;
     HANDOFF_CONFIRM__HANDOFF: string;
+    MEMORY__DIALOG_TITLE: string;
+    MEMORY__DESC_ON: string;
+    MEMORY__DESC_OFF: string;
+    MEMORY__BUTTON_USE: string;
+    MEMORY__BUTTON_DONT_USE: string;
+    MEMORY__BUTTON_KEEP_USING: string;
+    MEMORY__BUTTON_DISABLE: string;
+    MEMORY__BUTTON_DISABLE_AND_DELETE: string;
+    MEMORY__BUTTON_KEEP_OFF: string;
+    MEMORY__BUTTON_ENABLE: string;
+    MEMORY__BUTTON_CANCEL: string;
+    MEMORY__ERROR_MESSAGE: string;
+    A11Y_MEMORY_INDICATOR_MANAGE: string;
+    A11Y_MEMORY_INDICATOR_ON: string;
+    A11Y_MEMORY_INDICATOR_OFF: string;
     CONNECTION_DELAY__TITLE: string;
     CONNECTION_DELAY__DESCRIPTION: (formattedTime: string) => string;
     /** @deprecated Please use DATE_FORMAT__DATE_SHORT instead. **/