yext · yen-tt · May 7, 2024 · May 6, 2024
@@ -31,7 +31,7 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 The following NPM package may be included in this product:
 
- - @reduxjs/toolkit@1.9.5
+ - @reduxjs/toolkit@1.9.7
 
 This package contains the following license and notice below:
 
@@ -62,6 +62,7 @@ SOFTWARE.
 The following NPM packages may be included in this product:
 
  - @types/hast@2.3.4
+ - @types/hoist-non-react-statics@3.3.5
  - @types/mdast@3.0.11
  - @types/parse5@5.0.3
  - @types/prop-types@15.7.5
@@ -99,37 +100,7 @@ MIT License
 
 The following NPM package may be included in this product:
 
- - @types/hoist-non-react-statics@3.3.1
-
-This package contains the following license and notice below:
-
-MIT License
-
-    Copyright (c) Microsoft Corporation. All rights reserved.
-
-    Permission is hereby granted, free of charge, to any person obtaining a copy
-    of this software and associated documentation files (the "Software"), to deal
-    in the Software without restriction, including without limitation the rights
-    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-    copies of the Software, and to permit persons to whom the Software is
-    furnished to do so, subject to the following conditions:
-
-    The above copyright notice and this permission notice shall be included in all
-    copies or substantial portions of the Software.
-
-    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-    SOFTWARE
-
------------
-
-The following NPM package may be included in this product:
-
- - @yext/analytics@0.6.4
+ - @yext/analytics@0.6.6
 
 This package contains the following license and notice below:
 
@@ -170,9 +141,9 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 The following NPM packages may be included in this product:
 
- - @yext/chat-core@0.7.6
- - @yext/chat-headless-react@0.6.1
- - @yext/chat-headless@0.7.1
+ - @yext/chat-core@0.8.0
+ - @yext/chat-headless-react@0.7.0
+ - @yext/chat-headless@0.8.0
 
 These packages each contain the following license and notice below:
 
@@ -827,7 +798,7 @@ THE SOFTWARE.
 
 The following NPM package may be included in this product:
 
- - layerr@2.0.1
+ - layerr@2.1.0
 
 This package contains the following license and notice below:
 
@@ -1236,7 +1207,7 @@ The following NPM packages may be included in this product:
  - react-is@18.2.0
  - react@18.2.0
  - scheduler@0.23.0
- - use-sync-external-store@1.2.0
+ - use-sync-external-store@1.2.2
 
 These packages each contain the following license and notice below:
 
@@ -1296,31 +1267,31 @@ SOFTWARE.
 
 The following NPM packages may be included in this product:
 
- - react-redux@8.1.2
- - redux@4.2.1
+ - react-redux@8.1.3
+ - redux-thunk@2.4.2
 
 These packages each contain the following license and notice below:
 
-The MIT License (MIT)
-
-Copyright (c) 2015-present Dan Abramov
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+The MIT License (MIT)
+
+Copyright (c) 2015-present Dan Abramov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 
 -----------
@@ -1356,30 +1327,30 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 The following NPM package may be included in this product:
 
- - redux-thunk@2.4.2
+ - redux@4.2.1
 
 This package contains the following license and notice below:
 
-The MIT License (MIT)
-
-Copyright (c) 2015-present Dan Abramov
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+The MIT License (MIT)
+
+Copyright (c) 2015-present Dan Abramov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 
 -----------
@@ -1783,7 +1754,7 @@ THE SOFTWARE.
 
 The following NPM package may be included in this product:
 
- - ulidx@2.1.0
+ - ulidx@2.3.0
 
 This package contains the following license and notice below:
 

