@algolia/satellite 2.2.3 → 2.3.0-rc.10

package/dist/cjs/Chat/ChatMessageLoader/index.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _ChatMessageLoader = require("./ChatMessageLoader");
+Object.keys(_ChatMessageLoader).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _ChatMessageLoader[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _ChatMessageLoader[key];
+    }
+  });
+});

package/dist/cjs/Chat/ChatMessages/ChatMessages.d.ts

@@ -0,0 +1,141 @@
+import type { HTMLAttributes, ReactElement, ReactNode, Ref } from "react";
+import type { ChatMessageProps } from "../../Chat/ChatMessage";
+import type { ChatMessageErrorProps } from "../../Chat/ChatMessageError";
+import type { ChatMessageLoaderProps } from "../../Chat/ChatMessageLoader";
+import type { ChatMessageBase, ChatStatus } from "../../Chat/types";
+export declare type ChatMessageLocale = {
+    scrollToBottomText?: string;
+};
+declare type ChatMessageWithoutContent<Message extends ChatMessageBase> = Omit<ChatMessageProps<Message>, "content">;
+export declare type ChatMessagesProps<Message extends ChatMessageBase = ChatMessageBase> = Omit<HTMLAttributes<HTMLDivElement>, "children"> & {
+    /**
+     * The messages to display in the chat.
+     */
+    messages: Message[];
+    /**
+     * The props for the user message.
+     */
+    userMessageProps?: ChatMessageWithoutContent<Message> | ((message: Message) => ChatMessageWithoutContent<Message>);
+    /**
+     * The props for the assistant message.
+     */
+    assistantMessageProps?: ChatMessageWithoutContent<Message> | ((message: Message) => ChatMessageWithoutContent<Message>);
+    /**
+     * The props for the loader message.
+     */
+    loaderProps?: ChatMessageLoaderProps;
+    /**
+     * The props for the error message.
+     */
+    errorProps?: Omit<ChatMessageErrorProps, "onReload">;
+    /**
+     * The function to render the message.
+     */
+    renderMessage?: (message: Message) => ReactNode;
+    /**
+     * The function to render the loader message.
+     */
+    renderLoader?: ReactNode;
+    /**
+     * The function to render the error message.
+     */
+    renderError?: ReactNode;
+    /**
+     * The status of the chat.
+     */
+    status?: ChatStatus;
+    /**
+     * The function to reload the chat.
+     */
+    onReload?: () => void;
+    /**
+     * Whether to hide the scroll to bottom button.
+     */
+    hideScrollToBottom?: boolean;
+    /**
+     * The class name for the scroll container.
+     */
+    scrollClassName?: string;
+    /**
+     * The class name for the content container.
+     */
+    contentClassName?: string;
+    /**
+     * The locale for the chat messages.
+     */
+    locale?: ChatMessageLocale;
+    /**
+     * Whether to enable right-to-left text direction.
+     */
+    rtl?: boolean;
+};
+/**
+ * The `ChatMessages` component provides a list of messages to display in the chat.
+ *
+ * See the [ChatMessages documentation page](https://satellite.algolia.com/8261d6576/p/06f740-chat-messages) for more information.
+ */
+export declare const ChatMessages: <Message extends ChatMessageBase = ChatMessageBase>(props: Omit<HTMLAttributes<HTMLDivElement>, "children"> & {
+    /**
+     * The messages to display in the chat.
+     */
+    messages: Message[];
+    /**
+     * The props for the user message.
+     */
+    userMessageProps?: ChatMessageWithoutContent<Message> | ((message: Message) => ChatMessageWithoutContent<Message>) | undefined;
+    /**
+     * The props for the assistant message.
+     */
+    assistantMessageProps?: ChatMessageWithoutContent<Message> | ((message: Message) => ChatMessageWithoutContent<Message>) | undefined;
+    /**
+     * The props for the loader message.
+     */
+    loaderProps?: ChatMessageLoaderProps | undefined;
+    /**
+     * The props for the error message.
+     */
+    errorProps?: Omit<ChatMessageErrorProps, "onReload"> | undefined;
+    /**
+     * The function to render the message.
+     */
+    renderMessage?: ((message: Message) => ReactNode) | undefined;
+    /**
+     * The function to render the loader message.
+     */
+    renderLoader?: ReactNode;
+    /**
+     * The function to render the error message.
+     */
+    renderError?: ReactNode;
+    /**
+     * The status of the chat.
+     */
+    status?: ChatStatus | undefined;
+    /**
+     * The function to reload the chat.
+     */
+    onReload?: (() => void) | undefined;
+    /**
+     * Whether to hide the scroll to bottom button.
+     */
+    hideScrollToBottom?: boolean | undefined;
+    /**
+     * The class name for the scroll container.
+     */
+    scrollClassName?: string | undefined;
+    /**
+     * The class name for the content container.
+     */
+    contentClassName?: string | undefined;
+    /**
+     * The locale for the chat messages.
+     */
+    locale?: ChatMessageLocale | undefined;
+    /**
+     * Whether to enable right-to-left text direction.
+     */
+    rtl?: boolean | undefined;
+} & {
+    ref?: Ref<HTMLDivElement> | undefined;
+}) => ReactElement | null;
+export {};

