react-instantsearch 7.45.0 → 7.47.0

package/dist/cjs/widgets/Chat.js

@@ -35,7 +35,11 @@ _export(exports, {
         return createDefaultTools;
     }
 });
+var _call_super = require("@swc/helpers/_/_call_super");
+var _class_call_check = require("@swc/helpers/_/_class_call_check");
+var _create_class = require("@swc/helpers/_/_create_class");
 var _define_property = require("@swc/helpers/_/_define_property");
+var _inherits = require("@swc/helpers/_/_inherits");
 var _interop_require_wildcard = require("@swc/helpers/_/_interop_require_wildcard");
 var _object_spread = require("@swc/helpers/_/_object_spread");
 var _object_spread_props = require("@swc/helpers/_/_object_spread_props");
@@ -44,6 +48,7 @@ var _sliced_to_array = require("@swc/helpers/_/_sliced_to_array");
 var _to_array = require("@swc/helpers/_/_to_array");
 var _instantsearchuicomponents = require("instantsearch-ui-components");
 var _chat = require("instantsearch.js/cjs/lib/chat");
+var _focusAfterReveal = require("instantsearch.js/cjs/lib/chat/focusAfterReveal");
 var _react = /*#__PURE__*/ _interop_require_wildcard._(require("react"));
 var _reactinstantsearchcore = require("react-instantsearch-core");
 var _useStickToBottom = require("../lib/useStickToBottom");
