instantsearch.js 4.75.2 → 4.75.4

package/es/lib/utils/uuid.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Create UUID according to
+ * https://www.ietf.org/rfc/rfc4122.txt.
+ *
+ * @returns Generated UUID.
+ */
+export declare function createUUID(): string;

package/es/lib/utils/uuid.js

@@ -0,0 +1,15 @@
+/**
+ * Create UUID according to
+ * https://www.ietf.org/rfc/rfc4122.txt.
+ *
+ * @returns Generated UUID.
+ */
+export function createUUID() {
+  return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
+    /* eslint-disable no-bitwise */
+    var r = Math.random() * 16 | 0;
+    var v = c === 'x' ? r : r & 0x3 | 0x8;
+    /* eslint-enable */
+    return v.toString(16);
+  });
+}

package/es/lib/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "4.75.2";
+declare const _default: "4.75.4";
 export default _default;

package/es/lib/version.js

@@ -1 +1 @@
-export default '4.75.2';
+export default '4.75.4';

package/es/middlewares/createInsightsMiddleware.js

@@ -16,6 +16,7 @@ function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToAr
 function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
 import { getInsightsAnonymousUserTokenInternal } from "../helpers/index.js";
 import { warning, noop, getAppIdAndApiKey, find, safelyRunOnBrowser } from "../lib/utils/index.js";