package/dist/cjs/Chat/ChatMessages/ChatMessages.js

@@ -0,0 +1,165 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ChatMessages = void 0;
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
+var _react = require("react");
+var _useStickToBottom2 = require("use-stick-to-bottom");
+var _ChatMessages = require("./ChatMessages.styles");
+var _useLastMessageHeight = require("./useLastMessageHeight");
+var _Actions = require("./../../Actions");
+var _ChatMessage = require("./../ChatMessage");
+var _ChatMessageError = require("./../ChatMessageError");
+var _ChatMessageLoader = require("./../ChatMessageLoader");
+var _Icons = require("./../../Icons");
+var _Satellite = require("./../../Satellite");
+var _jsxRuntime = require("react/jsx-runtime");
+var _excluded = ["messages", "userMessageProps", "assistantMessageProps", "loaderProps", "errorProps", "renderMessage", "renderLoader", "renderError", "status", "onReload", "hideScrollToBottom", "className", "scrollClassName", "contentClassName", "locale", "rtl"];
+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) { (0, _defineProperty2["default"])(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; }
+var DEFAULT_CHAT_MESSAGE_LOCALE = {
+  scrollToBottomText: "Scroll to bottom"
+};
+function resolveProps(propsOrFn, message) {
+  if (typeof propsOrFn === "function") {
+    return propsOrFn(message);
+  }
+  return propsOrFn;
+}
+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,
+    _ref$rtl = _ref.rtl,
+    rtl = _ref$rtl === void 0 ? false : _ref$rtl,
+    props = (0, _objectWithoutProperties2["default"])(_ref, _excluded);
+  var contextLocale = (0, _Satellite.useLocale)("chatMessage");
+  var locale = _objectSpread(_objectSpread(_objectSpread({}, DEFAULT_CHAT_MESSAGE_LOCALE), contextLocale), propsLocale);
+  var _useStickToBottom = (0, _useStickToBottom2.useStickToBottom)({
+      // @ts-expect-error - Types are wrong in use-stick-to-bottom
+      initial: "instant",
+      resize: "smooth"
+    }),
+    scrollRef = _useStickToBottom.scrollRef,
+    contentRef = _useStickToBottom.contentRef,
+    isAtBottom = _useStickToBottom.isAtBottom,
+    scrollToBottom = _useStickToBottom.scrollToBottom;
+  var styles = (0, _ChatMessages.chatMessagesStyles)();
+  var lastUserMessageRef = (0, _react.useRef)(null);
+  var _useState = (0, _react.useState)(false),
+    _useState2 = (0, _slicedToArray2["default"])(_useState, 2),
+    lastMessageSubmitted = _useState2[0],
+    setLastMessageSubmitted = _useState2[1];
+  var lastUserMessage = (0, _toConsumableArray2["default"])(messages).reverse().find(function (m) {
+    return m.role === "user";
+  });
+  var lastMessageHeight = (0, _useLastMessageHeight.useLastMessageHeight)(scrollRef, lastUserMessageRef, messages, lastMessageSubmitted, 24);
+  var lastMessageId = (0, _react.useMemo)(function () {
+    var _messages;
+    return (_messages = messages[messages.length - 1]) === null || _messages === void 0 ? void 0 : _messages.id;
+  }, [messages]);
+  var getMessageProps = (0, _react.useCallback)(function (message) {
+    var propsResult;
+    if (message.role === "assistant") {
+      propsResult = resolveProps(assistantMessageProps, message);
+
+      // If the last assistant message is streaming, we don't want to render actions or footer
+      if ((status === "streaming" || message.content.length === 0) && lastMessageId === message.id) {
+        propsResult = _objectSpread(_objectSpread({}, propsResult), {}, {
+          renderFooter: undefined,
+          renderActions: undefined,
+          actions: undefined
+        });
+      }
+    } else {
+      propsResult = resolveProps(userMessageProps, message);
+    }
+    return propsResult;
+  }, [assistantMessageProps, userMessageProps, status, lastMessageId]);
+  (0, _react.useEffect)(function () {
+    if (status === "submitted" && lastUserMessage) {
+      setLastMessageSubmitted(true);
+      void scrollToBottom();
+    }
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [status, lastUserMessage]);
+  return /*#__PURE__*/(0, _jsxRuntime.jsxs)("div", _objectSpread(_objectSpread({}, props), {}, {
+    ref: forwardedRef,
+    className: styles.base({
+      className: className
+    }),
+    role: "log",
+    "aria-live": "polite",
+    children: [/*#__PURE__*/(0, _jsxRuntime.jsx)("div", {
+      ref: scrollRef,
+      className: styles.scroll({
+        className: scrollClassName
+      }),
+      children: /*#__PURE__*/(0, _jsxRuntime.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";
+          var isLastUserMessage = (lastUserMessage === null || lastUserMessage === void 0 ? void 0 : lastUserMessage.id) === message.id;
+          var side = isAssistant ? "left" : "right";
+          return /*#__PURE__*/(0, _jsxRuntime.jsx)(_ChatMessage.ChatMessage, _objectSpread(_objectSpread({
+            rtl: rtl,
+            ref: isLastUserMessage ? lastUserMessageRef : undefined,
+            side: side,
+            variant: isAssistant ? "subtle" : "neutral"
+          }, getMessageProps(message)), {}, {
+            content: renderMessage ? renderMessage(message) : message.content,
+            actionsExtraData: message,
+            "data-role": message.role,
+            "data-key": message.id
+          }), message.id);
+        }), status === "submitted" && (renderLoader !== null && renderLoader !== void 0 ? renderLoader : /*#__PURE__*/(0, _jsxRuntime.jsx)(_ChatMessageLoader.ChatMessageLoader, _objectSpread({}, loaderProps))), status === "error" && (renderError !== null && renderError !== void 0 ? renderError : /*#__PURE__*/(0, _jsxRuntime.jsx)(_ChatMessageError.ChatMessageError, _objectSpread(_objectSpread({}, errorProps), {}, {
+          onReload: onReload
+        })))]
+      })
+    }), !hideScrollToBottom && /*#__PURE__*/(0, _jsxRuntime.jsx)(_Actions.IconButton, {
+      icon: _Icons.ChevronDownIcon,
+      title: locale.scrollToBottomText,
+      size: "small",
+      onClick: function onClick() {
+        return scrollToBottom();
+      },
+      className: styles.scrollToBottom({
+        isAtBottom: isAtBottom
+      }),
+      tooltipHideDelay: 0,
+      tabIndex: isAtBottom ? -1 : 0
+    })]
+  }));
+};
+
+/**
+ * The `ChatMessages` component provides a list of messages to display in the chat.
+ *
+ * See the [ChatMessages documentation page](https://satellite.algolia.com/8261d6576/p/06f740-chat-messages) for more information.
+ */
+var ChatMessages = exports.ChatMessages = /*#__PURE__*/(0, _react.forwardRef)(ChatMessagesBase);

