react-instantsearch-core 7.29.0 → 7.30.0

package/dist/umd/ReactInstantSearchCore.js

@@ -1,4 +1,4 @@
-/*! React InstantSearch Core 7.29.0 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch */
+/*! React InstantSearch Core 7.30.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.29.0';
+    var version$2 = '7.30.0';
 
     function _define_property(obj, key, value) {
         if (key in obj) {
@@ -5938,7 +5938,7 @@
         }
     }
 
-    var withUsage$s = createDocumentationMessageGenerator({
+    var withUsage$t = createDocumentationMessageGenerator({
         name: 'configure',
         connector: true
     });
@@ -5954,7 +5954,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$s('The `searchParameters` option expects an object.'));
+                throw new Error(withUsage$t('The `searchParameters` option expects an object.'));
             }
             var connectorState = {};
             function refine(helper) {
@@ -6535,13 +6535,13 @@
         }
     }
 
-    var withUsage$r = createDocumentationMessageGenerator({
+    var withUsage$s = 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$r());
+        checkRendering(renderFn, withUsage$s());
         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 ? [
                 '*'
@@ -6551,10 +6551,10 @@
             if (!(widgets && Array.isArray(widgets) && widgets.every(function(widget) {
                 return (typeof widget === "undefined" ? "undefined" : _type_of(widget)) === 'object';
             }))) {
-                throw new Error(withUsage$r('The `widgets` option expects an array of widgets.'));
+                throw new Error(withUsage$s('The `widgets` option expects an array of widgets.'));
             }
             if (!Array.isArray(facets)) {
-                throw new Error(withUsage$r("The `facets` option only accepts an array of facets, you passed ".concat(JSON.stringify(facets))));
+                throw new Error(withUsage$s("The `facets` option only accepts an array of facets, you passed ".concat(JSON.stringify(facets))));
             }
             var localWidgets = new Map();
             return {
@@ -6656,7 +6656,7 @@
                         results: results
                     });
                     if (!Array.isArray(attributesToRender)) {
-                        throw new Error(withUsage$r('The `transformItems` option expects a function that returns an Array.'));
+                        throw new Error(withUsage$s('The `transformItems` option expects a function that returns an Array.'));
                     }
                     return {
                         attributesToRender: attributesToRender,
@@ -6838,7 +6838,7 @@
         };
     }
 
-    var withUsage$q = createDocumentationMessageGenerator({
+    var withUsage$r = createDocumentationMessageGenerator({
         name: 'index-widget'
     });
     /**
@@ -6932,7 +6932,7 @@
     }
     var index = function index(widgetParams) {
         if (widgetParams === undefined || widgetParams.indexName === undefined && !widgetParams.EXPERIMENTAL_isolated) {
-            throw new Error(withUsage$q('The `indexName` option is required.'));
+            throw new Error(withUsage$r('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.
@@ -7022,7 +7022,7 @@
             addWidgets: function addWidgets(widgets) {
                 var _this = this;
                 if (!Array.isArray(widgets)) {
-                    throw new Error(withUsage$q('The `addWidgets` method expects an array of widgets.'));
+                    throw new Error(withUsage$r('The `addWidgets` method expects an array of widgets.'));
                 }
                 var flatWidgets = widgets.reduce(function(acc, w) {
                     return acc.concat(Array.isArray(w) ? w : [
@@ -7032,7 +7032,7 @@
                 if (flatWidgets.some(function(widget) {
                     return typeof widget.init !== 'function' && typeof widget.render !== 'function';
                 })) {
-                    throw new Error(withUsage$q('The widget definition expects a `render` and/or an `init` method.'));
+                    throw new Error(withUsage$r('The widget definition expects a `render` and/or an `init` method.'));
                 }
                 flatWidgets.forEach(function(widget) {
                     widget.parent = _this;
@@ -7092,7 +7092,7 @@
             removeWidgets: function removeWidgets(widgets) {
                 var _this = this;
                 if (!Array.isArray(widgets)) {
-                    throw new Error(withUsage$q('The `removeWidgets` method expects an array of widgets.'));
+                    throw new Error(withUsage$r('The `removeWidgets` method expects an array of widgets.'));
                 }
                 var flatWidgets = widgets.reduce(function(acc, w) {
                     return acc.concat(Array.isArray(w) ? w : [
@@ -7102,7 +7102,7 @@
                 if (flatWidgets.some(function(widget) {
                     return typeof widget.dispose !== 'function';
                 })) {
-                    throw new Error(withUsage$q('The widget definition expects a `dispose` method.'));
+                    throw new Error(withUsage$r('The widget definition expects a `dispose` method.'));
                 }
                 localWidgets = localWidgets.filter(function(widget) {
                     return flatWidgets.indexOf(widget) === -1;
@@ -9721,7 +9721,7 @@
         };
     }
 
-    var version = '4.93.0';
+    var version = '4.94.0';
 
     function hydrateSearchClient(client, results) {
         if (!results) {
@@ -9856,7 +9856,7 @@
         });
     }
 
-    var withUsage$p = createDocumentationMessageGenerator({
+    var withUsage$q = createDocumentationMessageGenerator({
         name: 'instantsearch'
     });
     function defaultCreateURL() {
@@ -9912,7 +9912,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$p('The `searchClient` option is required.'));
+                throw new Error(withUsage$q('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/");
@@ -9921,7 +9921,7 @@
                 searchClient.addAlgoliaAgent("instantsearch.js (".concat(version, ")"));
             }
             if (insightsClient && typeof insightsClient !== 'function') {
-                throw new Error(withUsage$p('The `insightsClient` option should be a function.'));
+                throw new Error(withUsage$q('The `insightsClient` option should be a function.'));
             }
             _this.client = searchClient;
             _this.future = future;
@@ -10069,12 +10069,12 @@
        * @param widgets The array of widgets to add to InstantSearch.
        */ function addWidgets(widgets) {
                     if (!Array.isArray(widgets)) {
-                        throw new Error(withUsage$p('The `addWidgets` method expects an array of widgets. Please use `addWidget`.'));
+                        throw new Error(withUsage$q('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$p('The `index` widget cannot be used with a composition-based InstantSearch implementation.'));
+                        throw new Error(withUsage$q('The `index` widget cannot be used with a composition-based InstantSearch implementation.'));
                     }
                     this.mainIndex.addWidgets(widgets);
                     return this;
@@ -10103,7 +10103,7 @@
        * The widgets must implement a `dispose()` method to clear their states.
        */ function removeWidgets(widgets) {
                     if (!Array.isArray(widgets)) {
-                        throw new Error(withUsage$p('The `removeWidgets` method expects an array of widgets. Please use `removeWidget`.'));
+                        throw new Error(withUsage$q('The `removeWidgets` method expects an array of widgets. Please use `removeWidget`.'));
                     }
                     this.mainIndex.removeWidgets(widgets);
                     return this;
@@ -10117,7 +10117,7 @@
        */ function start() {
                     var _this = this;
                     if (this.started) {
-                        throw new Error(withUsage$p('The `start` method has already been called once.'));
+                        throw new Error(withUsage$q('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
@@ -10319,7 +10319,7 @@
                     var _this = this;
                     var callOnStateChange = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : true;
                     if (!this.mainHelper) {
-                        throw new Error(withUsage$p('The `start` method needs to be called before `setUiState`.'));
+                        throw new Error(withUsage$q('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`.
@@ -10356,7 +10356,7 @@
                 value: function createURL() {
                     var nextState = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : {};
                     if (!this.started) {
-                        throw new Error(withUsage$p('The `start` method needs to be called before `createURL`.'));
+                        throw new Error(withUsage$q('The `start` method needs to be called before `createURL`.'));
                     }
                     return this._createURL(nextState);
                 }
@@ -10365,7 +10365,7 @@
                 key: "refresh",
                 value: function refresh() {
                     if (!this.mainHelper) {
-                        throw new Error(withUsage$p('The `start` method needs to be called before `refresh`.'));
+                        throw new Error(withUsage$q('The `start` method needs to be called before `refresh`.'));
                     }
                     this.mainHelper.clearCache().search();
                 }
@@ -11046,17 +11046,17 @@
         return bindEventForHits;
     }
 
-    var withUsage$o = createDocumentationMessageGenerator({
+    var withUsage$p = 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$o());
+        checkRendering(renderFn, withUsage$p());
         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;
-            } : _ref_transformItems;
+            } : _ref_transformItems, tmp = _ref.future, _ref1 = tmp === void 0 ? {} : tmp, _ref_undefinedEmptyQuery = _ref1.undefinedEmptyQuery, undefinedEmptyQuery = _ref_undefinedEmptyQuery === void 0 ? false : _ref_undefinedEmptyQuery;
             var connectorState = {};
             return {
                 $$type: 'ais.autocomplete',
@@ -11111,7 +11111,7 @@
                         };
                     });
                     return {
-                        currentRefinement: state.query || '',
+                        currentRefinement: undefinedEmptyQuery ? state.query : state.query || '',
                         indices: transformItems(indices).map(function(transformedIndex) {
                             return _object_spread_props(_object_spread({}, transformedIndex), {
                                 sendEvent: sendEventMap[transformedIndex.indexId]
@@ -11123,8 +11123,8 @@
                 },
                 getWidgetUiState: function getWidgetUiState(uiState, param) {
                     var searchParameters = param.searchParameters;
-                    var query = searchParameters.query || '';
-                    if (query === '' || uiState && uiState.query === query) {
+                    var query = undefinedEmptyQuery ? searchParameters.query : searchParameters.query || '';
+                    if (!query || query === '' || uiState && uiState.query === query) {
                         return uiState;
                     }
                     return _object_spread_props(_object_spread({}, uiState), {
@@ -11134,7 +11134,7 @@
                 getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, param) {
                     var uiState = param.uiState;
                     var parameters = {
-                        query: uiState.query || ''
+                        query: undefinedEmptyQuery ? uiState.query : uiState.query || ''
                     };
                     if (!escapeHTML) {
                         return searchParameters.setQueryParameters(parameters);
@@ -11160,20 +11160,20 @@
         return useConnector(connectAutocomplete, props, additionalWidgetProperties);
     }
 
-    var withUsage$n = createDocumentationMessageGenerator({
+    var withUsage$o = 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$n());
+        checkRendering(renderFn, withUsage$o());
         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$n('The `attributes` option expects an array of strings.'));
+                throw new Error(withUsage$o('The `attributes` option expects an array of strings.'));
             }
             var _attributes = _sliced_to_array(attributes, 1), hierarchicalFacetName = _attributes[0];
             function getRefinedState(state, facetValue) {
@@ -12806,7 +12806,7 @@
         return refinements;
     }
 
-    var withUsage$m = createDocumentationMessageGenerator({
+    var withUsage$n = createDocumentationMessageGenerator({
         name: 'chat',
         connector: true
     });
@@ -12857,12 +12857,14 @@
     }
     var connectChat = function connectChat(renderFn) {
         var unmountFn = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : noop;
-        checkRendering(renderFn, withUsage$m());
+        checkRendering(renderFn, withUsage$n());
         return function(widgetParams) {
-            var _ref = widgetParams || {}, _ref_resume = _ref.resume, resume = _ref_resume === void 0 ? false : _ref_resume, _ref_tools = _ref.tools, tools = _ref_tools === void 0 ? {} : _ref_tools, _ref_type = _ref.type, type = _ref_type === void 0 ? 'chat' : _ref_type, options = _object_without_properties(_ref, [
+            var _ref = widgetParams || {}, _ref_resume = _ref.resume, resume = _ref_resume === void 0 ? false : _ref_resume, _ref_tools = _ref.tools, tools = _ref_tools === void 0 ? {} : _ref_tools, _ref_type = _ref.type, type = _ref_type === void 0 ? 'chat' : _ref_type, context = _ref.context, initialUserMessage = _ref.initialUserMessage, options = _object_without_properties(_ref, [
                 "resume",
                 "tools",
-                "type"
+                "type",
+                "context",
+                "initialUserMessage"
             ]);
             var _chatInstance;
             var input = '';
@@ -12904,6 +12906,10 @@
                 if (!_chatInstance.messages || _chatInstance.messages.length === 0) {
                     return;
                 }
+                var status = _chatInstance.status;
+                if (status === 'submitted' || status === 'streaming') {
+                    _chatInstance.stop();
+                }
                 setIsClearing(true);
             };
             var onClearTransitionEnd = function onClearTransitionEnd() {
@@ -12953,7 +12959,7 @@
                 }
                 if ('agentId' in options && options.agentId) {
                     if (!appId || !apiKey) {
-                        throw new Error(withUsage$m('Could not extract Algolia credentials from the search client.'));
+                        throw new Error(withUsage$n('Could not extract Algolia credentials from the search client.'));
                     }
                     var baseApi = "https://".concat(appId, ".algolia.net/agent-studio/1/agents/").concat(agentId, "/completions?compatibilityMode=ai-sdk-5");
                     transport = new DefaultChatTransport({
@@ -12979,7 +12985,7 @@
                     });
                 }
                 if (!transport) {
-                    throw new Error(withUsage$m('You need to provide either an `agentId` or a `transport`.'));
+                    throw new Error(withUsage$n('You need to provide either an `agentId` or a `transport`.'));
                 }
                 if ('chat' in options) {
                     return options.chat;
@@ -13052,7 +13058,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$m('Could not extract Algolia credentials from the search client.'));
+                            throw new Error(withUsage$n('Could not extract Algolia credentials from the search client.'));
                         }
                         feedbackAbortController = new AbortController();
                         _sendChatMessageFeedback = function _sendChatMessageFeedback(messageId, vote) {
@@ -13077,6 +13083,11 @@
                     if (resume) {
                         _chatInstance.resumeStream();
                     }
+                    if (initialUserMessage && !resume && _chatInstance.messages.length === 0) {
+                        _chatInstance.sendMessage({
+                            text: initialUserMessage
+                        });
+                    }
                     renderFn(_object_spread_props(_object_spread({}, this.getWidgetRenderState(initOptions)), {
                         instantSearchInstance: instantSearchInstance
                     }), true);
@@ -13112,10 +13123,65 @@
                         var _param = _sliced_to_array(param, 2), key = _param[0], tool = _param[1];
                         var toolWithAddToolResult = _object_spread_props(_object_spread({}, tool), {
                             addToolResult: _chatInstance.addToolResult,
-                            applyFilters: applyFilters
+                            applyFilters: applyFilters,
+                            sendEvent: sendEvent
                         });
                         toolsWithAddToolResult[key] = toolWithAddToolResult;
                     });
+                    var sendMessageWithContext = function sendMessageWithContext(message) {
+                        for(var _len = arguments.length, rest = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++){
+                            rest[_key - 1] = arguments[_key];
+                        }
+                        var _chatInstance1;
+                        if (!context || !message) {
+                            var _chatInstance2;
+                            return (_chatInstance2 = _chatInstance).sendMessage.apply(_chatInstance2, [
+                                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 : '';
+                        return (_chatInstance1 = _chatInstance).sendMessage.apply(_chatInstance1, [
+                            {
+                                parts: [
+                                    contextTextPart,
+                                    {
+                                        type: 'text',
+                                        text: textContent
+                                    }
+                                ],
+                                metadata: message.metadata,
+                                messageId: message.messageId,
+                                files: undefined,
+                                text: undefined
+                            }
+                        ].concat(_to_consumable_array(rest)));
+                    };
                     return {
                         indexUiState: instantSearchInstance.getUiState()[parent.getIndexId()],
                         input: input,
@@ -13142,7 +13208,7 @@
                         messages: _chatInstance.messages,
                         regenerate: _chatInstance.regenerate,
                         resumeStream: _chatInstance.resumeStream,
-                        sendMessage: _chatInstance.sendMessage,
+                        sendMessage: sendMessageWithContext,
                         status: _chatInstance.status,
                         stop: _chatInstance.stop
                     };
@@ -13165,13 +13231,13 @@
         return useConnector(connectChat, props, additionalWidgetProperties);
     }
 
-    var withUsage$l = createDocumentationMessageGenerator({
+    var withUsage$m = createDocumentationMessageGenerator({
         name: 'clear-refinements',
         connector: true
     });
     var connectClearRefinements = function connectClearRefinements(renderFn) {
         var unmountFn = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : noop;
-        checkRendering(renderFn, withUsage$l());
+        checkRendering(renderFn, withUsage$m());
         return function(widgetParams) {
             var _ref = widgetParams || {}, _ref_includedAttributes = _ref.includedAttributes, includedAttributes = _ref_includedAttributes === void 0 ? [] : _ref_includedAttributes, _ref_excludedAttributes = _ref.excludedAttributes, excludedAttributes = _ref_excludedAttributes === void 0 ? [
                 'query'
@@ -13179,7 +13245,7 @@
                 return items;
             } : _ref_transformItems;
             if (widgetParams && widgetParams.includedAttributes && widgetParams.excludedAttributes) {
-                throw new Error(withUsage$l('The options `includedAttributes` and `excludedAttributes` cannot be used together.'));
+                throw new Error(withUsage$m('The options `includedAttributes` and `excludedAttributes` cannot be used together.'));
             }
             var connectorState = {
                 refine: noop,
@@ -13282,16 +13348,16 @@
         return useConnector(connectClearRefinements, props, additionalWidgetProperties);
     }
 
-    var withUsage$k = createDocumentationMessageGenerator({
+    var withUsage$l = createDocumentationMessageGenerator({
         name: 'current-refinements',
         connector: true
     });
     var connectCurrentRefinements = function connectCurrentRefinements(renderFn) {
         var unmountFn = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : noop;
-        checkRendering(renderFn, withUsage$k());
+        checkRendering(renderFn, withUsage$l());
         return function(widgetParams) {
             if ((widgetParams || {}).includedAttributes && (widgetParams || {}).excludedAttributes) {
-                throw new Error(withUsage$k('The options `includedAttributes` and `excludedAttributes` cannot be used together.'));
+                throw new Error(withUsage$l('The options `includedAttributes` and `excludedAttributes` cannot be used together.'));
             }
             var _ref = widgetParams || {}, includedAttributes = _ref.includedAttributes, _ref_excludedAttributes = _ref.excludedAttributes, excludedAttributes = _ref_excludedAttributes === void 0 ? [
                 'query'
@@ -13480,19 +13546,19 @@
         });
     }
 
-    var withUsage$j = createDocumentationMessageGenerator({
+    var withUsage$k = createDocumentationMessageGenerator({
         name: 'frequently-bought-together',
         connector: true
     });
     var connectFrequentlyBoughtTogether = function connectFrequentlyBoughtTogether(renderFn) {
         var unmountFn = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : noop;
-        checkRendering(renderFn, withUsage$j());
+        checkRendering(renderFn, withUsage$k());
         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(items) {
                 return items;
             } : _ref_transformItems, objectIDs = _ref.objectIDs, limit = _ref.limit, threshold = _ref.threshold, fallbackParameters = _ref.fallbackParameters, queryParameters = _ref.queryParameters;
             if (!objectIDs || objectIDs.length === 0) {
-                throw new Error(withUsage$j('The `objectIDs` option is required.'));
+                throw new Error(withUsage$k('The `objectIDs` option is required.'));
             }
             var sendEvent;
             return {
@@ -13630,7 +13696,7 @@
         return insideBoundingBoxStringToBoundingBox(value);
     }
 
-    var withUsage$i = createDocumentationMessageGenerator({
+    var withUsage$j = createDocumentationMessageGenerator({
         name: 'geo-search',
         connector: true
     });
@@ -13654,7 +13720,7 @@
      * Currently, the feature is not compatible with multiple values in the _geoloc attribute.
      */ var connectGeoSearch = function connectGeoSearch(renderFn) {
         var unmountFn = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : noop;
-        checkRendering(renderFn, withUsage$i());
+        checkRendering(renderFn, withUsage$j());
         return function(widgetParams) {
             var _ref = widgetParams || {}, _ref_enableRefineOnMapMove = _ref.enableRefineOnMapMove, enableRefineOnMapMove = _ref_enableRefineOnMapMove === void 0 ? true : _ref_enableRefineOnMapMove, _ref_transformItems = _ref.transformItems, transformItems = _ref_transformItems === void 0 ? function(items) {
                 return items;
@@ -13872,7 +13938,7 @@
         return sendEventForFacet;
     }
 
-    var withUsage$h = createDocumentationMessageGenerator({
+    var withUsage$i = createDocumentationMessageGenerator({
         name: 'hierarchical-menu',
         connector: true
     });
@@ -13893,16 +13959,16 @@
      * @return {function(CustomHierarchicalMenuWidgetParams)} Re-usable widget factory for a custom **HierarchicalMenu** widget.
      */ var connectHierarchicalMenu = function connectHierarchicalMenu(renderFn) {
         var unmountFn = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : noop;
-        checkRendering(renderFn, withUsage$h());
+        checkRendering(renderFn, withUsage$i());
         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_showParentLevel = _ref.showParentLevel, showParentLevel = _ref_showParentLevel === void 0 ? true : _ref_showParentLevel, _ref_limit = _ref.limit, limit = _ref_limit === void 0 ? 10 : _ref_limit, _ref_showMore = _ref.showMore, showMore = _ref_showMore === void 0 ? false : _ref_showMore, _ref_showMoreLimit = _ref.showMoreLimit, showMoreLimit = _ref_showMoreLimit === void 0 ? 20 : _ref_showMoreLimit, _ref_sortBy = _ref.sortBy, sortBy = _ref_sortBy === void 0 ? DEFAULT_SORT$2 : _ref_sortBy, _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$h('The `attributes` option expects an array of strings.'));
+                throw new Error(withUsage$i('The `attributes` option expects an array of strings.'));
             }
             if (showMore === true && showMoreLimit <= limit) {
-                throw new Error(withUsage$h('The `showMoreLimit` option must be greater than `limit`.'));
+                throw new Error(withUsage$i('The `showMoreLimit` option must be greater than `limit`.'));
             }
             // we need to provide a hierarchicalFacet name for the search state
             // so that we can always map $hierarchicalFacetName => real attributes
@@ -14094,13 +14160,13 @@
         return useConnector(connectHierarchicalMenu, props, additionalWidgetProperties);
     }
 
-    var withUsage$g = createDocumentationMessageGenerator({
+    var withUsage$h = createDocumentationMessageGenerator({
         name: 'hits',
         connector: true
     });
     var connectHits = function connectHits(renderFn) {
         var unmountFn = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : noop;
-        checkRendering(renderFn, withUsage$g());
+        checkRendering(renderFn, withUsage$h());
         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(items) {
                 return items;
@@ -14198,29 +14264,29 @@
         return useConnector(connectHits, props, additionalWidgetProperties);
     }
 
-    var withUsage$f = createDocumentationMessageGenerator({
+    var withUsage$g = createDocumentationMessageGenerator({
         name: 'hits-per-page',
         connector: true
     });
     var connectHitsPerPage = function connectHitsPerPage(renderFn) {
         var unmountFn = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : noop;
-        checkRendering(renderFn, withUsage$f());
+        checkRendering(renderFn, withUsage$g());
         return function(widgetParams) {
             var _ref = widgetParams || {}, userItems = _ref.items, _ref_transformItems = _ref.transformItems, transformItems = _ref_transformItems === void 0 ? function(items) {
                 return items;
             } : _ref_transformItems;
             if (!Array.isArray(userItems)) {
-                throw new Error(withUsage$f('The `items` option expects an array of objects.'));
+                throw new Error(withUsage$g('The `items` option expects an array of objects.'));
             }
             var items = userItems;
             var defaultItems = items.filter(function(item) {
                 return item.default === true;
             });
             if (defaultItems.length === 0) {
-                throw new Error(withUsage$f("A default value must be specified in `items`."));
+                throw new Error(withUsage$g("A default value must be specified in `items`."));
             }
             if (defaultItems.length > 1) {
-                throw new Error(withUsage$f('More than one default value is specified in `items`.'));
+                throw new Error(withUsage$g('More than one default value is specified in `items`.'));
             }
             var defaultItem = defaultItems[0];
             var normalizeItems = function normalizeItems(param) {
@@ -14339,7 +14405,7 @@
         });
     }
 
-    var withUsage$e = createDocumentationMessageGenerator({
+    var withUsage$f = createDocumentationMessageGenerator({
         name: 'infinite-hits',
         connector: true
     });
@@ -14385,7 +14451,7 @@
     }
     var connectInfiniteHits = function connectInfiniteHits(renderFn) {
         var unmountFn = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : noop;
-        checkRendering(renderFn, withUsage$e());
+        checkRendering(renderFn, withUsage$f());
         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(items) {
                 return items;
@@ -14591,7 +14657,7 @@
         return useConnector(connectInfiniteHits, props, additionalWidgetProperties);
     }
 
-    var withUsage$d = createDocumentationMessageGenerator({
+    var withUsage$e = createDocumentationMessageGenerator({
         name: 'menu',
         connector: true
     });
@@ -14609,16 +14675,16 @@
      * **Requirement:** the attribute passed as `attribute` must be present in "attributes for faceting" on the Algolia dashboard or configured as attributesForFaceting via a set settings call to the Algolia API.
      */ var connectMenu = function connectMenu(renderFn) {
         var unmountFn = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : noop;
-        checkRendering(renderFn, withUsage$d());
+        checkRendering(renderFn, withUsage$e());
         return function(widgetParams) {
             var _ref = widgetParams || {}, attribute = _ref.attribute, _ref_limit = _ref.limit, limit = _ref_limit === void 0 ? 10 : _ref_limit, _ref_showMore = _ref.showMore, showMore = _ref_showMore === void 0 ? false : _ref_showMore, _ref_showMoreLimit = _ref.showMoreLimit, showMoreLimit = _ref_showMoreLimit === void 0 ? 20 : _ref_showMoreLimit, _ref_sortBy = _ref.sortBy, sortBy = _ref_sortBy === void 0 ? DEFAULT_SORT$1 : _ref_sortBy, _ref_transformItems = _ref.transformItems, transformItems = _ref_transformItems === void 0 ? function(items) {
                 return items;
             } : _ref_transformItems;
             if (!attribute) {
-                throw new Error(withUsage$d('The `attribute` option is required.'));
+                throw new Error(withUsage$e('The `attribute` option is required.'));
             }
             if (showMore === true && showMoreLimit <= limit) {
-                throw new Error(withUsage$d('The `showMoreLimit` option must be greater than `limit`.'));
+                throw new Error(withUsage$e('The `showMoreLimit` option must be greater than `limit`.'));
             }
             var sendEvent;
             var _createURL;
@@ -14788,7 +14854,7 @@
         return typeof value === 'number' && isFinite(value);
     }
 
-    var withUsage$c = createDocumentationMessageGenerator({
+    var withUsage$d = createDocumentationMessageGenerator({
         name: 'numeric-menu',
         connector: true
     });
@@ -14807,16 +14873,16 @@
     };
     var connectNumericMenu = function connectNumericMenu(renderFn) {
         var unmountFn = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : noop;
-        checkRendering(renderFn, withUsage$c());
+        checkRendering(renderFn, withUsage$d());
         return function(widgetParams) {
             var _ref = widgetParams || {}, _ref_attribute = _ref.attribute, attribute = _ref_attribute === void 0 ? '' : _ref_attribute, _ref_items = _ref.items, items = _ref_items === void 0 ? [] : _ref_items, _ref_transformItems = _ref.transformItems, transformItems = _ref_transformItems === void 0 ? function(item) {
                 return item;
             } : _ref_transformItems;
             if (attribute === '') {
-                throw new Error(withUsage$c('The `attribute` option is required.'));
+                throw new Error(withUsage$d('The `attribute` option is required.'));
             }
             if (!items || items.length === 0) {
-                throw new Error(withUsage$c('The `items` option expects an array of objects.'));
+                throw new Error(withUsage$d('The `items` option expects an array of objects.'));
             }
             var prepareItems = function prepareItems(state) {
                 return items.map(function(param) {
@@ -15131,7 +15197,7 @@
         return Paginator;
     }();
 
-    var withUsage$b = createDocumentationMessageGenerator({
+    var withUsage$c = createDocumentationMessageGenerator({
         name: 'pagination',
         connector: true
     });
@@ -15143,7 +15209,7 @@
      * beyond the 1000th hits by default. You can find more information on the [Algolia documentation](https://www.algolia.com/doc/guides/searching/pagination/#pagination-limitations).
      */ var connectPagination = function connectPagination(renderFn) {
         var unmountFn = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : noop;
-        checkRendering(renderFn, withUsage$b());
+        checkRendering(renderFn, withUsage$c());
         return function(widgetParams) {
             var _ref = widgetParams || {}, totalPages = _ref.totalPages, _ref_padding = _ref.padding, padding = _ref_padding === void 0 ? 3 : _ref_padding;
             var pager = new Paginator({
@@ -15260,7 +15326,7 @@
         };
     }
 
-    var withUsage$a = createDocumentationMessageGenerator({
+    var withUsage$b = createDocumentationMessageGenerator({
         name: 'query-rules',
         connector: true
     });
@@ -15316,7 +15382,7 @@
     }
     var connectQueryRules = function connectQueryRules(render) {
         var unmount = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : noop;
-        checkRendering(render, withUsage$a());
+        checkRendering(render, withUsage$b());
         return function(widgetParams) {
             var _ref = widgetParams || {}, _ref_trackedFilters = _ref.trackedFilters, trackedFilters = _ref_trackedFilters === void 0 ? {} : _ref_trackedFilters, _ref_transformRuleContexts = _ref.transformRuleContexts, transformRuleContexts = _ref_transformRuleContexts === void 0 ? function(rules) {
                 return rules;
@@ -15325,7 +15391,7 @@
             } : _ref_transformItems;
             Object.keys(trackedFilters).forEach(function(facetName) {
                 if (typeof trackedFilters[facetName] !== 'function') {
-                    throw new Error(withUsage$a("'The \"".concat(facetName, '" filter value in the `trackedFilters` option expects a function.')));
+                    throw new Error(withUsage$b("'The \"".concat(facetName, '" filter value in the `trackedFilters` option expects a function.')));
                 }
             });
             var hasTrackedFilters = Object.keys(trackedFilters).length > 0;
@@ -15401,7 +15467,7 @@
         return useConnector(connectQueryRules, props, additionalWidgetProperties);
     }
 
-    var withUsage$9 = createDocumentationMessageGenerator({
+    var withUsage$a = createDocumentationMessageGenerator({
         name: 'range-input',
         connector: true
     }, {
@@ -15425,14 +15491,14 @@
      * information about the min and max bounds for the current result set.
      */ var connectRange = function connectRange(renderFn) {
         var unmountFn = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : noop;
-        checkRendering(renderFn, withUsage$9());
+        checkRendering(renderFn, withUsage$a());
         return function(widgetParams) {
             var _ref = widgetParams || {}, _ref_attribute = _ref.attribute, attribute = _ref_attribute === void 0 ? '' : _ref_attribute, minBound = _ref.min, maxBound = _ref.max, _ref_precision = _ref.precision, precision = _ref_precision === void 0 ? 0 : _ref_precision;
             if (!attribute) {
-                throw new Error(withUsage$9('The `attribute` option is required.'));
+                throw new Error(withUsage$a('The `attribute` option is required.'));
             }
             if (isFiniteNumber(minBound) && isFiniteNumber(maxBound) && minBound > maxBound) {
-                throw new Error(withUsage$9("The `max` option can't be lower than `min`."));
+                throw new Error(withUsage$a("The `max` option can't be lower than `min`."));
             }
             var formatToNumber = function formatToNumber(v) {
                 return Number(Number(v).toFixed(precision));
@@ -15652,7 +15718,7 @@
         return useConnector(connectRange, props, additionalWidgetProperties);
     }
 
-    var withUsage$8 = createDocumentationMessageGenerator({
+    var withUsage$9 = createDocumentationMessageGenerator({
         name: 'refinement-list',
         connector: true
     });
@@ -15674,19 +15740,19 @@
      * - a `searchForItems()` function to search within the items.
      */ var connectRefinementList = function connectRefinementList(renderFn) {
         var unmountFn = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : noop;
-        checkRendering(renderFn, withUsage$8());
+        checkRendering(renderFn, withUsage$9());
         return function(widgetParams) {
             var _ref = widgetParams || {}, attribute = _ref.attribute, _ref_operator = _ref.operator, operator = _ref_operator === void 0 ? 'or' : _ref_operator, _ref_limit = _ref.limit, limit = _ref_limit === void 0 ? 10 : _ref_limit, _ref_showMore = _ref.showMore, showMore = _ref_showMore === void 0 ? false : _ref_showMore, _ref_showMoreLimit = _ref.showMoreLimit, showMoreLimit = _ref_showMoreLimit === void 0 ? 20 : _ref_showMoreLimit, _ref_sortBy = _ref.sortBy, sortBy = _ref_sortBy === void 0 ? DEFAULT_SORT : _ref_sortBy, _ref_escapeFacetValues = _ref.escapeFacetValues, escapeFacetValues = _ref_escapeFacetValues === void 0 ? true : _ref_escapeFacetValues, _ref_transformItems = _ref.transformItems, transformItems = _ref_transformItems === void 0 ? function(items) {
                 return items;
             } : _ref_transformItems;
             if (!attribute) {
-                throw new Error(withUsage$8('The `attribute` option is required.'));
+                throw new Error(withUsage$9('The `attribute` option is required.'));
             }
             if (!/^(and|or)$/.test(operator)) {
-                throw new Error(withUsage$8('The `operator` must one of: `"and"`, `"or"` (got "'.concat(operator, '").')));
+                throw new Error(withUsage$9('The `operator` must one of: `"and"`, `"or"` (got "'.concat(operator, '").')));
             }
             if (showMore === true && showMoreLimit <= limit) {
-                throw new Error(withUsage$8('`showMoreLimit` should be greater than `limit`.'));
+                throw new Error(withUsage$9('`showMoreLimit` should be greater than `limit`.'));
             }
             var formatItems = function formatItems(_0) {
                 var label = _0.name, value = _0.escapedValue, item = _object_without_properties(_0, [
@@ -15914,19 +15980,19 @@
         return useConnector(connectRefinementList, props, additionalWidgetProperties);
     }
 
-    var withUsage$7 = createDocumentationMessageGenerator({
+    var withUsage$8 = createDocumentationMessageGenerator({
         name: 'related-products',
         connector: true
     });
     var connectRelatedProducts = function connectRelatedProducts(renderFn) {
         var unmountFn = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : noop;
-        checkRendering(renderFn, withUsage$7());
+        checkRendering(renderFn, withUsage$8());
         return function(widgetParams) {
             var _ref = widgetParams || {}, _ref_escapeHTML = _ref.escapeHTML, escapeHTML = _ref_escapeHTML === void 0 ? true : _ref_escapeHTML, objectIDs = _ref.objectIDs, limit = _ref.limit, threshold = _ref.threshold, fallbackParameters = _ref.fallbackParameters, queryParameters = _ref.queryParameters, _ref_transformItems = _ref.transformItems, transformItems = _ref_transformItems === void 0 ? function(items) {
                 return items;
             } : _ref_transformItems;
             if (!objectIDs || objectIDs.length === 0) {
-                throw new Error(withUsage$7('The `objectIDs` option is required.'));
+                throw new Error(withUsage$8('The `objectIDs` option is required.'));
             }
             var sendEvent;
             return {
@@ -16002,7 +16068,7 @@
         return useConnector(connectRelatedProducts, props, additionalWidgetProperties);
     }
 
-    var withUsage$6 = createDocumentationMessageGenerator({
+    var withUsage$7 = createDocumentationMessageGenerator({
         name: 'search-box',
         connector: true
     });
@@ -16016,7 +16082,7 @@
      * may be impacted by the `queryHook` widget parameter.
      */ var connectSearchBox = function connectSearchBox(renderFn) {
         var unmountFn = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : noop;
-        checkRendering(renderFn, withUsage$6());
+        checkRendering(renderFn, withUsage$7());
         return function(widgetParams) {
             var _ref = widgetParams || {}, _ref_queryHook = _ref.queryHook, queryHook = _ref_queryHook === void 0 ? defaultQueryHook : _ref_queryHook;
             var _refine;
@@ -16087,7 +16153,7 @@
         return useConnector(connectSearchBox, props, additionalWidgetProperties);
     }
 
-    var withUsage$5 = createDocumentationMessageGenerator({
+    var withUsage$6 = createDocumentationMessageGenerator({
         name: 'sort-by',
         connector: true
     });
@@ -16107,14 +16173,14 @@
     }
     var connectSortBy = function connectSortBy(renderFn) {
         var unmountFn = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : noop;
-        checkRendering(renderFn, withUsage$5());
+        checkRendering(renderFn, withUsage$6());
         var connectorState = {};
         return function(widgetParams) {
             var _ref = widgetParams || {}, items = _ref.items, _ref_transformItems = _ref.transformItems, transformItems = _ref_transformItems === void 0 ? function(x) {
                 return x;
             } : _ref_transformItems;
             if (!Array.isArray(items)) {
-                throw new Error(withUsage$5('The `items` option expects an array of objects.'));
+                throw new Error(withUsage$6('The `items` option expects an array of objects.'));
             }
             var itemsLookup = {};
             items.forEach(function(item, index) {
@@ -16122,10 +16188,10 @@
                 var hasStrategy = 'strategy' in item && item.strategy !== undefined;
                 // Validate mutual exclusivity
                 if (hasValue && hasStrategy) {
-                    throw new Error(withUsage$5("Item at index ".concat(index, ' cannot have both "value" and "strategy" properties.')));
+                    throw new Error(withUsage$6("Item at index ".concat(index, ' cannot have both "value" and "strategy" properties.')));
                 }
                 if (!hasValue && !hasStrategy) {
-                    throw new Error(withUsage$5("Item at index ".concat(index, ' must have either a "value" or "strategy" property.')));
+                    throw new Error(withUsage$6("Item at index ".concat(index, ' must have either a "value" or "strategy" property.')));
                 }
                 var itemValue = getItemValue(item);
                 itemsLookup[itemValue] = item;
@@ -16140,7 +16206,7 @@
                         return 'strategy' in item && item.strategy;
                     });
                     if (hasStrategyItems && !instantSearchInstance.compositionID) {
-                        throw new Error(withUsage$5('Sorting strategies can only be used in composition mode. Please provide a "compositionID" to your InstantSearch instance.'));
+                        throw new Error(withUsage$6('Sorting strategies can only be used in composition mode. Please provide a "compositionID" to your InstantSearch instance.'));
                     }
                     var widgetRenderState = this.getWidgetRenderState(initOptions);
                     var currentIndex = widgetRenderState.currentRefinement;
@@ -16253,13 +16319,13 @@
         return useConnector(connectSortBy, props, additionalWidgetProperties);
     }
 
-    var withUsage$4 = createDocumentationMessageGenerator({
+    var withUsage$5 = createDocumentationMessageGenerator({
         name: 'stats',
         connector: true
     });
     var connectStats = function connectStats(renderFn) {
         var unmountFn = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : noop;
-        checkRendering(renderFn, withUsage$4());
+        checkRendering(renderFn, withUsage$5());
         return function(widgetParams) {
             return {
                 $$type: 'ais.stats',
@@ -16318,7 +16384,7 @@
         return useConnector(connectStats, props, additionalWidgetProperties);
     }
 
-    var withUsage$3 = createDocumentationMessageGenerator({
+    var withUsage$4 = createDocumentationMessageGenerator({
         name: 'toggle-refinement',
         connector: true
     });
@@ -16369,11 +16435,11 @@
      *  - switch between two values.
      */ var connectToggleRefinement = function connectToggleRefinement(renderFn) {
         var unmountFn = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : noop;
-        checkRendering(renderFn, withUsage$3());
+        checkRendering(renderFn, withUsage$4());
         return function(widgetParams) {
             var _ref = widgetParams || {}, attribute = _ref.attribute, tmp = _ref.on, userOn = tmp === void 0 ? true : tmp, userOff = _ref.off;
             if (!attribute) {
-                throw new Error(withUsage$3('The `attribute` option is required.'));
+                throw new Error(withUsage$4('The `attribute` option is required.'));
             }
             var hasAnOffValue = userOff !== undefined;
             // even though facet values can be numbers and boolean,
@@ -16594,19 +16660,19 @@
         return useConnector(connectToggleRefinement, props, additionalWidgetProperties);
     }
 
-    var withUsage$2 = createDocumentationMessageGenerator({
+    var withUsage$3 = createDocumentationMessageGenerator({
         name: 'trending-items',
         connector: true
     });
     var connectTrendingItems = function connectTrendingItems(renderFn) {
         var unmountFn = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : noop;
-        checkRendering(renderFn, withUsage$2());
+        checkRendering(renderFn, withUsage$3());
         return function(widgetParams) {
             var _ref = widgetParams || {}, facetName = _ref.facetName, facetValue = _ref.facetValue, 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) {
                 return items;
             } : _ref_transformItems;
             if (facetName && !facetValue || !facetName && facetValue) {
-                throw new Error(withUsage$2("When you provide facetName (received type ".concat(getObjectType(facetName), "), you must also provide facetValue (received type ").concat(getObjectType(facetValue), ").")));
+                throw new Error(withUsage$3("When you provide facetName (received type ".concat(getObjectType(facetName), "), you must also provide facetValue (received type ").concat(getObjectType(facetValue), ").")));
             }
             var sendEvent;
             return {
@@ -16680,6 +16746,94 @@
         return useConnector(connectTrendingItems, props, additionalWidgetProperties);
     }
 
+    var withUsage$2 = createDocumentationMessageGenerator({
+        name: 'trending-facets',
+        connector: true
+    });
+    var connectTrendingFacets = function connectTrendingFacets(renderFn) {
+        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) {
+                return items;
+            } : _ref_transformItems;
+            if (!facetName) {
+                throw new Error(withUsage$2('The `facetName` option is required.'));
+            }
+            return {
+                dependsOn: 'recommend',
+                $$type: 'ais.trendingFacets',
+                init: function init(initOptions) {
+                    renderFn(_object_spread_props(_object_spread({}, this.getWidgetRenderState(initOptions)), {
+                        instantSearchInstance: initOptions.instantSearchInstance
+                    }), true);
+                },
+                render: function render(renderOptions) {
+                    var renderState = this.getWidgetRenderState(renderOptions);
+                    renderFn(_object_spread_props(_object_spread({}, renderState), {
+                        instantSearchInstance: renderOptions.instantSearchInstance
+                    }), false);
+                },
+                getRenderState: function getRenderState(renderState) {
+                    return renderState;
+                },
+                getWidgetRenderState: function getWidgetRenderState(param) {
+                    var results = param.results;
+                    param.helper;
+                    param.instantSearchInstance;
+                    if (results === null || results === undefined) {
+                        return {
+                            items: [],
+                            widgetParams: widgetParams
+                        };
+                    }
+                    var items = (results.hits || []).map(function(hit) {
+                        return {
+                            facetName: hit.facetName,
+                            facetValue: hit.facetValue,
+                            _score: hit._score
+                        };
+                    });
+                    if (escapeHTML) {
+                        items = items.map(function(item) {
+                            return _object_spread_props(_object_spread({}, item), {
+                                facetValue: escape$1(item.facetValue)
+                            });
+                        });
+                    }
+                    items = transformItems(items, {
+                        results: results
+                    });
+                    return {
+                        items: items,
+                        widgetParams: widgetParams
+                    };
+                },
+                dispose: function dispose(param) {
+                    var recommendState = param.recommendState;
+                    unmountFn();
+                    return recommendState.removeParams(this.$$id);
+                },
+                getWidgetParameters: function getWidgetParameters(state) {
+                    // v4 TrendingFacetsQuery doesn't include queryParameters or
+                    // fallbackParameters, but the v5 API and the helper support them.
+                    return state.removeParams(this.$$id).addTrendingFacets({
+                        facetName: facetName,
+                        maxRecommendations: limit,
+                        threshold: threshold,
+                        fallbackParameters: fallbackParameters ? _object_spread({}, fallbackParameters, escapeHTML ? TAG_PLACEHOLDER : {}) : undefined,
+                        queryParameters: _object_spread({}, queryParameters, escapeHTML ? TAG_PLACEHOLDER : {}),
+                        $$id: this.$$id
+                    });
+                }
+            };
+        };
+    };
+
+    function useTrendingFacets(props, additionalWidgetProperties) {
+        return useConnector(connectTrendingFacets, props, additionalWidgetProperties);
+    }
+
     var withUsage$1 = createDocumentationMessageGenerator({
         name: 'looking-similar',
         connector: true
@@ -17390,6 +17544,7 @@
     exports.useSortBy = useSortBy;
     exports.useStats = useStats;
     exports.useToggleRefinement = useToggleRefinement;
+    exports.useTrendingFacets = useTrendingFacets;
     exports.useTrendingItems = useTrendingItems;
     exports.version = version$2;
     exports.wrapPromiseWithState = wrapPromiseWithState;