@enjoys/react-chatbot-plugin 1.2.0 → 1.4.0

package/dist/index.d.ts

@@ -4446,6 +4446,16 @@ export declare interface ChatBotProps {
     components?: Record<string, ComponentType<StepComponentProps>>;
     /** Map of async action handlers (key = step.asyncAction.handler) */
     actionHandlers?: Record<string, (data: Record<string, unknown>, ctx: ActionContext) => Promise<FlowActionResult>>;
+    /** Override built-in form field renderers per field type. Each renderer receives strongly-typed props + the default element. */
+    renderFormField?: FormFieldRenderMap;
+    /** Fallback message when user types text with no active flow or unmatched input */
+    fallbackMessage?: string | ((text: string) => string | null);
+    /** Keyword routes — match user text to responses or flow steps */
+    keywords?: KeywordRoute[];
+    /** Convenience: auto-respond to common greetings (hello, hi, hey, etc.) */
+    greetingResponse?: string;
+    /** Typing delay in ms before bot sends keyword/fallback replies (default: 0) */
+    typingDelay?: number;
 }
 
 export declare const ChatBubbleIcon: default_2.FC<IconProps>;
@@ -4463,6 +4473,10 @@ export declare interface ChatCallbacks {
     onFlowEnd?: (collectedData: Record<string, unknown>) => void;
     onError?: (error: Error) => void;
     onEvent?: (event: string, payload?: unknown) => void;
+    /** Called when user types text the bot couldn't handle */
+    onUnhandledMessage?: (text: string, context: {
+        currentStepId: string | null;
+    }) => void;
 }
 
 export declare const ChatContext: Context<ChatContextValue | null>;
@@ -4471,6 +4485,7 @@ declare interface ChatContextValue {
     state: ChatState;
     dispatch: React.Dispatch<ChatAction>;
     props: ChatBotProps;
+    pluginManager?: PluginManager | null;
 }
 
 export declare const ChatHeader: default_2.FC<ChatHeaderProps>;
@@ -4604,6 +4619,15 @@ declare interface CheckboxFieldProps {
     error?: string;
 }
 
+/** Props passed to checkbox custom field renderers */
+export declare interface CheckboxFieldRenderProps {
+    type: 'checkbox';
+    field: FormFieldConfig;
+    value: string[];
+    onChange: (value: string[]) => void;
+    error?: string;
+}
+
 export declare const CloseIcon: default_2.FC<IconProps>;
 
 export declare const DynamicForm: default_2.FC<DynamicFormProps>;
@@ -4612,6 +4636,7 @@ declare interface DynamicFormProps {
     config: FormConfig;
     onSubmit: (data: Record<string, unknown>) => void;
     primaryColor: string;
+    renderFormField?: FormFieldRenderMap;
 }
 
 export declare const EmojiIcon: default_2.FC<IconProps>;
@@ -4624,6 +4649,16 @@ declare interface EmojiPickerProps {
     primaryColor: string;
 }
 
+/** Props passed to file custom field renderers */
+export declare interface FileFieldRenderProps {
+    type: 'file';
+    field: FormFieldConfig;
+    value: FileList | null;
+    onChange: (value: FileList | null) => void;
+    error?: string;
+    primaryColor: string;
+}
+
 export declare const FileIcon: default_2.FC<IconProps>;
 
 export declare const FilePreviewList: default_2.FC<FilePreviewListProps>;
@@ -4761,10 +4796,22 @@ export declare interface FlowStep {
     condition?: FlowCondition;
     /** Key into ChatBotProps.components — renders a custom React component in this step */
     component?: string;
+    /** Free-text input configuration — validates user input before advancing */
+    input?: FlowStepInput;
     /** Async action to run when this step is entered (API calls, verification, etc.) */
     asyncAction?: FlowAsyncAction;
 }
 
