@sendbird/ai-agent-messenger-react 1.1.1 → 1.1.3

package/dist/es/{CSc2-BOs.js → DuIMnVIa.js}

@@ -1,6 +1,6 @@
 import * as t from "react";
 import n from "styled-components";
-import { P as a, I as l, a as c, c as s } from "./BovngiOZ.js";
+import { P as a, I as l, a as c, c as s } from "./DQVTDao9.js";
 const d = ({ label: r = "Something went wrong", action: e, ...o }) => /* @__PURE__ */ t.createElement(a, { icon: "error", label: r, ...o }, e && /* @__PURE__ */ t.createElement(i, { onClick: e.onClick, label: e.label ?? "Retry" })), i = ({ label: r, onClick: e }) => /* @__PURE__ */ t.createElement(m, { tabIndex: 0, onClick: e }, /* @__PURE__ */ t.createElement(l, { type: "refresh", size: 20 }), /* @__PURE__ */ t.createElement(c, { variant: "button", color: s.color.primary.main }, r)), m = n.button`all:unset;display:flex;cursor:pointer;gap:4px;align-items:center;justify-content:center;`;
 export {
   d as default

package/dist/es/{DeR_25I_.js → yjU33qf_.js}

@@ -1,5 +1,5 @@
 import * as o from "react";
-import { P as r } from "./BovngiOZ.js";
+import { P as r } from "./DQVTDao9.js";
 const c = ({ label: e = "No channels", ...a }) => /* @__PURE__ */ o.createElement(r, { icon: "chat", label: e, ...a });
 export {
   c as default

package/dist/index.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./cjs/4USOA6cB.cjs");require("react");exports.AgentProviderContainer=e.AgentProviderContainer;exports.AgentUIProviderContainer=e.AgentUIProviderContainer;exports.CSATType=e.CSATType;exports.Commands=e.Commands;exports.Conversation=e.Conversation;exports.ConversationLayout=e.ConversationLayout;exports.ConversationList=e.ConversationList;exports.ConversationListItemLayout=e.ConversationListItemLayout;exports.ConversationListLayout=e.ConversationListLayout;exports.DefaultMessenger=e.DefaultMessenger;exports.FixedMessenger=e.FixedMessenger;exports.IncomingMessageLayout=e.IncomingMessageLayout;exports.LauncherBase=e.LauncherBase;exports.LogLevel=e.LogLevel;exports.MessageLogs=e.MessageLogs;exports.OutgoingMessageLayout=e.OutgoingMessageLayout;exports.SystemMessageLayout=e.SystemMessageLayout;exports.messengerDispatcher=e.messengerDispatcher;exports.useLocalizationContext=e.useLocalizationContext;exports.useMessengerContext=e.useMessengerContext;exports.useMessengerSessionContext=e.useMessengerSessionContext;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./cjs/DWvpgvvZ.cjs");require("react");exports.AgentProviderContainer=e.AgentProviderContainer;exports.AgentUIProviderContainer=e.AgentUIProviderContainer;exports.CSATType=e.CSATType;exports.Commands=e.Commands;exports.Conversation=e.Conversation;exports.ConversationLayout=e.ConversationLayout;exports.ConversationList=e.ConversationList;exports.ConversationListItemLayout=e.ConversationListItemLayout;exports.ConversationListLayout=e.ConversationListLayout;exports.DefaultMessenger=e.DefaultMessenger;exports.FixedMessenger=e.FixedMessenger;exports.IncomingMessageLayout=e.IncomingMessageLayout;exports.LauncherBase=e.LauncherBase;exports.LogLevel=e.LogLevel;exports.MessageLogs=e.MessageLogs;exports.OutgoingMessageLayout=e.OutgoingMessageLayout;exports.SystemMessageLayout=e.SystemMessageLayout;exports.messengerDispatcher=e.messengerDispatcher;exports.useLocalizationContext=e.useLocalizationContext;exports.useMessengerContext=e.useMessengerContext;exports.useMessengerSessionContext=e.useMessengerSessionContext;

package/dist/index.d.ts

@@ -1,14 +1,20 @@
+import { Action } from '@sendbird/uikit-message-template';
+import { AIAgentChannelFilter } from '@sendbird/chat/aiAgent';
 import { AIAgentModule } from '@sendbird/chat/aiAgent';
 import { ComponentType } from 'react';
 import { Context } from 'react';
 import { ConversationStatus } from '@sendbird/chat/aiAgent';
+import { DeskChannelFilter } from '@sendbird/chat/aiAgent';
 import { format } from 'date-fns';
+import { ForwardRefExoticComponent } from 'react';
+import { GroupChannel } from '@sendbird/chat/groupChannel';
 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 { RefAttributes } from 'react';
 import { SendbirdChatWith } from '@sendbird/chat';
 import { SessionHandler } from '@sendbird/chat';
 
@@ -74,7 +80,111 @@ export declare interface AgentPreviewConfigs {
     };
 }
 
