@botpress/webchat 1.2.0 → 1.3.1

package/dist/adapters/index.d.ts

@@ -0,0 +1,4 @@
+export * from 'webchat-adapters';
+export * as target from './target';
+export * as messagingToTarget from './messaging-to-target';
+export * as webchatToTarget from './webchat-to-target';

package/dist/adapters/messaging-to-target.d.ts

@@ -0,0 +1,151 @@
+import * as adapters from 'webchat-adapters';
+import * as target from './target';
+type WithBubble<T extends target.Message> = target.BubbleOf<T>;
+export type MessagingToTargetAdapters = adapters.Adapter<adapters.messaging.Messages, target.Messages>;
+export declare const audioAdapter: ({ type, audio }: {
+    type: "audio";
+    audio: string;
+    className?: string | undefined;
+    avatarUrl?: string | undefined;
+    title?: string | undefined;
+}) => {
+    type: "audio";
+    url: string;
+};
+export declare const cardAdapter: (card: {
+    title: string;
+    type: "card";
+    actions: ({
+        title: string;
+        text: string;
+        action: "Say something";
+    } | {
+        title: string;
+        action: "Open URL";
+        url: string;
+    } | {
+        title: string;
+        action: "Postback";
+        payload: string;
+    })[];
+    className?: string | undefined;
+    avatarUrl?: string | undefined;
+    subtitle?: string | undefined;
+    image?: string | undefined;
+}) => WithBubble<target.ColumnMessage>;
+export declare const carouselAdapter: ({ items }: {
+    type: "carousel";
+    items: {
+        title: string;
+        type: "card";
+        actions: ({
+            title: string;
+            text: string;
+            action: "Say something";
+        } | {
+            title: string;
+            action: "Open URL";
+            url: string;
+        } | {
+            title: string;
+            action: "Postback";
+            payload: string;
+        })[];
+        className?: string | undefined;
+        avatarUrl?: string | undefined;
+        subtitle?: string | undefined;
+        image?: string | undefined;
+    }[];
+    className?: string | undefined;
+    avatarUrl?: string | undefined;
+}) => {
+    type: "carousel";
+    blocks: target.ColumnMessage[];
+};
+export declare const choiceAdapter: (x: {
+    type: "single-choice";
+    text: string;
+    choices: {
+        title: string;
+        value: string;
+    }[];
+    className?: string | undefined;
+    avatarUrl?: string | undefined;
+    disableFreeText?: boolean | undefined;
+}) => target.Message;
+export declare const dropdownAdapter: (x: {
+    options: {
+        value: string;
+        label: string;
+    }[];
+    type: "dropdown";
+    className?: string | undefined;
+    avatarUrl?: string | undefined;
+    message?: string | undefined;
+    allowCreation?: boolean | undefined;
+    placeholderText?: string | undefined;
+    allowMultiple?: boolean | undefined;
+    buttonText?: string | undefined;
+    width?: number | undefined;
+    displayInKeyboard?: boolean | undefined;
+    markdown?: boolean | undefined;
+    text?: string | undefined;
+}) => WithBubble<target.ColumnMessage>;
+export declare const fileAdapter: ({ file, ...props }: {
+    type: "file";
+    file: string;
+    className?: string | undefined;
+    avatarUrl?: string | undefined;
+    title?: string | undefined;
+}) => {
+    type: "file";
+    className?: string | undefined;
+    avatarUrl?: string | undefined;
+    title?: string | undefined;
+    url: string;
+};
+export declare const imageAdapter: ({ type, image }: {
+    type: "image";
+    image: string;
+    className?: string | undefined;
+    avatarUrl?: string | undefined;
+}) => {
+    type: "image";
+    url: string;
+};
+export declare const locationAdapter: ({ type, latitude, longitude, title, address }: {
+    type: "location";
+    latitude: number;
+    longitude: number;
+    className?: string | undefined;
+    avatarUrl?: string | undefined;
+    address?: string | undefined;
+    title?: string | undefined;
+}) => {
+    type: "location";
+    latitude: number;
+    longitude: number;
+    title: string;
+};
+export declare const textAdapter: ({ type, text }: {
+    type: "text";
+    text: string;
+    className?: string | undefined;
+    avatarUrl?: string | undefined;
+    markdown?: boolean | undefined;
+}) => WithBubble<{
+    type: "text";
+    text: string;
+}>;
+export declare const videoAdapter: ({ type, video }: {
+    type: "video";
+    video: string;
+    className?: string | undefined;
+    avatarUrl?: string | undefined;
+    title?: string | undefined;
+}) => {
+    type: "video";
+    url: string;
+};
+export declare const messageAdapter: (message: adapters.messaging.Message) => target.Message;
+export {};

