instantsearch.js 4.60.0 → 4.62.0

package/dist/instantsearch.development.js

@@ -1,4 +1,4 @@
-/*! InstantSearch.js 4.60.0 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch */
+/*! InstantSearch.js 4.62.0 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch */
 (function (global, factory) {
   typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
   typeof define === 'function' && define.amd ? define(factory) :
@@ -1411,8 +1411,6 @@
     });
   }
 
-  // @ts-nocheck (types to be fixed during actual implementation)
-
   function hydrateSearchClient(client, results) {
     if (!results) {
       return;
@@ -1422,9 +1420,22 @@
     // - Algoliasearch API Client < v4 with cache disabled
     // - Third party clients (detected by the `addAlgoliaAgent` function missing)
 
-    if ((!client.transporter || client._cacheHydrated) && (!client._useCache || typeof client.addAlgoliaAgent !== 'function')) {
+    if ((!('transporter' in client) || client._cacheHydrated) && (!client._useCache || typeof client.addAlgoliaAgent !== 'function')) {
       return;
     }
+    var cachedRequest = Object.keys(results).map(function (key) {
+      return results[key].results.map(function (result) {
+        return {
+          indexName: result.index,
+          // We normalize the params received from the server as they can
+          // be serialized differently depending on the engine.
+          params: serializeQueryParameters(deserializeQueryParameters(result.params))
+        };
+      });
+    });
+    var cachedResults = Object.keys(results).reduce(function (acc, key) {
+      return acc.concat(results[key].results);
+    }, []);
 
     // Algoliasearch API Client >= v4
     // To hydrate the client we need to populate the cache with the data from
@@ -1433,9 +1444,10 @@
     // for us to compute the key the same way as `algoliasearch-client` we need
     // to populate it on a custom key and override the `search` method to
     // search on it first.
-    if (client.transporter && !client._cacheHydrated) {
+    if ('transporter' in client && !client._cacheHydrated) {
       client._cacheHydrated = true;
       var baseMethod = client.search;
+      // @ts-ignore wanting type checks for v3 on this would make this too complex
       client.search = function (requests) {
         for (var _len = arguments.length, methodArgs = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
           methodArgs[_key - 1] = arguments[_key];
@@ -1452,22 +1464,11 @@
           return baseMethod.apply(void 0, [requests].concat(methodArgs));
         });
       };
-
-      // Populate the cache with the data from the server
       client.transporter.responsesCache.set({
         method: 'search',
-        args: [Object.keys(results).reduce(function (acc, key) {
-          return acc.concat(results[key].results.map(function (request) {
-            return {
-              indexName: request.index,
-              params: request.params
-            };
-          }));
-        }, [])]
+        args: cachedRequest
       }, {
-        results: Object.keys(results).reduce(function (acc, key) {
-          return acc.concat(results[key].results);
-        }, [])
+        results: cachedResults
       });
     }
 
@@ -1477,24 +1478,27 @@
     // a single-index result. You can find more information about the
     // computation of the key inside the client (see link below).
     // https://github.com/algolia/algoliasearch-client-javascript/blob/c27e89ff92b2a854ae6f40dc524bffe0f0cbc169/src/AlgoliaSearchCore.js#L232-L240
-    if (!client.transporter) {
+    if (!('transporter' in client)) {
       var cacheKey = "/1/indexes/*/queries_body_".concat(JSON.stringify({
-        requests: Object.keys(results).reduce(function (acc, key) {
-          return acc.concat(results[key].rawResults.map(function (request) {
-            return {
-              indexName: request.index,
-              params: request.params
-            };
-          }));
-        }, [])
+        requests: cachedRequest
       }));
       client.cache = _objectSpread2(_objectSpread2({}, client.cache), {}, _defineProperty({}, cacheKey, JSON.stringify({
-        results: Object.keys(results).reduce(function (acc, key) {
-          return acc.concat(results[key].rawResults);
-        }, [])
+        results: Object.keys(results).map(function (key) {
+          return results[key].results;
+        })
       })));
     }
   }
+  function deserializeQueryParameters(parameters) {
+    return parameters.split('&').reduce(function (acc, parameter) {
+      var _parameter$split = parameter.split('='),
+        _parameter$split2 = _slicedToArray(_parameter$split, 2),
+        key = _parameter$split2[0],
+        value = _parameter$split2[1];
+      acc[key] = value ? decodeURIComponent(value) : '';
+      return acc;
+    }, {});
+  }
 
   // This function is copied from the algoliasearch v4 API Client. If modified,
   // consider updating it also in `serializeQueryParameters` from `@algolia/transporter`.
@@ -1950,8 +1954,8 @@
       }))) {
         throw new Error(withUsage$1('The `widgets` option expects an array of widgets.'));
       }
