@algolia/satellite 2.2.3 → 2.3.0-rc.10

package/dist/esm/Chat/ChatMessage/ChatMessage.styles.js

@@ -0,0 +1,70 @@
+import _taggedTemplateLiteral from "@babel/runtime/helpers/taggedTemplateLiteral";
+var _templateObject, _templateObject2, _templateObject3, _templateObject4, _templateObject5, _templateObject6, _templateObject7, _templateObject8, _templateObject9, _templateObject10, _templateObject11, _templateObject12, _templateObject13, _templateObject14, _templateObject15, _templateObject16, _templateObject17, _templateObject18;
+import stl from "./../../styles/helpers/satellitePrefixer";
+import { tv } from "./../../styles/helpers/tv";
+export var chatMessageStyles = tv({
+  slots: {
+    base: stl(_templateObject || (_templateObject = _taggedTemplateLiteral(["relative w-full scroll-mt-4 group/message"]))),
+    container: stl(_templateObject2 || (_templateObject2 = _taggedTemplateLiteral(["relative flex items-start group-data-[role=user]/message:max-w-[70%] gap-3"]))),
+    leading: stl(_templateObject3 || (_templateObject3 = _taggedTemplateLiteral(["inline-flex items-center justify-center"]))),
+    content: stl(_templateObject4 || (_templateObject4 = _taggedTemplateLiteral(["flex flex-col gap-3 group-data-[role=assistant]/message:grow overflow-y-hidden overflow-x-auto"]))),
+    message: stl(_templateObject5 || (_templateObject5 = _taggedTemplateLiteral(["relative text-pretty typo-display-body"]))),
+    actions: stl(_templateObject6 || (_templateObject6 = _taggedTemplateLiteral(["flex items-center gap-1"]))),
+    footer: stl(_templateObject7 || (_templateObject7 = _taggedTemplateLiteral([""])))
+  },
+  variants: {
+    variant: {
+      neutral: {
+        message: stl(_templateObject8 || (_templateObject8 = _taggedTemplateLiteral(["bg-grey-100"])))
+      },
+      subtle: {
+        message: stl(_templateObject9 || (_templateObject9 = _taggedTemplateLiteral([""])))
+      }
+    },
+    side: {
+      left: {
+        container: stl(_templateObject10 || (_templateObject10 = _taggedTemplateLiteral(["justify-start"])))
+      },
+      right: {
+        container: stl(_templateObject11 || (_templateObject11 = _taggedTemplateLiteral(["justify-end ms-auto"])))
+      }
+    },
+    leading: {
+      "true": stl(_templateObject12 || (_templateObject12 = _taggedTemplateLiteral([""])))
+    },
+    actions: {
+      "true": stl(_templateObject13 || (_templateObject13 = _taggedTemplateLiteral([""])))
+    },
+    autoHideActions: {
+      "true": stl(_templateObject14 || (_templateObject14 = _taggedTemplateLiteral([""])))
+    }
+  },
+  compoundVariants: [{
+    variant: "neutral",
+    className: {
+      message: stl(_templateObject15 || (_templateObject15 = _taggedTemplateLiteral(["p-3 rounded-[8px]"])))
+    }
+  }, {
+    leading: true,
+    side: "left",
+    className: {
+      actions: stl(_templateObject16 || (_templateObject16 = _taggedTemplateLiteral(["left-11"])))
+    }
+  }, {
+    actions: true,
+    autoHideActions: true,
+    className: {
+      actions: stl(_templateObject17 || (_templateObject17 = _taggedTemplateLiteral(["opacity-0 group-hover/message:opacity-100 transition-opacity"])))
+    }
+  }, {
+    actions: true,
+    side: "right",
+    className: {
+      actions: stl(_templateObject18 || (_templateObject18 = _taggedTemplateLiteral(["justify-end"])))
+    }
+  }],
+  defaultVariants: {
+    variant: "subtle",
+    side: "left"
+  }
+});

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

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

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

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

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