-export declare function AgentProviderContainer({ rootElement, logLevel, language, userSessionInfo, children, ...props }: AIAgentProps): JSX.Element;
+export declare const AgentProviderContainer: ForwardRefExoticComponent<    {
+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 AIAgent Messenger theme
+* */
+theme?: {
+palette?: Partial<PaletteShape>;
+typography?: Partial<{ [K in keyof TypographyShape]: Partial<TypographyShape[K]>; }>;
+};
+/**
+* @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 It's for the dashboard tester or not.
+* @note we're using this for the temporary usage for testing the dashboard tester.
+* This will be removed in the future. DO NOT expose this flag to the public.
+*/
+_UNSAFE_INTERNAL_dashboardTester?: {
+testerType: "default" | "actionbook";
+};
+/**
+* @internal DO NOT USE THIS
+* */
+messageTemplate?: {
+__internalVariables?: InternalMessageTemplateVariables;
+};
+} & {
+children?: ReactNode | undefined;
+} & RefAttributes<MessengerSessionRef>>;
 
 export declare function AgentUIProviderContainer({ appearance, rootElement, logger, language, stringSet, children, messageTemplate, theme, }: Props): JSX.Element;
 
@@ -91,6 +201,34 @@ declare interface AIAgentContextValue {
     dispatcher: Dispatcher;
 }
 
