@botpress/webchat 2.3.6 → 2.4.0-beta.1

package/dist/hooks/useWebchatClient.d.ts

@@ -0,0 +1,47 @@
+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;
+};
+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, ...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, useOfflineStore } from './stores';