@sendbird/ai-agent-messenger-react 1.0.0-rc.0

package/dist/index.d.ts

@@ -0,0 +1,837 @@
+import { AIAgentModule } from '@sendbird/chat/aiAgent';
+import { ComponentType } from 'react';
+import { Context } from 'react';
+import { ConversationStatus } from '@sendbird/chat/aiAgent';
+import { format } from 'date-fns';
+import { GroupChannelModule } from '@sendbird/chat/groupChannel';
+import { JSX } from 'react/jsx-runtime';
+import { Locale } from 'date-fns';
+import { LogLevel as LogLevel_2 } from '@sendbird/chat';
+import { PropsWithChildren } from 'react';
+import { ReactNode } from 'react';
+import { SendbirdChatWith } from '@sendbird/chat';
+import { SessionHandler } from '@sendbird/chat';
+
+export declare interface ActionbookInfo {
+    key: string;
+    name: string;
+    step: string | null;
+}
+
+export declare interface AgentClientHandlers {
+    onRegisterDeauthenticateHandler?: (deauthenticate: () => void) => void;
+    onMessageSend?: (message: string) => void;
+    onFunctionCallDetailClick?: (func: FunctionCallsInfo) => void;
+}
+
+export declare interface AgentMessageTemplateInfo {
+    key: string;
+    message_template_key: 'text' | 'suggested_replies' | 'cta' | 'image' | 'carousel';
+    name: string;
+    request_context?: {
+        request: {
+            headers: Record<string, string>;
+            method: string;
+            query_params: Record<string, string>;
+            request_body: Record<string, string>;
+            url: string;
+        };
+        response?: {
+            content: string;
+            status: number;
+        };
+        error?: string;
+    };
+}
+
+export declare interface AgentPreviewConfigs {
+    welcomeMessages?: {
+        message: string;
+        suggestedReplies?: string[];
+    }[];
+    suggestedRepliesDirection?: 'horizontal' | 'vertical';
+    messageStackDirection?: 'top' | 'bottom';
+    appearance?: {
+        theme?: 'light' | 'dark';
+        primaryColor?: string;
+        botMessageBackgroundColor?: string;
+    };
+    bot?: {
+        profileUrl?: string;
+        nickname?: string;
+        specialNotice?: string;
+        specialNoticeEnabled?: boolean;
+    };
+    launcher?: {
+        type: LauncherImageType;
+        imageUrl: string;
+    };
+    forceCreateChannel?: boolean;
+    agentAttributes?: {
+        ai?: Record<string, unknown>;
+        safeguard?: Record<string, unknown>;
+    };
+}
+
+export declare function AgentProviderContainer({ rootElement, logLevel, language, userSessionInfo, children, ...props }: AIAgentProps): JSX.Element;
+
+export declare function AgentUIProviderContainer({ appearance, rootElement, logger, language, stringSet, children, messageTemplate, }: Props): JSX.Element;
+
+declare interface AIAgentContextValue {
+    appId: string;
+    aiAgentId: string;
+    chatSDK: SendbirdChatWith<[GroupChannelModule, AIAgentModule]>;
+
+    language: string;
+    countryCode?: string;
+    context?: Record<string, string>;
+
+    logger: Loggable;
+    dispatcher: Dispatcher;
+}
+
+declare interface AIAgentInfo {
+    userId: string;
+    nickname: string;
+    profileUrl: string;
+    replyToFile: boolean;
+    showHandoffButton: boolean;
+    specialNotice: string;
+    specialNoticeEnabled: boolean;
+}
+
+export declare type AIAgentProps = PropsWithChildren<{
+    appId: string;
+    aiAgentId: string;
+    customApiHost?: string;
+    customWebSocketHost?: string;
+    rootElement?: HTMLElement;
+    /**
+     * @public
+     * @description Custom state management for the ai agent client.
+     * */
+    state?: {
+        opened?: boolean;
+        setOpened?: (value: boolean) => void;
+        expanded?: boolean;
+        setExpanded?: (value: boolean) => void;
+    };
+    /**
+     * @public
+     * @description Custom User session information to be used in connecting to the agent.
+     * */
+    userSessionInfo?: UserSessionInfo;
+    /**
+     * @public
+     * @description Localization string set for the ai agent client.
+     * */
+    stringSet?: Partial<StringSet>;
+    /**
+     * @public
+     * @description dir of the widget.
+     * */
+    dir?: 'ltr' | 'rtl';
+    /**
+     * @public
+     * @description logLevel for the ai agent client.
+     * */
+    logLevel?: LogLevel_2;
+    /**
+     * @public
+     * @description Language for the ai agent client. Should follow the IETF BCP 47 format.
+     * For example, "ko-KR" for Korean in South Korea or "en-US" for English in the United States.
+     * */
+    language?: string;
+    /**
+     * @public
+     * @description Country code for the ai agent client. Should follow the ISO 3166 format.
+     * For example, "KR" for South Korea or "US" for the United States.
+     * */
+    countryCode?: string;
+    /**
+     * @public
+     * @description Context object for the AI agent client. This is injected when the messenger is first loaded and can provide additional context that may influence how the AI responds to user conversations.
+     * */
+    context?: Record<string, string>;
+    /**
+     * @internal
+     * @description Preview configurations for the ai agent client.
+     * */
+    agentPreviewConfigs?: AgentPreviewConfigs;
+    /**
+     * @internal
+     * @description Event handlers for the ai agent client.
+     */
+    handlers?: AgentClientHandlers;
+    /**
+     * @internal
+     * @description Whether to show the manual conversation close button in the header. (default: false)
+     */
+    enableCloseConversationButton?: boolean;
+    /**
+     * @internal
+     * @description Whether to show the expand button in the header. (default: true)
+     * */
+    enableExpandButton?: boolean;
+    /**
+     * @internal
+     * @description Whether to automatically disconnect the WebSocket when the user is inactive in launcher mode.
+     * Set to false to keep the connection alive even during inactivity. (default: true)
+     */
+    enableAutoDisconnectInLauncher?: boolean;
+    /**
+     * @internal
+     * @description Whether its for the dashboard actionbook tester or not.
+     * @note we're using this for the temporary usage for testing the dashboard actionbook tester.
+     * This will be removed in the future. DO NOT expose this flag to the public.
+     */
+    _UNSAFE_INTERNAL_isActionbookTester?: boolean;
+    /**
+     * @internal DO NOT USE THIS
+     * */
+    messageTemplate?: {
+        __internalVariables?: InternalMessageTemplateVariables;
+    };
+}>;
+
+declare abstract class BaseCommand {
+    abstract type: CommandType;
+    payload: any;
+
+    constructor(payload: any = {}) {
+        this.payload = payload;
+    }
+
+    toJSON(): string {
+        return JSON.stringify({ type: this.type, payload: this.payload });
+    }
+}
+
+declare type BaseMessageProps<T> = T & {
+    createdAt: number;
+    extendedMessagePayload?: Partial<ExtendedMessagePayload>;
+    groupType?: MessageGroupType;
+    maxBodyWidth?: number;
+    onClickMedia?: (params: {
+        url: string;
+        type: string;
+    }) => void;
+    children?: ReactNode;
+};
+
+declare interface CommandPayloads {
+    [CommandType.ConversationClose]: undefined;
+}
+
+export declare const Commands = {
+    CloseConversation: () => new CloseConversationCommand(),
+};
+
+declare enum CommandType {
+    ConversationClose = 'conv.close',
+}
+
+export declare const Conversation: ({ children, onNavigateToConversationList, closedChannelUrl, onClearClosedChannelUrl, }: Props_4) => JSX.Element;
+
+export declare const ConversationList: ({ children, onOpenConversationView }: Props_5) => JSX.Element;
+
+declare type CSATSubmitParams = {
+    csatType: string;
+    csat?: number;
+    csatReason?: string;
+    isResolved?: boolean;
+};
+
+export declare enum CSATType {
+    AI_AGENT_CSAT_5 = "AI_AGENT_CSAT_5",
+    AI_AGENT_CSAT_5_WITH_CRE = "AI_AGENT_CSAT_5_WITH_CRE"
+}
+
+declare const _default: {
+    language: string;
+    dateLocale: Locale;
+    stringSet: {
+        CHANNEL_FROZEN: string;
+        PLACE_HOLDER__WRONG: string;
+        PLACE_HOLDER__NO_MESSAGES: string;
+        UNKNOWN__UNKNOWN_MESSAGE_TYPE: string;
+        HEADER_BUTTON__AGENT_HANDOFF: string;
+        MESSAGE_INPUT__PLACE_HOLDER: string;
+        MESSAGE_INPUT__PLACE_HOLDER__WAIT_AI_AGENT_RESPONSE: string;
+        MESSAGE_INPUT__PLACE_HOLDER__DISABLED: string;
+        BUTTON__CANCEL: string;
+        BUTTON__SAVE: string;
+        BUTTON__OK: string;
+        NO_NAME: string;
+        RETRY: string;
+        DATE_FORMAT__MESSAGE_LIST__DATE_SEPARATOR: string;
+        DATE_FORMAT__MESSAGE_TIMESTAMP: string;
+        FILE_UPLOAD_NOTIFICATION__COUNT_LIMIT: string;
+        FILE_UPLOAD_NOTIFICATION__SIZE_LIMIT: string;
+        FILE_VIEWER__UNSUPPORT: string;
+        CSAT_TITLE_UNSUBMITTED: string;
+        CSAT_TITLE_SUBMITTED: string;
+        CSAT_CRE_TITLE: string;
+        CSAT_CRE_SOLVED: string;
+        CSAT_CRE_NOT_SOLVED: string;
+        CSAT_REASON_PLACEHOLDER: string;
+        CSAT_RATING_TITLE: string;
+        CSAT5_RATING_SCORE_1: string;
+        CSAT5_RATING_SCORE_2: string;
+        CSAT5_RATING_SCORE_3: string;
+        CSAT5_RATING_SCORE_4: string;
+        CSAT5_RATING_SCORE_5: string;
+        CSAT_SUBMIT_LABEL: string;
+        CSAT_SUBMISSION_EXPIRED: string;
+        POWERED_BY: string;
+        CONVERSATION_CLOSED_FOOTER_LABEL: string;
+        START_NEW_CONVERSATION: string;
+        RETURN_TO_CONVERSATION: string;
+        CONVERSATION_LIST__HEADER_TITLE: string;
+        CONVERSATION_LIST__TOPICS_FALLBACK: string;
+        CONVERSATION_LIST__NO_CONVERSATIONS: string;
+        DATE_FORMAT__CONVERSATION_LIST__LIST_ITEM_TITLE: string;
+        DATE_FORMAT__CONVERSATION_LIST__LIST_ITEM_TITLE_CAPTION: string;
+    };
+};
+
+export declare const DefaultMessenger: ({ children, ...props }: AIAgentProps) => JSX.Element;
+
+declare interface Dispatcher {
+    send(command: BaseCommand): Promise<void>;
+    subscribe<E extends CommandType>(eventType: E, callback: (payload: CommandPayloads[E]) => void | Promise<void>): void;
+    unsubscribe<E extends CommandType>(
+    eventType: E,
+    callback: (payload: CommandPayloads[E]) => void | Promise<void>,
+    ): void;
+}
+
+declare function ExtendedCTAButton({ extendedMessagePayload, onClickCTA, }: IncomingMessageProps): JSX.Element | null;
+
+/**
+ * This component is a placeholder for the ExtendedMessageLogs component.
+ * Because message logs are only visible in the action book tester.
+ * @see @contexts/_UNSAFE_INTERNAL_DashboardActionbookTesterContext.tsx
+ */
+declare function ExtendedMessageLogs(_: IncomingMessageProps): JSX.Element;
+
+/**
+ * For better understanding: https://sendbird.atlassian.net/wiki/spaces/AA/pages/3075014695/Extended+Message+Payload+Spec
+ */
+export declare interface ExtendedMessagePayload {
+    is_thinking: boolean;
+    cta_button: {
+        label: string;
+        url: string;
+    };
+    suggested_replies: string[];
+    message_template: MessageTemplateShape;
+    csat: {
+        type: CSATType;
+        visibility: boolean;
+    };
+    bot_message_type: 'generated' | 'canned' | 'thinking' | 'welcome' | 'resolution_feedback' | 'maintenance' | 'safeguard' | 'error';
+    groundedness: GroundednessInfo[];
+    manual: ActionbookInfo;
+    function_calls: FunctionCallsInfo[];
+    agent_message_templates: AgentMessageTemplateInfo[];
+}
+
+declare function ExtendedMessageTemplate(props: Props_3): JSX.Element;
+
+declare function ExtendedSuggestedReplies({ extendedMessagePayload, onClickSuggestedReply, suggestedRepliesDirection, }: IncomingMessageProps): JSX.Element | null;
+
+export declare const FixedMessenger: ({ children, ...props }: AIAgentProps) => JSX.Element;
+
+export declare interface FunctionCallsInfo {
+    key: string;
+    name: string;
+    request: {
+        method: string;
+        url: string;
+        headers: Record<string, string>;
+        query_params?: Record<string, any>;
+        request_body: Record<string, any>;
+    };
+    response: {
+        status_code: number;
+        response_text: string;
+    };
+}
+
+export declare interface GroundednessInfo {
+    id: number;
+    source_type: 'site' | 'file' | 'snippet' | 'sb_desk' | 'sb_salesforce' | 'sb_confluence' | 'sb_zendesk' | 'sb_sprinklr' | (string & {});
+    preview_title: string;
+}
+
+declare type IncomingBaseMessageProps<T> = T & BaseMessageProps<{
+    sender: {
+        nickname: string;
+        profileUrl?: string;
+    };
+    suggestedRepliesVisible?: boolean;
+    suggestedRepliesDirection?: 'vertical' | 'horizontal';
+    isBotMessage?: boolean;
+    onGetCachedMessageTemplate?: (templateKey: string) => string | null;
+    onRequestMessageTemplate?: (templateKey: string) => Promise<string>;
+    onClickSuggestedReply?: (params: {
+        reply: string;
+    }) => void;
+    onClickCTA?: (params: {
+        url: string;
+    }) => void;
+    messageTemplateErrorFallback?: ReactNode;
+    messageTemplateLoadingFallback?: ReactNode;
+}>;
+
+declare function IncomingMessageBody(props: IncomingMessageProps): JSX.Element;
+
+export declare const IncomingMessageLayout: {
+    (props: PropsWithChildren): ReactNode;
+    defaults: {
+        template: ComponentType<IncomingMessageProps>;
+        components: {
+            SenderName: typeof IncomingSenderName;
+            SenderAvatar: typeof IncomingSenderAvatar;
+            SentTime: typeof IncomingSentTime;
+            MessageBody: typeof IncomingMessageBody;
+            SuggestedReplies: typeof ExtendedSuggestedReplies;
+            MessageTemplate: typeof ExtendedMessageTemplate;
+            CTAButton: typeof ExtendedCTAButton;
+            MessageLogs: typeof ExtendedMessageLogs;
+        };
+    };
+    Template: ({ template, children }: {
+        template?: ComponentType<IncomingMessageProps> | undefined;
+        children?: ReactNode;
+    }) => JSX.Element;
+    Context: Context<LayoutContextValue<    {
+    SenderName: typeof IncomingSenderName;
+    SenderAvatar: typeof IncomingSenderAvatar;
+    SentTime: typeof IncomingSentTime;
+    MessageBody: typeof IncomingMessageBody;
+    SuggestedReplies: typeof ExtendedSuggestedReplies;
+    MessageTemplate: typeof ExtendedMessageTemplate;
+    CTAButton: typeof ExtendedCTAButton;
+    MessageLogs: typeof ExtendedMessageLogs;
+    }, IncomingMessageProps>>;
+    useContext: () => LayoutContextValue<    {
+    SenderName: typeof IncomingSenderName;
+    SenderAvatar: typeof IncomingSenderAvatar;
+    SentTime: typeof IncomingSentTime;
+    MessageBody: typeof IncomingMessageBody;
+    SuggestedReplies: typeof ExtendedSuggestedReplies;
+    MessageTemplate: typeof ExtendedMessageTemplate;
+    CTAButton: typeof ExtendedCTAButton;
+    MessageLogs: typeof ExtendedMessageLogs;
+    }, IncomingMessageProps>;
+} & {
+    MessageTemplate: (props: {
+        component: typeof ExtendedMessageTemplate;
+    }) => null;
+    SenderName: (props: {
+        component: typeof IncomingSenderName;
+    }) => null;
+    SenderAvatar: (props: {
+        component: typeof IncomingSenderAvatar;
+    }) => null;
+    SentTime: (props: {
+        component: typeof IncomingSentTime;
+    }) => null;
+    MessageBody: (props: {
+        component: typeof IncomingMessageBody;
+    }) => null;
+    SuggestedReplies: (props: {
+        component: typeof ExtendedSuggestedReplies;
+    }) => null;
+    CTAButton: (props: {
+        component: typeof ExtendedCTAButton;
+    }) => null;
+    MessageLogs: (props: {
+        component: typeof ExtendedMessageLogs;
+    }) => null;
+};
+
+export declare type IncomingMessageProps<T extends IncomingMessageUnion['messageType'] = IncomingMessageUnion['messageType']> = PickMessageProps<IncomingMessageUnion, T>;
+
+declare type IncomingMessageUnion = IncomingBaseMessageProps<{
+    messageType: 'user';
+    message: string;
+}> | IncomingBaseMessageProps<{
+    messageType: 'file';
+    message: string;
+    file: {
+        type: string;
+        url: string;
+        name: string;
+    };
+}>;
+
+declare function IncomingSenderAvatar({ sender, isBotMessage }: Pick<IncomingMessageProps, 'sender' | 'isBotMessage'>): JSX.Element;
+
+declare function IncomingSenderName({ sender }: Pick<IncomingMessageProps, 'sender'>): JSX.Element;
+
+declare function IncomingSentTime({ createdAt }: Pick<IncomingMessageProps, 'createdAt'>): JSX.Element;
+
+declare interface InternalMessageTemplateVariables {
+    carousel_padding_left?: number;
+    carousel_padding_right?: number;
+}
+
+declare interface LanguageSet {
+    language: string;
+    stringSet: StringSet;
+    dateLocale: Locale;
+}
+
+export declare function LauncherBase({ className, isOpened, onClick, type, imageUrl, dir, animated, backgroundColor, }: LauncherProps): JSX.Element;
+
+declare type LauncherImageType = 'default_icon' | 'custom_image';
+
+declare interface LauncherInfo {
+    type: LauncherImageType;
+    imageUrl: string;
+}
+
+declare type LauncherProps = {
+    className?: string;
+    isOpened: boolean;
+    onClick?: () => void;
+    type: LauncherImageType;
+    imageUrl: string;
+    backgroundColor: string;
+    animated?: boolean;
+    dir?: 'ltr' | 'rtl';
+};
+
+declare interface LayoutContextValue<Components extends Record<string, ComponentType<Props>>, Props> {
+    Template: ComponentType<Props>;
+    updateTemplate: (template: ComponentType<Props>) => void;
+    components: Components;
+    updateComponent: (key: keyof Components, component: Components[keyof Components]) => void;
+}
+
+declare interface LocalizationContextValue extends LanguageSet {
+    format: typeof format;
+}
+
+declare interface Loggable {
+    verbose(...args: any[]): void;
+    debug(...args: any[]): void;
+    info(...args: any[]): void;
+    warn(...args: any[]): void;
+    error(...args: any[]): void;
+}
+
+export declare enum LogLevel {
+    VERBOSE,
+    DEBUG,
+    INFO,
+    WARN,
+    ERROR,
+    NONE,
+}
+
+/**
+ * @description
+ * - single: The message is standalone (not grouped with adjacent messages).
+ * - top: The message is grouped and is the first (top) in that group.
+ * - middle: The message is grouped and sits between other messages in the group.
+ * - bottom: The message is grouped and is the last (bottom) in that group.
+ * */
+declare type MessageGroupType = 'single' | 'top' | 'bottom' | 'middle';
+
+export declare const MessageLogs: ({ actionbook, functionCalls, groundedness, agentMessageTemplates, onClickActionbook, onClickFunctionCall, onClickFunctionCallDetail, onClickGroundedness, onClickAgentMessageTemplate, bottomContent, renderCustomGroundednessIcon, style, }: Props_2) => JSX.Element;
+
+/**
+ * Information containing the key and variables of the message template to be rendered in the message
+ *  message.extended_message_payload.message_template
+ * */
+declare interface MessageTemplateShape extends MessageTemplateShapeAtom {
+    view_variables?: Record<string, MessageTemplateShapeAtom[]>;
+    fallback_message?: string;
+}
+
+declare interface MessageTemplateShapeAtom {
+    type?: 'default';
+    key: string;
+    variables?: Record<string, any>;
+}
+
+declare interface MessengerContextValue extends AIAgentContextValue {
+    rootElement: HTMLElement;
+    agentPreviewConfigs?: AgentPreviewConfigs;
+    handlers?: AgentClientHandlers;
+    state: {
+        opened: boolean;
+        setOpened: (value: boolean) => void;
+        expanded: boolean;
+        setExpanded: (value: boolean) => void;
+    };
+    dir?: 'ltr' | 'rtl';
+    enableCloseConversationButton: boolean;
+    enableExpandButton: boolean;
+    enableAutoDisconnectInLauncher: boolean;
+}
+
+declare class MessengerDispatcher implements Dispatcher {
+    private subscribers: { [E in CommandType]?: ((payload: CommandPayloads[E]) => void | Promise<void>)[] } = {};
+    constructor(private logger: Loggable) {}
+
+    async send(command: BaseCommand): Promise<void> {
+        const deferred = createDeferred<void>();
+
+        const callbacks = this.subscribers[command.type];
+        if (callbacks) {
+            this.logger.debug(`messenger.dispatcher: dispatching command: ${command.type}`, command.payload);
+
+            const callbackPromises = callbacks.map((callback) => callback(command.payload));
+            await Promise.all(callbackPromises).catch((error) => {
+                this.logger.error(`messenger.dispatcher: error in callback for command: ${command.type}`, error);
+            });
+        }
+
+        deferred.resolve();
+
+        return deferred.promise;
+    }
+
+    subscribe<E extends CommandType>(eventType: E, callback: (payload: CommandPayloads[E]) => void): void {
+        if (!this.subscribers[eventType]) {
+            this.subscribers[eventType] = [];
+        }
+        this.subscribers[eventType].push(callback);
+    }
+
+    unsubscribe<E extends CommandType>(eventType: E, callback: (payload: CommandPayloads[E]) => void): void {
+        if (!this.subscribers[eventType]) {
+            return;
+        }
+
+        this.subscribers[eventType] = this.subscribers[eventType].filter((cb) => cb !== callback);
+    }
+}
+
+export declare const messengerDispatcher: MessengerDispatcher;
+
+declare interface MessengerSessionContextValue {
+    activeChannel?: {
+        url: string;
+        status: ConversationStatus;
+    };
+    refreshActiveChannel: () => Promise<string>;
+    connectionError?: Error;
+    userSession: {
+        userId: string;
+        authToken: string;
+    };
+    aiAgentInfo: AIAgentInfo;
+    launcherInfo: LauncherInfo;
+}
+
+declare type OutgoingBaseMessageProps<T> = T & BaseMessageProps<{
+    sender: {
+        nickname: string;
+        profileUrl?: string;
+    };
+    sendingStatus: 'pending' | 'failed' | 'succeeded' | 'canceled' | 'scheduled';
+}>;
+
+declare function OutgoingMessageBody(props: OutgoingMessageProps): JSX.Element | null;
+
+export declare const OutgoingMessageLayout: {
+    (props: PropsWithChildren): ReactNode;
+    defaults: {
+        template: ComponentType<OutgoingMessageProps>;
+        components: {
+            SendingStatus: typeof OutgoingSendingStatus;
+            SentTime: typeof OutgoingSentTime;
+            MessageBody: typeof OutgoingMessageBody;
+        };
+    };
+    Template: ({ template, children }: {
+        template?: ComponentType<OutgoingMessageProps> | undefined;
+        children?: ReactNode;
+    }) => JSX.Element;
+    Context: Context<LayoutContextValue<    {
+    SendingStatus: typeof OutgoingSendingStatus;
+    SentTime: typeof OutgoingSentTime;
+    MessageBody: typeof OutgoingMessageBody;
+    }, OutgoingMessageProps>>;
+    useContext: () => LayoutContextValue<    {
+    SendingStatus: typeof OutgoingSendingStatus;
+    SentTime: typeof OutgoingSentTime;
+    MessageBody: typeof OutgoingMessageBody;
+    }, OutgoingMessageProps>;
+} & {
+    SentTime: (props: {
+        component: typeof OutgoingSentTime;
+    }) => null;
+    MessageBody: (props: {
+        component: typeof OutgoingMessageBody;
+    }) => null;
+    SendingStatus: (props: {
+        component: typeof OutgoingSendingStatus;
+    }) => null;
+};
+
+export declare type OutgoingMessageProps<T extends OutgoingMessageUnion['messageType'] = OutgoingMessageUnion['messageType']> = PickMessageProps<OutgoingMessageUnion, T>;
+
+declare type OutgoingMessageUnion = OutgoingBaseMessageProps<{
+    messageType: 'user';
+    message: string;
+}> | OutgoingBaseMessageProps<{
+    messageType: 'file';
+    message: string;
+    file: {
+        type: string;
+        url: string;
+        name: string;
+    };
+    metadata: {
+        aspectRatio: string;
+        localFile?: unknown;
+    };
+}>;
+
+declare function OutgoingSendingStatus({ sendingStatus }: OutgoingMessageProps): JSX.Element | null;
+
+declare function OutgoingSentTime({ createdAt }: OutgoingMessageProps): JSX.Element;
+
+declare type PickMessageProps<Union, T extends Union extends {
+    messageType: infer MT;
+} ? MT : never = Union extends {
+    messageType: infer MT;
+} ? MT : never> = Union extends {
+    messageType: T;
+} ? Union : never;
+
+declare type Props = {
+    children: ReactNode;
+    rootElement?: HTMLElement;
+    appearance?: AgentPreviewConfigs['appearance'];
+    logger?: Loggable;
+    stringSet?: Partial<StringSet>;
+    language?: string;
+    messageTemplate?: {
+        /** @internal DO NOT USE THIS **/
+        __internalVariables?: InternalMessageTemplateVariables;
+    };
+};
+
+declare type Props_2 = {
+    actionbook?: ActionbookInfo;
+    functionCalls?: FunctionCallsInfo[];
+    groundedness?: GroundednessInfo[];
+    agentMessageTemplates?: AgentMessageTemplateInfo[];
+    onClickActionbook?: (value: ActionbookInfo) => void;
+    onClickFunctionCall?: (value: FunctionCallsInfo) => void;
+    onClickFunctionCallDetail?: (value: FunctionCallsInfo) => void;
+    onClickGroundedness?: (value: GroundednessInfo) => void;
+    onClickAgentMessageTemplate?: (value: AgentMessageTemplateInfo) => void;
+    style?: {
+        iconColor?: string;
+        textColor?: string;
+        barColor?: string;
+        highlightColor?: string;
+    };
+    bottomContent?: ReactNode;
+    renderCustomGroundednessIcon?: (props: {
+        default: ReactNode;
+        sourceType: string;
+    }) => ReactNode;
+};
+
+declare type Props_3 = Pick<IncomingMessageProps, 'extendedMessagePayload' | 'onGetCachedMessageTemplate' | 'onRequestMessageTemplate' | 'messageTemplateErrorFallback' | 'messageTemplateLoadingFallback'>;
+
+declare type Props_4 = PropsWithChildren<{
+    closedChannelUrl?: string;
+    onClearClosedChannelUrl?: () => void;
+    onNavigateToConversationList?: () => void;
+}>;
+
+declare type Props_5 = PropsWithChildren<{
+    onOpenConversationView?: (channelUrl: string, status: ConversationStatus) => void;
+}>;
+
+declare type StringSet = Record<keyof StringSetKey, string>;
+
+declare type StringSetKey = typeof _default.stringSet;
+
+declare function SystemAdminMessage(props: SystemMessageProps): JSX.Element | null;
+
+declare type SystemBaseMessageProps<T> = T & BaseMessageProps<{}>;
+
+export declare const SystemMessageLayout: {
+    (props: PropsWithChildren): ReactNode;
+    defaults: {
+        template: ComponentType<SystemMessageProps>;
+        components: {
+            AdminMessage: typeof SystemAdminMessage;
+            CSATMessage: (props: SystemMessageProps) => JSX.Element | null;
+        };
+    };
+    Template: ({ template, children }: {
+        template?: ComponentType<SystemMessageProps> | undefined;
+        children?: ReactNode;
+    }) => JSX.Element;
+    Context: Context<LayoutContextValue<    {
+    AdminMessage: typeof SystemAdminMessage;
+    CSATMessage: (props: SystemMessageProps) => JSX.Element | null;
+    }, SystemMessageProps>>;
+    useContext: () => LayoutContextValue<    {
+    AdminMessage: typeof SystemAdminMessage;
+    CSATMessage: (props: SystemMessageProps) => JSX.Element | null;
+    }, SystemMessageProps>;
+} & {
+    AdminMessage: (props: {
+        component: typeof SystemAdminMessage;
+    }) => null;
+    CSATMessage: (props: {
+        component: (props: SystemMessageProps) => JSX.Element | null;
+    }) => null;
+};
+
+export declare type SystemMessageProps<T extends SystemMessageUnion['messageType'] = SystemMessageUnion['messageType']> = PickMessageProps<SystemMessageUnion, T>;
+
+declare type SystemMessageUnion = SystemBaseMessageProps<{
+    messageType: 'admin';
+    message: string;
+}> | SystemBaseMessageProps<{
+    messageType: 'admin.csat';
+    csat?: number;
+    csatReason?: string;
+    csatExpireAt?: number;
+    isResolvedWhenDeterminedByUser?: boolean;
+    onSubmitCSAT: (params: CSATSubmitParams) => void;
+}>;
+
+export declare const useLocalizationContext: {
+    (): LocalizationContextValue;
+    displayName: string;
+};
+
+export declare const useMessengerContext: {
+    (): MessengerContextValue;
+    displayName: string;
+};
+
+export declare const useMessengerSessionContext: {
+    (): MessengerSessionContextValue;
+    displayName: string;
+};
+
+declare interface UserSessionInfo {
+    userId: string;
+    authToken: string;
+    sessionHandler: SessionHandler;
+}
+
+export { }
+
+
+declare module 'styled-components' {
+    interface DefaultTheme extends AgentTheme {
+    }
+}