@botpress/webchat 4.2.2 → 4.3.2

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @botpress/webchat@4.2.2 build /home/runner/work/genisys/genisys/packages/webchat-components
+> @botpress/webchat@4.3.2 build /home/runner/work/genisys/genisys/packages/webchat-components
 > vite build
 
 vite v5.4.8 building for production...
@@ -10,12 +10,12 @@ rendering chunks...
 [vite:dts] Start generate declaration files...
 computing gzip size...
 dist/style.css   54.01 kB │ gzip:   9.07 kB
-dist/index.js   679.60 kB │ gzip: 183.90 kB
+dist/index.js   678.97 kB │ gzip: 183.72 kB
 [vite:dts] Start rollup declaration files...
 Analysis will use the bundled TypeScript version 5.8.2
 *** The target project appears to use TypeScript 5.9.3 which is newer than the bundled compiler engine; consider upgrading API Extractor.
-[vite:dts] Declaration files built in 18826ms.
+[vite:dts] Declaration files built in 19456ms.
 
 dist/style.css       54.01 kB │ gzip:   9.07 kB
-dist/index.umd.cjs  451.67 kB │ gzip: 148.74 kB
-✓ built in 23.52s
+dist/index.umd.cjs  451.15 kB │ gzip: 148.59 kB
+✓ built in 24.07s

package/dist/index.d.ts

@@ -1,31 +1,37 @@
 import { AddMessageFeedbackBody } from '@botpress/webchat-client';
-import { ClassAttributes } from 'react';
+import { ClassAttributes } from '../../../node_modules/@types/react';
 import { Client } from '@botpress/webchat-client';
-import { ComponentProps } from 'react';
-import { ComponentPropsWithRef } from 'react';
+import { ComponentProps } from '../../../node_modules/@types/react';
+import { ComponentProps as ComponentProps_2 } from '../../node_modules/@types/react';
+import { ComponentPropsWithRef } from '../../node_modules/@types/react';
 import { LatestWebchatConfig as Configuration } from '@bpinternal/shared';
-import { Context } from 'react';
-import { CSSProperties } from 'react';
+import { Context } from '../../node_modules/@types/react';
+import { CSSProperties } from '../../node_modules/@types/react';
 import * as Dialog from '@radix-ui/react-dialog';
-import { Dispatch } from 'react';
+import { Dispatch } from '../../node_modules/@types/react';
 import { EventEmitter } from '@bpinternal/shared';
-import type { FC } from 'react';
-import { ForwardRefExoticComponent } from 'react';
-import { HTMLAttributes } from 'react';
+import { FC } from '../../node_modules/@types/react';
+import { ForwardRefExoticComponent } from '../../node_modules/@types/react';
+import { ForwardRefExoticComponent as ForwardRefExoticComponent_2 } from '../../../node_modules/@types/react';
+import { ForwardRefExoticComponent as ForwardRefExoticComponent_3 } from 'react';
+import { HTMLAttributes } from '../../../node_modules/@types/react';
 import { IntegrationError } from '@botpress/webchat-client';
-import { JSX } from 'react';
+import { JSX } from '../../node_modules/@types/react';
 import { JSX as JSX_2 } from 'react/jsx-runtime';
 import { LatestWebchatTheme } from '@bpinternal/shared';
-import { MemoExoticComponent } from 'react';
+import { MemoExoticComponent } from '../../../node_modules/@types/react';
 import { Message as Message_2 } from '@botpress/webchat-client';
-import { NamedExoticComponent } from 'react';
+import { NamedExoticComponent } from '../../../node_modules/@types/react';
 import { PersistOptions } from 'zustand/middleware';
-import { ReactNode } from 'react';
-import { Ref } from 'react';
-import { RefAttributes } from 'react';
-import { RefObject } from 'react';
+import { ReactNode } from '../../../node_modules/@types/react';
+import { ReactNode as ReactNode_2 } from '../../node_modules/@types/react';
+import { Ref } from '../../../node_modules/@types/react';
+import { RefAttributes } from '../../node_modules/@types/react';
+import { RefAttributes as RefAttributes_2 } from '../../../node_modules/@types/react';
+import { RefAttributes as RefAttributes_3 } from 'react';
+import { RefObject } from '../../node_modules/@types/react';
 import { RotateCcw } from 'lucide-react';
-import { SetStateAction } from 'react';
+import { SetStateAction } from '../../node_modules/@types/react';
 import { StoreApi } from 'zustand';
 import { UseBoundStore } from 'zustand';
 import { User } from '@botpress/webchat-client';
@@ -142,12 +148,6 @@ declare type ChatSoundStore = {
     toggleSound: () => void;
 };
 