package/dist/cjs/Chat/ChatMessages/ChatMessages.styles.d.ts

@@ -0,0 +1,69 @@
+export declare const chatMessagesStyles: import("tailwind-variants").TVReturnType<{
+    isAtBottom: {
+        true: {
+            scrollToBottom: string;
+        };
+        false: {
+            scrollToBottom: string;
+        };
+    };
+}, {
+    base: string;
+    scroll: string;
+    content: string;
+    scrollToBottom: string;
+}, undefined, {
+    responsiveVariants?: boolean | ("sm" | "md" | "lg" | "xl" | "2xl")[] | {
+        isAtBottom?: boolean | ("sm" | "md" | "lg" | "xl" | "2xl")[] | undefined;
+    } | undefined;
+} & import("tailwind-variants/dist/config").TWMConfig & {
+    twMergeConfig: {
+        prefix: string;
+    };
+}, {
+    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, import("tailwind-variants/dist/config").TVConfig<{
+    isAtBottom: {
+        true: {
+            scrollToBottom: string;
+        };
+        false: {
+            scrollToBottom: string;
+        };
+    };
+}, {
+    isAtBottom: {
+        true: {
+            scrollToBottom: string;
+        };
+        false: {
+            scrollToBottom: string;
+        };
+    };
+}>, unknown, unknown, undefined>>;

package/dist/cjs/Chat/ChatMessages/ChatMessages.styles.js

@@ -0,0 +1,29 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.chatMessagesStyles = void 0;
+var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
+var _satellitePrefixer = _interopRequireDefault(require("./../../styles/helpers/satellitePrefixer"));
+var _tv = require("./../../styles/helpers/tv");
+var _templateObject, _templateObject2, _templateObject3, _templateObject4, _templateObject5, _templateObject6;
+var chatMessagesStyles = exports.chatMessagesStyles = (0, _tv.tv)({
+  slots: {
+    base: (0, _satellitePrefixer["default"])(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2["default"])(["relative flex flex-col overflow-hidden h-full"]))),
+    scroll: (0, _satellitePrefixer["default"])(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2["default"])(["overflow-y-auto overflow-x-hidden thin-scrollbar size-full"]))),
+    content: (0, _satellitePrefixer["default"])(_templateObject3 || (_templateObject3 = (0, _taggedTemplateLiteral2["default"])(["flex flex-col gap-6 w-full flex-1 [&>article:last-of-type]:min-h-[var(--last-message-height)]"]))),
+    scrollToBottom: (0, _satellitePrefixer["default"])(_templateObject4 || (_templateObject4 = (0, _taggedTemplateLiteral2["default"])(["absolute bottom-4 left-1/2 -translate-x-1/2 transition-[transform,opacity] duration-300 ease-out"])))
+  },
+  variants: {
+    isAtBottom: {
+      "true": {
+        scrollToBottom: (0, _satellitePrefixer["default"])(_templateObject5 || (_templateObject5 = (0, _taggedTemplateLiteral2["default"])(["pointer-events-none translate-y-4 scale-95 opacity-0"])))
+      },
+      "false": {
+        scrollToBottom: (0, _satellitePrefixer["default"])(_templateObject6 || (_templateObject6 = (0, _taggedTemplateLiteral2["default"])(["translate-y-0 scale-100 opacity-100"])))
+      }
+    }
+  }
+});

