@sendbird/ai-agent-messenger-react 1.39.0 → 1.40.0

package/dist/index.d.ts

@@ -280,6 +280,8 @@ _UNSAFE_INTERNAL_dashboardTester?: {
 testerType: "default" | "actionbook";
 origin?: string;
 };
+/** @internal DO NOT USE THIS */
+_sourceService?: string;
 /**
 * @internal DO NOT USE THIS - Used by dashboard integration for template variable injection.
 * */
@@ -797,6 +799,9 @@ declare interface AIAgentInterface {
     /** @internal Initializes a conversation on the channel if needed (AI Agent channel without conversation). */
     initConversationIfNeeded: (channel: ChatSDKGroupChannel, params?: { initialUserMessage?: string }) => Promise<void>;
 
+    /** @internal Records the end user's response to a Desk ticket closure inquiry. */
+    confirmEndOfChat: (params: ConfirmEndOfChatParams) => Promise<void>;
+
     /** @internal Live metric handler; bridged from {@link AIAgentClientHandlers.onLiveMetric}. */
     onLiveMetric?: LiveMetricDispatch;
 
@@ -1027,6 +1032,8 @@ export declare type AIAgentProps = PropsWithChildren<{
         testerType: 'default' | 'actionbook';
         origin?: string;
     };
+    /** @internal DO NOT USE THIS */
+    _sourceService?: string;
     /**
      * @internal DO NOT USE THIS - Used by dashboard integration for template variable injection.
      * */
@@ -1324,6 +1331,12 @@ declare interface AIAgentStringSet {
         title: string;
         description: (formattedTime: string) => string;
     };
+
+    desk: {
+        ticket_closure_confirm: string;
+        ticket_closure_decline: string;
+        ticket_closure_error_message: string;
+    };
 }
 
 /**
@@ -1625,6 +1638,12 @@ declare enum CommandType {
     NudgeMessageReceived = 'nudge.message.received',
 }
 
+declare interface ConfirmEndOfChatParams {
+    messageId: number;
+    ticketId: number;
+    confirmed: boolean;
+}
+
 export declare interface ConnectionDelayDialogProps {
     title: string;
     description: string;
@@ -3059,6 +3078,8 @@ export declare interface ExtendedMessagePayload {
     manual: ActionbookInfo;
     function_calls: FunctionCallsInfo[];
     agent_message_templates: AgentMessageTemplateInfo[];
+
+    prechecks?: PrecheckRecord[];
 }
 
 declare type ExternalAuthTokenExpiredData = {
@@ -3211,6 +3232,7 @@ BaseMessageProps<{
     onRequestMessageTemplate?: (templateKey: string) => Promise<string>;
     onHandleTemplateInternalAction?: (action: Action) => void;
     onClickSuggestedReply?: (params: { reply: string }) => void;
+    onConfirmTicketClosure?: (params: { ticketId: number; confirmed: boolean }) => Promise<void>;
     onClickCTA?: (params: { url: string }) => void;
     onClickCitation?: (citation: CitationInfo) => void;
     onFeedbackUpdate?: (params: { rating: 'good' | 'bad'; comment?: string } | null) => void;
@@ -3267,8 +3289,8 @@ export declare const IncomingMessageLayout: {
                     bubbleBackgroundColor?: string;
                 };
             }) => ReactNode;
-            SuggestedReplies: ({ extendedMessagePayload, onClickSuggestedReply, suggestedRepliesDirection, }: IncomingMessageProps) => ReactNode;
-            MessageTemplate: (props: Pick<IncomingMessageProps, "onClickLink" | "onGetCachedMessageTemplate" | "onRequestMessageTemplate" | "onHandleTemplateInternalAction" | "messageTemplateErrorFallback" | "messageTemplateLoadingFallback" | "extendedMessagePayload"> & {
+            SuggestedReplies: ({ data, extendedMessagePayload, onClickSuggestedReply, onConfirmTicketClosure, suggestedRepliesDirection, }: IncomingMessageProps) => ReactNode;
+            MessageTemplate: (props: Pick<IncomingMessageProps, "extendedMessagePayload" | "onClickLink" | "onGetCachedMessageTemplate" | "onRequestMessageTemplate" | "onHandleTemplateInternalAction" | "messageTemplateErrorFallback" | "messageTemplateLoadingFallback"> & {
                 statsCallbacks?: Pick<IncomingMessageStatsCallbacks, "onMessageTemplateError">;
             }) => ReactNode;
             CustomMessageTemplate: (_: ({
@@ -3297,6 +3319,10 @@ export declare const IncomingMessageLayout: {
                 onClickSuggestedReply?: (params: {
                     reply: string;
                 }) => void;
+                onConfirmTicketClosure?: (params: {
+                    ticketId: number;
+                    confirmed: boolean;
+                }) => Promise<void>;
                 onClickCTA?: (params: {
                     url: string;
                 }) => void;
@@ -3376,6 +3402,10 @@ export declare const IncomingMessageLayout: {
                 onClickSuggestedReply?: (params: {
                     reply: string;
                 }) => void;
+                onConfirmTicketClosure?: (params: {
+                    ticketId: number;
+                    confirmed: boolean;
+                }) => Promise<void>;
                 onClickCTA?: (params: {
                     url: string;
                 }) => void;
@@ -3455,6 +3485,10 @@ export declare const IncomingMessageLayout: {
                 onClickSuggestedReply?: (params: {
                     reply: string;
                 }) => void;
+                onConfirmTicketClosure?: (params: {
+                    ticketId: number;
+                    confirmed: boolean;
+                }) => Promise<void>;
                 onClickCTA?: (params: {
                     url: string;
                 }) => void;
@@ -3530,6 +3564,10 @@ export declare const IncomingMessageLayout: {
                 onClickSuggestedReply?: (params: {
                     reply: string;
                 }) => void;
+                onConfirmTicketClosure?: (params: {
+                    ticketId: number;
+                    confirmed: boolean;
+                }) => Promise<void>;
                 onClickCTA?: (params: {
                     url: string;
                 }) => void;
@@ -3609,6 +3647,10 @@ export declare const IncomingMessageLayout: {
                 onClickSuggestedReply?: (params: {
                     reply: string;
                 }) => void;
+                onConfirmTicketClosure?: (params: {
+                    ticketId: number;
+                    confirmed: boolean;
+                }) => Promise<void>;
                 onClickCTA?: (params: {
                     url: string;
                 }) => void;
@@ -3688,6 +3730,10 @@ export declare const IncomingMessageLayout: {
                 onClickSuggestedReply?: (params: {
                     reply: string;
                 }) => void;
+                onConfirmTicketClosure?: (params: {
+                    ticketId: number;
+                    confirmed: boolean;
+                }) => Promise<void>;
                 onClickCTA?: (params: {
                     url: string;
                 }) => void;
@@ -3744,6 +3790,7 @@ export declare const IncomingMessageLayout: {
             }) => ReactNode;
             Feedback: ({ isBotMessage, isConversationClosed, isStreaming, isFeedbackEnabled, isFeedbackCommentEnabled, extendedMessagePayload, onFeedbackUpdate, }: IncomingMessageProps) => ReactNode;
             MessageLogs: (_: IncomingMessageProps) => ReactNode;
+            Prechecks: (_: IncomingMessageProps) => ReactNode;
         };
     };
     Template: ({ template, children }: {
@@ -3765,8 +3812,8 @@ export declare const IncomingMessageLayout: {
     bubbleBackgroundColor?: string;
     };
     }) => ReactNode;
-    SuggestedReplies: ({ extendedMessagePayload, onClickSuggestedReply, suggestedRepliesDirection, }: IncomingMessageProps) => ReactNode;
-    MessageTemplate: (props: Pick<IncomingMessageProps, "onClickLink" | "onGetCachedMessageTemplate" | "onRequestMessageTemplate" | "onHandleTemplateInternalAction" | "messageTemplateErrorFallback" | "messageTemplateLoadingFallback" | "extendedMessagePayload"> & {
+    SuggestedReplies: ({ data, extendedMessagePayload, onClickSuggestedReply, onConfirmTicketClosure, suggestedRepliesDirection, }: IncomingMessageProps) => ReactNode;
+    MessageTemplate: (props: Pick<IncomingMessageProps, "extendedMessagePayload" | "onClickLink" | "onGetCachedMessageTemplate" | "onRequestMessageTemplate" | "onHandleTemplateInternalAction" | "messageTemplateErrorFallback" | "messageTemplateLoadingFallback"> & {
     statsCallbacks?: Pick<IncomingMessageStatsCallbacks, "onMessageTemplateError">;
     }) => ReactNode;
     CustomMessageTemplate: (_: ({
@@ -3795,6 +3842,10 @@ export declare const IncomingMessageLayout: {
     onClickSuggestedReply?: (params: {
     reply: string;
     }) => void;
+    onConfirmTicketClosure?: (params: {
+    ticketId: number;
+    confirmed: boolean;
+    }) => Promise<void>;
     onClickCTA?: (params: {
     url: string;
     }) => void;
@@ -3874,6 +3925,10 @@ export declare const IncomingMessageLayout: {
     onClickSuggestedReply?: (params: {
     reply: string;
     }) => void;
+    onConfirmTicketClosure?: (params: {
+    ticketId: number;
+    confirmed: boolean;
+    }) => Promise<void>;
     onClickCTA?: (params: {
     url: string;
     }) => void;
@@ -3953,6 +4008,10 @@ export declare const IncomingMessageLayout: {
     onClickSuggestedReply?: (params: {
     reply: string;
     }) => void;
+    onConfirmTicketClosure?: (params: {
+    ticketId: number;
+    confirmed: boolean;
+    }) => Promise<void>;
     onClickCTA?: (params: {
     url: string;
     }) => void;
@@ -4028,6 +4087,10 @@ export declare const IncomingMessageLayout: {
     onClickSuggestedReply?: (params: {
     reply: string;
     }) => void;
+    onConfirmTicketClosure?: (params: {
+    ticketId: number;
+    confirmed: boolean;
+    }) => Promise<void>;
     onClickCTA?: (params: {
     url: string;
     }) => void;
@@ -4107,6 +4170,10 @@ export declare const IncomingMessageLayout: {
     onClickSuggestedReply?: (params: {
     reply: string;
     }) => void;
+    onConfirmTicketClosure?: (params: {
+    ticketId: number;
+    confirmed: boolean;
+    }) => Promise<void>;
     onClickCTA?: (params: {
     url: string;
     }) => void;
@@ -4186,6 +4253,10 @@ export declare const IncomingMessageLayout: {
     onClickSuggestedReply?: (params: {
     reply: string;
     }) => void;
+    onConfirmTicketClosure?: (params: {
+    ticketId: number;
+    confirmed: boolean;
+    }) => Promise<void>;
     onClickCTA?: (params: {
     url: string;
     }) => void;
@@ -4242,6 +4313,7 @@ export declare const IncomingMessageLayout: {
     }) => ReactNode;
     Feedback: ({ isBotMessage, isConversationClosed, isStreaming, isFeedbackEnabled, isFeedbackCommentEnabled, extendedMessagePayload, onFeedbackUpdate, }: IncomingMessageProps) => ReactNode;
     MessageLogs: (_: IncomingMessageProps) => ReactNode;
+    Prechecks: (_: IncomingMessageProps) => ReactNode;
     }>>;
     useContext: () => LayoutContextValue<IncomingMessageTemplateProps, {
     SenderName: ({ sender }: Pick<IncomingMessageProps, "sender">) => ReactNode;
@@ -4258,8 +4330,8 @@ export declare const IncomingMessageLayout: {
     bubbleBackgroundColor?: string;
     };
     }) => ReactNode;
-    SuggestedReplies: ({ extendedMessagePayload, onClickSuggestedReply, suggestedRepliesDirection, }: IncomingMessageProps) => ReactNode;
-    MessageTemplate: (props: Pick<IncomingMessageProps, "onClickLink" | "onGetCachedMessageTemplate" | "onRequestMessageTemplate" | "onHandleTemplateInternalAction" | "messageTemplateErrorFallback" | "messageTemplateLoadingFallback" | "extendedMessagePayload"> & {
+    SuggestedReplies: ({ data, extendedMessagePayload, onClickSuggestedReply, onConfirmTicketClosure, suggestedRepliesDirection, }: IncomingMessageProps) => ReactNode;
+    MessageTemplate: (props: Pick<IncomingMessageProps, "extendedMessagePayload" | "onClickLink" | "onGetCachedMessageTemplate" | "onRequestMessageTemplate" | "onHandleTemplateInternalAction" | "messageTemplateErrorFallback" | "messageTemplateLoadingFallback"> & {
     statsCallbacks?: Pick<IncomingMessageStatsCallbacks, "onMessageTemplateError">;
     }) => ReactNode;
     CustomMessageTemplate: (_: ({
@@ -4288,6 +4360,10 @@ export declare const IncomingMessageLayout: {
     onClickSuggestedReply?: (params: {
     reply: string;
     }) => void;
+    onConfirmTicketClosure?: (params: {
+    ticketId: number;
+    confirmed: boolean;
+    }) => Promise<void>;
     onClickCTA?: (params: {
     url: string;
     }) => void;
@@ -4367,6 +4443,10 @@ export declare const IncomingMessageLayout: {
     onClickSuggestedReply?: (params: {
     reply: string;
     }) => void;
+    onConfirmTicketClosure?: (params: {
+    ticketId: number;
+    confirmed: boolean;
+    }) => Promise<void>;
     onClickCTA?: (params: {
     url: string;
     }) => void;
@@ -4446,6 +4526,10 @@ export declare const IncomingMessageLayout: {
     onClickSuggestedReply?: (params: {
     reply: string;
     }) => void;
+    onConfirmTicketClosure?: (params: {
+    ticketId: number;
+    confirmed: boolean;
+    }) => Promise<void>;
     onClickCTA?: (params: {
     url: string;
     }) => void;
@@ -4521,6 +4605,10 @@ export declare const IncomingMessageLayout: {
     onClickSuggestedReply?: (params: {
     reply: string;
     }) => void;
+    onConfirmTicketClosure?: (params: {
+    ticketId: number;
+    confirmed: boolean;
+    }) => Promise<void>;
     onClickCTA?: (params: {
     url: string;
     }) => void;
@@ -4600,6 +4688,10 @@ export declare const IncomingMessageLayout: {
     onClickSuggestedReply?: (params: {
     reply: string;
     }) => void;
+    onConfirmTicketClosure?: (params: {
+    ticketId: number;
+    confirmed: boolean;
+    }) => Promise<void>;
     onClickCTA?: (params: {
     url: string;
     }) => void;
@@ -4679,6 +4771,10 @@ export declare const IncomingMessageLayout: {
     onClickSuggestedReply?: (params: {
     reply: string;
     }) => void;
+    onConfirmTicketClosure?: (params: {
+    ticketId: number;
+    confirmed: boolean;
+    }) => Promise<void>;
     onClickCTA?: (params: {
     url: string;
     }) => void;
@@ -4735,10 +4831,11 @@ export declare const IncomingMessageLayout: {
     }) => ReactNode;
     Feedback: ({ isBotMessage, isConversationClosed, isStreaming, isFeedbackEnabled, isFeedbackCommentEnabled, extendedMessagePayload, onFeedbackUpdate, }: IncomingMessageProps) => ReactNode;
     MessageLogs: (_: IncomingMessageProps) => ReactNode;
+    Prechecks: (_: IncomingMessageProps) => ReactNode;
     }>;
 } & {
     MessageTemplate: (props: {
-        component: (props: Pick<IncomingMessageProps, "onClickLink" | "onGetCachedMessageTemplate" | "onRequestMessageTemplate" | "onHandleTemplateInternalAction" | "messageTemplateErrorFallback" | "messageTemplateLoadingFallback" | "extendedMessagePayload"> & {
+        component: (props: Pick<IncomingMessageProps, "extendedMessagePayload" | "onClickLink" | "onGetCachedMessageTemplate" | "onRequestMessageTemplate" | "onHandleTemplateInternalAction" | "messageTemplateErrorFallback" | "messageTemplateLoadingFallback"> & {
             statsCallbacks?: Pick<IncomingMessageStatsCallbacks, "onMessageTemplateError">;
         }) => ReactNode;
     }) => null;
@@ -4775,7 +4872,7 @@ export declare const IncomingMessageLayout: {
         }) => ReactNode;
     }) => null;
     SuggestedReplies: (props: {
-        component: ({ extendedMessagePayload, onClickSuggestedReply, suggestedRepliesDirection, }: IncomingMessageProps) => ReactNode;
+        component: ({ data, extendedMessagePayload, onClickSuggestedReply, onConfirmTicketClosure, suggestedRepliesDirection, }: IncomingMessageProps) => ReactNode;
     }) => null;
     CustomMessageTemplate: (props: {
         component: (_: ({
@@ -4804,6 +4901,10 @@ export declare const IncomingMessageLayout: {
             onClickSuggestedReply?: (params: {
                 reply: string;
             }) => void;
+            onConfirmTicketClosure?: (params: {
+                ticketId: number;
+                confirmed: boolean;
+            }) => Promise<void>;
             onClickCTA?: (params: {
                 url: string;
             }) => void;
@@ -4883,6 +4984,10 @@ export declare const IncomingMessageLayout: {
             onClickSuggestedReply?: (params: {
                 reply: string;
             }) => void;
+            onConfirmTicketClosure?: (params: {
+                ticketId: number;
+                confirmed: boolean;
+            }) => Promise<void>;
             onClickCTA?: (params: {
                 url: string;
             }) => void;
@@ -4962,6 +5067,10 @@ export declare const IncomingMessageLayout: {
             onClickSuggestedReply?: (params: {
                 reply: string;
             }) => void;
+            onConfirmTicketClosure?: (params: {
+                ticketId: number;
+                confirmed: boolean;
+            }) => Promise<void>;
             onClickCTA?: (params: {
                 url: string;
             }) => void;
@@ -5039,6 +5148,10 @@ export declare const IncomingMessageLayout: {
             onClickSuggestedReply?: (params: {
                 reply: string;
             }) => void;
+            onConfirmTicketClosure?: (params: {
+                ticketId: number;
+                confirmed: boolean;
+            }) => Promise<void>;
             onClickCTA?: (params: {
                 url: string;
             }) => void;
@@ -5118,6 +5231,10 @@ export declare const IncomingMessageLayout: {
             onClickSuggestedReply?: (params: {
                 reply: string;
             }) => void;
+            onConfirmTicketClosure?: (params: {
+                ticketId: number;
+                confirmed: boolean;
+            }) => Promise<void>;
             onClickCTA?: (params: {
                 url: string;
             }) => void;
@@ -5197,6 +5314,10 @@ export declare const IncomingMessageLayout: {
             onClickSuggestedReply?: (params: {
                 reply: string;
             }) => void;
+            onConfirmTicketClosure?: (params: {
+                ticketId: number;
+                confirmed: boolean;
+            }) => Promise<void>;
             onClickCTA?: (params: {
                 url: string;
             }) => void;
@@ -5264,6 +5385,9 @@ export declare const IncomingMessageLayout: {
     MessageLogs: (props: {
         component: (_: IncomingMessageProps) => ReactNode;
     }) => null;
+    Prechecks: (props: {
+        component: (_: IncomingMessageProps) => ReactNode;
+    }) => null;
 };
 
 export declare type IncomingMessageProps<T extends IncomingMessageUnion['messageType'] = IncomingMessageUnion['messageType']> =
@@ -6235,6 +6359,10 @@ export declare type PositionHorizontal = 'start' | 'end';
 
 export declare type PositionVertical = 'top' | 'bottom';
 
+export declare interface PrecheckRecord {
+    key: string;
+}
+
 declare type PresentMethod = 'launcher_toggle' | 'direct_present' | 'embedded';
 
 declare type Props = {
@@ -7242,6 +7370,9 @@ export declare type StringSet = {
     A11Y_MEMORY_INDICATOR_MANAGE: string;
     A11Y_MEMORY_INDICATOR_ON: string;
     A11Y_MEMORY_INDICATOR_OFF: string;
+    DESK__TICKET_CLOSURE_CONFIRM: string;
+    DESK__TICKET_CLOSURE_DECLINE: string;
+    DESK__TICKET_CLOSURE_ERROR_MESSAGE: string;
     CONNECTION_DELAY__TITLE: string;
     CONNECTION_DELAY__DESCRIPTION: (formattedTime: string) => string;
     /** @deprecated Please use DATE_FORMAT__DATE_SHORT instead. **/