react-instantsearch 7.32.3 → 7.33.1

package/dist/umd/ReactInstantSearch.js

@@ -1,4 +1,4 @@
-/*! React InstantSearch 7.32.3 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch */
+/*! React InstantSearch 7.33.1 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch */
 (function (global, factory) {
     typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('react')) :
     typeof define === 'function' && define.amd ? define(['exports', 'react'], factory) :
@@ -24,7 +24,7 @@
 
     var React__namespace = /*#__PURE__*/_interopNamespaceDefault(React);
 
-    var version$2 = '7.32.3';
+    var version$2 = '7.33.1';
 
     function _define_property(obj, key, value) {
         if (key in obj) {
@@ -10821,7 +10821,7 @@
         };
     }
 
-    var version = '4.97.0';
+    var version = '4.99.0';
 
     var withUsage$q = createDocumentationMessageGenerator({
         name: 'instantsearch'
@@ -12536,6 +12536,12 @@
                 }
             });
             /**
+       * Regenerate the chat id. Use this to start a fresh conversation on the
+       * server while keeping the same Chat instance and its registered listeners.
+       */ _define_property(this, "regenerateId", function() {
+                _this.id = _this.generateId();
+            });
+            /**
        * Add a tool result for a tool call.
        */ _define_property(this, "addToolResult", function(param) {
                 var tool = param.tool, toolCallId = param.toolCallId, output = param.output;
@@ -13412,6 +13418,41 @@
         return Chat;
     }(AbstractChat);
 
+    // Centralizes the "open the chat from an entry point" behavior shared by the
+    // SearchBox AI button, the Autocomplete AI button, prompt suggestions, and any
+    // future entry point. The chat is always opened; the message is only sent when
+    // it is non-empty and the chat is not already processing a message.
+    // Returns true when a message was submitted, so callers can clear their input.
+    function openChat(chatRenderState) {
+        var _ref = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : {}, message = _ref.message, referer = _ref.referer;
+        var _ref1;
+        var _chatRenderState_setOpen;
+        if (!chatRenderState) {
+            return false;
+        }
+        (_chatRenderState_setOpen = chatRenderState.setOpen) === null || _chatRenderState_setOpen === void 0 ? void 0 : _chatRenderState_setOpen.call(chatRenderState, true);
+        var trimmed = (_ref1 = message === null || message === void 0 ? void 0 : message.trim()) !== null && _ref1 !== void 0 ? _ref1 : '';
+        if (!trimmed) {
+            var _chatRenderState_focusInput;
+            (_chatRenderState_focusInput = chatRenderState.focusInput) === null || _chatRenderState_focusInput === void 0 ? void 0 : _chatRenderState_focusInput.call(chatRenderState);
+            return false;
+        }
+        if (isChatBusy(chatRenderState) || !chatRenderState.sendMessage) {
+            return false;
+        }
+        chatRenderState.sendMessage({
+            text: trimmed
+        }, referer ? {
+            headers: {
+                'x-algolia-referer': referer
+            }
+        } : undefined);
+        return true;
+    }
+    function isChatBusy(chatRenderState) {
+        return (chatRenderState === null || chatRenderState === void 0 ? void 0 : chatRenderState.status) === 'submitted' || (chatRenderState === null || chatRenderState === void 0 ? void 0 : chatRenderState.status) === 'streaming';
+    }
+
     var SearchIndexToolType$1 = 'algolia_search_index';
     var RecommendToolType = 'algolia_recommend';
     var MemorizeToolType = 'algolia_memorize';
@@ -13707,12 +13748,14 @@
             var onClearTransitionEnd = function onClearTransitionEnd() {
                 setMessages([]);
                 _chatInstance.clearError();
+                _chatInstance.regenerateId();
                 feedbackState = {};
                 setIsClearing(false);
             };
             var makeChatInstance = function makeChatInstance(instantSearchInstance) {
                 var transport;
-                var _getAppIdAndApiKey = _sliced_to_array(getAppIdAndApiKey(instantSearchInstance.client), 2), appId = _getAppIdAndApiKey[0], apiKey = _getAppIdAndApiKey[1];
+                var client = instantSearchInstance.client;
+                var _getAppIdAndApiKey = _sliced_to_array(getAppIdAndApiKey(client), 2), appId = _getAppIdAndApiKey[0], apiKey = _getAppIdAndApiKey[1];
                 // Filter out custom data parts (like data-suggestions) that the backend doesn't accept
                 var filterDataParts = function filterDataParts(messages) {
                     return messages.map(function(message) {
@@ -13729,9 +13772,16 @@
                     transport = new DefaultChatTransport(_object_spread_props(_object_spread({}, options.transport), {
                         prepareSendMessagesRequest: function prepareSendMessagesRequest(params) {
                             // Call the original prepareSendMessagesRequest if it exists,
-                            // otherwise construct the default body
+                            // otherwise construct a minimal default body containing only the
+                            // request payload — without leaking transport metadata such as
+                            // resolved headers, api URL, credentials, or `requestMetadata`.
                             var preparedOrPromise = originalPrepare ? originalPrepare(params) : {
-                                body: _object_spread({}, params)
+                                body: _object_spread({
+                                    id: params.id,
+                                    messageId: params.messageId,
+                                    trigger: params.trigger,
+                                    messages: params.messages
+                                }, params.body)
                             };
                             // Then filter out data-* parts
                             var applyFilter = function applyFilter(prepared) {
@@ -13758,20 +13808,19 @@
                         api: baseApi,
                         headers: {
                             'x-algolia-application-id': appId,
-                            'x-algolia-api-Key': apiKey,
-                            'x-algolia-agent': getAlgoliaAgent(instantSearchInstance.client)
+                            'x-algolia-api-key': apiKey,
+                            'x-algolia-agent': "".concat(getAlgoliaAgent(client), "; chat")
                         },
-                        prepareSendMessagesRequest: function prepareSendMessagesRequest(_0) {
-                            var messages = _0.messages, trigger = _0.trigger, rest = _object_without_properties(_0, [
-                                "messages",
-                                "trigger"
-                            ]);
+                        prepareSendMessagesRequest: function prepareSendMessagesRequest(param) {
+                            var id = param.id, messages = param.messages, trigger = param.trigger, messageId = param.messageId;
                             return {
                                 // Bypass cache when regenerating to ensure fresh responses
                                 api: trigger === 'regenerate-message' ? "".concat(baseApi, "&cache=false") : baseApi,
-                                body: _object_spread_props(_object_spread({}, rest), {
+                                body: {
+                                    id: id,
+                                    messageId: messageId,
                                     messages: filterDataParts(messages)
-                                })
+                                }
                             };
                         }
                     });
@@ -13945,47 +13994,15 @@
                                 message
                             ].concat(_to_consumable_array(rest)));
                         }
-                        var resolvedContext = typeof context === 'function' ? context() : context;
-                        var serializedContext;
-                        try {
-                            serializedContext = JSON.stringify(resolvedContext);
-                        } catch (unused) {
-                            var _chatInstance3;
-                            return (_chatInstance3 = _chatInstance).sendMessage.apply(_chatInstance3, [
-                                message
-                            ].concat(_to_consumable_array(rest)));
-                        }
-                        var contextTextPart = {
-                            type: 'text',
-                            text: '<context>'.concat(serializedContext).concat('</context>')
-                        };
-                        if ('parts' in message && message.parts) {
-                            var _chatInstance4;
-                            return (_chatInstance4 = _chatInstance).sendMessage.apply(_chatInstance4, [
-                                _object_spread_props(_object_spread({}, message), {
-                                    parts: [
-                                        contextTextPart
-                                    ].concat(_to_consumable_array(message.parts)),
-                                    text: undefined,
-                                    files: undefined
-                                })
-                            ].concat(_to_consumable_array(rest)));
-                        }
-                        var textContent = 'text' in message && message.text ? message.text : '';
+                        // Resolve once per send; let the server validate the payload and
+                        // surface any contract violations.
+                        var turnContext = typeof context === 'function' ? context() : context;
                         return (_chatInstance1 = _chatInstance).sendMessage.apply(_chatInstance1, [
-                            {
-                                parts: [
-                                    contextTextPart,
-                                    {
-                                        type: 'text',
-                                        text: textContent
-                                    }
-                                ],
-                                metadata: message.metadata,
-                                messageId: message.messageId,
-                                files: undefined,
-                                text: undefined
-                            }
+                            _object_spread_props(_object_spread({}, message), {
+                                metadata: _object_spread_props(_object_spread({}, message.metadata), {
+                                    turnContext: turnContext
+                                })
+                            })
                         ].concat(_to_consumable_array(rest)));
                     };
                     return {
@@ -17393,7 +17410,7 @@
         var unmountFn = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : noop;
         checkRendering(renderFn, withUsage$2());
         return function(widgetParams) {
-            var _ref = widgetParams || {}, facetName = _ref.facetName, limit = _ref.limit, threshold = _ref.threshold, fallbackParameters = _ref.fallbackParameters, queryParameters = _ref.queryParameters, _ref_escapeHTML = _ref.escapeHTML, escapeHTML = _ref_escapeHTML === void 0 ? true : _ref_escapeHTML, _ref_transformItems = _ref.transformItems, transformItems = _ref_transformItems === void 0 ? function(items) {
+            var _ref = widgetParams || {}, facetName = _ref.facetName, limit = _ref.limit, threshold = _ref.threshold, fallbackParameters = _ref.fallbackParameters, _ref_escapeHTML = _ref.escapeHTML, escapeHTML = _ref_escapeHTML === void 0 ? true : _ref_escapeHTML, _ref_transformItems = _ref.transformItems, transformItems = _ref_transformItems === void 0 ? function(items) {
                 return items;
             } : _ref_transformItems;
             if (!facetName) {
@@ -17461,7 +17478,6 @@
                         maxRecommendations: limit,
                         threshold: threshold,
                         fallbackParameters: fallbackParameters ? _object_spread({}, fallbackParameters, escapeHTML ? TAG_PLACEHOLDER : {}) : undefined,
-                        queryParameters: _object_spread({}, queryParameters, escapeHTML ? TAG_PLACEHOLDER : {}),
                         $$id: this.$$id
                     });
                 }
@@ -17565,7 +17581,9 @@
         name: 'filter-suggestions',
         connector: true
     });
-    var connectFilterSuggestions = function connectFilterSuggestions(renderFn) {
+    /**
+     * @deprecated Filter suggestions are deprecated and will be removed in a future major version.
+     */ var connectFilterSuggestions = function connectFilterSuggestions(renderFn) {
         var unmountFn = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : noop;
         checkRendering(renderFn, withUsage());
         return function(widgetParams) {
@@ -17777,7 +17795,9 @@
         };
     };
 
-    function useFilterSuggestions(props, additionalWidgetProperties) {
+    /**
+     * @deprecated Filter suggestions are deprecated and will be removed in a future major version.
+     */ function useFilterSuggestions(props, additionalWidgetProperties) {
         return useConnector(connectFilterSuggestions, props, additionalWidgetProperties);
     }
 
@@ -18804,7 +18824,7 @@
     function createAutocompleteSearchComponent(param) {
         var createElement = param.createElement;
         return function AutocompleteSearch(userProps) {
-            var inputProps = userProps.inputProps, onClear = userProps.onClear, query = userProps.query, isSearchStalled = userProps.isSearchStalled, onCancel = userProps.onCancel, isDetached = userProps.isDetached, submitTitle = userProps.submitTitle, onAiModeClick = userProps.onAiModeClick, _userProps_classNames = userProps.classNames, classNames = _userProps_classNames === void 0 ? {} : _userProps_classNames;
+            var inputProps = userProps.inputProps, onClear = userProps.onClear, query = userProps.query, isSearchStalled = userProps.isSearchStalled, onCancel = userProps.onCancel, isDetached = userProps.isDetached, submitTitle = userProps.submitTitle, onAiModeClick = userProps.onAiModeClick, _userProps_aiModeButtonDisabled = userProps.aiModeButtonDisabled, aiModeButtonDisabled = _userProps_aiModeButtonDisabled === void 0 ? false : _userProps_aiModeButtonDisabled, _userProps_classNames = userProps.classNames, classNames = _userProps_classNames === void 0 ? {} : _userProps_classNames;
             var isBackButton = Boolean(isDetached && onCancel);
             var resolvedCancelTitle = submitTitle !== null && submitTitle !== void 0 ? submitTitle : 'Close';
             var inputRef = inputProps.ref;
@@ -18881,6 +18901,7 @@
                 className: cx('ais-AiModeButton', classNames.aiModeButton),
                 type: "button",
                 title: "AI Mode",
+                disabled: aiModeButtonDisabled,
                 onClick: function onClick(e) {
                     e.preventDefault();
                     onAiModeClick();
@@ -19687,6 +19708,10 @@
                     return null;
                 }
                 if (part.type === 'text') {
+                    // Back-compat shim for sessions started before the move from a
+                    // `<context>{...}</context>` text part to `metadata.turnContext`.
+                    // Safe to remove once existing sessionStorage transcripts have
+                    // rolled over (~2 weeks after release).
                     if (part.text.startsWith('<context>') && part.text.endsWith('</context>')) {
                         return null;
                     }
@@ -21696,7 +21721,7 @@
         Fragment: React.Fragment
     });
     function AutocompleteSearch(param) {
-        var inputProps = param.inputProps, clearQuery = param.clearQuery, onQueryChange = param.onQueryChange, query = param.query, isSearchStalled = param.isSearchStalled, onCancel = param.onCancel, isDetached = param.isDetached, submitTitle = param.submitTitle, onAiModeClick = param.onAiModeClick, classNames = param.classNames;
+        var inputProps = param.inputProps, clearQuery = param.clearQuery, onQueryChange = param.onQueryChange, query = param.query, isSearchStalled = param.isSearchStalled, onCancel = param.onCancel, isDetached = param.isDetached, submitTitle = param.submitTitle, onAiModeClick = param.onAiModeClick, aiModeButtonDisabled = param.aiModeButtonDisabled, classNames = param.classNames;
         return /*#__PURE__*/ React.createElement(AutocompleteSearchComponent, {
             inputProps: _object_spread_props(_object_spread({}, inputProps), {
                 onChange: function onChange(event) {
@@ -21711,6 +21736,7 @@
             isDetached: isDetached,
             submitTitle: submitTitle,
             onAiModeClick: onAiModeClick,
+            aiModeButtonDisabled: aiModeButtonDisabled,
             classNames: classNames
         });
     }
@@ -22207,14 +22233,13 @@
             onSelect: userOnSelect !== null && userOnSelect !== void 0 ? userOnSelect : function(param) {
                 var item = param.item, query = param.query, setQuery = param.setQuery, url = param.url;
                 if (isPromptSuggestion(item)) {
-                    var chatRenderStateWithFocus = chatRenderState;
-                    if (chatRenderStateWithFocus) {
-                        var _chatRenderStateWithFocus_setOpen, _chatRenderStateWithFocus_focusInput, _chatRenderStateWithFocus_sendMessage;
-                        (_chatRenderStateWithFocus_setOpen = chatRenderStateWithFocus.setOpen) === null || _chatRenderStateWithFocus_setOpen === void 0 ? void 0 : _chatRenderStateWithFocus_setOpen.call(chatRenderStateWithFocus, true);
-                        (_chatRenderStateWithFocus_focusInput = chatRenderStateWithFocus.focusInput) === null || _chatRenderStateWithFocus_focusInput === void 0 ? void 0 : _chatRenderStateWithFocus_focusInput.call(chatRenderStateWithFocus);
-                        (_chatRenderStateWithFocus_sendMessage = chatRenderStateWithFocus.sendMessage) === null || _chatRenderStateWithFocus_sendMessage === void 0 ? void 0 : _chatRenderStateWithFocus_sendMessage.call(chatRenderStateWithFocus, {
-                            text: item.prompt
-                        });
+                    if (chatRenderState) {
+                        if (openChat(chatRenderState, {
+                            message: item.prompt,
+                            referer: 'prompt-suggestions'
+                        })) {
+                            setQuery('');
+                        }
                         return;
                     }
                     if ((showPromptSuggestions === null || showPromptSuggestions === void 0 ? void 0 : showPromptSuggestions.indexName) && !hasWarnedMissingPromptSuggestionsChatRef.current) {
@@ -22354,17 +22379,15 @@
                 if (isDetached) {
                     setIsModalOpen(false);
                 }
-                if (chatRenderState) {
-                    var _chatRenderState_setOpen;
-                    (_chatRenderState_setOpen = chatRenderState.setOpen) === null || _chatRenderState_setOpen === void 0 ? void 0 : _chatRenderState_setOpen.call(chatRenderState, true);
-                    if (resolvedQuery.trim()) {
-                        var _chatRenderState_sendMessage;
-                        (_chatRenderState_sendMessage = chatRenderState.sendMessage) === null || _chatRenderState_sendMessage === void 0 ? void 0 : _chatRenderState_sendMessage.call(chatRenderState, {
-                            text: resolvedQuery
-                        });
-                    }
+                if (openChat(chatRenderState, {
+                    message: resolvedQuery,
+                    referer: 'ai-mode'
+                })) {
+                    refineSearchBox('');
+                    refineAutocomplete('');
                 }
             } : undefined,
+            aiModeButtonDisabled: aiMode ? isChatBusy(chatRenderState) : undefined,
             classNames: classNames
         });
         var panelContent = /*#__PURE__*/ React.createElement(AutocompletePanel, _object_spread_props(_object_spread({}, getPanelProps()), {
@@ -24013,7 +24036,7 @@
         }));
     }
     function SearchBox$1(_0) {
-        var formRef = _0.formRef, inputRef = _0.inputRef, inputProps = _0.inputProps, isSearchStalled = _0.isSearchStalled, onChange = _0.onChange, onReset = _0.onReset, onSubmit = _0.onSubmit, _0_placeholder = _0.placeholder, placeholder = _0_placeholder === void 0 ? '' : _0_placeholder, value = _0.value, autoFocus = _0.autoFocus, tmp = _0.resetIconComponent, ResetIcon = tmp === void 0 ? DefaultResetIcon : tmp, tmp1 = _0.submitIconComponent, SubmitIcon = tmp1 === void 0 ? DefaultSubmitIcon : tmp1, tmp2 = _0.loadingIconComponent, LoadingIcon = tmp2 === void 0 ? DefaultLoadingIcon : tmp2, tmp3 = _0.aiModeIconComponent, AiModeIcon = tmp3 === void 0 ? DefaultAiModeIcon : tmp3, onAiModeClick = _0.onAiModeClick, _0_classNames = _0.classNames, classNames = _0_classNames === void 0 ? {} : _0_classNames, translations = _0.translations, props = _object_without_properties(_0, [
+        var formRef = _0.formRef, inputRef = _0.inputRef, inputProps = _0.inputProps, isSearchStalled = _0.isSearchStalled, onChange = _0.onChange, onReset = _0.onReset, onSubmit = _0.onSubmit, _0_placeholder = _0.placeholder, placeholder = _0_placeholder === void 0 ? '' : _0_placeholder, value = _0.value, autoFocus = _0.autoFocus, tmp = _0.resetIconComponent, ResetIcon = tmp === void 0 ? DefaultResetIcon : tmp, tmp1 = _0.submitIconComponent, SubmitIcon = tmp1 === void 0 ? DefaultSubmitIcon : tmp1, tmp2 = _0.loadingIconComponent, LoadingIcon = tmp2 === void 0 ? DefaultLoadingIcon : tmp2, tmp3 = _0.aiModeIconComponent, AiModeIcon = tmp3 === void 0 ? DefaultAiModeIcon : tmp3, onAiModeClick = _0.onAiModeClick, _0_aiModeButtonDisabled = _0.aiModeButtonDisabled, aiModeButtonDisabled = _0_aiModeButtonDisabled === void 0 ? false : _0_aiModeButtonDisabled, _0_classNames = _0.classNames, classNames = _0_classNames === void 0 ? {} : _0_classNames, translations = _0.translations, props = _object_without_properties(_0, [
             "formRef",
             "inputRef",
             "inputProps",
@@ -24029,6 +24052,7 @@
             "loadingIconComponent",
             "aiModeIconComponent",
             "onAiModeClick",
+            "aiModeButtonDisabled",
             "classNames",
             "translations"
         ]);
@@ -24092,6 +24116,7 @@
             className: cx('ais-AiModeButton', classNames.aiModeButton),
             type: "button",
             title: translations.aiModeButtonTitle || 'AI Mode',
+            disabled: aiModeButtonDisabled,
             onClick: function onClick(e) {
                 e.preventDefault();
                 onAiModeClick();
@@ -24310,6 +24335,7 @@
         if (query !== inputValue && document.activeElement !== inputRef.current) {
             setInputValue(query);
         }
+        var chatRenderState = indexRenderState.chat;
         var uiProps = {
             inputRef: inputRef,
             isSearchStalled: isSearchStalled,
@@ -24317,18 +24343,14 @@
             onReset: onReset,
             onSubmit: onSubmit,
             onAiModeClick: aiMode ? function() {
-                var chatRenderState = indexRenderState.chat;
-                if (chatRenderState) {
-                    var _chatRenderState_setOpen;
-                    (_chatRenderState_setOpen = chatRenderState.setOpen) === null || _chatRenderState_setOpen === void 0 ? void 0 : _chatRenderState_setOpen.call(chatRenderState, true);
-                    if (inputValue.trim()) {
-                        var _chatRenderState_sendMessage;
-                        (_chatRenderState_sendMessage = chatRenderState.sendMessage) === null || _chatRenderState_sendMessage === void 0 ? void 0 : _chatRenderState_sendMessage.call(chatRenderState, {
-                            text: inputValue
-                        });
-                    }
+                if (openChat(chatRenderState, {
+                    message: inputValue,
+                    referer: 'ai-mode'
+                })) {
+                    onReset();
                 }
             } : undefined,
+            aiModeButtonDisabled: aiMode ? isChatBusy(chatRenderState) : undefined,
             value: inputValue,
             translations: _object_spread({
                 submitButtonTitle: 'Submit the search query',
@@ -24608,12 +24630,11 @@
         Fragment: React.Fragment
     });
     function TrendingFacets(_0) {
-        var facetName = _0.facetName, limit = _0.limit, threshold = _0.threshold, fallbackParameters = _0.fallbackParameters, queryParameters = _0.queryParameters, escapeHTML = _0.escapeHTML, transformItems = _0.transformItems, itemComponent = _0.itemComponent, headerComponent = _0.headerComponent, emptyComponent = _0.emptyComponent, props = _object_without_properties(_0, [
+        var facetName = _0.facetName, limit = _0.limit, threshold = _0.threshold, fallbackParameters = _0.fallbackParameters, escapeHTML = _0.escapeHTML, transformItems = _0.transformItems, itemComponent = _0.itemComponent, headerComponent = _0.headerComponent, emptyComponent = _0.emptyComponent, props = _object_without_properties(_0, [
             "facetName",
             "limit",
             "threshold",
             "fallbackParameters",
-            "queryParameters",
             "escapeHTML",
             "transformItems",
             "itemComponent",
@@ -24626,7 +24647,6 @@
             limit: limit,
             threshold: threshold,
             fallbackParameters: fallbackParameters,
-            queryParameters: queryParameters,
             escapeHTML: escapeHTML,
             transformItems: transformItems
         }, {
@@ -24646,7 +24666,9 @@
         createElement: React.createElement,
         Fragment: React.Fragment
     });
-    function FilterSuggestions(_0) {
+    /**
+     * @deprecated Filter suggestions are deprecated and will be removed in a future major version.
+     */ function FilterSuggestions(_0) {
         var agentId = _0.agentId, attributes = _0.attributes, maxSuggestions = _0.maxSuggestions, debounceMs = _0.debounceMs, hitsToSample = _0.hitsToSample, transformItems = _0.transformItems, itemComponent = _0.itemComponent, headerComponent = _0.headerComponent, emptyComponent = _0.emptyComponent, transport = _0.transport, props = _object_without_properties(_0, [
             "agentId",
             "attributes",