@botpress/webchat 3.0.0 → 3.1.0-beta.0

package/.turbo/turbo-build.log

@@ -1,21 +1,21 @@
 
-> @botpress/webchat@3.0.0 build /home/runner/work/genisys/genisys/packages/webchat-components
+> @botpress/webchat@3.1.0-beta.0 build /home/runner/work/genisys/genisys/packages/webchat-components
 > vite build
 
 vite v5.4.8 building for production...
 transforming...
-✓ 3046 modules transformed.
+✓ 3087 modules transformed.
 rendering chunks...
 
 [vite:dts] Start generate declaration files...
 computing gzip size...
-dist/style.css   44.76 kB │ gzip:   8.25 kB
-dist/index.js   776.75 kB │ gzip: 212.99 kB
+dist/style.css   46.57 kB │ gzip:   8.58 kB
+dist/index.js   773.33 kB │ gzip: 212.28 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 21441ms.
+[vite:dts] Declaration files built in 20967ms.
 
-dist/style.css       44.76 kB │ gzip:   8.25 kB
-dist/index.umd.cjs  517.62 kB │ gzip: 174.18 kB
-✓ built in 28.74s
+dist/style.css       46.57 kB │ gzip:   8.58 kB
+dist/index.umd.cjs  516.92 kB │ gzip: 173.66 kB
+✓ built in 28.50s

package/dist/index.d.ts

@@ -5,9 +5,11 @@ import { ComponentProps } from 'react';
 import { ComponentPropsWithRef } from 'react';
 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';
@@ -22,8 +24,8 @@ import { RefObject } from 'react';
 import { RotateCcw } from 'lucide-react';
 import { StoreApi } from 'zustand';
 import { UseBoundStore } from 'zustand';
+import { User } from '@botpress/webchat-client';
 import { UserCredentials } from '@botpress/webchat-client';
