@botpress/webchat 1.1.1 → 1.2.0

package/dist/App.d.ts

@@ -1,11 +1,11 @@
 import { ComponentProps } from 'react';
-import { WebChatClient } from './client';
+import { WebchatClient } from './client';
 import { Container } from './components';
 import { Theme } from './schemas';
 type Props = {
     theme: Theme;
-    client?: WebChatClient;
+    client?: WebchatClient;
 } & ComponentProps<typeof Container>;
-export declare const App: ({ theme, client }: Props) => JSX.Element;
-export declare function FabSample(props: Props): JSX.Element;
+export declare const App: ({ theme, client }: Props) => import("react/jsx-runtime").JSX.Element;
+export declare function FabSample(props: Props): import("react/jsx-runtime").JSX.Element;
 export {};

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

@@ -1,20 +1,7 @@
 import { type MessagingSocketOptions, type UserCredentials } from '@botpress/messaging-socket';
 import { EventEmitter } from '../../utils';
-import { Message, WebChatClient } from '../types';
-import { TriggerSchema } from './adapters/Trigger';
-import { z } from 'zod';
-type Events = {
-    connect: UserCredentials;
-    disconnect: undefined;
-    user: string | undefined;
-    conversation: string | undefined;
-    message: Message;
-    messageSent: string;
-    startTyping: undefined;
-    stopTyping: undefined;
-    trigger: z.infer<typeof TriggerSchema>['trigger'];
-};
-export declare class MessagingClient implements WebChatClient {
+import { Events, WebchatClient } from '../types';
+export declare class MessagingClient implements WebchatClient {
     private socket;
     clientId: string | undefined;
     userId: string | undefined;
@@ -38,4 +25,3 @@ export declare class MessagingClient implements WebChatClient {
         sentOn: Date;
     }[]>;
 }
-export {};

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

@@ -1,14 +1,14 @@
 import { EventEmitter } from '../../utils';
-import { Events, Message, UserCredentials, WebChatClient } from '../types';
-export type ChatClientProps = {
+import { Events, Message, UserCredentials, WebchatClient } from '../types';
+export type PushpinClientProps = {
     apiUrl: string;
     clientId: string;
 };
-export declare class ChatClient extends EventEmitter<Events> implements WebChatClient {
+export declare class PushpinClient extends EventEmitter<Events> implements WebchatClient {
     private _client;
     private _webhookId;
     private _state;
-    constructor(props: ChatClientProps);
+    constructor(props: PushpinClientProps);
     get clientId(): string;
     get userId(): string | undefined;
     get conversationId(): string | undefined;

package/dist/client/PushpinClient/inner-client/event-emitter.d.ts

@@ -0,0 +1,10 @@
+export type ListenStatus = 'keep-listening' | 'stop-listening';
+export declare class EventEmitter<E extends object> {
+    private listeners;
+    emit<K extends keyof E>(type: K, event: E[K]): void;
+    onceOrMore<K extends keyof E>(type: K, listener: (event: E[K]) => ListenStatus): void;
+    once<K extends keyof E>(type: K, listener: (event: E[K]) => void): void;
+    on<K extends keyof E>(type: K, listener: (event: E[K]) => void): void;
+    off<K extends keyof E>(type: K, listener: (event: E[K]) => void): void;
+    cleanup(): void;
+}

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

@@ -0,0 +1,22 @@
+import EventSource from 'event-source-polyfill';
+import { EventEmitter } from './event-emitter';
+type OnOpen = NonNullable<EventSource.EventSourcePolyfill['onopen']>;
+type OnMessage = NonNullable<EventSource.EventSourcePolyfill['onmessage']>;
+type OnError = NonNullable<EventSource.EventSourcePolyfill['onerror']>;
+export type OpenEvent = Parameters<OnOpen>[0];
+export type MessageEvent = Parameters<OnMessage>[0];
+export type ErrorEvent = Parameters<OnError>[0];
+export type Events = {
+    open: OpenEvent;
+    message: MessageEvent;
+    error: ErrorEvent;
+};
+export type Props = {
+    headers?: Record<string, string>;
+};
+export type EvSource = {
+    on: EventEmitter<Events>['on'];
+    close: () => void;
+};
+export declare const listenEventSource: (url: string, props?: Props) => Promise<EvSource>;
+export {};

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

@@ -0,0 +1,39 @@
+import { ApiClient as AutoGeneratedClient } from '../../../gen/client/client';
+import { SignalListener } from './signal-listener';
+export type { Message, Conversation, User } from '../../../gen/client';
+export * from '../../../gen/client/errors';
+export type Headers = Record<string, string>;
+export type ClientProps = {
+    apiUrl: string;
+    timeout?: number;
+    headers?: Headers;
+};
+type IOf<T extends object> = {
+    [K in keyof T]: T[K];
+};
+type IAutoClient = IOf<AutoGeneratedClient>;
+type IClient = Omit<IAutoClient, 'listenConversation'>;
+type ListenConversationOperation = IAutoClient['listenConversation'];
+type ListenConversationArgs = Parameters<ListenConversationOperation>[0];
+export declare class Client implements IClient {
+    readonly props: Readonly<ClientProps>;
+    private _auto;
+    constructor(props: Readonly<ClientProps>);
+    readonly createConversation: IAutoClient['createConversation'];
+    readonly getConversation: IAutoClient['getConversation'];
+    readonly deleteConversation: IAutoClient['deleteConversation'];
+    readonly listConversations: IAutoClient['listConversations'];
+    readonly listConversationMessages: IAutoClient['listConversationMessages'];
+    readonly addParticipant: IAutoClient['addParticipant'];
+    readonly removeParticipant: IAutoClient['removeParticipant'];
+    readonly getParticipant: IAutoClient['getParticipant'];
+    readonly listParticipants: IAutoClient['listParticipants'];
+    readonly createMessage: IAutoClient['createMessage'];
+    readonly getMessage: IAutoClient['getMessage'];
+    readonly deleteMessage: IAutoClient['deleteMessage'];
+    readonly createUser: IAutoClient['createUser'];
+    readonly getUser: IAutoClient['getUser'];
+    readonly updateUser: IAutoClient['updateUser'];
+    readonly deleteUser: IAutoClient['deleteUser'];
+    readonly listenConversation: ({ id, xUserKey }: ListenConversationArgs) => Promise<SignalListener>;
+}

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

@@ -0,0 +1,47 @@
+import { EventEmitter } from './event-emitter';
+import { EvSource } from './eventsource';
+import { Types } from '../../../gen/signals';
+type Signals = Types & {
+    unknown: {
+        type: 'unknown';
+        data: unknown;
+    };
+};
+type SignalMap = {
+    [K in keyof Signals as Signals[K]['type']]: Signals[K]['data'];
+};
+type Events = SignalMap & {
+    error: Error;
+};
+type SignalListenerState = {
+    status: 'disconnected';
+} | {
+    status: 'connecting';
+    connectionPromise: Promise<EvSource>;
+} | {
+    status: 'connected';
+    source: EvSource;
+};
+export type SignalListenerStatus = SignalListenerState['status'];
+export type SignalListenerProps = {
+    url: string;
+    userKey: string;
+    conversationId: string;
+};
+export declare class SignalListener extends EventEmitter<Events> {
+    private _props;
+    private _state;
+    constructor(_props: SignalListenerProps);
+    static listen: (props: SignalListenerProps) => Promise<SignalListener>;
+    get status(): SignalListenerStatus;
+    readonly connect: () => Promise<void>;
+    readonly disconnect: () => Promise<void>;
+    private _connect;
+    private _disconnectSync;
+    private _handleMessage;
+    private _handleError;
+    private _parseSignal;
+    private _safeJsonParse;
+    private _toError;
+}
+export {};

package/dist/client/{ChatClient → PushpinClient}/state-machine.d.ts

@@ -1,4 +1,4 @@
-import { Client } from '@botpress/chat';
+import { Client } from './inner-client';
 export type SignalEmitter = Awaited<ReturnType<Client['listenConversation']>>;
 export type DisconnectedState = {};
 export type UserCreatingState = DisconnectedState & {};
@@ -11,7 +11,7 @@ export type ConversationCreatedState = ConversationCreatingState & {
     conversationId: string;
     signalEmitter: SignalEmitter;
 };
-export type ChatClientState = (DisconnectedState & {
+export type PushpinClientState = (DisconnectedState & {
     status: 'disconnected';
 }) | (UserCreatingState & {
     status: 'user_creating';
@@ -22,19 +22,19 @@ export type ChatClientState = (DisconnectedState & {
 }) | (ConversationCreatedState & {
     status: 'conversation_created';
 });
-export type ChatClientStatus = ChatClientState['status'];
-export type StateOf<S extends ChatClientStatus> = Extract<ChatClientState, {
+export type PushpinClientStatus = PushpinClientState['status'];
+export type StateOf<S extends PushpinClientStatus> = Extract<PushpinClientState, {
     status: S;
 }>;
-type GT<S extends ChatClientStatus> = S extends 'disconnected' ? 'user_creating' | 'user_created' | 'conversation_creating' | 'conversation_created' : S extends 'user_creating' ? 'user_created' | 'conversation_creating' | 'conversation_created' : S extends 'user_created' ? 'conversation_creating' | 'conversation_created' : S extends 'conversation_creating' ? 'conversation_created' : never;
-type LT<S extends ChatClientStatus> = S extends 'conversation_created' ? 'conversation_creating' | 'user_created' | 'user_creating' | 'disconnected' : S extends 'conversation_creating' ? 'user_created' | 'user_creating' | 'disconnected' : S extends 'user_created' ? 'user_creating' | 'disconnected' : S extends 'user_creating' ? 'disconnected' : never;
-export declare const isEq: <S extends "disconnected" | "user_creating" | "user_created" | "conversation_creating" | "conversation_created">(s: ChatClientState, target: S) => s is StateOf<S>;
-export declare const isGt: <S extends "disconnected" | "user_creating" | "user_created" | "conversation_creating" | "conversation_created">(s: ChatClientState, target: S) => s is StateOf<GT<S>>;
-export declare const isLt: <S extends "disconnected" | "user_creating" | "user_created" | "conversation_creating" | "conversation_created">(s: ChatClientState, target: S) => s is StateOf<LT<S>>;
-export declare const isGte: <S extends "disconnected" | "user_creating" | "user_created" | "conversation_creating" | "conversation_created">(s: ChatClientState, target: S) => s is StateOf<S | GT<S>>;
-export declare const isLte: <S extends "disconnected" | "user_creating" | "user_created" | "conversation_creating" | "conversation_created">(s: ChatClientState, target: S) => s is StateOf<S | LT<S>>;
+type GT<S extends PushpinClientStatus> = S extends 'disconnected' ? 'user_creating' | 'user_created' | 'conversation_creating' | 'conversation_created' : S extends 'user_creating' ? 'user_created' | 'conversation_creating' | 'conversation_created' : S extends 'user_created' ? 'conversation_creating' | 'conversation_created' : S extends 'conversation_creating' ? 'conversation_created' : never;
+type LT<S extends PushpinClientStatus> = S extends 'conversation_created' ? 'conversation_creating' | 'user_created' | 'user_creating' | 'disconnected' : S extends 'conversation_creating' ? 'user_created' | 'user_creating' | 'disconnected' : S extends 'user_created' ? 'user_creating' | 'disconnected' : S extends 'user_creating' ? 'disconnected' : never;
+export declare const isEq: <S extends "disconnected" | "user_creating" | "user_created" | "conversation_creating" | "conversation_created">(s: PushpinClientState, target: S) => s is StateOf<S>;
+export declare const isGt: <S extends "disconnected" | "user_creating" | "user_created" | "conversation_creating" | "conversation_created">(s: PushpinClientState, target: S) => s is StateOf<GT<S>>;
+export declare const isLt: <S extends "disconnected" | "user_creating" | "user_created" | "conversation_creating" | "conversation_created">(s: PushpinClientState, target: S) => s is StateOf<LT<S>>;
+export declare const isGte: <S extends "disconnected" | "user_creating" | "user_created" | "conversation_creating" | "conversation_created">(s: PushpinClientState, target: S) => s is StateOf<S | GT<S>>;
+export declare const isLte: <S extends "disconnected" | "user_creating" | "user_created" | "conversation_creating" | "conversation_created">(s: PushpinClientState, target: S) => s is StateOf<S | LT<S>>;
 export declare class InvalidStateError extends Error {
-    readonly state: ChatClientState;
-    constructor(state: ChatClientState);
+    readonly state: PushpinClientState;
+    constructor(state: PushpinClientState);
 }
 export {};

package/dist/client/index.d.ts

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

package/dist/client/types.d.ts

@@ -16,8 +16,11 @@ export type Events = {
     message: Message;
     messageSent: string;
     error: Error;
+    webchatVisibility: 'show' | 'hide' | 'toggle';
+    webchatConfig: Record<string, any>;
+    customEvent: Record<string, any>;
 };
-export type WebChatClient = {
+export type WebchatClient = {
     clientId: string | undefined;
     userId: string | undefined;
     conversationId: string | undefined;

package/dist/components/Block.d.ts

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

package/dist/components/Composer.d.ts

@@ -2,7 +2,7 @@ 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'>) => JSX.Element>;
+declare const ComposerInput: import("react").MemoExoticComponent<({ ...props }: ComponentProps<'textarea'>) => import("react/jsx-runtime").JSX.Element>;
 type ComposerButtonStyle = NonNullable<Theme['composer']>['button'];
 type ComposerButtonProps = {
     icon?: FC<StyleOptions>;

package/dist/components/Header.d.ts

@@ -31,6 +31,6 @@ declare const HeaderNamespace: import("react").NamedExoticComponent<Omit<HeaderP
     Description: import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLParagraphElement>, HTMLParagraphElement>, "ref"> & import("react").RefAttributes<HTMLParagraphElement>>;
     Title: import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLHeadingElement>, HTMLHeadingElement>, "ref"> & import("react").RefAttributes<HTMLHeadingElement>>;
     Actions: import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & import("react").RefAttributes<HTMLDivElement>>;
-    DescriptionItem: ({ icon, title, link, ...props }: DescriptionItemProps) => JSX.Element | null;
+    DescriptionItem: ({ icon, title, link, ...props }: DescriptionItemProps) => import("react/jsx-runtime").JSX.Element | null;
 };
 export { HeaderNamespace as Header };

package/dist/components/LoadingIndicator.d.ts

@@ -1,2 +1,2 @@
 import { ComponentProps } from 'react';
-export declare const LoadingIndicator: import("react").MemoExoticComponent<({ ...props }: ComponentProps<'div'>) => JSX.Element>;
+export declare const LoadingIndicator: import("react").MemoExoticComponent<({ ...props }: ComponentProps<'div'>) => import("react/jsx-runtime").JSX.Element>;

package/dist/components/MessageList.d.ts

@@ -6,5 +6,5 @@ type MessageListProps = {
         icon?: FC<StyleOptions>;
     };
 };
-export declare const MessageList: import("react").MemoExoticComponent<({ scrollDownButton, ...props }: ComponentProps<'ul'> & MessageListProps) => JSX.Element>;
+export declare const MessageList: import("react").MemoExoticComponent<({ scrollDownButton, ...props }: ComponentProps<'ul'> & MessageListProps) => import("react/jsx-runtime").JSX.Element>;
 export {};

package/dist/components/Modal.d.ts

@@ -4,7 +4,7 @@ export declare function Modal({ open, onOpenChange, children, }: {
     open?: boolean;
     onOpenChange?: (open: boolean) => void;
     children: ReactNode;
-}): JSX.Element;
+}): import("react/jsx-runtime").JSX.Element;
 export declare namespace Modal {
     var Button: import("react").ForwardRefExoticComponent<Dialog.DialogTriggerProps & import("react").RefAttributes<HTMLButtonElement>>;
     var Close: import("react").ForwardRefExoticComponent<Dialog.DialogCloseProps & import("react").RefAttributes<HTMLButtonElement>>;
@@ -13,5 +13,5 @@ export declare namespace Modal {
 declare function ModalContent({ title, children }: {
     title: string;
     children: ReactNode;
-}): JSX.Element;
+}): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/components/RestartConversation.d.ts

@@ -1,5 +1,5 @@
 import { ArrowPathIcon } from '@heroicons/react/20/solid';
 import { ComponentProps } from 'react';
 type Props = {} & ComponentProps<typeof ArrowPathIcon>;
-export declare const RestartConversation: ({ ...props }: Props) => JSX.Element;
+export declare const RestartConversation: ({ ...props }: Props) => import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/components/Webchat.d.ts

@@ -1 +1 @@
-export declare const Webchat: () => JSX.Element;
+export declare const Webchat: () => import("react/jsx-runtime").JSX.Element;

package/dist/components/dev-tools/DevTools.d.ts

@@ -1 +1 @@
-export declare const DevTools: () => JSX.Element;
+export declare const DevTools: () => import("react/jsx-runtime").JSX.Element;

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

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

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

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

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

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

package/dist/contexts/WebchatContext.d.ts

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