@botpress/webchat 2.3.8 → 2.4.0-beta.2

package/dist/components/renderers/Video/Video.d.ts

@@ -1,4 +1,6 @@
-export declare const Video: import("react").ForwardRefExoticComponent<import("../../../adapters/target").VideoMessage & Partial<Pick<import("../../..").MessageObject<import("../../../adapters/target").Message>, "direction" | "timestamp" | "sender"> & {
+export declare const Video: import("react").ForwardRefExoticComponent<import("../../../adapters/target").VideoMessage & Pick<import("../../..").RichMessageObject<import("../../../adapters/target").Message>, "direction" | "timestamp" | "sender"> & {
     messageId: string;
+    sendMessage?: (payload: import("../../../adapters/webchat").Message) => void;
     metadata?: Record<string, any>;
-}> & import("react").RefAttributes<HTMLVideoElement>>;
+    isReadOnly?: boolean;
+} & import("react").RefAttributes<HTMLVideoElement>>;

package/dist/components/renderers/index.d.ts

@@ -1,2 +1,2 @@
-import { Renderers } from '../../contexts';
+import type { Renderers } from '../../types';
 export declare const renderers: Renderers;

package/dist/contexts/index.d.ts

@@ -1,3 +1,2 @@
 export * from './MessageContext';
 export * from './ModalContext';
-export * from './WebchatContext';

package/dist/gen/signals/index.d.ts

@@ -593,8 +593,8 @@ export declare const zod: {
                 })[];
             };
             id: string;
-            userId: string;
             conversationId: string;
+            userId: string;
             createdAt: string;
         }, {
             payload: {
@@ -703,8 +703,8 @@ export declare const zod: {
                 })[];
             };
             id: string;
-            userId: string;
             conversationId: string;
+            userId: string;
             createdAt: string;
         }>;
     }, "strip", import("zod").ZodTypeAny, {
@@ -816,8 +816,8 @@ export declare const zod: {
                 })[];
             };
             id: string;
-            userId: string;
             conversationId: string;
+            userId: string;
             createdAt: string;
         };
     }, {
@@ -929,8 +929,8 @@ export declare const zod: {
                 })[];
             };
             id: string;
-            userId: string;
             conversationId: string;
+            userId: string;
             createdAt: string;
         };
     }>;

package/dist/gen/signals/messageCreated.z.d.ts

@@ -586,8 +586,8 @@ declare const _default: z.ZodObject<{
             })[];
         };
         id: string;
-        userId: string;
         conversationId: string;
+        userId: string;
         createdAt: string;
     }, {
         payload: {
@@ -696,8 +696,8 @@ declare const _default: z.ZodObject<{
             })[];
         };
         id: string;
-        userId: string;
         conversationId: string;
+        userId: string;
         createdAt: string;
     }>;
 }, "strip", z.ZodTypeAny, {
@@ -809,8 +809,8 @@ declare const _default: z.ZodObject<{
             })[];
         };
         id: string;
-        userId: string;
         conversationId: string;
+        userId: string;
         createdAt: string;
     };
 }, {
@@ -922,8 +922,8 @@ declare const _default: z.ZodObject<{
             })[];
         };
         id: string;
-        userId: string;
         conversationId: string;
+        userId: string;
         createdAt: string;
     };
 }>;

package/dist/hooks/index.d.ts

@@ -1,4 +1,5 @@
 export * from './useClient';
 export * from './useImageSize';
+export * from './useIsTyping';
 export * from './useRefresh';
-export * from './useWebchatStore';
+export * from './useWebchatClient';

package/dist/hooks/useIsTyping.d.ts

@@ -0,0 +1,4 @@
+export declare function useIsTyping(): {
+    isTyping: boolean;
+    setIsTyping: (isTyping: boolean, timeout?: number) => () => void;
+};

package/dist/hooks/useWebchatClient.d.ts

@@ -0,0 +1,48 @@
+import type { Events, User } from '../client/types';
+import { type FileType, type MessageObject } from '../types';
+import { EventEmitter } from '../utils';
+import type { Message as WebchatMessage } from '../adapters/webchat';
+import { getClient } from '../client';
+type UserResponse = Awaited<ReturnType<Awaited<ReturnType<typeof getClient>['getUser']>>>['user'];
+type Props = {
+    userKey?: string;
+    conversationId?: string;
+    clientId: string;
+    apiUrl?: string;
+    sseTimeout?: number;
+    storageKey?: string;
+};
+type ScopedClient = {
+    sendMessage: (payload: WebchatMessage) => Promise<void>;
+    updateUser: (user: User) => Promise<User>;
+    sendEvent: (event: Record<string, any>) => Promise<void>;
+    uploadFile: (file: File) => Promise<{
+        fileUrl: string;
+        name: string;
+        type: FileType;
+    }>;
+    getUser: () => Promise<UserResponse>;
+};
+export type UseWebchatClientReturn = {
+    clientState: 'connected' | 'disconnected' | 'error';
+    on: EventEmitter<Events>['on'];
+    client: ScopedClient;
+    messages: MessageObject[];
+    conversationId: string;
+    newConversation: () => void;
+    isFetchingMessages: boolean;
+    user?: UserResponse;
+    isTyping: boolean;
+} | {
+    clientState: 'connecting';
+    on: EventEmitter<Events>['on'];
+    client: undefined;
+    messages: MessageObject[];
+    conversationId: undefined;
+    newConversation: () => void;
+    isFetchingMessages: boolean;
+    user: undefined;
+    isTyping: undefined;
+};
+export declare function useWebchatClient({ apiUrl, clientId, storageKey, ...props }: Props): UseWebchatClientReturn;
+export {};

package/dist/index.d.ts

@@ -9,7 +9,7 @@ export * from './providers';
 export * from './types';
 export * from './schemas';
 export { webchatClasses } from './styles';
-export { type WebchatClient, type WebchatEvents } from './client';
-export { getClient } from './get-client';
-export { useClient, useWebchatStore } from './hooks';
+export { type WebchatClient, type WebchatEvents, getClient, type Client } from './client';
+export { useClient, useWebchatClient, type UseWebchatClientReturn } from './hooks';
 export { generateThemeStylesheet } from './utils';
+export { useWebchatStore, getUseUserStore } from './stores';