package/dist/adapters/target.d.ts

@@ -0,0 +1,77 @@
+import * as adapters from 'webchat-adapters';
+export type AudioMessage = {
+    type: 'audio';
+    url: string;
+};
+export type BubbleMessage = {
+    type: 'bubble';
+    block: Message;
+};
+export type ButtonMessage = {
+    type: 'button';
+    variant: 'action' | 'link';
+    reusable?: boolean;
+    groupId?: string;
+    text: string;
+    buttonValue: string;
+};
+export type CarouselMessage = {
+    type: 'carousel';
+    blocks: Message[];
+};
+export type ColumnMessage = {
+    type: 'column';
+    blocks: Message[];
+    horizontalAlignment?: 'left' | 'center' | 'right';
+    verticalAlignment?: 'top' | 'center' | 'bottom' | 'stretch';
+};
+export type DropdownMessage = {
+    label?: string;
+    type: 'dropdown';
+    reusable?: boolean;
+    options: {
+        label: string;
+        value: string;
+    }[];
+};
+export type FileMessage = {
+    type: 'file';
+    url: string;
+    title?: string;
+};
+export type ImageMessage = {
+    type: 'image';
+    orientation?: 'portrait' | 'landscape' | 'square' | 'auto';
+    url: string;
+};
+export type LocationMessage = {
+    type: 'location';
+    latitude: number;
+    longitude: number;
+    title?: string;
+};
+export type RowMessage = {
+    type: 'row';
+    blocks: Message[];
+    horizontalAlignment?: 'left' | 'center' | 'right' | 'stretch';
+    verticalAlignment?: 'top' | 'center' | 'bottom';
+};
+export type TextMessage = {
+    type: 'text';
+    text: string;
+};
+export type VideoMessage = {
+    type: 'video';
+    url: string;
+};
+export type Message = AudioMessage | BubbleMessage | ButtonMessage | CarouselMessage | ColumnMessage | DropdownMessage | FileMessage | ImageMessage | LocationMessage | RowMessage | TextMessage | VideoMessage;
+export type BubbleOf<T extends Message> = Omit<BubbleMessage, 'block'> & {
+    block: T;
+};
+export type ColumnOf<T extends Message> = Omit<ColumnMessage, 'blocks'> & {
+    blocks: T[];
+};
+export type RowOf<T extends Message> = Omit<RowMessage, 'blocks'> & {
+    blocks: T[];
+};
+export type Messages = adapters.MessagesOf<Message>;

package/dist/adapters/webchat-to-target.d.ts