-declare class ChatSoundStores {
-    private static _instances;
-    private constructor();
-    static getInstance(name?: string): BoundChatSoundStore;
-}
-
 export declare type ColumnBlock = {
     type: 'column';
     blocks: GenericBlock[];
@@ -176,47 +176,47 @@ export declare type ComposableIntegrationMessagePayload = Extract<IntegrationMes
 
 declare type ComposableIntegrationMessageTypes = 'audio' | 'bloc' | 'file' | 'image' | 'location' | 'markdown' | 'text' | 'video';
 
-export declare const Composer: NamedExoticComponent<Omit<Props_3, "ref"> & RefAttributes<HTMLDivElement>>;
+export declare const Composer: NamedExoticComponent<Omit<Props_3, "ref"> & RefAttributes_2<HTMLDivElement>>;
 
 export declare const CONFIG_ACCESS_DENIED = "Access denied to configuration file. Please check your credentials or your configuration URL and try again.";
 
 export { Configuration }
 
 export declare const Container: {
-    ({ children, className, uploadFile, allowFileUpload, storageKey, connected: _, ...props }: Props_4): JSX_2.Element;
+    ({ children, className, uploadFile, allowFileUpload, storageKey, ...props }: Props_4): JSX_2.Element;
     displayName: string;
 };
 
 declare const createChatSoundStore: (storeName: string) => UseBoundStore<Omit<Omit<StoreApi<ChatSoundStore>, "setState"> & {
-    setState<A extends string | {
-        type: unknown;
-    }>(partial: ChatSoundStore | Partial<ChatSoundStore> | ((state: ChatSoundStore) => ChatSoundStore | Partial<ChatSoundStore>), replace?: boolean | undefined, action?: A | undefined): void;
+setState<A extends string | {
+type: unknown;
+}>(partial: ChatSoundStore | Partial<ChatSoundStore> | ((state: ChatSoundStore) => ChatSoundStore | Partial<ChatSoundStore>), replace?: boolean | undefined, action?: A | undefined): void;
 }, "persist"> & {
-    persist: {
-        setOptions: (options: Partial<PersistOptions<ChatSoundStore, ChatSoundStore>>) => void;
-        clearStorage: () => void;
-        rehydrate: () => Promise<void> | void;
-        hasHydrated: () => boolean;
-        onHydrate: (fn: (state: ChatSoundStore) => void) => () => void;
-        onFinishHydration: (fn: (state: ChatSoundStore) => void) => () => void;
-        getOptions: () => Partial<PersistOptions<ChatSoundStore, ChatSoundStore>>;
-    };
+persist: {
+setOptions: (options: Partial<PersistOptions<ChatSoundStore, ChatSoundStore>>) => void;
+clearStorage: () => void;
+rehydrate: () => Promise<void> | void;
+hasHydrated: () => boolean;
+onHydrate: (fn: (state: ChatSoundStore) => void) => () => void;
+onFinishHydration: (fn: (state: ChatSoundStore) => void) => () => void;
+getOptions: () => Partial<PersistOptions<ChatSoundStore, ChatSoundStore>>;
+};
 }>;
 
 declare const createWebchatClientStore: (storeName: string, storageLocation?: StorageLocation) => UseBoundStore<Omit<Omit<StoreApi<WebchatClientStore>, "setState"> & {
-    setState<A extends string | {
-        type: unknown;
-    }>(partial: WebchatClientStore | Partial<WebchatClientStore> | ((state: WebchatClientStore) => WebchatClientStore | Partial<WebchatClientStore>), replace?: boolean | undefined, action?: A | undefined): void;
+setState<A extends string | {
+type: unknown;
+}>(partial: WebchatClientStore | Partial<WebchatClientStore> | ((state: WebchatClientStore) => WebchatClientStore | Partial<WebchatClientStore>), replace?: boolean | undefined, action?: A | undefined): void;
 }, "persist"> & {
-    persist: {
-        setOptions: (options: Partial<PersistOptions<WebchatClientStore, unknown>>) => void;
-        clearStorage: () => void;
-        rehydrate: () => Promise<void> | void;
-        hasHydrated: () => boolean;
-        onHydrate: (fn: (state: WebchatClientStore) => void) => () => void;
-        onFinishHydration: (fn: (state: WebchatClientStore) => void) => () => void;
-        getOptions: () => Partial<PersistOptions<WebchatClientStore, unknown>>;
-    };
+persist: {
+setOptions: (options: Partial<PersistOptions<WebchatClientStore, unknown>>) => void;
+clearStorage: () => void;
+rehydrate: () => Promise<void> | void;
+hasHydrated: () => boolean;
+onHydrate: (fn: (state: WebchatClientStore) => void) => () => void;
+onFinishHydration: (fn: (state: WebchatClientStore) => void) => () => void;
+getOptions: () => Partial<PersistOptions<WebchatClientStore, unknown>>;
+};
 }>;
 
 export declare type CustomBlock = {
@@ -262,9 +262,9 @@ declare type Events_2 = {
     [key: string]: string;
 };
 
-export declare const Fab: ForwardRefExoticComponent<Omit<ClassAttributes<HTMLDivElement> & HTMLAttributes<HTMLDivElement> & {
-    imgUrl?: string;
-}, "ref"> & RefAttributes<HTMLDivElement>>;
+export declare const Fab: ForwardRefExoticComponent_2<Omit<ClassAttributes<HTMLDivElement> & HTMLAttributes<HTMLDivElement> & {
+imgUrl?: string;
+}, "ref"> & RefAttributes_2<HTMLDivElement>>;
 
 export declare type Feedback = AddMessageFeedbackBody;
 
@@ -284,9 +284,9 @@ export declare function generateThemeStylesheet(theme: LatestWebchatTheme): stri
 
 export declare type GenericBlock = AudioBlock | BubbleBlock | ButtonBlock | CarouselBlock | ColumnBlock | DropdownBlock | FileBlock | ImageBlock | LocationBlock | RowBlock | TextBlock | VideoBlock | CustomBlock;
 
-export declare const getUseChatSoundStore: typeof ChatSoundStores.getInstance;
+export declare const getUseChatSoundStore: (name?: string) => BoundChatSoundStore;
 
-export declare const getUseWebchatClientStore: typeof WebchatClientStores.getInstance;
+export declare const getUseWebchatClientStore: (name?: string, storageLocation?: StorageLocation) => BoundWebchatClientStore;
 
 export declare const Header: ({ defaultOpen, closeWindow, configuration, restartConversation, disabled, soundOn, toggleSound, clientId, ...props }: HeaderProps) => JSX_2.Element;
 
@@ -320,7 +320,7 @@ export declare type InputModalProps<T> = {
     Content?: ({ setValue }: {
         value: T | undefined;
         setValue: (value: T) => void;
-    }) => ReactNode;
+    }) => ReactNode_2;
 };
 
 export declare type IntegrationMessage = Message_2;