-      if (!(Array.isArray(facets) && facets.length <= 1 && (facets[0] === '*' || facets[0] === undefined))) {
-        throw new Error(withUsage$1("The `facets` option only accepts [] or [\"*\"], you passed ".concat(JSON.stringify(facets))));
+      if (!Array.isArray(facets)) {
+        throw new Error(withUsage$1("The `facets` option only accepts an array of facets, you passed ".concat(JSON.stringify(facets))));
       }
       var localWidgets = new Map();
       return {
@@ -2029,7 +2033,6 @@
           unmountFn();
         },
         getWidgetSearchParameters: function getWidgetSearchParameters(state) {
-          // broadening the scope of facets to avoid conflict between never and *
           return facets.reduce(function (acc, curr) {
             return acc.addFacet(curr);
           }, state.setQueryParameters({
@@ -2572,12 +2575,9 @@
         getWidgetUiState: function getWidgetUiState(uiState, _ref5) {
           var searchParameters = _ref5.searchParameters;
           var path = searchParameters.getHierarchicalFacetBreadcrumb(hierarchicalFacetName);
-          if (!path.length) {
-            return uiState;
-          }
-          return _objectSpread2(_objectSpread2({}, uiState), {}, {
+          return removeEmptyRefinementsFromUiState(_objectSpread2(_objectSpread2({}, uiState), {}, {
             hierarchicalMenu: _objectSpread2(_objectSpread2({}, uiState.hierarchicalMenu), {}, _defineProperty({}, hierarchicalFacetName, path))
-          });
+          }), hierarchicalFacetName);
         },
         getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref6) {
           var uiState = _ref6.uiState;
@@ -2610,6 +2610,18 @@
       };
     };
   };
+  function removeEmptyRefinementsFromUiState(indexUiState, attribute) {
+    if (!indexUiState.hierarchicalMenu) {
+      return indexUiState;
+    }
+    if (!indexUiState.hierarchicalMenu[attribute] || indexUiState.hierarchicalMenu[attribute].length === 0) {
+      delete indexUiState.hierarchicalMenu[attribute];
+    }
+    if (Object.keys(indexUiState.hierarchicalMenu).length === 0) {
+      delete indexUiState.hierarchicalMenu;
+    }
+    return indexUiState;
+  }
 
   var withUsage$5 = createDocumentationMessageGenerator({
     name: 'hits',
@@ -3465,12 +3477,9 @@
           var _searchParameters$get = searchParameters.getHierarchicalFacetBreadcrumb(attribute),
             _searchParameters$get2 = _slicedToArray(_searchParameters$get, 1),
             value = _searchParameters$get2[0];
-          if (!value) {
-            return uiState;
-          }
-          return _objectSpread2(_objectSpread2({}, uiState), {}, {
+          return removeEmptyRefinementsFromUiState$1(_objectSpread2(_objectSpread2({}, uiState), {}, {
             menu: _objectSpread2(_objectSpread2({}, uiState.menu), {}, _defineProperty({}, attribute, value))
-          });
+          }), attribute);
         },
         getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref5) {
           var uiState = _ref5.uiState;
@@ -3496,6 +3505,18 @@
       };
     };
   };
