instantsearch.js 4.60.0 → 4.62.0

package/cjs/components/SearchBox/SearchBox.js

@@ -184,7 +184,7 @@ var SearchBox = /*#__PURE__*/function (_Component) {
         rootProps: {
           className: cssClasses.submit,
           type: 'submit',
-          title: 'Submit the search query.',
+          title: 'Submit the search query',
           hidden: !showSubmit
         },
         templates: templates,
@@ -197,7 +197,7 @@ var SearchBox = /*#__PURE__*/function (_Component) {
         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,

package/cjs/connectors/breadcrumb/connectBreadcrumb.js

@@ -121,12 +121,9 @@ var connectBreadcrumb = function connectBreadcrumb(renderFn) {
       getWidgetUiState: function getWidgetUiState(uiState, _ref3) {
         var searchParameters = _ref3.searchParameters;
         var path = searchParameters.getHierarchicalFacetBreadcrumb(hierarchicalFacetName);
-        if (!path.length) {
-          return uiState;
-        }
-        return _objectSpread(_objectSpread({}, uiState), {}, {
+        return removeEmptyRefinementsFromUiState(_objectSpread(_objectSpread({}, uiState), {}, {
           hierarchicalMenu: _objectSpread(_objectSpread({}, uiState.hierarchicalMenu), {}, _defineProperty({}, hierarchicalFacetName, path))
-        });
+        }), hierarchicalFacetName);
       },
       getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref4) {
         var uiState = _ref4.uiState;
@@ -177,5 +174,17 @@ function shiftItemsValues(array) {
     };
   });
 }
+function removeEmptyRefinementsFromUiState(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 _default = connectBreadcrumb;
 exports.default = _default;

package/cjs/connectors/dynamic-widgets/connectDynamicWidgets.js

@@ -35,8 +35,8 @@ var connectDynamicWidgets = function connectDynamicWidgets(renderFn) {
     }))) {
       throw new Error(withUsage('The `widgets` option expects an array of widgets.'));
     }
