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

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

@@ -6,9 +6,7 @@ var _excluded = ["messages", "userMessageProps", "assistantMessageProps", "loade
 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";
@@ -21,6 +19,12 @@ 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,
@@ -42,15 +46,16 @@ var ChatMessagesBase = function ChatMessagesBase(_ref, forwardedRef) {
   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 +63,41 @@ 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" && 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);
     }
-    setLastMessageSubmitted(true);
-  }, [status, messages, lastUserMessage]);
+  }, [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 +113,15 @@ 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;
           return /*#__PURE__*/_jsx(ChatMessage, _objectSpread(_objectSpread({
-            ref: function ref(el) {
-              if (el) messageRefs.current.set(message.id, el);else messageRefs.current["delete"](message.id);
-            },
+            ref: isLastUserMessage ? lastUserMessageRef : undefined,
             side: isAssistant ? "left" : "right",
-            variant: isAssistant ? "subtle" : "neutral",
-            content: renderMessage ? renderMessage(message) : message.content
-          }, isAssistant ? assistantMessageProps : userMessageProps), {}, {
-            "data-role": message.role,
+            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), {}, {

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

@@ -1,10 +1,8 @@
 import type { RefObject } from "react";
+import type { ChatMessageBase } from "../../../Layout/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.
  */
-export declare function useLastMessageHeight(scrollRef: RefObject<HTMLElement>, messages: Array<{
-    id: string;
-    role: string;
-}>, lastUserMessageEl: HTMLElement | undefined, lastMessageSubmitted: boolean, spacingOffset?: number): number;
+export declare function useLastMessageHeight(scrollRef: RefObject<HTMLElement>, lastUserMessageRef: RefObject<HTMLDivElement | null>, messages: ChatMessageBase[], lastMessageSubmitted: boolean, spacingOffset?: number): number;

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

@@ -1,34 +1,35 @@
 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.
  */
-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 +37,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;
 }

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

@@ -1,5 +1,5 @@
 import type { FormEvent, KeyboardEvent, ReactNode } from "react";
-import type { TextAreaProps } from "../../../Fields";
+import type { TextAreaAutoSizeProps } from "../../../Fields/TextAreaAutoSize/TextAreaAutoSize";
 import type { ChatStatus } from "../../../Layout/Chat/types";
 export declare type ChatPromptLocale = {
     textareaLabel?: string;
@@ -7,7 +7,7 @@ export declare type ChatPromptLocale = {
     stopResponseTooltip?: string;
     sendMessageTooltip?: string;
 };
-export declare type ChatPromptProps = Omit<TextAreaProps, "onSubmit"> & {
+export declare type ChatPromptProps = Omit<TextAreaAutoSizeProps, "onSubmit"> & {
     /**
      * Content to render above the textarea (e.g., a title or instructions).
      */
@@ -30,6 +30,14 @@ export declare type ChatPromptProps = Omit<TextAreaProps, "onSubmit"> & {
      * - "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;
+    /**
+     * 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.
@@ -39,12 +47,8 @@ export declare type ChatPromptProps = Omit<TextAreaProps, "onSubmit"> & {
      * 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"> & {
+export declare const ChatPrompt: import("react").ForwardRefExoticComponent<Omit<TextAreaAutoSizeProps, "onSubmit"> & {
     /**
      * Content to render above the textarea (e.g., a title or instructions).
      */
@@ -67,6 +71,14 @@ export declare const ChatPrompt: import("react").ForwardRefExoticComponent<Omit<
      * - "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;
+    /**
+     * 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.
@@ -76,8 +88,4 @@ export declare const ChatPrompt: import("react").ForwardRefExoticComponent<Omit<
      * 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>>;

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

@@ -1,7 +1,7 @@
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
-var _excluded = ["className", "renderHeader", "children", "renderFooter", "onSubmit", "onStop", "placeholder", "placeholders", "status", "defaultValue", "value", "locale"];
+var _excluded = ["className", "renderHeader", "children", "renderFooter", "onSubmit", "onStop", "placeholder", "placeholders", "status", "autoFocusOnTyping", "defaultValue", "value", "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 { ArrowUpIcon, CircleStopIcon } from "lucide-react";
@@ -9,6 +9,7 @@ import { useState } from "react";
 import { useRef } from "react";
 import { forwardRef } from "react";
 import { chatPromptStyles } from "./ChatPrompt.styles";
+import { useFocusOnTyping } from "./useFocusTyping";
 import { useTypewriter } from "./useTypewriter";
 import { IconButton } from "./../../../Actions";
 import { TextAreaAutoSize } from "./../../../Fields/TextAreaAutoSize/TextAreaAutoSize";
@@ -34,6 +35,7 @@ export var ChatPrompt = /*#__PURE__*/forwardRef(function (_ref, forwardedRef) {
     placeholders = _ref$placeholders === void 0 ? [] : _ref$placeholders,
     _ref$status = _ref.status,
     status = _ref$status === void 0 ? "ready" : _ref$status,
+    autoFocusOnTyping = _ref.autoFocusOnTyping,
     defaultValue = _ref.defaultValue,
     valueProp = _ref.value,
     propsLocale = _ref.locale,
@@ -53,6 +55,10 @@ export var ChatPrompt = /*#__PURE__*/forwardRef(function (_ref, forwardedRef) {
   var buttonDisabled = !hasValue && !canStop;
   var dynamicPlaceholder = useTypewriter(placeholders, !hasValue);
   var computedPlaceholder = placeholders.length > 0 ? dynamicPlaceholder : staticPlaceholder;
+  useFocusOnTyping(internalRef, {
+    enabled: autoFocusOnTyping,
+    strictChars: true
+  });
   var submit = function submit(e) {
     e.preventDefault();
     if (!hasValue || canStop) {

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

@@ -8,7 +8,7 @@ export var chatPromptStyles = tv({
     header: stl(_templateObject2 || (_templateObject2 = _taggedTemplateLiteral(["flex items-center gap-1.5"]))),
     body: stl(_templateObject3 || (_templateObject3 = _taggedTemplateLiteral([""]))),
     textarea: stl(_templateObject4 || (_templateObject4 = _taggedTemplateLiteral(["[&>textarea]:p-3 [&>textarea]:pb-0 [&>textarea]:thin-scrollbar"]))),
-    actions: stl(_templateObject5 || (_templateObject5 = _taggedTemplateLiteral(["flex flex-row p-3 pt-2 justify-end"]))),
+    actions: stl(_templateObject5 || (_templateObject5 = _taggedTemplateLiteral(["flex flex-row p-3 pt-2 justify-end cursor-text"]))),
     submit: stl(_templateObject6 || (_templateObject6 = _taggedTemplateLiteral([""]))),
     footer: stl(_templateObject7 || (_templateObject7 = _taggedTemplateLiteral(["flex items-center justify-between gap-1.5"])))
   }

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

@@ -0,0 +1,12 @@
+/// <reference types="react" />
+declare type Editable = HTMLTextAreaElement | HTMLInputElement | HTMLElement;
+interface Options {
+    enabled?: boolean;
+    strictChars?: boolean;
+}
+/**
+ * Focus `editableRef` the moment the user types anywhere on the page,
+ * *unless* their cursor is already inside an editable control.
+ */
+export declare function useFocusOnTyping<E extends Editable = Editable>(editableRef: React.RefObject<E>, { enabled, strictChars }?: Options): void;
+export {};

package/dist/esm/Layout/Chat/ChatPrompt/useFocusTyping.js

@@ -0,0 +1,54 @@
+import { useCallback, useEffect } from "react";
+var isTextualElement = function isTextualElement(el) {
+  if (el.isContentEditable) return true;
+  var tag = el.tagName.toUpperCase();
+  if (tag === "TEXTAREA") return true;
+  if (tag === "INPUT") {
+    // Empty `type` defaults to "text"
+    var t = (el.type || "text").toLowerCase();
+    return ["text", "search", "url", "email", "tel", "password", "number", "date", "datetime-local", "month", "week", "time"].includes(t);
+  }
+  return false;
+};
+var shouldFocusEditable = function shouldFocusEditable(target) {
+  var el = target;
+  if (!el) return true;
+  return !isTextualElement(el);
+};
+
+// e.g. <div contentEditable>
+
+/**
+ * Focus `editableRef` the moment the user types anywhere on the page,
+ * *unless* their cursor is already inside an editable control.
+ */
+export function useFocusOnTyping(editableRef) {
+  var _ref = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {},
+    _ref$enabled = _ref.enabled,
+    enabled = _ref$enabled === void 0 ? true : _ref$enabled,
+    _ref$strictChars = _ref.strictChars,
+    strictChars = _ref$strictChars === void 0 ? false : _ref$strictChars;
+  var handleKeyDown = useCallback(function (e) {
+    if (!enabled || e.ctrlKey || e.altKey || e.metaKey || e.isComposing || e.repeat || (
+    // Printable-character test
+    strictChars ? !/^[A-Za-z0-9]$/.test(e.key) : e.key.length !== 1)) {
+      return;
+    }
+    var node = editableRef.current;
+    if (!node) return;
+    if (node.contains(document.activeElement)) return;
+    if (shouldFocusEditable(e.target)) {
+      node.focus();
+    }
+  }, [enabled, strictChars, editableRef]);
+  useEffect(function () {
+    if (typeof window === "undefined") return; // SSR/test guard
+
+    window.addEventListener("keydown", handleKeyDown, {
+      passive: true
+    });
+    return function () {
+      return window.removeEventListener("keydown", handleKeyDown);
+    };
+  }, [handleKeyDown]);
+}