@algolia/satellite 2.3.0-rc.5 → 2.3.0-rc.8

package/dist/esm/{Layout/Chat → Chat}/ChatPrompt/ChatPrompt.js

@@ -1,28 +1,35 @@
 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", "autoFocusOnTyping", "defaultValue", "value", "locale", "id"];
+var _excluded = ["className", "renderHeader", "children", "renderFooter", "onSubmit", "onStop", "placeholder", "placeholders", "status", "autoFocusOnTyping", "rtl", "defaultValue", "value", "locale", "id"];
 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 { useMemo } from "react";
 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";
-import { ArrowUpIcon, StopCircleIcon } from "./../../../Icons";
-import { useLocale } from "./../../../Satellite";
-import { uniqueId } from "./../../../utils";
-import { mergeRefs } from "./../../../utils/mergeRefs";
+import { IconButton } from "./../../Actions";
+import { TextAreaAutoSize } from "./../../Fields/TextAreaAutoSize/TextAreaAutoSize";
+import { ArrowUpIcon, StopCircleIcon } from "./../../Icons";
+import { useLocale } from "./../../Satellite";
+import { uniqueId } from "./../../utils";
+import { mergeRefs } from "./../../utils/mergeRefs";
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 var DEFAULT_CHAT_PROMPT_LOCALE = {
   textareaLabel: "Type your message...",
   emptyMessageTooltip: "Message is empty",
   stopResponseTooltip: "Stop response",
-  sendMessageTooltip: "Send message"
+  sendMessageTooltip: "Send message",
+  disabledTooltip: "Chat prompt is disabled"
 };
