@botpress/webchat 2.2.19 → 2.3.0

package/dist/client/{PushpinClient/index.d.ts → client.d.ts}

@@ -1,11 +1,12 @@
-import { EventEmitter } from '../../utils';
-import { Events, Message, UserCredentials, UserData, UserOptions, WebchatClient, type User } from '../types';
-import { type FileType } from '../../types';
+import { EventEmitter } from '../utils';
+import { Events, UserCredentials, UserData, UserOptions, type Message, type User } from './types';
+import { type FileType } from '../types';
+import type { Message as WebchatMessage } from '../adapters/webchat';
 export type PushpinClientProps = {
     apiUrl: string;
     clientId: string;
 };
-export declare class PushpinClient extends EventEmitter<Events> implements WebchatClient {
+export declare class WebchatClient extends EventEmitter<Events> {
     private _client;
     private _webhookId;
     private _apiUrl;
@@ -31,7 +32,7 @@ export declare class PushpinClient extends EventEmitter<Events> implements Webch
         name: string;
         type: FileType;
     }>;
-    sendMessage(message: string): Promise<void>;
+    sendMessage(payload: WebchatMessage): Promise<void>;
     sendEvent(event: Record<string, any>): Promise<void>;
     switchConversation(id: string): Promise<void>;
     conversationExists(id: string): Promise<boolean>;

package/dist/client/index.d.ts

@@ -1,3 +1,2 @@
-export * from './MessagingClient';
-export * from './PushpinClient';
+export * from './client';
 export * from './types';

package/dist/client/{PushpinClient/inner-client → inner-client}/index.d.ts

@@ -1,7 +1,7 @@
-import { Client as AutoGeneratedClient } from '../../../gen/client';
+import { Client as AutoGeneratedClient } from '../../gen/client';
 import { SignalListener } from './signal-listener';
-export type { Message, Conversation, User } from '../../../gen/client';
-export * from '../../../gen/client/errors';
+export type { Message, Conversation, User } from '../../gen/client';
+export * from '../../gen/client/errors';
 export type Headers = Record<string, string>;
 export type ClientProps = {
     apiUrl: string;

package/dist/client/{PushpinClient/inner-client → inner-client}/signal-listener.d.ts

@@ -1,6 +1,6 @@
 import { EventEmitter } from './event-emitter';
 import { EvSource } from './eventsource';
-import { Types } from '../../../gen/signals';
+import { Types } from '../../gen/signals';
 type Signals = Types & {
     unknown: {
         type: 'unknown';

package/dist/client/types.d.ts

@@ -1,6 +1,6 @@
-import { EventEmitter } from '../utils';
-import { BlockObject, type FileType } from '../types/block-type';
+import { BlockObject } from '../types/block-type';
 import { UserProps } from '../types';
+import type { Message as WebchatMessage } from '../adapters/webchat';
 type SafeOmit<T, K extends keyof T> = Omit<T, K>;
 export type UserCredentials = {
     userId: string;
@@ -20,7 +20,7 @@ export type Message = {
 export type WebchatEvents = {
     conversation: string | undefined;
     message: Message;
-    messageSent: string;
+    messageSent: WebchatMessage;
     error: Error;
     webchatVisibility: 'show' | 'hide' | 'toggle';
     webchatConfig: Record<string, any>;
@@ -40,27 +40,4 @@ type AnyEvent = ValueOf<{
 export type Events = WebchatEvents & {
     '*': AnyEvent;
 };
-export type WebchatClient = {
-    mode: 'messaging' | 'pushpin';
-    clientId: string;
-    apiUrl: string;
-    userId: string | undefined;
-    conversationId: string | undefined;
-    on: EventEmitter<Events>['on'];
-    connect(creds?: UserCredentials, data?: UserData, opts?: UserOptions): Promise<UserCredentials | undefined>;
-    disconnect(): Promise<void>;
-    getUser(): Promise<User>;
-    updateUser(user: User): Promise<User>;
-    sendMessage(message: string): Promise<void>;
-    sendFile(file: File): Promise<{
-        fileUrl: string;
-        name: string;
-        type: FileType;
-    }>;
-    sendEvent(event: Record<string, any>): Promise<void>;
-    switchConversation(id: string): Promise<void>;
-    conversationExists(id: string): Promise<boolean>;
-    newConversation(): Promise<void>;
-    listMessages(): Promise<Message[]>;
-};
 export {};

package/dist/components/Block.d.ts

@@ -1,7 +1,7 @@
 import { JSX } from 'react';
-import { BlockObjects, BlockType } from '../types';
+import { BlockObjects, BlockType, type CommonBlockProps } from '../types';
 type BlockProps<T extends BlockType> = {
     block: BlockObjects[T];
-};
+} & Partial<CommonBlockProps>;
 export declare const Block: <T extends BlockType>({ block, ...props }: BlockProps<T>) => JSX.Element;
 export {};

package/dist/components/Message/Message.d.ts

@@ -1,6 +1,8 @@
 import { type ReactNode } from 'react';
 import type { MessageObject } from '../../types';
-export declare const Message: import("react").MemoExoticComponent<import("react").ForwardRefExoticComponent<{
+type MessageProps = {
     scroll: () => void;
     children?: ReactNode;
-} & Partial<MessageObject> & import("react").RefAttributes<HTMLDivElement>>>;
+} & MessageObject;
+export declare const Message: import("react").MemoExoticComponent<import("react").ForwardRefExoticComponent<Partial<MessageProps> & import("react").RefAttributes<HTMLDivElement>>>;
+export {};

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

@@ -1 +1,3 @@
-export declare const Audio: import("react").ForwardRefExoticComponent<import("../../../adapters/target").AudioMessage & import("react").RefAttributes<HTMLAudioElement>>;
+export declare const Audio: import("react").ForwardRefExoticComponent<import("../../../adapters/target").AudioMessage & Partial<Pick<import("../../..").MessageObject<import("../../../adapters/target").Message>, "direction" | "timestamp" | "sender"> & {
+    messageId: string;
+}> & import("react").RefAttributes<HTMLAudioElement>>;

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

@@ -1,5 +1,5 @@
 import { ComponentProps } from 'react';
-import { BubbleBlock } from '../../../types';
-type Props = BubbleBlock & ComponentProps<'div'>;
+import { BubbleBlock, type CommonBlockProps } from '../../../types';
+type Props = BubbleBlock & ComponentProps<'div'> & CommonBlockProps;
 export declare const Bubble: import("react").ForwardRefExoticComponent<Omit<Props, "ref"> & import("react").RefAttributes<HTMLDivElement>>;
 export {};

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

@@ -1,4 +1,4 @@
-import { ButtonBlock } from '../../../types';
-type Props = ButtonBlock;
+import { ButtonBlock, type CommonBlockProps } from '../../../types';
+type Props = ButtonBlock & CommonBlockProps;
 export declare const Button: ({ text, buttonValue, type, variant, groupId, reusable, ...props }: Props) => import("react/jsx-runtime").JSX.Element;
 export {};

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

@@ -1 +1,3 @@
-export declare const Carousel: import("react").ForwardRefExoticComponent<import("../../../adapters/target").CarouselMessage & import("react").RefAttributes<HTMLDivElement>>;
+export declare const Carousel: import("react").ForwardRefExoticComponent<import("../../../adapters/target").CarouselMessage & Partial<Pick<import("../../..").MessageObject<import("../../../adapters/target").Message>, "direction" | "timestamp" | "sender"> & {
+    messageId: string;
+}> & import("react").RefAttributes<HTMLDivElement>>;

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

@@ -1,5 +1,5 @@
 import { ComponentProps } from 'react';
-import { ColumnBlock } from '../../../types';
-type Props = ColumnBlock & ComponentProps<'div'>;
+import { ColumnBlock, type CommonBlockProps } from '../../../types';
+type Props = ColumnBlock & ComponentProps<'div'> & CommonBlockProps;
 export declare const Column: import("react").ForwardRefExoticComponent<Omit<Props, "ref"> & import("react").RefAttributes<HTMLDivElement>>;
 export {};

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

@@ -1,5 +1,5 @@
-import { DropdownBlock } from '../../../types';
+import { DropdownBlock, type CommonBlockProps } from '../../../types';
 import { ComponentProps } from 'react';
-type Props = DropdownBlock & ComponentProps<'div'>;
+type Props = DropdownBlock & ComponentProps<'div'> & CommonBlockProps;
 export declare const Dropdown: ({ options, label, reusable }: Props) => import("react/jsx-runtime").JSX.Element;
 export {};

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

@@ -1 +1,3 @@
-export declare const File: import("react").ForwardRefExoticComponent<import("../../../adapters/target").FileMessage & import("react").RefAttributes<HTMLAnchorElement>>;
+export declare const File: import("react").ForwardRefExoticComponent<import("../../../adapters/target").FileMessage & Partial<Pick<import("../../..").MessageObject<import("../../../adapters/target").Message>, "direction" | "timestamp" | "sender"> & {
+    messageId: string;
+}> & import("react").RefAttributes<HTMLAnchorElement>>;

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

@@ -1 +1,3 @@
-export declare const Image: import("react").ForwardRefExoticComponent<import("../../../adapters/target").ImageMessage & import("react").RefAttributes<HTMLImageElement>>;
+export declare const Image: import("react").ForwardRefExoticComponent<import("../../../adapters/target").ImageMessage & Partial<Pick<import("../../..").MessageObject<import("../../../adapters/target").Message>, "direction" | "timestamp" | "sender"> & {
+    messageId: string;
+}> & import("react").RefAttributes<HTMLImageElement>>;

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

@@ -1 +1,3 @@
-export declare const Location: import("react").ForwardRefExoticComponent<import("../../../adapters/target").LocationMessage & import("react").RefAttributes<HTMLAnchorElement>>;
+export declare const Location: import("react").ForwardRefExoticComponent<import("../../../adapters/target").LocationMessage & Partial<Pick<import("../../..").MessageObject<import("../../../adapters/target").Message>, "direction" | "timestamp" | "sender"> & {
+    messageId: string;
+}> & import("react").RefAttributes<HTMLAnchorElement>>;

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

@@ -1,5 +1,5 @@
 import { ComponentProps } from 'react';
-import { RowBlock } from '../../../types';
-type Props = RowBlock & ComponentProps<'div'>;
+import { RowBlock, type CommonBlockProps } from '../../../types';
+type Props = RowBlock & ComponentProps<'div'> & CommonBlockProps;
 export declare const Row: import("react").ForwardRefExoticComponent<Omit<Props, "ref"> & import("react").RefAttributes<HTMLDivElement>>;
 export {};

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

@@ -1,4 +1,4 @@
-import { TextBlock } from '../../../types';
-type Props = TextBlock;
+import { TextBlock, type CommonBlockProps } from '../../../types';
+type Props = TextBlock & CommonBlockProps;
 export declare const Text: ({ text }: Props) => import("react/jsx-runtime").JSX.Element;
 export {};

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

@@ -1 +1,3 @@
-export declare const Video: import("react").ForwardRefExoticComponent<import("../../../adapters/target").VideoMessage & import("react").RefAttributes<HTMLVideoElement>>;
+export declare const Video: import("react").ForwardRefExoticComponent<import("../../../adapters/target").VideoMessage & Partial<Pick<import("../../..").MessageObject<import("../../../adapters/target").Message>, "direction" | "timestamp" | "sender"> & {
+    messageId: string;
+}> & import("react").RefAttributes<HTMLVideoElement>>;

package/dist/gen/client/models.d.ts

@@ -184,6 +184,67 @@ export interface Message {
         className?: string;
         type: "video";
         [k: string]: any;
+    } | {
+        items: ({
+            type: "text";
+            payload: {
+                text: string;
+                [k: string]: any;
+            };
+            [k: string]: any;
+        } | {
+            type: "markdown";
+            payload: {
+                markdown: string;
+                [k: string]: any;
+            };
+            [k: string]: any;
+        } | {
+            type: "image";
+            payload: {
+                imageUrl: string;
+                [k: string]: any;
+            };
+            [k: string]: any;
+        } | {
+            type: "audio";
+            payload: {
+                audioUrl: string;
+                [k: string]: any;
+            };
+            [k: string]: any;
+        } | {
+            type: "video";
+            payload: {
+                videoUrl: string;
+                [k: string]: any;
+            };
+            [k: string]: any;
+        } | {
+            type: "file";
+            payload: {
+                fileUrl: string;
+                title?: string;
+                [k: string]: any;
+            };
+            [k: string]: any;
+        } | {
+            type: "location";
+            payload: {
+                latitude: number;
+                longitude: number;
+                address?: string;
+                title?: string;
+                [k: string]: any;
+            };
+            [k: string]: any;
+        })[];
+        /**
+         * CSS className to apply to the message
+         */
+        className?: string;
+        type: "bloc";
+        [k: string]: any;
     };
     /**
      * ID of the [User](#schema_user)

package/dist/gen/client/operations/createMessage.d.ts

@@ -135,6 +135,67 @@ export interface CreateMessageRequestBody {
         className?: string;
         type: "video";
         [k: string]: any;
+    } | {
+        items: ({
+            type: "text";
+            payload: {
+                text: string;
+                [k: string]: any;
+            };
+            [k: string]: any;
+        } | {
+            type: "markdown";
+            payload: {
+                markdown: string;
+                [k: string]: any;
+            };
+            [k: string]: any;
+        } | {
+            type: "image";
+            payload: {
+                imageUrl: string;
+                [k: string]: any;
+            };
+            [k: string]: any;
+        } | {
+            type: "audio";
+            payload: {
+                audioUrl: string;
+                [k: string]: any;
+            };
+            [k: string]: any;
+        } | {
+            type: "video";
+            payload: {
+                videoUrl: string;
+                [k: string]: any;
+            };
+            [k: string]: any;
+        } | {
+            type: "file";
+            payload: {
+                fileUrl: string;
+                title?: string;
+                [k: string]: any;
+            };
+            [k: string]: any;
+        } | {
+            type: "location";
+            payload: {
+                latitude: number;
+                longitude: number;
+                address?: string;
+                title?: string;
+                [k: string]: any;
+            };
+            [k: string]: any;
+        })[];
+        /**
+         * CSS className to apply to the message
+         */
+        className?: string;
+        type: "bloc";
+        [k: string]: any;
     };
     /**
      * ID of the [Conversation](#schema_conversation)
@@ -293,6 +354,67 @@ export interface CreateMessageResponse {
             className?: string;
             type: "video";
             [k: string]: any;
+        } | {
+            items: ({
+                type: "text";
+                payload: {
+                    text: string;
+                    [k: string]: any;
+                };
+                [k: string]: any;
+            } | {
+                type: "markdown";
+                payload: {
+                    markdown: string;
+                    [k: string]: any;
+                };
+                [k: string]: any;
+            } | {
+                type: "image";
+                payload: {
+                    imageUrl: string;
+                    [k: string]: any;
+                };
+                [k: string]: any;
+            } | {
+                type: "audio";
+                payload: {
+                    audioUrl: string;
+                    [k: string]: any;
+                };
+                [k: string]: any;
+            } | {
+                type: "video";
+                payload: {
+                    videoUrl: string;
+                    [k: string]: any;
+                };
+                [k: string]: any;
+            } | {
+                type: "file";
+                payload: {
+                    fileUrl: string;
+                    title?: string;
+                    [k: string]: any;
+                };
+                [k: string]: any;
+            } | {
+                type: "location";
+                payload: {
+                    latitude: number;
+                    longitude: number;
+                    address?: string;
+                    title?: string;
+                    [k: string]: any;
+                };
+                [k: string]: any;
+            })[];
+            /**
+             * CSS className to apply to the message
+             */
+            className?: string;
+            type: "bloc";
+            [k: string]: any;
         };
         /**
          * ID of the [User](#schema_user)

package/dist/gen/client/operations/getMessage.d.ts

@@ -160,6 +160,67 @@ export interface GetMessageResponse {
             className?: string;
             type: "video";
             [k: string]: any;
+        } | {
+            items: ({
+                type: "text";
+                payload: {
+                    text: string;
+                    [k: string]: any;
+                };
+                [k: string]: any;
+            } | {
+                type: "markdown";
+                payload: {
+                    markdown: string;
+                    [k: string]: any;
+                };
+                [k: string]: any;
+            } | {
+                type: "image";
+                payload: {
+                    imageUrl: string;
+                    [k: string]: any;
+                };
+                [k: string]: any;
+            } | {
+                type: "audio";
+                payload: {
+                    audioUrl: string;
+                    [k: string]: any;
+                };
+                [k: string]: any;
+            } | {
+                type: "video";
+                payload: {
+                    videoUrl: string;
+                    [k: string]: any;
+                };
+                [k: string]: any;
+            } | {
+                type: "file";
+                payload: {
+                    fileUrl: string;
+                    title?: string;
+                    [k: string]: any;
+                };
+                [k: string]: any;
+            } | {
+                type: "location";
+                payload: {
+                    latitude: number;
+                    longitude: number;
+                    address?: string;
+                    title?: string;
+                    [k: string]: any;
+                };
+                [k: string]: any;
+            })[];
+            /**
+             * CSS className to apply to the message
+             */
+            className?: string;
+            type: "bloc";
+            [k: string]: any;
         };
         /**
          * ID of the [User](#schema_user)

package/dist/gen/client/operations/listConversationMessages.d.ts

@@ -158,6 +158,67 @@ export interface ListConversationMessagesResponse {
             className?: string;
             type: "video";
             [k: string]: any;
+        } | {
+            items: ({
+                type: "text";
+                payload: {
+                    text: string;
+                    [k: string]: any;
+                };
+                [k: string]: any;
+            } | {
+                type: "markdown";
+                payload: {
+                    markdown: string;
+                    [k: string]: any;
+                };
+                [k: string]: any;
+            } | {
+                type: "image";
+                payload: {
+                    imageUrl: string;
+                    [k: string]: any;
+                };
+                [k: string]: any;
+            } | {
+                type: "audio";
+                payload: {
+                    audioUrl: string;
+                    [k: string]: any;
+                };
+                [k: string]: any;
+            } | {
+                type: "video";
+                payload: {
+                    videoUrl: string;
+                    [k: string]: any;
+                };
+                [k: string]: any;
+            } | {
+                type: "file";
+                payload: {
+                    fileUrl: string;
+                    title?: string;
+                    [k: string]: any;
+                };
+                [k: string]: any;
+            } | {
+                type: "location";
+                payload: {
+                    latitude: number;
+                    longitude: number;
+                    address?: string;
+                    title?: string;
+                    [k: string]: any;
+                };
+                [k: string]: any;
+            })[];
+            /**
+             * CSS className to apply to the message
+             */
+            className?: string;
+            type: "bloc";
+            [k: string]: any;
         };
         /**
          * ID of the [User](#schema_user)