@sendbird/ai-agent-messenger-react 1.23.0 → 1.24.0

package/dist/index.d.ts

@@ -12,7 +12,6 @@ import { Conversation as Conversation_2 } from '@sendbird/chat/aiAgent';
 import { ConversationStatus } from '@sendbird/chat/aiAgent';
 import { CSSProperties } from 'react';
 import { DeskChannelFilter } from '@sendbird/chat/aiAgent';
-import { FC } from 'react';
 import { FileMessage } from '@sendbird/chat/message';
 import { FileMessageCreateParams } from '@sendbird/chat/message';
 import { format } from 'date-fns';
@@ -23,7 +22,6 @@ import { GroupChannelHandler } from '@sendbird/chat/groupChannel';
 import { GroupChannelListOrder } from '@sendbird/chat/groupChannel';
 import { GroupChannelModule } from '@sendbird/chat/groupChannel';
 import { JSX } from 'react/jsx-runtime';
-import { LazyExoticComponent } from 'react';
 import type { Locale } from 'date-fns';
 import { LogLevel as LogLevel_2 } from '@sendbird/chat';
 import { MultipleFilesMessage } from '@sendbird/chat/message';
@@ -36,7 +34,6 @@ import { SendbirdChatParams } from '@sendbird/chat';
 import { SendbirdChatWith } from '@sendbird/chat';
 import { SendbirdError } from '@sendbird/chat';
 import { SessionHandler } from '@sendbird/chat';
-import { SVGProps } from 'react';
 import { UIEvent as UIEvent_2 } from 'react';
 import { User } from '@sendbird/chat';
 import { UserMessage } from '@sendbird/chat/message';
@@ -203,6 +200,11 @@ userSessionInfo?: ManualSessionInfo | AnonymousSessionInfo | UserSessionInfo;
 stringSet?: Partial<StringSet>;
 /**
 * @public
+* @description Custom icon registry for the ai agent client.
+* */
+icons?: IconRegistry;
+/**
+* @public
 * @description dir of the widget.
 * */
 dir?: "ltr" | "rtl";
@@ -288,7 +290,7 @@ __internalVariables?: InternalMessageTemplateVariables;
 children?: ReactNode | undefined;
 } & RefAttributes<MessengerSessionRef>>;
 
-export declare function AgentUIProviderContainer({ appearance, rootElement, logger, language, languageCode, stringSet, children, messageTemplate, theme, }: Props): JSX.Element;
+export declare function AgentUIProviderContainer({ appearance, rootElement, logger, language, languageCode, stringSet, children, messageTemplate, icons, theme, }: Props): JSX.Element;
 
 declare abstract class AIAgentBaseStats {
     protected timers: Map<string, TimerData> = new Map();
@@ -383,6 +385,36 @@ declare interface AIAgentCache {
     messenger: MessengerSessionCache;
 }
 
+declare type AIAgentCommonIconName =
+| 'close'
+| 'send'
+| 'menu'
+| 'spinner'
+| 'chat'
+| 'message'
+| 'error'
+| 'refresh'
+| 'chevron-down'
+| 'done'
+| 'done-circle'
+| 'stop'
+| 'stop-circle'
+| 'user'
+| 'file-document'
+| 'agent'
+| 'radio-on'
+| 'radio-off'
+| 'source'
+| 'copy'
+| 'good'
+| 'bad'
+| 'good-filled'
+| 'bad-filled'
+| 'delight'
+| 'photo'
+| 'add'
+| 'document';
+
 export declare interface AIAgentConfig {
     conversation?: {
         /**
@@ -557,6 +589,22 @@ declare interface AIAgentGroupChannelFilter {
     copilotSupportChannelUrl?: string;
 }
 
+declare type AIAgentIconComponent = ComponentType<AIAgentIconComponentProps>;
+
+declare type AIAgentIconComponentProps = {
+    size?: number | string;
+    color?: string;
+    /**
+     * Metadata flag. When true, this icon is a direction-sensitive glyph and should be
+     * horizontally flipped by the implementation when rendered in an RTL layout.
+     * The value does not reflect the current layout direction — it only marks the icon
+     * as eligible for flipping.
+     */
+    flipInRtl?: boolean;
+};
+
+declare type AIAgentIconRegistry<T extends string = AIAgentCommonIconName> = Partial<Record<T, AIAgentIconComponent>>;
+
 declare interface AIAgentInfo {
     userId: string;
     nickname: string;
@@ -775,6 +823,11 @@ export declare type AIAgentProps = PropsWithChildren<{
      * @description Localization string set for the ai agent client.
      * */
     stringSet?: Partial<StringSet>;
+    /**
+     * @public
+     * @description Custom icon registry for the ai agent client.
+     * */
+    icons?: IconRegistry;
     /**
      * @public
      * @description dir of the widget.
@@ -2409,64 +2462,13 @@ export declare interface GroundednessInfo {
  */
 declare type HexColor = `#${string}`;
 
-/**
- * frequently used icons are imported statically, and others are imported dynamically.
- * */
-declare const icons: {
-    readonly close: FC<SVGProps<SVGElement>>;
-    readonly send: FC<SVGProps<SVGElement>>;
-    readonly menu: FC<SVGProps<SVGElement>>;
-    readonly expand: FC<SVGProps<SVGElement>>;
-    readonly collapse: FC<SVGProps<SVGElement>>;
-    readonly spinner: LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly chat: LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly message: LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly error: LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly info: LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly refresh: LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly 'chevron-down': LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly 'chevron-right': LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly done: LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly 'done-circle': LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly stop: LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly 'stop-circle': LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly user: LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly 'file-document': LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly download: LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly attach: LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly delete: LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly 'close-filled': LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly agent: LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly question: LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly actionbook: LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly function: LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly 'radio-on': LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly 'radio-off': LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly confluence: LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly zendesk: LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly salesforce: LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly sprinklr: LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly website: LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly snippet: LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly template: LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly source: LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly bot: LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly 'bot-filled': LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly copy: LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly show: LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly mute: LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly good: LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly bad: LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly 'good-filled': LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly 'bad-filled': LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly delight: LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly photo: LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly 'arrow-left': LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly add: LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-    readonly document: LazyExoticComponent<FC<SVGProps<SVGElement>>>;
-};
+export declare type IconComponent = AIAgentIconComponent;
+
+export declare type IconComponentProps = AIAgentIconComponentProps;
 
-declare type IconType = keyof typeof icons;
+export declare type IconRegistry = AIAgentIconRegistry<IconType>;
+
+export declare type IconType = AIAgentCommonIconName | ReactOnlyIconName;
 
 declare type IncomingBaseMessageProps<T> = T &
 BaseMessageProps<{
@@ -4193,6 +4195,7 @@ declare type Props = {
     language?: string;
     /** @internal DO NOT USE THIS **/
     languageCode?: string;
+    icons?: IconRegistry;
     theme?: {
         palette?: Partial<PaletteShape>;
         typography?: Partial<{
@@ -4252,6 +4255,8 @@ declare type Props_4 = PropsWithChildren<{
     style?: CSSProperties;
 }>;
 
+declare type ReactOnlyIconName = 'expand' | 'collapse' | 'chevron-right' | 'download' | 'attach' | 'close-filled' | 'actionbook' | 'function' | 'confluence' | 'zendesk' | 'salesforce' | 'sprinklr' | 'website' | 'snippet' | 'template' | 'show' | 'mute';
+
 declare type SBUFoundationProps<T = NonNullable<unknown>> = T & {
     className?: string;
     children?: ReactNode;