+  function removeEmptyRefinementsFromUiState$1(indexUiState, attribute) {
+    if (!indexUiState.menu) {
+      return indexUiState;
+    }
+    if (indexUiState.menu[attribute] === undefined) {
+      delete indexUiState.menu[attribute];
+    }
+    if (Object.keys(indexUiState.menu).length === 0) {
+      delete indexUiState.menu;
+    }
+    return indexUiState;
+  }
 
   var withUsage$9 = createDocumentationMessageGenerator({
     name: 'numeric-menu',
@@ -3580,12 +3601,9 @@
           }
           var min = values['>='] && values['>='][0] || '';
           var max = values['<='] && values['<='][0] || '';
-          if (min === '' && max === '') {
-            return uiState;
-          }
-          return _objectSpread2(_objectSpread2({}, uiState), {}, {
+          return removeEmptyRefinementsFromUiState$2(_objectSpread2(_objectSpread2({}, uiState), {}, {
             numericMenu: _objectSpread2(_objectSpread2({}, uiState.numericMenu), {}, _defineProperty({}, attribute, "".concat(min, ":").concat(max)))
-          });
+          }), attribute);
         },
         getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref6) {
           var uiState = _ref6.uiState;
@@ -3747,6 +3765,18 @@
   function hasNumericRefinement(currentRefinements, operator, value) {
     return currentRefinements[operator] !== undefined && currentRefinements[operator].includes(value);
   }
+  function removeEmptyRefinementsFromUiState$2(indexUiState, attribute) {
+    if (!indexUiState.numericMenu) {
+      return indexUiState;
+    }
+    if (indexUiState.numericMenu[attribute] === ':') {
+      delete indexUiState.numericMenu[attribute];
+    }
+    if (Object.keys(indexUiState.numericMenu).length === 0) {
+      delete indexUiState.numericMenu;
+    }
+    return indexUiState;
+  }
 
   var Paginator = /*#__PURE__*/function () {
     function Paginator(params) {
@@ -4432,12 +4462,9 @@
         getWidgetUiState: function getWidgetUiState(uiState, _ref5) {
           var searchParameters = _ref5.searchParameters;
           var values = operator === 'or' ? searchParameters.getDisjunctiveRefinements(attribute) : searchParameters.getConjunctiveRefinements(attribute);
-          if (!values.length) {
-            return uiState;
-          }
-          return _objectSpread2(_objectSpread2({}, uiState), {}, {
+          return removeEmptyRefinementsFromUiState$3(_objectSpread2(_objectSpread2({}, uiState), {}, {
             refinementList: _objectSpread2(_objectSpread2({}, uiState.refinementList), {}, _defineProperty({}, attribute, values))
-          });
+          }), attribute);
         },
         getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref6) {
           var uiState = _ref6.uiState;
@@ -4467,6 +4494,18 @@
       };
     };
   };
+  function removeEmptyRefinementsFromUiState$3(indexUiState, attribute) {
+    if (!indexUiState.refinementList) {
+      return indexUiState;
+    }
+    if (!indexUiState.refinementList[attribute] || indexUiState.refinementList[attribute].length === 0) {
+      delete indexUiState.refinementList[attribute];
+    }
+    if (Object.keys(indexUiState.refinementList).length === 0) {
+      delete indexUiState.refinementList;
+    }
+    return indexUiState;
+  }
 
   var withUsage$d = createDocumentationMessageGenerator({
     name: 'search-box',
@@ -4901,12 +4940,9 @@
         getWidgetUiState: function getWidgetUiState(uiState, _ref7) {
           var searchParameters = _ref7.searchParameters;
           var value = _getRefinedStar(searchParameters);
-          if (typeof value !== 'number') {
-            return uiState;
-          }
-          return _objectSpread2(_objectSpread2({}, uiState), {}, {
-            ratingMenu: _objectSpread2(_objectSpread2({}, uiState.ratingMenu), {}, _defineProperty({}, attribute, value))
-          });
+          return removeEmptyRefinementsFromUiState$4(_objectSpread2(_objectSpread2({}, uiState), {}, {
+            ratingMenu: _objectSpread2(_objectSpread2({}, uiState.ratingMenu), {}, _defineProperty({}, attribute, typeof value === 'number' ? value : undefined))
+          }), attribute);
         },
         getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref8) {
           var uiState = _ref8.uiState;
@@ -4923,6 +4959,18 @@
       };
     };
   };
