@algolia/satellite 2.2.2 → 2.3.0-rc.1

package/dist/esm/Layout/Chat/ChatMessageLoader/ChatMessageLoader.styles.d.ts

@@ -0,0 +1,200 @@
+export declare const chatMessageLoaderStyles: import("tailwind-variants").TVReturnType<{
+    [key: string]: {
+        [key: string]: import("tailwind-merge").ClassNameValue | {
+            content?: import("tailwind-merge").ClassNameValue;
+            message?: import("tailwind-merge").ClassNameValue;
+            skeletonWrapper?: import("tailwind-merge").ClassNameValue;
+            skeleton?: import("tailwind-merge").ClassNameValue;
+        };
+    };
+} | {
+    variant: {
+        neutral: import("tailwind-merge").ClassNameValue | {
+            content?: import("tailwind-merge").ClassNameValue;
+            message?: import("tailwind-merge").ClassNameValue;
+            skeletonWrapper?: import("tailwind-merge").ClassNameValue;
+            skeleton?: import("tailwind-merge").ClassNameValue;
+        };
+        subtle: import("tailwind-merge").ClassNameValue | {
+            content?: import("tailwind-merge").ClassNameValue;
+            message?: import("tailwind-merge").ClassNameValue;
+            skeletonWrapper?: import("tailwind-merge").ClassNameValue;
+            skeleton?: import("tailwind-merge").ClassNameValue;
+        };
+    };
+    side: {
+        left: import("tailwind-merge").ClassNameValue | {
+            content?: import("tailwind-merge").ClassNameValue;
+            message?: import("tailwind-merge").ClassNameValue;
+            skeletonWrapper?: import("tailwind-merge").ClassNameValue;
+            skeleton?: import("tailwind-merge").ClassNameValue;
+        };
+        right: import("tailwind-merge").ClassNameValue | {
+            content?: import("tailwind-merge").ClassNameValue;
+            message?: import("tailwind-merge").ClassNameValue;
+            skeletonWrapper?: import("tailwind-merge").ClassNameValue;
+            skeleton?: import("tailwind-merge").ClassNameValue;
+        };
+    };
+    leading: {
+        true: import("tailwind-merge").ClassNameValue | {
+            content?: import("tailwind-merge").ClassNameValue;
+            message?: import("tailwind-merge").ClassNameValue;
+            skeletonWrapper?: import("tailwind-merge").ClassNameValue;
+            skeleton?: import("tailwind-merge").ClassNameValue;
+        };
+    };
+    actions: {
+        true: import("tailwind-merge").ClassNameValue | {
+            content?: import("tailwind-merge").ClassNameValue;
+            message?: import("tailwind-merge").ClassNameValue;
+            skeletonWrapper?: import("tailwind-merge").ClassNameValue;
+            skeleton?: import("tailwind-merge").ClassNameValue;
+        };
+    };
+    autoHideActions: {
+        true: import("tailwind-merge").ClassNameValue | {
+            content?: import("tailwind-merge").ClassNameValue;
+            message?: import("tailwind-merge").ClassNameValue;
+            skeletonWrapper?: import("tailwind-merge").ClassNameValue;
+            skeleton?: import("tailwind-merge").ClassNameValue;
+        };
+    };
+}, {
+    content: string;
+    message: string;
+    skeletonWrapper: string;
+    skeleton: string;
+}, undefined, {
+    variant: {
+        neutral: {
+            message: string;
+        };
+        subtle: {
+            message: string;
+        };
+    };
+    side: {
+        left: {
+            container: string;
+        };
+        right: {
+            container: string;
+        };
+    };
+    leading: {
+        true: string;
+    };
+    actions: {
+        true: string;
+    };
+    autoHideActions: {
+        true: string;
+    };
+}, {
+    base: string;
+    container: string;
+    leading: string;
+    content: string;
+    message: string;
+    actions: string;
+}, import("tailwind-variants").TVReturnType<{
+    variant: {
+        neutral: {
+            message: string;
+        };
+        subtle: {
+            message: string;
+        };
+    };
+    side: {
+        left: {
+            container: string;
+        };
+        right: {
+            container: string;
+        };
+    };
+    leading: {
+        true: string;
+    };
+    actions: {
+        true: string;
+    };
+    autoHideActions: {
+        true: string;
+    };
+}, {
+    base: string;
+    container: string;
+    leading: string;
+    content: string;
+    message: string;
+    actions: string;
+}, undefined, {
+    variant: {
+        neutral: {
+            message: string;
+        };
+        subtle: {
+            message: string;
+        };
+    };
+    side: {
+        left: {
+            container: string;
+        };
+        right: {
+            container: string;
+        };
+    };
+    leading: {
+        true: string;
+    };
+    actions: {
+        true: string;
+    };
+    autoHideActions: {
+        true: string;
+    };
+}, {
+    base: string;
+    container: string;
+    leading: string;
+    content: string;
+    message: string;
+    actions: string;
+}, import("tailwind-variants").TVReturnType<{
+    variant: {
+        neutral: {
+            message: string;
+        };
+        subtle: {
+            message: string;
+        };
+    };
+    side: {
+        left: {
+            container: string;
+        };
+        right: {
+            container: string;
+        };
+    };
+    leading: {
+        true: string;
+    };
+    actions: {
+        true: string;
+    };
+    autoHideActions: {
+        true: string;
+    };
+}, {
+    base: string;
+    container: string;
+    leading: string;
+    content: string;
+    message: string;
+    actions: string;
+}, undefined, unknown, unknown, undefined>>>;

