@botpress/webchat 3.1.0 → 3.2.0

package/.turbo/turbo-build.log

@@ -1,21 +1,21 @@
 
-> @botpress/webchat@3.1.0 build /home/runner/work/genisys/genisys/packages/webchat-components
+> @botpress/webchat@3.2.0 build /home/runner/work/genisys/genisys/packages/webchat-components
 > vite build
 
 vite v5.4.8 building for production...
 transforming...
-✓ 3087 modules transformed.
+✓ 3180 modules transformed.
 rendering chunks...
 
 [vite:dts] Start generate declaration files...
 computing gzip size...
-dist/style.css   46.51 kB │ gzip:   8.57 kB
-dist/index.js   785.47 kB │ gzip: 215.42 kB
+dist/style.css   47.29 kB │ gzip:   8.69 kB
+dist/index.js   771.34 kB │ gzip: 212.14 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 21718ms.
+[vite:dts] Declaration files built in 21868ms.
 
-dist/style.css       46.51 kB │ gzip:   8.57 kB
-dist/index.umd.cjs  524.32 kB │ gzip: 176.34 kB
-✓ built in 29.23s
+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

package/dist/index.d.ts

@@ -3,15 +3,16 @@ import { ClassAttributes } from 'react';
 import { Client } from '@botpress/webchat-client';
 import { ComponentProps } from 'react';
 import { ComponentPropsWithRef } from 'react';
+import { LatestWebchatConfig as Configuration } from '@bpinternal/shared';
 import { CSSProperties } from 'react';
 import * as Dialog from '@radix-ui/react-dialog';
 import { EventEmitter } from '@bpinternal/shared';
 import type { FC } from 'react';
 import { ForwardRefExoticComponent } from 'react';
 import { HTMLAttributes } from 'react';
+import { IntegrationError } from '@botpress/webchat-client';
 import { JSX as JSX_2 } from 'react';
 import { JSX as JSX_3 } from 'react/jsx-runtime';
-import { LatestWebchatConfig } from '@bpinternal/shared';
 import { LatestWebchatTheme } from '@bpinternal/shared';
 import { MemoExoticComponent } from 'react';
 import { Message as Message_2 } from '@botpress/webchat-client';
@@ -92,7 +93,7 @@ declare type BlockProps<T extends GenericBlock['type']> = {
     renderers?: Partial<Renderers>;
 };
 
-export declare const BOT_IS_BLOCKED = "This bot is currently blocked or disabled.";
+export declare const BOT_IS_BLOCKED = "This bot has temporarily paused.\nPlease check back later.";
 
 declare type BoundWebchatClientStore = ReturnType<typeof createWebchatClientStore>;
 
@@ -140,6 +141,10 @@ export declare type ColumnOf<T extends GenericBlock> = Omit<ColumnBlock, 'blocks
     blocks: T[];
 };
 
