instantsearch.js 4.61.0 → 4.63.0

package/cjs/components/SearchBox/SearchBox.js

@@ -58,13 +58,15 @@ var SearchBox = /*#__PURE__*/function (_Component) {
         refine = _this$props.refine,
         onChange = _this$props.onChange;
       var query = event.target.value;
-      if (searchAsYouType) {
-        refine(query);
+      if (event.type === 'compositionend' || !event.isComposing) {
+        if (searchAsYouType) {
+          refine(query);
+        }
+        _this.setState({
+          query: query
+        });
+        onChange(event);
       }
-      _this.setState({
-        query: query
-      });
-      onChange(event);
     });
     _defineProperty(_assertThisInitialized(_this), "onSubmit", function (event) {
       var _this$props2 = _this.props,
@@ -174,7 +176,11 @@ var SearchBox = /*#__PURE__*/function (_Component) {
         ,
         spellCheck: "false",
         maxLength: 512,
-        onInput: this.onInput,
+        onInput: this.onInput
+        // see: https://github.com/preactjs/preact/issues/1978
+        // eslint-disable-next-line react/no-unknown-property
+        ,
+        oncompositionend: this.onInput,
         onBlur: this.onBlur,
         onFocus: this.onFocus,
         "aria-label": ariaLabel

package/cjs/connectors/breadcrumb/connectBreadcrumb.js

@@ -6,9 +6,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var _utils = require("../../lib/utils");
-var _excluded = ["hierarchicalMenu"];
-function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
-function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
 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; }
@@ -126,7 +123,7 @@ var connectBreadcrumb = function connectBreadcrumb(renderFn) {
         var path = searchParameters.getHierarchicalFacetBreadcrumb(hierarchicalFacetName);
         return removeEmptyRefinementsFromUiState(_objectSpread(_objectSpread({}, uiState), {}, {
           hierarchicalMenu: _objectSpread(_objectSpread({}, uiState.hierarchicalMenu), {}, _defineProperty({}, hierarchicalFacetName, path))
-        }));
+        }), hierarchicalFacetName);
       },
       getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref4) {
         var uiState = _ref4.uiState;
@@ -177,18 +174,17 @@ function shiftItemsValues(array) {
     };
   });
 }
-function removeEmptyRefinementsFromUiState(indexUiState) {
-  var hierarchicalMenu = indexUiState.hierarchicalMenu,
-    indexUiStateBase = _objectWithoutProperties(indexUiState, _excluded);
-  if (!hierarchicalMenu) {
+function removeEmptyRefinementsFromUiState(indexUiState, attribute) {
+  if (!indexUiState.hierarchicalMenu) {
     return indexUiState;
   }
-  var connectorUiState = Object.keys(hierarchicalMenu).reduce(function (acc, key) {
-    return _objectSpread(_objectSpread({}, acc), hierarchicalMenu[key].length > 0 ? _defineProperty({}, key, hierarchicalMenu[key]) : {});
-  }, {});
-  return _objectSpread(_objectSpread({}, indexUiStateBase), Object.keys(connectorUiState).length > 0 ? {
-    hierarchicalMenu: connectorUiState
-  } : {});
+  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/hierarchical-menu/connectHierarchicalMenu.js

@@ -6,8 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var _utils = require("../../lib/utils");
-var _excluded = ["name", "escapedValue", "data", "path"],
-  _excluded2 = ["hierarchicalMenu"];
+var _excluded = ["name", "escapedValue", "data", "path"];
 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; }
@@ -208,7 +207,7 @@ var connectHierarchicalMenu = function connectHierarchicalMenu(renderFn) {
         var path = searchParameters.getHierarchicalFacetBreadcrumb(hierarchicalFacetName);
         return removeEmptyRefinementsFromUiState(_objectSpread(_objectSpread({}, uiState), {}, {
           hierarchicalMenu: _objectSpread(_objectSpread({}, uiState.hierarchicalMenu), {}, _defineProperty({}, hierarchicalFacetName, path))
-        }));
+        }), hierarchicalFacetName);
       },
       getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref6) {
         var uiState = _ref6.uiState;
@@ -241,18 +240,17 @@ var connectHierarchicalMenu = function connectHierarchicalMenu(renderFn) {
     };
   };
 };
