@algolia/satellite 2.2.3 → 2.3.0-rc.10

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

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

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/Chat/ChatMessages/useLastMessageHeight.js

@@ -0,0 +1,48 @@
+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, 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 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(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
+  useLayoutEffect(function () {
+    if (!lastMessageSubmitted) return;
+    updateLastMessageHeight();
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [messages.length, lastMessageSubmitted]);
+  return lastMessageHeight;
+}

package/dist/esm/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>>;

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

@@ -0,0 +1,159 @@
+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", "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 { 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",
+  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,
+    renderHeader = _ref.renderHeader,
+    children = _ref.children,
+    renderFooter = _ref.renderFooter,
+    onSubmit = _ref.onSubmit,
+    onStop = _ref.onStop,
+    staticPlaceholder = _ref.placeholder,
+    _ref$placeholders = _ref.placeholders,
+    placeholders = _ref$placeholders === void 0 ? [] : _ref$placeholders,
+    _ref$status = _ref.status,
+    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,
+    propId = _ref.id,
+    props = _objectWithoutProperties(_ref, _excluded);
+  var contextLocale = useLocale("chatPrompt");
+  var locale = _objectSpread(_objectSpread(_objectSpread({}, DEFAULT_CHAT_PROMPT_LOCALE), contextLocale), propsLocale);
+
+  // eslint-disable-next-line @algolia/stl/prefer-stl-helper
+  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({
+    disabled: props.disabled
+  });
+  var _useState = useState(defaultValue !== null && defaultValue !== void 0 ? defaultValue : ""),
+    _useState2 = _slicedToArray(_useState, 2),
+    internalValue = _useState2[0],
+    setInternalValue = _useState2[1];
+  var isControlled = typeof valueProp !== "undefined";
+  var value = isControlled ? valueProp : internalValue;
+  var hasValue = typeof value === "string" ? value.trim() !== "" : !!value;
+  var canStop = status === "submitted" || status === "streaming";
+  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 (canStop) {
+      onStop === null || onStop === void 0 || onStop();
+      return;
+    }
+    if (!hasValue) {
+      return;
+    }
+    onSubmit === null || onSubmit === void 0 || onSubmit(e);
+  };
+  return /*#__PURE__*/_jsxs("form", {
+    className: styles.base(),
+    onSubmit: submit,
+    dir: rtl ? "rtl" : "ltr",
+    children: [!!renderHeader && /*#__PURE__*/_jsx("div", {
+      className: styles.header(),
+      children: renderHeader
+    }), /*#__PURE__*/_jsx("div", {
+      className: styles.body(),
+      onClick: function onClick(e) {
+        var _internalRef$current;
+        if (e.target === internalRef.current) return;
+        (_internalRef$current = internalRef.current) === null || _internalRef$current === void 0 || _internalRef$current.focus();
+      },
+      children: /*#__PURE__*/_jsx(TextAreaAutoSize, _objectSpread(_objectSpread({
+        id: textareaId,
+        ref: mergeRefs([forwardedRef, internalRef]),
+        rows: 2,
+        maxRows: 8,
+        placeholder: computedPlaceholder,
+        value: value,
+        "aria-label": (_ref2 = placeholders[0] ? placeholders[0] : staticPlaceholder) !== null && _ref2 !== void 0 ? _ref2 : locale.textareaLabel,
+        translate: "no",
+        autoComplete: "off",
+        onInput: function onInput(e) {
+          var _props$onInput;
+          if (!isControlled) {
+            setInternalValue(e.currentTarget.value);
+          }
+          (_props$onInput = props.onInput) === null || _props$onInput === void 0 || _props$onInput.call(props, e);
+        }
+      }, props), {}, {
+        className: styles.textarea({
+          className: className
+        }),
+        onKeyDown: function onKeyDown(e) {
+          var _props$onKeyDown;
+          (_props$onKeyDown = props.onKeyDown) === null || _props$onKeyDown === void 0 || _props$onKeyDown.call(props, e);
+          if (e.key === "Enter" && !e.shiftKey) {
+            submit(e);
+          }
+          if (e.key === "Escape") {
+            e.currentTarget.blur();
+          }
+        },
+        children: /*#__PURE__*/_jsx("div", {
+          className: styles.actions(),
+          children: /*#__PURE__*/_jsx(IconButton, {
+            type: "submit",
+            icon: canStop ? StopCircleIcon : ArrowUpIcon,
+            variant: canStop ? "neutral" : "primary",
+            size: "small",
+            title: props.disabled ? locale.disabledTooltip : buttonDisabled ? locale.emptyMessageTooltip : canStop ? locale.stopResponseTooltip : locale.sendMessageTooltip,
+            tooltipSide: "top",
+            disabled: buttonDisabled,
+            className: styles.submit(),
+            "data-status": status
+          })
+        })
+      }))
+    }), !!renderFooter && /*#__PURE__*/_jsx("div", {
+      className: styles.footer(),
+      children: renderFooter
+    })]
+  });
+});
+ChatPrompt.displayName = "ChatPrompt";

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/Chat/ChatPrompt/ChatPrompt.styles.js