-import { UserProps } from '@bpinternal/shared';
 
 declare type AnyEvent = ValueOf<{
     [K in keyof WebchatEvents]: {
@@ -66,6 +68,7 @@ export declare type BlockMessage<T = GenericBlock> = {
     conversationId?: string;
     authorId?: string;
     disableInput?: boolean;
+    status?: 'pending' | 'processing' | 'processed' | 'failed' | 'skipped';
     metadata?: {
         clientMessageId?: string;
         delivered?: boolean;
@@ -90,6 +93,8 @@ declare type BlockProps<T extends GenericBlock['type']> = {
     renderers?: Partial<Renderers>;
 };
 
+export declare const BOT_IS_BLOCKED = "This bot is currently blocked or disabled.";
+
 declare type BoundWebchatClientStore = ReturnType<typeof createWebchatClientStore>;
 
 export declare type BubbleBlock = {
@@ -118,14 +123,12 @@ declare type ByType<M extends {
     }>;
 };
 
-declare type CallbackFn<T> = (args: T) => void;
-
 export declare type CarouselBlock = {
     type: 'carousel';
     blocks: GenericBlock[];
 };
 
-export declare const Chat: ({ connected, configuration, closeWindow, isTyping, messages, user, sendMessage, uploadFile, addMessageFeedback, isLoading, renderers, isReadOnly, disableComposer, restartConversation, allowFileUpload, ...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, restartConversation, ...props }: Props) => JSX_3.Element;
 
 export declare type ColumnBlock = {
     type: 'column';
@@ -138,10 +141,15 @@ 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>;
     isReadOnly?: boolean;
+    status?: BlockMessage['status'];
     sendMessage?: (payload: IntegrationMessage['payload']) => void;
     addMessageFeedback?: (messageId: string, feedback: Feedback) => void;
 };
@@ -152,6 +160,8 @@ declare type ComposableIntegrationMessageTypes = 'audio' | 'bloc' | 'file' | 'im
 
 export declare const Composer: MemoExoticComponent<ForwardRefExoticComponent<Omit<Props_3, "ref"> & RefAttributes<HTMLDivElement>>>;
 
+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 declare const Container: {
@@ -196,19 +206,25 @@ export declare type DropdownBlock = {
     }[];
 };
 
-declare class EventEmitter<T extends Record<string, any>> {
-    private readonly eventMap;
-    constructor();
-    on<U extends keyof T>(event: U, callback: CallbackFn<T[U]>): () => void;
-    emit<U extends keyof T>(event: U, arg?: T[U]): void;
-}
+export declare function enrichMessage(messages: BlockMessage[], participants: User[], currentUserId: string, botName?: string, botAvatar?: string): RichBlockMessage[];
+
+declare type ErrorProps = {
+    error: WebchatError;
+    restartConversation?: () => void;
+};
+
+export declare function ErrorState({ error, restartConversation }: ErrorProps): JSX_3.Element;
+
+declare type EventError = Error & {
+    type: 'error';
+};
 
 declare type Events = WebchatEvents & {
     '*': AnyEvent;
 };
 
 declare type Events_2 = {
-    [key: string]: undefined;
+    [key: string]: string;
 };
 
 export declare const Fab: ForwardRefExoticComponent<Omit<ClassAttributes<HTMLDivElement> & HTMLAttributes<HTMLDivElement> & {
@@ -233,6 +249,8 @@ export declare type GenericBlock = AudioBlock | BubbleBlock | ButtonBlock | Caro
 
 export declare const getUseWebchatClientStore: typeof WebchatClientStores.getInstance;
 
+export declare const handleIntegrationError: (thrown: unknown) => WebchatError;
+
 export declare const Header: ({ defaultOpen, closeWindow, configuration, restartConversation, ...props }: HeaderProps) => JSX_3.Element;
 
 declare type HeaderProps = {
@@ -245,6 +263,12 @@ declare type HeaderProps = {
     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;
+};
+
 export declare type ImageBlock = {
     type: 'image';
     orientation?: 'portrait' | 'landscape' | 'square' | 'auto';
@@ -261,8 +285,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_BOTPRESS_URL = "Invalid URL. Please make sure your client ID and API URL are valid";
+
+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. Please make sure your config URL 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. Please 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;
@@ -276,6 +320,7 @@ export declare const Message: MemoExoticComponent<ForwardRefExoticComponent<{
     sendMessage?: (payload: IntegrationMessage["payload"]) => void;
     addMessageFeedback?: (messageId: string, feedback: Feedback) => void;
     isReadOnly?: boolean;
+    isLastDeliveredMessage?: boolean;
 } & BlockMessage<GenericBlock> & {
     direction: "incoming" | "outgoing" | "system";
     sender: {
@@ -299,6 +344,14 @@ declare type MessageListProps = {
     showMarquee?: boolean;
 };
 
+export declare const MISSING_API_URL = "The API url is required to initialize the webchat.";
+
+export declare const MISSING_BOT_ID = "The Bot ID is required to initialize the webchat.";
+
+export declare const MISSING_CLIENT_ID = "The Client ID is required to initialize the webchat.";
+
+export declare const MISSING_CONFIG_URL = "No config URL provided.";
+
 export declare function Modal({ open, onOpenChange, children, }: {
     open?: boolean;
     onOpenChange?: (open: boolean) => void;
@@ -330,6 +383,10 @@ export declare const ModalProvider: ({ children }: {
     children: ReactNode;
 }) => JSX_3.Element;
 
+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 type Options = {
     timeout?: number;
 };
@@ -339,6 +396,7 @@ export declare type Props = {
     renderers?: Partial<Renderers>;
     configuration: LatestWebchatConfig;
     messages: BlockMessage[];
+    participants: User[];
     connected?: boolean;
     disableComposer?: boolean;
     isReadOnly?: boolean;
@@ -352,13 +410,14 @@ export declare type Props = {
     user?: {
         id: string;
     } & Record<string, unknown>;
-    sendMessage?: (payload: IntegrationMessage['payload']) => void;
+    sendMessage?: (payload: IntegrationMessage['payload']) => Promise<void>;
     uploadFile?: (file: File) => Promise<{
         fileUrl: string;
         name: string;
         type: FileType;
     }>;
     addMessageFeedback?: (messageId: string, feedback: Feedback) => void;
+    error?: WebchatError;
 };
 
 declare type Props_2 = {
@@ -368,7 +427,7 @@ declare type Props_2 = {
     apiUrl?: string;
     sseTimeout?: number;
     storageKey?: string;
-    storageLocation?: Parameters<typeof getUseWebchatClientStore>[1];
+    storageLocation?: StorageLocation;
 };
 
 declare type Props_3 = ComponentProps<'div'> & {
@@ -410,6 +469,8 @@ declare type Props_6 = {
 
 declare type Props_7 = Partial<LatestWebchatTheme>;
 
+export declare const QUOTA_EXCEEDED = "This bot has temporarily paused. Please check back later.";
+
 export declare type Renderers = {
     [T in GenericBlock['type']]: FC<BlockObjects[T]>;
 };
@@ -447,9 +508,15 @@ declare type ScopedClient = {
     }>;
     addMessageFeedback: (messageId: string, feedback: Feedback) => Promise<void>;
     getUser: () => Promise<UserResponse>;
-    updateUser: (user: User) => Promise<User>;
+    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. Please refresh the page.";
+
 declare type StorageLocation = 'sessionStorage' | 'localStorage';
 
 export declare type StyleOptions = {
@@ -478,7 +545,7 @@ export declare type UseImageSizeResult = [Dimensions | null, {
     error: string | null;
 }];
 
-declare type User = UserProps;
+declare type UserProfile = Omit<User, 'id' | 'createdAt' | 'updatedAt'>;
 
 declare type UserResponse = Awaited<ReturnType<Client['getUser']>>['user'];
 
@@ -494,8 +561,10 @@ declare type UseWebchatReturn = {
     isFetchingMessages: boolean;
     user?: UserCredentials;
     isTyping: boolean;
+    error?: WebchatError;
+    participants: User[];
 } | {
-    clientState: 'connecting';
+    clientState: 'connecting' | 'error';
     on: EventEmitter<Events>['on'];
     client: undefined;
     messages: BlockMessage[];
@@ -504,6 +573,8 @@ declare type UseWebchatReturn = {
     isFetchingMessages: boolean;
     user: undefined;
     isTyping: undefined;
+    error?: WebchatError;
+    participants: User[];
 };
 
 export declare const useWebchatStore: UseBoundStore<Omit<StoreApi<WebchatStore>, "setState"> & {
@@ -778,6 +849,9 @@ export declare const webchatClasses: {
                 readonly className: "bpMessageAvatarFallback";
             };
         };
+        readonly deliveryStatus: {
+            readonly className: "bpMessageDeliveryStatus";
+        };
         readonly blocks: {
             readonly text: {
                 readonly heading1: {
@@ -949,6 +1023,26 @@ export declare const webchatClasses: {
             };
         };
     };
+    readonly error: {
+        readonly container: {
+            readonly className: "bpReset bpErrorContainer";
+        };
+        readonly header: {
+            readonly className: "bpErrorHeader";
+        };
+        readonly content: {
+            readonly className: "bpErrorContent";
+        };
+        readonly errorTitle: {
+            readonly className: "bpErrorTitle";
+        };
+        readonly errorMessage: {
+            readonly className: "bpErrorMessage";
+        };
+        readonly icon: {
+            readonly className: "bpErrorIcon";
+        };
+    };
     readonly typingIndicator: {
         readonly container: {
             readonly className: "bpTypingIndicatorContainer";
@@ -963,7 +1057,7 @@ declare type WebchatClientStore = {
     user?: UserCredentials;
     conversationId?: string;
     setUser: (userId?: UserCredentials) => void;
-    setConversationId: (conversationId?: string) => void;
+    setConversationId: (conversationId: string) => void;
     clearAll: () => void;
 };
 
@@ -973,6 +1067,20 @@ declare class WebchatClientStores {
     static getInstance(name?: string, storageLocation?: StorageLocation): BoundWebchatClientStore;
 }
 
+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;
+} | {
+    type: 'bot';
+    message: typeof BOT_IS_BLOCKED | typeof QUOTA_EXCEEDED | typeof NOT_A_PARTICIPANT;
+} | {
+    type: 'network';
+    message: typeof NETWORK_ERROR | typeof SSE_DISCONNECTED_ERROR;
+} | {
+    type: string;
+    message: string;
+};
+
 export declare type WebchatEvents = {
     conversation: string | undefined;
     message: BlockMessage;
@@ -985,6 +1093,8 @@ export declare type WebchatEvents = {
         isTyping: boolean;
         timeout: number;
     };
+    participantAdded: User;
+    participantRemoved: User;
 };
 
 declare type WebchatStore = {
@@ -993,4 +1103,8 @@ declare type WebchatStore = {
     eventEmitter: EventEmitter<Events_2>;
 };
 
+export declare const webhookHandlerErrorMap: {
+    [key in 'ResourceNotFound' | 'Forbidden']: WebchatError;
+};
+
 export { }