-function removeEmptyRefinementsFromUiState(indexUiState) {
-  var hierarchicalMenu = indexUiState.hierarchicalMenu,
-    indexUiStateBase = _objectWithoutProperties(indexUiState, _excluded2);
-  if (!hierarchicalMenu) {
+function removeEmptyRefinementsFromUiState(indexUiState, attribute) {
+  if (!indexUiState.hierarchicalMenu) {
     return indexUiState;
   }
-  var connectorUiState = Object.keys(hierarchicalMenu).reduce(function (acc, key) {
-    return _objectSpread(_objectSpread({}, acc), hierarchicalMenu[key].length > 0 ? _defineProperty({}, key, hierarchicalMenu[key]) : {});
-  }, {});
-  return _objectSpread(_objectSpread({}, indexUiStateBase), Object.keys(connectorUiState).length > 0 ? {
-    hierarchicalMenu: connectorUiState
-  } : {});
+  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

@@ -5,8 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var _utils = require("../../lib/utils");
-var _excluded = ["name", "escapedValue", "path"],
-  _excluded2 = ["menu"];
+var _excluded = ["name", "escapedValue", "path"];
 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 _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
 function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
@@ -180,7 +179,7 @@ var connectMenu = function connectMenu(renderFn) {
           value = _searchParameters$get2[0];
         return removeEmptyRefinementsFromUiState(_objectSpread(_objectSpread({}, uiState), {}, {
           menu: _objectSpread(_objectSpread({}, uiState.menu), {}, _defineProperty({}, attribute, value))
-        }));
+        }), attribute);
       },
       getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref5) {
         var uiState = _ref5.uiState;
@@ -206,19 +205,17 @@ var connectMenu = function connectMenu(renderFn) {
     };
   };
 };
-function removeEmptyRefinementsFromUiState(indexUiState) {
-  var menu = indexUiState.menu,
-    indexUiStateBase = _objectWithoutProperties(indexUiState, _excluded2);
-  if (!menu) {
+function removeEmptyRefinementsFromUiState(indexUiState, attribute) {
+  if (!indexUiState.menu) {
     return indexUiState;
   }
-  var connectorUiState = Object.keys(menu).reduce(function (acc, key) {
-    var _menu$key;
-    return _objectSpread(_objectSpread({}, acc), ((_menu$key = menu[key]) === null || _menu$key === void 0 ? void 0 : _menu$key.length) > 0 ? _defineProperty({}, key, menu[key]) : {});
-  }, {});
-  return _objectSpread(_objectSpread({}, indexUiStateBase), Object.keys(connectorUiState).length > 0 ? {
-    menu: connectorUiState
-  } : {});
+  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

@@ -5,10 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var _utils = require("../../lib/utils");
-var _excluded = ["numericMenu"];
 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 _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
-function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
 function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e2) { throw _e2; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e3) { didErr = true; err = _e3; }, f: function f() { try { if (!normalCompletion && it.return != null) it.return(); } finally { if (didErr) throw err; } } }; }
 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."); }
@@ -106,7 +103,7 @@ var connectNumericMenu = function connectNumericMenu(renderFn) {
         var max = values['<='] && values['<='][0] || '';
         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,18 +265,17 @@ function getRefinedState(state, attribute, facetValue) {
 function hasNumericRefinement(currentRefinements, operator, value) {
   return currentRefinements[operator] !== undefined && currentRefinements[operator].includes(value);
 }
-function removeEmptyRefinementsFromUiState(indexUiState) {
-  var numericMenu = indexUiState.numericMenu,
-    indexUiStateBase = _objectWithoutProperties(indexUiState, _excluded);
-  if (!numericMenu) {
+function removeEmptyRefinementsFromUiState(indexUiState, attribute) {
+  if (!indexUiState.numericMenu) {
     return indexUiState;
   }
-  var connectorUiState = Object.keys(numericMenu).reduce(function (acc, key) {
-    return _objectSpread(_objectSpread({}, acc), numericMenu[key] !== ':' ? _defineProperty({}, key, numericMenu[key]) : {});
-  }, {});
-  return _objectSpread(_objectSpread({}, indexUiStateBase), Object.keys(connectorUiState).length > 0 ? {
-    numericMenu: connectorUiState
-  } : {});
+  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

@@ -6,9 +6,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var _utils = require("../../lib/utils");
-var _excluded = ["ratingMenu"];
-function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
-function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
 function _toConsumableArray(arr) { return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread(); }
 function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
 function _iterableToArray(iter) { if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter); }
@@ -267,7 +264,7 @@ var connectRatingMenu = function connectRatingMenu(renderFn) {
         var value = _getRefinedStar(searchParameters);
         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,18 +281,17 @@ var connectRatingMenu = function connectRatingMenu(renderFn) {
     };
   };
 };
-function removeEmptyRefinementsFromUiState(indexUiState) {
-  var ratingMenu = indexUiState.ratingMenu,
-    indexUiStateBase = _objectWithoutProperties(indexUiState, _excluded);
-  if (!ratingMenu) {
+function removeEmptyRefinementsFromUiState(indexUiState, attribute) {
+  if (!indexUiState.ratingMenu) {
     return indexUiState;
   }
-  var connectorUiState = Object.keys(ratingMenu).reduce(function (acc, key) {
-    return _objectSpread(_objectSpread({}, acc), typeof ratingMenu[key] === 'number' ? _defineProperty({}, key, ratingMenu[key]) : {});
-  }, {});
-  return _objectSpread(_objectSpread({}, indexUiStateBase), Object.keys(connectorUiState).length > 0 ? {
-    ratingMenu: connectorUiState
-  } : {});
+  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

@@ -7,8 +7,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 var _utils = require("../../lib/utils");
 var _excluded = ["name", "escapedValue"],
-  _excluded2 = ["escapedValue", "value"],
-  _excluded3 = ["refinementList"];
+  _excluded2 = ["escapedValue", "value"];
 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; }
@@ -252,7 +251,7 @@ var connectRefinementList = function connectRefinementList(renderFn) {
         var values = operator === 'or' ? searchParameters.getDisjunctiveRefinements(attribute) : searchParameters.getConjunctiveRefinements(attribute);
         return removeEmptyRefinementsFromUiState(_objectSpread(_objectSpread({}, uiState), {}, {
           refinementList: _objectSpread(_objectSpread({}, uiState.refinementList), {}, _defineProperty({}, attribute, values))
-        }));
+        }), attribute);
       },
       getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref6) {
         var uiState = _ref6.uiState;
@@ -282,18 +281,17 @@ var connectRefinementList = function connectRefinementList(renderFn) {
     };
   };
 };
