instantsearch.js 4.54.1 → 4.56.0

package/cjs/lib/utils/createSendEventForFacet.js

@@ -6,6 +6,12 @@ Object.defineProperty(exports, "__esModule", {
 exports.createSendEventForFacet = createSendEventForFacet;
 var _isFacetRefined = require("./isFacetRefined");
 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); }
+function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+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; }
+function _iterableToArrayLimit(arr, i) { var _i = null == arr ? null : "undefined" != typeof Symbol && arr[Symbol.iterator] || arr["@@iterator"]; if (null != _i) { var _s, _e, _x, _r, _arr = [], _n = !0, _d = !1; try { if (_x = (_i = _i.call(arr)).next, 0 === i) { if (Object(_i) !== _i) return; _n = !1; } else for (; !(_n = (_s = _x.call(_i)).done) && (_arr.push(_s.value), _arr.length !== i); _n = !0); } catch (err) { _d = !0, _e = err; } finally { try { if (!_n && null != _i.return && (_r = _i.return(), Object(_r) !== _r)) return; } finally { if (_d) throw _e; } } return _arr; } }
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
 function createSendEventForFacet(_ref) {
   var instantSearchInstance = _ref.instantSearchInstance,
     helper = _ref.helper,
@@ -15,10 +21,13 @@ function createSendEventForFacet(_ref) {
     for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
       args[_key] = arguments[_key];
     }
-    var eventType = args[0],
-      facetValue = args[1],
+    var facetValue = args[1],
       _args$ = args[2],
       eventName = _args$ === void 0 ? 'Filter Applied' : _args$;
+    var _args$0$split = args[0].split(':'),
+      _args$0$split2 = _slicedToArray(_args$0$split, 2),
+      eventType = _args$0$split2[0],
+      eventModifier = _args$0$split2[1];
     var attribute = typeof attr === 'string' ? attr : attr(facetValue);
     if (args.length === 1 && _typeof(args[0]) === 'object') {
       instantSearchInstance.sendEventToInsights(args[0]);
@@ -29,6 +38,7 @@ function createSendEventForFacet(_ref) {
           insightsMethod: 'clickedFilters',
           widgetType: widgetType,
           eventType: eventType,
+          eventModifier: eventModifier,
           payload: {
             eventName: eventName,
             index: helper.getIndex(),

package/cjs/lib/utils/createSendEventForHits.js

@@ -3,9 +3,16 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports._buildEventPayloadsForHits = _buildEventPayloadsForHits;
 exports.createBindEventForHits = createBindEventForHits;
 exports.createSendEventForHits = createSendEventForHits;
 var _serializer = require("./serializer");
+function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+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; }
+function _iterableToArrayLimit(arr, i) { var _i = null == arr ? null : "undefined" != typeof Symbol && arr[Symbol.iterator] || arr["@@iterator"]; if (null != _i) { var _s, _e, _x, _r, _arr = [], _n = !0, _d = !1; try { if (_x = (_i = _i.call(arr)).next, 0 === i) { if (Object(_i) !== _i) return; _n = !1; } else for (; !(_n = (_s = _x.call(_i)).done) && (_arr.push(_s.value), _arr.length !== i); _n = !0); } catch (err) { _d = !0, _e = err; } finally { try { if (!_n && null != _i.return && (_r = _i.return(), Object(_r) !== _r)) return; } finally { if (_d) throw _e; } } return _arr; } }
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
 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); }
 function chunk(arr) {
   var chunkSize = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 20;
@@ -15,7 +22,7 @@ function chunk(arr) {
   }
   return chunks;
 }
-var buildPayloads = function buildPayloads(_ref) {
+function _buildEventPayloadsForHits(_ref) {
   var index = _ref.index,
     widgetType = _ref.widgetType,
     methodName = _ref.methodName,
@@ -25,7 +32,10 @@ var buildPayloads = function buildPayloads(_ref) {
   if (args.length === 1 && _typeof(args[0]) === 'object') {
     return [args[0]];
   }
-  var eventType = args[0];
+  var _args$0$split = args[0].split(':'),
+    _args$0$split2 = _slicedToArray(_args$0$split, 2),
+    eventType = _args$0$split2[0],
+    eventModifier = _args$0$split2[1];
   var hits = args[1];
   var eventName = args[2];
   if (!hits) {
@@ -72,7 +82,8 @@ var buildPayloads = function buildPayloads(_ref) {
           index: index,
           objectIDs: objectIDsByChunk[i]
         },
-        hits: batch
+        hits: batch,
+        eventModifier: eventModifier
       };
     });
   } else if (eventType === 'click') {
@@ -82,13 +93,14 @@ var buildPayloads = function buildPayloads(_ref) {
         widgetType: widgetType,
         eventType: eventType,
         payload: {
-          eventName: eventName,
+          eventName: eventName || 'Hit Clicked',
           index: index,
           queryID: queryID,
           objectIDs: objectIDsByChunk[i],
           positions: positionsByChunk[i]
         },
-        hits: batch
+        hits: batch,
+        eventModifier: eventModifier
       };
     });
   } else if (eventType === 'conversion') {
@@ -98,12 +110,13 @@ var buildPayloads = function buildPayloads(_ref) {
         widgetType: widgetType,
         eventType: eventType,
         payload: {
-          eventName: eventName,
+          eventName: eventName || 'Hit Converted',
           index: index,
           queryID: queryID,
           objectIDs: objectIDsByChunk[i]
         },
-        hits: batch
+        hits: batch,
+        eventModifier: eventModifier
       };
     });
   } else if (process.env.NODE_ENV === 'development') {
@@ -111,16 +124,18 @@ var buildPayloads = function buildPayloads(_ref) {
   } else {
     return [];
   }
-};
+}
 function createSendEventForHits(_ref2) {
   var instantSearchInstance = _ref2.instantSearchInstance,
     index = _ref2.index,
     widgetType = _ref2.widgetType;
+  var sentEvents = {};
+  var timer = undefined;
   var sendEventForHits = function sendEventForHits() {
     for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
       args[_key] = arguments[_key];
     }
-    var payloads = buildPayloads({
+    var payloads = _buildEventPayloadsForHits({
       widgetType: widgetType,
       index: index,
       methodName: 'sendEvent',
@@ -128,8 +143,16 @@ function createSendEventForHits(_ref2) {
       instantSearchInstance: instantSearchInstance
     });
     payloads.forEach(function (payload) {
-      return instantSearchInstance.sendEventToInsights(payload);
+      if (payload.eventType === 'click' && payload.eventModifier === 'internal' && sentEvents[payload.eventType]) {
+        return;
+      }
+      sentEvents[payload.eventType] = true;
+      instantSearchInstance.sendEventToInsights(payload);
     });
+    clearTimeout(timer);
+    timer = setTimeout(function () {
+      sentEvents = {};
+    }, 0);
   };
   return sendEventForHits;
 }
@@ -141,7 +164,7 @@ function createBindEventForHits(_ref3) {
     for (var _len2 = arguments.length, args = new Array(_len2), _key2 = 0; _key2 < _len2; _key2++) {
       args[_key2] = arguments[_key2];
     }
-    var payloads = buildPayloads({
+    var payloads = _buildEventPayloadsForHits({
       widgetType: widgetType,
       index: index,
       methodName: 'bindEvent',

package/cjs/lib/utils/render-args.js

@@ -26,13 +26,14 @@ function createInitArgs(instantSearchInstance, parent, uiState) {
 }
 function createRenderArgs(instantSearchInstance, parent) {
   var results = parent.getResults();
+  var helper = parent.getHelper();
   return {
-    helper: parent.getHelper(),
+    helper: helper,
     parent: parent,
     instantSearchInstance: instantSearchInstance,
     results: results,
     scopedResults: parent.getScopedResults(),
-    state: results._state,
+    state: results ? results._state : helper.state,
     renderState: instantSearchInstance.renderState,
     templatesConfig: instantSearchInstance.templatesConfig,
     createURL: parent.createURL,

package/cjs/lib/version.js

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

package/cjs/middlewares/createInsightsMiddleware.js

@@ -14,35 +14,69 @@ function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _ty
 function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
 function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
 function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
-function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
-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; }
 function _iterableToArrayLimit(arr, i) { var _i = null == arr ? null : "undefined" != typeof Symbol && arr[Symbol.iterator] || arr["@@iterator"]; if (null != _i) { var _s, _e, _x, _r, _arr = [], _n = !0, _d = !1; try { if (_x = (_i = _i.call(arr)).next, 0 === i) { if (Object(_i) !== _i) return; _n = !1; } else for (; !(_n = (_s = _x.call(_i)).done) && (_arr.push(_s.value), _arr.length !== i); _n = !0); } catch (err) { _d = !0, _e = err; } finally { try { if (!_n && null != _i.return && (_r = _i.return(), Object(_r) !== _r)) return; } finally { if (_d) throw _e; } } return _arr; } }
 function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
-function createInsightsMiddleware(props) {
-  var _ref = props || {},
-    _insightsClient = _ref.insightsClient,
-    insightsInitParams = _ref.insightsInitParams,
-    onEvent = _ref.onEvent;
-  if (_insightsClient !== null && !_insightsClient) {
-    if (process.env.NODE_ENV === 'development') {
-      throw new Error("The `insightsClient` option is required if you want userToken to be automatically set in search calls. If you don't want this behaviour, set it to `null`.");
-    } else {
-      throw new Error('The `insightsClient` option is required. To disable, set it to `null`.');
-    }
+function _toConsumableArray(arr) { return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread(); }
+function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+function _iterableToArray(iter) { if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter); }
+function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToArray(arr); }
+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; }
+var ALGOLIA_INSIGHTS_VERSION = '2.6.0';
+var ALGOLIA_INSIGHTS_SRC = "https://cdn.jsdelivr.net/npm/search-insights@".concat(ALGOLIA_INSIGHTS_VERSION, "/dist/search-insights.min.js");
+function createInsightsMiddleware() {
+  var props = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  var _insightsClient = props.insightsClient,
+    insightsInitParams = props.insightsInitParams,
+    onEvent = props.onEvent,
+    _props$$$internal = props.$$internal,
+    $$internal = _props$$$internal === void 0 ? false : _props$$$internal;
+  var potentialInsightsClient = _insightsClient;
+  if (!_insightsClient && _insightsClient !== null) {
+    (0, _utils.safelyRunOnBrowser)(function (_ref) {
+      var window = _ref.window;
+      var pointer = window.AlgoliaAnalyticsObject || 'aa';
+      if (typeof pointer === 'string') {
+        potentialInsightsClient = window[pointer];
+      }
+      if (!potentialInsightsClient) {
+        window.AlgoliaAnalyticsObject = pointer;
+        if (!window[pointer]) {
+          window[pointer] = function () {
+            if (!window[pointer].queue) {
+              window[pointer].queue = [];
+            }
+            for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+              args[_key] = arguments[_key];
+            }
+            window[pointer].queue.push(args);
+          };
+          window[pointer].version = ALGOLIA_INSIGHTS_VERSION;
+          window[pointer].shouldAddScript = true;
+        }
+        potentialInsightsClient = window[pointer];
+      }
+    });
   }
-  var hasInsightsClient = Boolean(_insightsClient);
-  var insightsClient = _insightsClient === null ? _utils.noop : _insightsClient;
+  // if still no insightsClient was found, we use a noop
+  var insightsClient = potentialInsightsClient || _utils.noop;
   return function (_ref2) {
     var instantSearchInstance = _ref2.instantSearchInstance;
+    // remove existing default insights middleware
+    // user-provided insights middleware takes precedence
+    var existingInsightsMiddlewares = instantSearchInstance.middleware.filter(function (m) {
+      return m.instance.$$type === 'ais.insights' && m.instance.$$internal;
+    }).map(function (m) {
+      return m.creator;
+    });
+    instantSearchInstance.unuse.apply(instantSearchInstance, _toConsumableArray(existingInsightsMiddlewares));
     var _getAppIdAndApiKey = (0, _utils.getAppIdAndApiKey)(instantSearchInstance.client),
       _getAppIdAndApiKey2 = _slicedToArray(_getAppIdAndApiKey, 2),
       appId = _getAppIdAndApiKey2[0],
       apiKey = _getAppIdAndApiKey2[1];
 
     // search-insights.js also throws an error so dev-only clarification is sufficient
-    if (process.env.NODE_ENV === 'development' && !(appId && apiKey)) {
-      throw new Error('[insights middleware]: could not extract Algolia credentials from searchClient');
-    }
+    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 userTokenBeforeInit = undefined;
     if (Array.isArray(insightsClient.queue)) {
@@ -72,15 +106,39 @@ function createInsightsMiddleware(props) {
       // Otherwise, the `init` call might override it with anonymous user token.
       userTokenBeforeInit = userToken;
     });
-    insightsClient('init', _objectSpread({
-      appId: appId,
-      apiKey: apiKey
-    }, insightsInitParams));
+
+    // Only `init` if the `insightsInitParams` option is passed or
+    // if the `insightsClient` version doesn't supports optional `init` calling.
+    if (insightsInitParams || !isModernInsightsClient(insightsClient)) {
+      insightsClient('init', _objectSpread({
+        appId: appId,
+        apiKey: apiKey,
+        partial: true
+      }, insightsInitParams));
+    }
     var initialParameters;
     var helper;
     return {
+      $$type: 'ais.insights',
+      $$internal: $$internal,
       onStateChange: function onStateChange() {},
-      subscribe: function subscribe() {},
+      subscribe: function subscribe() {
+        if (!insightsClient.shouldAddScript) return;
+        var errorMessage = '[insights middleware]: could not load search-insights.js. Please load it manually following https://alg.li/insights-init';
+        try {
+          var script = document.createElement('script');
+          script.async = true;
+          script.src = ALGOLIA_INSIGHTS_SRC;
+          script.onerror = function () {
+            instantSearchInstance.emit('error', new Error(errorMessage));
+          };
+          document.body.appendChild(script);
+          insightsClient.shouldAddScript = false;
+        } catch (cause) {
+          insightsClient.shouldAddScript = false;
+          instantSearchInstance.emit('error', new Error(errorMessage));
+        }
+      },
       started: function started() {
         insightsClient('addAlgoliaAgent', 'insights-middleware');
         helper = instantSearchInstance.helper;
@@ -91,15 +149,23 @@ function createInsightsMiddleware(props) {
         helper.overrideStateWithoutTriggeringChangeEvent(_objectSpread(_objectSpread({}, helper.state), {}, {
           clickAnalytics: true
         }));
-        instantSearchInstance.scheduleSearch();
+        if (!$$internal) {
+          instantSearchInstance.scheduleSearch();
+        }
         var setUserTokenToSearch = function setUserTokenToSearch(userToken) {
+          if (!userToken) {
+            return;
+          }
+          var existingToken = helper.state.userToken;
           helper.overrideStateWithoutTriggeringChangeEvent(_objectSpread(_objectSpread({}, helper.state), {}, {
             userToken: userToken
           }));
-          instantSearchInstance.scheduleSearch();
+          if (existingToken && existingToken !== userToken) {
+            instantSearchInstance.scheduleSearch();
+          }
         };
         var anonymousUserToken = (0, _helpers.getInsightsAnonymousUserTokenInternal)();
-        if (hasInsightsClient && anonymousUserToken) {
+        if (anonymousUserToken) {
           // When `aa('init', { ... })` is called, it creates an anonymous user token in cookie.
           // We can set it as userToken.
           setUserTokenToSearch(anonymousUserToken);
@@ -108,8 +174,10 @@ function createInsightsMiddleware(props) {
         // 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);
           insightsClient('setUserToken', userTokenBeforeInit);
         } else if (queuedUserToken) {
+          setUserTokenToSearch(queuedUserToken);
           insightsClient('setUserToken', queuedUserToken);
         }
 
@@ -117,16 +185,31 @@ function createInsightsMiddleware(props) {
         insightsClient('onUserTokenChange', setUserTokenToSearch, {
           immediate: true
         });
+        var insightsClientWithLocalCredentials = insightsClient;
+        if (isModernInsightsClient(insightsClient)) {
+          insightsClientWithLocalCredentials = function insightsClientWithLocalCredentials(method, payload) {
+            var extraParams = {
+              headers: {
+                'X-Algolia-Application-Id': appId,
+                'X-Algolia-API-Key': apiKey
+              }
+            };
+
+            // @ts-ignore we are calling this only when we know that the client actually is correct
+            return insightsClient(method, payload, extraParams);
+          };
+        }
         instantSearchInstance.sendEventToInsights = function (event) {
           if (onEvent) {
-            onEvent(event, _insightsClient);
+            onEvent(event, insightsClientWithLocalCredentials);
           } else if (event.insightsMethod) {
-            var hasUserToken = Boolean(helper.state.userToken);
-            if (hasUserToken) {
-              insightsClient(event.insightsMethod, event.payload);
-            } else {
-              process.env.NODE_ENV === 'development' ? (0, _utils.warning)(false, "\nCannot send event to Algolia Insights because `userToken` is not set.\n\nSee documentation: https://www.algolia.com/doc/guides/building-search-ui/going-further/send-insights-events/js/#setting-the-usertoken\n") : void 0;
+            // Source is used to differentiate events sent by instantsearch from those sent manually.
+            event.payload.algoliaSource = ['instantsearch'];
+            if (event.eventModifier === 'internal') {
+              event.payload.algoliaSource.push('instantsearch-internal');
             }
+            insightsClientWithLocalCredentials(event.insightsMethod, event.payload);
+            process.env.NODE_ENV === 'development' ? (0, _utils.warning)(Boolean(helper.state.userToken), "\nCannot send event to Algolia Insights because `userToken` is not set.\n\nSee documentation: https://www.algolia.com/doc/guides/building-search-ui/going-further/send-insights-events/js/#setting-the-usertoken\n") : void 0;
           } else {
             process.env.NODE_ENV === 'development' ? (0, _utils.warning)(false, 'Cannot send event to Algolia Insights because `insightsMethod` option is missing.') : void 0;
           }
@@ -136,10 +219,29 @@ function createInsightsMiddleware(props) {
         insightsClient('onUserTokenChange', undefined);
         instantSearchInstance.sendEventToInsights = _utils.noop;
         if (helper && initialParameters) {
-          helper.setState(_objectSpread(_objectSpread({}, helper.state), initialParameters));
+          helper.overrideStateWithoutTriggeringChangeEvent(_objectSpread(_objectSpread({}, helper.state), initialParameters));
           instantSearchInstance.scheduleSearch();
         }
       }
     };
   };
+}
+
+/**
+ * Determines if a given insights `client` supports the optional call to `init`
+ * and the ability to set credentials via extra parameters when sending events.
+ */
+function isModernInsightsClient(client) {
+  var _split$map = (client.version || '').split('.').map(Number),
+    _split$map2 = _slicedToArray(_split$map, 2),
+    major = _split$map2[0],
+    minor = _split$map2[1];
+
+  /* eslint-disable @typescript-eslint/naming-convention */
+  var v3 = major >= 3;
+  var v2_6 = major === 2 && minor >= 6;
+  var v1_10 = major === 1 && minor >= 10;
+  /* eslint-enable @typescript-eslint/naming-convention */
+
+  return v3 || v2_6 || v1_10;
 }

package/cjs/middlewares/createMetadataMiddleware.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.createMetadataMiddleware = createMetadataMiddleware;
 exports.isMetadataEnabled = isMetadataEnabled;
 var _utils = require("../lib/utils");
-function extractPayload(widgets, instantSearchInstance, payload) {
+function extractWidgetPayload(widgets, instantSearchInstance, payload) {
   var initOptions = (0, _utils.createInitArgs)(instantSearchInstance, instantSearchInstance.mainIndex, instantSearchInstance._initialUiState);
   widgets.forEach(function (widget) {
     var widgetParams = {};
@@ -28,7 +28,7 @@ function extractPayload(widgets, instantSearchInstance, payload) {
       params: params
     });
     if (widget.$$type === 'ais.index') {
-      extractPayload(widget.getWidgets(), instantSearchInstance, payload);
+      extractWidgetPayload(widget.getWidgets(), instantSearchInstance, payload);
     }
   });
 }
@@ -52,8 +52,11 @@ function isMetadataEnabled() {
  * - connector name
  */
 function createMetadataMiddleware() {
-  return function (_ref2) {
-    var instantSearchInstance = _ref2.instantSearchInstance;
+  var _ref2 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
+    _ref2$$$internal = _ref2.$$internal,
+    $$internal = _ref2$$$internal === void 0 ? false : _ref2$$$internal;
+  return function (_ref3) {
+    var instantSearchInstance = _ref3.instantSearchInstance;
     var payload = {
       widgets: []
     };
@@ -61,13 +64,22 @@ function createMetadataMiddleware() {
     var refNode = document.querySelector('head');
     payloadContainer.name = 'instantsearch:widgets';
     return {
+      $$type: 'ais.metadata',
+      $$internal: $$internal,
       onStateChange: function onStateChange() {},
       subscribe: function subscribe() {
         // using setTimeout here to delay extraction until widgets have been added in a tick (e.g. Vue)
         setTimeout(function () {
           var client = instantSearchInstance.client;
           payload.ua = client.transporter && client.transporter.userAgent ? client.transporter.userAgent.value : client._ua;
-          extractPayload(instantSearchInstance.mainIndex.getWidgets(), instantSearchInstance, payload);
+          extractWidgetPayload(instantSearchInstance.mainIndex.getWidgets(), instantSearchInstance, payload);
+          instantSearchInstance.middleware.forEach(function (middleware) {
+            return payload.widgets.push({
+              middleware: true,
+              type: middleware.instance.$$type,
+              internal: middleware.instance.$$internal
+            });
+          });
           payloadContainer.content = JSON.stringify(payload);
           refNode.appendChild(payloadContainer);
         }, 0);

package/cjs/middlewares/createRouterMiddleware.js

@@ -19,7 +19,9 @@ var createRouterMiddleware = function createRouterMiddleware() {
   var _props$router = props.router,
     router = _props$router === void 0 ? (0, _history.default)() : _props$router,
     _props$stateMapping = props.stateMapping,
-    stateMapping = _props$stateMapping === void 0 ? (0, _simple.default)() : _props$stateMapping;
+    stateMapping = _props$stateMapping === void 0 ? (0, _simple.default)() : _props$stateMapping,
+    _props$$$internal = props.$$internal,
+    $$internal = _props$$$internal === void 0 ? false : _props$$$internal;
   return function (_ref) {
     var instantSearchInstance = _ref.instantSearchInstance;
     function topLevelCreateURL(nextState) {
@@ -36,6 +38,8 @@ var createRouterMiddleware = function createRouterMiddleware() {
     var lastRouteState = undefined;
     var initialUiState = instantSearchInstance._initialUiState;
     return {
+      $$type: "ais.router({router:".concat(router.$$type || '__unknown__', ", stateMapping:").concat(stateMapping.$$type || '__unknown__', "})"),
+      $$internal: $$internal,
       onStateChange: function onStateChange(_ref2) {
         var uiState = _ref2.uiState;
         var routeState = stateMapping.stateToRoute(uiState);

package/cjs/widgets/hits/hits.js

@@ -24,7 +24,6 @@ var withUsage = (0, _utils.createDocumentationMessageGenerator)({
   name: 'hits'
 });
 var suit = (0, _suit.component)('Hits');
-var HitsWithInsightsListener = (0, _insights.withInsightsListener)(_Hits.default);
 var renderer = function renderer(_ref) {
   var renderState = _ref.renderState,
     cssClasses = _ref.cssClasses,
@@ -45,7 +44,7 @@ var renderer = function renderer(_ref) {
       });
       return;
     }
-    (0, _preact.render)((0, _preact.h)(HitsWithInsightsListener, {
+    (0, _preact.render)((0, _preact.h)(_Hits.default, {
       cssClasses: cssClasses,
       hits: receivedHits,
       results: results,

package/cjs/widgets/hits-per-page/hits-per-page.js

@@ -38,7 +38,9 @@ var renderer = function renderer(_ref) {
     }, (0, _preact.h)(_Selector.default, {
       cssClasses: cssClasses,
       currentValue: currentValue,
-      options: items,
+      options: items
+      // @ts-expect-error: the refine function expects a number, but setValue will call it with a string. We don't want to change the type of the refine function because it's part of the connector API.
+      ,
       setValue: refine
     })), containerNode);
   };

package/cjs/widgets/index/index.js

@@ -339,7 +339,7 @@ var index = function index(widgetParams) {
         // does not have access to lastResults, which it used to in pre-federated
         // search behavior.
         helper.lastResults = results;
-        lastValidSearchParameters = results._state;
+        lastValidSearchParameters = results === null || results === void 0 ? void 0 : results._state;
       });
 
       // We compute the render state before calling `init` in a separate loop
@@ -395,16 +395,16 @@ var index = function index(widgetParams) {
     render: function render(_ref5) {
       var _this4 = this;
       var instantSearchInstance = _ref5.instantSearchInstance;
-      if (!this.getResults()) {
-        return;
-      }
-
       // we can't attach a listener to the error event of search, as the error
       // then would no longer be thrown for global handlers.
-      if (instantSearchInstance.status === 'error' && !instantSearchInstance.mainHelper.hasPendingRequests()) {
+      if (instantSearchInstance.status === 'error' && !instantSearchInstance.mainHelper.hasPendingRequests() && lastValidSearchParameters) {
         helper.setState(lastValidSearchParameters);
       }
-      localWidgets.forEach(function (widget) {
+
+      // We only render index widgets if there are no results.
+      // This makes sure `render` is never called with `results` being `null`.
+      var widgetsToRender = this.getResults() ? localWidgets : localWidgets.filter(_utils.isIndexWidget);
+      widgetsToRender.forEach(function (widget) {
         if (widget.getRenderState) {
           var renderState = widget.getRenderState(instantSearchInstance.renderState[_this4.getIndexId()] || {}, (0, _utils.createRenderArgs)(instantSearchInstance, _this4));
           storeRenderState({
@@ -414,7 +414,7 @@ var index = function index(widgetParams) {
           });
         }
       });
-      localWidgets.forEach(function (widget) {
+      widgetsToRender.forEach(function (widget) {
         // At this point, all the variables used below are set. Both `helper`
         // and `derivedHelper` have been created at the `init` step. The attribute
         // `lastResults` might be `null` though. It's possible that a stalled render

package/cjs/widgets/infinite-hits/infinite-hits.js

@@ -24,7 +24,6 @@ var withUsage = (0, _utils.createDocumentationMessageGenerator)({
   name: 'infinite-hits'
 });
 var suit = (0, _suit.component)('InfiniteHits');
-var InfiniteHitsWithInsightsListener = (0, _insights.withInsightsListener)(_InfiniteHits.default);
 var renderer = function renderer(_ref) {
   var containerNode = _ref.containerNode,
     cssClasses = _ref.cssClasses,
@@ -50,7 +49,7 @@ var renderer = function renderer(_ref) {
       });
       return;
     }
-    (0, _preact.render)((0, _preact.h)(InfiniteHitsWithInsightsListener, {
+    (0, _preact.render)((0, _preact.h)(_InfiniteHits.default, {
       cssClasses: cssClasses,
       hits: hits,
       results: results,