@@ -0,0 +1,126 @@
+import * as adapters from 'webchat-adapters';
+import * as target from './target';
+export type WebchatToTargetAdapters = adapters.Adapter<adapters.webchat.Messages, target.Messages>;
+export declare const audioAdapter: (webchatMessage: {
+    type: "audio";
+    audioUrl: string;
+    className?: string | undefined;
+}) => {
+    type: "audio";
+    url: string;
+};
+export declare const cardAdapter: (webchatMessage: {
+    title: string;
+    type: "card";
+    actions: {
+        value: string;
+        action: "url" | "postback" | "say";
+        label: string;
+    }[];
+    className?: string | undefined;
+    subtitle?: string | undefined;
+    imageUrl?: string | undefined;
+}) => Omit<target.BubbleMessage, "block"> & {
+    block: target.ColumnMessage;
+};
+export declare const carouselAdapter: (webchatMessage: {
+    type: "carousel";
+    items: {
+        title: string;
+        actions: {
+            value: string;
+            action: "url" | "postback" | "say";
+            label: string;
+        }[];
+        className?: string | undefined;
+        subtitle?: string | undefined;
+        imageUrl?: string | undefined;
+    }[];
+    className?: string | undefined;
+}) => {
+    type: "carousel";
+    blocks: target.ColumnMessage[];
+};
+export declare const choiceAdapter: (webchatMessage: {
+    options: {
+        value: string;
+        label: string;
+    }[];
+    type: "choice";
+    text: string;
+    disableFreeText?: boolean | undefined;
+    className?: string | undefined;
+}) => target.Message;
+export declare const dropdownAdapter: (webchatMessage: {
+    options: {
+        value: string;
+        label: string;
+    }[];
+    type: "dropdown";
+    text: string;
+    className?: string | undefined;
+}) => Omit<target.BubbleMessage, "block"> & {
+    block: target.ColumnMessage;
+};
+export declare const fileAdapter: (webchatMessage: {
+    type: "file";
+    fileUrl: string;
+    title?: string | undefined;
+    className?: string | undefined;
+}) => {
+    type: "file";
+    className?: string | undefined;
+    avatarUrl?: string | undefined;
+    title?: string | undefined;
+    url: string;
+};
+export declare const imageAdapter: (webchatMessage: {
+    type: "image";
+    imageUrl: string;
+    className?: string | undefined;
+}) => {
+    type: "image";
+    url: string;
+};
+export declare const locationAdapter: (webchatMessage: {
+    type: "location";
+    latitude: number;
+    longitude: number;
+    title?: string | undefined;
+    address?: string | undefined;
+    className?: string | undefined;
+}) => {
+    type: "location";
+    latitude: number;
+    longitude: number;
+    title: string;
+};
+export declare const markdownAdapter: (webchatMessage: {
+    type: "markdown";
+    markdown: string;
+    className?: string | undefined;
+}) => Omit<target.BubbleMessage, "block"> & {
+    block: {
+        type: "text";
+        text: string;
+    };
+};
+export declare const textAdapter: (webchatMessage: {
+    type: "text";
+    text: string;
+    className?: string | undefined;
+}) => Omit<target.BubbleMessage, "block"> & {
+    block: {
+        type: "text";
+        text: string;
+    };
+};
+export declare const videoAdapter: (webchatMessage: {
+    type: "video";
+    videoUrl: string;
+    className?: string | undefined;
+}) => {
+    type: "video";
+    url: string;
+};
+export declare const messageAdapter: (message: adapters.webchat.Message) => target.Message;

package/dist/client/MessagingClient/client.d.ts

@@ -1,6 +1,7 @@
 import { type MessagingSocketOptions, type UserCredentials } from '@botpress/messaging-socket';
 import { EventEmitter } from '../../utils';
