@botpress/webchat 0.5.1 → 1.0.0

package/dist/components/RestartConversation.d.ts

@@ -0,0 +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 {};

package/dist/components/Webchat.d.ts

@@ -0,0 +1,6 @@
+import { Configuration } from '../contexts';
+type Props = {
+    configuration: Configuration;
+};
+export declare const Webchat: ({ configuration }: Props) => JSX.Element;
+export {};

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

@@ -0,0 +1 @@
+export declare const DevTools: () => JSX.Element;

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

@@ -0,0 +1,2 @@
+import { Configuration } from '../../contexts';
+export declare const defaultConfiguration: Configuration;

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

@@ -0,0 +1,5 @@
+import { BlockObject, MessageObject } from '../../types';
+type Direction = 'incoming' | 'outgoing' | 'system';
+export declare function messageInBubble(block: BlockObject, direction?: Direction): MessageObject;
+export declare function splitCamelCase(text: string): string;
+export {};

package/dist/components/index.d.ts

@@ -0,0 +1,12 @@
+export * from './Avatar';
+export * from './Block';
+export * from './Composer';
+export * from './Container';
+export * from './Header';
+export * from './LoadingIndicator';
+export * from './Message';
+export * from './MessageList';
+export * from './Modal';
+export * from './RestartConversation';
+export * from './Webchat';
+export * from './renderers';

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

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

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

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

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

@@ -0,0 +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 {};

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

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

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

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

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

@@ -0,0 +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 {};

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,2 @@
+import { Renderers } from '../../contexts';
+export declare const renderers: Renderers;

package/dist/contexts/ComposerContext.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+type ComposerContextValue = {
+    value: string;
+    setValue: (value: string) => void;
+};
+export declare const ComposerContext: import("react").Context<ComposerContextValue | null>;
+export declare function useComposerContext(): ComposerContextValue;
+export {};

package/dist/contexts/MessageContext.d.ts

@@ -0,0 +1,8 @@
+import { Dispatch, SetStateAction } from 'react';
+type MessageContextVaue = {
+    isLoading: string[];
+    setIsLoading: Dispatch<SetStateAction<string[]>>;
+};
+export declare const MessageContext: import("react").Context<MessageContextVaue | null>;
+export declare function useMessageContext(): MessageContextVaue;
+export {};

package/dist/contexts/ModalContext.d.ts

@@ -0,0 +1,14 @@
+import { ReactNode } from 'react';
+type ModalContextVaue = {
+    open: boolean;
+    showModal: (props: {
+        title: string;
+        content: ReactNode;
+    }) => void;
+    hideModal: () => void;
+    title: string;
+    content: ReactNode | null;
+};
+export declare const ModalContext: import("react").Context<ModalContextVaue | null>;
+export declare function useModalContext(): ModalContextVaue;
+export {};

package/dist/contexts/WebchatContext.d.ts

@@ -0,0 +1,56 @@
+import { CSSProperties, FC, ReactNode } from 'react';
+import type { BlockObject, BlockStyles, MessageObject } from '../types';
+import { EventEmitter, Events } from '../Utils';
+import { Theme } from '../schemas';
+import { type WebchatClient } from '../client';
+export type StyleOptions = {
+    className?: string;
+    style?: CSSProperties;
+};
+type DescriptionItem = {
+    title: string;
+    link?: string;
+};
+export type Configuration = {
+    composerPlaceholder?: string;
+    botName?: string;
+    botAvatar?: string;
+    botDescription?: string;
+    website?: DescriptionItem;
+    email?: DescriptionItem;
+    phone?: DescriptionItem;
+    privacyPolicy?: DescriptionItem;
+    termsOfService?: DescriptionItem;
+};
+export type Renderers<P extends BlockObject = BlockObject> = {
+    [T in P['type']]: FC<Extract<P, {
+        type: T;
+    }> & {
+        styles: BlockStyles;
+    }>;
+};
+export type ModalProps = {
+    title: string | null;
+    content: ReactNode | null;
+};
+type ContextVaue = {
+    theme: Theme;
+    renderers: Renderers;
+    messages: MessageObject[];
+    eventEmitter: EventEmitter<Events>;
+    configuration: Configuration;
+    setConfiguration: React.Dispatch<React.SetStateAction<Configuration>>;
+    state: {
+        disableComposer: boolean;
+    };
+    client: {
+        on: WebchatClient['on'];
+        sendMessage: WebchatClient['sendMessage'];
+        restartConversation: () => void;
+    };
+    setState: (state: Partial<ContextVaue['state']>) => void;
+    setTheme: (styles: Partial<Theme>) => void;
+};
+export declare const WebchatContext: import("react").Context<ContextVaue | null>;
+export declare function useWebchatContext(): ContextVaue;
+export {};

