@botpress/webchat 1.3.13 → 2.1.0

package/dist/providers/WebchatProvider.d.ts

@@ -1,16 +1,5 @@
-import { ComponentProps, ReactNode } from 'react';
-import { type WebchatClient } from '../client';
-import { ContextVaue, Renderers, WebchatContext } from '../contexts';
-import { Theme, Configuration } from '../types';
-type Props = {
-    theme?: Theme;
-    renderers?: Renderers;
-    client?: WebchatClient;
-    configuration?: Configuration;
-    defaultState?: Partial<ContextVaue['state']>;
-    children?: ReactNode | ((configuration: Configuration) => ReactNode);
-    userData?: Record<string, unknown>;
-    closeWindow?: () => void;
-} & Omit<ComponentProps<typeof WebchatContext.Provider>, 'value' | 'children'>;
-export declare const WebchatProvider: ({ theme: initialTheme, renderers, client, children, configuration, userData, closeWindow, ...props }: Props) => import("react/jsx-runtime").JSX.Element;
+/// <reference types="react" />
+import { type WebchatProps } from '../stores';
+type WebchatProviderProps = Partial<React.PropsWithChildren<WebchatProps>>;
+export declare const WebchatProvider: ({ children, ...props }: WebchatProviderProps) => import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/schemas/init.d.ts

@@ -1184,6 +1184,46 @@ export declare const configPropsSchema: z.ZodObject<{
                 className?: string | undefined;
                 style?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
             }>>;
