@botpress/webchat 3.2.0 → 3.2.4

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @botpress/webchat@3.2.0 build /home/runner/work/genisys/genisys/packages/webchat-components
+> @botpress/webchat@3.2.4 build /home/runner/work/genisys/genisys/packages/webchat-components
 > vite build
 
 vite v5.4.8 building for production...
@@ -9,13 +9,13 @@ rendering chunks...
 
 [vite:dts] Start generate declaration files...
 computing gzip size...
-dist/style.css   47.29 kB │ gzip:   8.69 kB
-dist/index.js   771.34 kB │ gzip: 212.14 kB
+dist/style.css   47.53 kB │ gzip:   8.72 kB
+dist/index.js   776.04 kB │ gzip: 213.46 kB
 [vite:dts] Start rollup declaration files...
 Analysis will use the bundled TypeScript version 5.4.2
 *** The target project appears to use TypeScript 5.6.2 which is newer than the bundled compiler engine; consider upgrading API Extractor.
-[vite:dts] Declaration files built in 21868ms.
+[vite:dts] Declaration files built in 20058ms.
 
-dist/style.css       47.29 kB │ gzip:   8.69 kB
-dist/index.umd.cjs  516.29 kB │ gzip: 173.38 kB
-✓ built in 29.78s
+dist/style.css       47.53 kB │ gzip:   8.72 kB
+dist/index.umd.cjs  519.33 kB │ gzip: 174.43 kB
+✓ built in 26.42s

package/dist/index.d.ts

@@ -128,7 +128,7 @@ export declare type CarouselBlock = {
     blocks: GenericBlock[];
 };
 
