@algolia/satellite 2.3.0-rc.1 → 2.3.0-rc.10

package/dist/{cjs/Layout → esm}/Chat/ChatMessageLoader/ChatMessageLoader.styles.d.ts

@@ -2,62 +2,62 @@ export declare const chatMessageLoaderStyles: import("tailwind-variants").TVRetu
     [key: string]: {
         [key: string]: import("tailwind-merge").ClassNameValue | {
             content?: import("tailwind-merge").ClassNameValue;
+            skeleton?: 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;
+            skeleton?: 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;
+            skeleton?: 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;
+            skeleton?: 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;
+            skeleton?: 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;
+            skeleton?: 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;
+            skeleton?: 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;
+            skeleton?: import("tailwind-merge").ClassNameValue;
             message?: import("tailwind-merge").ClassNameValue;
             skeletonWrapper?: import("tailwind-merge").ClassNameValue;
-            skeleton?: import("tailwind-merge").ClassNameValue;
         };
     };
 }, {
@@ -66,6 +66,18 @@ export declare const chatMessageLoaderStyles: import("tailwind-variants").TVRetu
     skeletonWrapper: string;
     skeleton: string;
 }, undefined, {
+    responsiveVariants?: boolean | ("sm" | "md" | "lg" | "xl" | "2xl")[] | {
+        variant?: boolean | ("sm" | "md" | "lg" | "xl" | "2xl")[] | undefined;
+        leading?: boolean | ("sm" | "md" | "lg" | "xl" | "2xl")[] | undefined;
+        side?: boolean | ("sm" | "md" | "lg" | "xl" | "2xl")[] | undefined;
+        actions?: boolean | ("sm" | "md" | "lg" | "xl" | "2xl")[] | undefined;
+        autoHideActions?: boolean | ("sm" | "md" | "lg" | "xl" | "2xl")[] | undefined;
+    } | undefined;
+} & import("tailwind-variants/dist/config").TWMConfig & {
+    twMergeConfig: {
+        prefix: string;
+    };
+}, {
     variant: {
         neutral: {
             message: string;
@@ -98,6 +110,7 @@ export declare const chatMessageLoaderStyles: import("tailwind-variants").TVRetu
     content: string;
     message: string;
     actions: string;
+    footer: string;
 }, import("tailwind-variants").TVReturnType<{
     variant: {
         neutral: {
@@ -131,7 +144,20 @@ export declare const chatMessageLoaderStyles: import("tailwind-variants").TVRetu
     content: string;
     message: string;
     actions: string;
+    footer: string;
 }, undefined, {
+    responsiveVariants?: boolean | ("sm" | "md" | "lg" | "xl" | "2xl")[] | {
+        variant?: boolean | ("sm" | "md" | "lg" | "xl" | "2xl")[] | undefined;
+        leading?: boolean | ("sm" | "md" | "lg" | "xl" | "2xl")[] | undefined;
+        side?: boolean | ("sm" | "md" | "lg" | "xl" | "2xl")[] | undefined;
+        actions?: boolean | ("sm" | "md" | "lg" | "xl" | "2xl")[] | undefined;
+        autoHideActions?: boolean | ("sm" | "md" | "lg" | "xl" | "2xl")[] | undefined;
+    } | undefined;
+} & import("tailwind-variants/dist/config").TWMConfig & {
+    twMergeConfig: {
+        prefix: string;
+    };
+}, {
     variant: {
         neutral: {
             message: string;
@@ -164,6 +190,7 @@ export declare const chatMessageLoaderStyles: import("tailwind-variants").TVRetu
     content: string;
     message: string;
     actions: string;
+    footer: string;
 }, import("tailwind-variants").TVReturnType<{
     variant: {
         neutral: {
@@ -197,4 +224,57 @@ export declare const chatMessageLoaderStyles: import("tailwind-variants").TVRetu
     content: string;
     message: string;
     actions: string;
-}, undefined, unknown, unknown, undefined>>>;
+    footer: string;
+}, undefined, import("tailwind-variants/dist/config").TVConfig<{
+    variant: {
+        neutral: {
+            message: string;
+        };
+        subtle: {
+            message: string;
+        };
+    };
+    side: {
+        left: {
+            container: string;
+        };
+        right: {
+            container: string;
+        };
+    };
+    leading: {
+        true: string;
+    };
+    actions: {
+        true: string;
+    };
+    autoHideActions: {
+        true: string;
+    };
+}, {
+    variant: {
+        neutral: {
+            message: string;
+        };
+        subtle: {
+            message: string;
+        };
+    };
+    side: {
+        left: {
+            container: string;
+        };
+        right: {
+            container: string;
+        };
+    };
+    leading: {
+        true: string;
+    };
+    actions: {
+        true: string;
+    };
+    autoHideActions: {
+        true: string;
+    };
+}>, unknown, unknown, undefined>>>;

package/dist/esm/{Layout/Chat → Chat}/ChatMessageLoader/ChatMessageLoader.styles.js

@@ -1,13 +1,13 @@
 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";
+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"]))),
+    message: stl(_templateObject2 || (_templateObject2 = _taggedTemplateLiteral(["flex flex-col gap-2"]))),
     skeletonWrapper: stl(_templateObject3 || (_templateObject3 = _taggedTemplateLiteral(["flex flex-col gap-1"]))),
     skeleton: stl(_templateObject4 || (_templateObject4 = _taggedTemplateLiteral(["h-4"])))
   }

package/dist/esm/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/esm/{Layout/Chat → Chat}/ChatMessages/ChatMessages.js

@@ -2,25 +2,29 @@ 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"];
+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) { _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 { forwardRef, useCallback, useEffect, useMemo, useRef, useState } from "react";
 import { useStickToBottom } from "use-stick-to-bottom";
 import { chatMessagesStyles } from "./ChatMessages.styles";
 import { useLastMessageHeight } from "./useLastMessageHeight";
-import { IconButton } from "./../../../Actions";
+import { IconButton } from "./../../Actions";
 import { ChatMessage } from "./../ChatMessage";
 import { ChatMessageError } from "./../ChatMessageError";
 import { ChatMessageLoader } from "./../ChatMessageLoader";
-import { useLocale } from "./../../../Satellite";
+import { ChevronDownIcon } from "./../../Icons";
+import { useLocale } from "./../../Satellite";
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 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,
@@ -38,19 +42,22 @@ var ChatMessagesBase = function ChatMessagesBase(_ref, forwardedRef) {
     scrollClassName = _ref.scrollClassName,
     contentClassName = _ref.contentClassName,
     propsLocale = _ref.locale,
+    _ref$rtl = _ref.rtl,
+    rtl = _ref$rtl === void 0 ? false : _ref$rtl,
     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"
+      // @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 = chatMessagesStyles();
-  var messageRefs = useRef(new Map());
+  var lastUserMessageRef = useRef(null);
   var _useState = useState(false),
     _useState2 = _slicedToArray(_useState, 2),
     lastMessageSubmitted = _useState2[0],
@@ -58,19 +65,43 @@ var ChatMessagesBase = function ChatMessagesBase(_ref, forwardedRef) {
   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);
+  var lastMessageHeight = useLastMessageHeight(scrollRef, lastUserMessageRef, messages, lastMessageSubmitted, 24);
+  var lastMessageId = useMemo(function () {
+    var _messages;
+    return (_messages = messages[messages.length - 1]) === null || _messages === void 0 ? void 0 : _messages.id;
+  }, [messages]);
+  var getMessageProps = 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]);
   useEffect(function () {
-    if (status !== "submitted" || !lastUserMessage) {
-      return;
+    if (status === "submitted" && lastUserMessage) {
+      setLastMessageSubmitted(true);
+      void scrollToBottom();
     }
-    setLastMessageSubmitted(true);
-  }, [status, messages, lastUserMessage]);
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [status, lastUserMessage]);
   return /*#__PURE__*/_jsxs("div", _objectSpread(_objectSpread({}, props), {}, {
     ref: forwardedRef,
     className: styles.base({
       className: className
     }),
+    role: "log",
+    "aria-live": "polite",
     children: [/*#__PURE__*/_jsx("div", {
       ref: scrollRef,
       className: styles.scroll({
@@ -86,16 +117,17 @@ var ChatMessagesBase = function ChatMessagesBase(_ref, forwardedRef) {
         },
         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__*/_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,
+            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__*/_jsx(ChatMessageLoader, _objectSpread({}, loaderProps))), status === "error" && (renderError !== null && renderError !== void 0 ? renderError : /*#__PURE__*/_jsx(ChatMessageError, _objectSpread(_objectSpread({}, errorProps), {}, {
@@ -112,8 +144,15 @@ var ChatMessagesBase = function ChatMessagesBase(_ref, forwardedRef) {
       className: styles.scrollToBottom({
         isAtBottom: isAtBottom
       }),
-      tooltipHideDelay: 0
+      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.
+ */
 export var ChatMessages = /*#__PURE__*/forwardRef(ChatMessagesBase);

package/dist/esm/{Layout/Chat → Chat}/ChatMessages/ChatMessages.styles.d.ts

@@ -13,6 +13,14 @@ export declare const chatMessagesStyles: import("tailwind-variants").TVReturnTyp
     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;
@@ -40,4 +48,22 @@ export declare const chatMessagesStyles: import("tailwind-variants").TVReturnTyp
     scroll: string;
     content: string;
     scrollToBottom: string;
-}, undefined, unknown, unknown, undefined>>;
+}, 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/esm/{Layout/Chat → Chat}/ChatMessages/ChatMessages.styles.js

@@ -1,7 +1,7 @@
 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";
+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"]))),

package/dist/esm/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/esm/{Layout/Chat → Chat}/ChatMessages/useLastMessageHeight.js

@@ -1,34 +1,41 @@
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import { useRef } from "react";
 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.
+ *
+ * @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 function useLastMessageHeight(scrollRef, messages, lastUserMessageEl, lastMessageSubmitted) {
+export function useLastMessageHeight(scrollRef, lastUserMessageRef, messages, 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;
+  var offsetsRef = 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(scrollEl);
+    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;
-    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));
+    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
@@ -36,6 +43,6 @@ export function useLastMessageHeight(scrollRef, messages, lastUserMessageEl, las
     if (!lastMessageSubmitted) return;
     updateLastMessageHeight();
     // eslint-disable-next-line react-hooks/exhaustive-deps
-  }, [messages, lastMessageSubmitted]);
+  }, [messages.length, lastMessageSubmitted]);
   return lastMessageHeight;
 }