+            uploadButton: z.ZodOptional<z.ZodObject<{
+                container: z.ZodOptional<z.ZodObject<{
+                    className: z.ZodOptional<z.ZodString>;
+                    style: z.ZodOptional<z.ZodEffects<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>, import("react").CSSProperties, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+                }, "strip", z.ZodTypeAny, {
+                    className?: string | undefined;
+                    style?: import("react").CSSProperties | undefined;
+                }, {
+                    className?: string | undefined;
+                    style?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+                }>>;
+                icon: z.ZodOptional<z.ZodObject<{
+                    className: z.ZodOptional<z.ZodString>;
+                    style: z.ZodOptional<z.ZodEffects<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>, import("react").CSSProperties, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+                }, "strip", z.ZodTypeAny, {
+                    className?: string | undefined;
+                    style?: import("react").CSSProperties | undefined;
+                }, {
+                    className?: string | undefined;
+                    style?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+                }>>;
+            }, "strip", z.ZodTypeAny, {
+                container?: {
+                    className?: string | undefined;
+                    style?: import("react").CSSProperties | undefined;
+                } | undefined;
+                icon?: {
+                    className?: string | undefined;
+                    style?: import("react").CSSProperties | undefined;
+                } | undefined;
+            }, {
+                container?: {
+                    className?: string | undefined;
+                    style?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+                } | undefined;
+                icon?: {
+                    className?: string | undefined;
+                    style?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+                } | undefined;
+            }>>;
             button: z.ZodOptional<z.ZodObject<{
                 container: z.ZodOptional<z.ZodObject<{
                     className: z.ZodOptional<z.ZodString>;
@@ -1233,6 +1273,16 @@ export declare const configPropsSchema: z.ZodObject<{
                 className?: string | undefined;
                 style?: import("react").CSSProperties | undefined;
             } | undefined;
+            uploadButton?: {
+                container?: {
+                    className?: string | undefined;
+                    style?: import("react").CSSProperties | undefined;
+                } | undefined;
+                icon?: {
+                    className?: string | undefined;
+                    style?: import("react").CSSProperties | undefined;
+                } | undefined;
+            } | undefined;
             button?: {
                 container?: {
                     className?: string | undefined;
@@ -1252,6 +1302,16 @@ export declare const configPropsSchema: z.ZodObject<{
                 className?: string | undefined;
                 style?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
             } | undefined;
+            uploadButton?: {
+                container?: {
+                    className?: string | undefined;
+                    style?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+                } | undefined;
+                icon?: {
+                    className?: string | undefined;
+                    style?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+                } | undefined;
+            } | undefined;
             button?: {
                 container?: {
                     className?: string | undefined;
@@ -2997,6 +3057,16 @@ export declare const configPropsSchema: z.ZodObject<{
                 className?: string | undefined;
                 style?: import("react").CSSProperties | undefined;
             } | undefined;
+            uploadButton?: {
+                container?: {
+                    className?: string | undefined;
+                    style?: import("react").CSSProperties | undefined;
+                } | undefined;
+                icon?: {
+                    className?: string | undefined;
+                    style?: import("react").CSSProperties | undefined;
+                } | undefined;
+            } | undefined;
             button?: {
                 container?: {
                     className?: string | undefined;
@@ -3408,6 +3478,16 @@ export declare const configPropsSchema: z.ZodObject<{
                 className?: string | undefined;
                 style?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
             } | undefined;
+            uploadButton?: {
+                container?: {
+                    className?: string | undefined;
+                    style?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+                } | undefined;
+                icon?: {
+                    className?: string | undefined;
+                    style?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+                } | undefined;
+            } | undefined;
             button?: {
                 container?: {
                     className?: string | undefined;
@@ -3855,6 +3935,16 @@ export declare const configPropsSchema: z.ZodObject<{
                 className?: string | undefined;
                 style?: import("react").CSSProperties | undefined;
             } | undefined;
+            uploadButton?: {
+                container?: {
+                    className?: string | undefined;
+                    style?: import("react").CSSProperties | undefined;
+                } | undefined;
+                icon?: {
+                    className?: string | undefined;
+                    style?: import("react").CSSProperties | undefined;
+                } | undefined;
+            } | undefined;
             button?: {
                 container?: {
                     className?: string | undefined;
@@ -5279,6 +5369,46 @@ export declare const initPropsSchema: z.ZodObject<{
                 className?: string | undefined;
                 style?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
             }>>;
+            uploadButton: z.ZodOptional<z.ZodObject<{
+                container: z.ZodOptional<z.ZodObject<{
+                    className: z.ZodOptional<z.ZodString>;
+                    style: z.ZodOptional<z.ZodEffects<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>, import("react").CSSProperties, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+                }, "strip", z.ZodTypeAny, {
+                    className?: string | undefined;
+                    style?: import("react").CSSProperties | undefined;
+                }, {
+                    className?: string | undefined;
+                    style?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+                }>>;
+                icon: z.ZodOptional<z.ZodObject<{
+                    className: z.ZodOptional<z.ZodString>;
+                    style: z.ZodOptional<z.ZodEffects<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>, import("react").CSSProperties, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+                }, "strip", z.ZodTypeAny, {
+                    className?: string | undefined;
+                    style?: import("react").CSSProperties | undefined;
+                }, {
+                    className?: string | undefined;
+                    style?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+                }>>;
+            }, "strip", z.ZodTypeAny, {
+                container?: {
+                    className?: string | undefined;
+                    style?: import("react").CSSProperties | undefined;
+                } | undefined;
+                icon?: {
+                    className?: string | undefined;
+                    style?: import("react").CSSProperties | undefined;
+                } | undefined;
+            }, {
+                container?: {
+                    className?: string | undefined;
+                    style?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+                } | undefined;
+                icon?: {
+                    className?: string | undefined;
+                    style?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+                } | undefined;
+            }>>;
             button: z.ZodOptional<z.ZodObject<{
                 container: z.ZodOptional<z.ZodObject<{
                     className: z.ZodOptional<z.ZodString>;
@@ -5328,6 +5458,16 @@ export declare const initPropsSchema: z.ZodObject<{
                 className?: string | undefined;
                 style?: import("react").CSSProperties | undefined;
             } | undefined;
+            uploadButton?: {
+                container?: {
+                    className?: string | undefined;
+                    style?: import("react").CSSProperties | undefined;
+                } | undefined;
+                icon?: {
+                    className?: string | undefined;
+                    style?: import("react").CSSProperties | undefined;
+                } | undefined;
+            } | undefined;
             button?: {
                 container?: {
                     className?: string | undefined;
@@ -5347,6 +5487,16 @@ export declare const initPropsSchema: z.ZodObject<{
                 className?: string | undefined;
                 style?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
             } | undefined;
+            uploadButton?: {
+                container?: {
+                    className?: string | undefined;
+                    style?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+                } | undefined;
+                icon?: {
+                    className?: string | undefined;
+                    style?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+                } | undefined;
+            } | undefined;
             button?: {
                 container?: {
                     className?: string | undefined;
@@ -7092,6 +7242,16 @@ export declare const initPropsSchema: z.ZodObject<{
                 className?: string | undefined;
                 style?: import("react").CSSProperties | undefined;
             } | undefined;
+            uploadButton?: {
+                container?: {
+                    className?: string | undefined;
+                    style?: import("react").CSSProperties | undefined;
+                } | undefined;
+                icon?: {
+                    className?: string | undefined;
+                    style?: import("react").CSSProperties | undefined;
+                } | undefined;
+            } | undefined;
             button?: {
                 container?: {
                     className?: string | undefined;
@@ -7503,6 +7663,16 @@ export declare const initPropsSchema: z.ZodObject<{
                 className?: string | undefined;
                 style?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
             } | undefined;
+            uploadButton?: {
+                container?: {
+                    className?: string | undefined;
+                    style?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+                } | undefined;
+                icon?: {
+                    className?: string | undefined;
+                    style?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+                } | undefined;
+            } | undefined;
             button?: {
                 container?: {
                     className?: string | undefined;
@@ -7961,6 +8131,16 @@ export declare const initPropsSchema: z.ZodObject<{
                 className?: string | undefined;
                 style?: import("react").CSSProperties | undefined;
             } | undefined;
+            uploadButton?: {
+                container?: {
+                    className?: string | undefined;
+                    style?: import("react").CSSProperties | undefined;
+                } | undefined;
+                icon?: {
+                    className?: string | undefined;
+                    style?: import("react").CSSProperties | undefined;
+                } | undefined;
+            } | undefined;
             button?: {
                 container?: {
                     className?: string | undefined;

package/dist/schemas/theme.d.ts

@@ -1814,6 +1814,46 @@ export declare const themeSchema: z.ZodObject<{
             className?: string | undefined;
             style?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
         }>>;
+        uploadButton: z.ZodOptional<z.ZodObject<{
+            container: z.ZodOptional<z.ZodObject<{
+                className: z.ZodOptional<z.ZodString>;
+                style: z.ZodOptional<z.ZodEffects<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>, CSSProperties, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+            }, "strip", z.ZodTypeAny, {
+                className?: string | undefined;
+                style?: CSSProperties | undefined;
+            }, {
+                className?: string | undefined;
+                style?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+            }>>;
+            icon: z.ZodOptional<z.ZodObject<{
+                className: z.ZodOptional<z.ZodString>;
+                style: z.ZodOptional<z.ZodEffects<z.ZodObject<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>, CSSProperties, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+            }, "strip", z.ZodTypeAny, {
+                className?: string | undefined;
+                style?: CSSProperties | undefined;
+            }, {
+                className?: string | undefined;
+                style?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+            }>>;
+        }, "strip", z.ZodTypeAny, {
+            container?: {
+                className?: string | undefined;
+                style?: CSSProperties | undefined;
+            } | undefined;
+            icon?: {
+                className?: string | undefined;
+                style?: CSSProperties | undefined;
+            } | undefined;
+        }, {
+            container?: {
+                className?: string | undefined;
+                style?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+            } | undefined;
+            icon?: {
+                className?: string | undefined;
+                style?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+            } | undefined;
+        }>>;
         button: z.ZodOptional<z.ZodObject<{
             container: z.ZodOptional<z.ZodObject<{
                 className: z.ZodOptional<z.ZodString>;
@@ -1863,6 +1903,16 @@ export declare const themeSchema: z.ZodObject<{
             className?: string | undefined;
             style?: CSSProperties | undefined;
         } | undefined;
+        uploadButton?: {
+            container?: {
+                className?: string | undefined;
+                style?: CSSProperties | undefined;
+            } | undefined;
+            icon?: {
+                className?: string | undefined;
+                style?: CSSProperties | undefined;
+            } | undefined;
+        } | undefined;
         button?: {
             container?: {
                 className?: string | undefined;
@@ -1882,6 +1932,16 @@ export declare const themeSchema: z.ZodObject<{
             className?: string | undefined;
             style?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
         } | undefined;
+        uploadButton?: {
+            container?: {
+                className?: string | undefined;
+                style?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+            } | undefined;
+            icon?: {
+                className?: string | undefined;
+                style?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+            } | undefined;
+        } | undefined;
         button?: {
             container?: {
                 className?: string | undefined;
@@ -3627,6 +3687,16 @@ export declare const themeSchema: z.ZodObject<{
             className?: string | undefined;
             style?: CSSProperties | undefined;
         } | undefined;
+        uploadButton?: {
+            container?: {
+                className?: string | undefined;
+                style?: CSSProperties | undefined;
+            } | undefined;
+            icon?: {
+                className?: string | undefined;
+                style?: CSSProperties | undefined;
+            } | undefined;
+        } | undefined;
         button?: {
             container?: {
                 className?: string | undefined;
@@ -4038,6 +4108,16 @@ export declare const themeSchema: z.ZodObject<{
             className?: string | undefined;
             style?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
         } | undefined;
+        uploadButton?: {
+            container?: {
+                className?: string | undefined;
+                style?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+            } | undefined;
+            icon?: {
+                className?: string | undefined;
+                style?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+            } | undefined;
+        } | undefined;
         button?: {
             container?: {
                 className?: string | undefined;

package/dist/stores/index.d.ts

@@ -0,0 +1,2 @@
+export * from './offlineStore';
+export * from './webchatStore';

package/dist/stores/offlineStore.d.ts

@@ -0,0 +1,33 @@
+import { UserCredentials } from '@botpress/messaging-socket';
+type OfflineStore = {
+    messageHistory: {
+        [key: string]: string[];
+    };
+    user?: UserCredentials;
+    conversationId?: string;
+    clientMode: string;
+    addMessageToHistory: (props: {
+        userId: string;
+        message: string;
+    }) => void;
+    setClientMode: (clientMode: string) => void;
+    setUser: (userId?: UserCredentials) => void;
+    setConversationId: (conversationId?: string) => void;
+    clearAll: () => void;
+};
+export declare const useOfflineStore: import("zustand").UseBoundStore<Omit<Omit<import("zustand").StoreApi<OfflineStore>, "setState"> & {
+    setState<A extends string | {
+        type: unknown;
+    }>(partial: OfflineStore | Partial<OfflineStore> | ((state: OfflineStore) => OfflineStore | Partial<OfflineStore>), replace?: boolean | undefined, action?: A | undefined): void;
+}, "persist"> & {
+    persist: {
+        setOptions: (options: Partial<import("zustand/middleware").PersistOptions<OfflineStore, OfflineStore>>) => void;
+        clearStorage: () => void;
+        rehydrate: () => void | Promise<void>;
+        hasHydrated: () => boolean;
+        onHydrate: (fn: (state: OfflineStore) => void) => () => void;
+        onFinishHydration: (fn: (state: OfflineStore) => void) => () => void;
+        getOptions: () => Partial<import("zustand/middleware").PersistOptions<OfflineStore, OfflineStore>>;
+    };
+}>;
+export {};

package/dist/stores/webchatStore.d.ts

@@ -0,0 +1,46 @@
+import { type RefObject } from 'react';
+import type { Configuration, MessageObject, Theme } from '../types';
+import type { Renderers } from '../contexts';
+import type { WebchatClient } from '../client';
+import { type EventEmitter, type Events } from '../utils';
+export type WebchatProps = {
+    theme: Theme;
+    renderers: Partial<Renderers>;
+    client?: WebchatClient;
+    configuration: Configuration;
+    messages: MessageObject[];
+    connected: boolean;
+    disableComposer: boolean;
+    isReadOnly: boolean;
+    isTyping: boolean;
+    allowFileUpload: boolean;
+    userData: Record<string, unknown>;
+    messageContainerRef: RefObject<HTMLDivElement>;
+    closeWindow?: () => void;
+};
+export type WebchatState = WebchatProps & {
+    setState: (newState: Partial<WebchatState>) => void;
+    setTheme: (theme: Partial<Theme>) => void;
+    setMessages: (messages: MessageObject[]) => void;
+    addMessage: (message: MessageObject) => void;
+    sendTextMessage: (message: string) => void;
+    sendFile: WebchatClient['sendFile'];
+    on: WebchatClient['on'];
+    setConfiguration: (config: Configuration) => void;
+    setConnected: (connected: boolean) => void;
+    setIsTyping: (isTyping: boolean) => void;
+    restartConversation: () => void;
+    getClientId: () => string | undefined;
+    eventEmitter: EventEmitter<Events>;
+};
+export type WebchatStore = ReturnType<typeof createWebchatStore>;
+export declare const WebchatContext: import("react").Context<(Omit<import("zustand").StoreApi<WebchatState>, "setState"> & {
+    setState<A extends string | {
+        type: unknown;
+    }>(partial: WebchatState | Partial<WebchatState> | ((state: WebchatState) => WebchatState | Partial<WebchatState>), replace?: boolean | undefined, action?: A | undefined): void;
+}) | null>;
+export declare const createWebchatStore: (initProps?: Partial<WebchatProps>) => Omit<import("zustand").StoreApi<WebchatState>, "setState"> & {
+    setState<A extends string | {
+        type: unknown;
+    }>(partial: WebchatState | Partial<WebchatState> | ((state: WebchatState) => WebchatState | Partial<WebchatState>), replace?: boolean | undefined, action?: A | undefined): void;
+};

package/dist/types/block-type.d.ts

@@ -34,3 +34,6 @@ export type BlockObjects = {
         type: T;
     }>;
 };
+export declare const fileTypes: readonly ["audio", "file", "image", "video"];
+export type FileType = (typeof fileTypes)[number];
+export declare const isFileType: (type: string) => type is "image" | "audio" | "video" | "file";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/webchat",
-  "version": "1.3.13",
+  "version": "2.1.0",
   "type": "module",
   "license": "MIT",
   "main": "./dist/index.umd.cjs",
@@ -13,7 +13,7 @@
     }
   },
   "scripts": {
-    "type:check": "tsc --noEmit",
+    "check:type": "tsc --noEmit",
     "build": "vite build",
     "test": "vitest run",
     "gen:client": "OUT_DIR=./src/gen es-node ./openapi"
@@ -27,6 +27,7 @@
     "@radix-ui/react-collapsible": "^1.0.3",
     "@radix-ui/react-dialog": "^1.0.4",
     "@radix-ui/react-scroll-area": "^1.0.5",
+    "@redux-devtools/extension": "^3.3.0",
     "@types/qs": "^6.9.8",
     "axios": "1.2.5",
     "clsx": "^2.0.0",