package/dist/contexts/index.d.ts

@@ -0,0 +1,4 @@
+export * from './ComposerContext';
+export * from './MessageContext';
+export * from './ModalContext';
+export * from './WebchatContext';

package/dist/hooks/index.d.ts

@@ -0,0 +1,3 @@
+export * from './useImageSize';
+export * from './useWebchatStore';
+export * from './useRefresh.ts';

package/dist/hooks/useImageSize.d.ts

@@ -0,0 +1,2 @@
+import { Options, UseImageSizeResult } from '../types';
+export declare const useImageSize: (url: string, options?: Options) => UseImageSizeResult;

package/dist/hooks/useRefresh.d.ts

@@ -0,0 +1,10 @@
+export declare const defaultGetRefreshTime: (expiresAt: Date) => number;
+/**
+ * Utility hooks to force a state fresh based on a date
+ * @example
+ * const [onRefresh, setDate] = useDateRefresh()
+ * useEffect(() => {}, [onRefresh])
+ * setDate(futureDate) // The refresh function will trigger when the date passes
+ * @returns value to observe for refreshing and a function that set the refresh date
+ */
+export declare const useRefresh: (getRefreshTimeInMs?: (expiresAt: Date) => number) => [number, (date: Date) => void];

package/dist/hooks/useWebchatStore.d.ts

@@ -0,0 +1,30 @@
+import { UserCredentials } from '@botpress/messaging-socket';
+type WebchatState = {
+    messageHistory: {
+        [key: string]: string[];
+    };
+    user?: UserCredentials;
+    conversationId?: string;
+    addMessageToHistory: (props: {
+        userId: string;
+        message: string;
+    }) => void;
+    setUser: (userId?: UserCredentials) => void;
+    setConversationId: (conversationId?: string) => void;
+};
+export declare const useWebchatStore: import("zustand").UseBoundStore<Omit<Omit<import("zustand").StoreApi<WebchatState>, "setState"> & {
+    setState<A extends string | {
+        type: unknown;
+    }>(partial: WebchatState | Partial<WebchatState> | ((state: WebchatState) => WebchatState | Partial<WebchatState>), replace?: boolean | undefined, action?: A | undefined): void;
+}, "persist"> & {
+    persist: {
+        setOptions: (options: Partial<import("zustand/middleware").PersistOptions<WebchatState, WebchatState>>) => void;
+        clearStorage: () => void;
+        rehydrate: () => void | Promise<void>;
+        hasHydrated: () => boolean;
+        onHydrate: (fn: (state: WebchatState) => void) => () => void;
+        onFinishHydration: (fn: (state: WebchatState) => void) => () => void;
+        getOptions: () => Partial<import("zustand/middleware").PersistOptions<WebchatState, WebchatState>>;
+    };
+}>;
+export {};

package/dist/index.d.ts

@@ -1,17 +1,3 @@
-import React from 'react';
-import { RootStore } from './store';
-import { Config } from './typings';
-interface State {
-    store: RootStore;
-}
-interface Props {
-    config?: Config;
-    fullscreen?: boolean;
-}
-export declare class ExposedWebChat extends React.Component<Props, State> {
-    constructor(props: Props);
-    render(): JSX.Element;
-}
-export declare const Embedded: (props: Props) => ExposedWebChat;
-export declare const Fullscreen: (props: Props) => ExposedWebChat;
-export * from './typings';
+export * from './components';
+export * from './providers';
+export * from './types';