+import { createUUID } from "../lib/utils/uuid.js";
 var ALGOLIA_INSIGHTS_VERSION = '2.15.0';
 var ALGOLIA_INSIGHTS_SRC = "https://cdn.jsdelivr.net/npm/search-insights@".concat(ALGOLIA_INSIGHTS_VERSION, "/dist/search-insights.min.js");
 export function createInsightsMiddleware() {
@@ -27,6 +28,7 @@ export function createInsightsMiddleware() {
     $$internal = _props$$$internal === void 0 ? false : _props$$$internal,
     _props$$$automatic = props.$$automatic,
     $$automatic = _props$$$automatic === void 0 ? false : _props$$$automatic;
+  var currentTokenType;
   var potentialInsightsClient = _insightsClient;
   if (!_insightsClient && _insightsClient !== null) {
     safelyRunOnBrowser(function (_ref) {
@@ -73,6 +75,7 @@ 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 queuedInitParams = undefined;
     var queuedUserToken = undefined;
     var queuedAuthenticatedUserToken = undefined;
     var userTokenBeforeInit = undefined;
@@ -89,7 +92,7 @@ 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 _map = ['setUserToken', 'setAuthenticatedUserToken'].map(function (key) {
+      var _map = ['setUserToken', 'setAuthenticatedUserToken', 'init'].map(function (key) {
         var _ref3 = find(queue.slice().reverse(), function (_ref5) {
             var _ref6 = _slicedToArray(_ref5, 1),
               method = _ref6[0];
@@ -99,9 +102,10 @@ export function createInsightsMiddleware() {
           value = _ref4[1];
         return value;
       });
-      var _map2 = _slicedToArray(_map, 2);
+      var _map2 = _slicedToArray(_map, 3);
       queuedUserToken = _map2[0];
       queuedAuthenticatedUserToken = _map2[1];
+      queuedInitParams = _map2[2];
     }
 
     // If user called `aa('setUserToken')` or `aa('setAuthenticatedUserToken')`
@@ -152,6 +156,23 @@ export function createInsightsMiddleware() {
       started: function started() {
         insightsClient('addAlgoliaAgent', 'insights-middleware');
         helper = instantSearchInstance.mainHelper;
+        var queueAtStart = insightsClient.queue;
+        if (Array.isArray(queueAtStart)) {
+          var _map3 = ['setUserToken', 'setAuthenticatedUserToken', 'init'].map(function (key) {
+            var _ref7 = find(queueAtStart.slice().reverse(), function (_ref9) {
+                var _ref10 = _slicedToArray(_ref9, 1),
+                  method = _ref10[0];
+                return method === key;
+              }) || [],
+              _ref8 = _slicedToArray(_ref7, 2),
+              value = _ref8[1];
+            return value;
+          });
+          var _map4 = _slicedToArray(_map3, 3);
+          queuedUserToken = _map4[0];
+          queuedAuthenticatedUserToken = _map4[1];
+          queuedInitParams = _map4[2];
+        }
         initialParameters = {
           userToken: helper.state.userToken,
           clickAnalytics: helper.state.clickAnalytics
@@ -167,8 +188,9 @@ export function createInsightsMiddleware() {
         if (!$$internal) {
           instantSearchInstance.scheduleSearch();
         }
-        var setUserTokenToSearch = function setUserTokenToSearch(userToken) {
-          var immediate = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
+        var setUserTokenToSearch = function setUserTokenToSearch(userToken, tokenType) {
+          var immediate = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
+          var unsetAuthenticatedUserToken = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : false;
           var normalizedUserToken = normalizeUserToken(userToken);
           if (!normalizedUserToken) {
             return;
@@ -181,6 +203,13 @@ export function createInsightsMiddleware() {
             if (existingToken && existingToken !== userToken) {
               instantSearchInstance.scheduleSearch();
             }
+            currentTokenType = tokenType;
+          }
+
+          // the authenticated user token cannot be overridden by a user or anonymous token
+          // for instant search query requests
+          if (currentTokenType && currentTokenType === 'authenticated' && tokenType === 'default' && !unsetAuthenticatedUserToken) {
+            return;
           }
 
           // Delay the token application to the next render cycle
@@ -190,14 +219,8 @@ export function createInsightsMiddleware() {
             applyToken();
           }
         };
-        var anonymousUserToken = getInsightsAnonymousUserTokenInternal();
-        if (anonymousUserToken) {
-          // When `aa('init', { ... })` is called, it creates an anonymous user token in cookie.
-          // We can set it as userToken.
-          setUserTokenToSearch(anonymousUserToken, true);
-        }
         function setUserToken(token, userToken, authenticatedUserToken) {
-          setUserTokenToSearch(token, true);
+          setUserTokenToSearch(token, authenticatedUserToken ? 'authenticated' : 'default', true);
           if (userToken) {
             insightsClient('setUserToken', userToken);
           }
@@ -205,19 +228,66 @@ export function createInsightsMiddleware() {
             insightsClient('setAuthenticatedUserToken', authenticatedUserToken);
           }
         }
+        var anonymousUserToken = undefined;
+        var anonymousTokenFromInsights = getInsightsAnonymousUserTokenInternal();
+        if (anonymousTokenFromInsights) {
+          // When `aa('init', { ... })` is called, it creates an anonymous user token in cookie.
+          // We can set it as userToken on instantsearch and insights. If it's not set as an insights
+          // userToken before a sendEvent, insights automatically generates a new anonymous token,
+          // causing a state change and an unnecessary query on instantsearch.
+          anonymousUserToken = anonymousTokenFromInsights;
+        } else {
+          var token = "anonymous-".concat(createUUID());
+          anonymousUserToken = token;
+        }
+        var authenticatedUserTokenFromInit;
+        var userTokenFromInit;
+
+        // With SSR, the token could be be set on the state. We make sure
+        // that insights is in sync with that token since, there is no
+        // insights lib on the server.
+        var tokenFromSearchParameters = initialParameters.userToken;
+
+        // When the first query is sent, the token is possibly not yet be set by
+        // the insights onChange callbacks (if insights isn't yet loaded).
+        // It is explicitly being set here so that the first query has the
+        // initial tokens set and ensure a second query isn't automatically
+        // made when the onChange callback actually changes the state.
+        if (insightsInitParams) {
+          if (insightsInitParams.authenticatedUserToken) {
+            authenticatedUserTokenFromInit = insightsInitParams.authenticatedUserToken;
+          } else if (insightsInitParams.userToken) {
+            userTokenFromInit = insightsInitParams.userToken;
+          }
+        }
 
         // We consider the `userToken` or `authenticatedUserToken` before an
-        // `init` call of higher importance than one from the queue.
+        // `init` call of higher importance than one from the queue and ones set
+        // from the init props to be higher than that.
+        var tokenFromInit = authenticatedUserTokenFromInit || userTokenFromInit;
         var tokenBeforeInit = authenticatedUserTokenBeforeInit || userTokenBeforeInit;
-        var queuedToken = queuedAuthenticatedUserToken || queuedUserToken;
-        if (tokenBeforeInit) {
+        var tokenFromQueue = queuedAuthenticatedUserToken || queuedUserToken;
+        if (tokenFromInit) {
+          setUserToken(tokenFromInit, userTokenFromInit, authenticatedUserTokenFromInit);
+        } else if (tokenFromSearchParameters) {
+          setUserToken(tokenFromSearchParameters, tokenFromSearchParameters, undefined);
+        } else if (tokenBeforeInit) {
           setUserToken(tokenBeforeInit, userTokenBeforeInit, authenticatedUserTokenBeforeInit);
-        } else if (queuedToken) {
-          setUserToken(queuedToken, queuedUserToken, queuedAuthenticatedUserToken);
+        } else if (tokenFromQueue) {
+          setUserToken(tokenFromQueue, queuedUserToken, queuedAuthenticatedUserToken);
+        } else if (anonymousUserToken) {
+          var _queuedInitParams;
+          setUserToken(anonymousUserToken, anonymousUserToken, undefined);
+          if (insightsInitParams !== null && insightsInitParams !== void 0 && insightsInitParams.useCookie || (_queuedInitParams = queuedInitParams) !== null && _queuedInitParams !== void 0 && _queuedInitParams.useCookie) {
+            var _queuedInitParams2;
+            saveTokenAsCookie(anonymousUserToken, (insightsInitParams === null || insightsInitParams === void 0 ? void 0 : insightsInitParams.cookieDuration) || ((_queuedInitParams2 = queuedInitParams) === null || _queuedInitParams2 === void 0 ? void 0 : _queuedInitParams2.cookieDuration));
+          }
         }
 
         // This updates userToken which is set explicitly by `aa('setUserToken', userToken)`
-        insightsClient('onUserTokenChange', setUserTokenToSearch, {
+        insightsClient('onUserTokenChange', function (token) {
+          return setUserTokenToSearch(token, 'default', true);
+        }, {
           immediate: true
         });
 
@@ -226,10 +296,10 @@ export function createInsightsMiddleware() {
           // If we're unsetting the `authenticatedUserToken`, we revert to the `userToken`
           if (!authenticatedUserToken) {
             insightsClient('getUserToken', null, function (_, userToken) {
-              setUserTokenToSearch(userToken);
+              setUserTokenToSearch(userToken, 'default', true, true);
             });
           }
-          setUserTokenToSearch(authenticatedUserToken);
+          setUserTokenToSearch(authenticatedUserToken, 'authenticated', true);
         }, {
           immediate: true
         });
@@ -247,10 +317,33 @@ export function createInsightsMiddleware() {
             return insightsClient(method, payload, extraParams);
           };
         }
+        var viewedObjectIDs = new Set();
+        var lastQueryId;
+        instantSearchInstance.mainHelper.derivedHelpers[0].on('result', function (_ref11) {
+          var results = _ref11.results;
+          if (!results.queryID || results.queryID !== lastQueryId) {
+            lastQueryId = results.queryID;
+            viewedObjectIDs.clear();
+          }
+        });
         instantSearchInstance.sendEventToInsights = function (event) {
           if (onEvent) {
             onEvent(event, insightsClientWithLocalCredentials);
           } else if (event.insightsMethod) {
+            if (event.insightsMethod === 'viewedObjectIDs') {
+              var _payload = event.payload;
+              var difference = _payload.objectIDs.filter(function (objectID) {
+                return !viewedObjectIDs.has(objectID);
+              });
+              if (difference.length === 0) {
+                return;
+              }
+              difference.forEach(function (objectID) {
+                return viewedObjectIDs.add(objectID);
+              });
+              _payload.objectIDs = difference;
+            }
+
             // Source is used to differentiate events sent by instantsearch from those sent manually.
             event.payload.algoliaSource = ['instantsearch'];
             if ($$automatic) {
@@ -278,6 +371,13 @@ export function createInsightsMiddleware() {
     };
   };
 }
+function saveTokenAsCookie(token, cookieDuration) {
+  var MONTH = 30 * 24 * 60 * 60 * 1000;
+  var d = new Date();
+  d.setTime(d.getTime() + (cookieDuration || MONTH * 6));
+  var expires = "expires=".concat(d.toUTCString());
+  document.cookie = "_ALGOLIA=".concat(token, ";").concat(expires, ";path=/");
+}
 
 /**
  * Determines if a given insights `client` supports the optional call to `init`

package/es/types/insights.d.ts

@@ -32,7 +32,7 @@ type QueueItemMap = {
         ...args: InsightsMethodMap[MethodName]
     ];
 };
-type QueueItem = QueueItemMap[keyof QueueItemMap];
+export type QueueItem = QueueItemMap[keyof QueueItemMap];
 export type InsightsClient = _InsightsClient & {
     queue?: QueueItem[];
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "instantsearch.js",
-  "version": "4.75.2",
+  "version": "4.75.4",
   "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",
@@ -56,9 +56,9 @@
     "watch:es": "yarn --silent build:es:base --watch"
   },
   "devDependencies": {
-    "@instantsearch/mocks": "1.60.0",
-    "@instantsearch/tests": "1.60.0",
-    "@instantsearch/testutils": "1.49.0",
+    "@instantsearch/mocks": "1.62.0",
+    "@instantsearch/tests": "1.62.0",
+    "@instantsearch/testutils": "1.51.0",
     "@storybook/html": "5.3.9",
     "@types/scriptjs": "0.0.2",
     "algoliasearch": "5.1.1",
@@ -66,5 +66,5 @@
     "scriptjs": "2.5.9",
     "webpack": "4.47.0"
   },
-  "gitHead": "c5f9a44d3f97363b1a0486a18696edbeafc193d5"
+  "gitHead": "9a088ad35f12bcaffaa0280a7c10b828a917e1cc"
 }