@botpress/webchat 0.5.0 → 1.0.0

package/dist/App.d.ts

@@ -0,0 +1,10 @@
+import { ComponentProps } from 'react';
+import { WebchatClient } from './client';
+import { Container } from './components';
+import { Theme } from './schemas';
+type Props = {
+    theme: Theme;
+    client: WebchatClient;
+} & ComponentProps<typeof Container>;
+export declare const App: ({ theme, client }: Props) => JSX.Element;
+export {};

package/dist/Utils/colors.d.ts

@@ -0,0 +1,18 @@
+export declare function buildColorPalette(color: string, theme?: 'light' | 'dark'): {
+    primary: string;
+    primaryHover: string;
+    primaryHoverDark: string;
+    onPrimary: string;
+    primaryContainer: string;
+    primaryContainerHover: string;
+    onPrimaryContainer: string;
+    secondary: string;
+    secondaryHover: string;
+    onSecondary: string;
+    secondaryContainer: string;
+    secondaryContainerHover: string;
+    onSecondaryContainer: string;
+};
+type Grays = 'gray' | 'stone' | 'slate' | 'zinc' | 'neutral';
+export declare function selectGrayFromColor(color: string, omit?: Grays[]): Grays;
+export {};

package/dist/Utils/eventEmitter.d.ts

@@ -0,0 +1,12 @@
+type CallbackFn<T> = (args: T) => void;
+export declare class EventEmitter<T extends Record<string, any>> {
+    private readonly eventMap;
+    constructor();
+    on<U extends keyof T>(event: U, callback: CallbackFn<T[U]>): () => void;
+    emit<U extends keyof T>(event: U, arg?: T[U]): void;
+}
+export type Events = {
+    [key: string]: undefined;
+};
+export declare const eventEmitter: EventEmitter<Events>;
+export {};

package/dist/Utils/index.d.ts

@@ -0,0 +1,2 @@
+export * from './colors';
+export * from './eventEmitter';

package/dist/client/MessagingClient.d.ts

@@ -0,0 +1,27 @@
+import { type MessagingSocketOptions, type UserCredentials, type Message } from '@botpress/messaging-socket';
+import { EventEmitter } from '../Utils';
+type Events = {
+    connect: UserCredentials;
+    disconnect: undefined;
+    user: string | undefined;
+    conversation: string | undefined;
+    message: Message;
+    messageSent: string;
+    startTyping: undefined;
+    stopTyping: undefined;
+};
+export declare class WebchatClient {
+    private socket;
+    userId: string | undefined;
+    private conversationId;
+    private userToken;
+    private connected;
+    private readonly emitter;
+    on: EventEmitter<Events>['on'];
+    constructor(options: MessagingSocketOptions);
+    connect(creds?: UserCredentials): Promise<UserCredentials | undefined>;
+    disconnect(): Promise<void>;
+    sendMessage(message: string): Promise<void>;
+    newConversation(): Promise<void>;
+}
+export {};

package/dist/client/adapters/Audio.d.ts

@@ -0,0 +1,19 @@
+import { z } from 'zod';
+import { AudioBlock } from '../../types';
+export declare const AudioSchema: z.ZodEffects<z.ZodObject<{
+    type: z.ZodLiteral<"audio">;
+    audio: z.ZodString;
+    title: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    audio: string;
+    type: "audio";
+    title?: string | undefined;
+}, {
+    audio: string;
+    type: "audio";
+    title?: string | undefined;
+}>, AudioBlock, {
+    audio: string;
+    type: "audio";
+    title?: string | undefined;
+}>;

package/dist/client/adapters/Card.d.ts