@@ -0,0 +1,62 @@
+import type { HTMLAttributes, ReactNode } from "react";
+import type { ButtonProps } from "../../Actions";
+import type { ChatMessageProps } from "../../Chat/ChatMessage";
+export declare type ChatMessageErrorLocale = {
+    error?: string;
+    retry?: string;
+};
+export declare type ChatMessageErrorProps = Omit<HTMLAttributes<HTMLElement>, "children"> & Pick<ChatMessageProps, "rtl"> & {
+    /**
+     * Content to render as the error message.
+     * If not provided, a default error message will be shown.
+     */
+    renderError?: ReactNode;
+    /**
+     * Content to render below the error message.
+     */
+    renderFooter?: ReactNode;
+    /**
+     * Optional actions to display below the error message.
+     * If not provided, a default retry button will be shown.
+     */
+    actions?: ButtonProps[];
+    /**
+     * Callback function to be called when the retry button is clicked.
+     * If not provided, the default retry button will not have any action.
+     */
+    onReload?: () => void;
+    /**
+     * Optional locale.
+     */
+    locale?: ChatMessageErrorLocale;
+};
+/**
+ * The `ChatMessageError` component provides a message to display when an error occurs.
+ *
+ * See the [ChatMessageError documentation page](https://satellite.algolia.com/8261d6576/p/06f740-chat-message-error) for more information.
+ */
+export declare const ChatMessageError: import("react").ForwardRefExoticComponent<Omit<HTMLAttributes<HTMLElement>, "children"> & Pick<ChatMessageProps<Record<string, any>>, "rtl"> & {
+    /**
+     * Content to render as the error message.
+     * If not provided, a default error message will be shown.
+     */
+    renderError?: ReactNode;
+    /**
+     * Content to render below the error message.
+     */
+    renderFooter?: ReactNode;
+    /**
+     * Optional actions to display below the error message.
+     * If not provided, a default retry button will be shown.
+     */
+    actions?: ButtonProps[] | undefined;
+    /**
+     * Callback function to be called when the retry button is clicked.
+     * If not provided, the default retry button will not have any action.
+     */
+    onReload?: (() => void) | undefined;
+    /**
+     * Optional locale.
+     */
+    locale?: ChatMessageErrorLocale | undefined;
+} & import("react").RefAttributes<HTMLElement>>;

package/dist/esm/Chat/ChatMessageError/ChatMessageError.js

@@ -0,0 +1,66 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["renderError", "actions", "renderFooter", "locale", "onReload", "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) { _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 { forwardRef } from "react";
+import { chatMessageErrorStyles } from "./ChatMessageError.styles";
+import { Button } from "./../../Actions";
+import { RotateCwIcon } from "./../../Icons";
+import { useLocale } from "./../../Satellite";
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+var DEFAULT_CHAT_MESSAGE_ERROR_LOCALE = {
+  error: "Sorry, we are not able to generate a response at the moment. Please retry or contact support.",
+  retry: "Retry"
+};
+/**
+ * The `ChatMessageError` component provides a message to display when an error occurs.
+ *
+ * See the [ChatMessageError documentation page](https://satellite.algolia.com/8261d6576/p/06f740-chat-message-error) for more information.
+ */
+export var ChatMessageError = /*#__PURE__*/forwardRef(function (_ref, ref) {
+  var renderError = _ref.renderError,
+    actions = _ref.actions,
+    renderFooter = _ref.renderFooter,
+    propsLocale = _ref.locale,
+    onReload = _ref.onReload,
+    rtl = _ref.rtl,
+    className = _ref.className,
+    props = _objectWithoutProperties(_ref, _excluded);
+  var contextLocale = useLocale("chatMessageError");
+  var locale = _objectSpread(_objectSpread(_objectSpread({}, DEFAULT_CHAT_MESSAGE_ERROR_LOCALE), contextLocale), propsLocale);
+  var styles = chatMessageErrorStyles({
+    side: "left",
+    variant: "subtle"
+  });
+  return /*#__PURE__*/_jsx("article", _objectSpread(_objectSpread({}, props), {}, {
+    ref: ref,
+    className: styles.base({
+      className: className
+    }),
+    dir: rtl ? "rtl" : "ltr",
+    children: /*#__PURE__*/_jsx("div", {
+      className: styles.container(),
+      children: /*#__PURE__*/_jsxs("div", {
+        className: styles.content(),
+        children: [/*#__PURE__*/_jsx("div", {
+          className: styles.message(),
+          children: renderError !== null && renderError !== void 0 ? renderError : locale.error
+        }), actions ? /*#__PURE__*/_jsx("div", {
+          className: styles.actions(),
+          children: actions.map(function (action, index) {
+            return /*#__PURE__*/_jsx(Button, _objectSpread(_objectSpread({}, action), {}, {
+              children: action.children
+            }), index);
+          })
+        }) : /*#__PURE__*/_jsx(Button, {
+          variant: "primary",
+          startIcon: RotateCwIcon,
+          onClick: onReload,
+          children: locale.retry
+        }), renderFooter]
+      })
+    })
+  }));
+});
+ChatMessageError.displayName = "ChatMessageError";

package/dist/esm/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/esm/Chat/ChatMessageError/ChatMessageError.styles.js

@@ -0,0 +1,11 @@
+import _taggedTemplateLiteral from "@babel/runtime/helpers/taggedTemplateLiteral";
+var _templateObject;
+import { chatMessageStyles } from "./../ChatMessage/ChatMessage.styles";
+import stl from "./../../styles/helpers/satellitePrefixer";
+import { tv } from "./../../styles/helpers/tv";
+export var chatMessageErrorStyles = tv({
+  extend: chatMessageStyles,
+  slots: {
+    content: stl(_templateObject || (_templateObject = _taggedTemplateLiteral(["w-full items-start"])))
+  }
+});

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

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

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

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

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

@@ -0,0 +1,21 @@
+import type { HTMLAttributes, ReactNode } from "react";
+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.
+     */
+    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.
+     */
+    message?: ReactNode;
+} & import("react").RefAttributes<HTMLElement>>;