@@ -364,21 +364,21 @@ export declare type LocationBlock = {
 
 export declare const mapToWebchatError: (thrown: unknown) => WebchatError;
 
-export declare const Message: NamedExoticComponent<{
-    children?: ReactNode;
-    renderers?: Partial<Renderers>;
-    sendMessage?: (payload: IntegrationMessage["payload"]) => void;
-    addMessageFeedback?: (messageId: string, feedback: Feedback) => void;
-    isReadOnly?: boolean;
-    isLastDeliveredMessage?: boolean;
-    showAvatar?: boolean;
+export declare const Message: NamedExoticComponent<    {
+children?: ReactNode;
+renderers?: Partial<Renderers>;
+sendMessage?: (payload: IntegrationMessage["payload"]) => void;
+addMessageFeedback?: (messageId: string, feedback: Feedback) => void;
+isReadOnly?: boolean;
+isLastDeliveredMessage?: boolean;
+showAvatar?: boolean;
 } & BlockMessage<GenericBlock> & {
-    direction: "incoming" | "outgoing" | "system";
-    sender: {
-        name: string;
-        avatar?: string;
-    };
-} & RefAttributes<HTMLDivElement>>;
+direction: "incoming" | "outgoing" | "system";
+sender: {
+name: string;
+avatar?: string;
+};
+} & RefAttributes_2<HTMLDivElement>>;
 
 export declare const MessageContext: Context<MessageContextVaue | null>;
 
@@ -406,12 +406,12 @@ declare type MessageListProps = {
     showOutgoingMessageAvatar?: boolean;
 };
 
-export declare const MessagePreview: ForwardRefExoticComponent<Omit<ClassAttributes<HTMLDivElement> & HTMLAttributes<HTMLDivElement> & {
-    avatarUrl?: string;
-    botName?: string;
-    description?: string;
-    onClose?: () => void;
-}, "ref"> & RefAttributes<HTMLDivElement>>;
+export declare const MessagePreview: ForwardRefExoticComponent_2<Omit<ClassAttributes<HTMLDivElement> & HTMLAttributes<HTMLDivElement> & {
+avatarUrl?: string;
+botName?: string;
+description?: string;
+onClose?: () => void;
+}, "ref"> & RefAttributes_2<HTMLDivElement>>;
 
 export declare const MISSING_API_URL = "The API url is required to initialize the webchat.";
 
@@ -428,8 +428,8 @@ export declare function Modal({ open, onOpenChange, children, }: {
 }): JSX_2.Element;
 
 export declare namespace Modal {
-    var Button: ForwardRefExoticComponent<Dialog.DialogTriggerProps & RefAttributes<HTMLButtonElement>>;
-    var Close: ForwardRefExoticComponent<Dialog.DialogCloseProps & RefAttributes<HTMLButtonElement>>;
+    var Button: ForwardRefExoticComponent_3<Dialog.DialogTriggerProps & RefAttributes_3<HTMLButtonElement>>;
+    var Close: ForwardRefExoticComponent_3<Dialog.DialogCloseProps & RefAttributes_3<HTMLButtonElement>>;
     var Content: typeof ModalContent;
 }
 
@@ -450,7 +450,7 @@ declare type ModalContextValue = {
 };
 
 export declare const ModalProvider: ({ children }: {
-    children: ReactNode;
+    children: ReactNode_2;
 }) => JSX_2.Element;
 
 export declare const NETWORK_ERROR = "Please check your internet connection and refresh the page.";
@@ -480,14 +480,9 @@ export declare type Props = {
     user?: {
         id: string;
     } & Record<string, unknown>;
-    sendMessage?: (payload: IntegrationMessage['payload']) => Promise<void>;
-    uploadFile?: (file: File) => Promise<{
-        fileUrl: string;
-        name: string;
-        type: FileType;
-    }>;
-    addMessageFeedback?: (messageId: string, feedback: Feedback) => void;
-    triggerNetworkError?: (errorType?: 'network' | 'timeout' | 'server', delay?: number) => Promise<never>;
+    sendMessage?: ScopedClient['sendMessage'];
+    uploadFile?: ScopedClient['uploadFile'];
+    addMessageFeedback?: ScopedClient['addMessageFeedback'];
     error?: WebchatError;
     soundOn?: boolean;
     toggleSound?: () => void;
@@ -514,29 +509,21 @@ declare type Props_3 = ComponentProps<'div'> & {
     allowFileUpload?: boolean;
     disableSendButton?: boolean;
     connected?: boolean;
-    sendMessage?: (payload: IntegrationMessage['payload']) => void;
-    uploadFile?: (file: File) => Promise<{
-        fileUrl: string;
-        name: string;
-        type: FileType;
-    }>;
+    sendMessage?: ScopedClient['sendMessage'];
+    uploadFile?: ScopedClient['uploadFile'];
     storageKey?: string;
 } & Pick<Configuration, 'composerPlaceholder' | 'footer'>;
 
 declare type Props_4 = ComponentProps<'div'> & {
     connected?: boolean;
-    uploadFile?: (file: File) => Promise<{
-        fileUrl: string;
-        name: string;
-        type: FileType;
-    }>;
+    uploadFile?: ScopedClient['uploadFile'];
     allowFileUpload?: boolean;
     storageKey?: string;
 };
 
 declare type Props_5 = {
     restartConversation: () => void;
-} & ComponentProps<typeof RotateCcw>;
+} & ComponentProps_2<typeof RotateCcw>;
 
 declare type Props_6 = {
     clientId: string;
@@ -547,7 +534,7 @@ declare type Props_6 = {
     configuration?: Configuration;
     soundOn?: boolean;
     toggleSound?: () => void;
-} & Pick<ComponentProps<typeof Chat>, 'allowFileUpload' | 'renderers'> & ComponentProps<'div'>;
+} & Pick<ComponentProps_2<typeof Chat>, 'allowFileUpload' | 'renderers'> & ComponentProps_2<'div'>;
 
 declare type Props_7 = Partial<LatestWebchatTheme>;
 
@@ -592,6 +579,7 @@ declare type ScopedClient = {
         fileUrl: string;
         name: string;
         type: FileType;
+        fileId: string;
     }>;
     addMessageFeedback: (messageId: string, feedback: Feedback) => Promise<void>;
     getUser: () => Promise<UserResponse>;
@@ -676,9 +664,9 @@ declare type UseWebchatReturn = {
 };
 
 export declare const useWebchatStore: UseBoundStore<Omit<StoreApi<WebchatStore>, "setState"> & {
-    setState<A extends string | {
-        type: unknown;
-    }>(partial: WebchatStore | Partial<WebchatStore> | ((state: WebchatStore) => WebchatStore | Partial<WebchatStore>), replace?: boolean | undefined, action?: A | undefined): void;
+setState<A extends string | {
+type: unknown;
+}>(partial: WebchatStore | Partial<WebchatStore> | ((state: WebchatStore) => WebchatStore | Partial<WebchatStore>), replace?: boolean | undefined, action?: A | undefined): void;
 }>;
 
 declare type ValueOf<T> = T[keyof T];
@@ -1230,12 +1218,6 @@ export declare type WebchatClientState = {
 
 declare type WebchatClientStore = WebchatClientState & WebchatClientActions;
 
-declare class WebchatClientStores {
-    private static _instances;
-    private constructor();
-    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;