instantsearch.js 4.63.1 → 4.64.1

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.63.1";
+declare const _default: "4.64.1";
 export default _default;

package/es/lib/version.js

@@ -1 +1 @@
-export default '4.63.1';
+export default '4.64.1';

package/es/middlewares/createInsightsMiddleware.js

@@ -74,8 +74,11 @@ export function createInsightsMiddleware() {
     // search-insights.js also throws an error so dev-only clarification is sufficient
     process.env.NODE_ENV === 'development' ? warning(Boolean(appId && apiKey), 'could not extract Algolia credentials from searchClient in insights middleware.') : void 0;
     var queuedUserToken = undefined;
+    var queuedAuthenticatedUserToken = undefined;
     var userTokenBeforeInit = undefined;
-    if (Array.isArray(insightsClient.queue)) {
+    var authenticatedUserTokenBeforeInit = undefined;
+    var queue = insightsClient.queue;
+    if (Array.isArray(queue)) {
       // Context: The umd build of search-insights is asynchronously loaded by the snippet.
       //
       // When user calls `aa('setUserToken', 'my-user-token')` before `search-insights` is loaded,
@@ -86,22 +89,32 @@ export function createInsightsMiddleware() {
       // At this point, even though `search-insights` is not loaded yet,
       // we still want to read the token from the queue.
       // Otherwise, the first search call will be fired without the token.
-      var _ref3 = find(insightsClient.queue.slice().reverse(), function (_ref5) {
-        var _ref6 = _slicedToArray(_ref5, 1),
-          method = _ref6[0];
-        return method === 'setUserToken';
-      }) || [];
-      var _ref4 = _slicedToArray(_ref3, 2);
-      queuedUserToken = _ref4[1];
+      var _map = ['setUserToken', 'setAuthenticatedUserToken'].map(function (key) {
+        var _ref3 = find(queue.slice().reverse(), function (_ref5) {
+            var _ref6 = _slicedToArray(_ref5, 1),
+              method = _ref6[0];
+            return method === key;
+          }) || [],
+          _ref4 = _slicedToArray(_ref3, 2),
+          value = _ref4[1];
+        return value;
+      });
+      var _map2 = _slicedToArray(_map, 2);
+      queuedUserToken = _map2[0];
+      queuedAuthenticatedUserToken = _map2[1];
     }
+
+    // If user called `aa('setUserToken')` or `aa('setAuthenticatedUserToken')`
+    // before creating the Insights middleware, we temporarily store the token
+    // and set it later on.
+    //
+    // Otherwise, the `init` call might override them with anonymous user token.
     insightsClient('getUserToken', null, function (_error, userToken) {
-      // If user has called `aa('setUserToken', 'my-user-token')` before creating
-      // the `insights` middleware, we store them temporarily and
-      // set it later on.
-      //
-      // Otherwise, the `init` call might override it with anonymous user token.
       userTokenBeforeInit = normalizeUserToken(userToken);
     });
+    insightsClient('getAuthenticatedUserToken', null, function (_error, userToken) {
+      authenticatedUserTokenBeforeInit = normalizeUserToken(userToken);
+    });
 
     // Only `init` if the `insightsInitParams` option is passed or
     // if the `insightsClient` version doesn't supports optional `init` calling.
@@ -183,21 +196,43 @@ export function createInsightsMiddleware() {
           // We can set it as userToken.
           setUserTokenToSearch(anonymousUserToken, true);
         }
+        function setUserToken(token, userToken, authenticatedUserToken) {
+          setUserTokenToSearch(token, true);
+          if (userToken) {
+            insightsClient('setUserToken', userToken);
+          }
+          if (authenticatedUserToken) {
+            insightsClient('setAuthenticatedUserToken', authenticatedUserToken);
+          }
+        }
 
-        // We consider the `userToken` coming from a `init` call to have a higher
-        // importance than the one coming from the queue.
-        if (userTokenBeforeInit) {
-          setUserTokenToSearch(userTokenBeforeInit, true);
-          insightsClient('setUserToken', userTokenBeforeInit);
-        } else if (queuedUserToken) {
-          setUserTokenToSearch(queuedUserToken, true);
-          insightsClient('setUserToken', queuedUserToken);
+        // We consider the `userToken` or `authenticatedUserToken` before an
+        // `init` call of higher importance than one from the queue.
+        var tokenBeforeInit = authenticatedUserTokenBeforeInit || userTokenBeforeInit;
+        var queuedToken = queuedAuthenticatedUserToken || queuedUserToken;
+        if (tokenBeforeInit) {
+          setUserToken(tokenBeforeInit, userTokenBeforeInit, authenticatedUserTokenBeforeInit);
+        } else if (queuedToken) {
+          setUserToken(queuedToken, queuedUserToken, queuedAuthenticatedUserToken);
         }
 
         // This updates userToken which is set explicitly by `aa('setUserToken', userToken)`
         insightsClient('onUserTokenChange', setUserTokenToSearch, {
           immediate: true
         });
+
+        // This updates userToken which is set explicitly by `aa('setAuthenticatedtUserToken', authenticatedUserToken)`
+        insightsClient('onAuthenticatedUserTokenChange', function (authenticatedUserToken) {
+          // If we're unsetting the `authenticatedUserToken`, we revert to the `userToken`
+          if (!authenticatedUserToken) {
+            insightsClient('getUserToken', null, function (_, userToken) {
+              setUserTokenToSearch(userToken);
+            });
+          }
+          setUserTokenToSearch(authenticatedUserToken);
+        }, {
+          immediate: true
+        });
         var insightsClientWithLocalCredentials = insightsClient;
         if (isModernInsightsClient(insightsClient)) {
           insightsClientWithLocalCredentials = function insightsClientWithLocalCredentials(method, payload) {
@@ -233,6 +268,7 @@ export function createInsightsMiddleware() {
       },
       unsubscribe: function unsubscribe() {
         insightsClient('onUserTokenChange', undefined);
+        insightsClient('onAuthenticatedUserTokenChange', undefined);
         instantSearchInstance.sendEventToInsights = noop;
         if (helper && initialParameters) {
           helper.overrideStateWithoutTriggeringChangeEvent(_objectSpread(_objectSpread({}, helper.state), initialParameters));

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "instantsearch.js",
-  "version": "4.63.1",
+  "version": "4.64.1",
   "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.33.0",
-    "@instantsearch/tests": "1.33.0",
-    "@instantsearch/testutils": "1.22.0",
+    "@instantsearch/mocks": "1.35.0",
+    "@instantsearch/tests": "1.35.0",
+    "@instantsearch/testutils": "1.24.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": "4e99d1220b9c7872130f52bded4c1a84900bd0a3"
+  "gitHead": "3f061b181adf4358629406027eec8f79d2577196"
 }