package/dist/esm/Chat/ChatMessageLoader/ChatMessageLoader.js

@@ -0,0 +1,61 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _taggedTemplateLiteral from "@babel/runtime/helpers/taggedTemplateLiteral";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+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) { _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 { forwardRef } from "react";
+import { chatMessageLoaderStyles } from "./ChatMessageLoader.styles";
+import { ShimmerText } from "./../../Helpers/ShimmerText/ShimmerText";
+import { ProgressSpinner, Skeleton } from "./../../Indicators";
+import stl from "./../../styles/helpers/satellitePrefixer";
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+/**
+ * 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 var ChatMessageLoader = /*#__PURE__*/forwardRef(function (_ref, ref) {
+  var message = _ref.message,
+    rtl = _ref.rtl,
+    className = _ref.className,
+    props = _objectWithoutProperties(_ref, _excluded);
+  var styles = chatMessageLoaderStyles({
+    side: "left",
+    variant: "subtle",
+    leading: true
+  });
+  return /*#__PURE__*/_jsx("article", _objectSpread(_objectSpread({}, props), {}, {
+    ref: ref,
+    className: styles.base({
+      className: className
+    }),
+    dir: rtl ? "rtl" : "ltr",
+    children: /*#__PURE__*/_jsxs("div", {
+      className: styles.container(),
+      children: [/*#__PURE__*/_jsx("div", {
+        className: styles.leading(),
+        children: /*#__PURE__*/_jsx(ProgressSpinner, {})
+      }), /*#__PURE__*/_jsx("div", {
+        className: styles.content(),
+        children: /*#__PURE__*/_jsxs("div", {
+          className: styles.message(),
+          children: [!!message && /*#__PURE__*/_jsx(ShimmerText, {
+            children: message
+          }), /*#__PURE__*/_jsxs("div", {
+            className: styles.skeletonWrapper(),
+            children: [/*#__PURE__*/_jsx(Skeleton, {
+              className: styles.skeleton()
+            }), /*#__PURE__*/_jsx(Skeleton, {
+              className: styles.skeleton({
+                className: stl(_templateObject || (_templateObject = _taggedTemplateLiteral(["w-2/5"])))
+              })
+            })]
+          })]
+        })
+      })]
+    })
+  }));
+});
+ChatMessageLoader.displayName = "ChatMessageLoader";