+/** Configuration for a free-text input step with optional validation */
+export declare interface FlowStepInput {
+    /** Placeholder text for the input */
+    placeholder?: string;
+    /** Validation rules (reuses form validation) */
+    validation?: FormFieldValidation;
+    /** Transform user input before storing */
+    transform?: 'lowercase' | 'uppercase' | 'trim' | 'email';
+}
+
 export declare interface FormConfig {
     id: string;
     title?: string;
@@ -4791,9 +4838,31 @@ export declare interface FormFieldOption {
     value: string;
 }
 
+/** Map of field type → custom renderer. The renderer receives strongly-typed props + the default element. */
+export declare type FormFieldRenderMap = Partial<{
+    text: (props: TextFieldRenderProps, defaultElement: React.ReactNode) => React.ReactNode;
+    email: (props: TextFieldRenderProps, defaultElement: React.ReactNode) => React.ReactNode;
+    password: (props: TextFieldRenderProps, defaultElement: React.ReactNode) => React.ReactNode;
+    number: (props: TextFieldRenderProps, defaultElement: React.ReactNode) => React.ReactNode;
+    tel: (props: TextFieldRenderProps, defaultElement: React.ReactNode) => React.ReactNode;
+    url: (props: TextFieldRenderProps, defaultElement: React.ReactNode) => React.ReactNode;
+    textarea: (props: TextFieldRenderProps, defaultElement: React.ReactNode) => React.ReactNode;
+    date: (props: TextFieldRenderProps, defaultElement: React.ReactNode) => React.ReactNode;
+    time: (props: TextFieldRenderProps, defaultElement: React.ReactNode) => React.ReactNode;
+    select: (props: SelectFieldRenderProps, defaultElement: React.ReactNode) => React.ReactNode;
+    multiselect: (props: SelectFieldRenderProps, defaultElement: React.ReactNode) => React.ReactNode;
+    radio: (props: RadioFieldRenderProps, defaultElement: React.ReactNode) => React.ReactNode;
+    checkbox: (props: CheckboxFieldRenderProps, defaultElement: React.ReactNode) => React.ReactNode;
+    file: (props: FileFieldRenderProps, defaultElement: React.ReactNode) => React.ReactNode;
+}>;
+
+/** Union of all field render props — discriminated by `type` */
+export declare type FormFieldRenderProps = TextFieldRenderProps | SelectFieldRenderProps | RadioFieldRenderProps | CheckboxFieldRenderProps | FileFieldRenderProps;
+
 export declare type FormFieldType = 'text' | 'email' | 'password' | 'number' | 'tel' | 'url' | 'textarea' | 'select' | 'multiselect' | 'radio' | 'checkbox' | 'file' | 'date' | 'time' | 'hidden';
 
 export declare interface FormFieldValidation {
+    required?: boolean;
     pattern?: string;
     minLength?: number;
     maxLength?: number;
@@ -4820,6 +4889,22 @@ declare interface IconProps {
 
 export declare const ImageIcon: default_2.FC<IconProps>;
 
+/** Route configuration for keyword-based text matching */
+export declare interface KeywordRoute {
+    /** Patterns to match against user text */
+    patterns: string[];
+    /** Bot response message when matched */
+    response?: string;
+    /** Jump to this flow step when matched */
+    next?: string;
+    /** Case-sensitive matching (default: false) */
+    caseSensitive?: boolean;
+    /** Matching strategy (default: 'contains') */
+    matchType?: 'exact' | 'contains' | 'startsWith' | 'regex';
+    /** Priority — higher wins when multiple routes match (default: 0) */
+    priority?: number;
+}
+
 export declare const Launcher: default_2.FC<LauncherProps>;
 
 declare interface LauncherProps {
@@ -4838,6 +4923,7 @@ declare interface LoginScreenProps {
     config: FormConfig;
     onLogin: (data: Record<string, unknown>) => void;
     primaryColor: string;
+    renderFormField?: FormFieldRenderMap;
 }
 
 export declare interface MessageAttachment {
@@ -4872,6 +4958,8 @@ declare interface MessageListProps {
     collectedData?: Record<string, unknown>;
     /** Current step ID */
     currentStepId?: string | null;
+    /** Custom form field renderers per field type */
+    renderFormField?: FormFieldRenderMap;
 }
 
 export declare type MessageSender = 'bot' | 'user' | 'system';
@@ -4939,6 +5027,15 @@ declare interface RadioFieldProps {
     error?: string;
 }
 
+/** Props passed to radio custom field renderers */
+export declare interface RadioFieldRenderProps {
+    type: 'radio';
+    field: FormFieldConfig;
+    value: string;
+    onChange: (value: string) => void;
+    error?: string;
+}
+
 export declare const RemoveIcon: default_2.FC<IconProps>;
 
 export declare function resolveTheme(theme?: ChatTheme): Required<ChatTheme>;
@@ -4954,6 +5051,15 @@ declare interface SelectFieldProps {
     error?: string;
 }
 
+/** Props passed to select/multiselect custom field renderers */
+export declare interface SelectFieldRenderProps {
+    type: 'select' | 'multiselect';
+    field: FormFieldConfig;
+    value: string | string[];
+    onChange: (value: string | string[]) => void;
+    error?: string;
+}
+
 export declare const SendIcon: default_2.FC<IconProps>;
 
 /** Props passed to custom components rendered in flow steps */
@@ -4975,6 +5081,15 @@ declare interface TextFieldProps {
     error?: string;
 }
 
+/** Props passed to text-like custom field renderers */
+export declare interface TextFieldRenderProps {
+    type: 'text' | 'email' | 'password' | 'number' | 'tel' | 'url' | 'textarea' | 'date' | 'time';
+    field: FormFieldConfig;
+    value: string;
+    onChange: (value: string) => void;
+    error?: string;
+}
+
 export declare const TypingIndicator: default_2.FC<TypingIndicatorProps>;
 
 declare interface TypingIndicatorProps {
@@ -4983,7 +5098,7 @@ declare interface TypingIndicatorProps {
 
 export declare function useChat(): {
     state: ChatState;
-    sendMessage: (text: string) => void;
+    sendMessage: (text: string) => Promise<void>;
     addBotMessage: (text: string, extras?: Partial<ChatMessage>) => Promise<void>;
     handleQuickReply: (value: string, label: string) => void;
     handleFormSubmit: (formId: string, data: Record<string, unknown>) => Promise<void>;