react-instantsearch-core 7.49.0 → 7.50.0

package/dist/umd/ReactInstantSearchCore.js

@@ -1,4 +1,4 @@
-/*! React InstantSearch Core 7.49.0 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch */
+/*! React InstantSearch Core 7.50.0 | © 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.49.0';
+    var version$2 = '7.50.0';
 
     function _define_property(obj, key, value) {
         if (key in obj) {
@@ -5980,7 +5980,7 @@
         }
     }
 
-    var withUsage$x = createDocumentationMessageGenerator({
+    var withUsage$y = createDocumentationMessageGenerator({
         name: 'configure',
         connector: true
     });
@@ -5996,7 +5996,7 @@
         var renderFn = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : noop, unmountFn = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : noop;
         return function(widgetParams) {
             if (!widgetParams || !isPlainObject(widgetParams.searchParameters)) {
-                throw new Error(withUsage$x('The `searchParameters` option expects an object.'));
+                throw new Error(withUsage$y('The `searchParameters` option expects an object.'));
             }
             var connectorState = {};
             function refine(helper) {
@@ -7833,13 +7833,13 @@
         return null;
     }
 
-    var withUsage$w = createDocumentationMessageGenerator({
+    var withUsage$x = createDocumentationMessageGenerator({
         name: 'dynamic-widgets',
         connector: true
     });
     var connectDynamicWidgets = function connectDynamicWidgets(renderFn) {
         var unmountFn = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : noop;
-        checkRendering(renderFn, withUsage$w());
+        checkRendering(renderFn, withUsage$x());
         return function(widgetParams) {
             var widgets = widgetParams.widgets, _widgetParams_maxValuesPerFacet = widgetParams.maxValuesPerFacet, maxValuesPerFacet = _widgetParams_maxValuesPerFacet === void 0 ? 20 : _widgetParams_maxValuesPerFacet, _widgetParams_facets = widgetParams.facets, facets = _widgetParams_facets === void 0 ? [
                 '*'
@@ -7849,10 +7849,10 @@
             if (!(widgets && Array.isArray(widgets) && widgets.every(function(widget) {
                 return (typeof widget === "undefined" ? "undefined" : _type_of(widget)) === 'object';
             }))) {
-                throw new Error(withUsage$w('The `widgets` option expects an array of widgets.'));
+                throw new Error(withUsage$x('The `widgets` option expects an array of widgets.'));
             }
             if (!Array.isArray(facets)) {
-                throw new Error(withUsage$w("The `facets` option only accepts an array of facets, you passed ".concat(JSON.stringify(facets))));
+                throw new Error(withUsage$x("The `facets` option only accepts an array of facets, you passed ".concat(JSON.stringify(facets))));
             }
             var localWidgets = new Map();
             return {
@@ -7954,7 +7954,7 @@
                         results: results
                     });
                     if (!Array.isArray(attributesToRender)) {
-                        throw new Error(withUsage$w('The `transformItems` option expects a function that returns an Array.'));
+                        throw new Error(withUsage$x('The `transformItems` option expects a function that returns an Array.'));
                     }
                     return {
                         attributesToRender: attributesToRender,
@@ -8345,19 +8345,19 @@
             return toFeedSearchResults(lastResults._state, raw);
         });
     }
-    var withUsage$v = createDocumentationMessageGenerator({
+    var withUsage$w = createDocumentationMessageGenerator({
         name: 'feeds',
         connector: true
     });
     var connectFeeds = function connectFeeds(renderFn) {
         var unmountFn = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : noop;
-        checkRendering(renderFn, withUsage$v());
+        checkRendering(renderFn, withUsage$w());
         return function(widgetParams) {
             var isolated = widgetParams.isolated, _widgetParams_transformFeeds = widgetParams.transformFeeds, transformFeeds = _widgetParams_transformFeeds === void 0 ? function(feeds) {
                 return feeds;
             } : _widgetParams_transformFeeds;
             if (isolated !== false) {
-                throw new Error(withUsage$v('The `isolated` option currently only supports `false`.'));
+                throw new Error(withUsage$w('The `isolated` option currently only supports `false`.'));
             }
             return {
                 $$type: 'ais.feeds',
@@ -8365,7 +8365,7 @@
                 init: function init(initOptions) {
                     var instantSearchInstance = initOptions.instantSearchInstance;
                     if (!instantSearchInstance.compositionID) {
-                        throw new Error(withUsage$v('The `feeds` widget requires a composition-based InstantSearch instance (compositionID must be set).'));
+                        throw new Error(withUsage$w('The `feeds` widget requires a composition-based InstantSearch instance (compositionID must be set).'));
                     }
                     hydrateFeedsFromInitialResultsIfNeeded(instantSearchInstance, initOptions.parent);
                     renderFn(_object_spread_props(_object_spread({}, this.getWidgetRenderState(initOptions)), {
@@ -8411,12 +8411,12 @@
                     ];
                     feedIDs = transformFeeds(feedIDs);
                     if (!Array.isArray(feedIDs)) {
-                        throw new Error(withUsage$v('The `transformFeeds` option expects a function that returns an Array.'));
+                        throw new Error(withUsage$w('The `transformFeeds` option expects a function that returns an Array.'));
                     }
                     if (!feedIDs.every(function(feedID) {
                         return typeof feedID === 'string';
                     })) {
-                        throw new Error(withUsage$v('The `transformFeeds` option expects a function that returns an array of feed IDs (strings).'));
+                        throw new Error(withUsage$w('The `transformFeeds` option expects a function that returns an array of feed IDs (strings).'));
                     }
                     return {
                         feedIDs: feedIDs,
@@ -8527,7 +8527,7 @@
         }));
     }
 
-    var withUsage$u = createDocumentationMessageGenerator({
+    var withUsage$v = createDocumentationMessageGenerator({
         name: 'index-widget'
     });
     /**
@@ -8655,7 +8655,7 @@
     var index = function index(widgetParams) {
         var _widgetParams_EXPERIMENTAL_isolated;
         if (widgetParams === undefined || widgetParams.indexName === undefined && !widgetParams.isolated && !widgetParams.EXPERIMENTAL_isolated) {
-            throw new Error(withUsage$u('The `indexName` option is required.'));
+            throw new Error(withUsage$v('The `indexName` option is required.'));
         }
         // When isolated=true, we use an empty string as the default indexName.
         // This is intentional: isolated indices do not require a real index name.
@@ -8753,7 +8753,7 @@
             addWidgets: function addWidgets(widgets) {
                 var _this = this;
                 if (!Array.isArray(widgets)) {
-                    throw new Error(withUsage$u('The `addWidgets` method expects an array of widgets.'));
+                    throw new Error(withUsage$v('The `addWidgets` method expects an array of widgets.'));
                 }
                 var flatWidgets = widgets.reduce(function(acc, w) {
                     return acc.concat(Array.isArray(w) ? w : [
@@ -8763,7 +8763,7 @@
                 if (flatWidgets.some(function(widget) {
                     return typeof widget.init !== 'function' && typeof widget.render !== 'function';
                 })) {
-                    throw new Error(withUsage$u('The widget definition expects a `render` and/or an `init` method.'));
+                    throw new Error(withUsage$v('The widget definition expects a `render` and/or an `init` method.'));
                 }
                 flatWidgets.forEach(function(widget) {
                     widget.parent = _this;
@@ -8813,10 +8813,10 @@
             },
             updateWidget: function updateWidget(previousWidget, nextWidget) {
                 if (typeof previousWidget.dispose !== 'function') {
-                    throw new Error(withUsage$u('The widget definition expects a `dispose` method.'));
+                    throw new Error(withUsage$v('The widget definition expects a `dispose` method.'));
                 }
                 if (typeof nextWidget.init !== 'function' && typeof nextWidget.render !== 'function') {
-                    throw new Error(withUsage$u('The widget definition expects a `render` and/or an `init` method.'));
+                    throw new Error(withUsage$v('The widget definition expects a `render` and/or an `init` method.'));
                 }
                 // The `uiState` as it is before the previous widget is detached, so that
                 // the state it owns can be handed over to the next widget.
@@ -8900,7 +8900,7 @@
             removeWidgets: function removeWidgets(widgets) {
                 var _this = this;
                 if (!Array.isArray(widgets)) {
-                    throw new Error(withUsage$u('The `removeWidgets` method expects an array of widgets.'));
+                    throw new Error(withUsage$v('The `removeWidgets` method expects an array of widgets.'));
                 }
                 var flatWidgets = widgets.reduce(function(acc, w) {
                     return acc.concat(Array.isArray(w) ? w : [
@@ -8910,7 +8910,7 @@
                 if (flatWidgets.some(function(widget) {
                     return typeof widget.dispose !== 'function';
                 })) {
-                    throw new Error(withUsage$u('The widget definition expects a `dispose` method.'));
+                    throw new Error(withUsage$v('The widget definition expects a `dispose` method.'));
                 }
                 localWidgets = localWidgets.filter(function(widget) {
                     return flatWidgets.indexOf(widget) === -1;
@@ -9418,7 +9418,7 @@
         });
     }
 
-    var version = '4.116.0';
+    var version = '4.118.0';
 
     var ANONYMOUS_TOKEN_COOKIE_KEY = '_ALGOLIA';
     function getCookie(name) {
@@ -11280,7 +11280,7 @@
         };
     }
 
-    var withUsage$t = createDocumentationMessageGenerator({
+    var withUsage$u = createDocumentationMessageGenerator({
         name: 'instantsearch'
     });
     function defaultCreateURL() {
@@ -11351,7 +11351,7 @@
             _this.setMaxListeners(100);
             var _options_indexName = options.indexName, indexName = _options_indexName === void 0 ? '' : _options_indexName, compositionID = options.compositionID, numberLocale = options.numberLocale, _options_initialUiState = options.initialUiState, initialUiState = _options_initialUiState === void 0 ? {} : _options_initialUiState, _options_routing = options.routing, routing = _options_routing === void 0 ? null : _options_routing, _options_insights = options.insights, insights = _options_insights === void 0 ? undefined : _options_insights, searchFunction = options.searchFunction, _options_stalledSearchDelay = options.stalledSearchDelay, stalledSearchDelay = _options_stalledSearchDelay === void 0 ? 200 : _options_stalledSearchDelay, _options_searchClient = options.searchClient, searchClient = _options_searchClient === void 0 ? null : _options_searchClient, _options_insightsClient = options.insightsClient, insightsClient = _options_insightsClient === void 0 ? null : _options_insightsClient, _options_onStateChange = options.onStateChange, onStateChange = _options_onStateChange === void 0 ? null : _options_onStateChange, _options_future1 = options.future, future = _options_future1 === void 0 ? _object_spread({}, INSTANTSEARCH_FUTURE_DEFAULTS, options.future || {}) : _options_future1;
             if (searchClient === null) {
-                throw new Error(withUsage$t('The `searchClient` option is required.'));
+                throw new Error(withUsage$u('The `searchClient` option is required.'));
             }
             if (typeof searchClient.search !== 'function') {
                 throw new Error("The `searchClient` must implement a `search` method.\n\nSee: https://www.algolia.com/doc/guides/building-search-ui/going-further/backend-search/in-depth/backend-instantsearch/js/");
@@ -11360,7 +11360,7 @@
                 searchClient.addAlgoliaAgent("instantsearch.js (".concat(version, ")"));
             }
             if (insightsClient && typeof insightsClient !== 'function') {
-                throw new Error(withUsage$t('The `insightsClient` option should be a function.'));
+                throw new Error(withUsage$u('The `insightsClient` option should be a function.'));
             }
             _this._initialOptions = options;
             _this.client = searchClient;
@@ -11509,12 +11509,12 @@
        * @param widgets The array of widgets to add to InstantSearch.
        */ function addWidgets(widgets) {
                     if (!Array.isArray(widgets)) {
-                        throw new Error(withUsage$t('The `addWidgets` method expects an array of widgets. Please use `addWidget`.'));
+                        throw new Error(withUsage$u('The `addWidgets` method expects an array of widgets. Please use `addWidget`.'));
                     }
                     if (this.compositionID && widgets.some(function(w) {
                         return !Array.isArray(w) && isIndexWidget(w) && !w._isolated;
                     })) {
-                        throw new Error(withUsage$t('The `index` widget cannot be used with a composition-based InstantSearch implementation.'));
+                        throw new Error(withUsage$u('The `index` widget cannot be used with a composition-based InstantSearch implementation.'));
                     }
                     this.mainIndex.addWidgets(widgets);
                     return this;
@@ -11543,7 +11543,7 @@
        * The widgets must implement a `dispose()` method to clear their states.
        */ function removeWidgets(widgets) {
                     if (!Array.isArray(widgets)) {
-                        throw new Error(withUsage$t('The `removeWidgets` method expects an array of widgets. Please use `removeWidget`.'));
+                        throw new Error(withUsage$u('The `removeWidgets` method expects an array of widgets. Please use `removeWidget`.'));
                     }
                     this.mainIndex.removeWidgets(widgets);
                     return this;
@@ -11557,7 +11557,7 @@
        */ function start() {
                     var _this = this;
                     if (this.started) {
-                        throw new Error(withUsage$t('The `start` method has already been called once.'));
+                        throw new Error(withUsage$u('The `start` method has already been called once.'));
                     }
                     // This Helper is used for the queries, we don't care about its state. The
                     // states are managed at the `index` level. We use this Helper to create
@@ -11765,7 +11765,7 @@
                     var _this = this;
                     var callOnStateChange = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : true;
                     if (!this.mainHelper) {
-                        throw new Error(withUsage$t('The `start` method needs to be called before `setUiState`.'));
+                        throw new Error(withUsage$u('The `start` method needs to be called before `setUiState`.'));
                     }
                     // We refresh the index UI state to update the local UI state that the
                     // main index passes to the function form of `setUiState`.
@@ -11802,7 +11802,7 @@
                 value: function createURL() {
                     var nextState = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : {};
                     if (!this.started) {
-                        throw new Error(withUsage$t('The `start` method needs to be called before `createURL`.'));
+                        throw new Error(withUsage$u('The `start` method needs to be called before `createURL`.'));
                     }
                     return this._createURL(nextState);
                 }
@@ -11811,7 +11811,7 @@
                 key: "refresh",
                 value: function refresh() {
                     if (!this.mainHelper) {
-                        throw new Error(withUsage$t('The `start` method needs to be called before `refresh`.'));
+                        throw new Error(withUsage$u('The `start` method needs to be called before `refresh`.'));
                     }
                     this.mainHelper.clearCache().search();
                 }
@@ -12343,13 +12343,13 @@
         }, children);
     }
 