@@ -0,0 +1,22 @@
+import _taggedTemplateLiteral from "@babel/runtime/helpers/taggedTemplateLiteral";
+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"]))),
+    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 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/index.d.ts

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

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

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

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/Chat/ChatPrompt/useFocusTyping.js

@@ -0,0 +1,59 @@
+import { useCallback, useEffect } from "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 var isTextualElement = function isTextualElement(el) {
+  if (el.isContentEditable) return true;
+  var tag = el.tagName.toUpperCase();
+  if (tag === "TEXTAREA") return true;
+  if (tag === "INPUT") {
+    var t = el.type.toLowerCase();
+    return ["text", "search", "url", "email", "tel", "password", "number", "date", "datetime-local", "month", "week", "time"].includes(t);
+  }
+  return false;
+};
+
+// 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 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
+    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;
+    var el = e.target;
+    if (!el || !isTextualElement(el)) {
+      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]);
+}

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

@@ -0,0 +1,27 @@
+export interface UseTypewriterOptions {
+    /**
+     * Milliseconds per character when typing.
+     * @default 150
+     */
+    typingSpeed?: number;
+    /**
+     * Milliseconds per character when deleting.
+     * @default 20
+     */
+    deletingSpeed?: number;
+    /**
+     * Milliseconds to pause after typing a full word before deleting.
+     * @default 1000
+     */
+    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/Chat/ChatPrompt/useTypewriter.js

@@ -0,0 +1,80 @@
+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] : {};
+  var _options$typingSpeed = options.typingSpeed,
+    typingSpeed = _options$typingSpeed === void 0 ? 150 : _options$typingSpeed,
+    _options$deletingSpee = options.deletingSpeed,
+    deletingSpeed = _options$deletingSpee === void 0 ? 20 : _options$deletingSpee,
+    _options$pauseDuratio = options.pauseDuration,
+    pauseDuration = _options$pauseDuratio === void 0 ? 1000 : _options$pauseDuratio;
+  var _useState = useState(""),
+    _useState2 = _slicedToArray(_useState, 2),
+    currentText = _useState2[0],
+    setCurrentText = _useState2[1];
+  var _useState3 = useState(false),
+    _useState4 = _slicedToArray(_useState3, 2),
+    isDeleting = _useState4[0],
+    setIsDeleting = _useState4[1];
+  var _useState5 = useState(0),
+    _useState6 = _slicedToArray(_useState5, 2),
+    loopIndex = _useState6[0],
+    setLoopIndex = _useState6[1];
+  useEffect(function () {
+    if (texts.length === 0 || !enabled) {
+      return;
+    }
+    var currentIndex = loopIndex % texts.length;
+    var fullText = texts[currentIndex];
+    var isFullWord = !isDeleting && currentText === fullText;
+    var isEmptyWord = isDeleting && currentText === "";
+    var nextText;
+    var delay;
+    if (isFullWord) {
+      // Just finished typing the full word: pause, then start deleting
+      nextText = fullText.substring(0, fullText.length - 1);
+      delay = pauseDuration;
+    } else if (isEmptyWord) {
+      // Just finished deleting the word: move to next word
+      nextText = "";
+      delay = typingSpeed;
+    } else {
+      // Normal typing or deleting behavior
+      if (isDeleting) {
+        nextText = fullText.substring(0, currentText.length - 1);
+        delay = deletingSpeed;
+      } else {
+        nextText = fullText.substring(0, currentText.length + 1);
+        delay = typingSpeed;
+      }
+    }
+    var timer = setTimeout(function () {
+      setCurrentText(nextText);
+      if (isFullWord) {
+        // Switch to deleting
+        setIsDeleting(true);
+      } else if (isEmptyWord) {
+        // Reset to typing next word
+        setIsDeleting(false);
+        setLoopIndex(function (prev) {
+          return prev + 1;
+        });
+      }
+      // Otherwise, keep the current isDeleting value
+    }, delay);
+    return function () {
+      return clearTimeout(timer);
+    };
+  }, [enabled, currentText, isDeleting, loopIndex, texts, typingSpeed, deletingSpeed, pauseDuration]);
+  return currentText;
+}

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