-function removeEmptyRefinementsFromUiState(indexUiState) {
-  var refinementList = indexUiState.refinementList,
-    indexUiStateBase = _objectWithoutProperties(indexUiState, _excluded3);
-  if (!refinementList) {
+function removeEmptyRefinementsFromUiState(indexUiState, attribute) {
+  if (!indexUiState.refinementList) {
     return indexUiState;
   }
-  var connectorUiState = Object.keys(refinementList).reduce(function (acc, key) {
-    return _objectSpread(_objectSpread({}, acc), refinementList[key].length > 0 ? _defineProperty({}, key, refinementList[key]) : {});
-  }, {});
-  return _objectSpread(_objectSpread({}, indexUiStateBase), Object.keys(connectorUiState).length > 0 ? {
-    refinementList: connectorUiState
-  } : {});
+  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/routers/history.js

@@ -36,7 +36,8 @@ var BrowserHistory = /*#__PURE__*/function () {
       getLocation = _ref.getLocation,
       start = _ref.start,
       dispose = _ref.dispose,
-      push = _ref.push;
+      push = _ref.push,
+      cleanUrlOnDispose = _ref.cleanUrlOnDispose;
     _classCallCheck(this, BrowserHistory);
     _defineProperty(this, "$$type", 'ais.browser');
     /**
@@ -86,6 +87,7 @@ var BrowserHistory = /*#__PURE__*/function () {
     _defineProperty(this, "_start", void 0);
     _defineProperty(this, "_dispose", void 0);
     _defineProperty(this, "_push", void 0);
+    _defineProperty(this, "_cleanUrlOnDispose", void 0);
     this.windowTitle = windowTitle;
     this.writeTimer = undefined;
     this.writeDelay = writeDelay;
@@ -95,6 +97,13 @@ var BrowserHistory = /*#__PURE__*/function () {
     this._start = start;
     this._dispose = dispose;
     this._push = push;
+    this._cleanUrlOnDispose = typeof cleanUrlOnDispose === 'undefined' ? true : cleanUrlOnDispose;
+    if (process.env.NODE_ENV === 'development' && typeof cleanUrlOnDispose === 'undefined') {
+      // eslint-disable-next-line no-console
+      console.info("Starting from the next major version, InstantSearch will not clean up the URL from active refinements when it is disposed.\n\nWe recommend setting `cleanUrlOnDispose` to false to adopt this change today.\nTo stay with the current behaviour and remove this warning, set the option to true.\n\nSee documentation: ".concat((0, _utils.createDocumentationLink)({
+        name: 'history-router'
+      }), "#widget-param-cleanurlondispose"));
+    }
     (0, _utils.safelyRunOnBrowser)(function (_ref2) {
       var window = _ref2.window;
       var title = _this.windowTitle && _this.windowTitle(_this.read());
@@ -222,7 +231,9 @@ var BrowserHistory = /*#__PURE__*/function () {
       if (this.writeTimer) {
         clearTimeout(this.writeTimer);
       }
-      this.write({});
+      if (this._cleanUrlOnDispose) {
+        this.write({});
+      }
     }
   }, {
     key: "start",
@@ -311,7 +322,8 @@ function historyRouter() {
     } : _ref7$getLocation,
     start = _ref7.start,
     dispose = _ref7.dispose,
-    push = _ref7.push;
+    push = _ref7.push,
+    cleanUrlOnDispose = _ref7.cleanUrlOnDispose;
   return new BrowserHistory({
     createURL: createURL,
     parseURL: parseURL,
@@ -320,6 +332,7 @@ function historyRouter() {
     getLocation: getLocation,
     start: start,
     dispose: dispose,
-    push: push
+    push: push,
+    cleanUrlOnDispose: cleanUrlOnDispose
   });
 }

package/cjs/lib/version.js

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

package/cjs/middlewares/createInsightsMiddleware.js

@@ -22,7 +22,7 @@ function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o =
 function _iterableToArray(iter) { if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter); }
 function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToArray(arr); }
 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; }
-var ALGOLIA_INSIGHTS_VERSION = '2.6.0';
+var ALGOLIA_INSIGHTS_VERSION = '2.13.0';
 var ALGOLIA_INSIGHTS_SRC = "https://cdn.jsdelivr.net/npm/search-insights@".concat(ALGOLIA_INSIGHTS_VERSION, "/dist/search-insights.min.js");
 function createInsightsMiddleware() {
   var props = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
@@ -106,7 +106,7 @@ function createInsightsMiddleware() {
       // set it later on.
       //
       // Otherwise, the `init` call might override it with anonymous user token.
-      userTokenBeforeInit = userToken;
+      userTokenBeforeInit = normalizeUserToken(userToken);
     });
 
     // Only `init` if the `insightsInitParams` option is passed or
@@ -162,13 +162,14 @@ function createInsightsMiddleware() {
         }
         var setUserTokenToSearch = function setUserTokenToSearch(userToken) {
           var immediate = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
-          if (!userToken) {
+          var normalizedUserToken = normalizeUserToken(userToken);
+          if (!normalizedUserToken) {
             return;
           }
           var existingToken = helper.state.userToken;
           function applyToken() {
             helper.overrideStateWithoutTriggeringChangeEvent(_objectSpread(_objectSpread({}, helper.state), {}, {
-              userToken: userToken
+              userToken: normalizedUserToken
             }));
             if (existingToken && existingToken !== userToken) {
               instantSearchInstance.scheduleSearch();
@@ -265,4 +266,15 @@ function isModernInsightsClient(client) {
   /* eslint-enable @typescript-eslint/naming-convention */
 
   return v3 || v2_6 || v1_10;
+}
+
+/**
+ * While `search-insights` supports both string and number user tokens,
+ * the Search API only accepts strings. This function normalizes the user token.
+ */
+function normalizeUserToken(userToken) {
+  if (!userToken) {
+    return undefined;
+  }
+  return typeof userToken === 'number' ? userToken.toString() : userToken;
 }

package/dist/instantsearch.development.d.ts

@@ -486,11 +486,12 @@ declare class BrowserHistory<TRouteState> implements Router<TRouteState> {
     private _start?;
     private _dispose?;
     private _push?;
+    private _cleanUrlOnDispose;
     /**
      * Initializes a new storage provider that syncs the search state to the URL
      * using web APIs (`window.location.pushState` and `onpopstate` event).
      */
-    constructor({ windowTitle, writeDelay, createURL, parseURL, getLocation, start, dispose, push, }: BrowserHistoryArgs<TRouteState>);
+    constructor({ windowTitle, writeDelay, createURL, parseURL, getLocation, start, dispose, push, cleanUrlOnDispose, }: BrowserHistoryArgs<TRouteState>);
     /**
      * Reads the URL and returns a syncable UI search state.
      */
@@ -529,6 +530,13 @@ declare type BrowserHistoryArgs<TRouteState> = {
     start?: (onUpdate: () => void) => void;
     dispose?: () => void;
     push?: (url: string) => void;
+    /**
+     * Whether the URL should be cleaned up when the router is disposed.
+     * This can be useful when closing a modal containing InstantSearch, to
+     * remove active refinements from the URL.
+     * @default true
+     */
+    cleanUrlOnDispose?: boolean;
 };
 
 declare type BuiltInBindEventForHits = (eventType: string, hits: Hit | Hit[], eventName?: string, additionalData?: Record<string, any>) => string;
@@ -1813,7 +1821,7 @@ declare type HighlightProps_2 = Omit<HighlightProps_3, 'classNames'> & {
     classNames?: Partial<HighlightClassNames>;
 };
 
-declare function historyRouter<TRouteState = UiState>({ createURL, parseURL, writeDelay, windowTitle, getLocation, start, dispose, push, }?: Partial<BrowserHistoryArgs<TRouteState>>): BrowserHistory<TRouteState>;
+declare function historyRouter<TRouteState = UiState>({ createURL, parseURL, writeDelay, windowTitle, getLocation, start, dispose, push, cleanUrlOnDispose, }?: Partial<BrowserHistoryArgs<TRouteState>>): BrowserHistory<TRouteState>;
 
 declare type Hit<THit extends BaseHit = Record<string, any>> = {
     __position: number;
@@ -2627,6 +2635,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;
     };
 };