+/**
+ * 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 var ChatPrompt = /*#__PURE__*/forwardRef(function (_ref, forwardedRef) {
   var _ref2;
   var className = _ref.className,
@@ -38,6 +45,8 @@ export var ChatPrompt = /*#__PURE__*/forwardRef(function (_ref, forwardedRef) {
     status = _ref$status === void 0 ? "ready" : _ref$status,
     _ref$autoFocusOnTypin = _ref.autoFocusOnTyping,
     autoFocusOnTyping = _ref$autoFocusOnTypin === void 0 ? false : _ref$autoFocusOnTypin,
+    _ref$rtl = _ref.rtl,
+    rtl = _ref$rtl === void 0 ? false : _ref$rtl,
     defaultValue = _ref.defaultValue,
     valueProp = _ref.value,
     propsLocale = _ref.locale,
@@ -47,10 +56,14 @@ export var ChatPrompt = /*#__PURE__*/forwardRef(function (_ref, forwardedRef) {
   var locale = _objectSpread(_objectSpread(_objectSpread({}, DEFAULT_CHAT_PROMPT_LOCALE), contextLocale), propsLocale);
 
   // eslint-disable-next-line @algolia/stl/prefer-stl-helper
-  var generatedId = uniqueId("stl-chat-prompt-");
+  var generatedId = useMemo(function () {
+    return uniqueId("stl-chat-prompt-");
+  }, []);
   var textareaId = propId !== null && propId !== void 0 ? propId : generatedId;
   var internalRef = useRef(null);
-  var styles = chatPromptStyles();
+  var styles = chatPromptStyles({
+    disabled: props.disabled
+  });
   var _useState = useState(defaultValue !== null && defaultValue !== void 0 ? defaultValue : ""),
     _useState2 = _slicedToArray(_useState, 2),
     internalValue = _useState2[0],
@@ -68,7 +81,11 @@ export var ChatPrompt = /*#__PURE__*/forwardRef(function (_ref, forwardedRef) {
   });
   var submit = function submit(e) {
     e.preventDefault();
-    if (!hasValue || canStop) {
+    if (canStop) {
+      onStop === null || onStop === void 0 || onStop();
+      return;
+    }
+    if (!hasValue) {
       return;
     }
     onSubmit === null || onSubmit === void 0 || onSubmit(e);
@@ -76,6 +93,7 @@ export var ChatPrompt = /*#__PURE__*/forwardRef(function (_ref, forwardedRef) {
   return /*#__PURE__*/_jsxs("form", {
     className: styles.base(),
     onSubmit: submit,
+    dir: rtl ? "rtl" : "ltr",
     children: [!!renderHeader && /*#__PURE__*/_jsx("div", {
       className: styles.header(),
       children: renderHeader
@@ -120,20 +138,15 @@ export var ChatPrompt = /*#__PURE__*/forwardRef(function (_ref, forwardedRef) {
         children: /*#__PURE__*/_jsx("div", {
           className: styles.actions(),
           children: /*#__PURE__*/_jsx(IconButton, {
-            type: status === "ready" ? "submit" : undefined,
-            onClick: function onClick(e) {
-              if (canStop) {
-                e.preventDefault();
-                onStop === null || onStop === void 0 || onStop();
-              }
-            },
+            type: "submit",
             icon: canStop ? StopCircleIcon : ArrowUpIcon,
             variant: canStop ? "neutral" : "primary",
             size: "small",
-            title: buttonDisabled ? locale.emptyMessageTooltip : canStop ? locale.stopResponseTooltip : locale.sendMessageTooltip,
+            title: props.disabled ? locale.disabledTooltip : buttonDisabled ? locale.emptyMessageTooltip : canStop ? locale.stopResponseTooltip : locale.sendMessageTooltip,
             tooltipSide: "top",
             disabled: buttonDisabled,
-            className: styles.submit()
+            className: styles.submit(),
+            "data-status": status
           })
         })
       }))

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

@@ -0,0 +1,63 @@
+export declare const chatPromptStyles: import("tailwind-variants").TVReturnType<{
+    disabled: {
+        true: {
+            actions: string;
+        };
+    };
+}, {
+    base: string;
+    header: string;
+    body: string;
+    textarea: string;
+    actions: string;
+    submit: string;
+    footer: string;
+}, undefined, {
+    responsiveVariants?: boolean | ("sm" | "md" | "lg" | "xl" | "2xl")[] | {
+        disabled?: boolean | ("sm" | "md" | "lg" | "xl" | "2xl")[] | undefined;
+    } | undefined;
+} & import("tailwind-variants/dist/config").TWMConfig & {
+    twMergeConfig: {
+        prefix: string;
+    };
+}, {
+    disabled: {
+        true: {
+            actions: string;
+        };
+    };
+}, {
+    base: string;
+    header: string;
+    body: string;
+    textarea: string;
+    actions: string;
+    submit: string;
+    footer: string;
+}, import("tailwind-variants").TVReturnType<{
+    disabled: {
+        true: {
+            actions: string;
+        };
+    };
+}, {
+    base: string;
+    header: string;
+    body: string;
+    textarea: string;
+    actions: string;
+    submit: string;
+    footer: string;
+}, undefined, import("tailwind-variants/dist/config").TVConfig<{
+    disabled: {
+        true: {
+            actions: string;
+        };
+    };
+}, {
+    disabled: {
+        true: {
+            actions: string;
+        };
+    };
+}>, unknown, unknown, undefined>>;

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

@@ -1,7 +1,7 @@
 import _taggedTemplateLiteral from "@babel/runtime/helpers/taggedTemplateLiteral";
-var _templateObject, _templateObject2, _templateObject3, _templateObject4, _templateObject5, _templateObject6, _templateObject7;
-import stl from "./../../../styles/helpers/satellitePrefixer";
-import { tv } from "./../../../styles/helpers/tv";
+var _templateObject, _templateObject2, _templateObject3, _templateObject4, _templateObject5, _templateObject6, _templateObject7, _templateObject8;
+import stl from "./../../styles/helpers/satellitePrefixer";
+import { tv } from "./../../styles/helpers/tv";
 export var chatPromptStyles = tv({
   slots: {
     base: stl(_templateObject || (_templateObject = _taggedTemplateLiteral(["relative flex flex-col items-stretch gap-2 w-full"]))),
@@ -11,5 +11,12 @@ export var chatPromptStyles = tv({
     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"])))
+  },
+  variants: {
+    disabled: {
+      "true": {
+        actions: stl(_templateObject8 || (_templateObject8 = _taggedTemplateLiteral(["bg-grey-100 cursor-not-allowed"])))
+      }
+    }
   }
 });

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

@@ -0,0 +1,30 @@
+/// <reference types="react" />
+/**
+ * Check if the element is a textual element.
+ * @param el - The element to check.
+ * @returns True if the element is a textual element, false otherwise.
+ */
+export declare const isTextualElement: (el: HTMLElement) => boolean;
+declare type Editable = HTMLTextAreaElement | HTMLInputElement | HTMLElement;
+export interface UseFocusOnTypingOptions {
+    /**
+     * Whether the hook is enabled.
+     * @default true
+     */
+    enabled?: boolean;
+    /**
+     * Whether to allow punctuation, diacritics, etc.
+     * @default false
+     */
+    strictChars?: boolean;
+}
+/**
+ * Focus `editableRef` the moment the user types anywhere on the page,
+ * *unless* their cursor is already inside an editable control.
+ * @param editableRef - The ref to the editable element.
+ * @param options - The options for the hook.
+ * @param options.enabled - Whether the hook is enabled.
+ * @param options.strictChars - Whether to allow punctuation, diacritics, etc.
+ */
+export declare function useFocusOnTyping<E extends Editable = Editable>(editableRef: React.RefObject<E>, options?: UseFocusOnTypingOptions): void;
+export {};

package/dist/esm/{Layout/Chat → Chat}/ChatPrompt/useFocusTyping.js

@@ -1,33 +1,37 @@
 import { useCallback, useEffect } from "react";
-var isTextualElement = function isTextualElement(el) {
+
+/**
+ * Check if the element is a textual element.
+ * @param el - The element to check.
+ * @returns True if the element is a textual element, false otherwise.
+ */
+export 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();
+    var t = el.type.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.
+ * @param editableRef - The ref to the editable element.
+ * @param options - The options for the hook.
+ * @param options.enabled - Whether the hook is enabled.
+ * @param options.strictChars - Whether to allow punctuation, diacritics, etc.
  */
 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 options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  var _options$enabled = options.enabled,
+    enabled = _options$enabled === void 0 ? true : _options$enabled,
+    _options$strictChars = options.strictChars,
+    strictChars = _options$strictChars === void 0 ? false : _options$strictChars;
   var handleKeyDown = useCallback(function (e) {
     if (!enabled || e.ctrlKey || e.altKey || e.metaKey || e.isComposing || e.repeat || (
     // Printable-character test
@@ -37,7 +41,8 @@ export function useFocusOnTyping(editableRef) {
     var node = editableRef.current;
     if (!node) return;
     if (node.contains(document.activeElement)) return;
-    if (shouldFocusEditable(e.target)) {
+    var el = e.target;
+    if (!el || !isTextualElement(el)) {
       node.focus();
     }
   }, [enabled, strictChars, editableRef]);

package/dist/esm/{Layout/Chat → Chat}/ChatPrompt/useTypewriter.d.ts

@@ -15,4 +15,13 @@ export interface UseTypewriterOptions {
      */
     pauseDuration?: number;
 }
+/**
+ * A hook that types out a list of texts character by character.
+ * @param texts - The list of texts to type out.
+ * @param enabled - Whether the hook is enabled.
+ * @param options - The options for the hook.
+ * @param options.typingSpeed - The speed at which to type out the text.
+ * @param options.deletingSpeed - The speed at which to delete the text.
+ * @param options.pauseDuration - The duration to pause after typing a full word before deleting.
+ */
 export declare function useTypewriter(texts: string[], enabled?: boolean, options?: UseTypewriterOptions): string;

package/dist/esm/{Layout/Chat → Chat}/ChatPrompt/useTypewriter.js

@@ -1,5 +1,14 @@
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import { useEffect, useState } from "react";
+/**
+ * A hook that types out a list of texts character by character.
+ * @param texts - The list of texts to type out.
+ * @param enabled - Whether the hook is enabled.
+ * @param options - The options for the hook.
+ * @param options.typingSpeed - The speed at which to type out the text.
+ * @param options.deletingSpeed - The speed at which to delete the text.
+ * @param options.pauseDuration - The duration to pause after typing a full word before deleting.
+ */
 export function useTypewriter(texts) {
   var enabled = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : true;
   var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};

package/dist/esm/Fields/Checkbox/Checkbox.d.ts

@@ -15,12 +15,12 @@ declare type CheckboxCustomProps = {
      */
     checkedColor?: string;
 };
-declare type CheckboxInputProps = Omit<HTMLAttributes<HTMLInputElement>, "onChange"> & Pick<InputHTMLAttributes<HTMLInputElement>, "onChange" | "required" | "autoFocus" | "disabled" | "checked" | "defaultChecked">;
+declare type CheckboxInputProps = Omit<HTMLAttributes<HTMLInputElement>, "onChange"> & Pick<InputHTMLAttributes<HTMLInputElement>, "onChange" | "required" | "autoFocus" | "disabled" | "checked" | "defaultChecked" | "name">;
 export declare type CheckboxProps = CheckboxInputProps & CheckboxCustomProps;
 /**
  * The `Checkbox` component is a control that allows single or multiple selections from a set of options.
  *
  * See the [Checkbox documentation page](https://satellite.algolia.com/8261d6576/p/023233-checkbox) for more information.
  */
-export declare const Checkbox: import("react").ForwardRefExoticComponent<Omit<HTMLAttributes<HTMLInputElement>, "onChange"> & Pick<InputHTMLAttributes<HTMLInputElement>, "onChange" | "defaultChecked" | "autoFocus" | "disabled" | "checked" | "required"> & CheckboxCustomProps & import("react").RefAttributes<HTMLInputElement>>;
+export declare const Checkbox: import("react").ForwardRefExoticComponent<Omit<HTMLAttributes<HTMLInputElement>, "onChange"> & Pick<InputHTMLAttributes<HTMLInputElement>, "name" | "onChange" | "defaultChecked" | "autoFocus" | "disabled" | "checked" | "required"> & CheckboxCustomProps & import("react").RefAttributes<HTMLInputElement>>;
 export {};

package/dist/esm/Fields/Checkbox/Checkbox.js

@@ -66,7 +66,7 @@ export var Checkbox = /*#__PURE__*/forwardRef(function (_ref, ref) {
   return /*#__PURE__*/_jsxs("div", {
     className: cx(stl(_templateObject2 || (_templateObject2 = _taggedTemplateLiteral(["group/checkbox inline-flex items-center ", ""])), textPosition === "left" && "flex-row-reverse"), className),
     children: [/*#__PURE__*/_jsxs("span", {
-      className: cx(stl(_templateObject3 || (_templateObject3 = _taggedTemplateLiteral(["\n            checkbox focusable-within\n            ", "\n            ", "\n            ", "\n          "])), indeterminate && "checkbox-indeterminate", isChecked && "checkbox-checked", disabled && "checkbox-disabled"), STATUS_CLASSNAMES[status]),
+      className: cx(stl(_templateObject3 || (_templateObject3 = _taggedTemplateLiteral(["\n            checkbox focusable-visible-within\n            ", "\n            ", "\n            ", "\n          "])), indeterminate && "checkbox-indeterminate", isChecked && "checkbox-checked", disabled && "checkbox-disabled"), STATUS_CLASSNAMES[status]),
       style: {
         color: checkedColor
       },
@@ -76,7 +76,7 @@ export var Checkbox = /*#__PURE__*/forwardRef(function (_ref, ref) {
         "aria-labelledby": labelId,
         "aria-describedby": descriptionId
       }, checkboxProps), {}, {
-        id: id !== null && id !== void 0 ? id : inputId,
+        id: id,
         required: required,
         "aria-invalid": status === "invalid",
         "aria-checked": indeterminate ? "mixed" : isChecked,

package/dist/esm/Fields/Dropzone/Dropzone.js

@@ -135,7 +135,7 @@ export var Dropzone = /*#__PURE__*/forwardRef(function (_ref2, ref) {
     "aria-labelledby": labelId,
     "aria-describedby": descriptionId,
     "aria-invalid": isInvalid,
-    className: cx(stl(_templateObject5 || (_templateObject5 = _taggedTemplateLiteral(["\n            relative flex items-center group/dropzone bg-white\n            border border-dashed rounded\n            overflow-hidden transition-colors\n            focusable focus-visible:border-transparent\n            min-h-16 p-4\n            ", "\n            ", "\n            ", ""])), disabled ? "cursor-not-allowed border-grey-200" : "cursor-pointer border-grey-500", isDragReject && !disabled ? "border-red-200 cursor-not-allowed" : isDragActive ? "border-accent-500 cursor-pointer" : null, !disabled && (isInvalid ? "bg-red-100 border-red-700 hover:bg-red-50" : "bg-white hover:bg-grey-100")), className),
+    className: cx(stl(_templateObject5 || (_templateObject5 = _taggedTemplateLiteral(["\n            relative flex items-center group/dropzone bg-white\n            border border-dashed rounded\n            overflow-hidden transition-colors\n            focusable-visible focus-visible:border-transparent\n            min-h-16 p-4\n            ", "\n            ", "\n            ", ""])), disabled ? "cursor-not-allowed border-grey-200" : "cursor-pointer border-grey-500", isDragReject && !disabled ? "border-red-200 cursor-not-allowed" : isDragActive ? "border-accent-500 cursor-pointer" : null, !disabled && (isInvalid ? "bg-red-100 border-red-700 hover:bg-red-50" : "bg-white hover:bg-grey-100")), className),
     onClick: function onClick(evt) {
       // Helps with https://github.com/react-dropzone/react-dropzone/issues/182
       if (evt.target.closest("label")) {