+declare interface AIAgentGroupChannelFilter {
+    /**
+     * The filter applied to AI agent channels.
+     * It determines whether to include or exclude AI agent channels in the query results.
+     */
+    aiAgentChannelFilter?: AIAgentChannelFilter;
+    /**
+     * The filter applied to AI agent conversation statuses.
+     * It allows filtering channels based on the status of their conversations.
+     */
+    aiAgentConversationStatusFilter?: ConversationStatus[];
+    /**
+     * The list of AI agent IDs to filter the channels.
+     * Only channels associated with these AI agents will be included in the results.
+     */
+    aiAgentIds?: string[];
+    /**
+     * The filter applied to Desk channels.
+     * It determines whether to include or exclude Desk channels in the query results.
+     */
+    deskChannelFilter?: DeskChannelFilter;
+    /**
+     * The list of pinned channel URLs.
+     * These channels are prioritized in the query results.
+     */
+    pinnedChannelUrls?: string[];
+}
+
 declare interface AIAgentInfo {
     userId: string;
     nickname: string;
@@ -192,11 +330,13 @@ export declare type AIAgentProps = PropsWithChildren<{
     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.
+     * @description Whether It's for the dashboard tester or not.
+     * @note we're using this for the temporary usage for testing the dashboard tester.
      * This will be removed in the future. DO NOT expose this flag to the public.
      */
-    _UNSAFE_INTERNAL_isActionbookTester?: boolean;
+    _UNSAFE_INTERNAL_dashboardTester?: {
+        testerType: 'default' | 'actionbook';
+    };
     /**
      * @internal DO NOT USE THIS
      * */
@@ -234,20 +374,37 @@ declare type BaseMessageProps<T> = T & {
     children?: ReactNode;
 };
 
+declare interface CloseConversationCommandParams {
+    channelUrl: string;
+}
+
 declare interface CommandPayloads {
-    [CommandType.ConversationClose]: undefined;
+    [CommandType.ConversationClose]: undefined | CloseConversationCommandParams;
 }
 
 export declare const Commands = {
-    CloseConversation: () => new CloseConversationCommand(),
+    CloseConversation: (params?: CloseConversationCommandParams) => new CloseConversationCommand(params),
 };
 
 declare enum CommandType {
     ConversationClose = 'conv.close',
 }
 
+declare interface ContextObject {
+    language?: string;
+    country?: string;
+    context: Record<string, string>;
+}
+
 export declare const Conversation: ({ children, onNavigateToConversationList, closedChannelUrl, onClearClosedChannelUrl, }: Props_4) => JSX.Element;
 
+declare interface ConversationCreateParams {
+    aiAgentId: string;
+    language?: string;
+    country?: string;
+    context?: Record<string, string>;
+}
+
 export declare const ConversationLayout: {
     (props: PropsWithChildren): ReactNode;
     defaults: {
@@ -284,7 +441,7 @@ export declare const ConversationLayout: {
     }) => null;
 };
 
-export declare const ConversationList: ({ children, onOpenConversationView }: Props_5) => JSX.Element;
+export declare const ConversationList: ({ conversationListFilter, children, onOpenConversationView }: Props_5) => JSX.Element;
 
 export declare const ConversationListItemLayout: {
     (props: PropsWithChildren): ReactNode;
@@ -301,6 +458,7 @@ export declare const ConversationListItemLayout: {
 } & {};
 
 export declare interface ConversationListItemProps {
+    channel: GroupChannel;
     channelUrl: string;
     title?: string;
     lastMessageTimestamp?: number;
@@ -403,7 +561,43 @@ declare const _default: {
     };
 };
 
-export declare const DefaultMessenger: ({ children, ...props }: AIAgentProps) => JSX.Element;
+export declare const DefaultMessenger: ForwardRefExoticComponent<    {
+appId: string;
+aiAgentId: string;
+customApiHost?: string;
+customWebSocketHost?: string;
+rootElement?: HTMLElement;
+state?: {
+opened?: boolean;
+setOpened?: (value: boolean) => void;
+expanded?: boolean;
+setExpanded?: (value: boolean) => void;
+};
+theme?: {
+palette?: Partial<PaletteShape>;
+typography?: Partial<{ [K in keyof TypographyShape]: Partial<TypographyShape[K]>; }>;
+};
+userSessionInfo?: UserSessionInfo;
+stringSet?: Partial<StringSet>;
+dir?: "ltr" | "rtl";
+logLevel?: LogLevel_2;
+language?: string;
+countryCode?: string;
+context?: Record<string, string>;
+agentPreviewConfigs?: AgentPreviewConfigs;
+handlers?: AgentClientHandlers;
+enableCloseConversationButton?: boolean;
+enableExpandButton?: boolean;
+enableAutoDisconnectInLauncher?: boolean;
+_UNSAFE_INTERNAL_dashboardTester?: {
+testerType: "default" | "actionbook";
+};
+messageTemplate?: {
+__internalVariables?: InternalMessageTemplateVariables;
+};
+} & {
+children?: ReactNode | undefined;
+} & RefAttributes<MessengerSessionRef>>;
 
 declare interface Dispatcher {
     send(command: BaseCommand): Promise<void>;
@@ -419,7 +613,7 @@ declare function ExtendedCTAButton({ extendedMessagePayload, onClickCTA, }: Inco
 /**
  * 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
+ * @see @contexts/_UNSAFE_INTERNAL_DashboardTesterContext.tsx
  */
 declare function ExtendedMessageLogs(_: IncomingMessageProps): JSX.Element;
 
@@ -449,7 +643,74 @@ 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 const FixedMessenger: ForwardRefExoticComponent<    {
+appId: string;
+aiAgentId: string;
+customApiHost?: string;
+customWebSocketHost?: string;
+rootElement?: HTMLElement;
+state?: {
+opened?: boolean;
+setOpened?: (value: boolean) => void;
+expanded?: boolean;
+setExpanded?: (value: boolean) => void;
+};
+theme?: {
+palette?: Partial<PaletteShape>;
+typography?: Partial<{ [K in keyof TypographyShape]: Partial<TypographyShape[K]>; }>;
+};
+userSessionInfo?: UserSessionInfo;
+stringSet?: Partial<StringSet>;
+dir?: "ltr" | "rtl";
+logLevel?: LogLevel_2;
+language?: string;
+countryCode?: string;
+context?: Record<string, string>;
+agentPreviewConfigs?: AgentPreviewConfigs;
+handlers?: AgentClientHandlers;
+enableCloseConversationButton?: boolean;
+enableExpandButton?: boolean;
+enableAutoDisconnectInLauncher?: boolean;
+_UNSAFE_INTERNAL_dashboardTester?: {
+testerType: "default" | "actionbook";
+};
+messageTemplate?: {
+__internalVariables?: InternalMessageTemplateVariables;
+};
+} & {
+children?: ReactNode | undefined;
+} & RefAttributes<MessengerSessionRef>> & {
+    Style: (props: FixedMessengerStyleProps) => null;
+};
+
+export declare type FixedMessengerMargin = {
+    top: number;
+    bottom: number;
+    start: number;
+    end: number;
+};
+
+export declare type FixedMessengerPosition = `${PositionHorizontal}-${PositionVertical}`;
+
+declare interface FixedMessengerStyleProps {
+    /**
+     * @description Defines the position of the fixed messenger launcher.
+     * @default 'end-bottom'
+     * */
+    position?: FixedMessengerPosition;
+    /**
+     * @description Defines the margin around the fixed messenger launcher.
+     * This can be used to adjust the spacing from the edges of the viewport.
+     * @default { top: 24, bottom: 24, start: 24, end: 24 }
+     * */
+    margin?: Partial<FixedMessengerMargin>;
+    /**
+     * @description Defines the size of the launcher in pixels.
+     * This is used to set the width and height of the launcher.
+     * @default 48
+     * */
+    launcherSize?: number;
+}
 
 export declare interface FunctionCallsInfo {
     key: string;
@@ -484,6 +745,7 @@ declare type IncomingBaseMessageProps<T> = T & BaseMessageProps<{
     isTyping?: boolean;
     onGetCachedMessageTemplate?: (templateKey: string) => string | null;
     onRequestMessageTemplate?: (templateKey: string) => Promise<string>;
+    onHandleTemplateInternalAction?: (action: Action) => void;
     onClickSuggestedReply?: (params: {
         reply: string;
     }) => void;
@@ -609,7 +871,7 @@ declare interface LanguageSet {
     dateLocale: Locale;
 }
 
-export declare function LauncherBase({ className, isOpened, onClick, type, imageUrl, dir, animated, backgroundColor, }: LauncherProps): JSX.Element;
+export declare function LauncherBase({ className, isOpened, onClick, type, imageUrl, dir, animated, backgroundColor, size, }: LauncherProps): JSX.Element;
 
 declare type LauncherImageType = 'default_icon' | 'custom_image';
 
@@ -627,6 +889,7 @@ declare type LauncherProps = {
     backgroundColor: string;
     animated?: boolean;
     dir?: 'ltr' | 'rtl';
+    size?: number;
 };
 
 declare interface LayoutContextValue<Components extends Record<string, ComponentType<Props>>, Props> {
@@ -749,6 +1012,7 @@ declare interface MessengerSessionContextValue {
         status: ConversationStatus;
     };
     refreshActiveChannel: () => Promise<string>;
+    createConversation: (params: ConversationCreateParams) => Promise<string>;
     connectionError?: Error;
     userSession: {
         userId: string;
@@ -758,6 +1022,12 @@ declare interface MessengerSessionContextValue {
     launcherInfo: LauncherInfo;
 }
 
+export declare interface MessengerSessionRef {
+    updateContext: (context: Record<string, string>) => Promise<ContextObject>;
+    patchContext: (context: Record<string, string>) => Promise<ContextObject>;
+    getContextObject: () => Promise<ContextObject>;
+}
+
 declare type OutgoingBaseMessageProps<T> = T & BaseMessageProps<{
     sender: {
         nickname: string;
@@ -878,6 +1148,10 @@ declare type PickMessageProps<Union, T extends Union extends {
     messageType: T;
 } ? Union : never;
 
+export declare type PositionHorizontal = 'start' | 'end';
+
+export declare type PositionVertical = 'top' | 'bottom';
+
 declare type Props = {
     children: ReactNode;
     rootElement?: HTMLElement;
@@ -921,7 +1195,7 @@ declare type Props_2 = {
     }) => ReactNode;
 };
 
-declare type Props_3 = Pick<IncomingMessageProps, 'extendedMessagePayload' | 'onGetCachedMessageTemplate' | 'onRequestMessageTemplate' | 'messageTemplateErrorFallback' | 'messageTemplateLoadingFallback'>;
+declare type Props_3 = Pick<IncomingMessageProps, 'extendedMessagePayload' | 'onGetCachedMessageTemplate' | 'onRequestMessageTemplate' | 'onHandleTemplateInternalAction' | 'messageTemplateErrorFallback' | 'messageTemplateLoadingFallback'>;
 
 declare type Props_4 = PropsWithChildren<{
     closedChannelUrl?: string;
@@ -930,6 +1204,7 @@ declare type Props_4 = PropsWithChildren<{
 }>;
 
 declare type Props_5 = PropsWithChildren<{
+    conversationListFilter?: Partial<AIAgentGroupChannelFilter>;
     onOpenConversationView?: (channelUrl: string, status: ConversationStatus) => void;
 }>;
 

package/dist/index.js

@@ -1,4 +1,4 @@
-import { b as o, d as n, i as t, C as i, k as r, l as g, n as L, j as u, o as C, D as m, F as M, h as v, g as y, p as d, M as p, O as x, S as c, m as l, f as S, u as f, e as h } from "./es/BovngiOZ.js";
+import { b as o, d as n, i as t, C as i, k as r, l as g, n as L, j as u, o as C, D as m, F as M, h as v, g as y, p as d, M as p, O as x, S as c, m as l, f as S, u as f, e as h } from "./es/DQVTDao9.js";
 import "react";
 export {
   o as AgentProviderContainer,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sendbird/ai-agent-messenger-react",
-  "version": "1.1.1",
+  "version": "1.1.3",
   "description": "Sendbird AI Agent Messenger for React",
   "type": "module",
   "main": "dist/index.js",
@@ -20,23 +20,23 @@
   "sideEffects": false,
   "dependencies": {
     "@emotion/is-prop-valid": "^1.3.1",
-    "@sendbird/react-uikit-message-template-view": "0.0.9",
-    "@sendbird/uikit-message-template": "0.0.9",
-    "@sendbird/uikit-tools": "0.0.9",
+    "@sendbird/react-uikit-message-template-view": "0.0.13",
+    "@sendbird/uikit-message-template": "0.0.13",
+    "@sendbird/uikit-tools": "0.0.13",
     "date-fns": "^4.1.0",
     "dompurify": "^3.2.4",
-    "markdown-to-jsx": "^7.7.2",
+    "markdown-to-jsx": "^7.7.12",
     "react-syntax-highlighter": "^15.6.1"
   },
   "peerDependencies": {
-    "@sendbird/chat": "^4.19.2",
+    "@sendbird/chat": "^4.19.5",
     "react": ">=18.0.0",
     "react-dom": ">=18.0.0",
     "styled-components": ">=5.0.0"
   },
   "devDependencies": {
     "@monaco-editor/react": "^4.7.0",
-    "@sendbird/chat": "^4.19.2",
+    "@sendbird/chat": "^4.19.5",
     "@types/react": "^19.0.2",
     "@types/react-dom": "^19.0.2",
     "@types/react-syntax-highlighter": "^15.5.13",
@@ -45,7 +45,7 @@
     "react-dom": "^19.0.0",
     "strip-json-comments": "^5.0.1",
     "styled-components": "^6.1.15",
-    "@sendbird/ai-agent-core": "1.1.0",
+    "@sendbird/ai-agent-core": "1.1.3",
     "@sendbird/vite-tools": "0.0.1"
   },
   "msw": {