package/dist/esm/Layout/Chat/ChatMessageLoader/ChatMessageLoader.styles.js

@@ -0,0 +1,14 @@
+import _taggedTemplateLiteral from "@babel/runtime/helpers/taggedTemplateLiteral";
+var _templateObject, _templateObject2, _templateObject3, _templateObject4;
+import { chatMessageStyles } from "./../ChatMessage/ChatMessage.styles";
+import stl from "./../../../styles/helpers/satellitePrefixer";
+import { tv } from "./../../../styles/helpers/tv";
+export var chatMessageLoaderStyles = tv({
+  extend: chatMessageStyles,
+  slots: {
+    content: stl(_templateObject || (_templateObject = _taggedTemplateLiteral(["w-full"]))),
+    message: stl(_templateObject2 || (_templateObject2 = _taggedTemplateLiteral(["flex flex-col gap-2 typo-subdued"]))),
+    skeletonWrapper: stl(_templateObject3 || (_templateObject3 = _taggedTemplateLiteral(["flex flex-col gap-1"]))),
+    skeleton: stl(_templateObject4 || (_templateObject4 = _taggedTemplateLiteral(["h-4"])))
+  }
+});

package/dist/esm/Layout/Chat/ChatMessageLoader/index.d.ts

@@ -0,0 +1 @@
+export * from "./ChatMessageLoader";

package/dist/esm/Layout/Chat/ChatMessageLoader/index.js

@@ -0,0 +1 @@
+export * from "./ChatMessageLoader";

package/dist/esm/Layout/Chat/ChatMessages/ChatMessages.d.ts