@@ -0,0 +1,188 @@
+import { z } from 'zod';
+import { ButtonBlock, ColumnBlock, ImageBlock, TextBlock } from '../../types';
+import { WithBubble } from './Utils';
+export type CardBlockType = {
+    blocks: CardBlocks;
+} & Omit<ColumnBlock, 'blocks'>;
+type CardBlocks = (ImageBlock | TextBlock | {
+    type: 'row';
+    blocks: ButtonBlock[];
+})[];
+export declare const BaseCardSchema: z.ZodObject<{
+    type: z.ZodLiteral<"card">;
+    title: z.ZodOptional<z.ZodString>;
+    subtitle: z.ZodOptional<z.ZodString>;
+    image: z.ZodOptional<z.ZodString>;
+    actions: z.ZodArray<z.ZodUnion<[z.ZodEffects<z.ZodObject<{
+        title: z.ZodString;
+        action: z.ZodLiteral<"Say something">;
+        text: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        title: string;
+        text: string;
+        action: "Say something";
+    }, {
+        title: string;
+        text: string;
+        action: "Say something";
+    }>, ButtonBlock, {
+        title: string;
+        text: string;
+        action: "Say something";
+    }>, z.ZodEffects<z.ZodObject<{
+        title: z.ZodString;
+        action: z.ZodLiteral<"Open URL">;
+        url: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        title: string;
+        url: string;
+        action: "Open URL";
+    }, {
+        title: string;
+        url: string;
+        action: "Open URL";
+    }>, ButtonBlock, {
+        title: string;
+        url: string;
+        action: "Open URL";
+    }>, z.ZodEffects<z.ZodObject<{
+        title: z.ZodString;
+        action: z.ZodLiteral<"Postback">;
+        payload: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        title: string;
+        action: "Postback";
+        payload: string;
+    }, {
+        title: string;
+        action: "Postback";
+        payload: string;
+    }>, ButtonBlock, {
+        title: string;
+        action: "Postback";
+        payload: string;
+    }>]>, "many">;
+}, "strip", z.ZodTypeAny, {
+    type: "card";
+    actions: ButtonBlock[];
+    title?: string | undefined;
+    subtitle?: string | undefined;
+    image?: string | undefined;
+}, {
+    type: "card";
+    actions: ({
+        title: string;
+        text: string;
+        action: "Say something";
+    } | {
+        title: string;
+        url: string;
+        action: "Open URL";
+    } | {
+        title: string;
+        action: "Postback";
+        payload: string;
+    })[];
+    title?: string | undefined;
+    subtitle?: string | undefined;
+    image?: string | undefined;
+}>;
+export declare const CardSchemaTransform: ({ title, image, actions, subtitle, }: Omit<z.infer<typeof BaseCardSchema>, 'type'>) => CardBlockType;
+export declare const CardSchema: z.ZodEffects<z.ZodObject<{
+    type: z.ZodLiteral<"card">;
+    title: z.ZodOptional<z.ZodString>;
+    subtitle: z.ZodOptional<z.ZodString>;
+    image: z.ZodOptional<z.ZodString>;
+    actions: z.ZodArray<z.ZodUnion<[z.ZodEffects<z.ZodObject<{
+        title: z.ZodString;
+        action: z.ZodLiteral<"Say something">;
+        text: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        title: string;
+        text: string;
+        action: "Say something";
+    }, {
+        title: string;
+        text: string;
+        action: "Say something";
+    }>, ButtonBlock, {
+        title: string;
+        text: string;
+        action: "Say something";
+    }>, z.ZodEffects<z.ZodObject<{
+        title: z.ZodString;
+        action: z.ZodLiteral<"Open URL">;
+        url: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        title: string;
+        url: string;
+        action: "Open URL";
+    }, {
+        title: string;
+        url: string;
+        action: "Open URL";
+    }>, ButtonBlock, {
+        title: string;
+        url: string;
+        action: "Open URL";
+    }>, z.ZodEffects<z.ZodObject<{
+        title: z.ZodString;
+        action: z.ZodLiteral<"Postback">;
+        payload: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        title: string;
+        action: "Postback";
+        payload: string;
+    }, {
+        title: string;
+        action: "Postback";
+        payload: string;
+    }>, ButtonBlock, {
+        title: string;
+        action: "Postback";
+        payload: string;
+    }>]>, "many">;
+}, "strip", z.ZodTypeAny, {
+    type: "card";
+    actions: ButtonBlock[];
+    title?: string | undefined;
+    subtitle?: string | undefined;
+    image?: string | undefined;
+}, {
+    type: "card";
+    actions: ({
+        title: string;
+        text: string;
+        action: "Say something";
+    } | {
+        title: string;
+        url: string;
+        action: "Open URL";
+    } | {
+        title: string;
+        action: "Postback";
+        payload: string;
+    })[];
+    title?: string | undefined;
+    subtitle?: string | undefined;
+    image?: string | undefined;
+}>, WithBubble<CardBlockType>, {
+    type: "card";
+    actions: ({
+        title: string;
+        text: string;
+        action: "Say something";
+    } | {
+        title: string;
+        url: string;
+        action: "Open URL";
+    } | {
+        title: string;
+        action: "Postback";
+        payload: string;
+    })[];
+    title?: string | undefined;
+    subtitle?: string | undefined;
+    image?: string | undefined;
+}>;
+export {};

