@yext/chat-ui-react 0.7.2 → 0.8.0

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

@@ -0,0 +1,51 @@
+import { useState, useEffect } from 'react';
+import { useChatActions, useChatState } from '@yext/chat-headless-react';
+import { useDefaultHandleApiError } from './useDefaultHandleApiError.mjs';
+
+/**
+ * Sends a request to Chat API to fetch the initial message when the
+ * conversation first start or when the message history is reset.
+ *
+ * @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.
+ * @param stream      - Enable streaming behavior by making a request to Chat Streaming API. Defaults to false.
+ * @param customCondition - additional condition for when to fetch initial message
+ */
+function useFetchInitialMessage(handleError, stream = false, customCondition = true) {
+    const chat = useChatActions();
+    const defaultHandleApiError = useDefaultHandleApiError();
+    const messages = useChatState((state) => state.conversation.messages);
+    const [fetchInitialMessage, setFetchInitialMessage] = useState(messages.length === 0);
+    const [messagesLength, setMessagesLength] = useState(messages.length);
+    const canSendMessage = useChatState((state) => state.conversation.canSendMessage);
+    //handle message history resets
+    useEffect(() => {
+        const newMessagesLength = messages.length;
+        // Fetch data only when the conversation messages changes from non-zero to zero
+        if (messagesLength > 0 && newMessagesLength === 0) {
+            setFetchInitialMessage(true);
+        }
+        setMessagesLength(newMessagesLength);
+    }, [messages.length, messagesLength]);
+    useEffect(() => {
+        if (!fetchInitialMessage || !canSendMessage || !customCondition) {
+            return;
+        }
+        setFetchInitialMessage(false);
+        const res = stream ? chat.streamNextMessage() : chat.getNextMessage();
+        res.catch((e) => (handleError ? handleError(e) : defaultHandleApiError(e)));
+    }, [
+        chat,
+        stream,
+        handleError,
+        defaultHandleApiError,
+        fetchInitialMessage,
+        canSendMessage,
+        customCondition,
+    ]);
+}
+
+export { useFetchInitialMessage };
+//# sourceMappingURL=useFetchInitialMessage.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useFetchInitialMessage.mjs","sources":["../../../../src/hooks/useFetchInitialMessage.ts"],"sourcesContent":["import { useEffect, useState } from \"react\";\nimport { useChatState, useChatActions } from \"@yext/chat-headless-react\";\nimport { useDefaultHandleApiError } from \"../hooks/useDefaultHandleApiError\";\n\n/**\n * Sends a request to Chat API to fetch the initial message when the\n * conversation first start or when the message history is reset.\n *\n * @internal\n *\n * @param handleError - A function which is called when an error occurs while fetching for initial message.\n *                      By default, the error is logged to the console and an error message is added to state.\n * @param stream      - Enable streaming behavior by making a request to Chat Streaming API. Defaults to false.\n * @param customCondition - additional condition for when to fetch initial message\n */\nexport function useFetchInitialMessage(\n  handleError?: (e: unknown) => void,\n  stream = false,\n  customCondition = true\n) {\n  const chat = useChatActions();\n  const defaultHandleApiError = useDefaultHandleApiError();\n  const messages = useChatState((state) => state.conversation.messages);\n  const [fetchInitialMessage, setFetchInitialMessage] = useState(\n    messages.length === 0\n  );\n  const [messagesLength, setMessagesLength] = useState(messages.length);\n  const canSendMessage = useChatState(\n    (state) => state.conversation.canSendMessage\n  );\n\n  //handle message history resets\n  useEffect(() => {\n    const newMessagesLength = messages.length;\n    // Fetch data only when the conversation messages changes from non-zero to zero\n    if (messagesLength > 0 && newMessagesLength === 0) {\n      setFetchInitialMessage(true);\n    }\n    setMessagesLength(newMessagesLength);\n  }, [messages.length, messagesLength]);\n\n  useEffect(() => {\n    if (!fetchInitialMessage || !canSendMessage || !customCondition) {\n      return;\n    }\n    setFetchInitialMessage(false);\n    const res = stream ? chat.streamNextMessage() : chat.getNextMessage();\n    res.catch((e) => (handleError ? handleError(e) : defaultHandleApiError(e)));\n  }, [\n    chat,\n    stream,\n    handleError,\n    defaultHandleApiError,\n    fetchInitialMessage,\n    canSendMessage,\n    customCondition,\n  ]);\n}\n"],"names":[],"mappings":";;;;AAIA;;;;;;;;;;AAUG;AACG,SAAU,sBAAsB,CACpC,WAAkC,EAClC,MAAM,GAAG,KAAK,EACd,eAAe,GAAG,IAAI,EAAA;AAEtB,IAAA,MAAM,IAAI,GAAG,cAAc,EAAE,CAAC;AAC9B,IAAA,MAAM,qBAAqB,GAAG,wBAAwB,EAAE,CAAC;AACzD,IAAA,MAAM,QAAQ,GAAG,YAAY,CAAC,CAAC,KAAK,KAAK,KAAK,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;AACtE,IAAA,MAAM,CAAC,mBAAmB,EAAE,sBAAsB,CAAC,GAAG,QAAQ,CAC5D,QAAQ,CAAC,MAAM,KAAK,CAAC,CACtB,CAAC;AACF,IAAA,MAAM,CAAC,cAAc,EAAE,iBAAiB,CAAC,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AACtE,IAAA,MAAM,cAAc,GAAG,YAAY,CACjC,CAAC,KAAK,KAAK,KAAK,CAAC,YAAY,CAAC,cAAc,CAC7C,CAAC;;IAGF,SAAS,CAAC,MAAK;AACb,QAAA,MAAM,iBAAiB,GAAG,QAAQ,CAAC,MAAM,CAAC;;AAE1C,QAAA,IAAI,cAAc,GAAG,CAAC,IAAI,iBAAiB,KAAK,CAAC,EAAE;YACjD,sBAAsB,CAAC,IAAI,CAAC,CAAC;AAC9B,SAAA;QACD,iBAAiB,CAAC,iBAAiB,CAAC,CAAC;KACtC,EAAE,CAAC,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,CAAC;IAEtC,SAAS,CAAC,MAAK;QACb,IAAI,CAAC,mBAAmB,IAAI,CAAC,cAAc,IAAI,CAAC,eAAe,EAAE;YAC/D,OAAO;AACR,SAAA;QACD,sBAAsB,CAAC,KAAK,CAAC,CAAC;AAC9B,QAAA,MAAM,GAAG,GAAG,MAAM,GAAG,IAAI,CAAC,iBAAiB,EAAE,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QACtE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,WAAW,GAAG,WAAW,CAAC,CAAC,CAAC,GAAG,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC9E,KAAC,EAAE;QACD,IAAI;QACJ,MAAM;QACN,WAAW;QACX,qBAAqB;QACrB,mBAAmB;QACnB,cAAc;QACd,eAAe;AAChB,KAAA,CAAC,CAAC;AACL;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yext/chat-ui-react",
-  "version": "0.7.2",
+  "version": "0.8.0",
   "description": "A library of React Components for powering Yext Chat integrations.",
   "author": "clippy@yext.com",
   "main": "./lib/commonjs/src/index.js",