-    if (!(Array.isArray(facets) && facets.length <= 1 && (facets[0] === '*' || facets[0] === undefined))) {
-      throw new Error(withUsage("The `facets` option only accepts [] or [\"*\"], you passed ".concat(JSON.stringify(facets))));
+    if (!Array.isArray(facets)) {
+      throw new Error(withUsage("The `facets` option only accepts an array of facets, you passed ".concat(JSON.stringify(facets))));
     }
     var localWidgets = new Map();
     return {
@@ -114,7 +114,6 @@ var connectDynamicWidgets = function connectDynamicWidgets(renderFn) {
         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({

package/cjs/connectors/hierarchical-menu/connectHierarchicalMenu.js

@@ -205,12 +205,9 @@ var connectHierarchicalMenu = function connectHierarchicalMenu(renderFn) {
       getWidgetUiState: function getWidgetUiState(uiState, _ref5) {
         var searchParameters = _ref5.searchParameters;
         var path = searchParameters.getHierarchicalFacetBreadcrumb(hierarchicalFacetName);
-        if (!path.length) {
-          return uiState;
-        }
-        return _objectSpread(_objectSpread({}, uiState), {}, {
+        return removeEmptyRefinementsFromUiState(_objectSpread(_objectSpread({}, uiState), {}, {
           hierarchicalMenu: _objectSpread(_objectSpread({}, uiState.hierarchicalMenu), {}, _defineProperty({}, hierarchicalFacetName, path))
-        });
+        }), hierarchicalFacetName);
       },
       getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref6) {
         var uiState = _ref6.uiState;
@@ -243,5 +240,17 @@ var connectHierarchicalMenu = function connectHierarchicalMenu(renderFn) {
     };
   };
 };
+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 _default = connectHierarchicalMenu;
 exports.default = _default;

package/cjs/connectors/menu/connectMenu.js

@@ -177,12 +177,9 @@ var connectMenu = function connectMenu(renderFn) {
         var _searchParameters$get = searchParameters.getHierarchicalFacetBreadcrumb(attribute),
           _searchParameters$get2 = _slicedToArray(_searchParameters$get, 1),
           value = _searchParameters$get2[0];
-        if (!value) {
-          return uiState;
-        }
-        return _objectSpread(_objectSpread({}, uiState), {}, {
+        return removeEmptyRefinementsFromUiState(_objectSpread(_objectSpread({}, uiState), {}, {
           menu: _objectSpread(_objectSpread({}, uiState.menu), {}, _defineProperty({}, attribute, value))
-        });
+        }), attribute);
       },
       getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref5) {
         var uiState = _ref5.uiState;
@@ -208,5 +205,17 @@ var connectMenu = function connectMenu(renderFn) {
     };
   };
 };
+function removeEmptyRefinementsFromUiState(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 _default = connectMenu;
 exports.default = _default;

package/cjs/connectors/numeric-menu/connectNumericMenu.js

@@ -101,12 +101,9 @@ var connectNumericMenu = function connectNumericMenu(renderFn) {
         }
         var min = values['>='] && values['>='][0] || '';
         var max = values['<='] && values['<='][0] || '';
-        if (min === '' && max === '') {
-          return uiState;
-        }
-        return _objectSpread(_objectSpread({}, uiState), {}, {
+        return removeEmptyRefinementsFromUiState(_objectSpread(_objectSpread({}, uiState), {}, {
           numericMenu: _objectSpread(_objectSpread({}, uiState.numericMenu), {}, _defineProperty({}, attribute, "".concat(min, ":").concat(max)))
-        });
+        }), attribute);
       },
       getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref6) {
         var uiState = _ref6.uiState;
@@ -268,5 +265,17 @@ function getRefinedState(state, attribute, facetValue) {
 function hasNumericRefinement(currentRefinements, operator, value) {
   return currentRefinements[operator] !== undefined && currentRefinements[operator].includes(value);
 }
+function removeEmptyRefinementsFromUiState(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 _default = connectNumericMenu;
 exports.default = _default;

package/cjs/connectors/rating-menu/connectRatingMenu.js

@@ -262,12 +262,9 @@ var connectRatingMenu = function connectRatingMenu(renderFn) {
       getWidgetUiState: function getWidgetUiState(uiState, _ref7) {
         var searchParameters = _ref7.searchParameters;
         var value = _getRefinedStar(searchParameters);
-        if (typeof value !== 'number') {
-          return uiState;
-        }
-        return _objectSpread(_objectSpread({}, uiState), {}, {
-          ratingMenu: _objectSpread(_objectSpread({}, uiState.ratingMenu), {}, _defineProperty({}, attribute, value))
-        });
+        return removeEmptyRefinementsFromUiState(_objectSpread(_objectSpread({}, uiState), {}, {
+          ratingMenu: _objectSpread(_objectSpread({}, uiState.ratingMenu), {}, _defineProperty({}, attribute, typeof value === 'number' ? value : undefined))
+        }), attribute);
       },
       getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref8) {
         var uiState = _ref8.uiState;
@@ -284,5 +281,17 @@ var connectRatingMenu = function connectRatingMenu(renderFn) {
     };
   };
 };
+function removeEmptyRefinementsFromUiState(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 _default = connectRatingMenu;
 exports.default = _default;

package/cjs/connectors/refinement-list/connectRefinementList.js

@@ -249,12 +249,9 @@ var connectRefinementList = function connectRefinementList(renderFn) {
       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 _objectSpread(_objectSpread({}, uiState), {}, {
+        return removeEmptyRefinementsFromUiState(_objectSpread(_objectSpread({}, uiState), {}, {
           refinementList: _objectSpread(_objectSpread({}, uiState.refinementList), {}, _defineProperty({}, attribute, values))
-        });
+        }), attribute);
       },
       getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref6) {
         var uiState = _ref6.uiState;
@@ -284,5 +281,17 @@ var connectRefinementList = function connectRefinementList(renderFn) {
     };
   };
 };
+function removeEmptyRefinementsFromUiState(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 _default = connectRefinementList;
 exports.default = _default;

package/cjs/lib/InstantSearch.js

@@ -44,7 +44,8 @@ function defaultCreateURL() {
  * Global options for an InstantSearch instance.
  */
 var INSTANTSEARCH_FUTURE_DEFAULTS = {
-  preserveSharedStateOnUnmount: false
+  preserveSharedStateOnUnmount: false,
+  persistHierarchicalRootCount: false
 };
 
 /**
@@ -381,7 +382,9 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
       // 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 || (0, _algoliasearchHelper.default)(this.client, this.indexName);
+      var mainHelper = this.mainHelper || (0, _algoliasearchHelper.default)(this.client, this.indexName, undefined, {
+        persistHierarchicalRootCount: this.future.persistHierarchicalRootCount
+      });
       mainHelper.search = function () {
         _this3.status = 'loading';
         _this3.scheduleRender(false);

package/cjs/lib/utils/hydrateSearchClient.js

@@ -5,13 +5,17 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.hydrateSearchClient = hydrateSearchClient;
 function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
+function _iterableToArrayLimit(arr, i) { var _i = null == arr ? null : "undefined" != typeof Symbol && arr[Symbol.iterator] || arr["@@iterator"]; if (null != _i) { var _s, _e, _x, _r, _arr = [], _n = !0, _d = !1; try { if (_x = (_i = _i.call(arr)).next, 0 === i) { if (Object(_i) !== _i) return; _n = !1; } else for (; !(_n = (_s = _x.call(_i)).done) && (_arr.push(_s.value), _arr.length !== i); _n = !0); } catch (err) { _d = !0, _e = err; } finally { try { if (!_n && null != _i.return && (_r = _i.return(), Object(_r) !== _r)) return; } finally { if (_d) throw _e; } } return _arr; } }
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
 function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
-// @ts-nocheck (types to be fixed during actual implementation)
-
 function hydrateSearchClient(client, results) {
   if (!results) {
     return;
@@ -21,9 +25,22 @@ function hydrateSearchClient(client, results) {
   // - 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
@@ -32,9 +49,10 @@ function hydrateSearchClient(client, results) {
   // 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];
@@ -51,22 +69,11 @@ function hydrateSearchClient(client, results) {
         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
     });
   }
 
@@ -76,24 +83,27 @@ function hydrateSearchClient(client, results) {
   // 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 = _objectSpread(_objectSpread({}, 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`.

package/cjs/lib/version.js

@@ -4,5 +4,5 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _default = '4.60.0';
+var _default = '4.62.0';
 exports.default = _default;

package/cjs/widgets/search-box/defaultTemplates.js

@@ -13,12 +13,12 @@ var _ref4 = (0, _preact.h)("path", {
 });
 var _ref6 = (0, _preact.h)("g", {
   fill: "none",
-  fillRule: "evenodd"
+  "fill-rule": "evenodd"
 }, (0, _preact.h)("g", {
   transform: "translate(1 1)",
-  strokeWidth: "2"
+  "stroke-width": "2"
 }, (0, _preact.h)("circle", {
-  strokeOpacity: ".5",
+  "stroke-opacity": ".5",
   cx: "18",
   cy: "18",
   r: "18"
@@ -55,7 +55,12 @@ var defaultTemplate = {
   },
   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 (0, _preact.h)("svg", {
+      "aria-label": "Results are loading",
       className: cssClasses.loadingIcon,
       width: "16",
       height: "16",
@@ -63,6 +68,7 @@ var defaultTemplate = {
       stroke: "#444",
       "aria-hidden": "true"
     }, _ref6);
+    /* eslint-enable react/no-unknown-property */
   }
 };
 var _default = defaultTemplate;

package/dist/instantsearch.development.d.ts

@@ -1130,11 +1130,21 @@ declare type DynamicWidgetsConnectorParams = {
     }>;
     /**
      * To prevent unneeded extra network requests when widgets mount or unmount,
-     * we request all facet values.
+     * we request all facet values by default. If you want to only request the
+     * facet values that are needed, you can set this option to the list of
+     * attributes you want to display.
+     *
+     * If `facets` is set to `['*']`, we request all facet values.
+     *
+     * Any facets that are requested due to the `facetOrdering` result are always
+     * requested by the widget that mounted itself.
+     *
+     * Setting `facets` to a value other than `['*']` will only prevent extra
+     * requests if all potential facets are listed.
      *
      * @default ['*']
      */
-    facets?: ['*'] | never[];
+    facets?: ['*'] | string[];
     /**
      * If you have more than 20 facet values pinned, you need to increase the
      * maxValuesPerFacet to at least that value.
@@ -2617,6 +2627,16 @@ declare type InstantSearchOptions<TUiState extends UiState = UiState, TRouteStat
          * @default false
          */
         preserveSharedStateOnUnmount?: boolean;
+        /**
+         * Changes the way root levels of hierarchical facets have their count displayed.
+         *
+         * If `false` (by default), the count of the refined root level is updated to match the count of the actively refined parent level.
+         *
+         * If `true`, the count of the root level stays the same as the count of all children levels.
+         *
+         * @default false
+         */
+        persistHierarchicalRootCount?: boolean;
     };
 };
 
@@ -3965,7 +3985,7 @@ declare type RatingMenuWidgetDescription = {
     };
     indexUiState: {
         ratingMenu: {
-            [attribute: string]: number;
+            [attribute: string]: number | undefined;
         };
     };
 };