+  function removeEmptyRefinementsFromUiState$4(indexUiState, attribute) {
+    if (!indexUiState.ratingMenu) {
+      return indexUiState;
+    }
+    if (typeof indexUiState.ratingMenu[attribute] !== 'number') {
+      delete indexUiState.ratingMenu[attribute];
+    }
+    if (Object.keys(indexUiState.ratingMenu).length === 0) {
+      delete indexUiState.ratingMenu;
+    }
+    return indexUiState;
+  }
 
   var withUsage$g = createDocumentationMessageGenerator({
     name: 'stats',
@@ -5392,12 +5440,9 @@
         getWidgetUiState: function getWidgetUiState(uiState, _ref3) {
           var searchParameters = _ref3.searchParameters;
           var path = searchParameters.getHierarchicalFacetBreadcrumb(hierarchicalFacetName);
-          if (!path.length) {
-            return uiState;
-          }
-          return _objectSpread2(_objectSpread2({}, uiState), {}, {
+          return removeEmptyRefinementsFromUiState$5(_objectSpread2(_objectSpread2({}, uiState), {}, {
             hierarchicalMenu: _objectSpread2(_objectSpread2({}, uiState.hierarchicalMenu), {}, _defineProperty({}, hierarchicalFacetName, path))
-          });
+          }), hierarchicalFacetName);
         },
         getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref4) {
           var uiState = _ref4.uiState;
@@ -5448,6 +5493,18 @@
       };
     });
   }
+  function removeEmptyRefinementsFromUiState$5(indexUiState, attribute) {
+    if (!indexUiState.hierarchicalMenu) {
+      return indexUiState;
+    }
+    if (!indexUiState.hierarchicalMenu[attribute] || !indexUiState.hierarchicalMenu[attribute].length) {
+      delete indexUiState.hierarchicalMenu[attribute];
+    }
+    if (Object.keys(indexUiState.hierarchicalMenu).length === 0) {
+      delete indexUiState.hierarchicalMenu;
+    }
+    return indexUiState;
+  }
 
   var withUsage$j = createDocumentationMessageGenerator({
     name: 'geo-search',
@@ -8972,7 +9029,6 @@
     );
   }
 
-  // eslint-disable-next-line valid-jsdoc
   /**
    * Constructor for SearchResults
    * @class
@@ -8980,6 +9036,7 @@
    * {@link AlgoliaSearchHelper}.
    * @param {SearchParameters} state state that led to the response
    * @param {array.<object>} results the results from algolia client
+   * @param {object} options options to control results content
    * @example <caption>SearchResults of the first query in
    * <a href="http://demos.algolia.com/instant-search-demo">the instant search demo</a></caption>
   {
@@ -9117,8 +9174,14 @@
     });
 
     // Make every key of the result options reachable from the instance
-    Object.keys(options || {}).forEach(function (key) {
-      self[key] = options[key];
+    var opts = merge_1(
+      {
+        persistHierarchicalRootCount: false,
+      },
+      options
+    );
+    Object.keys(opts).forEach(function (key) {
+      self[key] = opts[key];
     });
 
     /**
@@ -9468,9 +9531,13 @@
           // We want
           //   | beers (5)
           //     > IPA (5)
+          // @MAJOR: remove this legacy behaviour in next major version
           var defaultData = {};
 
-          if (currentRefinement.length > 0) {
+          if (
+            currentRefinement.length > 0 &&
+            !self.persistHierarchicalRootCount
+          ) {
             var root = currentRefinement[0].split(separator)[0];
             defaultData[root] =
               self.hierarchicalFacets[position][attributeIndex].data[root];
@@ -10019,7 +10086,7 @@
 
   var SearchResults_1 = SearchResults;
 
-  var version = '3.15.0';
+  var version = '3.16.0';
 
   var escapeFacetValue$4 = escapeFacetValue_1.escapeFacetValue;
 
@@ -10133,8 +10200,9 @@
    * @param  {SearchParameters | object} options an object defining the initial
    * config of the search. It doesn't have to be a {SearchParameters},
    * just an object containing the properties you need from it.
+   * @param {SearchResultsOptions|object} searchResultsOptions an object defining the options to use when creating the search results.
    */
