@yext/chat-ui-react 0.8.1-alpha.53.2 → 0.8.2

package/src/components/FeedbackButtons.tsx

@@ -39,9 +39,9 @@ const builtInCssClasses: FeedbackButtonsCssClasses =
 /**
  * The props for the FeedbackButtons component.
  *
- * @public
+ * @internal
  */
-export interface FeedbackButtonsProps {
+interface FeedbackButtonsProps {
   /** The response ID correlates to the current message to give feedback on. */
   responseId?: string;
   /** CSS classes for customizing the component styling. */
@@ -52,7 +52,7 @@ export interface FeedbackButtonsProps {
  * Displays feedback buttons (e.g. thumbs up and thumbs down) that will
  * report analytic events on click.
  *
- * @public
+ * @internal
  */
 export function FeedbackButtons({
   customCssClasses,

package/src/components/Markdown.tsx

@@ -19,12 +19,7 @@ const unifiedPlugins: { remark?: PluggableList; rehype: PluggableList } = {
   ],
 };
 
-/**
- * The props for the {@link Markdown} component.
- * 
- * @public
- */
-export interface MarkdownProps {
+interface MarkdownProps {
   /** Stringified markdown. */
   content: string;
   /** The response ID correlates to the current message. */
@@ -40,7 +35,7 @@ export interface MarkdownProps {
  * @remarks
  * A link click will send a CHAT_LINK_CLICK analytics event
  *
- * @public
+ * @internal
  */
 export function Markdown({ content, responseId, className }: MarkdownProps) {
   const reportAnalyticsEvent = useReportAnalyticsEvent();

package/src/components/MessageSuggestions.tsx

@@ -0,0 +1,71 @@
+import React, { useCallback } from "react";
+import { useChatActions } from "@yext/chat-headless-react";
+import { useDefaultHandleApiError } from "../hooks/useDefaultHandleApiError";
+import { withStylelessCssClasses } from "../utils/withStylelessCssClasses";
+import { useComposedCssClasses } from "../hooks";
+
+/**
+ * The CSS class interface for the MessageSuggestion component.
+ *
+ * @public
+ */
+export interface MessageSuggestionCssClasses {
+  container?: string;
+  suggestion?: string;
+}
+
+/**
+ * The props for the MessageSuggestions component.
+ *
+ * @public
+ */
+export interface MessageSuggestionsProps {
+  suggestions: string[];
+  customCssClasses?: MessageSuggestionCssClasses;
+}
+
+const defaultClassnames: MessageSuggestionCssClasses = withStylelessCssClasses(
+  "Suggestions",
+  {
+    container: "flex gap-2 mt-4 w-full overflow-x-auto flex-wrap",
+    suggestion:
+      "hover:cursor-pointer px-2 py-1 bg-white hover:bg-slate-300 rounded-full text-sm text-blue-700 border border-blue-700 hover:underline",
+  }
+);
+
+/**
+ * A component that displays a list of suggested messages
+ * to the user, which they can click to send the message to the bot.
+ *
+ * @internal
+ */
+export const MessageSuggestions: React.FC<MessageSuggestionsProps> = ({
+  suggestions,
+  customCssClasses,
+}) => {
+  const actions = useChatActions();
+  const defaultHandleApiError = useDefaultHandleApiError();
+  const sendMsg = useCallback(
+    (msg: string) => {
+      const res = actions.getNextMessage(msg);
+      res.catch(defaultHandleApiError);
+    },
+    [defaultHandleApiError, actions]
+  );
+
+  const classes = useComposedCssClasses(defaultClassnames, customCssClasses);
+
+  return (
+    <div className={classes.container}>
+      {suggestions.map((suggestion, index) => (
+        <button
+          key={index}
+          className={classes.suggestion}
+          onClick={() => sendMsg(suggestion)}
+        >
+          {suggestion}
+        </button>
+      ))}
+    </div>
+  );
+};

package/src/components/index.ts

@@ -16,10 +16,10 @@ export type { ChatPanelCssClasses, ChatPanelProps } from "./ChatPanel";
 export { ChatPopUp } from "./ChatPopUp";
 export type { ChatPopUpCssClasses, ChatPopUpProps } from "./ChatPopUp";
 
-export { FeedbackButtons } from "./FeedbackButtons";
-export type { FeedbackButtonsCssClasses, FeedbackButtonsProps } from "./FeedbackButtons";
-
-export { Markdown } from "./Markdown";
-export { MarkdownProps } from "./Markdown";
-
+export type { FeedbackButtonsCssClasses } from "./FeedbackButtons";
 export type { InitialMessagePopUpCssClasses } from "./InitialMessagePopUp";
+
+export type {
+  MessageSuggestionCssClasses,
+  MessageSuggestionsProps,
+} from "./MessageSuggestions";

package/src/hooks/index.ts

@@ -1,5 +1,2 @@
 export { useComposedCssClasses } from "./useComposedCssClasses";
-export { useDefaultHandleApiError } from "./useDefaultHandleApiError";
-export { useFetchInitialMessage } from "./useFetchInitialMessage";
 export { useReportAnalyticsEvent } from "./useReportAnalyticsEvent";
-export { useScrollToLastMessage } from "./useScrollToLastMessage";

package/src/hooks/useDefaultHandleApiError.ts

@@ -5,7 +5,7 @@ import { useCallback } from "react";
  * Returns a default handler function for API errors. It will log the error and
  * add a default error message to state.
  *
- * @public
+ * @internal
  */
 export function useDefaultHandleApiError() {
   const chat = useChatActions();

package/src/hooks/useFetchInitialMessage.ts

@@ -6,7 +6,7 @@ import { useDefaultHandleApiError } from "../hooks/useDefaultHandleApiError";
  * Sends a request to Chat API to fetch the initial message when the
  * conversation first start or when the message history is reset.
  *
- * @public
+ * @internal
  *
  * @param handleError - A function which is called when an error occurs while fetching for initial message.
  *                      By default, the error is logged to the console and an error message is added to state.

package/src/hooks/useReportAnalyticsEvent.ts

@@ -4,8 +4,6 @@ import { useCallback } from "react";
 
 /**
  * Returns a function to send requests to Yext Analytics API.
- * The payload will automatically includes chat-ui-react's
- * package version for "clientSdk" field.
  *
  * @public
  */

package/lib/commonjs/src/hooks/useScrollToLastMessage.d.ts

@@ -1,15 +0,0 @@
-import React from "react";
-/**
- * Scroll the messsages container to the top of the last message whenever there's
- * an update to the messages state.
- *
- * @public
- *
- * @returns a ref to set on the messages container element and
- *  a function to set ref on individual message element
- */
-export declare function useScrollToLastMessage(): [
-    React.RefObject<HTMLDivElement>,
-    (index: number) => ((message: HTMLDivElement) => void) | undefined
-];
-//# sourceMappingURL=useScrollToLastMessage.d.ts.map

package/lib/commonjs/src/hooks/useScrollToLastMessage.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useScrollToLastMessage.d.ts","sourceRoot":"","sources":["../../../../src/hooks/useScrollToLastMessage.ts"],"names":[],"mappings":"AACA,OAAO,KAAyC,MAAM,OAAO,CAAC;AAE9D;;;;;;;;GAQG;AACH,wBAAgB,sBAAsB,IAAI;IACxC,KAAK,CAAC,SAAS,CAAC,cAAc,CAAC;IAC/B,CAAC,KAAK,EAAE,MAAM,KAAK,CAAC,CAAC,OAAO,EAAE,cAAc,KAAK,IAAI,CAAC,GAAG,SAAS;CACnE,CA+BA"}

package/lib/commonjs/src/hooks/useScrollToLastMessage.js

@@ -1,45 +0,0 @@
-'use strict';
-
-var chatHeadlessReact = require('@yext/chat-headless-react');
-var React = require('react');
-
-/**
- * Scroll the messsages container to the top of the last message whenever there's
- * an update to the messages state.
- *
- * @public
- *
- * @returns a ref to set on the messages container element and
- *  a function to set ref on individual message element
- */
-function useScrollToLastMessage() {
-    const messagesRef = React.useRef([]);
-    const messagesContainerRef = React.useRef(null);
-    const messages = chatHeadlessReact.useChatState((state) => state.conversation.messages);
-    // Handle scrolling when messages change
-    React.useEffect(() => {
-        let scrollTop = 0;
-        messagesRef.current = messagesRef.current.slice(0, messages.length);
-        // Sums up scroll heights of all messages except the last one
-        if (messagesRef?.current.length > 1) {
-            scrollTop = messagesRef.current
-                .slice(0, -1)
-                .map((elem, _) => elem?.scrollHeight ?? 0)
-                .reduce((total, height) => total + height);
-        }
-        // Scroll to the top of the last message
-        messagesContainerRef.current?.scroll({
-            top: scrollTop,
-            behavior: "smooth",
-        });
-    }, [messages]);
-    const setMessageRef = React.useCallback((index) => {
-        if (!messagesRef?.current)
-            return undefined;
-        return (message) => (messagesRef.current[index] = message);
-    }, []);
-    return [messagesContainerRef, setMessageRef];
-}
-
-exports.useScrollToLastMessage = useScrollToLastMessage;
-//# sourceMappingURL=useScrollToLastMessage.js.map

package/lib/commonjs/src/hooks/useScrollToLastMessage.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"useScrollToLastMessage.js","sources":["../../../../src/hooks/useScrollToLastMessage.ts"],"sourcesContent":["import { useChatState } from \"@yext/chat-headless-react\";\nimport React, { useCallback, useEffect, useRef } from \"react\";\n\n/**\n * Scroll the messsages container to the top of the last message whenever there's\n * an update to the messages state.\n * \n * @public\n * \n * @returns a ref to set on the messages container element and\n *  a function to set ref on individual message element\n */\nexport function useScrollToLastMessage(): [\n  React.RefObject<HTMLDivElement>,\n  (index: number) => ((message: HTMLDivElement) => void) | undefined\n] {\n  const messagesRef = useRef<Array<HTMLDivElement | null>>([]);\n  const messagesContainerRef = useRef<HTMLDivElement>(null);\n  const messages = useChatState((state) => state.conversation.messages);\n\n  // Handle scrolling when messages change\n  useEffect(() => {\n    let scrollTop = 0;\n    messagesRef.current = messagesRef.current.slice(0, messages.length);\n\n    // Sums up scroll heights of all messages except the last one\n    if (messagesRef?.current.length > 1) {\n      scrollTop = messagesRef.current\n        .slice(0, -1)\n        .map((elem, _) => elem?.scrollHeight ?? 0)\n        .reduce((total, height) => total + height);\n    }\n\n    // Scroll to the top of the last message\n    messagesContainerRef.current?.scroll({\n      top: scrollTop,\n      behavior: \"smooth\",\n    });\n  }, [messages]);\n\n  const setMessageRef = useCallback((index) => {\n    if (!messagesRef?.current) return undefined;\n    return (message: HTMLDivElement) => (messagesRef.current[index] = message);\n  }, []);\n\n  return [messagesContainerRef, setMessageRef]\n}"],"names":["useRef","useChatState","useEffect","useCallback"],"mappings":";;;;;AAGA;;;;;;;;AAQG;SACa,sBAAsB,GAAA;AAIpC,IAAA,MAAM,WAAW,GAAGA,YAAM,CAA+B,EAAE,CAAC,CAAC;AAC7D,IAAA,MAAM,oBAAoB,GAAGA,YAAM,CAAiB,IAAI,CAAC,CAAC;AAC1D,IAAA,MAAM,QAAQ,GAAGC,8BAAY,CAAC,CAAC,KAAK,KAAK,KAAK,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;;IAGtEC,eAAS,CAAC,MAAK;QACb,IAAI,SAAS,GAAG,CAAC,CAAC;AAClB,QAAA,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;;AAGpE,QAAA,IAAI,WAAW,EAAE,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YACnC,SAAS,GAAG,WAAW,CAAC,OAAO;AAC5B,iBAAA,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AACZ,iBAAA,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,EAAE,YAAY,IAAI,CAAC,CAAC;AACzC,iBAAA,MAAM,CAAC,CAAC,KAAK,EAAE,MAAM,KAAK,KAAK,GAAG,MAAM,CAAC,CAAC;AAC9C,SAAA;;AAGD,QAAA,oBAAoB,CAAC,OAAO,EAAE,MAAM,CAAC;AACnC,YAAA,GAAG,EAAE,SAAS;AACd,YAAA,QAAQ,EAAE,QAAQ;AACnB,SAAA,CAAC,CAAC;AACL,KAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;AAEf,IAAA,MAAM,aAAa,GAAGC,iBAAW,CAAC,CAAC,KAAK,KAAI;QAC1C,IAAI,CAAC,WAAW,EAAE,OAAO;AAAE,YAAA,OAAO,SAAS,CAAC;AAC5C,QAAA,OAAO,CAAC,OAAuB,MAAM,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,CAAC;KAC5E,EAAE,EAAE,CAAC,CAAC;AAEP,IAAA,OAAO,CAAC,oBAAoB,EAAE,aAAa,CAAC,CAAA;AAC9C;;;;"}

package/lib/esm/src/hooks/useScrollToLastMessage.d.ts

@@ -1,15 +0,0 @@
-import React from "react";
-/**
- * Scroll the messsages container to the top of the last message whenever there's
- * an update to the messages state.
- *
- * @public
- *
- * @returns a ref to set on the messages container element and
- *  a function to set ref on individual message element
- */
-export declare function useScrollToLastMessage(): [
-    React.RefObject<HTMLDivElement>,
-    (index: number) => ((message: HTMLDivElement) => void) | undefined
-];
-//# sourceMappingURL=useScrollToLastMessage.d.ts.map

package/lib/esm/src/hooks/useScrollToLastMessage.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useScrollToLastMessage.d.ts","sourceRoot":"","sources":["../../../../src/hooks/useScrollToLastMessage.ts"],"names":[],"mappings":"AACA,OAAO,KAAyC,MAAM,OAAO,CAAC;AAE9D;;;;;;;;GAQG;AACH,wBAAgB,sBAAsB,IAAI;IACxC,KAAK,CAAC,SAAS,CAAC,cAAc,CAAC;IAC/B,CAAC,KAAK,EAAE,MAAM,KAAK,CAAC,CAAC,OAAO,EAAE,cAAc,KAAK,IAAI,CAAC,GAAG,SAAS;CACnE,CA+BA"}

package/lib/esm/src/hooks/useScrollToLastMessage.mjs

@@ -1,43 +0,0 @@
-import { useChatState } from '@yext/chat-headless-react';
-import { useRef, useEffect, useCallback } from 'react';
-
-/**
- * Scroll the messsages container to the top of the last message whenever there's
- * an update to the messages state.
- *
- * @public
- *
- * @returns a ref to set on the messages container element and
- *  a function to set ref on individual message element
- */
-function useScrollToLastMessage() {
-    const messagesRef = useRef([]);
-    const messagesContainerRef = useRef(null);
-    const messages = useChatState((state) => state.conversation.messages);
-    // Handle scrolling when messages change
-    useEffect(() => {
-        let scrollTop = 0;
-        messagesRef.current = messagesRef.current.slice(0, messages.length);
-        // Sums up scroll heights of all messages except the last one
-        if (messagesRef?.current.length > 1) {
-            scrollTop = messagesRef.current
-                .slice(0, -1)
-                .map((elem, _) => elem?.scrollHeight ?? 0)
-                .reduce((total, height) => total + height);
-        }
-        // Scroll to the top of the last message
-        messagesContainerRef.current?.scroll({
-            top: scrollTop,
-            behavior: "smooth",
-        });
-    }, [messages]);
-    const setMessageRef = useCallback((index) => {
-        if (!messagesRef?.current)
-            return undefined;
-        return (message) => (messagesRef.current[index] = message);
-    }, []);
-    return [messagesContainerRef, setMessageRef];
-}
-
-export { useScrollToLastMessage };
-//# sourceMappingURL=useScrollToLastMessage.mjs.map

package/lib/esm/src/hooks/useScrollToLastMessage.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"useScrollToLastMessage.mjs","sources":["../../../../src/hooks/useScrollToLastMessage.ts"],"sourcesContent":["import { useChatState } from \"@yext/chat-headless-react\";\nimport React, { useCallback, useEffect, useRef } from \"react\";\n\n/**\n * Scroll the messsages container to the top of the last message whenever there's\n * an update to the messages state.\n * \n * @public\n * \n * @returns a ref to set on the messages container element and\n *  a function to set ref on individual message element\n */\nexport function useScrollToLastMessage(): [\n  React.RefObject<HTMLDivElement>,\n  (index: number) => ((message: HTMLDivElement) => void) | undefined\n] {\n  const messagesRef = useRef<Array<HTMLDivElement | null>>([]);\n  const messagesContainerRef = useRef<HTMLDivElement>(null);\n  const messages = useChatState((state) => state.conversation.messages);\n\n  // Handle scrolling when messages change\n  useEffect(() => {\n    let scrollTop = 0;\n    messagesRef.current = messagesRef.current.slice(0, messages.length);\n\n    // Sums up scroll heights of all messages except the last one\n    if (messagesRef?.current.length > 1) {\n      scrollTop = messagesRef.current\n        .slice(0, -1)\n        .map((elem, _) => elem?.scrollHeight ?? 0)\n        .reduce((total, height) => total + height);\n    }\n\n    // Scroll to the top of the last message\n    messagesContainerRef.current?.scroll({\n      top: scrollTop,\n      behavior: \"smooth\",\n    });\n  }, [messages]);\n\n  const setMessageRef = useCallback((index) => {\n    if (!messagesRef?.current) return undefined;\n    return (message: HTMLDivElement) => (messagesRef.current[index] = message);\n  }, []);\n\n  return [messagesContainerRef, setMessageRef]\n}"],"names":[],"mappings":";;;AAGA;;;;;;;;AAQG;SACa,sBAAsB,GAAA;AAIpC,IAAA,MAAM,WAAW,GAAG,MAAM,CAA+B,EAAE,CAAC,CAAC;AAC7D,IAAA,MAAM,oBAAoB,GAAG,MAAM,CAAiB,IAAI,CAAC,CAAC;AAC1D,IAAA,MAAM,QAAQ,GAAG,YAAY,CAAC,CAAC,KAAK,KAAK,KAAK,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;;IAGtE,SAAS,CAAC,MAAK;QACb,IAAI,SAAS,GAAG,CAAC,CAAC;AAClB,QAAA,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;;AAGpE,QAAA,IAAI,WAAW,EAAE,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YACnC,SAAS,GAAG,WAAW,CAAC,OAAO;AAC5B,iBAAA,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AACZ,iBAAA,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,EAAE,YAAY,IAAI,CAAC,CAAC;AACzC,iBAAA,MAAM,CAAC,CAAC,KAAK,EAAE,MAAM,KAAK,KAAK,GAAG,MAAM,CAAC,CAAC;AAC9C,SAAA;;AAGD,QAAA,oBAAoB,CAAC,OAAO,EAAE,MAAM,CAAC;AACnC,YAAA,GAAG,EAAE,SAAS;AACd,YAAA,QAAQ,EAAE,QAAQ;AACnB,SAAA,CAAC,CAAC;AACL,KAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;AAEf,IAAA,MAAM,aAAa,GAAG,WAAW,CAAC,CAAC,KAAK,KAAI;QAC1C,IAAI,CAAC,WAAW,EAAE,OAAO;AAAE,YAAA,OAAO,SAAS,CAAC;AAC5C,QAAA,OAAO,CAAC,OAAuB,MAAM,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,CAAC;KAC5E,EAAE,EAAE,CAAC,CAAC;AAEP,IAAA,OAAO,CAAC,oBAAoB,EAAE,aAAa,CAAC,CAAA;AAC9C;;;;"}

package/src/hooks/useScrollToLastMessage.ts

@@ -1,47 +0,0 @@
-import { useChatState } from "@yext/chat-headless-react";
-import React, { useCallback, useEffect, useRef } from "react";
-
-/**
- * Scroll the messsages container to the top of the last message whenever there's
- * an update to the messages state.
- * 
- * @public
- * 
- * @returns a ref to set on the messages container element and
- *  a function to set ref on individual message element
- */
-export function useScrollToLastMessage(): [
-  React.RefObject<HTMLDivElement>,
-  (index: number) => ((message: HTMLDivElement) => void) | undefined
-] {
-  const messagesRef = useRef<Array<HTMLDivElement | null>>([]);
-  const messagesContainerRef = useRef<HTMLDivElement>(null);
-  const messages = useChatState((state) => state.conversation.messages);
-
-  // Handle scrolling when messages change
-  useEffect(() => {
-    let scrollTop = 0;
-    messagesRef.current = messagesRef.current.slice(0, messages.length);
-
-    // Sums up scroll heights of all messages except the last one
-    if (messagesRef?.current.length > 1) {
-      scrollTop = messagesRef.current
-        .slice(0, -1)
-        .map((elem, _) => elem?.scrollHeight ?? 0)
-        .reduce((total, height) => total + height);
-    }
-
-    // Scroll to the top of the last message
-    messagesContainerRef.current?.scroll({
-      top: scrollTop,
-      behavior: "smooth",
-    });
-  }, [messages]);
-
-  const setMessageRef = useCallback((index) => {
-    if (!messagesRef?.current) return undefined;
-    return (message: HTMLDivElement) => (messagesRef.current[index] = message);
-  }, []);
-
-  return [messagesContainerRef, setMessageRef]
-}