@@ -0,0 +1,15 @@
+export type { ChatMessageProps as ExperimentalChatMessageProps } from "./ChatMessage";
+export { ChatMessage as ExperimentalChatMessage } from "./ChatMessage";
+export type { ChatMessagesProps as ExperimentalChatMessagesProps, ChatMessageLocale as ExperimentalChatMessageLocale, } from "./ChatMessages";
+export { ChatMessages as ExperimentalChatMessages } from "./ChatMessages";
+export type { ChatPromptProps as ExperimentalChatPromptProps } from "./ChatPrompt";
+export type { ChatPromptLocale as ExperimentalChatPromptLocale } from "./ChatPrompt";
+export { ChatPrompt as ExperimentalChatPrompt } from "./ChatPrompt";
+export type { ChatContextAccordionProps as ExperimentalChatContextAccordionProps } from "./ChatContextAccordion";
+export { ChatContextAccordion as ExperimentalChatContextAccordion } from "./ChatContextAccordion";
+export type { ChatMessageErrorLocale as ExperimentalChatMessageErrorLocale } from "./ChatMessageError";
+export type { ChatMessageErrorProps as ExperimentalChatMessageErrorProps } from "./ChatMessageError";
+export { ChatMessageError as ExperimentalChatMessageError } from "./ChatMessageError";
+export type { ChatMessageLoaderProps as ExperimentalChatMessageLoaderProps } from "./ChatMessageLoader";
+export { ChatMessageLoader as ExperimentalChatMessageLoader } from "./ChatMessageLoader";
+export type { ChatMessageBase as ExperimentalChatMessageBase, ChatMessageRole as ExperimentalChatMessageRole, ChatStatus as ExperimentalChatStatus, } from "./types";

package/dist/esm/Chat/index.js

@@ -0,0 +1,6 @@
+export { ChatMessage as ExperimentalChatMessage } from "./ChatMessage";
+export { ChatMessages as ExperimentalChatMessages } from "./ChatMessages";
+export { ChatPrompt as ExperimentalChatPrompt } from "./ChatPrompt";
+export { ChatContextAccordion as ExperimentalChatContextAccordion } from "./ChatContextAccordion";
+export { ChatMessageError as ExperimentalChatMessageError } from "./ChatMessageError";
+export { ChatMessageLoader as ExperimentalChatMessageLoader } from "./ChatMessageLoader";

package/dist/esm/Chat/types.d.ts

@@ -0,0 +1,7 @@
+export declare type ChatMessageRole = "system" | "user" | "assistant" | "data";
+export declare type ChatStatus = "submitted" | "streaming" | "ready" | "error";
+export declare type ChatMessageBase = {
+    id: string;
+    role: ChatMessageRole;
+    content: string;
+};

package/dist/esm/Chat/types.js

@@ -0,0 +1 @@
+export {};