-  function AlgoliaSearchHelper(client, index, options) {
+  function AlgoliaSearchHelper(client, index, options, searchResultsOptions) {
     if (typeof client.addAlgoliaAgent === 'function') {
       client.addAlgoliaAgent('JS Helper (' + version + ')');
     }
@@ -10148,6 +10216,7 @@
     this._lastQueryIdReceived = -1;
     this.derivedHelpers = [];
     this._currentNbQueries = 0;
+    this._searchResultsOptions = searchResultsOptions;
   }
 
   inherits_1(AlgoliaSearchHelper, events);
@@ -11420,6 +11489,9 @@
     queryId,
     content
   ) {
+    // eslint-disable-next-line consistent-this
+    var self = this;
+
     // @TODO remove the number of outdated queries discarded instead of just one
 
     if (queryId < this._lastQueryIdReceived) {
@@ -11448,7 +11520,11 @@
         return;
       }
 
-      helper.lastResults = new SearchResults_1(state, specificResults);
+      helper.lastResults = new SearchResults_1(
+        state,
+        specificResults,
+        self._searchResultsOptions
+      );
 
       helper.emit('result', {
         results: helper.lastResults,
@@ -11646,10 +11722,11 @@
    * @param  {AlgoliaSearch} client an AlgoliaSearch client
    * @param  {string} index the name of the index to query
    * @param  {SearchParameters|object} opts an object defining the initial config of the search. It doesn't have to be a {SearchParameters}, just an object containing the properties you need from it.
+   * @param {SearchResultsOptions|object} searchResultsOptions an object defining the options to use when creating the search results.
    * @return {AlgoliaSearchHelper} The helper instance
    */
-  function algoliasearchHelper(client, index, opts) {
-    return new algoliasearch_helper(client, index, opts);
+  function algoliasearchHelper(client, index, opts, searchResultsOptions) {
+    return new algoliasearch_helper(client, index, opts, searchResultsOptions);
   }
 
   /**
@@ -14745,7 +14822,7 @@
     };
   }
 
-  var version$1 = '4.60.0';
+  var version$1 = '4.62.0';
 
   var withUsage$r = createDocumentationMessageGenerator({
     name: 'instantsearch'
@@ -14761,7 +14838,8 @@
    * Global options for an InstantSearch instance.
    */
   var INSTANTSEARCH_FUTURE_DEFAULTS = {
-    preserveSharedStateOnUnmount: false
+    preserveSharedStateOnUnmount: false,
+    persistHierarchicalRootCount: false
   };
 
   /**
@@ -15097,7 +15175,9 @@
         // DerivedHelper scoped into the `index` widgets.
         // In Vue InstantSearch' hydrate, a main helper gets set before start, so
         // we need to respect this helper as a way to keep all listeners correct.
-        var mainHelper = this.mainHelper || algoliasearchHelper_1(this.client, this.indexName);
+        var mainHelper = this.mainHelper || algoliasearchHelper_1(this.client, this.indexName, undefined, {
+          persistHierarchicalRootCount: this.future.persistHierarchicalRootCount
+        });
         mainHelper.search = function () {
           _this3.status = 'loading';
           _this3.scheduleRender(false);
@@ -18050,7 +18130,7 @@
           rootProps: {
             className: cssClasses.submit,
             type: 'submit',
-            title: 'Submit the search query.',
+            title: 'Submit the search query',
             hidden: !showSubmit
           },
           templates: templates,
@@ -18063,7 +18143,7 @@
           rootProps: {
             className: cssClasses.reset,
             type: 'reset',
-            title: 'Clear the search query.',
+            title: 'Clear the search query',
             hidden: !(showReset && this.state.query.trim() && !isSearchStalled)
           },
           templates: templates,
@@ -21267,12 +21347,12 @@
   });
   var _ref6$1 = h("g", {
     fill: "none",
-    fillRule: "evenodd"
+    "fill-rule": "evenodd"
   }, h("g", {
     transform: "translate(1 1)",
-    strokeWidth: "2"
+    "stroke-width": "2"
   }, h("circle", {
-    strokeOpacity: ".5",
+    "stroke-opacity": ".5",
     cx: "18",
     cy: "18",
     r: "18"
@@ -21309,7 +21389,12 @@
     },
     loadingIndicator: function loadingIndicator(_ref5) {
       var cssClasses = _ref5.cssClasses;
+      /* eslint-disable react/no-unknown-property */
+      // Preact supports kebab case attributes, and using camel case would
+      // require using `preact/compat`.
+      // @TODO: reconsider using the `react` ESLint preset
       return h("svg", {
+        "aria-label": "Results are loading",
         className: cssClasses.loadingIcon,
         width: "16",
         height: "16",
@@ -21317,6 +21402,7 @@
         stroke: "#444",
         "aria-hidden": "true"
       }, _ref6$1);
+      /* eslint-enable react/no-unknown-property */
     }
   };