@@ -0,0 +1,42 @@
+import type { HTMLAttributes, ReactElement, ReactNode, Ref } from "react";
+import type { ChatMessageProps } from "../../../Layout/Chat/ChatMessage";
+import type { ChatMessageErrorProps } from "../../../Layout/Chat/ChatMessageError";
+import type { ChatMessageLoaderProps } from "../../../Layout/Chat/ChatMessageLoader";
+import type { ChatMessageBase, ChatStatus } from "../../../Layout/Chat/types";
+export declare type ChatMessageLocale = {
+    scrollToBottomText?: string;
+};
+export declare type ChatMessagesProps<Message extends ChatMessageBase = ChatMessageBase> = Omit<HTMLAttributes<HTMLDivElement>, "children"> & {
+    messages: Message[];
+    userMessageProps?: Omit<ChatMessageProps<Message>, "content">;
+    assistantMessageProps?: Omit<ChatMessageProps<Message>, "content">;
+    loaderProps?: ChatMessageLoaderProps;
+    errorProps?: Omit<ChatMessageErrorProps, "onReload">;
+    renderMessage?: (message: Message) => ReactNode;
+    renderLoader?: ReactNode;
+    renderError?: ReactNode;
+    status?: ChatStatus;
+    onReload?: () => void;
+    hideScrollToBottom?: boolean;
+    scrollClassName?: string;
+    contentClassName?: string;
+    locale?: ChatMessageLocale;
+};
+export declare const ChatMessages: <Message extends ChatMessageBase = ChatMessageBase>(props: Omit<HTMLAttributes<HTMLDivElement>, "children"> & {
+    messages: Message[];
+    userMessageProps?: Omit<ChatMessageProps<Message>, "content"> | undefined;
+    assistantMessageProps?: Omit<ChatMessageProps<Message>, "content"> | undefined;
+    loaderProps?: ChatMessageLoaderProps | undefined;
+    errorProps?: Omit<ChatMessageErrorProps, "onReload"> | undefined;
+    renderMessage?: ((message: Message) => ReactNode) | undefined;
+    renderLoader?: ReactNode;
+    renderError?: ReactNode;
+    status?: ChatStatus | undefined;
+    onReload?: (() => void) | undefined;
+    hideScrollToBottom?: boolean | undefined;
+    scrollClassName?: string | undefined;
+    contentClassName?: string | undefined;
+    locale?: ChatMessageLocale | undefined;
+} & {
+    ref?: Ref<HTMLDivElement> | undefined;
+}) => ReactElement | null;

package/dist/esm/Layout/Chat/ChatMessages/ChatMessages.js