-import { Events, WebchatClient } from '../types';
+import { Events, UserData, WebchatClient } from '../types';
+export type MessagingClientProps = MessagingSocketOptions;
 export declare class MessagingClient implements WebchatClient {
     private socket;
     clientId: string | undefined;
@@ -10,15 +11,17 @@ export declare class MessagingClient implements WebchatClient {
     private connected;
     private readonly emitter;
     on: EventEmitter<Events>['on'];
-    constructor(options: MessagingSocketOptions);
-    connect(creds?: UserCredentials): Promise<UserCredentials | undefined>;
+    constructor(options: MessagingClientProps);
+    readonly mode = "messaging";
+    connect(creds?: UserCredentials, data?: UserData): Promise<UserCredentials | undefined>;
     disconnect(): Promise<void>;
     sendMessage(message: string): Promise<void>;
+    sendEvent(event: Record<string, any>): Promise<void>;
     switchConversation(id: string): Promise<void>;
     conversationExists(id: string): Promise<boolean>;
     newConversation(): Promise<void>;
     listMessages(limit?: number): Promise<{
-        payload: import("message-adapters/src/target").Message;
+        payload: import("../../adapters/target").Message;
         id: string;
         conversationId: string;
         authorId: string | undefined;

package/dist/client/PushpinClient/index.d.ts

@@ -1,5 +1,5 @@
 import { EventEmitter } from '../../utils';
-import { Events, Message, UserCredentials, WebchatClient } from '../types';
+import { Events, Message, UserCredentials, UserData, WebchatClient } from '../types';
 export type PushpinClientProps = {
     apiUrl: string;
     clientId: string;
@@ -9,14 +9,16 @@ export declare class PushpinClient extends EventEmitter<Events> implements Webch
     private _webhookId;
     private _state;
     constructor(props: PushpinClientProps);
+    readonly mode = "pushpin";
     get clientId(): string;
     get userId(): string | undefined;
     get conversationId(): string | undefined;
-    connect(creds?: UserCredentials): Promise<UserCredentials | undefined>;
+    connect(creds?: UserCredentials, data?: UserData): Promise<UserCredentials | undefined>;
     private _initialConnect;
     private _reConnect;
     disconnect(): Promise<void>;
     sendMessage(message: string): Promise<void>;
+    sendEvent(event: Record<string, any>): Promise<void>;
     switchConversation(id: string): Promise<void>;
     conversationExists(id: string): Promise<boolean>;
     userExists({ userToken }: UserCredentials): Promise<boolean>;

package/dist/client/PushpinClient/inner-client/index.d.ts

@@ -35,5 +35,7 @@ export declare class Client implements IClient {
     readonly getUser: IAutoClient['getUser'];
     readonly updateUser: IAutoClient['updateUser'];
     readonly deleteUser: IAutoClient['deleteUser'];
+    readonly createEvent: IAutoClient['createEvent'];
+    readonly getEvent: IAutoClient['getEvent'];
     readonly listenConversation: ({ id, xUserKey }: ListenConversationArgs) => Promise<SignalListener>;
 }

package/dist/client/types.d.ts

@@ -4,6 +4,7 @@ export type UserCredentials = {
     userId: string;
     userToken: string;
 };
+export type UserData = Record<string, string>;
 export type Message = {
     id: string;
     conversationId: string;
@@ -21,13 +22,15 @@ export type Events = {
     customEvent: Record<string, any>;
 };
 export type WebchatClient = {
+    mode: 'messaging' | 'pushpin';
     clientId: string | undefined;
     userId: string | undefined;
     conversationId: string | undefined;
     on: EventEmitter<Events>['on'];
-    connect(creds?: UserCredentials): Promise<UserCredentials | undefined>;
+    connect(creds?: UserCredentials, data?: UserData): Promise<UserCredentials | undefined>;
     disconnect(): Promise<void>;
     sendMessage(message: string): Promise<void>;
+    sendEvent(event: Record<string, any>): Promise<void>;
     switchConversation(id: string): Promise<void>;
     conversationExists(id: string): Promise<boolean>;
     newConversation(): Promise<void>;

package/dist/components/Avatar.d.ts

@@ -1,9 +1,8 @@
+import { AvatarTheme } from '../types';
 import { ComponentPropsWithRef } from 'react';
-import { z } from 'zod';
-import * as Themes from '../schemas';
 type AvatarProps = {
     userId?: string;
     src?: string;
-} & Omit<ComponentPropsWithRef<'span'>, 'className' | 'style'> & z.infer<typeof Themes.AvatarSchema>;
+} & Omit<ComponentPropsWithRef<'span'>, 'className' | 'style'> & AvatarTheme;
 export declare const Avatar: import("react").ForwardRefExoticComponent<Omit<AvatarProps, "ref"> & import("react").RefAttributes<HTMLSpanElement>>;
 export {};

package/dist/components/Block.d.ts

@@ -1,4 +1,5 @@
-import { BlockMap, CommonBlockProps } from '../types';
-export declare const Block: <T extends "audio" | "carousel" | "text" | "dropdown" | "file" | "image" | "location" | "video" | "bubble" | "button" | "column" | "row">({ block, styles, ...props }: {
+/// <reference types="react" />
+import { BlockMap, BlockTypes, CommonBlockProps } from '../types';
+export declare const Block: <T extends BlockTypes>({ block, styles, ...props }: {
     block: BlockMap[T];
 } & CommonBlockProps) => JSX.Element;

package/dist/components/CloseWindow.d.ts

@@ -0,0 +1,5 @@
+import { ComponentProps } from 'react';
+import { XMarkIcon } from '@heroicons/react/24/outline';
+type Props = ComponentProps<typeof XMarkIcon>;
+export declare const CloseWindow: ({ ...props }: Props) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/components/Composer.d.ts

@@ -1,6 +1,6 @@
+import { Theme } from '../types';
 import { ComponentProps, FC } from 'react';
 import { type StyleOptions } from '../contexts';
-import { Theme } from '../schemas';
 declare const Composer: import("react").MemoExoticComponent<import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & import("react").RefAttributes<HTMLDivElement>>>;
 declare const ComposerInput: import("react").MemoExoticComponent<({ ...props }: ComponentProps<'textarea'>) => import("react/jsx-runtime").JSX.Element>;
 type ComposerButtonStyle = NonNullable<Theme['composer']>['button'];

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

@@ -1,3 +1,3 @@
 /// <reference types="react" />
 import { CommonBlockProps } from '../../types';
-export declare const Audio: import("react").ForwardRefExoticComponent<CommonBlockProps & import("message-adapters/src/target").AudioMessage & import("react").RefAttributes<HTMLAudioElement>>;
+export declare const Audio: import("react").ForwardRefExoticComponent<CommonBlockProps & import("../../adapters/target").AudioMessage & import("react").RefAttributes<HTMLAudioElement>>;

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

@@ -1,3 +1,3 @@
 /// <reference types="react" />
 import { CommonBlockProps } from '../../types';
-export declare const Carousel: import("react").ForwardRefExoticComponent<CommonBlockProps & import("message-adapters/src/target").CarouselMessage & import("react").RefAttributes<HTMLDivElement>>;
+export declare const Carousel: import("react").ForwardRefExoticComponent<CommonBlockProps & import("../../adapters/target").CarouselMessage & import("react").RefAttributes<HTMLDivElement>>;

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

@@ -1,3 +1,3 @@
 /// <reference types="react" />
 import { CommonBlockProps } from '../../types';
-export declare const File: import("react").ForwardRefExoticComponent<CommonBlockProps & import("message-adapters/src/target").FileMessage & import("react").RefAttributes<HTMLAnchorElement>>;
+export declare const File: import("react").ForwardRefExoticComponent<CommonBlockProps & import("../../adapters/target").FileMessage & import("react").RefAttributes<HTMLAnchorElement>>;

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

@@ -1,3 +1,3 @@
 /// <reference types="react" />
 import { CommonBlockProps } from '../../types';
-export declare const Image: import("react").ForwardRefExoticComponent<CommonBlockProps & import("message-adapters/src/target").ImageMessage & import("react").RefAttributes<HTMLImageElement>>;
+export declare const Image: import("react").ForwardRefExoticComponent<CommonBlockProps & import("../../adapters/target").ImageMessage & import("react").RefAttributes<HTMLImageElement>>;

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

@@ -1,3 +1,3 @@
 /// <reference types="react" />
 import { CommonBlockProps } from '../../types';
-export declare const Location: import("react").ForwardRefExoticComponent<CommonBlockProps & import("message-adapters/src/target").LocationMessage & import("react").RefAttributes<HTMLAnchorElement>>;
+export declare const Location: import("react").ForwardRefExoticComponent<CommonBlockProps & import("../../adapters/target").LocationMessage & import("react").RefAttributes<HTMLAnchorElement>>;

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

@@ -1,3 +1,3 @@
 /// <reference types="react" />
 import { CommonBlockProps } from '../../types';
-export declare const Video: import("react").ForwardRefExoticComponent<CommonBlockProps & import("message-adapters/src/target").VideoMessage & import("react").RefAttributes<HTMLVideoElement>>;
+export declare const Video: import("react").ForwardRefExoticComponent<CommonBlockProps & import("../../adapters/target").VideoMessage & import("react").RefAttributes<HTMLVideoElement>>;

package/dist/contexts/WebchatContext.d.ts

@@ -1,8 +1,7 @@
 import { CSSProperties, FC, ReactNode } from 'react';
-import type { BlockObject, BlockStyles, Configuration, MessageObject } from '../types';
+import { Theme, Configuration, BlockObject, BlockStyles, MessageObject } from '../types';
 import { EventEmitter, Events } from '../utils';
-import { Theme } from '../schemas';
-import { type WebchatClient } from '../client';
+import { WebchatClient } from '../client';
 export type StyleOptions = {
     className?: string;
     style?: CSSProperties;
@@ -39,6 +38,7 @@ export type ContextVaue = {
         sendMessage: WebchatClient['sendMessage'];
         restartConversation: () => void;
     } & Pick<WebchatClient, 'userId' | 'conversationId' | 'clientId'>;
+    closeWindow?: () => void;
     setState: (state: Partial<ContextVaue['state']>) => void;
     setTheme: (styles: Partial<Theme>) => void;
 };