+export declare const commonApiErrorMap: {
+    [key in 'MethodNotFound' | 'QuotaExceeded' | 'Forbidden']: WebchatError;
+};
+
 export declare type CommonBlockProps = Pick<RichBlockMessage, 'direction' | 'sender' | 'timestamp' | 'feedback'> & {
     messageId: string;
     metadata?: Record<string, any>;
@@ -157,7 +162,7 @@ export declare const Composer: MemoExoticComponent<ForwardRefExoticComponent<Omi
 
 export declare const CONFIG_ACCESS_DENIED = "Access denied to configuration file. Please check your credentials or your configuration URL and try again.";
 
-declare type configuration = ComponentProps<typeof Chat>['configuration'];
+export { Configuration }
 
 export declare const Container: {
     ({ children, className, connected, uploadFile, allowFileUpload, ...props }: Props_4): JSX_3.Element;
@@ -205,9 +210,14 @@ export declare function enrichMessage(messages: BlockMessage[], participants: Us
 
 declare type ErrorProps = {
     error: WebchatError;
+    restartConversation?: () => void;
 };
 
-export declare function ErrorState({ error }: ErrorProps): JSX_3.Element;
+export declare function ErrorState({ error, restartConversation }: ErrorProps): JSX_3.Element;
+
+declare type EventError = Error & {
+    type: 'error';
+};
 
 declare type Events = WebchatEvents & {
     '*': AnyEvent;
@@ -239,9 +249,9 @@ export declare type GenericBlock = AudioBlock | BubbleBlock | ButtonBlock | Caro
 
 export declare const getUseWebchatClientStore: typeof WebchatClientStores.getInstance;
 
-export declare const handleIntegrationError: (error: unknown) => WebchatError;
+export declare const handleIntegrationError: (thrown: unknown) => WebchatError;
 
-export declare const Header: ({ defaultOpen, closeWindow, configuration, restartConversation, ...props }: HeaderProps) => JSX_3.Element;
+export declare const Header: ({ defaultOpen, closeWindow, configuration, restartConversation, disabled, ...props }: HeaderProps) => JSX_3.Element;
 
 declare type HeaderProps = {
     defaultOpen?: boolean;
@@ -250,13 +260,7 @@ declare type HeaderProps = {
     onOpenChange?(open: boolean): void;
     restartConversation?: () => void;
     closeWindow?: () => void;
-    configuration: Pick<LatestWebchatConfig, 'email' | 'phone' | 'privacyPolicy' | 'website' | 'termsOfService' | 'botAvatar' | 'botDescription' | 'botName'>;
-};
-
-export declare type HookResult<T> = {
-    data: Simplify<T> | undefined;
-    isLoading: boolean;
-    error: WebchatError | undefined;
+    configuration: Pick<Configuration, 'email' | 'phone' | 'privacyPolicy' | 'website' | 'termsOfService' | 'botAvatar' | 'botDescription' | 'botName'>;
 };
 
 export declare type ImageBlock = {
@@ -275,18 +279,28 @@ export declare function integrationMessageToBlockMessage(message: IntegrationMes
 
 declare type IntegrationMessageTypes = IntegrationMessage['payload']['type'];
 
-export declare const INVALID_API_URL = "Invalid API URL. Please use a valid API URL.";
+export declare const INVALID_API_URL = "Invalid API URL.\nPlease use a valid API URL.";
+
+export declare const INVALID_BOTPRESS_URL = "Invalid URL.\nPlease make sure your client ID and API URL are valid";
 
-export declare const INVALID_BOTPRESS_URL = "Invalid URL. Please make sure your client ID and API URL are valid";
+export declare const INVALID_CLIENT_ID = "Invalid Client ID.\nPlease use a valid Botpress Client ID.";
 
-export declare const INVALID_CLIENT_ID = "Invalid Client ID. Please use a valid Botpress Client ID.";
+export declare const INVALID_CONFIG_URL = "Invalid config URL.\nPlease make sure your config URL is valid";
 
-export declare const INVALID_CONFIG_URL = "Invalid config URL. Please make sure your config URL is valid";
+export declare const INVALID_CONFIGURATION = "Invalid webchat configuration.\nPlease make sure your config file is valid";
 
-export declare const INVALID_CONFIGURATION = "Invalid webchat configuration, please make sure your config file is valid";
+export declare const INVALID_MESSAGE_CONTENT_TYPE = "Unable to process the message.\nPlease start a new conversation.";
+
+export declare function isCommonApiErrorType(type: string): type is keyof typeof commonApiErrorMap;
+
+export declare function isEventError(thrown: unknown): thrown is EventError;
 
 export declare const isFileType: (type: string) => type is FileType;
 
+export declare function isIntegrationError(thrown: unknown): thrown is IntegrationError;
+
+export declare function isWebhookHandlerErrorType(type: string): type is keyof typeof webhookHandlerErrorMap;
+
 export declare type LocationBlock = {
     type: 'location';
     latitude: number;
@@ -365,7 +379,7 @@ export declare const ModalProvider: ({ children }: {
 
 export declare const NETWORK_ERROR = "Please check your internet connection and refresh the page.";
 
-export declare const NOT_A_PARTICIPANT = "You are not a participant of this conversation, please clear your local storage.";
+export declare const NOT_A_PARTICIPANT = "Something went wrong. To fix it, please clear your browser's local and session storage and then refresh the page";
 
 export declare type Options = {
     timeout?: number;
@@ -374,7 +388,7 @@ export declare type Options = {
 export declare type Props = {
     className?: string;
     renderers?: Partial<Renderers>;
-    configuration: LatestWebchatConfig;
+    configuration: Configuration;
     messages: BlockMessage[];
     participants: User[];
     connected?: boolean;
@@ -422,7 +436,7 @@ declare type Props_3 = ComponentProps<'div'> & {
         name: string;
         type: FileType;
     }>;
-} & Pick<LatestWebchatConfig, 'composerPlaceholder' | 'footer'>;
+} & Pick<Configuration, 'composerPlaceholder' | 'footer'>;
 
 declare type Props_4 = ComponentProps<'div'> & {
     connected?: boolean;
@@ -444,12 +458,12 @@ declare type Props_6 = {
     storageKey?: string;
     user?: UserCredentials;
     conversationId?: string;
-    configuration?: configuration;
+    configuration?: Configuration;
 } & Pick<ComponentProps<typeof Chat>, 'allowFileUpload' | 'renderers'> & ComponentProps<'div'>;
 
 declare type Props_7 = Partial<LatestWebchatTheme>;
 
-export declare const QUOTA_EXCEEDED = "This bot has temporarily paused. Please check back later.";
+export declare const QUOTA_EXCEEDED = "This bot has temporarily paused.\nPlease check back later.";
 
 export declare type Renderers = {
     [T in GenericBlock['type']]: FC<BlockObjects[T]>;
@@ -491,9 +505,7 @@ declare type ScopedClient = {
     updateUser: (user: UserProfile) => Promise<User>;
 };
 
-export declare type Simplify<T> = {
-    [KeyType in keyof T]: T[KeyType];
-} & {};
+export declare const SSE_DISCONNECTED_ERROR = "You've been disconnected from the conversation.\nPlease refresh the page.";
 
 declare type StorageLocation = 'sessionStorage' | 'localStorage';
 
@@ -502,6 +514,10 @@ export declare type StyleOptions = {
     style?: CSSProperties;
 };
 
+/**
+ * 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 type TextBlock = {
@@ -868,6 +884,9 @@ export declare const webchatClasses: {
                 readonly image: {
                     readonly className: "bpMessageBlocksTextImage";
                 };
+                readonly imageError: {
+                    readonly className: "bpMessageBlocksTextImageError";
+                };
                 readonly horizontalRule: {
                     readonly className: "bpMessageBlocksTextHorizontalRule";
                 };
@@ -1005,6 +1024,9 @@ export declare const webchatClasses: {
         readonly container: {
             readonly className: "bpReset bpErrorContainer";
         };
+        readonly id: {
+            readonly className: "bpErrorId";
+        };
         readonly header: {
             readonly className: "bpErrorHeader";
         };
@@ -1045,7 +1067,7 @@ declare class WebchatClientStores {
     static getInstance(name?: string, storageLocation?: StorageLocation): BoundWebchatClientStore;
 }
 
-export declare type WebchatError = {
+export declare type WebchatError = ({
     type: 'configuration';
     message: typeof MISSING_CLIENT_ID | typeof MISSING_API_URL | typeof MISSING_BOT_ID | typeof INVALID_CLIENT_ID | typeof INVALID_CONFIGURATION | typeof MISSING_CONFIG_URL;
 } | {
@@ -1053,10 +1075,12 @@ export declare type WebchatError = {
     message: typeof BOT_IS_BLOCKED | typeof QUOTA_EXCEEDED | typeof NOT_A_PARTICIPANT;
 } | {
     type: 'network';
-    message: typeof NETWORK_ERROR;
+    message: typeof NETWORK_ERROR | typeof SSE_DISCONNECTED_ERROR;
 } | {
     type: string;
     message: string;
+}) & {
+    id?: string;
 };
 
 export declare type WebchatEvents = {
@@ -1081,4 +1105,8 @@ declare type WebchatStore = {
     eventEmitter: EventEmitter<Events_2>;
 };
 
+export declare const webhookHandlerErrorMap: {
+    [key in 'ResourceNotFound' | 'Forbidden']: WebchatError;
+};
+
 export { }