instantsearch.js 4.64.0 → 4.64.2

package/cjs/components/SearchBox/SearchBox.js

@@ -29,6 +29,7 @@ var defaultProps = {
   showLoadingIndicator: true,
   autofocus: false,
   searchAsYouType: true,
+  ignoreCompositionEvents: false,
   isSearchStalled: false,
   disabled: false,
   ariaLabel: 'Search',
@@ -58,7 +59,7 @@ var SearchBox = /*#__PURE__*/function (_Component) {
         refine = _this$props.refine,
         onChange = _this$props.onChange;
       var query = event.target.value;
-      if (event.type === 'compositionend' || !event.isComposing) {
+      if (!(_this.props.ignoreCompositionEvents && event.isComposing)) {
         if (searchAsYouType) {
           refine(query);
         }

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

@@ -88,7 +88,7 @@ var connectNumericMenu = function connectNumericMenu(renderFn) {
       dispose: function dispose(_ref4) {
         var state = _ref4.state;
         unmountFn();
-        return state.clearRefinements(attribute);
+        return state.removeNumericRefinement(attribute);
       },
       getWidgetUiState: function getWidgetUiState(uiState, _ref5) {
         var searchParameters = _ref5.searchParameters;
@@ -108,11 +108,11 @@ var connectNumericMenu = function connectNumericMenu(renderFn) {
       getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref6) {
         var uiState = _ref6.uiState;
         var value = uiState.numericMenu && uiState.numericMenu[attribute];
-        var withoutRefinements = searchParameters.clearRefinements(attribute);
+        var withoutRefinements = searchParameters.setQueryParameters({
+          numericRefinements: _objectSpread(_objectSpread({}, searchParameters.numericRefinements), {}, _defineProperty({}, attribute, {}))
+        });
         if (!value) {
-          return withoutRefinements.setQueryParameters({
-            numericRefinements: _objectSpread(_objectSpread({}, withoutRefinements.numericRefinements), {}, _defineProperty({}, attribute, {}))
-          });
+          return withoutRefinements;
         }
         var isExact = value.indexOf(':') === -1;
         if (isExact) {

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

@@ -269,8 +269,7 @@ var connectRatingMenu = function connectRatingMenu(renderFn) {
       getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref8) {
         var uiState = _ref8.uiState;
         var value = uiState.ratingMenu && uiState.ratingMenu[attribute];
-        var withoutRefinements = searchParameters.clearRefinements(attribute);
-        var withDisjunctiveFacet = withoutRefinements.addDisjunctiveFacet(attribute);
+        var withDisjunctiveFacet = searchParameters.addDisjunctiveFacet(attribute).removeNumericRefinement(attribute).removeDisjunctiveFacetRefinement(attribute);
         if (!value) {
           return withDisjunctiveFacet.setQueryParameters({
             numericRefinements: _objectSpread(_objectSpread({}, withDisjunctiveFacet.numericRefinements), {}, _defineProperty({}, attribute, {}))

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

@@ -265,8 +265,7 @@ var connectRefinementList = function connectRefinementList(renderFn) {
           return searchParameters;
         }
         var values = uiState.refinementList && uiState.refinementList[attribute];
-        var withoutRefinements = searchParameters.clearRefinements(attribute);
-        var withFacetConfiguration = isDisjunctive ? withoutRefinements.addDisjunctiveFacet(attribute) : withoutRefinements.addFacet(attribute);
+        var withFacetConfiguration = isDisjunctive ? searchParameters.addDisjunctiveFacet(attribute).removeDisjunctiveFacetRefinement(attribute) : searchParameters.addFacet(attribute).removeFacetRefinement(attribute);
         var currentMaxValuesPerFacet = withFacetConfiguration.maxValuesPerFacet || 0;
         var nextMaxValuesPerFacet = Math.max(currentMaxValuesPerFacet, showMore ? showMoreLimit : limit);
         var withMaxValuesPerFacet = withFacetConfiguration.setQueryParameter('maxValuesPerFacet', nextMaxValuesPerFacet);

package/cjs/connectors/toggle-refinement/connectToggleRefinement.js

@@ -283,7 +283,7 @@ var connectToggleRefinement = function connectToggleRefinement(renderFn) {
           process.env.NODE_ENV === 'development' ? (0, _utils.warning)(false, "ToggleRefinement: Attribute \"".concat(attribute, "\" is already used by another widget of a different type.\nAs this is not supported, please make sure to remove this other widget or this ToggleRefinement widget will not work at all.")) : void 0;
           return searchParameters;
         }
-        var withFacetConfiguration = searchParameters.clearRefinements(attribute).addDisjunctiveFacet(attribute);
+        var withFacetConfiguration = searchParameters.addDisjunctiveFacet(attribute).removeDisjunctiveFacetRefinement(attribute);
         var isRefined = Boolean(uiState.toggle && uiState.toggle[attribute]);
         if (isRefined) {
           if (on) {

package/cjs/lib/InstantSearch.js

@@ -365,9 +365,7 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
 
     /**
      * Ends the initialization of InstantSearch.js and triggers the
-     * first search. This method should be called after all widgets have been added
-     * to the instance of InstantSearch.js. InstantSearch.js also supports adding and removing
-     * widgets after the start as an **EXPERIMENTAL** feature.
+     * first search.
      */
   }, {
     key: "start",
@@ -519,9 +517,7 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
     }
 
     /**
-     * Removes all widgets without triggering a search afterwards. This is an **EXPERIMENTAL** feature,
-     * if you find an issue with it, please
-     * [open an issue](https://github.com/algolia/instantsearch/issues/new?title=Problem%20with%20dispose).
+     * Removes all widgets without triggering a search afterwards.
      * @return {undefined} This method does not return anything
      */
   }, {

package/cjs/lib/server.js

@@ -18,12 +18,26 @@ function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input ==
  */
 function waitForResults(search) {
   var helper = search.mainHelper;
+
+  // Extract search parameters from the search client to use them
+  // later during hydration.
+  var requestParamsList;
+  var client = helper.getClient();
+  helper.setClient({
+    search: function search(queries) {
+      requestParamsList = queries.map(function (_ref) {
+        var params = _ref.params;
+        return params;
+      });
+      return client.search(queries);
+    }
+  });
   helper.searchOnlyWithDerivedHelpers();
   return new Promise(function (resolve, reject) {
     // All derived helpers resolve in the same tick so we're safe only relying
     // on the first one.
     helper.derivedHelpers[0].on('result', function () {
-      resolve();
+      resolve(requestParamsList);
     });
 
     // However, we listen to errors that can happen on any derived helper because
@@ -45,17 +59,26 @@ function waitForResults(search) {
 /**
  * Walks the InstantSearch root index to construct the initial results.
  */
-function getInitialResults(rootIndex) {
+function getInitialResults(rootIndex,
+/**
+ * Search parameters sent to the search client,
+ * returned by `waitForResults()`.
+ */
+requestParamsList) {
   var initialResults = {};
+  var requestParamsIndex = 0;
   (0, _utils.walkIndex)(rootIndex, function (widget) {
     var searchResults = widget.getResults();
     if (searchResults) {
-      initialResults[widget.getIndexId()] = {
+      var requestParams = requestParamsList === null || requestParamsList === void 0 ? void 0 : requestParamsList[requestParamsIndex++];
+      initialResults[widget.getIndexId()] = _objectSpread({
         // We convert the Helper state to a plain object to pass parsable data
         // structures from server to client.
         state: _objectSpread({}, searchResults._state),
         results: searchResults._rawResults
-      };
+      }, requestParams && {
+        requestParams: requestParams
+      });
     }
   });
   if (Object.keys(initialResults).length === 0) {

package/cjs/lib/utils/hydrateSearchClient.js

@@ -29,13 +29,16 @@ function hydrateSearchClient(client, results) {
     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 _results$key = results[key],
+      state = _results$key.state,
+      requestParams = _results$key.requestParams,
+      serverResults = _results$key.results;
+    return serverResults.map(function (result) {
+      return _objectSpread({
+        indexName: state.index || result.index
+      }, requestParams || result.params ? {
+        params: serializeQueryParameters(requestParams || deserializeQueryParameters(result.params))
+      } : {});
     });
   });
   var cachedResults = Object.keys(results).reduce(function (acc, key) {

package/cjs/lib/version.js

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

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

@@ -29,6 +29,7 @@ var renderer = function renderer(_ref) {
     templates = _ref.templates,
     autofocus = _ref.autofocus,
     searchAsYouType = _ref.searchAsYouType,
+    ignoreCompositionEvents = _ref.ignoreCompositionEvents,
     showReset = _ref.showReset,
     showSubmit = _ref.showSubmit,
     showLoadingIndicator = _ref.showLoadingIndicator;
@@ -42,6 +43,7 @@ var renderer = function renderer(_ref) {
       autofocus: autofocus,
       refine: refine,
       searchAsYouType: searchAsYouType,
+      ignoreCompositionEvents: ignoreCompositionEvents,
       templates: templates,
       showSubmit: showSubmit,
       showReset: showReset,
@@ -72,6 +74,8 @@ var searchBox = function searchBox(widgetParams) {
     autofocus = _ref3$autofocus === void 0 ? false : _ref3$autofocus,
     _ref3$searchAsYouType = _ref3.searchAsYouType,
     searchAsYouType = _ref3$searchAsYouType === void 0 ? true : _ref3$searchAsYouType,
+    _ref3$ignoreCompositi = _ref3.ignoreCompositionEvents,
+    ignoreCompositionEvents = _ref3$ignoreCompositi === void 0 ? false : _ref3$ignoreCompositi,
     _ref3$showReset = _ref3.showReset,
     showReset = _ref3$showReset === void 0 ? true : _ref3$showReset,
     _ref3$showSubmit = _ref3.showSubmit,
@@ -120,6 +124,7 @@ var searchBox = function searchBox(widgetParams) {
     templates: templates,
     autofocus: autofocus,
     searchAsYouType: searchAsYouType,
+    ignoreCompositionEvents: ignoreCompositionEvents,
     showReset: showReset,
     showSubmit: showSubmit,
     showLoadingIndicator: showLoadingIndicator

package/dist/instantsearch.development.d.ts

@@ -15,6 +15,7 @@ import type * as Places from 'places.js';
 import type { PlainSearchParameters } from 'algoliasearch-helper';
 import { default as qs_2 } from 'qs';
 import { SearchClient } from 'algoliasearch-helper/types/algoliasearch.js';
+import { SearchOptions } from 'algoliasearch-helper/types/algoliasearch.js';
 import type { SearchParameters } from 'algoliasearch-helper';
 import type { SearchResults } from 'algoliasearch-helper';
 import { VNode } from 'preact';
@@ -2310,6 +2311,7 @@ declare type InfiniteHitsWidgetParams = {
 declare type InitialResult = {
     state: PlainSearchParameters;
     results: SearchResults['_rawResults'];
+    requestParams?: SearchOptions;
 };
 
 declare type InitialResults = Record<string, InitialResult>;
@@ -2455,15 +2457,11 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
     removeWidgets(widgets: Array<Widget | IndexWidget>): this;
     /**
      * Ends the initialization of InstantSearch.js and triggers the
-     * first search. This method should be called after all widgets have been added
-     * to the instance of InstantSearch.js. InstantSearch.js also supports adding and removing
-     * widgets after the start as an **EXPERIMENTAL** feature.
+     * first search.
      */
     start(): void;
     /**
-     * Removes all widgets without triggering a search afterwards. This is an **EXPERIMENTAL** feature,
-     * if you find an issue with it, please
-     * [open an issue](https://github.com/algolia/instantsearch/issues/new?title=Problem%20with%20dispose).
+     * Removes all widgets without triggering a search afterwards.
      * @return {undefined} This method does not return anything
      */
     dispose(): void;
@@ -4824,6 +4822,12 @@ declare type SearchBoxWidgetParams = {
      * once `<Enter>` is pressed only.
      */
     searchAsYouType?: boolean;
+    /**
+     * Whether to update the search state in the middle of a
+     * composition session.
+     * @default false
+     */
+    ignoreCompositionEvents?: boolean;
     /**
      * Whether to show the reset button
      */

package/dist/instantsearch.development.js

@@ -1,4 +1,4 @@
-/*! InstantSearch.js 4.64.0 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch */
+/*! InstantSearch.js 4.64.2 | © 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) :
@@ -1424,13 +1424,16 @@
       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 _results$key = results[key],
+        state = _results$key.state,
+        requestParams = _results$key.requestParams,
+        serverResults = _results$key.results;
+      return serverResults.map(function (result) {
+        return _objectSpread2({
+          indexName: state.index || result.index
+        }, requestParams || result.params ? {
+          params: serializeQueryParameters(requestParams || deserializeQueryParameters(result.params))
+        } : {});
       });
     });
     var cachedResults = Object.keys(results).reduce(function (acc, key) {
@@ -3588,7 +3591,7 @@
         dispose: function dispose(_ref4) {
           var state = _ref4.state;
           unmountFn();
-          return state.clearRefinements(attribute);
+          return state.removeNumericRefinement(attribute);
         },
         getWidgetUiState: function getWidgetUiState(uiState, _ref5) {
           var searchParameters = _ref5.searchParameters;
@@ -3608,11 +3611,11 @@
         getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref6) {
           var uiState = _ref6.uiState;
           var value = uiState.numericMenu && uiState.numericMenu[attribute];
-          var withoutRefinements = searchParameters.clearRefinements(attribute);
+          var withoutRefinements = searchParameters.setQueryParameters({
+            numericRefinements: _objectSpread2(_objectSpread2({}, searchParameters.numericRefinements), {}, _defineProperty({}, attribute, {}))
+          });
           if (!value) {
-            return withoutRefinements.setQueryParameters({
-              numericRefinements: _objectSpread2(_objectSpread2({}, withoutRefinements.numericRefinements), {}, _defineProperty({}, attribute, {}))
-            });
+            return withoutRefinements;
           }
           var isExact = value.indexOf(':') === -1;
           if (isExact) {
@@ -4478,8 +4481,7 @@
             return searchParameters;
           }
           var values = uiState.refinementList && uiState.refinementList[attribute];
-          var withoutRefinements = searchParameters.clearRefinements(attribute);
-          var withFacetConfiguration = isDisjunctive ? withoutRefinements.addDisjunctiveFacet(attribute) : withoutRefinements.addFacet(attribute);
+          var withFacetConfiguration = isDisjunctive ? searchParameters.addDisjunctiveFacet(attribute).removeDisjunctiveFacetRefinement(attribute) : searchParameters.addFacet(attribute).removeFacetRefinement(attribute);
           var currentMaxValuesPerFacet = withFacetConfiguration.maxValuesPerFacet || 0;
           var nextMaxValuesPerFacet = Math.max(currentMaxValuesPerFacet, showMore ? showMoreLimit : limit);
           var withMaxValuesPerFacet = withFacetConfiguration.setQueryParameter('maxValuesPerFacet', nextMaxValuesPerFacet);
@@ -4947,8 +4949,7 @@
         getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref8) {
           var uiState = _ref8.uiState;
           var value = uiState.ratingMenu && uiState.ratingMenu[attribute];
-          var withoutRefinements = searchParameters.clearRefinements(attribute);
-          var withDisjunctiveFacet = withoutRefinements.addDisjunctiveFacet(attribute);
+          var withDisjunctiveFacet = searchParameters.addDisjunctiveFacet(attribute).removeNumericRefinement(attribute).removeDisjunctiveFacetRefinement(attribute);
           if (!value) {
             return withDisjunctiveFacet.setQueryParameters({
               numericRefinements: _objectSpread2(_objectSpread2({}, withDisjunctiveFacet.numericRefinements), {}, _defineProperty({}, attribute, {}))
@@ -5306,7 +5307,7 @@
              _warning(false, "ToggleRefinement: Attribute \"".concat(attribute, "\" is already used by another widget of a different type.\nAs this is not supported, please make sure to remove this other widget or this ToggleRefinement widget will not work at all.")) ;
             return searchParameters;
           }
-          var withFacetConfiguration = searchParameters.clearRefinements(attribute).addDisjunctiveFacet(attribute);
+          var withFacetConfiguration = searchParameters.addDisjunctiveFacet(attribute).removeDisjunctiveFacetRefinement(attribute);
           var isRefined = Boolean(uiState.toggle && uiState.toggle[attribute]);
           if (isRefined) {
             if (on) {
@@ -6521,9 +6522,12 @@
         .sort()
         .forEach(function (facetName) {
           var facetValues = facetsRefinements[facetName] || [];
-          facetValues.sort().forEach(function (facetValue) {
-            facetFilters.push(facetName + ':' + facetValue);
-          });
+          facetValues
+            .slice()
+            .sort()
+            .forEach(function (facetValue) {
+              facetFilters.push(facetName + ':' + facetValue);
+            });
         });
 
       var facetsExcludes = state.facetsExcludes || {};
@@ -6546,9 +6550,12 @@
           }
           var orFilters = [];
 
-          facetValues.sort().forEach(function (facetValue) {
-            orFilters.push(facetName + ':' + facetValue);
-          });
+          facetValues
+            .slice()
+            .sort()
+            .forEach(function (facetValue) {
+              orFilters.push(facetName + ':' + facetValue);
+            });
 
           facetFilters.push(orFilters);
         });
@@ -7214,7 +7221,7 @@
       numbers.numericRefinements = numericRefinements;
     }
 
-    return merge_1({}, partialState, numbers);
+    return merge_1(partialState, numbers);
   };
 
   /**
@@ -10086,7 +10093,7 @@
 
   var SearchResults_1 = SearchResults;
 
-  var version = '3.16.1';
+  var version = '3.16.2';
 
   var escapeFacetValue$4 = escapeFacetValue_1.escapeFacetValue;
 
@@ -14883,7 +14890,7 @@
     };
   }
 
-  var version$1 = '4.64.0';
+  var version$1 = '4.64.2';
 
   var withUsage$r = createDocumentationMessageGenerator({
     name: 'instantsearch'
@@ -15219,9 +15226,7 @@
 
       /**
        * Ends the initialization of InstantSearch.js and triggers the
-       * first search. This method should be called after all widgets have been added
-       * to the instance of InstantSearch.js. InstantSearch.js also supports adding and removing
-       * widgets after the start as an **EXPERIMENTAL** feature.
+       * first search.
        */
     }, {
       key: "start",
@@ -15373,9 +15378,7 @@
       }
 
       /**
-       * Removes all widgets without triggering a search afterwards. This is an **EXPERIMENTAL** feature,
-       * if you find an issue with it, please
-       * [open an issue](https://github.com/algolia/instantsearch/issues/new?title=Problem%20with%20dispose).
+       * Removes all widgets without triggering a search afterwards.
        * @return {undefined} This method does not return anything
        */
     }, {
@@ -18036,6 +18039,7 @@
     showLoadingIndicator: true,
     autofocus: false,
     searchAsYouType: true,
+    ignoreCompositionEvents: false,
     isSearchStalled: false,
     disabled: false,
     ariaLabel: 'Search',
@@ -18065,7 +18069,7 @@
           refine = _this$props.refine,
           onChange = _this$props.onChange;
         var query = event.target.value;
-        if (event.type === 'compositionend' || !event.isComposing) {
+        if (!(_this.props.ignoreCompositionEvents && event.isComposing)) {
           if (searchAsYouType) {
             refine(query);
           }
@@ -21823,6 +21827,7 @@
       templates = _ref.templates,
       autofocus = _ref.autofocus,
       searchAsYouType = _ref.searchAsYouType,
+      ignoreCompositionEvents = _ref.ignoreCompositionEvents,
       showReset = _ref.showReset,
       showSubmit = _ref.showSubmit,
       showLoadingIndicator = _ref.showLoadingIndicator;
@@ -21836,6 +21841,7 @@
         autofocus: autofocus,
         refine: refine,
         searchAsYouType: searchAsYouType,
+        ignoreCompositionEvents: ignoreCompositionEvents,
         templates: templates,
         showSubmit: showSubmit,
         showReset: showReset,
@@ -21866,6 +21872,8 @@
       autofocus = _ref3$autofocus === void 0 ? false : _ref3$autofocus,
       _ref3$searchAsYouType = _ref3.searchAsYouType,
       searchAsYouType = _ref3$searchAsYouType === void 0 ? true : _ref3$searchAsYouType,
+      _ref3$ignoreCompositi = _ref3.ignoreCompositionEvents,
+      ignoreCompositionEvents = _ref3$ignoreCompositi === void 0 ? false : _ref3$ignoreCompositi,
       _ref3$showReset = _ref3.showReset,
       showReset = _ref3$showReset === void 0 ? true : _ref3$showReset,
       _ref3$showSubmit = _ref3.showSubmit,
@@ -21914,6 +21922,7 @@
       templates: templates,
       autofocus: autofocus,
       searchAsYouType: searchAsYouType,
+      ignoreCompositionEvents: ignoreCompositionEvents,
       showReset: showReset,
       showSubmit: showSubmit,
       showLoadingIndicator: showLoadingIndicator