-    var withUsage$s = createDocumentationMessageGenerator({
+    var withUsage$t = createDocumentationMessageGenerator({
         name: 'autocomplete',
         connector: true
     });
     var connectAutocomplete = function connectAutocomplete(renderFn) {
         var unmountFn = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : noop;
-        checkRendering(renderFn, withUsage$s());
+        checkRendering(renderFn, withUsage$t());
         return function(widgetParams) {
             var _ref = widgetParams || {}, _ref_escapeHTML = _ref.escapeHTML, escapeHTML = _ref_escapeHTML === void 0 ? true : _ref_escapeHTML, _ref_transformItems = _ref.transformItems, transformItems = _ref_transformItems === void 0 ? function(indices) {
                 return indices;
@@ -12462,20 +12462,20 @@
         return useConnector(connectAutocomplete, props, additionalWidgetProperties);
     }
 
-    var withUsage$r = createDocumentationMessageGenerator({
+    var withUsage$s = createDocumentationMessageGenerator({
         name: 'breadcrumb',
         connector: true
     });
     var connectBreadcrumb = function connectBreadcrumb(renderFn) {
         var unmountFn = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : noop;
-        checkRendering(renderFn, withUsage$r());
+        checkRendering(renderFn, withUsage$s());
         var connectorState = {};
         return function(widgetParams) {
             var _ref = widgetParams || {}, attributes = _ref.attributes, _ref_separator = _ref.separator, separator = _ref_separator === void 0 ? ' > ' : _ref_separator, _ref_rootPath = _ref.rootPath, rootPath = _ref_rootPath === void 0 ? null : _ref_rootPath, _ref_transformItems = _ref.transformItems, transformItems = _ref_transformItems === void 0 ? function(items) {
                 return items;
             } : _ref_transformItems;
             if (!attributes || !Array.isArray(attributes) || attributes.length === 0) {
-                throw new Error(withUsage$r('The `attributes` option expects an array of strings.'));
+                throw new Error(withUsage$s('The `attributes` option expects an array of strings.'));
             }
             var _attributes = _sliced_to_array(attributes, 1), hierarchicalFacetName = _attributes[0];
             function getRefinedState(state, facetValue) {
@@ -14917,7 +14917,7 @@
         return DefaultChatTransport;
     }(HttpChatTransport);
 
-    var withUsage$q = createDocumentationMessageGenerator({
+    var withUsage$r = createDocumentationMessageGenerator({
         name: 'chat',
         connector: true
     });
@@ -15048,7 +15048,7 @@
     }
     var connectChat = function connectChat(renderFn) {
         var unmountFn = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : noop;
-        checkRendering(renderFn, withUsage$q());
+        checkRendering(renderFn, withUsage$r());
         return function(widgetParams) {
             var _ref = widgetParams || {}, _ref_resume = _ref.resume, resume = _ref_resume === void 0 ? false : _ref_resume, tmp = _ref.tools, tools_ = tmp === void 0 ? {} : tmp, _ref_type = _ref.type, type = _ref_type === void 0 ? 'chat' : _ref_type, persistence = _ref.persistence, context = _ref.context, initialUserMessage = _ref.initialUserMessage, initialMessages = _ref.initialMessages, _ref_disableTriggerValidation = _ref.disableTriggerValidation, disableTriggerValidation = _ref_disableTriggerValidation === void 0 ? false : _ref_disableTriggerValidation, _ref_sendAutomaticallyWhen = _ref.sendAutomaticallyWhen, sendAutomaticallyWhen = _ref_sendAutomaticallyWhen === void 0 ? lastAssistantMessageIsCompleteWithToolCalls : _ref_sendAutomaticallyWhen, _ref_requiresSearch = _ref.requiresSearch, requiresSearch = _ref_requiresSearch === void 0 ? true : _ref_requiresSearch, options = _object_without_properties(_ref, [
                 "resume",
@@ -15081,7 +15081,7 @@
             var hasValidatedEntryPoints = false;
             var agentId = 'agentId' in options ? options.agentId : undefined;
             // Collected here rather than by the tool that searched: that tool renders
-            // nothing while display-results presents its records, and a record has to
+            // nothing while Grouped Results presents its records, and a record has to
             // outlive the render that produced it.
             var records = createChatRecordsStore();
             var collectRecords = function collectRecords() {
@@ -15113,28 +15113,6 @@
                 var _findSuggestionsPart;
                 return (_findSuggestionsPart = findSuggestionsPart(findLastAssistantMessage(messages))) === null || _findSuggestionsPart === void 0 ? void 0 : _findSuggestionsPart.data.suggestions;
             };
-            // "Still coming" has to be inferred: the turn is running and has no
-            // `data-suggestions` part yet. Expecting any at all needs evidence, or an
-            // agent that never sends them would sit under a placeholder forever.
-            var getSuggestionsStatus = function getSuggestionsStatus(messages) {
-                var _lastAssistantMessage_metadata;
-                var status = _chatInstance.status;
-                if (status !== 'submitted' && status !== 'streaming') {
-                    return 'idle';
-                }
-                var lastAssistantMessage = findLastAssistantMessage(messages);
-                if (findSuggestionsPart(lastAssistantMessage)) {
-                    return 'idle';
-                }
-                var declaresSuggestions = (lastAssistantMessage === null || lastAssistantMessage === void 0 ? void 0 : (_lastAssistantMessage_metadata = lastAssistantMessage.metadata) === null || _lastAssistantMessage_metadata === void 0 ? void 0 : _lastAssistantMessage_metadata.suggestionsEnabled) === true;
-                if (declaresSuggestions) {
-                    return 'loading';
-                }
-                var hasSuggestionsHistory = messages.some(function(message) {
-                    return message !== lastAssistantMessage && message.role === 'assistant' && Boolean(findSuggestionsPart(message));
-                });
-                return hasSuggestionsHistory ? 'loading' : 'idle';
-            };
             var setMessages = function setMessages(messagesParam) {
                 if (typeof messagesParam === 'function') {
                     messagesParam = messagesParam(_chatInstance.messages);
@@ -15230,7 +15208,7 @@
                 if ('agentId' in options && options.agentId) {
                     var _options_requestOptions, _options_requestOptions1;
                     if (!appId || !apiKey) {
-                        throw new Error(withUsage$q('Could not extract Algolia credentials from the search client.'));
+                        throw new Error(withUsage$r('Could not extract Algolia credentials from the search client.'));
                     }
                     var createApi = function createApi() {
                         var bypassCache = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : false;
@@ -15269,7 +15247,7 @@
                     });
                 }
                 if (!transport) {
-                    throw new Error(withUsage$q('You need to provide either an `agentId` or a `transport`.'));
+                    throw new Error(withUsage$r('You need to provide either an `agentId` or a `transport`.'));
                 }
                 var canRepairRestoredPendingToolParts = !resume;
                 var chat = new Chat(_object_spread_props(_object_spread({}, options), {
@@ -15459,7 +15437,7 @@
                     if (agentId && feedback) {
                         var _getAppIdAndApiKey = _sliced_to_array(getAppIdAndApiKey(initOptions.instantSearchInstance.client), 2), appId = _getAppIdAndApiKey[0], apiKey = _getAppIdAndApiKey[1];
                         if (!appId || !apiKey) {
-                            throw new Error(withUsage$q('Could not extract Algolia credentials from the search client.'));
+                            throw new Error(withUsage$r('Could not extract Algolia credentials from the search client.'));
                         }
                         feedbackAbortController = new AbortController();
                         _sendChatMessageFeedback = function _sendChatMessageFeedback(messageId, vote) {
@@ -15622,7 +15600,6 @@
                         '~isOpenStatePersistenceEnabled': normalizedPersistence.open,
                         setMessages: setMessages,
                         suggestions: getSuggestionsFromMessages(_chatInstance.messages),
-                        suggestionsStatus: getSuggestionsStatus(_chatInstance.messages),
                         clearMessages: clearMessages,
                         tools: toolsWithAddToolResult,
                         records: records,
@@ -16096,20 +16073,20 @@
         };
     }
 
-    var withUsage$p = createDocumentationMessageGenerator({
+    var withUsage$q = createDocumentationMessageGenerator({
         name: 'tasks',
         connector: true
     });
     var connectTasks = function connectTasks(renderFn) {
         var unmountFn = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : noop;
-        checkRendering(renderFn, withUsage$p());
+        checkRendering(renderFn, withUsage$q());
         return function(widgetParams) {
             var agentId = widgetParams.agentId, transport = widgetParams.transport, task = widgetParams.task, kind = widgetParams.kind, _widgetParams_stream = widgetParams.stream, stream = _widgetParams_stream === void 0 ? true : _widgetParams_stream;
             if (!agentId && !transport) {
-                throw new Error(withUsage$p('The `agentId` option is required unless a custom `transport` is provided.'));
+                throw new Error(withUsage$q('The `agentId` option is required unless a custom `transport` is provided.'));
             }
             if (!task && !kind) {
-                throw new Error(withUsage$p('Either the `task` or `kind` option is required.'));
+                throw new Error(withUsage$q('Either the `task` or `kind` option is required.'));
             }
             var runner;
             var output;
@@ -16183,7 +16160,7 @@
                     if (agentId) {
                         var _getAppIdAndApiKey = _sliced_to_array(getAppIdAndApiKey(instantSearchInstance.client), 2), appId = _getAppIdAndApiKey[0], apiKey = _getAppIdAndApiKey[1];
                         if (!appId || !apiKey) {
-                            throw new Error(withUsage$p('Could not extract Algolia credentials from the search client.'));
+                            throw new Error(withUsage$q('Could not extract Algolia credentials from the search client.'));
                         }
                         var taskTransport = createTaskTransport({
                             transport: transport,
@@ -16230,7 +16207,7 @@
         };
     };
 
-    var withUsage$o = createDocumentationMessageGenerator({
+    var withUsage$p = createDocumentationMessageGenerator({
         name: 'prompt-suggestions',
         connector: true
     });
@@ -16327,13 +16304,13 @@
     }
     var connectPromptSuggestions = function connectPromptSuggestions(renderFn) {
         var unmountFn = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : noop;
-        checkRendering(renderFn, withUsage$o());
+        checkRendering(renderFn, withUsage$p());
         return function(widgetParams) {
             var agentId = widgetParams.agentId, configurationId = widgetParams.configurationId, _widgetParams_transformHits = widgetParams.transformHits, transformHits = _widgetParams_transformHits === void 0 ? DEFAULT_TRANSFORM_HITS : _widgetParams_transformHits, context = widgetParams.context, _widgetParams_transformItems = widgetParams.transformItems, transformItems = _widgetParams_transformItems === void 0 ? function(items) {
                 return items;
             } : _widgetParams_transformItems, transport = widgetParams.transport;
             if (!agentId && !transport) {
-                throw new Error(withUsage$o('The `agentId` option is required unless a custom `transport` is provided.'));
+                throw new Error(withUsage$p('The `agentId` option is required unless a custom `transport` is provided.'));
             }
             var tasksState;
             var suggestions = [];
@@ -16613,7 +16590,7 @@
                     stream: true
                 };
             } else {
-                throw new Error(withUsage$o('The `agentId` option is required unless a custom `transport` is provided.'));
+                throw new Error(withUsage$p('The `agentId` option is required unless a custom `transport` is provided.'));
             }
             var tasksWidget = connectTasks(handleInnerRender, noop)(tasksParams);
             return {
@@ -16697,14 +16674,14 @@
         return useConnector(connectPromptSuggestions, props, additionalWidgetProperties);
     }
 
-    var withUsage$n = createDocumentationMessageGenerator({
+    var withUsage$o = createDocumentationMessageGenerator({
         name: 'chatTrigger',
         connector: true
     });
     // Reads the sibling chat widget's render state from the live cross-index
     // `instantSearchInstance.renderState` map. We resolve at call time so that
     // `toggleOpen` always sees the latest `open`/`setOpen` values.
-    function getChatRenderState(options) {
+    function getChatRenderState$1(options) {
         var _options_parent, _options_instantSearchInstance_renderState_indexId;
         var indexId = (_options_parent = options.parent) === null || _options_parent === void 0 ? void 0 : _options_parent.getIndexId();
         if (!indexId) return undefined;
@@ -16712,17 +16689,17 @@
     }
     var connectChatTrigger = function connectChatTrigger(renderFn) {
         var unmountFn = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : noop;
-        checkRendering(renderFn, withUsage$n());
+        checkRendering(renderFn, withUsage$o());
         return function(widgetParams) {
             var params = widgetParams !== null && widgetParams !== void 0 ? widgetParams : {};
             var lastOptions = null;
             function openChatFromTrigger(options) {
                 if (!lastOptions) return false;
-                return openChat(getChatRenderState(lastOptions), options);
+                return openChat(getChatRenderState$1(lastOptions), options);
             }
             function toggleOpen() {
                 if (!lastOptions) return;
-                var chatState = getChatRenderState(lastOptions);
+                var chatState = getChatRenderState$1(lastOptions);
                 if (!chatState) return;
                 if (chatState.open) {
                     var _chatState_setOpen;
@@ -16752,7 +16729,7 @@
                 },
                 getWidgetRenderState: function getWidgetRenderState(renderOptions) {
                     var _ref;
-                    var chatState = getChatRenderState(renderOptions);
+                    var chatState = getChatRenderState$1(renderOptions);
                     return {
                         open: (_ref = chatState === null || chatState === void 0 ? void 0 : chatState.open) !== null && _ref !== void 0 ? _ref : false,
                         toggleOpen: toggleOpen,
@@ -16778,6 +16755,235 @@
         return useConnector(connectChatTrigger, props, additionalWidgetProperties);
     }
 
+    var withUsage$n = createDocumentationMessageGenerator({
+        name: 'compare',
+        connector: true
+    });
+    /**
+     * Builds the placeholder message for a dashboard-configured comparison. The
+     * Agent Studio backend resolves it against the agent's comparison
+     * configuration: the LLM gets the configured instructions and the transcript
+     * keeps a natural-language message naming the selection.
+     */ function getComparisonPlaceholderMessage(configurationId) {
+        return "__ALGOLIA_COMPARISON_".concat(configurationId, "__");
+    }
+    /**
+     * Builds the default comparison message. It names each selected item so the
+     * agent can ground the comparison: it re-retrieves the records with
+     * `algolia_search_index` and renders them with the builtin
+     * `algolia_compare_products` tool. Works with the default shopping assistant
+     * prompt — no agent configuration required.
+     */ function getDefaultComparisonMessage(items) {
+        var labels = items.map(function(item) {
+            var _item_name;
+            var name = (_item_name = item.name) !== null && _item_name !== void 0 ? _item_name : item.title;
+            return typeof name === 'string' && name !== '' ? '"'.concat(name, '" (objectID: ').concat(item.objectID, ")") : 'the product with objectID "'.concat(item.objectID, '"');
+        });
+        return "Compare these products: ".concat(labels.join(' vs '));
+    }
+    // Turn-context payload for the comparison hand-off, per the Agent Studio
+    // contract: the selection rides `selected_products` (JSON-encoded records,
+    // `_`-prefixed internal metadata stripped) so the agent grounds the comparison
+    // in what the shopper actually selected, and `comparison_configuration_id`
+    // identifies the dashboard configuration when one is set.
+    function buildComparisonTurnContext(items, configurationId) {
+        var records = items.map(function(item) {
+            var clean = {};
+            Object.keys(item).forEach(function(key) {
+                if (!key.startsWith('_')) {
+                    clean[key] = item[key];
+                }
+            });
+            return clean;
+        });
+        return _object_spread({
+            selected_products: JSON.stringify(records)
+        }, configurationId ? {
+            comparison_configuration_id: configurationId
+        } : {});
+    }
+    // The selection is shared by every `compare` widget of the same InstantSearch
+    // instance (per-hit toggles, the compare bar, a picker modal, ...), so it
+    // lives in a store keyed by the instance rather than in any single widget.
+    var compareStores = new WeakMap();
+    function getCompareStore(instantSearchInstance) {
+        var store = compareStores.get(instantSearchInstance);
+        if (!store) {
+            store = {
+                items: [],
+                listeners: new Set()
+            };
+            compareStores.set(instantSearchInstance, store);
+        }
+        return store;
+    }
+    // Reads the sibling chat widget's render state from the live cross-index
+    // `instantSearchInstance.renderState` map. Resolved at call time so that
+    // `compare` always sees the latest `open`/`sendMessage` values.
+    function getChatRenderState(options) {
+        var _options_parent, _options_instantSearchInstance_renderState_indexId;
+        var indexId = (_options_parent = options.parent) === null || _options_parent === void 0 ? void 0 : _options_parent.getIndexId();
+        if (!indexId) return undefined;
+        return (_options_instantSearchInstance_renderState_indexId = options.instantSearchInstance.renderState[indexId]) === null || _options_instantSearchInstance_renderState_indexId === void 0 ? void 0 : _options_instantSearchInstance_renderState_indexId.chat;
+    }
+    /**
+     * Compare connector.
+     *
+     * Owns the "products selected for comparison" state and the hand-off into the
+     * chat: `compare()` opens the sibling `chat` widget and sends a comparison
+     * message naming the selected records, which the agent answers with the
+     * grounded `algolia_compare_products` table.
+     *
+     * The selection is shared across all `compare` widgets mounted on the same
+     * InstantSearch instance, so per-hit "Compare" toggles and the `compareBar`
+     * widget stay in sync. The widget is marked with `opensChat`, so it satisfies
+     * the `chat` widget's entry-point validation.
+     */ var connectCompare = function connectCompare(renderFn) {
+        var unmountFn = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : noop;
+        checkRendering(renderFn, withUsage$n());
+        return function(widgetParams) {
+            var _ref = widgetParams || {}, _ref_minItems = _ref.minItems, minItems = _ref_minItems === void 0 ? 2 : _ref_minItems, _ref_maxItems = _ref.maxItems, maxItems = _ref_maxItems === void 0 ? 3 : _ref_maxItems, configurationId = _ref.configurationId, _ref_getComparisonMessage = _ref.getComparisonMessage, getComparisonMessage = _ref_getComparisonMessage === void 0 ? configurationId ? function() {
+                return getComparisonPlaceholderMessage(configurationId);
+            } : getDefaultComparisonMessage : _ref_getComparisonMessage;
+            if (minItems < 2) {
+                throw new Error(withUsage$n('The `minItems` option must be at least 2.'));
+            }
+            if (maxItems < minItems) {
+                throw new Error(withUsage$n('The `maxItems` option must be greater than `minItems`.'));
+            }
+            var lastOptions = null;
+            var unsubscribe = null;
+            function getStore() {
+                if (!lastOptions) return null;
+                return getCompareStore(lastOptions.instantSearchInstance);
+            }
+            // Re-renders every subscribed `compare` widget, then schedules a full
+            // render so anything else reading `renderState.compare` catches up.
+            function notify(store) {
+                store.listeners.forEach(function(listener) {
+                    return listener();
+                });
+                lastOptions === null || lastOptions === void 0 ? void 0 : lastOptions.instantSearchInstance.scheduleRender();
+            }
+            function isSelected(objectID) {
+                var store = getStore();
+                return Boolean(store === null || store === void 0 ? void 0 : store.items.some(function(item) {
+                    return item.objectID === objectID;
+                }));
+            }
+            function addItem(item) {
+                var store = getStore();
+                if (!store || store.items.length >= maxItems || isSelected(item.objectID)) {
+                    return;
+                }
+                store.items = _to_consumable_array(store.items).concat([
+                    item
+                ]);
+                notify(store);
+            }
+            function removeItem(objectID) {
+                var store = getStore();
+                if (!store || !isSelected(objectID)) return;
+                store.items = store.items.filter(function(item) {
+                    return item.objectID !== objectID;
+                });
+                notify(store);
+            }
+            function toggleItem(item) {
+                if (isSelected(item.objectID)) {
+                    removeItem(item.objectID);
+                } else {
+                    addItem(item);
+                }
+            }
+            function clearItems() {
+                var store = getStore();
+                if (!store || store.items.length === 0) return;
+                store.items = [];
+                notify(store);
+            }
+            function compare() {
+                var store = getStore();
+                if (!store || !lastOptions || store.items.length < minItems) {
+                    return false;
+                }
+                return openChat(getChatRenderState(lastOptions), {
+                    message: getComparisonMessage(store.items),
+                    referer: 'compare',
+                    turnContext: buildComparisonTurnContext(store.items, configurationId)
+                });
+            }
+            return {
+                $$type: 'ais.compare',
+                opensChat: true,
+                init: function init(initOptions) {
+                    var _this = this;
+                    lastOptions = initOptions;
+                    var store = getCompareStore(initOptions.instantSearchInstance);
+                    var listener = function listener() {
+                        if (!lastOptions) return;
+                        renderFn(_object_spread_props(_object_spread({}, _this.getWidgetRenderState(lastOptions)), {
+                            instantSearchInstance: lastOptions.instantSearchInstance
+                        }), false);
+                    };
+                    store.listeners.add(listener);
+                    unsubscribe = function unsubscribe() {
+                        return store.listeners.delete(listener);
+                    };
+                    renderFn(_object_spread_props(_object_spread({}, this.getWidgetRenderState(initOptions)), {
+                        instantSearchInstance: initOptions.instantSearchInstance
+                    }), true);
+                },
+                render: function render(renderOptions) {
+                    lastOptions = renderOptions;
+                    renderFn(_object_spread_props(_object_spread({}, this.getWidgetRenderState(renderOptions)), {
+                        instantSearchInstance: renderOptions.instantSearchInstance
+                    }), false);
+                },
+                dispose: function dispose() {
+                    unsubscribe === null || unsubscribe === void 0 ? void 0 : unsubscribe();
+                    unsubscribe = null;
+                    unmountFn();
+                },
+                getWidgetRenderState: function getWidgetRenderState(renderOptions) {
+                    lastOptions = renderOptions;
+                    var store = getCompareStore(renderOptions.instantSearchInstance);
+                    return {
+                        items: store.items,
+                        isSelected: isSelected,
+                        addItem: addItem,
+                        removeItem: removeItem,
+                        toggleItem: toggleItem,
+                        clearItems: clearItems,
+                        canAddItems: store.items.length < maxItems,
+                        canCompare: store.items.length >= minItems,
+                        minItems: minItems,
+                        maxItems: maxItems,
+                        compare: compare,
+                        widgetParams: widgetParams || {}
+                    };
+                },
+                getRenderState: function getRenderState(renderState, renderOptions) {
+                    return _object_spread_props(_object_spread({}, renderState), {
+                        compare: this.getWidgetRenderState(renderOptions)
+                    });
+                }
+            };
+        };
+    };
+
+    /**
+     * Exposes the shared comparison selection and the chat hand-off.
+     *
+     * The selection is shared by every `useCompare` call on the same InstantSearch
+     * instance, so a per-hit "Compare" toggle (`toggleItem`) and the `<CompareBar>`
+     * widget stay in sync. `compare()` opens the `<Chat>` widget and sends the
+     * comparison message for the current selection.
+     */ function useCompare() {
+        var props = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : {}, additionalWidgetProperties = arguments.length > 1 ? arguments[1] : void 0;
+        return useConnector(connectCompare, props, additionalWidgetProperties);
+    }
+
     var withUsage$m = createDocumentationMessageGenerator({
         name: 'clear-refinements',
         connector: true
@@ -20926,6 +21132,7 @@
     exports.useChat = useChat;
     exports.useChatTrigger = useChatTrigger;
     exports.useClearRefinements = useClearRefinements;
+    exports.useCompare = useCompare;
     exports.useConfigure = useConfigure;
     exports.useConnector = useConnector;
     exports.useCurrentRefinements = useCurrentRefinements;