@@ -0,0 +1,119 @@
+import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["messages", "userMessageProps", "assistantMessageProps", "loaderProps", "errorProps", "renderMessage", "renderLoader", "renderError", "status", "onReload", "hideScrollToBottom", "className", "scrollClassName", "contentClassName", "locale"];
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+import { ChevronDownIcon } from "lucide-react";
+import { useEffect } from "react";
+import { useRef, useState } from "react";
+import { forwardRef } from "react";
+import { useStickToBottom } from "use-stick-to-bottom";
+import { chatMessagesStyles } from "./ChatMessages.styles";
+import { useLastMessageHeight } from "./useLastMessageHeight";
+import { IconButton } from "./../../../Actions";
+import { ChatMessage } from "./../ChatMessage";
+import { ChatMessageError } from "./../ChatMessageError";
+import { ChatMessageLoader } from "./../ChatMessageLoader";
+import { useLocale } from "./../../../Satellite";
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+var DEFAULT_CHAT_MESSAGE_LOCALE = {
+  scrollToBottomText: "Scroll to bottom"
+};
+var ChatMessagesBase = function ChatMessagesBase(_ref, forwardedRef) {
+  var messages = _ref.messages,
+    userMessageProps = _ref.userMessageProps,
+    assistantMessageProps = _ref.assistantMessageProps,
+    loaderProps = _ref.loaderProps,
+    errorProps = _ref.errorProps,
+    renderMessage = _ref.renderMessage,
+    renderLoader = _ref.renderLoader,
+    renderError = _ref.renderError,
+    status = _ref.status,
+    onReload = _ref.onReload,
+    _ref$hideScrollToBott = _ref.hideScrollToBottom,
+    hideScrollToBottom = _ref$hideScrollToBott === void 0 ? false : _ref$hideScrollToBott,
+    className = _ref.className,
+    scrollClassName = _ref.scrollClassName,
+    contentClassName = _ref.contentClassName,
+    propsLocale = _ref.locale,
+    props = _objectWithoutProperties(_ref, _excluded);
+  var contextLocale = useLocale("chatMessage");
+  var locale = _objectSpread(_objectSpread(_objectSpread({}, DEFAULT_CHAT_MESSAGE_LOCALE), contextLocale), propsLocale);
+  var _useStickToBottom = useStickToBottom({
+      resize: "smooth",
+      initial: "smooth"
+    }),
+    scrollRef = _useStickToBottom.scrollRef,
+    contentRef = _useStickToBottom.contentRef,
+    isAtBottom = _useStickToBottom.isAtBottom,
+    scrollToBottom = _useStickToBottom.scrollToBottom;
+  var styles = chatMessagesStyles();
+  var messageRefs = useRef(new Map());
+  var _useState = useState(false),
+    _useState2 = _slicedToArray(_useState, 2),
+    lastMessageSubmitted = _useState2[0],
+    setLastMessageSubmitted = _useState2[1];
+  var lastUserMessage = _toConsumableArray(messages).reverse().find(function (m) {
+    return m.role === "user";
+  });
+  var lastUserMessageEl = lastUserMessage ? messageRefs.current.get(lastUserMessage.id) : undefined;
+  var lastMessageHeight = useLastMessageHeight(scrollRef, messages, lastUserMessageEl, lastMessageSubmitted, 24);
+  useEffect(function () {
+    if (status !== "submitted" || !lastUserMessage) {
+      return;
+    }
+    setLastMessageSubmitted(true);
+  }, [status, messages, lastUserMessage]);
+  return /*#__PURE__*/_jsxs("div", _objectSpread(_objectSpread({}, props), {}, {
+    ref: forwardedRef,
+    className: styles.base({
+      className: className
+    }),
+    children: [/*#__PURE__*/_jsx("div", {
+      ref: scrollRef,
+      className: styles.scroll({
+        className: scrollClassName
+      }),
+      children: /*#__PURE__*/_jsxs("div", {
+        ref: contentRef,
+        className: styles.content({
+          className: contentClassName
+        }),
+        style: {
+          "--last-message-height": "".concat(lastMessageHeight, "px")
+        },
+        children: [messages.map(function (message) {
+          var isAssistant = message.role === "assistant";
+          return /*#__PURE__*/_jsx(ChatMessage, _objectSpread(_objectSpread({
+            ref: function ref(el) {
+              if (el) messageRefs.current.set(message.id, el);else messageRefs.current["delete"](message.id);
+            },
+            side: isAssistant ? "left" : "right",
+            variant: isAssistant ? "subtle" : "neutral",
+            content: renderMessage ? renderMessage(message) : message.content
+          }, isAssistant ? assistantMessageProps : userMessageProps), {}, {
+            "data-role": message.role,
+            actionsExtraData: message,
+            "data-key": message.id
+          }), message.id);
+        }), status === "submitted" && (renderLoader !== null && renderLoader !== void 0 ? renderLoader : /*#__PURE__*/_jsx(ChatMessageLoader, _objectSpread({}, loaderProps))), status === "error" && (renderError !== null && renderError !== void 0 ? renderError : /*#__PURE__*/_jsx(ChatMessageError, _objectSpread(_objectSpread({}, errorProps), {}, {
+          onReload: onReload
+        })))]
+      })
+    }), !hideScrollToBottom && /*#__PURE__*/_jsx(IconButton, {
+      icon: ChevronDownIcon,
+      title: locale.scrollToBottomText,
+      size: "small",
+      onClick: function onClick() {
+        return scrollToBottom();
+      },
+      className: styles.scrollToBottom({
+        isAtBottom: isAtBottom
+      }),
+      tooltipHideDelay: 0
+    })]
+  }));
+};
+export var ChatMessages = /*#__PURE__*/forwardRef(ChatMessagesBase);

package/dist/esm/Layout/Chat/ChatMessages/ChatMessages.styles.d.ts

@@ -0,0 +1,43 @@
+export declare const chatMessagesStyles: import("tailwind-variants").TVReturnType<{
+    isAtBottom: {
+        true: {
+            scrollToBottom: string;
+        };
+        false: {
+            scrollToBottom: string;
+        };
+    };
+}, {
+    base: string;
+    scroll: string;
+    content: string;
+    scrollToBottom: string;
+}, undefined, {
+    isAtBottom: {
+        true: {
+            scrollToBottom: string;
+        };
+        false: {
+            scrollToBottom: string;
+        };
+    };
+}, {
+    base: string;
+    scroll: string;
+    content: string;
+    scrollToBottom: string;
+}, import("tailwind-variants").TVReturnType<{
+    isAtBottom: {
+        true: {
+            scrollToBottom: string;
+        };
+        false: {
+            scrollToBottom: string;
+        };
+    };
+}, {
+    base: string;
+    scroll: string;
+    content: string;
+    scrollToBottom: string;
+}, undefined, unknown, unknown, undefined>>;

package/dist/esm/Layout/Chat/ChatMessages/ChatMessages.styles.js