-export declare const Chat: ({ connected, configuration, isTyping, messages, user, isLoading, renderers, isReadOnly, disableComposer, allowFileUpload, error, participants, closeWindow, sendMessage, uploadFile, addMessageFeedback, restartConversation, ...props }: Props) => JSX_3.Element;
+export declare const Chat: ({ connected, configuration, isTyping, messages, user, isLoading, renderers, isReadOnly, disableComposer, allowFileUpload, error, participants, closeWindow, sendMessage, uploadFile, addMessageFeedback, triggerNetworkError, restartConversation, storageKey, ...props }: Props) => JSX_3.Element;
 
 export declare type ColumnBlock = {
     type: 'column';
@@ -165,7 +165,7 @@ export declare const CONFIG_ACCESS_DENIED = "Access denied to configuration file
 export { Configuration }
 
 export declare const Container: {
-    ({ children, className, connected, uploadFile, allowFileUpload, ...props }: Props_4): JSX_3.Element;
+    ({ children, className, connected, uploadFile, allowFileUpload, storageKey, ...props }: Props_4): JSX_3.Element;
     displayName: string;
 };
 
@@ -211,9 +211,10 @@ export declare function enrichMessage(messages: BlockMessage[], participants: Us
 declare type ErrorProps = {
     error: WebchatError;
     restartConversation?: () => void;
+    closeWindow?: () => void;
 };
 
-export declare function ErrorState({ error, restartConversation }: ErrorProps): JSX_3.Element;
+export declare function ErrorState({ error, restartConversation, closeWindow }: ErrorProps): JSX_3.Element;
 
 declare type EventError = Error & {
     type: 'error';
@@ -243,6 +244,8 @@ export declare type FileType = (typeof fileTypes)[number];
 
 export declare const fileTypes: readonly ["audio", "file", "image", "video"];
 
+export declare function generateThemeOverride(theme: LatestWebchatTheme): Record<string, string>;
+
 export declare function generateThemeStylesheet(theme: LatestWebchatTheme): string;
 
 export declare type GenericBlock = AudioBlock | BubbleBlock | ButtonBlock | CarouselBlock | ColumnBlock | DropdownBlock | FileBlock | ImageBlock | LocationBlock | RowBlock | TextBlock | VideoBlock | CustomBlock;
@@ -251,7 +254,7 @@ export declare const getUseWebchatClientStore: typeof WebchatClientStores.getIns
 
 export declare const handleIntegrationError: (thrown: unknown) => WebchatError;
 
-export declare const Header: ({ defaultOpen, closeWindow, configuration, restartConversation, disabled, ...props }: HeaderProps) => JSX_3.Element;
+export declare const Header: ({ defaultOpen, closeWindow, configuration, restartConversation, triggerNetworkError, disabled, ...props }: HeaderProps) => JSX_3.Element;
 
 declare type HeaderProps = {
     defaultOpen?: boolean;
@@ -260,6 +263,7 @@ declare type HeaderProps = {
     onOpenChange?(open: boolean): void;
     restartConversation?: () => void;
     closeWindow?: () => void;
+    triggerNetworkError?: (errorType?: 'network' | 'timeout' | 'server', delay?: number) => Promise<never>;
     configuration: Pick<Configuration, 'email' | 'phone' | 'privacyPolicy' | 'website' | 'termsOfService' | 'botAvatar' | 'botDescription' | 'botName'>;
 };
 
@@ -315,6 +319,7 @@ export declare const Message: MemoExoticComponent<ForwardRefExoticComponent<{
     addMessageFeedback?: (messageId: string, feedback: Feedback) => void;
     isReadOnly?: boolean;
     isLastDeliveredMessage?: boolean;
+    showAvatar?: boolean;
 } & BlockMessage<GenericBlock> & {
     direction: "incoming" | "outgoing" | "system";
     sender: {
@@ -323,7 +328,7 @@ export declare const Message: MemoExoticComponent<ForwardRefExoticComponent<{
     };
 } & RefAttributes<HTMLDivElement>>>;
 
-export declare const MessageList: MemoExoticComponent<({ className, messages, isTyping, headerMessage, renderers, botAvatar, botDescription, botName, sendMessage, addMessageFeedback, showMarquee, ...props }: ComponentProps<"ul"> & MessageListProps) => JSX_3.Element>;
+export declare const MessageList: MemoExoticComponent<({ className, messages, isTyping, headerMessage, renderers, botAvatar, botDescription, botName, sendMessage, addMessageFeedback, showMarquee, showDateSystemMessage, showMessageStatus, showIncomingMessageAvatar, showOutgoingMessageAvatar, ...props }: ComponentProps<"ul"> & MessageListProps) => JSX_3.Element>;
 
 declare type MessageListProps = {
     messages?: RichBlockMessage[];
@@ -336,6 +341,10 @@ declare type MessageListProps = {
     sendMessage?: (payload: IntegrationMessage['payload']) => void;
     addMessageFeedback?: (messageId: string, feedback: Feedback) => void;
     showMarquee?: boolean;
+    showDateSystemMessage?: boolean;
+    showMessageStatus?: boolean;
+    showIncomingMessageAvatar?: boolean;
+    showOutgoingMessageAvatar?: boolean;
 };
 
 export declare const MISSING_API_URL = "The API url is required to initialize the webchat.";
@@ -411,10 +420,13 @@ export declare type Props = {
         type: FileType;
     }>;
     addMessageFeedback?: (messageId: string, feedback: Feedback) => void;
+    triggerNetworkError?: (errorType?: 'network' | 'timeout' | 'server', delay?: number) => Promise<never>;
     error?: WebchatError;
+    storageKey?: string;
 };
 
 declare type Props_2 = {
+    adminKey?: string;
     user?: UserCredentials;
     conversationId?: string;
     clientId: string;
@@ -436,6 +448,7 @@ declare type Props_3 = ComponentProps<'div'> & {
         name: string;
         type: FileType;
     }>;
+    storageKey?: string;
 } & Pick<Configuration, 'composerPlaceholder' | 'footer'>;
 
 declare type Props_4 = ComponentProps<'div'> & {
@@ -446,6 +459,7 @@ declare type Props_4 = ComponentProps<'div'> & {
         type: FileType;
     }>;
     allowFileUpload?: boolean;
+    storageKey?: string;
 };
 
 declare type Props_5 = {
@@ -503,6 +517,12 @@ declare type ScopedClient = {
     addMessageFeedback: (messageId: string, feedback: Feedback) => Promise<void>;
     getUser: () => Promise<UserResponse>;
     updateUser: (user: UserProfile) => Promise<User>;
+    /**
+     * Development-only method to trigger network errors for testing purposes
+     * @param errorType - Type of error to simulate ('network', 'timeout', 'server')
+     * @param delay - Optional delay in milliseconds before throwing the error
+     */
+    triggerNetworkError: (errorType?: 'network' | 'timeout' | 'server', delay?: number) => Promise<never>;
 };
 
 export declare const SSE_DISCONNECTED_ERROR = "You've been disconnected from the conversation.\nPlease refresh the page.";
@@ -518,7 +538,7 @@ export declare type StyleOptions = {
  * StylesheetProvider component that manages theme styles and font loading
  * Handles both default fonts and custom Google Fonts
  */
-export declare const StylesheetProvider: ({ color, fontFamily, radius, themeMode, variant, headerVariant }: Props_7) => JSX_3.Element;
+export declare const StylesheetProvider: ({ color, fontFamily, radius, themeMode, variant, headerVariant, additionalStylesheetUrl, }: Props_7) => JSX_3.Element;
 
 export declare type TextBlock = {
     type: 'text';
@@ -543,7 +563,7 @@ declare type UserProfile = Omit<User, 'id' | 'createdAt' | 'updatedAt'>;
 
 declare type UserResponse = Awaited<ReturnType<Client['getUser']>>['user'];
 
-export declare function useWebchat({ apiUrl, clientId, storageKey, storageLocation, ...props }: Props_2): UseWebchatReturn;
+export declare function useWebchat({ apiUrl, clientId, storageKey, storageLocation, adminKey, ...props }: Props_2): UseWebchatReturn;
 
 declare type UseWebchatReturn = {
     clientState: 'connected' | 'disconnected' | 'error';
@@ -1028,7 +1048,12 @@ export declare const webchatClasses: {
             readonly className: "bpErrorId";
         };
         readonly header: {
-            readonly className: "bpErrorHeader";
+            readonly container: {
+                readonly className: "bpErrorHeader";
+            };
+            readonly actions: {
+                readonly className: "bpErrorHeaderActions";
+            };
         };
         readonly content: {
             readonly className: "bpErrorContent";