@@ -53,11 +58,24 @@ var ChatUiComponent = (0, _instantsearchuicomponents.createChatComponent)({
     createElement: _react.createElement,
     Fragment: _react.Fragment,
     useMemo: _react.useMemo,
-    useState: _react.useState
+    useState: _react.useState,
+    useEffect: _react.useEffect
 });
 function createDefaultTools(itemComponent, getSearchPageURL) {
     var _obj;
-    return _obj = {}, _define_property._(_obj, _chat.SearchIndexToolType, (0, _SearchIndexTool.createCarouselTool)(true, itemComponent, getSearchPageURL)), _define_property._(_obj, _chat.RecommendToolType, (0, _SearchIndexTool.createCarouselTool)(false, itemComponent, getSearchPageURL)), _define_property._(_obj, _chat.DisplayResultsToolType, (0, _DisplayResultsTool.createDisplayResultsTool)(itemComponent)), _define_property._(_obj, _chat.MemorizeToolType, {}), _define_property._(_obj, _chat.MemorySearchToolType, {}), _define_property._(_obj, _chat.PonderToolType, {}), _obj;
+    return _obj = {}, _define_property._(_obj, _chat.SearchIndexToolType, _object_spread_props._(_object_spread._({}, (0, _SearchIndexTool.createCarouselTool)(true, itemComponent, getSearchPageURL)), {
+        // The agent decides per turn whether the richer display-results tool
+        // takes over the rendering of the search results.
+        shouldRender: isDisplayResultsDisabled
+    })), _define_property._(_obj, _chat.RecommendToolType, (0, _SearchIndexTool.createCarouselTool)(false, itemComponent, getSearchPageURL)), _define_property._(_obj, _chat.DisplayResultsToolType, (0, _DisplayResultsTool.createDisplayResultsTool)(itemComponent)), _define_property._(_obj, _chat.MemorizeToolType, {}), _define_property._(_obj, _chat.MemorySearchToolType, {}), _define_property._(_obj, _chat.PonderToolType, {}), _obj;
+}
+/**
+ * Whether the search tool renders its own results, i.e. the agent did not hand
+ * the turn to the display-results tool. Set on the message by the backend.
+ */ function isDisplayResultsDisabled(param) {
+    var parentMessage = param.parentMessage;
+    var _parentMessage_metadata;
+    return ((_parentMessage_metadata = parentMessage.metadata) === null || _parentMessage_metadata === void 0 ? void 0 : _parentMessage_metadata.displayResultsEnabled) !== true;
 }
 function mergeToolOptions(defaultTools, userTools) {
     if (!userTools) {
@@ -65,22 +83,62 @@ function mergeToolOptions(defaultTools, userTools) {
     }
     var tools = _object_spread._({}, defaultTools, userTools);
     Object.keys(userTools).forEach(function(toolName) {
-        var _defaultTools_toolName;
         var userTool = userTools[toolName];
-        var defaultStreamInput = (_defaultTools_toolName = defaultTools[toolName]) === null || _defaultTools_toolName === void 0 ? void 0 : _defaultTools_toolName.streamInput;
+        var defaultTool = defaultTools[toolName];
+        var defaultStreamInput = defaultTool === null || defaultTool === void 0 ? void 0 : defaultTool.streamInput;
         if (userTool.layoutComponent !== undefined && userTool.streamInput === undefined && defaultStreamInput !== undefined) {
-            tools[toolName] = _object_spread_props._(_object_spread._({}, userTool), {
+            tools[toolName] = _object_spread_props._(_object_spread._({}, tools[toolName]), {
                 streamInput: defaultStreamInput
             });
         }
+        // Overriding a tool's rendering shouldn't opt it out of the conditions
+        // under which the default renders at all.
+        if (userTool.shouldRender === undefined && (defaultTool === null || defaultTool === void 0 ? void 0 : defaultTool.shouldRender)) {
+            tools[toolName] = _object_spread_props._(_object_spread._({}, tools[toolName]), {
+                shouldRender: defaultTool.shouldRender
+            });
+        }
     });
     return tools;
 }
+var AnimationSnapshot = /*#__PURE__*/ function(_React_Component) {
+    _inherits._(AnimationSnapshot, _React_Component);
+    function AnimationSnapshot() {
+        _class_call_check._(this, AnimationSnapshot);
+        return _call_super._(this, AnimationSnapshot, arguments);
+    }
+    _create_class._(AnimationSnapshot, [
+        {
+            key: "getSnapshotBeforeUpdate",
+            value: function getSnapshotBeforeUpdate() {
+                return (0, _focusAfterReveal.getActiveContainerAnimations)(this.props.promptRef.current);
+            }
+        },
+        {
+            key: "componentDidUpdate",
+            value: function componentDidUpdate(_previousProps, _previousState, animationsBeforeReveal) {
+                this.props.animationsBeforeReveal.current = animationsBeforeReveal;
+                if (!_previousProps.open && this.props.open) {
+                    (0, _focusAfterReveal.holdContainerInertUntilReveal)(this.props.promptRef.current);
+                } else if (this.props.open) {
+                    (0, _focusAfterReveal.restoreContainerInertUntilReveal)(this.props.promptRef.current);
+                }
+            }
+        },
+        {
+            key: "render",
+            value: function render() {
+                return null;
+            }
+        }
+    ]);
+    return AnimationSnapshot;
+}(_react.default.Component);
 function ChatInner(_0, _1) {
     var _ref = [
         _0,
         _1
-    ], _ref1 = _to_array._(_ref), _ref2 = _ref1[0], _rest = _ref1.slice(1), userTools = _ref2.tools, headerProps = _ref2.headerProps, messagesProps = _ref2.messagesProps, promptProps = _ref2.promptProps, itemComponent = _ref2.itemComponent, layoutComponent = _ref2.layoutComponent, headerComponent = _ref2.headerComponent, headerTitleIconComponent = _ref2.headerTitleIconComponent, headerCloseIconComponent = _ref2.headerCloseIconComponent, headerMinimizeIconComponent = _ref2.headerMinimizeIconComponent, headerMaximizeIconComponent = _ref2.headerMaximizeIconComponent, loaderComponent = _ref2.loaderComponent, messagesErrorComponent = _ref2.messagesErrorComponent, promptComponent = _ref2.promptComponent, promptHeaderComponent = _ref2.promptHeaderComponent, promptFooterComponent = _ref2.promptFooterComponent, assistantMessageLeadingComponent = _ref2.assistantMessageLeadingComponent, assistantMessageFooterComponent = _ref2.assistantMessageFooterComponent, userMessageLeadingComponent = _ref2.userMessageLeadingComponent, userMessageFooterComponent = _ref2.userMessageFooterComponent, emptyComponent = _ref2.emptyComponent, actionsComponent = _ref2.actionsComponent, suggestionsComponent = _ref2.suggestionsComponent, classNames = _ref2.classNames, _ref_translations = _ref2.translations, translations = _ref_translations === void 0 ? {} : _ref_translations, title = _ref2.title, getSearchPageURL = _ref2.getSearchPageURL, _ref_disableTriggerValidation = _ref2.disableTriggerValidation, disableTriggerValidation = _ref_disableTriggerValidation === void 0 ? false : _ref_disableTriggerValidation, showReasoning = _ref2.showReasoning, props = _object_without_properties._(_ref2, [
+    ], _ref1 = _to_array._(_ref), _ref2 = _ref1[0], _rest = _ref1.slice(1), userTools = _ref2.tools, headerProps = _ref2.headerProps, messagesProps = _ref2.messagesProps, promptProps = _ref2.promptProps, itemComponent = _ref2.itemComponent, layoutComponent = _ref2.layoutComponent, headerComponent = _ref2.headerComponent, headerTitleIconComponent = _ref2.headerTitleIconComponent, headerCloseIconComponent = _ref2.headerCloseIconComponent, headerMinimizeIconComponent = _ref2.headerMinimizeIconComponent, headerMaximizeIconComponent = _ref2.headerMaximizeIconComponent, loaderComponent = _ref2.loaderComponent, loaderPosition = _ref2.loaderPosition, shouldShowLoader = _ref2.shouldShowLoader, loaderShowDelay = _ref2.loaderShowDelay, loaderMinDuration = _ref2.loaderMinDuration, messagesErrorComponent = _ref2.messagesErrorComponent, promptComponent = _ref2.promptComponent, promptHeaderComponent = _ref2.promptHeaderComponent, promptFooterComponent = _ref2.promptFooterComponent, assistantMessageLeadingComponent = _ref2.assistantMessageLeadingComponent, assistantMessageFooterComponent = _ref2.assistantMessageFooterComponent, userMessageLeadingComponent = _ref2.userMessageLeadingComponent, userMessageFooterComponent = _ref2.userMessageFooterComponent, emptyComponent = _ref2.emptyComponent, actionsComponent = _ref2.actionsComponent, suggestionsComponent = _ref2.suggestionsComponent, classNames = _ref2.classNames, _ref_translations = _ref2.translations, translations = _ref_translations === void 0 ? {} : _ref_translations, title = _ref2.title, getSearchPageURL = _ref2.getSearchPageURL, _ref_disableTriggerValidation = _ref2.disableTriggerValidation, disableTriggerValidation = _ref_disableTriggerValidation === void 0 ? false : _ref_disableTriggerValidation, showReasoning = _ref2.showReasoning, props = _object_without_properties._(_ref2, [
         "tools",
         "headerProps",
         "messagesProps",
@@ -93,6 +151,10 @@ function ChatInner(_0, _1) {
         "headerMinimizeIconComponent",
         "headerMaximizeIconComponent",
         "loaderComponent",
+        "loaderPosition",
+        "shouldShowLoader",
+        "loaderShowDelay",
+        "loaderMinDuration",
         "messagesErrorComponent",
         "promptComponent",
         "promptHeaderComponent",
@@ -116,6 +178,8 @@ function ChatInner(_0, _1) {
     var _useInstantSearch = (0, _reactinstantsearchcore.useInstantSearch)(), indexUiState = _useInstantSearch.indexUiState, setIndexUiState = _useInstantSearch.setIndexUiState;
     var _useState = _sliced_to_array._((0, _react.useState)(false), 2), maximized = _useState[0], setMaximized = _useState[1];
     var promptRef = (0, _react.useRef)(null);
+    var focusRequestId = (0, _react.useRef)(0);
+    var animationsBeforeReveal = (0, _react.useRef)([]);
     var _useStickToBottom1 = (0, _useStickToBottom.useStickToBottom)({
         initial: 'smooth',
         resize: 'smooth'
@@ -137,7 +201,7 @@ function ChatInner(_0, _1) {
         tools: tools,
         disableTriggerValidation: effectiveDisableTriggerValidation
     }));
-    var messages = chatState.messages, sendMessage = chatState.sendMessage, status = chatState.status, regenerate = chatState.regenerate, stop = chatState.stop, error = chatState.error, input = chatState.input, setInput = chatState.setInput, open = chatState.open, setOpen = chatState.setOpen, clearMessages = chatState.clearMessages, toolsFromConnector = chatState.tools, suggestions = chatState.suggestions, onFeedback = chatState.sendChatMessageFeedback, feedbackState = chatState.feedbackState, consumeInputFocus = chatState['~consumeInputFocus'], isOpenStatePersistenceEnabled = chatState['~isOpenStatePersistenceEnabled'];
+    var messages = chatState.messages, sendMessage = chatState.sendMessage, status = chatState.status, regenerate = chatState.regenerate, stop = chatState.stop, error = chatState.error, input = chatState.input, setInput = chatState.setInput, open = chatState.open, setOpen = chatState.setOpen, clearMessages = chatState.clearMessages, toolsFromConnector = chatState.tools, suggestions = chatState.suggestions, suggestionsStatus = chatState.suggestionsStatus, onFeedback = chatState.sendChatMessageFeedback, feedbackState = chatState.feedbackState, consumeInputFocus = chatState['~consumeInputFocus'], isOpenStatePersistenceEnabled = chatState['~isOpenStatePersistenceEnabled'];
     (0, _react.useImperativeHandle)(ref, function() {
         return {
             setOpen: setOpen,
@@ -148,10 +212,21 @@ function ChatInner(_0, _1) {
         };
     });
     (0, _react.useEffect)(function() {
+        if (!open) {
+            focusRequestId.current++;
+            return;
+        }
         if (consumeInputFocus === null || consumeInputFocus === void 0 ? void 0 : consumeInputFocus()) {
+            var currentFocusRequestId = ++focusRequestId.current;
+            var previousAnimations = animationsBeforeReveal.current;
+            (0, _focusAfterReveal.holdContainerInertUntilReveal)(promptRef.current);
             window.requestAnimationFrame(function() {
-                var _promptRef_current;
-                (_promptRef_current = promptRef.current) === null || _promptRef_current === void 0 ? void 0 : _promptRef_current.focus();
+                var prompt = promptRef.current;
+                (0, _focusAfterReveal.focusAfterReveal)(prompt, previousAnimations, function() {
+                    return focusRequestId.current === currentFocusRequestId && promptRef.current === prompt;
+                }, function() {
+                    return focusRequestId.current === currentFocusRequestId;
+                });
             });
         }
     });
@@ -176,7 +251,7 @@ function ChatInner(_0, _1) {
         "assistantMessageProps",
         "userMessageProps"
     ]);
-    return /*#__PURE__*/ _react.default.createElement(ChatUiComponent, {
+    var chat = /*#__PURE__*/ _react.default.createElement(ChatUiComponent, {
         title: title,
         open: open,
         maximized: maximized,
@@ -228,6 +303,10 @@ function ChatInner(_0, _1) {
             contentRef: contentRef,
             onScrollToBottom: scrollToBottom,
             loaderComponent: loaderComponent,
+            loaderPosition: loaderPosition,
+            shouldShowLoader: shouldShowLoader,
+            loaderShowDelay: loaderShowDelay,
+            loaderMinDuration: loaderMinDuration,
             errorComponent: messagesErrorComponent,
             emptyComponent: emptyComponent,
             actionsComponent: actionsComponent,
@@ -269,6 +348,7 @@ function ChatInner(_0, _1) {
         }),
         suggestionsProps: {
             suggestions: suggestions,
+            isLoading: suggestionsStatus === 'loading',
             onSuggestionClick: function onSuggestionClick(suggestion) {
                 sendMessage({
                     text: suggestion
@@ -277,5 +357,10 @@ function ChatInner(_0, _1) {
         },
         classNames: classNames
     });
+    return /*#__PURE__*/ _react.default.createElement(_react.default.Fragment, null, /*#__PURE__*/ _react.default.createElement(AnimationSnapshot, {
+        promptRef: promptRef,
+        animationsBeforeReveal: animationsBeforeReveal,
+        open: open
+    }), chat);
 }
 var Chat = /*#__PURE__*/ _react.default.forwardRef(ChatInner);

package/dist/cjs/widgets/PromptSuggestions.js

@@ -33,16 +33,20 @@ function PromptSuggestions(_0) {
         "context",
         "transformItems"
     ]);
-    var _usePromptSuggestions = (0, _reactinstantsearchcore.usePromptSuggestions)({
+    var source = agentId !== undefined ? {
         agentId: agentId,
-        transport: transport,
+        transport: transport
+    } : {
+        transport: transport
+    };
+    var _usePromptSuggestions = (0, _reactinstantsearchcore.usePromptSuggestions)(_object_spread_props._(_object_spread._({}, source), {
         configurationId: configurationId,
         transformHits: transformHits,
         context: context,
         transformItems: transformItems
-    }, {
+    }), {
         $$widgetType: 'ais.promptSuggestions'
-    }), suggestions = _usePromptSuggestions.suggestions, isLoading = _usePromptSuggestions.isLoading, onSuggestionClick = _usePromptSuggestions.onSuggestionClick, isChatBusy = _usePromptSuggestions.isChatBusy, sendToChat = _usePromptSuggestions.sendToChat;
+    }), suggestions = _usePromptSuggestions.suggestions, isLoading = _usePromptSuggestions.isLoading, error = _usePromptSuggestions.error, onSuggestionClick = _usePromptSuggestions.onSuggestionClick, isChatBusy = _usePromptSuggestions.isChatBusy, sendToChat = _usePromptSuggestions.sendToChat;
     var handleClick = onSuggestionClickOverride ? function(prompt) {
         return onSuggestionClickOverride(prompt, {
             sendToChat: sendToChat
@@ -52,6 +56,7 @@ function PromptSuggestions(_0) {
         return /*#__PURE__*/ _react.default.createElement(LayoutComponent, {
             suggestions: suggestions,
             isLoading: isLoading,
+            error: error,
             onSuggestionClick: handleClick,
             isChatBusy: isChatBusy
         });

package/dist/es/components/ChatMessageLoader.d.ts

@@ -1 +1 @@
-export declare const ChatMessageLoader: (userProps: import("instantsearch-ui-components").ChatComponentPropsWithContext<import("instantsearch-ui-components").ChatMessageLoaderProps>) => JSX.Element;
+export declare const ChatMessageLoader: <TMessage extends import("instantsearch-ui-components").ChatMessageBase = import("instantsearch-ui-components").ChatMessageBase>(userProps: import("instantsearch-ui-components").ChatMessageLoaderPropsWithContext<TMessage>) => JSX.Element;

package/dist/es/widgets/Chat.d.ts

@@ -31,6 +31,27 @@ export type ChatProps<TObject, TUiMessage extends UIMessage = UIMessage> = Omit<
     promptHeaderComponent?: ChatUiProps['promptProps']['headerComponent'];
     promptFooterComponent?: ChatUiProps['promptProps']['footerComponent'];
     loaderComponent?: ChatUiProps['messagesProps']['loaderComponent'];
+    /**
+     * Where the loader renders: as its own row after the last message
+     * (`messages-end`, the default) or inside the streaming assistant message
+     * (`message-inline`).
+     */
+    loaderPosition?: ChatUiProps['messagesProps']['loaderPosition'];
+    /**
+     * Overrides when the loader shows. Receives the turn context plus the
+     * built-in decision as `defaultValue`.
+     */
+    shouldShowLoader?: ChatUiProps['messagesProps']['shouldShowLoader'];
+    /**
+     * How long (ms) a renewed loading state must hold before the loader comes
+     * back after having been hidden in the same turn.
+     */
+    loaderShowDelay?: ChatUiProps['messagesProps']['loaderShowDelay'];
+    /**
+     * Minimum time (ms) the loader stays on screen once shown, while the turn is
+     * still running.
+     */
+    loaderMinDuration?: ChatUiProps['messagesProps']['loaderMinDuration'];
     emptyComponent?: ChatUiProps['messagesProps']['emptyComponent'];
     actionsComponent?: ChatUiProps['messagesProps']['actionsComponent'];
     assistantMessageLeadingComponent?: ChatMessageProps['leadingComponent'];

package/dist/es/widgets/Chat.js

@@ -1,13 +1,18 @@
-import { _ } from '@swc/helpers/esm/_define_property.js';
-import { _ as _$5 } from '@swc/helpers/esm/_object_spread.js';
-import { _ as _$4 } from '@swc/helpers/esm/_object_spread_props.js';
-import { _ as _$2 } from '@swc/helpers/esm/_object_without_properties.js';
-import { _ as _$3 } from '@swc/helpers/esm/_sliced_to_array.js';
-import { _ as _$1 } from '@swc/helpers/esm/_to_array.js';
+import { _ as _$2 } from '@swc/helpers/esm/_call_super.js';
+import { _ as _$1 } from '@swc/helpers/esm/_class_call_check.js';
+import { _ as _$3 } from '@swc/helpers/esm/_create_class.js';
+import { _ as _$4 } from '@swc/helpers/esm/_define_property.js';
+import { _ } from '@swc/helpers/esm/_inherits.js';
+import { _ as _$6 } from '@swc/helpers/esm/_object_spread.js';
+import { _ as _$5 } from '@swc/helpers/esm/_object_spread_props.js';
+import { _ as _$8 } from '@swc/helpers/esm/_object_without_properties.js';
+import { _ as _$9 } from '@swc/helpers/esm/_sliced_to_array.js';
+import { _ as _$7 } from '@swc/helpers/esm/_to_array.js';
 import { createChatComponent } from 'instantsearch-ui-components';
 import { SearchIndexToolType, RecommendToolType, DisplayResultsToolType, MemorizeToolType, MemorySearchToolType, PonderToolType } from 'instantsearch.js/es/lib/chat/index.js';
 export { DisplayResultsToolType, MemorizeToolType, MemorySearchToolType, PonderToolType, RecommendToolType, SearchIndexToolType } from 'instantsearch.js/es/lib/chat/index.js';
-import React, { createElement, Fragment, useMemo, useState, useRef, useImperativeHandle, useEffect } from 'react';
+import { getActiveContainerAnimations, holdContainerInertUntilReveal, restoreContainerInertUntilReveal, focusAfterReveal } from 'instantsearch.js/es/lib/chat/focusAfterReveal.js';
+import React, { createElement, Fragment, useMemo, useState, useEffect, useRef, useImperativeHandle } from 'react';
 import { useInstantSearch, useChat } from 'react-instantsearch-core';
 import { useStickToBottom } from '../lib/useStickToBottom.js';
 import { createDisplayResultsTool } from './chat/tools/DisplayResultsTool.js';
@@ -17,34 +22,87 @@ var ChatUiComponent = createChatComponent({
     createElement: createElement,
     Fragment: Fragment,
     useMemo: useMemo,
-    useState: useState
+    useState: useState,
+    useEffect: useEffect
 });
 function createDefaultTools(itemComponent, getSearchPageURL) {
     var _obj;
-    return _obj = {}, _(_obj, SearchIndexToolType, createCarouselTool(true, itemComponent, getSearchPageURL)), _(_obj, RecommendToolType, createCarouselTool(false, itemComponent, getSearchPageURL)), _(_obj, DisplayResultsToolType, createDisplayResultsTool(itemComponent)), _(_obj, MemorizeToolType, {}), _(_obj, MemorySearchToolType, {}), _(_obj, PonderToolType, {}), _obj;
+    return _obj = {}, _$4(_obj, SearchIndexToolType, _$5(_$6({}, createCarouselTool(true, itemComponent, getSearchPageURL)), {
+        // The agent decides per turn whether the richer display-results tool
+        // takes over the rendering of the search results.
+        shouldRender: isDisplayResultsDisabled
+    })), _$4(_obj, RecommendToolType, createCarouselTool(false, itemComponent, getSearchPageURL)), _$4(_obj, DisplayResultsToolType, createDisplayResultsTool(itemComponent)), _$4(_obj, MemorizeToolType, {}), _$4(_obj, MemorySearchToolType, {}), _$4(_obj, PonderToolType, {}), _obj;
+}
+/**
+ * Whether the search tool renders its own results, i.e. the agent did not hand
+ * the turn to the display-results tool. Set on the message by the backend.
+ */ function isDisplayResultsDisabled(param) {
+    var parentMessage = param.parentMessage;
+    var _parentMessage_metadata;
+    return ((_parentMessage_metadata = parentMessage.metadata) === null || _parentMessage_metadata === void 0 ? void 0 : _parentMessage_metadata.displayResultsEnabled) !== true;
 }
 function mergeToolOptions(defaultTools, userTools) {
     if (!userTools) {
         return defaultTools;
     }
-    var tools = _$5({}, defaultTools, userTools);
+    var tools = _$6({}, defaultTools, userTools);
     Object.keys(userTools).forEach(function(toolName) {
-        var _defaultTools_toolName;
         var userTool = userTools[toolName];
-        var defaultStreamInput = (_defaultTools_toolName = defaultTools[toolName]) === null || _defaultTools_toolName === void 0 ? void 0 : _defaultTools_toolName.streamInput;
+        var defaultTool = defaultTools[toolName];
+        var defaultStreamInput = defaultTool === null || defaultTool === void 0 ? void 0 : defaultTool.streamInput;
         if (userTool.layoutComponent !== undefined && userTool.streamInput === undefined && defaultStreamInput !== undefined) {
-            tools[toolName] = _$4(_$5({}, userTool), {
+            tools[toolName] = _$5(_$6({}, tools[toolName]), {
                 streamInput: defaultStreamInput
             });
         }
+        // Overriding a tool's rendering shouldn't opt it out of the conditions
+        // under which the default renders at all.
+        if (userTool.shouldRender === undefined && (defaultTool === null || defaultTool === void 0 ? void 0 : defaultTool.shouldRender)) {
+            tools[toolName] = _$5(_$6({}, tools[toolName]), {
+                shouldRender: defaultTool.shouldRender
+            });
+        }
     });
     return tools;
 }
+var AnimationSnapshot = /*#__PURE__*/ function(_React_Component) {
+    _(AnimationSnapshot, _React_Component);
+    function AnimationSnapshot() {
+        _$1(this, AnimationSnapshot);
+        return _$2(this, AnimationSnapshot, arguments);
+    }
+    _$3(AnimationSnapshot, [
+        {
+            key: "getSnapshotBeforeUpdate",
+            value: function getSnapshotBeforeUpdate() {
+                return getActiveContainerAnimations(this.props.promptRef.current);
+            }
+        },
+        {
+            key: "componentDidUpdate",
+            value: function componentDidUpdate(_previousProps, _previousState, animationsBeforeReveal) {
+                this.props.animationsBeforeReveal.current = animationsBeforeReveal;
+                if (!_previousProps.open && this.props.open) {
+                    holdContainerInertUntilReveal(this.props.promptRef.current);
+                } else if (this.props.open) {
+                    restoreContainerInertUntilReveal(this.props.promptRef.current);
+                }
+            }
+        },
+        {
+            key: "render",
+            value: function render() {
+                return null;
+            }
+        }
+    ]);
+    return AnimationSnapshot;
+}(React.Component);
 function ChatInner(_0, _1) {
     var _ref = [
         _0,
         _1
-    ], _ref1 = _$1(_ref), _ref2 = _ref1[0], _rest = _ref1.slice(1), userTools = _ref2.tools, headerProps = _ref2.headerProps, messagesProps = _ref2.messagesProps, promptProps = _ref2.promptProps, itemComponent = _ref2.itemComponent, layoutComponent = _ref2.layoutComponent, headerComponent = _ref2.headerComponent, headerTitleIconComponent = _ref2.headerTitleIconComponent, headerCloseIconComponent = _ref2.headerCloseIconComponent, headerMinimizeIconComponent = _ref2.headerMinimizeIconComponent, headerMaximizeIconComponent = _ref2.headerMaximizeIconComponent, loaderComponent = _ref2.loaderComponent, messagesErrorComponent = _ref2.messagesErrorComponent, promptComponent = _ref2.promptComponent, promptHeaderComponent = _ref2.promptHeaderComponent, promptFooterComponent = _ref2.promptFooterComponent, assistantMessageLeadingComponent = _ref2.assistantMessageLeadingComponent, assistantMessageFooterComponent = _ref2.assistantMessageFooterComponent, userMessageLeadingComponent = _ref2.userMessageLeadingComponent, userMessageFooterComponent = _ref2.userMessageFooterComponent, emptyComponent = _ref2.emptyComponent, actionsComponent = _ref2.actionsComponent, suggestionsComponent = _ref2.suggestionsComponent, classNames = _ref2.classNames, _ref_translations = _ref2.translations, translations = _ref_translations === void 0 ? {} : _ref_translations, title = _ref2.title, getSearchPageURL = _ref2.getSearchPageURL, _ref_disableTriggerValidation = _ref2.disableTriggerValidation, disableTriggerValidation = _ref_disableTriggerValidation === void 0 ? false : _ref_disableTriggerValidation, showReasoning = _ref2.showReasoning, props = _$2(_ref2, [
+    ], _ref1 = _$7(_ref), _ref2 = _ref1[0], _rest = _ref1.slice(1), userTools = _ref2.tools, headerProps = _ref2.headerProps, messagesProps = _ref2.messagesProps, promptProps = _ref2.promptProps, itemComponent = _ref2.itemComponent, layoutComponent = _ref2.layoutComponent, headerComponent = _ref2.headerComponent, headerTitleIconComponent = _ref2.headerTitleIconComponent, headerCloseIconComponent = _ref2.headerCloseIconComponent, headerMinimizeIconComponent = _ref2.headerMinimizeIconComponent, headerMaximizeIconComponent = _ref2.headerMaximizeIconComponent, loaderComponent = _ref2.loaderComponent, loaderPosition = _ref2.loaderPosition, shouldShowLoader = _ref2.shouldShowLoader, loaderShowDelay = _ref2.loaderShowDelay, loaderMinDuration = _ref2.loaderMinDuration, messagesErrorComponent = _ref2.messagesErrorComponent, promptComponent = _ref2.promptComponent, promptHeaderComponent = _ref2.promptHeaderComponent, promptFooterComponent = _ref2.promptFooterComponent, assistantMessageLeadingComponent = _ref2.assistantMessageLeadingComponent, assistantMessageFooterComponent = _ref2.assistantMessageFooterComponent, userMessageLeadingComponent = _ref2.userMessageLeadingComponent, userMessageFooterComponent = _ref2.userMessageFooterComponent, emptyComponent = _ref2.emptyComponent, actionsComponent = _ref2.actionsComponent, suggestionsComponent = _ref2.suggestionsComponent, classNames = _ref2.classNames, _ref_translations = _ref2.translations, translations = _ref_translations === void 0 ? {} : _ref_translations, title = _ref2.title, getSearchPageURL = _ref2.getSearchPageURL, _ref_disableTriggerValidation = _ref2.disableTriggerValidation, disableTriggerValidation = _ref_disableTriggerValidation === void 0 ? false : _ref_disableTriggerValidation, showReasoning = _ref2.showReasoning, props = _$8(_ref2, [
         "tools",
         "headerProps",
         "messagesProps",
@@ -57,6 +115,10 @@ function ChatInner(_0, _1) {
         "headerMinimizeIconComponent",
         "headerMaximizeIconComponent",
         "loaderComponent",
+        "loaderPosition",
+        "shouldShowLoader",
+        "loaderShowDelay",
+        "loaderMinDuration",
         "messagesErrorComponent",
         "promptComponent",
         "promptHeaderComponent",
@@ -74,12 +136,14 @@ function ChatInner(_0, _1) {
         "getSearchPageURL",
         "disableTriggerValidation",
         "showReasoning"
-    ]), _rest1 = _$3(_rest, 1), ref = _rest1[0];
+    ]), _rest1 = _$9(_rest, 1), ref = _rest1[0];
     var _ref3;
     var promptTranslations = translations.prompt, headerTranslations = translations.header, messageTranslations = translations.message, messagesTranslations = translations.messages;
     var _useInstantSearch = useInstantSearch(), indexUiState = _useInstantSearch.indexUiState, setIndexUiState = _useInstantSearch.setIndexUiState;
-    var _useState = _$3(useState(false), 2), maximized = _useState[0], setMaximized = _useState[1];
+    var _useState = _$9(useState(false), 2), maximized = _useState[0], setMaximized = _useState[1];
     var promptRef = useRef(null);
+    var focusRequestId = useRef(0);
+    var animationsBeforeReveal = useRef([]);
     var _useStickToBottom = useStickToBottom({
         initial: 'smooth',
         resize: 'smooth'
@@ -97,11 +161,11 @@ function ChatInner(_0, _1) {
     // set on the layout component, which is consistent across flavors.
     var isInlineLayoutComponent = typeof layoutComponent === 'function' && layoutComponent.$$inlineLayout === true;
     var effectiveDisableTriggerValidation = disableTriggerValidation || isInlineLayoutComponent;
-    var chatState = useChat(_$4(_$5({}, props), {
+    var chatState = useChat(_$5(_$6({}, props), {
         tools: tools,
         disableTriggerValidation: effectiveDisableTriggerValidation
     }));
-    var messages = chatState.messages, sendMessage = chatState.sendMessage, status = chatState.status, regenerate = chatState.regenerate, stop = chatState.stop, error = chatState.error, input = chatState.input, setInput = chatState.setInput, open = chatState.open, setOpen = chatState.setOpen, clearMessages = chatState.clearMessages, toolsFromConnector = chatState.tools, suggestions = chatState.suggestions, onFeedback = chatState.sendChatMessageFeedback, feedbackState = chatState.feedbackState, consumeInputFocus = chatState['~consumeInputFocus'], isOpenStatePersistenceEnabled = chatState['~isOpenStatePersistenceEnabled'];
+    var messages = chatState.messages, sendMessage = chatState.sendMessage, status = chatState.status, regenerate = chatState.regenerate, stop = chatState.stop, error = chatState.error, input = chatState.input, setInput = chatState.setInput, open = chatState.open, setOpen = chatState.setOpen, clearMessages = chatState.clearMessages, toolsFromConnector = chatState.tools, suggestions = chatState.suggestions, suggestionsStatus = chatState.suggestionsStatus, onFeedback = chatState.sendChatMessageFeedback, feedbackState = chatState.feedbackState, consumeInputFocus = chatState['~consumeInputFocus'], isOpenStatePersistenceEnabled = chatState['~isOpenStatePersistenceEnabled'];
     useImperativeHandle(ref, function() {
         return {
             setOpen: setOpen,
@@ -112,10 +176,21 @@ function ChatInner(_0, _1) {
         };
     });
     useEffect(function() {
+        if (!open) {
+            focusRequestId.current++;
+            return;
+        }
         if (consumeInputFocus === null || consumeInputFocus === void 0 ? void 0 : consumeInputFocus()) {
+            var currentFocusRequestId = ++focusRequestId.current;
+            var previousAnimations = animationsBeforeReveal.current;
+            holdContainerInertUntilReveal(promptRef.current);
             window.requestAnimationFrame(function() {
-                var _promptRef_current;
-                (_promptRef_current = promptRef.current) === null || _promptRef_current === void 0 ? void 0 : _promptRef_current.focus();
+                var prompt = promptRef.current;
+                focusAfterReveal(prompt, previousAnimations, function() {
+                    return focusRequestId.current === currentFocusRequestId && promptRef.current === prompt;
+                }, function() {
+                    return focusRequestId.current === currentFocusRequestId;
+                });
             });
         }
     });
@@ -136,11 +211,11 @@ function ChatInner(_0, _1) {
         status,
         scrollToBottom
     ]);
-    var _ref4 = messagesProps !== null && messagesProps !== void 0 ? messagesProps : {}, callerAssistantMessageProps = _ref4.assistantMessageProps, callerUserMessageProps = _ref4.userMessageProps, restMessagesProps = _$2(_ref4, [
+    var _ref4 = messagesProps !== null && messagesProps !== void 0 ? messagesProps : {}, callerAssistantMessageProps = _ref4.assistantMessageProps, callerUserMessageProps = _ref4.userMessageProps, restMessagesProps = _$8(_ref4, [
         "assistantMessageProps",
         "userMessageProps"
     ]);
-    return /*#__PURE__*/ React.createElement(ChatUiComponent, {
+    var chat = /*#__PURE__*/ React.createElement(ChatUiComponent, {
         title: title,
         open: open,
         maximized: maximized,
@@ -152,7 +227,7 @@ function ChatInner(_0, _1) {
         headerComponent: headerComponent,
         promptComponent: promptComponent,
         suggestionsComponent: suggestionsComponent,
-        headerProps: _$5({
+        headerProps: _$6({
             onClose: function onClose() {
                 return setOpen(false);
             },
@@ -168,7 +243,7 @@ function ChatInner(_0, _1) {
             maximizeIconComponent: headerMaximizeIconComponent,
             translations: headerTranslations
         }, headerProps),
-        messagesProps: _$4(_$5({
+        messagesProps: _$5(_$6({
             status: status,
             onReload: function onReload(messageId) {
                 return regenerate({
@@ -192,24 +267,28 @@ function ChatInner(_0, _1) {
             contentRef: contentRef,
             onScrollToBottom: scrollToBottom,
             loaderComponent: loaderComponent,
+            loaderPosition: loaderPosition,
+            shouldShowLoader: shouldShowLoader,
+            loaderShowDelay: loaderShowDelay,
+            loaderMinDuration: loaderMinDuration,
             errorComponent: messagesErrorComponent,
             emptyComponent: emptyComponent,
             actionsComponent: actionsComponent,
             translations: messagesTranslations,
             messageTranslations: messageTranslations
         }, restMessagesProps), {
-            assistantMessageProps: _$5({
+            assistantMessageProps: _$6({
                 leadingComponent: assistantMessageLeadingComponent,
                 footerComponent: assistantMessageFooterComponent,
                 showReasoning: showReasoning
             }, callerAssistantMessageProps),
-            userMessageProps: _$5({
+            userMessageProps: _$6({
                 leadingComponent: userMessageLeadingComponent,
                 footerComponent: userMessageFooterComponent
             }, callerUserMessageProps),
             error: error
         }),
-        promptProps: _$4(_$5({
+        promptProps: _$5(_$6({
             promptRef: promptRef,
             status: status,
             value: input,
@@ -233,6 +312,7 @@ function ChatInner(_0, _1) {
         }),
         suggestionsProps: {
             suggestions: suggestions,
+            isLoading: suggestionsStatus === 'loading',
             onSuggestionClick: function onSuggestionClick(suggestion) {
                 sendMessage({
                     text: suggestion
@@ -241,6 +321,11 @@ function ChatInner(_0, _1) {
         },
         classNames: classNames
     });
+    return /*#__PURE__*/ React.createElement(React.Fragment, null, /*#__PURE__*/ React.createElement(AnimationSnapshot, {
+        promptRef: promptRef,
+        animationsBeforeReveal: animationsBeforeReveal,
+        open: open
+    }), chat);
 }
 var Chat = /*#__PURE__*/ React.forwardRef(ChatInner);
 

package/dist/es/widgets/PromptSuggestions.d.ts

@@ -8,6 +8,7 @@ import type { UsePromptSuggestionsProps } from 'react-instantsearch-core';
 export type PromptSuggestionsLayoutComponentProps = {
     suggestions: string[];
     isLoading: boolean;
+    error: Error | undefined;
     onSuggestionClick: (prompt: string) => void;
     isChatBusy: boolean;
 };

package/dist/es/widgets/PromptSuggestions.js

@@ -22,16 +22,20 @@ function PromptSuggestions(_0) {
         "context",
         "transformItems"
     ]);
-    var _usePromptSuggestions = usePromptSuggestions({
+    var source = agentId !== undefined ? {
         agentId: agentId,
-        transport: transport,
+        transport: transport
+    } : {
+        transport: transport
+    };
+    var _usePromptSuggestions = usePromptSuggestions(_$1(_$2({}, source), {
         configurationId: configurationId,
         transformHits: transformHits,
         context: context,
         transformItems: transformItems
-    }, {
+    }), {
         $$widgetType: 'ais.promptSuggestions'
-    }), suggestions = _usePromptSuggestions.suggestions, isLoading = _usePromptSuggestions.isLoading, onSuggestionClick = _usePromptSuggestions.onSuggestionClick, isChatBusy = _usePromptSuggestions.isChatBusy, sendToChat = _usePromptSuggestions.sendToChat;
+    }), suggestions = _usePromptSuggestions.suggestions, isLoading = _usePromptSuggestions.isLoading, error = _usePromptSuggestions.error, onSuggestionClick = _usePromptSuggestions.onSuggestionClick, isChatBusy = _usePromptSuggestions.isChatBusy, sendToChat = _usePromptSuggestions.sendToChat;
     var handleClick = onSuggestionClickOverride ? function(prompt) {
         return onSuggestionClickOverride(prompt, {
             sendToChat: sendToChat
@@ -41,6 +45,7 @@ function PromptSuggestions(_0) {
         return /*#__PURE__*/ React.createElement(LayoutComponent, {
             suggestions: suggestions,
             isLoading: isLoading,
+            error: error,
             onSuggestionClick: handleClick,
             isChatBusy: isChatBusy
         });