package/dist/cjs/Chat/ChatMessages/index.d.ts

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

package/dist/cjs/Chat/ChatMessages/index.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _ChatMessages = require("./ChatMessages");
+Object.keys(_ChatMessages).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _ChatMessages[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _ChatMessages[key];
+    }
+  });
+});

package/dist/cjs/Chat/ChatMessages/useLastMessageHeight.d.ts

@@ -0,0 +1,14 @@
+import type { RefObject } from "react";
+import type { ChatMessageBase } from "../../Chat/types";
+/**
+ * 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.
+ *
+ * @param scrollRef - The ref to the scroll container.
+ * @param lastUserMessageRef - The ref to the last user message.
+ * @param messages - The messages to display in the chat.
+ * @param lastMessageSubmitted - Whether the last message has been submitted.
+ * @param spacingOffset - The spacing offset.
+ */
+export declare function useLastMessageHeight(scrollRef: RefObject<HTMLElement>, lastUserMessageRef: RefObject<HTMLDivElement | null>, messages: ChatMessageBase[], lastMessageSubmitted: boolean, spacingOffset?: number): number;

package/dist/cjs/Chat/ChatMessages/useLastMessageHeight.js

@@ -0,0 +1,54 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useLastMessageHeight = useLastMessageHeight;
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _react = require("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.
+ *
+ * @param scrollRef - The ref to the scroll container.
+ * @param lastUserMessageRef - The ref to the last user message.
+ * @param messages - The messages to display in the chat.
+ * @param lastMessageSubmitted - Whether the last message has been submitted.
+ * @param spacingOffset - The spacing offset.
+ */
+function useLastMessageHeight(scrollRef, lastUserMessageRef, messages, lastMessageSubmitted) {
+  var spacingOffset = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : 0;
+  var _useState = (0, _react.useState)(0),
+    _useState2 = (0, _slicedToArray2["default"])(_useState, 2),
+    lastMessageHeight = _useState2[0],
+    setLastMessageHeight = _useState2[1];
+  var offsetsRef = (0, _react.useRef)(0);
+  function getStaticOffsets() {
+    if (offsetsRef.current || !scrollRef.current) return offsetsRef.current;
+
+    // Compute any CSS gap/rowGap/padding offsets by reading computed style
+    var computed = window.getComputedStyle(scrollRef.current);
+    var rowGapValue = parseFloat(computed.rowGap) || parseFloat(computed.gap) || 0;
+    var paddingTop = parseFloat(computed.paddingTop) || 0;
+    var paddingBottom = parseFloat(computed.paddingBottom) || 0;
+    offsetsRef.current = spacingOffset + rowGapValue + paddingTop + paddingBottom;
+    return offsetsRef.current;
+  }
+  var updateLastMessageHeight = function updateLastMessageHeight() {
+    var scrollEl = scrollRef.current;
+    var lastUserMessageEl = lastUserMessageRef.current;
+    if (!scrollEl || messages.length === 0 || !lastMessageSubmitted || !lastUserMessageEl) return;
+    var height = Math.max(scrollEl.clientHeight - lastUserMessageEl.offsetHeight - getStaticOffsets(), 0);
+    setLastMessageHeight(height);
+  };
+
+  // Recompute whenever messages change and a new user message has just been submitted
+  (0, _react.useLayoutEffect)(function () {
+    if (!lastMessageSubmitted) return;
+    updateLastMessageHeight();
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [messages.length, lastMessageSubmitted]);
+  return lastMessageHeight;
+}

package/dist/cjs/Chat/ChatPrompt/ChatPrompt.d.ts

@@ -0,0 +1,105 @@
+import type { FormEvent, KeyboardEvent, ReactNode } from "react";
+import type { ChatStatus } from "../../Chat/types";
+import type { TextAreaAutoSizeProps } from "../../Fields/TextAreaAutoSize/TextAreaAutoSize";
+export declare type ChatPromptLocale = {
+    textareaLabel?: string;
+    emptyMessageTooltip?: string;
+    stopResponseTooltip?: string;
+    sendMessageTooltip?: string;
+    disabledTooltip?: string;
+};
+export declare type ChatPromptProps = Omit<TextAreaAutoSizeProps, "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;
+    /**
+     * Whether to automatically focus the textarea when the user starts typing.
+     */
+    autoFocusOnTyping?: boolean;
+    /**
+     * Whether to enable right-to-left (RTL) layout support.
+     */
+    rtl?: boolean;
+    /**
+     * Optional locale.
+     */
+    locale?: ChatPromptLocale;
+    /**
+     * 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;
+};
+/**
+ * The `ChatPrompt` component provides a textarea for users to type messages and a button to submit them.
+ *
+ * See the [ChatPrompt documentation page](https://satellite.algolia.com/8261d6576/p/06f740-chat-prompt) for more information.
+ */
+export declare const ChatPrompt: import("react").ForwardRefExoticComponent<Omit<TextAreaAutoSizeProps, "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;
+    /**
+     * Whether to automatically focus the textarea when the user starts typing.
+     */
+    autoFocusOnTyping?: boolean | undefined;
+    /**
+     * Whether to enable right-to-left (RTL) layout support.
+     */
+    rtl?: boolean | undefined;
+    /**
+     * Optional locale.
+     */
+    locale?: ChatPromptLocale | 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;
+} & import("react").RefAttributes<HTMLTextAreaElement>>;