instantsearch.js 4.63.1 → 4.64.0

package/cjs/lib/version.js

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

package/cjs/middlewares/createInsightsMiddleware.js

@@ -80,8 +80,11 @@ function createInsightsMiddleware() {
     // search-insights.js also throws an error so dev-only clarification is sufficient
     process.env.NODE_ENV === 'development' ? (0, _utils.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,
@@ -92,22 +95,32 @@ 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 = (0, _utils.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 = (0, _utils.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.
@@ -189,21 +202,43 @@ 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) {
@@ -239,6 +274,7 @@ function createInsightsMiddleware() {
       },
       unsubscribe: function unsubscribe() {
         insightsClient('onUserTokenChange', undefined);
+        insightsClient('onAuthenticatedUserTokenChange', undefined);
         instantSearchInstance.sendEventToInsights = _utils.noop;
         if (helper && initialParameters) {
           helper.overrideStateWithoutTriggeringChangeEvent(_objectSpread(_objectSpread({}, helper.state), initialParameters));

package/dist/instantsearch.development.js

@@ -1,4 +1,4 @@
-/*! InstantSearch.js 4.63.1 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch */
+/*! InstantSearch.js 4.64.0 | © 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) :
@@ -12789,8 +12789,11 @@
       // search-insights.js also throws an error so dev-only clarification is sufficient
        _warning(Boolean(appId && apiKey), 'could not extract Algolia credentials from searchClient in insights middleware.') ;
       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,
@@ -12801,22 +12804,32 @@
         // 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.
@@ -12898,21 +12911,43 @@
             // 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) {
@@ -12948,6 +12983,7 @@
         },
         unsubscribe: function unsubscribe() {
           insightsClient('onUserTokenChange', undefined);
+          insightsClient('onAuthenticatedUserTokenChange', undefined);
           instantSearchInstance.sendEventToInsights = noop;
           if (helper && initialParameters) {
             helper.overrideStateWithoutTriggeringChangeEvent(_objectSpread2(_objectSpread2({}, helper.state), initialParameters));
@@ -14847,7 +14883,7 @@
     };
   }
 
-  var version$1 = '4.63.1';
+  var version$1 = '4.64.0';
 
   var withUsage$r = createDocumentationMessageGenerator({
     name: 'instantsearch'