package/dist/client/adapters/Carousel.d.ts

@@ -0,0 +1,147 @@
+import { z } from 'zod';
+import { CardBlockType } from './Card';
+import { CarouselBlock } from '../../types';
+type CarouselBlockType = {
+    blocks: CardBlockType[];
+} & Omit<CarouselBlock, 'blocks'>;
+export declare const CarouselSchema: z.ZodEffects<z.ZodObject<{
+    type: z.ZodLiteral<"carousel">;
+    items: z.ZodArray<z.ZodEffects<z.ZodObject<Omit<{
+        type: z.ZodLiteral<"card">;
+        title: z.ZodOptional<z.ZodString>;
+        subtitle: z.ZodOptional<z.ZodString>;
+        image: z.ZodOptional<z.ZodString>;
+        actions: z.ZodArray<z.ZodUnion<[z.ZodEffects<z.ZodObject<{
+            title: z.ZodString;
+            action: z.ZodLiteral<"Say something">;
+            text: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            title: string;
+            text: string;
+            action: "Say something";
+        }, {
+            title: string;
+            text: string;
+            action: "Say something";
+        }>, import("../../types").ButtonBlock, {
+            title: string;
+            text: string;
+            action: "Say something";
+        }>, z.ZodEffects<z.ZodObject<{
+            title: z.ZodString;
+            action: z.ZodLiteral<"Open URL">;
+            url: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            title: string;
+            url: string;
+            action: "Open URL";
+        }, {
+            title: string;
+            url: string;
+            action: "Open URL";
+        }>, import("../../types").ButtonBlock, {
+            title: string;
+            url: string;
+            action: "Open URL";
+        }>, z.ZodEffects<z.ZodObject<{
+            title: z.ZodString;
+            action: z.ZodLiteral<"Postback">;
+            payload: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            title: string;
+            action: "Postback";
+            payload: string;
+        }, {
+            title: string;
+            action: "Postback";
+            payload: string;
+        }>, import("../../types").ButtonBlock, {
+            title: string;
+            action: "Postback";
+            payload: string;
+        }>]>, "many">;
+    }, "type">, "strip", z.ZodTypeAny, {
+        actions: import("../../types").ButtonBlock[];
+        title?: string | undefined;
+        image?: string | undefined;
+        subtitle?: string | undefined;
+    }, {
+        actions: ({
+            title: string;
+            text: string;
+            action: "Say something";
+        } | {
+            title: string;
+            url: string;
+            action: "Open URL";
+        } | {
+            title: string;
+            action: "Postback";
+            payload: string;
+        })[];
+        title?: string | undefined;
+        image?: string | undefined;
+        subtitle?: string | undefined;
+    }>, CardBlockType, {
+        actions: ({
+            title: string;
+            text: string;
+            action: "Say something";
+        } | {
+            title: string;
+            url: string;
+            action: "Open URL";
+        } | {
+            title: string;
+            action: "Postback";
+            payload: string;
+        })[];
+        title?: string | undefined;
+        image?: string | undefined;
+        subtitle?: string | undefined;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    type: "carousel";
+    items: CardBlockType[];
+}, {
+    type: "carousel";
+    items: {
+        actions: ({
+            title: string;
+            text: string;
+            action: "Say something";
+        } | {
+            title: string;
+            url: string;
+            action: "Open URL";
+        } | {
+            title: string;
+            action: "Postback";
+            payload: string;
+        })[];
+        title?: string | undefined;
+        image?: string | undefined;
+        subtitle?: string | undefined;
+    }[];
+}>, CarouselBlockType, {
+    type: "carousel";
+    items: {
+        actions: ({
+            title: string;
+            text: string;
+            action: "Say something";
+        } | {
+            title: string;
+            url: string;
+            action: "Open URL";
+        } | {
+            title: string;
+            action: "Postback";
+            payload: string;
+        })[];
+        title?: string | undefined;
+        image?: string | undefined;
+        subtitle?: string | undefined;
+    }[];
+}>;
+export {};

package/dist/client/adapters/Choice.d.ts

@@ -0,0 +1,45 @@
+import { z } from 'zod';
+import { ButtonBlock, ColumnBlock, RowBlock, TextBlock } from '../../types';
+import { WithBubble } from './Utils';
+type ButtonBlocks = {
+    blocks: ButtonBlock[];
+} & Omit<RowBlock, 'blocks'>;
+type ChoiceBlockType = {
+    blocks: (ButtonBlocks | TextBlock)[];
+} & Omit<ColumnBlock, 'blocks'>;
+export declare const ChoiceSchema: z.ZodEffects<z.ZodObject<{
+    type: z.ZodLiteral<"single-choice">;
+    text: z.ZodString;
+    choices: z.ZodArray<z.ZodObject<{
+        title: z.ZodString;
+        value: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        title: string;
+        value: string;
+    }, {
+        title: string;
+        value: string;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    text: string;
+    type: "single-choice";
+    choices: {
+        title: string;
+        value: string;
+    }[];
+}, {
+    text: string;
+    type: "single-choice";
+    choices: {
+        title: string;
+        value: string;
+    }[];
+}>, WithBubble<ChoiceBlockType>, {
+    text: string;
+    type: "single-choice";
+    choices: {
+        title: string;
+        value: string;
+    }[];
+}>;
+export {};

package/dist/client/adapters/Dropdown.d.ts

@@ -0,0 +1,46 @@
+import { z } from 'zod';
+import { ColumnBlock, DropdownBlock, TextBlock } from '../../types';
+import { WithBubble } from './Utils';
+type DropdownBlockType = {
+    blocks: (DropdownBlock | TextBlock)[];
+} & Omit<ColumnBlock, 'blocks'>;
+export declare const DropdownSchema: z.ZodEffects<z.ZodObject<{
+    type: z.ZodLiteral<"dropdown">;
+    text: z.ZodOptional<z.ZodString>;
+    message: z.ZodOptional<z.ZodString>;
+    options: z.ZodArray<z.ZodObject<{
+        label: z.ZodString;
+        value: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        label: string;
+        value: string;
+    }, {
+        label: string;
+        value: string;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    options: {
+        label: string;
+        value: string;
+    }[];
+    type: "dropdown";
+    text?: string | undefined;
+    message?: string | undefined;
+}, {
+    options: {
+        label: string;
+        value: string;
+    }[];
+    type: "dropdown";
+    text?: string | undefined;
+    message?: string | undefined;
+}>, WithBubble<DropdownBlockType>, {
+    options: {
+        label: string;
+        value: string;
+    }[];
+    type: "dropdown";
+    text?: string | undefined;
+    message?: string | undefined;
+}>;
+export {};

package/dist/client/adapters/File.d.ts

@@ -0,0 +1,19 @@
+import { z } from 'zod';
+import { FileBlock } from '../../types';
+export declare const FileSchema: z.ZodEffects<z.ZodObject<{
+    type: z.ZodLiteral<"file">;
+    file: z.ZodString;
+    title: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    type: "file";
+    file: string;
+    title?: string | undefined;
+}, {
+    type: "file";
+    file: string;
+    title?: string | undefined;
+}>, FileBlock, {
+    type: "file";
+    file: string;
+    title?: string | undefined;
+}>;

package/dist/client/adapters/Image.d.ts

@@ -0,0 +1,19 @@
+import { z } from 'zod';
+import { ImageBlock } from '../../types';
+export declare const ImageSchema: z.ZodEffects<z.ZodObject<{
+    type: z.ZodLiteral<"image">;
+    image: z.ZodString;
+    title: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    image: string;
+    type: "image";
+    title?: string | undefined;
+}, {
+    image: string;
+    type: "image";
+    title?: string | undefined;
+}>, ImageBlock, {
+    image: string;
+    type: "image";
+    title?: string | undefined;
+}>;

package/dist/client/adapters/Location.d.ts

@@ -0,0 +1,27 @@
+import { z } from 'zod';
+import { LocationBlock } from '../../types';
+export declare const LocationSchema: z.ZodEffects<z.ZodObject<{
+    type: z.ZodLiteral<"location">;
+    latitude: z.ZodNumber;
+    longitude: z.ZodNumber;
+    address: z.ZodOptional<z.ZodString>;
+    title: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    type: "location";
+    latitude: number;
+    longitude: number;
+    address?: string | undefined;
+    title?: string | undefined;
+}, {
+    type: "location";
+    latitude: number;
+    longitude: number;
+    address?: string | undefined;
+    title?: string | undefined;
+}>, LocationBlock, {
+    type: "location";
+    latitude: number;
+    longitude: number;
+    address?: string | undefined;
+    title?: string | undefined;
+}>;