@@ -33,7 +33,7 @@
     "lint": "prettier --write . && eslint --fix --max-warnings=0 .",
     "test": "jest --config=jest.config.json",
     "storybook": "storybook dev -p 6006",
-    "dev": "tsc --watch -p tsconfig.json",
+    "dev": "rollup --watch --config rollup.config.mjs",
     "generate-docs": "api-extractor run --local --verbose && api-documenter markdown --input-folder temp --output-folder docs && rm -rf temp",
     "generate-notices": "generate-license-file --input package.json --output ./THIRD-PARTY-NOTICES --overwrite",
     "postcss": "postcss",

package/src/components/ChatPanel.tsx

@@ -1,5 +1,5 @@
 import React, { useCallback, useEffect, useRef } from "react";
-import { useChatState, useChatActions } from "@yext/chat-headless-react";
+import { useChatState } from "@yext/chat-headless-react";
 import {
   MessageBubble,
   MessageBubbleCssClasses,
@@ -8,9 +8,9 @@ import {
 import { ChatInput, ChatInputCssClasses, ChatInputProps } from "./ChatInput";
 import { LoadingDots } from "./LoadingDots";
 import { useComposedCssClasses } from "../hooks";
-import { useDefaultHandleApiError } from "../hooks/useDefaultHandleApiError";
 import { withStylelessCssClasses } from "../utils/withStylelessCssClasses";
 import { useReportAnalyticsEvent } from "../hooks/useReportAnalyticsEvent";
+import { useFetchInitialMessage } from "../hooks/useFetchInitialMessage";
 
 /**
  * The CSS class interface for the {@link ChatPanel} component.
@@ -65,16 +65,12 @@ export interface ChatPanelProps
  * @param props - {@link ChatPanelProps}
  */
 export function ChatPanel(props: ChatPanelProps) {
-  const { header, customCssClasses } = props;
-  const chat = useChatActions();
+  const { header, customCssClasses, stream, handleError } = props;
   const messages = useChatState((state) => state.conversation.messages);
   const loading = useChatState((state) => state.conversation.isLoading);
-  const canSendMessage = useChatState(
-    (state) => state.conversation.canSendMessage
-  );
   const cssClasses = useComposedCssClasses(builtInCssClasses, customCssClasses);
-  const defaultHandleApiError = useDefaultHandleApiError();
   const reportAnalyticsEvent = useReportAnalyticsEvent();
+  useFetchInitialMessage(handleError, stream);
 
   useEffect(() => {
     reportAnalyticsEvent({
@@ -82,16 +78,6 @@ export function ChatPanel(props: ChatPanelProps) {
     });
   }, [reportAnalyticsEvent]);
 
-  // Fetch the first message on load, if there are no existing messages or a request being processed
-  useEffect(() => {
-    if (messages.length !== 0 || !canSendMessage) {
-      return;
-    }
-    const { stream = false, handleError } = props;
-    const res = stream ? chat.streamNextMessage() : chat.getNextMessage();
-    res.catch((e) => (handleError ? handleError(e) : defaultHandleApiError(e)));
-  }, [chat, props, messages, defaultHandleApiError, canSendMessage]);
-
   const messagesRef = useRef<Array<HTMLDivElement | null>>([]);
   const messagesContainer = useRef<HTMLDivElement>(null);
 
@@ -125,10 +111,7 @@ export function ChatPanel(props: ChatPanelProps) {
       <div className={cssClasses.container}>
         {header}
         <div className={cssClasses.messagesScrollContainer}>
-          <div
-            ref={messagesContainer}
-            className={cssClasses.messagesContainer}
-          >
+          <div ref={messagesContainer} className={cssClasses.messagesContainer}>
             {messages.map((message, index) => (
               <div key={index} ref={setMessagesRef(index)}>
                 <MessageBubble

package/src/components/ChatPopUp.tsx

@@ -10,6 +10,12 @@ import { twMerge } from "tailwind-merge";
 import { useComposedCssClasses } from "../hooks";
 import { withStylelessCssClasses } from "../utils/withStylelessCssClasses";
 import { useReportAnalyticsEvent } from "../hooks/useReportAnalyticsEvent";
+import {
+  InitialMessagePopUp,
+  InitialMessagePopUpCssClasses,
+} from "./InitialMessagePopUp";
+import { useChatState } from "@yext/chat-headless-react";
+import { useFetchInitialMessage } from "../hooks/useFetchInitialMessage";
 
 /**
  * The CSS class interface for the {@link ChatPopUp} component.
@@ -22,11 +28,16 @@ export interface ChatPopUpCssClasses {
   panel__display?: string;
   panel__hidden?: string;
   button?: string;
-  button__display?: string;
-  button__hidden?: string;
   buttonIcon?: string;
+  ctaLabelContainer?: string;
+  ctaLabel?: string;
+  notification?: string;
+  closedPopupContainer?: string;
+  closedPopupContainer__display?: string;
+  closedPopupContainer__hidden?: string;
   headerCssClasses?: ChatHeaderCssClasses;
   panelCssClasses?: ChatPanelCssClasses;
+  initialMessagePopUpCssClasses?: InitialMessagePopUpCssClasses;
 }
 
 const fixedPosition = "fixed bottom-6 right-4 lg:bottom-14 lg:right-10 z-50 ";
@@ -39,13 +50,20 @@ const builtInCssClasses: ChatPopUpCssClasses = withStylelessCssClasses(
       "w-80 max-[480px]:right-0 max-[480px]:bottom-0 max-[480px]:w-full max-[480px]:h-full lg:w-96 h-[75vh]",
     panel__display: "duration-300 translate-y-0",
     panel__hidden: "duration-300 translate-y-[20%] opacity-0 invisible",
-    button:
+    closedPopupContainer:
       fixedPosition +
-      "p-2 w-12 h-12 lg:w-16 lg:h-16 flex justify-center items-center text-white shadow-xl rounded-full bg-gradient-to-br from-blue-600 to-blue-700 hover:-translate-y-2 duration-150",
-    button__display: "duration-300 transform translate-y-0",
-    button__hidden:
+      "flex gap-x-2.5 items-center hover:-translate-y-2 duration-150",
+    closedPopupContainer__display: "duration-300 transform translate-y-0",
+    closedPopupContainer__hidden:
       "duration-300 transform translate-y-[20%] opacity-0 invisible",
+    button:
+      "p-2 w-12 h-12 lg:w-16 lg:h-16 flex justify-center items-center text-white shadow-xl rounded-full bg-gradient-to-br from-blue-600 to-blue-700",
     buttonIcon: "text-blue-600 w-[28px] h-[28px] lg:w-[40px] lg:h-[40px]",
+    ctaLabelContainer: "max-w-60 -mr-8 line-clamp-1",
+    ctaLabel:
+      "p-3 pr-8 flex items-center whitespace-nowrap animate-expand-left font-bold rounded-l-full bg-white text-blue-700 h-10 lg:h-14 text-sm lg:text-base",
+    notification:
+      "fixed animate-fade-in bg-red-700 -right-1 top-0 rounded-full w-5 lg:w-6 h-5 lg:h-6 items-center flex justify-center text-sm lg:text-base text-white",
     headerCssClasses: {
       container: "max-[480px]:rounded-none rounded-t-3xl",
     },
@@ -67,10 +85,31 @@ export interface ChatPopUpProps
     Omit<ChatPanelProps, "header" | "customCssClasses"> {
   /** Custom icon for the popup button to open the panel. */
   openPanelButtonIcon?: JSX.Element;
+  /** CSS classes for customizing the component styling. */
+  customCssClasses?: ChatPopUpCssClasses;
+  /** Whether to show the panel on load. Defaults to false. */
+  openOnLoad?: boolean;
   /**
-   * CSS classes for customizing the component styling.
+   * Whether to show the initial message popup when the panel is hidden on load.
+   * Defaults to false.
    */
-  customCssClasses?: ChatPopUpCssClasses;
+  showInitialMessagePopUp?: boolean;
+  /**
+   * Whether to show a heartbeat animation on the popup button when the panel is hidden.
+   * Defaults to false.
+   */
+  showHeartBeatAnimation?: boolean;
+  /**
+   * Whether to show notification showing number of unread messages.
+   * Defaults to false.
+   */
+  showUnreadNotification?: boolean;
+  /**
+   * The "Call to Action" label to be displayed next to the popup button.
+   * By default, the CTA is not shown.
+   * This prop will override the "showInitialMessagePopUp" prop, if specified.
+   */
+  ctaLabel?: string;
 }
 
 /**
@@ -87,63 +126,150 @@ export function ChatPopUp(props: ChatPopUpProps) {
     customCssClasses,
     showRestartButton = true,
     onClose: customOnClose,
+    handleError,
+    openOnLoad = false,
+    showInitialMessagePopUp = false,
+    showHeartBeatAnimation = false,
+    showUnreadNotification = false,
+    ctaLabel,
     title,
   } = props;
-  const reportAnalyticsEvent = useReportAnalyticsEvent();
 
+  const reportAnalyticsEvent = useReportAnalyticsEvent();
   useEffect(() => {
     reportAnalyticsEvent({
       action: "CHAT_IMPRESSION",
     });
   }, [reportAnalyticsEvent]);
 
+  const messages = useChatState((s) => s.conversation.messages);
+  const [numReadMessages, setNumReadMessagesLength] = useState<number>(0);
+  const [numUnreadMessages, setNumUnreadMessagesLength] = useState<number>(0);
+
+  useFetchInitialMessage(
+    showInitialMessagePopUp ? console.error : handleError,
+    false,
+    showUnreadNotification || showInitialMessagePopUp
+  );
+
+  const [showInitialMessage, setshowInitialMessage] = useState(
+    //only show initial message popup (if specified) when CTA label is not provided
+    !ctaLabel && showInitialMessagePopUp
+  );
+  const onCloseInitialMessage = useCallback(() => {
+    setshowInitialMessage(false);
+  }, []);
+
+  // control CSS behavior on open/close state of the panel
   const [showChat, setShowChat] = useState(false);
+
+  // control the actual DOM rendering of the panel. Start rendering on first open state
+  // to avoid message requests immediately on load while the popup is still "hidden"
+  const [renderChat, setRenderChat] = useState(false);
+
+  // update in useEffect, instead of having openOnLoad as initial state for show/renderChat,
+  // in order to maintain the fade-in CSS animation when opening the panel on load
+  useEffect(() => {
+    if (openOnLoad) {
+      setShowChat(true);
+      setRenderChat(true);
+      setshowInitialMessage(false);
+    }
+  }, [openOnLoad]);
+
   const onClick = useCallback(() => {
     setShowChat(!showChat);
+    setRenderChat(true);
+    setshowInitialMessage(false);
   }, [showChat]);
 
   const onClose = useCallback(() => {
     setShowChat(false);
     customOnClose?.();
-  }, [customOnClose]);
+    // consider all the messages are read while the panel was open
+    setNumReadMessagesLength(messages.length);
+  }, [customOnClose, messages]);
+
+  useEffect(() => {
+    //update number of unread messages if there are new messages added while the panel is closed
+    setNumUnreadMessagesLength(messages.length - numReadMessages);
+  }, [messages, numReadMessages]);
 
   const cssClasses = useComposedCssClasses(builtInCssClasses, customCssClasses);
   const panelCssClasses = twMerge(
     cssClasses.panel,
     showChat ? cssClasses.panel__display : cssClasses.panel__hidden
   );
-  const buttonCssClasses = twMerge(
-    cssClasses.button,
-    showChat ? cssClasses.button__hidden : cssClasses.button__display
+  const closedPopupContainerCssClasses = twMerge(
+    cssClasses.closedPopupContainer,
+    showChat
+      ? cssClasses.closedPopupContainer__hidden
+      : cssClasses.closedPopupContainer__display
   );
 
   return (
     <div className="yext-chat w-full h-full">
       <div className={cssClasses.container}>
         <div className={panelCssClasses} aria-label="Chat Popup Panel">
-          <ChatPanel
-            {...props}
-            customCssClasses={cssClasses.panelCssClasses}
-            header={
-              <ChatHeader
-                title={title}
-                showRestartButton={showRestartButton}
-                showCloseButton={true}
-                onClose={onClose}
-                customCssClasses={cssClasses.headerCssClasses}
-              />
-            }
-          />
+          {renderChat && (
+            <ChatPanel
+              {...props}
+              customCssClasses={cssClasses.panelCssClasses}
+              header={
+                <ChatHeader
+                  title={title}
+                  showRestartButton={showRestartButton}
+                  showCloseButton={true}
+                  onClose={onClose}
+                  customCssClasses={cssClasses.headerCssClasses}
+                />
+              }
+            />
+          )}
         </div>
-        <button
-          aria-label="Chat Popup Button"
-          onClick={onClick}
-          className={buttonCssClasses}
+        <div
+          className={closedPopupContainerCssClasses}
+          aria-label="Chat Closed Popup Container"
         >
-          {openPanelButtonIcon ?? (
-            <ChatIcon className={cssClasses.buttonIcon} />
+          {showInitialMessage && (
+            <InitialMessagePopUp
+              onClose={onCloseInitialMessage}
+              customCssClasses={cssClasses.initialMessagePopUpCssClasses}
+            />
           )}
-        </button>
+          {ctaLabel && (
+            // the div container is needed to islate the expand CSS animation
+            <div className={cssClasses.ctaLabelContainer}>
+              <button
+                onClick={onClick}
+                aria-label="CTA Label"
+                className={cssClasses.ctaLabel}
+              >
+                {ctaLabel}
+              </button>
+            </div>
+          )}
+          <button
+            aria-label="Chat Popup Button"
+            onClick={onClick}
+            className={
+              cssClasses.button +
+              (showHeartBeatAnimation ? " animate-heartbeat" : "")
+            }
+          >
+            {openPanelButtonIcon ?? (
+              <ChatIcon className={cssClasses.buttonIcon} />
+            )}
+            {showUnreadNotification && !!numUnreadMessages && (
+              <div
+                aria-label="Unread Messages Notification"
+                className={cssClasses.notification}
+              >
+                {numUnreadMessages}
+              </div>
+            )}
+          </button>
+        </div>
       </div>
     </div>
   );

package/src/components/InitialMessagePopUp.tsx

@@ -0,0 +1,76 @@
+import React, { useMemo } from "react";
+import { CrossIcon } from "../icons/Cross";
+import { useComposedCssClasses } from "../hooks";
+import { withStylelessCssClasses } from "../utils/withStylelessCssClasses";
+import { MessageSource, useChatState } from "@yext/chat-headless-react";
+
+/**
+ * The CSS class interface for the InitialMessagePopUp component.
+ *
+ * @public
+ */
+export interface InitialMessagePopUpCssClasses {
+  container?: string;
+  closeButton?: string;
+  closeButtonIcon?: string;
+  message?: string;
+}
+
+/**
+ * The props for the {@link InitialMessagePopUp} component.
+ *
+ * @internal
+ */
+interface InitialMessagePopUpProps {
+  /** CSS classes for customizing the component styling. */
+  customCssClasses?: InitialMessagePopUpCssClasses;
+  /** Function to call when user click on the close button */
+  onClose: () => void;
+}
+
+const builtInCssClasses: InitialMessagePopUpCssClasses =
+  withStylelessCssClasses("InitialMessagePopUp", {
+    container: "flex gap-x-1 animate-fade-in",
+    closeButton: "bg-white w-4 h-4 rounded-full border border-slate-300",
+    closeButtonIcon: "",
+    message:
+      "line-clamp-2 w-60 p-2.5 bg-white rounded-xl shadow-xl text-sm lg:text-base",
+  });
+
+/**
+ * A component that renders a popup bubble displaying the initial message from chat bot.
+ *
+ * @internal
+ *
+ * @param props - {@link InitialMessagePopUpProps}
+ */
+export function InitialMessagePopUp({
+  onClose,
+  customCssClasses,
+}: InitialMessagePopUpProps) {
+  const messages = useChatState((s) => s.conversation.messages);
+  const cssClasses = useComposedCssClasses(builtInCssClasses, customCssClasses);
+
+  const firstBotMessage: string = useMemo(() => {
+    return messages.length !== 0 && messages[0].source === MessageSource.BOT
+      ? messages[0].text
+      : "";
+  }, [messages]);
+
+  if (firstBotMessage.length === 0) {
+    return <></>;
+  }
+
+  return (
+    <div className={cssClasses.container}>
+      <button
+        aria-label="Close Initial Message"
+        onClick={onClose}
+        className={cssClasses.closeButton}
+      >
+        <CrossIcon className={cssClasses.closeButtonIcon} />
+      </button>
+      <div className={cssClasses.message}>{firstBotMessage}</div>
+    </div>
+  );
+}

package/src/components/index.ts

@@ -10,10 +10,11 @@ export type {
   MessageBubbleProps,
 } from "./MessageBubble";
 
-export type { FeedbackButtonsCssClasses } from "./FeedbackButtons";
-
 export { ChatPanel } from "./ChatPanel";
 export type { ChatPanelCssClasses, ChatPanelProps } from "./ChatPanel";
 
 export { ChatPopUp } from "./ChatPopUp";
 export type { ChatPopUpCssClasses, ChatPopUpProps } from "./ChatPopUp";
+
+export type { FeedbackButtonsCssClasses } from "./FeedbackButtons";
+export type { InitialMessagePopUpCssClasses } from "./InitialMessagePopUp";

package/src/hooks/useFetchInitialMessage.ts

@@ -0,0 +1,58 @@
+import { useEffect, useState } from "react";
+import { useChatState, useChatActions } from "@yext/chat-headless-react";
+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.
+ *
+ * @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.
+ * @param stream      - Enable streaming behavior by making a request to Chat Streaming API. Defaults to false.
+ * @param customCondition - additional condition for when to fetch initial message
+ */
+export function useFetchInitialMessage(
+  handleError?: (e: unknown) => void,
+  stream = false,
+  customCondition = true
+) {
+  const chat = useChatActions();
+  const defaultHandleApiError = useDefaultHandleApiError();
+  const messages = useChatState((state) => state.conversation.messages);
+  const [fetchInitialMessage, setFetchInitialMessage] = useState(
+    messages.length === 0
+  );
+  const [messagesLength, setMessagesLength] = useState(messages.length);
+  const canSendMessage = useChatState(
+    (state) => state.conversation.canSendMessage
+  );
+
+  //handle message history resets
+  useEffect(() => {
+    const newMessagesLength = messages.length;
+    // Fetch data only when the conversation messages changes from non-zero to zero
+    if (messagesLength > 0 && newMessagesLength === 0) {
+      setFetchInitialMessage(true);
+    }
+    setMessagesLength(newMessagesLength);
+  }, [messages.length, messagesLength]);
+
+  useEffect(() => {
+    if (!fetchInitialMessage || !canSendMessage || !customCondition) {
+      return;
+    }
+    setFetchInitialMessage(false);
+    const res = stream ? chat.streamNextMessage() : chat.getNextMessage();
+    res.catch((e) => (handleError ? handleError(e) : defaultHandleApiError(e)));
+  }, [
+    chat,
+    stream,
+    handleError,
+    defaultHandleApiError,
+    fetchInitialMessage,
+    canSendMessage,
+    customCondition,
+  ]);
+}