@@ -9,14 +9,14 @@ A component that allows user to input message and send to Chat API.
 **Signature:**
 
 ```typescript
-export declare function ChatInput({ placeholder, stream, inputAutoFocus, handleError, sendButtonIcon, customCssClasses, onSend, }: ChatInputProps): React.JSX.Element;
+export declare function ChatInput({ placeholder, stream, inputAutoFocus, handleError, sendButtonIcon, customCssClasses, onSend, onRetry, }: ChatInputProps): React.JSX.Element;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  { placeholder, stream, inputAutoFocus, handleError, sendButtonIcon, customCssClasses, onSend, } | [ChatInputProps](./chat-ui-react.chatinputprops.md) |  |
+|  { placeholder, stream, inputAutoFocus, handleError, sendButtonIcon, customCssClasses, onSend, onRetry, } | [ChatInputProps](./chat-ui-react.chatinputprops.md) |  |
 
 **Returns:**
 

@@ -19,6 +19,7 @@ export interface ChatInputProps
 |  [customCssClasses?](./chat-ui-react.chatinputprops.customcssclasses.md) |  | [ChatInputCssClasses](./chat-ui-react.chatinputcssclasses.md) | _(Optional)_ CSS classes for customizing the component styling. |
 |  [handleError?](./chat-ui-react.chatinputprops.handleerror.md) |  | (e: unknown) =&gt; void | _(Optional)_ A function which is called when an error occurs from Chat API while processing the user's message. By default, the error is logged to the console and an error message is added to state. |
 |  [inputAutoFocus?](./chat-ui-react.chatinputprops.inputautofocus.md) |  | boolean | _(Optional)_ Enable auto focus for the input box. Defaults to false. |
+|  [onRetry?](./chat-ui-react.chatinputprops.onretry.md) |  | (e: unknown) =&gt; void | _(Optional)_ A function which is called when a retryable error occurs from Chat API while processing the user's message. |
 |  [onSend?](./chat-ui-react.chatinputprops.onsend.md) |  | (message: string) =&gt; void | _(Optional)_ A callback which is called when user sends a message. |
 |  [placeholder?](./chat-ui-react.chatinputprops.placeholder.md) |  | string | _(Optional)_ The input's placeholder text when no text has been entered by the user. Defaults to "Type a message...". |
 |  [sendButtonIcon?](./chat-ui-react.chatinputprops.sendbuttonicon.md) |  | JSX.Element | _(Optional)_ Custom icon for the send button. |

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/chat-ui-react](./chat-ui-react.md) &gt; [ChatInputProps](./chat-ui-react.chatinputprops.md) &gt; [onRetry](./chat-ui-react.chatinputprops.onretry.md)
+
+## ChatInputProps.onRetry property
+
+A function which is called when a retryable error occurs from Chat API while processing the user's message.
+
+**Signature:**
+
+```typescript
+onRetry?: (e: unknown) => void;
+```
@@ -22,4 +22,5 @@ export interface ChatPanelProps extends Omit<MessageBubbleProps, "customCssClass
 |  [header?](./chat-ui-react.chatpanelprops.header.md) |  | ReactNode | _(Optional)_ A header to render at the top of the panel. |
 |  [messageSuggestions?](./chat-ui-react.chatpanelprops.messagesuggestions.md) |  | string\[\] | _(Optional)_ A set of pre-written initial messages that the user can click on instead of typing their own. |
 |  [onLinkClick?](./chat-ui-react.chatpanelprops.onlinkclick.md) |  | (href?: string) =&gt; void | _(Optional)_ A callback which is called when user clicks a link. |
+|  [retryText?](./chat-ui-react.chatpanelprops.retrytext.md) |  | string | _(Optional)_ Text to display when retrying. Defaults to "Error occurred. Retrying". |
 
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/chat-ui-react](./chat-ui-react.md) &gt; [ChatPanelProps](./chat-ui-react.chatpanelprops.md) &gt; [retryText](./chat-ui-react.chatpanelprops.retrytext.md)
+
+## ChatPanelProps.retryText property
+
+Text to display when retrying. Defaults to "Error occurred. Retrying".
+
+**Signature:**
+
+```typescript
+retryText?: string;
+```
@@ -9,7 +9,7 @@
 |  Function | Description |
 |  --- | --- |
 |  [ChatHeader({ title, showRestartButton, restartButtonIcon, showCloseButton, closeButtonIcon, onClose, customCssClasses, })](./chat-ui-react.chatheader.md) | A component that renders the header of a chat bot panel, including the title and a button to reset the conversation. |
-|  [ChatInput({ placeholder, stream, inputAutoFocus, handleError, sendButtonIcon, customCssClasses, onSend, })](./chat-ui-react.chatinput.md) | A component that allows user to input message and send to Chat API. |
+|  [ChatInput({ placeholder, stream, inputAutoFocus, handleError, sendButtonIcon, customCssClasses, onSend, onRetry, })](./chat-ui-react.chatinput.md) | A component that allows user to input message and send to Chat API. |
 |  [ChatPanel(props)](./chat-ui-react.chatpanel.md) | A component that renders a full panel for chat bot interactions. This includes the message bubbles for the conversation, input box with send button, and header (if provided). |
 |  [ChatPopUp(props)](./chat-ui-react.chatpopup.md) | A component that renders a popup button that displays and hides a panel for chat bot interactions. |
 |  [MessageBubble({ message, showFeedbackButtons, showTimestamp, customCssClasses, formatTimestamp, onLinkClick, })](./chat-ui-react.messagebubble.md) | A component that displays the provided message. |

@@ -18,5 +18,8 @@ export interface MessageSuggestionsProps
 |  --- | --- | --- | --- |
 |  [customCssClasses?](./chat-ui-react.messagesuggestionsprops.customcssclasses.md) |  | [MessageSuggestionCssClasses](./chat-ui-react.messagesuggestioncssclasses.md) | _(Optional)_ CSS classes for customizing the component styling. |
 |  [handleError?](./chat-ui-react.messagesuggestionsprops.handleerror.md) |  | (e: unknown) =&gt; void | _(Optional)_ A function which is called when an error occurs from Chat API while processing the user's message. By default, the error is logged to the console and an error message is added to state. |
+|  [onRetry?](./chat-ui-react.messagesuggestionsprops.onretry.md) |  | (e: unknown) =&gt; void | _(Optional)_ A function which is called when a retryable error occurs from Chat API while processing the user's message. |
+|  [onSend?](./chat-ui-react.messagesuggestionsprops.onsend.md) |  | (message: string) =&gt; void | _(Optional)_ A callback which is called when user sends a message. |
+|  [stream?](./chat-ui-react.messagesuggestionsprops.stream.md) |  | boolean | _(Optional)_ Enable streaming behavior by making a request to Chat Streaming API. This feature is experimental, and is subject to change. Defaults to false. |
 |  [suggestions](./chat-ui-react.messagesuggestionsprops.suggestions.md) |  | string\[\] | List of clickable message suggestions to render. |
 
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/chat-ui-react](./chat-ui-react.md) &gt; [MessageSuggestionsProps](./chat-ui-react.messagesuggestionsprops.md) &gt; [onRetry](./chat-ui-react.messagesuggestionsprops.onretry.md)
+
+## MessageSuggestionsProps.onRetry property
+
+A function which is called when a retryable error occurs from Chat API while processing the user's message.
+
+**Signature:**
+
+```typescript
+onRetry?: (e: unknown) => void;
+```
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/chat-ui-react](./chat-ui-react.md) &gt; [MessageSuggestionsProps](./chat-ui-react.messagesuggestionsprops.md) &gt; [onSend](./chat-ui-react.messagesuggestionsprops.onsend.md)
+
+## MessageSuggestionsProps.onSend property
+
+A callback which is called when user sends a message.
+
+**Signature:**
+
+```typescript
+onSend?: (message: string) => void;
+```
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/chat-ui-react](./chat-ui-react.md) &gt; [MessageSuggestionsProps](./chat-ui-react.messagesuggestionsprops.md) &gt; [stream](./chat-ui-react.messagesuggestionsprops.stream.md)
+
+## MessageSuggestionsProps.stream property
+
+Enable streaming behavior by making a request to Chat Streaming API. This feature is experimental, and is subject to change. Defaults to false.
+
+**Signature:**
+
+```typescript
+stream?: boolean;
+```
@@ -40,7 +40,7 @@ export interface ChatHeaderProps {
 }
 
 // @public
-export function ChatInput({ placeholder, stream, inputAutoFocus, handleError, sendButtonIcon, customCssClasses, onSend, }: ChatInputProps): React_2.JSX.Element;
+export function ChatInput({ placeholder, stream, inputAutoFocus, handleError, sendButtonIcon, customCssClasses, onSend, onRetry, }: ChatInputProps): React_2.JSX.Element;
 
 // @public
 export interface ChatInputCssClasses {
@@ -57,6 +57,7 @@ export interface ChatInputProps {
     customCssClasses?: ChatInputCssClasses;
     handleError?: (e: unknown) => void;
     inputAutoFocus?: boolean;
+    onRetry?: (e: unknown) => void;
     onSend?: (message: string) => void;
     placeholder?: string;
     sendButtonIcon?: JSX.Element;
@@ -93,6 +94,7 @@ export interface ChatPanelProps extends Omit<MessageBubbleProps, "customCssClass
     header?: ReactNode;
     messageSuggestions?: string[];
     onLinkClick?: (href?: string) => void;
+    retryText?: string;
 }
 
 // @public
@@ -230,6 +232,9 @@ export interface MessageSuggestionCssClasses {
 export interface MessageSuggestionsProps {
     customCssClasses?: MessageSuggestionCssClasses;
     handleError?: (e: unknown) => void;
+    onRetry?: (e: unknown) => void;
+    onSend?: (message: string) => void;
+    stream?: boolean;
     suggestions: string[];
 }