@@ -0,0 +1,22 @@
+import _taggedTemplateLiteral from "@babel/runtime/helpers/taggedTemplateLiteral";
+var _templateObject, _templateObject2, _templateObject3, _templateObject4, _templateObject5, _templateObject6;
+import stl from "./../../../styles/helpers/satellitePrefixer";
+import { tv } from "./../../../styles/helpers/tv";
+export var chatMessagesStyles = tv({
+  slots: {
+    base: stl(_templateObject || (_templateObject = _taggedTemplateLiteral(["relative flex flex-col overflow-hidden h-full"]))),
+    scroll: stl(_templateObject2 || (_templateObject2 = _taggedTemplateLiteral(["overflow-y-auto overflow-x-hidden thin-scrollbar size-full"]))),
+    content: stl(_templateObject3 || (_templateObject3 = _taggedTemplateLiteral(["flex flex-col gap-6 w-full flex-1 [&>article:last-of-type]:min-h-[var(--last-message-height)]"]))),
+    scrollToBottom: stl(_templateObject4 || (_templateObject4 = _taggedTemplateLiteral(["absolute bottom-4 left-1/2 -translate-x-1/2 transition-[transform,opacity] duration-300 ease-out"])))
+  },
+  variants: {
+    isAtBottom: {
+      "true": {
+        scrollToBottom: stl(_templateObject5 || (_templateObject5 = _taggedTemplateLiteral(["pointer-events-none translate-y-4 scale-95 opacity-0"])))
+      },
+      "false": {
+        scrollToBottom: stl(_templateObject6 || (_templateObject6 = _taggedTemplateLiteral(["translate-y-0 scale-100 opacity-100"])))
+      }
+    }
+  }
+});

package/dist/esm/Layout/Chat/ChatMessages/index.d.ts

@@ -0,0 +1 @@
+export * from "./ChatMessages";

package/dist/esm/Layout/Chat/ChatMessages/index.js

@@ -0,0 +1 @@
+export * from "./ChatMessages";

package/dist/esm/Layout/Chat/ChatMessages/useLastMessageHeight.d.ts

@@ -0,0 +1,10 @@
+import type { RefObject } from "react";
+/**
+ * React hook to compute the “fill” height below the last user message,
+ * based on the scroll container’s height, the last user‐message element’s height,
+ * and any CSS gap/padding offsets.
+ */
+export declare function useLastMessageHeight(scrollRef: RefObject<HTMLElement>, messages: Array<{
+    id: string;
+    role: string;
+}>, lastUserMessageEl: HTMLElement | undefined, lastMessageSubmitted: boolean, spacingOffset?: number): number;

package/dist/esm/Layout/Chat/ChatMessages/useLastMessageHeight.js

