react-instantsearch 7.5.2 → 7.5.4

package/dist/cjs/widgets/SearchBox.js

@@ -8,7 +8,7 @@ exports.SearchBox = SearchBox;
 var _react = _interopRequireWildcard(require("react"));
 var _reactInstantsearchCore = require("react-instantsearch-core");
 var _SearchBox = require("../ui/SearchBox");
-var _excluded = ["queryHook", "searchAsYouType", "translations"];
+var _excluded = ["queryHook", "searchAsYouType", "ignoreCompositionEvents", "translations"];
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
@@ -29,6 +29,8 @@ function SearchBox(_ref) {
   var queryHook = _ref.queryHook,
     _ref$searchAsYouType = _ref.searchAsYouType,
     searchAsYouType = _ref$searchAsYouType === void 0 ? true : _ref$searchAsYouType,
+    _ref$ignoreCompositio = _ref.ignoreCompositionEvents,
+    ignoreCompositionEvents = _ref$ignoreCompositio === void 0 ? false : _ref$ignoreCompositio,
     translations = _ref.translations,
     props = _objectWithoutProperties(_ref, _excluded);
   var _useSearchBox = (0, _reactInstantsearchCore.useSearchBox)({
@@ -45,9 +47,9 @@ function SearchBox(_ref) {
     setInputValue = _useState2[1];
   var inputRef = (0, _react.useRef)(null);
   function setQuery(newQuery) {
-    var compositionComplete = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : true;
+    var isComposing = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
     setInputValue(newQuery);
-    if (searchAsYouType && compositionComplete) {
+    if (searchAsYouType && !(ignoreCompositionEvents && isComposing)) {
       refine(newQuery);
     }
   }
@@ -58,8 +60,7 @@ function SearchBox(_ref) {
     }
   }
   function onChange(event) {
-    var compositionComplete = event.type === 'compositionend' || !event.nativeEvent.isComposing;
-    setQuery(event.currentTarget.value, compositionComplete);
+    setQuery(event.currentTarget.value, event.nativeEvent.isComposing);
   }
   function onSubmit(event) {
     if (!searchAsYouType) {

package/dist/es/widgets/SearchBox.d.ts

@@ -7,7 +7,13 @@ export type SearchBoxProps = Omit<SearchBoxUiComponentProps, Exclude<keyof UiPro
      * @default true
      */
     searchAsYouType?: boolean;
+    /**
+     * Whether to update the search state in the middle of a
+     * composition session.
+     * @default false
+     */
+    ignoreCompositionEvents?: boolean;
     translations?: Partial<UiProps['translations']>;
 };
-export declare function SearchBox({ queryHook, searchAsYouType, translations, ...props }: SearchBoxProps): JSX.Element;
+export declare function SearchBox({ queryHook, searchAsYouType, ignoreCompositionEvents, translations, ...props }: SearchBoxProps): JSX.Element;
 export {};

package/dist/es/widgets/SearchBox.js

@@ -1,5 +1,5 @@
 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); }
-var _excluded = ["queryHook", "searchAsYouType", "translations"];
+var _excluded = ["queryHook", "searchAsYouType", "ignoreCompositionEvents", "translations"];
 function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
 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; }
@@ -21,6 +21,8 @@ export function SearchBox(_ref) {
   var queryHook = _ref.queryHook,
     _ref$searchAsYouType = _ref.searchAsYouType,
     searchAsYouType = _ref$searchAsYouType === void 0 ? true : _ref$searchAsYouType,
+    _ref$ignoreCompositio = _ref.ignoreCompositionEvents,
+    ignoreCompositionEvents = _ref$ignoreCompositio === void 0 ? false : _ref$ignoreCompositio,
     translations = _ref.translations,
     props = _objectWithoutProperties(_ref, _excluded);
   var _useSearchBox = useSearchBox({
@@ -37,9 +39,9 @@ export function SearchBox(_ref) {
     setInputValue = _useState2[1];
   var inputRef = useRef(null);
   function setQuery(newQuery) {
-    var compositionComplete = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : true;
+    var isComposing = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
     setInputValue(newQuery);
-    if (searchAsYouType && compositionComplete) {
+    if (searchAsYouType && !(ignoreCompositionEvents && isComposing)) {
       refine(newQuery);
     }
   }
@@ -50,8 +52,7 @@ export function SearchBox(_ref) {
     }
   }
   function onChange(event) {
-    var compositionComplete = event.type === 'compositionend' || !event.nativeEvent.isComposing;
-    setQuery(event.currentTarget.value, compositionComplete);
+    setQuery(event.currentTarget.value, event.nativeEvent.isComposing);
   }
   function onSubmit(event) {
     if (!searchAsYouType) {

package/dist/umd/ReactInstantSearch.js

@@ -7,7 +7,7 @@
 
   var React__default = 'default' in React ? React['default'] : React;
 
-  var version = '7.5.2';
+  var version = '7.5.4';
 
   // Copyright Joyent, Inc. and other Node contributors.
   //
@@ -772,9 +772,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 || {};
@@ -797,9 +800,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);
         });
@@ -1465,7 +1471,7 @@
       numbers.numericRefinements = numericRefinements;
     }
 
-    return merge_1({}, partialState, numbers);
+    return merge_1(partialState, numbers);
   };
 
   /**
@@ -4337,7 +4343,7 @@
 
   var SearchResults_1 = SearchResults;
 
-  var version$1 = '3.16.1';
+  var version$1 = '3.16.2';
 
   var escapeFacetValue$3 = escapeFacetValue_1.escapeFacetValue;
 
@@ -7637,13 +7643,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 _objectSpread$5({
+          indexName: state.index || result.index
+        }, requestParams || result.params ? {
+          params: serializeQueryParameters(requestParams || deserializeQueryParameters(result.params))
+        } : {});
       });
     });
     var cachedResults = Object.keys(results).reduce(function (acc, key) {
@@ -12195,7 +12204,7 @@
     };
   }
 
-  var version$3 = '4.64.0';
+  var version$3 = '4.64.2';
 
   function _typeof$o(obj) {
     "@babel/helpers - typeof";
@@ -12663,9 +12672,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",
@@ -12816,9 +12823,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
        */
     }, {
@@ -16032,7 +16037,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;
@@ -16052,11 +16057,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: _objectSpread$u(_objectSpread$u({}, searchParameters.numericRefinements), {}, _defineProperty$v({}, attribute, {}))
+          });
           if (!value) {
-            return withoutRefinements.setQueryParameters({
-              numericRefinements: _objectSpread$u(_objectSpread$u({}, withoutRefinements.numericRefinements), {}, _defineProperty$v({}, attribute, {}))
-            });
+            return withoutRefinements;
           }
           var isExact = value.indexOf(':') === -1;
           if (isExact) {
@@ -17494,8 +17499,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);
@@ -18344,7 +18348,7 @@
           if (searchParameters.isHierarchicalFacet(attribute) || searchParameters.isConjunctiveFacet(attribute)) {
             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) {
@@ -18694,12 +18698,26 @@
    */
   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
@@ -18721,17 +18739,26 @@
   /**
    * 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;
     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$D({
           // We convert the Helper state to a plain object to pass parsable data
           // structures from server to client.
           state: _objectSpread$D({}, searchResults._state),
           results: searchResults._rawResults
-        };
+        }, requestParams && {
+          requestParams: requestParams
+        });
       }
     });
     if (Object.keys(initialResults).length === 0) {
@@ -18816,9 +18843,9 @@
         throw new Error("Unable to retrieve InstantSearch's server state in `getServerState()`. Did you mount the <InstantSearch> component?");
       }
       return waitForResults(searchRef.current);
-    }).then(function () {
+    }).then(function (requestParamsList) {
       return {
-        initialResults: getInitialResults(searchRef.current.mainIndex)
+        initialResults: getInitialResults(searchRef.current.mainIndex, requestParamsList)
       };
     });
   }
@@ -20317,11 +20344,13 @@
     }));
   }
 
-  var _excluded$E = ["queryHook", "searchAsYouType", "translations"];
+  var _excluded$E = ["queryHook", "searchAsYouType", "ignoreCompositionEvents", "translations"];
   function SearchBox$1(_ref) {
     var queryHook = _ref.queryHook,
       _ref$searchAsYouType = _ref.searchAsYouType,
       searchAsYouType = _ref$searchAsYouType === void 0 ? true : _ref$searchAsYouType,
+      _ref$ignoreCompositio = _ref.ignoreCompositionEvents,
+      ignoreCompositionEvents = _ref$ignoreCompositio === void 0 ? false : _ref$ignoreCompositio,
       translations = _ref.translations,
       props = _objectWithoutProperties$c(_ref, _excluded$E);
     var _useSearchBox = useSearchBox({
@@ -20338,9 +20367,9 @@
       setInputValue = _useState2[1];
     var inputRef = React.useRef(null);
     function setQuery(newQuery) {
-      var compositionComplete = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : true;
+      var isComposing = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
       setInputValue(newQuery);
-      if (searchAsYouType && compositionComplete) {
+      if (searchAsYouType && !(ignoreCompositionEvents && isComposing)) {
         refine(newQuery);
       }
     }
@@ -20351,8 +20380,7 @@
       }
     }
     function onChange(event) {
-      var compositionComplete = event.type === 'compositionend' || !event.nativeEvent.isComposing;
-      setQuery(event.currentTarget.value, compositionComplete);
+      setQuery(event.currentTarget.value, event.nativeEvent.isComposing);
     }
     function onSubmit(event) {
       if (!searchAsYouType) {