@sendbird/ai-agent-messenger-react-native 1.4.0 → 1.5.0

package/dist/index.d.ts

@@ -33,6 +33,7 @@ import { SendbirdChatParams } from '@sendbird/chat';
 import { SendbirdChatWith } from '@sendbird/chat';
 import { SendbirdError } from '@sendbird/chat';
 import { SessionHandler } from '@sendbird/chat';
+import { StyleProp } from 'react-native';
 import { User } from '@sendbird/chat';
 import { UserMessage } from '@sendbird/chat/message';
 import { UserMessageCreateParams } from '@sendbird/chat/message';
@@ -45,6 +46,11 @@ declare interface ActionbookInfo {
     step: string | null;
 }
 
+declare interface ActiveChannelUpdatedParams {
+    channelUrl: string;
+    status: ConversationStatus;
+}
+
 declare interface AgentMessageTemplateInfo {
     key: string;
     message_template_key:
@@ -281,9 +287,19 @@ declare interface AIAgentMessengerSessionRef {
     chatSDK: AIAgentContextValue['chatSDK'];
     authenticate: () => Promise<MessengerSettingsResponse>;
     deauthenticate: () => Promise<void>;
-    updateContext: (context: Record<string, string>) => Promise<ContextObject>;
-    patchContext: (context: Record<string, string>) => Promise<ContextObject>;
     getContextObject: () => Promise<ContextObject>;
+    updateContext: {
+        /** Updates the context of the active conversation initialized at session start. */
+        (context: Record<string, string>): Promise<ContextObject>;
+        /** Updates the context of a specific conversation by aiAgentId and channelUrl. */
+        (aiAgentId: string, channelUrl: string, context: Record<string, string>): Promise<ContextObject>;
+    };
+    patchContext: {
+        /** Patches the context of the active conversation initialized at session start. */
+        (context: Record<string, string>): Promise<ContextObject>;
+        /** Patches the context of a specific conversation by aiAgentId and channelUrl. */
+        (aiAgentId: string, channelUrl: string, context: Record<string, string>): Promise<ContextObject>;
+    };
 }
 
 export declare const AIAgentProviderContainer: ForwardRefExoticComponent<    {
@@ -363,6 +379,13 @@ declare interface AIAgentQueryParams {
     conversationListParams?: ConversationListCollectionParams;
 }
 
+/**
+ * AI Agent session handler.
+ * */
+declare interface AIAgentSessionHandler extends SessionHandler {
+    onExternalAuthTokenExpired?: (data: ExternalAuthTokenExpiredData) => void;
+}
+
 /**
  * Common string set interface shared between react and react-native packages
  * These are the base strings that both packages use
@@ -522,12 +545,12 @@ export declare const BottomSheetLayout: {
         template?: ComponentType<BottomSheetTemplateProps> | undefined;
         children?: ReactNode;
     }) => JSX.Element;
-    Context: Context<LayoutContextValue<    {
+    Context: Context<LayoutContextValue<BottomSheetTemplateProps, {
     ActionItem: ({ icon, label, destructive, onPress, }: BottomSheetActionItemProps) => ReactNode;
-    }, BottomSheetTemplateProps>>;
-    useContext: () => LayoutContextValue<    {
+    }>>;
+    useContext: () => LayoutContextValue<BottomSheetTemplateProps, {
     ActionItem: ({ icon, label, destructive, onPress, }: BottomSheetActionItemProps) => ReactNode;
-    }, BottomSheetTemplateProps>;
+    }>;
 } & {
     ActionItem: (props: {
         component: ({ icon, label, destructive, onPress, }: BottomSheetActionItemProps) => ReactNode;
@@ -557,10 +580,14 @@ declare interface CloseConversationCommandParams {
 
 declare interface CommandPayloads {
     [CommandType.ConversationClose]: undefined | CloseConversationCommandParams;
+    [CommandType.MessengerSettingsUpdated]: MessengerSettingsUpdatedParams;
+    [CommandType.ActiveChannelUpdated]: ActiveChannelUpdatedParams;
 }
 
 declare enum CommandType {
     ConversationClose = 'conv.close',
+    MessengerSettingsUpdated = 'messenger.settings.updated',
+    ActiveChannelUpdated = 'active.channel.updated',
 }
 
 declare type CommunityDocumentPickerModule = typeof CommunityDocumentPicker;
@@ -619,7 +646,7 @@ export declare const ConversationHeaderLayout: {
         template?: ComponentType<ConversationHeaderTemplateProps> | undefined;
         children?: ReactNode;
     }) => JSX.Element;
-    Context: Context<LayoutContextValue<    {
+    Context: Context<LayoutContextValue<ConversationHeaderTemplateProps, {
     StartArea: () => ReactNode;
     TitleArea: () => ReactNode;
     EndArea: () => ReactNode;
@@ -627,8 +654,8 @@ export declare const ConversationHeaderLayout: {
     Title: () => ReactNode;
     HandoffButton: () => ReactNode;
     CloseButton: () => ReactNode;
-    }, ConversationHeaderTemplateProps>>;
-    useContext: () => LayoutContextValue<    {
+    }>>;
+    useContext: () => LayoutContextValue<ConversationHeaderTemplateProps, {
     StartArea: () => ReactNode;
     TitleArea: () => ReactNode;
     EndArea: () => ReactNode;
@@ -636,7 +663,7 @@ export declare const ConversationHeaderLayout: {
     Title: () => ReactNode;
     HandoffButton: () => ReactNode;
     CloseButton: () => ReactNode;
-    }, ConversationHeaderTemplateProps>;
+    }>;
 } & {
     StartArea: (props: {
         component: () => ReactNode;
@@ -681,20 +708,20 @@ export declare const ConversationLayout: {
         template?: ComponentType<    {}> | undefined;
         children?: ReactNode;
     }) => JSX.Element;
-    Context: Context<LayoutContextValue<    {
+    Context: Context<LayoutContextValue<    {}, {
     Header: () => ReactNode;
     Body: ({ messageStackDirection, }: {
     messageStackDirection?: "top" | "bottom";
     }) => ReactNode;
     Footer: () => ReactNode;
-    }, {}>>;
-    useContext: () => LayoutContextValue<    {
+    }>>;
+    useContext: () => LayoutContextValue<    {}, {
     Header: () => ReactNode;
     Body: ({ messageStackDirection, }: {
     messageStackDirection?: "top" | "bottom";
     }) => ReactNode;
     Footer: () => ReactNode;
-    }, {}>;
+    }>;
 } & {
     Header: (props: {
         component: () => ReactNode;
@@ -753,20 +780,20 @@ export declare const ConversationListHeaderLayout: {
         template?: ComponentType<ConversationListHeaderTemplateProps> | undefined;
         children?: ReactNode;
     }) => JSX.Element;
-    Context: Context<LayoutContextValue<    {
+    Context: Context<LayoutContextValue<ConversationListHeaderTemplateProps, {
     StartArea: () => ReactNode;
     TitleArea: () => ReactNode;
     EndArea: () => ReactNode;
     Title: () => ReactNode;
     CloseButton: () => ReactNode;
-    }, ConversationListHeaderTemplateProps>>;
-    useContext: () => LayoutContextValue<    {
+    }>>;
+    useContext: () => LayoutContextValue<ConversationListHeaderTemplateProps, {
     StartArea: () => ReactNode;
     TitleArea: () => ReactNode;
     EndArea: () => ReactNode;
     Title: () => ReactNode;
     CloseButton: () => ReactNode;
-    }, ConversationListHeaderTemplateProps>;
+    }>;
 } & {
     StartArea: (props: {
         component: () => ReactNode;
@@ -803,16 +830,16 @@ export declare const ConversationListLayout: {
         template?: ComponentType<unknown> | undefined;
         children?: ReactNode;
     }) => JSX.Element;
-    Context: Context<LayoutContextValue<    {
+    Context: Context<LayoutContextValue<unknown, {
     Header: () => ReactNode;
     Body: () => ReactNode;
     Footer: () => ReactNode;
-    }, unknown>>;
-    useContext: () => LayoutContextValue<    {
+    }>>;
+    useContext: () => LayoutContextValue<unknown, {
     Header: () => ReactNode;
     Body: () => ReactNode;
     Footer: () => ReactNode;
-    }, unknown>;
+    }>;
 } & {
     Header: (props: {
         component: () => ReactNode;
@@ -905,6 +932,10 @@ export declare interface CustomMessageTemplateData {
     error: string | null;
 }
 
+export declare interface DateSeparatorProps extends ViewProps {
+    date?: Date | number;
+}
+
 declare interface Dispatcher {
     send(command: BaseCommand): Promise<void>;
     subscribe<E extends CommandType>(eventType: E, callback: (payload: CommandPayloads[E]) => void | Promise<void>): void;
@@ -1000,6 +1031,11 @@ export declare interface ExtendedMessagePayload {
     agent_message_templates: AgentMessageTemplateInfo[];
 }
 
+declare type ExternalAuthTokenExpiredData = {
+    channelUrl: string;
+    aiAgentId: string;
+};
+
 declare interface FeedbackInfo {
     rating: 'good' | 'bad';
     comment?: string;
@@ -1380,7 +1416,7 @@ export declare const IncomingMessageLayout: {
         template?: ComponentType<IncomingMessageProps> | undefined;
         children?: ReactNode;
     }) => JSX.Element;
-    Context: Context<LayoutContextValue<    {
+    Context: Context<LayoutContextValue<IncomingMessageProps, {
     SenderName: ({ sender }: Pick<IncomingMessageProps, "sender">) => JSX.Element;
     SenderAvatar: ({ sender, isBotMessage, }: Pick<IncomingMessageProps, "sender" | "isBotMessage">) => JSX.Element;
     SentTime: ({ createdAt, containerStyle }: IncomingMessageProps & {
@@ -1535,8 +1571,8 @@ export declare const IncomingMessageLayout: {
     Feedback: ({ isBotMessage, isConversationClosed, isStreaming, isFeedbackEnabled, isFeedbackCommentEnabled, extendedMessagePayload, onFeedbackUpdate, containerStyle, }: IncomingMessageProps & {
     containerStyle?: ViewStyle;
     }) => ReactNode;
-    }, IncomingMessageProps>>;
-    useContext: () => LayoutContextValue<    {
+    }>>;
+    useContext: () => LayoutContextValue<IncomingMessageProps, {
     SenderName: ({ sender }: Pick<IncomingMessageProps, "sender">) => JSX.Element;
     SenderAvatar: ({ sender, isBotMessage, }: Pick<IncomingMessageProps, "sender" | "isBotMessage">) => JSX.Element;
     SentTime: ({ createdAt, containerStyle }: IncomingMessageProps & {
@@ -1691,7 +1727,7 @@ export declare const IncomingMessageLayout: {
     Feedback: ({ isBotMessage, isConversationClosed, isStreaming, isFeedbackEnabled, isFeedbackCommentEnabled, extendedMessagePayload, onFeedbackUpdate, containerStyle, }: IncomingMessageProps & {
     containerStyle?: ViewStyle;
     }) => ReactNode;
-    }, IncomingMessageProps>;
+    }>;
 } & {
     SenderName: (props: {
         component: ({ sender }: Pick<IncomingMessageProps, "sender">) => JSX.Element;
@@ -1917,11 +1953,11 @@ declare interface LauncherInfo {
     imageUrl: string;
 }
 
-declare interface LayoutContextValue<Components extends Record<string, ComponentType<Props>>, Props> {
+declare interface LayoutContextValue<Props, Components extends Record<string, ComponentType<any>>> {
     Template: ComponentType<Props>;
     updateTemplate: (template: ComponentType<Props>) => void;
     components: Components;
-    updateComponent: (key: keyof Components, component: Components[keyof Components]) => void;
+    updateComponent: <K extends keyof Components>(key: K, component: Components[K]) => void;
 }
 
 declare interface Loggable {
@@ -1937,7 +1973,7 @@ declare type MaintainVisibleContentPosition = FlatListProps<any>['maintainVisibl
 export declare class ManualSessionInfo {
     userId: string;
     authToken: string;
-    sessionHandler: SessionHandler;
+    sessionHandler: AIAgentSessionHandler;
 
     constructor({ userId, authToken, sessionHandler }: ManualSessionInfoParams) {
         this.userId = userId;
@@ -1949,7 +1985,7 @@ export declare class ManualSessionInfo {
 declare interface ManualSessionInfoParams {
     userId: string;
     authToken: string;
-    sessionHandler: SessionHandler;
+    sessionHandler: AIAgentSessionHandler;
 }
 
 /** File metadata returned from picker methods */
@@ -1971,6 +2007,36 @@ declare interface MediaFile {
  * */
 declare type MessageGroupType = 'single' | 'top' | 'bottom' | 'middle';
 
+export declare const MessageListUILayout: {
+    (props: PropsWithChildren): ReactNode;
+    defaults: {
+        template: ComponentType<unknown>;
+        components: {
+            DateSeparator: ({ date, style, ...props }: DateSeparatorProps) => ReactNode;
+            ScrollToBottomButton: ({ style, onPress }: ScrollToBottomButtonProps) => JSX.Element;
+        };
+    };
+    Template: ({ template, children }: {
+        template?: ComponentType<unknown> | undefined;
+        children?: ReactNode;
+    }) => JSX.Element;
+    Context: Context<LayoutContextValue<unknown, {
+    DateSeparator: ({ date, style, ...props }: DateSeparatorProps) => ReactNode;
+    ScrollToBottomButton: ({ style, onPress }: ScrollToBottomButtonProps) => JSX.Element;
+    }>>;
+    useContext: () => LayoutContextValue<unknown, {
+    DateSeparator: ({ date, style, ...props }: DateSeparatorProps) => ReactNode;
+    ScrollToBottomButton: ({ style, onPress }: ScrollToBottomButtonProps) => JSX.Element;
+    }>;
+} & {
+    DateSeparator: (props: {
+        component: ({ date, style, ...props }: DateSeparatorProps) => ReactNode;
+    }) => null;
+    ScrollToBottomButton: (props: {
+        component: ({ style, onPress }: ScrollToBottomButtonProps) => JSX.Element;
+    }) => null;
+};
+
 declare interface MessageTemplateCache {
     set(key: string, value: string): void;
     get(key: string): string | null;
@@ -2061,6 +2127,11 @@ declare interface MessengerSettingsResponse {
     };
 }
 
+declare interface MessengerSettingsUpdatedParams {
+    settings: MessengerSettingsResponse;
+    source: 'cache' | 'server';
+}
+
 declare type MMKVModule = MMKV;
 
 declare interface ModalContextProps {
@@ -2195,7 +2266,7 @@ export declare const OutgoingMessageLayout: {
         template?: ComponentType<OutgoingMessageProps> | undefined;
         children?: ReactNode;
     }) => JSX.Element;
-    Context: Context<LayoutContextValue<    {
+    Context: Context<LayoutContextValue<OutgoingMessageProps, {
     SendingStatus: ({ sendingStatus, containerStyle }: OutgoingMessageProps<"file" | "user"> & {
     containerStyle?: ViewStyle;
     }) => ReactNode;
@@ -2203,8 +2274,8 @@ export declare const OutgoingMessageLayout: {
     containerStyle?: ViewStyle;
     }) => ReactNode;
     MessageBody: (props: OutgoingMessageBodyProps) => ReactNode;
-    }, OutgoingMessageProps>>;
-    useContext: () => LayoutContextValue<    {
+    }>>;
+    useContext: () => LayoutContextValue<OutgoingMessageProps, {
     SendingStatus: ({ sendingStatus, containerStyle }: OutgoingMessageProps<"file" | "user"> & {
     containerStyle?: ViewStyle;
     }) => ReactNode;
@@ -2212,7 +2283,7 @@ export declare const OutgoingMessageLayout: {
     containerStyle?: ViewStyle;
     }) => ReactNode;
     MessageBody: (props: OutgoingMessageBodyProps) => ReactNode;
-    }, OutgoingMessageProps>;
+    }>;
 } & {
     SentTime: (props: {
         component: ({ createdAt, containerStyle }: OutgoingMessageProps<"file" | "user"> & {
@@ -2300,13 +2371,90 @@ Union,
 T extends Union extends { messageType: infer MT } ? MT : never = Union extends { messageType: infer MT } ? MT : never,
 > = Union extends { messageType: T } ? Union : never;
 
+export declare interface PlaceholderBaseProps extends PlaceholderCommonProps {
+    icon?: IconType;
+    label?: string;
+}
+
+declare interface PlaceholderCommonProps {
+    style?: ViewStyle;
+    iconSize?: number;
+    children?: ReactNode;
+}
+
+export declare interface PlaceholderErrorProps extends PlaceholderBaseProps {
+    action?: {
+        label?: string;
+        onPress: () => void;
+    };
+}
+
+export declare const PlaceholderLayout: {
+    (props: PropsWithChildren): ReactNode;
+    defaults: {
+        template: ComponentType<PlaceholderTemplateProps>;
+        components: {
+            Loading: ({ iconSize, style }: PlaceholderLoadingProps) => ReactNode;
+            Error: ({ label, icon, action, ...props }: PlaceholderErrorProps) => ReactNode;
+            NoChannels: ({ label, icon, ...props }: PlaceholderBaseProps) => ReactNode;
+            NoMessages: ({ label, icon, ...props }: PlaceholderBaseProps) => ReactNode;
+        };
+    };
+    Template: ({ template, children }: {
+        template?: ComponentType<PlaceholderTemplateProps> | undefined;
+        children?: ReactNode;
+    }) => JSX.Element;
+    Context: Context<LayoutContextValue<PlaceholderTemplateProps, {
+    Loading: ({ iconSize, style }: PlaceholderLoadingProps) => ReactNode;
+    Error: ({ label, icon, action, ...props }: PlaceholderErrorProps) => ReactNode;
+    NoChannels: ({ label, icon, ...props }: PlaceholderBaseProps) => ReactNode;
+    NoMessages: ({ label, icon, ...props }: PlaceholderBaseProps) => ReactNode;
+    }>>;
+    useContext: () => LayoutContextValue<PlaceholderTemplateProps, {
+    Loading: ({ iconSize, style }: PlaceholderLoadingProps) => ReactNode;
+    Error: ({ label, icon, action, ...props }: PlaceholderErrorProps) => ReactNode;
+    NoChannels: ({ label, icon, ...props }: PlaceholderBaseProps) => ReactNode;
+    NoMessages: ({ label, icon, ...props }: PlaceholderBaseProps) => ReactNode;
+    }>;
+} & {
+    Loading: (props: {
+        component: ({ iconSize, style }: PlaceholderLoadingProps) => ReactNode;
+    }) => null;
+    Error: (props: {
+        component: ({ label, icon, action, ...props }: PlaceholderErrorProps) => ReactNode;
+    }) => null;
+    NoChannels: (props: {
+        component: ({ label, icon, ...props }: PlaceholderBaseProps) => ReactNode;
+    }) => null;
+    NoMessages: (props: {
+        component: ({ label, icon, ...props }: PlaceholderBaseProps) => ReactNode;
+    }) => null;
+};
+
+export declare interface PlaceholderLoadingProps extends PlaceholderCommonProps {
+}
+
+export declare type PlaceholderTemplateProps = ({
+    type: 'loading';
+} & PlaceholderLoadingProps) | ({
+    type: 'error';
+} & PlaceholderErrorProps) | ({
+    type: 'noChannels' | 'noMessages';
+} & PlaceholderBaseProps);
+
 declare type PositionHorizontal = 'start' | 'end';
 
 declare type PositionVertical = 'top' | 'bottom';
 
 declare type RNPermissionsModule = typeof RNPermissions;
 
+export declare type ScrollToBottomButtonProps = {
+    style?: StyleProp<ViewStyle>;
+    onPress: () => void;
+};
+
 declare interface SearchConversationParams {
+    aiAgentId: string;
     context: Record<string, string>;
 }
 
@@ -2359,14 +2507,14 @@ export declare const SystemMessageLayout: {
         template?: ComponentType<SystemMessageProps> | undefined;
         children?: ReactNode;
     }) => JSX.Element;
-    Context: Context<LayoutContextValue<    {
+    Context: Context<LayoutContextValue<SystemMessageProps, {
     AdminMessage: (props: SystemMessageProps) => JSX.Element | null;
     CSATMessage: (props: SystemMessageProps) => JSX.Element | null;
-    }, SystemMessageProps>>;
-    useContext: () => LayoutContextValue<    {
+    }>>;
+    useContext: () => LayoutContextValue<SystemMessageProps, {
     AdminMessage: (props: SystemMessageProps) => JSX.Element | null;
     CSATMessage: (props: SystemMessageProps) => JSX.Element | null;
-    }, SystemMessageProps>;
+    }>;
 } & {
     AdminMessage: (props: {
         component: (props: SystemMessageProps) => JSX.Element | null;
@@ -2467,7 +2615,7 @@ declare type UserSession = {
 declare interface UserSessionInfo {
     userId: string;
     authToken: string;
-    sessionHandler: SessionHandler;
+    sessionHandler: AIAgentSessionHandler;
 }
 
 export { }