@@ -0,0 +1,41 @@
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import { useLayoutEffect, useState } from "react";
+
+/**
+ * React hook to compute the “fill” height below the last user message,
+ * based on the scroll container’s height, the last user‐message element’s height,
+ * and any CSS gap/padding offsets.
+ */
+export function useLastMessageHeight(scrollRef, messages, lastUserMessageEl, lastMessageSubmitted) {
+  var spacingOffset = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : 0;
+  var _useState = useState(0),
+    _useState2 = _slicedToArray(_useState, 2),
+    lastMessageHeight = _useState2[0],
+    setLastMessageHeight = _useState2[1];
+  var updateLastMessageHeight = function updateLastMessageHeight() {
+    var scrollEl = scrollRef.current;
+    if (!scrollEl || messages.length === 0 || !lastMessageSubmitted || !lastUserMessageEl) return;
+
+    // Measure parent/container height
+    var parentHeight = scrollEl.clientHeight;
+
+    // Compute any CSS gap/rowGap/padding offsets by reading computed style
+    var computed = window.getComputedStyle(scrollEl);
+    var rowGapValue = parseFloat(computed.rowGap) || parseFloat(computed.gap) || 0;
+    var paddingTop = parseFloat(computed.paddingTop) || 0;
+    var paddingBottom = parseFloat(computed.paddingBottom) || 0;
+    var totalOffset = spacingOffset + rowGapValue + paddingTop + paddingBottom;
+
+    // The “remaining” height is parentHeight − lastMsgElem.offsetHeight − totalOffset
+    var remaining = parentHeight - lastUserMessageEl.offsetHeight - totalOffset;
+    setLastMessageHeight(Math.max(remaining, 0));
+  };
+
+  // Recompute whenever messages change and a new user message has just been submitted
+  useLayoutEffect(function () {
+    if (!lastMessageSubmitted) return;
+    updateLastMessageHeight();
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [messages, lastMessageSubmitted]);
+  return lastMessageHeight;
+}

package/dist/esm/Layout/Chat/ChatPrompt/ChatPrompt.d.ts

@@ -0,0 +1,83 @@
+import type { FormEvent, KeyboardEvent, ReactNode } from "react";
+import type { TextAreaProps } from "../../../Fields";
+import type { ChatStatus } from "../../../Layout/Chat/types";
+export declare type ChatPromptLocale = {
+    textareaLabel?: string;
+    emptyMessageTooltip?: string;
+    stopResponseTooltip?: string;
+    sendMessageTooltip?: string;
+};
+export declare type ChatPromptProps = Omit<TextAreaProps, "onSubmit"> & {
+    /**
+     * Content to render above the textarea (e.g., a title or instructions).
+     */
+    renderHeader?: ReactNode;
+    /**
+     * Content to render below the textarea (e.g., additional controls or hints).
+     */
+    renderFooter?: ReactNode;
+    /**
+     * An optional array of placeholder strings to cycle through with a typewriter effect.
+     * If provided and non-empty, the component will use the dynamic, animated placeholder
+     * text instead of any static `placeholder` prop passed in.
+     */
+    placeholders?: string[];
+    /**
+     * The current status of the chat prompt submit button:
+     * - "submitted": The message has been sent to the API and we're awaiting the start of the response stream.
+     * - "streaming": The response is actively streaming in from the API, receiving chunks of data.
+     * - "ready": The full response has been received and processed; a new user message can be submitted.
+     * - "error": An error occurred during the API request, preventing successful completion.
+     */
+    status?: ChatStatus;
+    /**
+     * Callback invoked when the user submits the form, either by clicking
+     * the submit button or pressing Enter (without Shift) inside the textarea.
+     */
+    onSubmit?: (e: KeyboardEvent<HTMLTextAreaElement> | FormEvent<HTMLFormElement>) => void;
+    /**
+     * Callback invoked when the user requests to stop the current chat response stream.
+     */
+    onStop?: () => void;
+    /**
+     * Optional locale.
+     */
+    locale?: ChatPromptLocale;
+};
+export declare const ChatPrompt: import("react").ForwardRefExoticComponent<Omit<TextAreaProps, "onSubmit"> & {
+    /**
+     * Content to render above the textarea (e.g., a title or instructions).
+     */
+    renderHeader?: ReactNode;
+    /**
+     * Content to render below the textarea (e.g., additional controls or hints).
+     */
+    renderFooter?: ReactNode;
+    /**
+     * An optional array of placeholder strings to cycle through with a typewriter effect.
+     * If provided and non-empty, the component will use the dynamic, animated placeholder
+     * text instead of any static `placeholder` prop passed in.
+     */
+    placeholders?: string[] | undefined;
+    /**
+     * The current status of the chat prompt submit button:
+     * - "submitted": The message has been sent to the API and we're awaiting the start of the response stream.
+     * - "streaming": The response is actively streaming in from the API, receiving chunks of data.
+     * - "ready": The full response has been received and processed; a new user message can be submitted.
+     * - "error": An error occurred during the API request, preventing successful completion.
+     */
+    status?: ChatStatus | undefined;
+    /**
+     * Callback invoked when the user submits the form, either by clicking
+     * the submit button or pressing Enter (without Shift) inside the textarea.
+     */
+    onSubmit?: ((e: KeyboardEvent<HTMLTextAreaElement> | FormEvent<HTMLFormElement>) => void) | undefined;
+    /**
+     * Callback invoked when the user requests to stop the current chat response stream.
+     */
+    onStop?: (() => void) | undefined;
+    /**
+     * Optional locale.
+     */
+    locale?: ChatPromptLocale | undefined;
+} & import("react").RefAttributes<HTMLTextAreaElement>>;