instantsearch.js 4.64.0 → 4.64.2

package/es/components/SearchBox/SearchBox.d.ts

@@ -16,6 +16,7 @@ type SearchBoxProps = {
     refine?: (value: string) => void;
     autofocus?: boolean;
     searchAsYouType?: boolean;
+    ignoreCompositionEvents?: boolean;
     isSearchStalled?: boolean;
     disabled?: boolean;
     ariaLabel?: string;
@@ -30,6 +31,7 @@ declare const defaultProps: {
     showLoadingIndicator: boolean;
     autofocus: boolean;
     searchAsYouType: boolean;
+    ignoreCompositionEvents: boolean;
     isSearchStalled: boolean;
     disabled: boolean;
     ariaLabel: string;
@@ -51,6 +53,7 @@ declare class SearchBox extends Component<SearchBoxPropsWithDefaultProps, Search
         showLoadingIndicator: boolean;
         autofocus: boolean;
         searchAsYouType: boolean;
+        ignoreCompositionEvents: boolean;
         isSearchStalled: boolean;
         disabled: boolean;
         ariaLabel: string;

package/es/components/SearchBox/SearchBox.js

@@ -22,6 +22,7 @@ var defaultProps = {
   showLoadingIndicator: true,
   autofocus: false,
   searchAsYouType: true,
+  ignoreCompositionEvents: false,
   isSearchStalled: false,
   disabled: false,
   ariaLabel: 'Search',
@@ -51,7 +52,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/es/connectors/numeric-menu/connectNumericMenu.js

@@ -82,7 +82,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;
@@ -102,11 +102,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/es/connectors/rating-menu/connectRatingMenu.js

@@ -263,8 +263,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/es/connectors/refinement-list/connectRefinementList.js

@@ -259,8 +259,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/es/connectors/toggle-refinement/connectToggleRefinement.js

@@ -277,7 +277,7 @@ var connectToggleRefinement = function connectToggleRefinement(renderFn) {
           process.env.NODE_ENV === 'development' ? 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/es/lib/InstantSearch.d.ts

@@ -205,15 +205,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;

package/es/lib/InstantSearch.js

@@ -357,9 +357,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",
@@ -511,9 +509,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/es/lib/server.d.ts

@@ -1,10 +1,15 @@
-import type { IndexWidget, InitialResults, InstantSearch } from '../types';
+import type { IndexWidget, InitialResults, InstantSearch, SearchOptions } from '../types';
 /**
  * Waits for the results from the search instance to coordinate the next steps
  * in `getServerState()`.
  */
-export declare function waitForResults(search: InstantSearch): Promise<void>;
+export declare function waitForResults(search: InstantSearch): Promise<SearchOptions[]>;
 /**
  * Walks the InstantSearch root index to construct the initial results.
  */
-export declare function getInitialResults(rootIndex: IndexWidget): InitialResults;
+export declare function getInitialResults(rootIndex: IndexWidget, 
+/**
+ * Search parameters sent to the search client,
+ * returned by `waitForResults()`.
+ */
+requestParamsList?: SearchOptions[]): InitialResults;

package/es/lib/server.js

@@ -11,12 +11,26 @@ import { walkIndex } from "./utils/index.js";
  */
 export 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
@@ -38,17 +52,26 @@ export function waitForResults(search) {
 /**
  * Walks the InstantSearch root index to construct the initial results.
  */
-export function getInitialResults(rootIndex) {
+export 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({
         // 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/es/lib/utils/hydrateSearchClient.js

@@ -23,13 +23,16 @@ export 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/es/lib/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "4.64.0";
+declare const _default: "4.64.2";
 export default _default;

package/es/lib/version.js

@@ -1 +1 @@
-export default '4.64.0';
+export default '4.64.2';

package/es/types/results.d.ts

@@ -1,3 +1,4 @@
+import type { SearchOptions } from './algoliasearch';
 import type { PlainSearchParameters, SearchForFacetValues, SearchResults } from 'algoliasearch-helper';
 export type HitAttributeHighlightResult = {
     value: string;
@@ -66,6 +67,7 @@ export type Refinement = FacetRefinement | NumericRefinement;
 type InitialResult = {
     state: PlainSearchParameters;
     results: SearchResults['_rawResults'];
+    requestParams?: SearchOptions;
 };
 export type InitialResults = Record<string, InitialResult>;
 export {};

package/es/widgets/search-box/search-box.d.ts

@@ -78,6 +78,12 @@ export 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/es/widgets/search-box/search-box.js

@@ -22,6 +22,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;
@@ -35,6 +36,7 @@ var renderer = function renderer(_ref) {
       autofocus: autofocus,
       refine: refine,
       searchAsYouType: searchAsYouType,
+      ignoreCompositionEvents: ignoreCompositionEvents,
       templates: templates,
       showSubmit: showSubmit,
       showReset: showReset,
@@ -65,6 +67,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,
@@ -113,6 +117,7 @@ var searchBox = function searchBox(widgetParams) {
     templates: templates,
     autofocus: autofocus,
     searchAsYouType: searchAsYouType,
+    ignoreCompositionEvents: ignoreCompositionEvents,
     showReset: showReset,
     showSubmit: showSubmit,
     showLoadingIndicator: showLoadingIndicator

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "instantsearch.js",
-  "version": "4.64.0",
+  "version": "4.64.2",
   "description": "InstantSearch.js is a JavaScript library for building performant and instant search experiences with Algolia.",
   "homepage": "https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/",
   "types": "es/index.d.ts",
@@ -33,7 +33,7 @@
     "@types/google.maps": "^3.45.3",
     "@types/hogan.js": "^3.0.0",
     "@types/qs": "^6.5.3",
-    "algoliasearch-helper": "3.16.1",
+    "algoliasearch-helper": "3.16.2",
     "hogan.js": "^3.0.2",
     "htm": "^3.0.0",
     "preact": "^10.10.0",
@@ -55,9 +55,9 @@
     "version": "./scripts/version/update-version.js"
   },
   "devDependencies": {
-    "@instantsearch/mocks": "1.34.0",
-    "@instantsearch/tests": "1.34.0",
-    "@instantsearch/testutils": "1.23.0",
+    "@instantsearch/mocks": "1.36.0",
+    "@instantsearch/tests": "1.36.0",
+    "@instantsearch/testutils": "1.25.0",
     "@storybook/html": "5.3.9",
     "@types/scriptjs": "0.0.2",
     "algoliasearch": "4.14.3",
@@ -65,5 +65,5 @@
     "scriptjs": "2.5.9",
     "webpack": "4.47.0"
   },
-  "gitHead": "d1e415e522b9d43162a6ca3a16c6c450dfa8b457"
+  "gitHead": "c8411331353d700fab508849c7e93f782f37e4e6"
 }