@algolia/satellite 2.3.0-rc.6 → 2.3.0-rc.9

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

@@ -0,0 +1,253 @@
+export declare const chatMessageErrorStyles: import("tailwind-variants").TVReturnType<{
+    [key: string]: {
+        [key: string]: import("tailwind-merge").ClassNameValue | {
+            content?: import("tailwind-merge").ClassNameValue;
+        };
+    };
+} | {
+    variant: {
+        neutral: import("tailwind-merge").ClassNameValue | {
+            content?: import("tailwind-merge").ClassNameValue;
+        };
+        subtle: import("tailwind-merge").ClassNameValue | {
+            content?: import("tailwind-merge").ClassNameValue;
+        };
+    };
+    side: {
+        left: import("tailwind-merge").ClassNameValue | {
+            content?: import("tailwind-merge").ClassNameValue;
+        };
+        right: import("tailwind-merge").ClassNameValue | {
+            content?: import("tailwind-merge").ClassNameValue;
+        };
+    };
+    leading: {
+        true: import("tailwind-merge").ClassNameValue | {
+            content?: import("tailwind-merge").ClassNameValue;
+        };
+    };
+    actions: {
+        true: import("tailwind-merge").ClassNameValue | {
+            content?: import("tailwind-merge").ClassNameValue;
+        };
+    };
+    autoHideActions: {
+        true: import("tailwind-merge").ClassNameValue | {
+            content?: import("tailwind-merge").ClassNameValue;
+        };
+    };
+}, {
+    content: 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;
+        };
+        subtle: {
+            message: string;
+        };
+    };
+    side: {
+        left: {
+            container: string;
+        };
+        right: {
+            container: string;
+        };
+    };
+    leading: {
+        true: string;
+    };
+    actions: {
+        true: string;
+    };
+    autoHideActions: {
+        true: string;
+    };
+}, {
+    base: string;
+    container: string;
+    leading: string;
+    content: string;
+    message: string;
+    actions: string;
+    footer: string;
+}, import("tailwind-variants").TVReturnType<{
+    variant: {
+        neutral: {
+            message: string;
+        };
+        subtle: {
+            message: string;
+        };
+    };
+    side: {
+        left: {
+            container: string;
+        };
+        right: {
+            container: string;
+        };
+    };
+    leading: {
+        true: string;
+    };
+    actions: {
+        true: string;
+    };
+    autoHideActions: {
+        true: string;
+    };
+}, {
+    base: string;
+    container: string;
+    leading: string;
+    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;
+        };
+        subtle: {
+            message: string;
+        };
+    };
+    side: {
+        left: {
+            container: string;
+        };
+        right: {
+            container: string;
+        };
+    };
+    leading: {
+        true: string;
+    };
+    actions: {
+        true: string;
+    };
+    autoHideActions: {
+        true: string;
+    };
+}, {
+    base: string;
+    container: string;
+    leading: string;
+    content: string;
+    message: string;
+    actions: string;
+    footer: string;
+}, import("tailwind-variants").TVReturnType<{
+    variant: {
+        neutral: {
+            message: string;
+        };
+        subtle: {
+            message: string;
+        };
+    };
+    side: {
+        left: {
+            container: string;
+        };
+        right: {
+            container: string;
+        };
+    };
+    leading: {
+        true: string;
+    };
+    actions: {
+        true: string;
+    };
+    autoHideActions: {
+        true: string;
+    };
+}, {
+    base: string;
+    container: string;
+    leading: string;
+    content: string;
+    message: string;
+    actions: string;
+    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/cjs/{Layout/Chat → Chat}/ChatMessageError/ChatMessageError.styles.js

@@ -7,8 +7,8 @@ Object.defineProperty(exports, "__esModule", {
 exports.chatMessageErrorStyles = void 0;
 var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
 var _ChatMessage = require("./../ChatMessage/ChatMessage.styles");
-var _satellitePrefixer = _interopRequireDefault(require("./../../../styles/helpers/satellitePrefixer"));
-var _tv = require("./../../../styles/helpers/tv");
+var _satellitePrefixer = _interopRequireDefault(require("./../../styles/helpers/satellitePrefixer"));
+var _tv = require("./../../styles/helpers/tv");
 var _templateObject;
 var chatMessageErrorStyles = exports.chatMessageErrorStyles = (0, _tv.tv)({
   extend: _ChatMessage.chatMessageStyles,

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

@@ -1,18 +1,21 @@
 import type { HTMLAttributes, ReactNode } from "react";
-import type { ChatMessageProps } from "../../../Layout/Chat/ChatMessage";
+import type { ChatMessageProps } from "../../Chat/ChatMessage";
 export declare type ChatMessageLoaderProps = Omit<HTMLAttributes<HTMLElement>, "children"> & Pick<ChatMessageProps, "rtl"> & {
     /**
      * Message to display in the loader.
      * If not provided, no message will be shown.
-     * @default undefined
      */
     message?: ReactNode;
 };
+/**
+ * The `ChatMessageLoader` component provides a message to display when a response is being generated.
+ *
+ * See the [ChatMessageLoader documentation page](https://satellite.algolia.com/8261d6576/p/06f740-chat-message-loader) for more information.
+ */
 export declare const ChatMessageLoader: import("react").ForwardRefExoticComponent<Omit<HTMLAttributes<HTMLElement>, "children"> & Pick<ChatMessageProps<Record<string, any>>, "rtl"> & {
     /**
      * Message to display in the loader.
      * If not provided, no message will be shown.
-     * @default undefined
      */
     message?: ReactNode;
 } & import("react").RefAttributes<HTMLElement>>;

package/dist/cjs/{Layout/Chat → Chat}/ChatMessageLoader/ChatMessageLoader.js

@@ -10,14 +10,19 @@ var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/hel
 var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
 var _react = require("react");
 var _ChatMessageLoader = require("./ChatMessageLoader.styles");
-var _ShimmerText = require("./../../../Helpers/ShimmerText/ShimmerText");
-var _Indicators = require("./../../../Indicators");
-var _satellitePrefixer = _interopRequireDefault(require("./../../../styles/helpers/satellitePrefixer"));
+var _ShimmerText = require("./../../Helpers/ShimmerText/ShimmerText");
+var _Indicators = require("./../../Indicators");
+var _satellitePrefixer = _interopRequireDefault(require("./../../styles/helpers/satellitePrefixer"));
 var _jsxRuntime = require("react/jsx-runtime");
 var _templateObject;
 var _excluded = ["message", "rtl", "className"];
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2["default"])(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+/**
+ * The `ChatMessageLoader` component provides a message to display when a response is being generated.
+ *
+ * See the [ChatMessageLoader documentation page](https://satellite.algolia.com/8261d6576/p/06f740-chat-message-loader) for more information.
+ */
 var ChatMessageLoader = exports.ChatMessageLoader = /*#__PURE__*/(0, _react.forwardRef)(function (_ref, ref) {
   var message = _ref.message,
     rtl = _ref.rtl,
@@ -43,7 +48,7 @@ var ChatMessageLoader = exports.ChatMessageLoader = /*#__PURE__*/(0, _react.forw
         className: styles.content(),
         children: /*#__PURE__*/(0, _jsxRuntime.jsxs)("div", {
           className: styles.message(),
-          children: [/*#__PURE__*/(0, _jsxRuntime.jsx)(_ShimmerText.ShimmerText, {
+          children: [!!message && /*#__PURE__*/(0, _jsxRuntime.jsx)(_ShimmerText.ShimmerText, {
             children: message
           }), /*#__PURE__*/(0, _jsxRuntime.jsxs)("div", {
             className: styles.skeletonWrapper(),

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

@@ -7,8 +7,8 @@ Object.defineProperty(exports, "__esModule", {
 exports.chatMessageLoaderStyles = void 0;
 var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
 var _ChatMessage = require("./../ChatMessage/ChatMessage.styles");
-var _satellitePrefixer = _interopRequireDefault(require("./../../../styles/helpers/satellitePrefixer"));
-var _tv = require("./../../../styles/helpers/tv");
+var _satellitePrefixer = _interopRequireDefault(require("./../../styles/helpers/satellitePrefixer"));
+var _tv = require("./../../styles/helpers/tv");
 var _templateObject, _templateObject2, _templateObject3, _templateObject4;
 var chatMessageLoaderStyles = exports.chatMessageLoaderStyles = (0, _tv.tv)({
   extend: _ChatMessage.chatMessageStyles,

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

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