instantsearch.js 4.54.1 → 4.55.0

package/es/lib/insights/listener.js

@@ -1,7 +1,34 @@
 import { h } from 'preact';
-import { readDataAttributes, hasDataAttributes } from "../../helpers/insights.js";
-import { deserializePayload } from "../utils/index.js";
-var findInsightsTarget = function findInsightsTarget(startElement, endElement, validator) {
+import { readDataAttributes } from "../../helpers/insights.js";
+import { deserializePayload, warning } from "../utils/index.js";
+export var createInsightsEventHandler = function createInsightsEventHandler(_ref) {
+  var insights = _ref.insights,
+    sendEvent = _ref.sendEvent;
+  return function (event) {
+    // new way, e.g. bindEvent("click", hit, "Hit clicked")
+    var insightsThroughSendEvent = findInsightsTarget(event.target, event.currentTarget, function (element) {
+      return element.hasAttribute('data-insights-event');
+    });
+    if (insightsThroughSendEvent) {
+      var payload = parseInsightsEvent(insightsThroughSendEvent);
+      payload.forEach(function (single) {
+        return sendEvent(single);
+      });
+    }
+
+    // old way, e.g. instantsearch.insights("clickedObjectIDsAfterSearch", { .. })
+    var insightsThroughFunction = findInsightsTarget(event.target, event.currentTarget, function (element) {
+      return element.hasAttribute('data-insights-method') && element.hasAttribute('data-insights-payload');
+    });
+    if (insightsThroughFunction) {
+      var _readDataAttributes = readDataAttributes(insightsThroughFunction),
+        method = _readDataAttributes.method,
+        _payload = _readDataAttributes.payload;
+      insights(method, _payload);
+    }
+  };
+};
+function findInsightsTarget(startElement, endElement, validator) {
   var element = startElement;
   while (element && !validator(element)) {
     if (element === endElement) {
@@ -10,8 +37,8 @@ var findInsightsTarget = function findInsightsTarget(startElement, endElement, v
     element = element.parentElement;
   }
   return element;
-};
-var parseInsightsEvent = function parseInsightsEvent(element) {
+}
+function parseInsightsEvent(element) {
   var serializedPayload = element.getAttribute('data-insights-event');
   if (typeof serializedPayload !== 'string') {
     throw new Error('The insights middleware expects `data-insights-event` to be a base64-encoded JSON string.');
@@ -21,38 +48,17 @@ var parseInsightsEvent = function parseInsightsEvent(element) {
   } catch (error) {
     throw new Error('The insights middleware was unable to parse `data-insights-event`.');
   }
-};
-var insightsListener = function insightsListener(BaseComponent) {
-  function WithInsightsListener(props) {
-    var handleClick = function handleClick(event) {
-      if (props.sendEvent) {
-        // new way with insights middleware
-        var targetWithEvent = findInsightsTarget(event.target, event.currentTarget, function (element) {
-          return element.hasAttribute('data-insights-event');
-        });
-        if (targetWithEvent) {
-          var payload = parseInsightsEvent(targetWithEvent);
-          payload.forEach(function (single) {
-            return props.sendEvent(single);
-          });
-        }
-      }
+}
 
-      // old way, e.g. instantsearch.insights("clickedObjectIDsAfterSearch", { .. })
-      var insightsTarget = findInsightsTarget(event.target, event.currentTarget, function (element) {
-        return hasDataAttributes(element);
-      });
-      if (insightsTarget) {
-        var _readDataAttributes = readDataAttributes(insightsTarget),
-          method = _readDataAttributes.method,
-          _payload = _readDataAttributes.payload;
-        props.insights(method, _payload);
-      }
-    };
+/**
+ * @deprecated use `sendEvent` directly instead
+ */
+export default function withInsightsListener(BaseComponent) {
+  process.env.NODE_ENV === 'development' ? warning(false, 'The `withInsightsListener` function is deprecated and will be removed in the next major version. Please use `sendEvent` directly instead.') : void 0;
+  return function WithInsightsListener(props) {
+    var handleClick = createInsightsEventHandler(props);
     return h("div", {
       onClick: handleClick
     }, h(BaseComponent, props));
-  }
-  return WithInsightsListener;
-};
-export default insightsListener;
+  };
+}

package/es/lib/routers/history.d.ts

@@ -20,6 +20,7 @@ export type BrowserHistoryArgs<TRouteState> = {
     push?: (url: string) => void;
 };
 declare class BrowserHistory<TRouteState> implements Router<TRouteState> {
+    $$type: string;
     /**
      * Transforms a UI state into a title for the page.
      */

package/es/lib/routers/history.js

@@ -31,6 +31,7 @@ var BrowserHistory = /*#__PURE__*/function () {
       dispose = _ref.dispose,
       push = _ref.push;
     _classCallCheck(this, BrowserHistory);
+    _defineProperty(this, "$$type", 'ais.browser');
     _defineProperty(this, "windowTitle", void 0);
     _defineProperty(this, "writeDelay", void 0);
     _defineProperty(this, "_createURL", void 0);

package/es/lib/stateMappings/simple.js

@@ -18,6 +18,7 @@ function getIndexStateWithoutConfigure(uiState) {
 // which excludes "configure" as this function does.
 export default function simpleStateMapping() {
   return {
+    $$type: 'ais.simple',
     stateToRoute: function stateToRoute(uiState) {
       return Object.keys(uiState).reduce(function (state, indexId) {
         return _objectSpread(_objectSpread({}, state), {}, _defineProperty({}, indexId, getIndexStateWithoutConfigure(uiState[indexId])));

package/es/lib/stateMappings/singleIndex.js

@@ -12,6 +12,7 @@ function getIndexStateWithoutConfigure(uiState) {
 }
 export default function singleIndexStateMapping(indexName) {
   return {
+    $$type: 'ais.singleIndex',
     stateToRoute: function stateToRoute(uiState) {
       return getIndexStateWithoutConfigure(uiState[indexName] || {});
     },

package/es/lib/utils/createSendEventForFacet.js

@@ -1,4 +1,10 @@
 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; }
 import { isFacetRefined } from "./isFacetRefined.js";
 export function createSendEventForFacet(_ref) {
   var instantSearchInstance = _ref.instantSearchInstance,
@@ -9,10 +15,13 @@ export 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]);
@@ -23,6 +32,7 @@ export function createSendEventForFacet(_ref) {
           insightsMethod: 'clickedFilters',
           widgetType: widgetType,
           eventType: eventType,
+          eventModifier: eventModifier,
           payload: {
             eventName: eventName,
             index: helper.getIndex(),

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

@@ -1,3 +1,4 @@
+import type { InsightsEvent } from '../../middlewares/createInsightsMiddleware';
 import type { InstantSearch, Hit } from '../../types';
 type BuiltInSendEventForHits = (eventType: string, hits: Hit | Hit[], eventName?: string) => void;
 type CustomSendEventForHits = (customPayload: any) => void;
@@ -5,6 +6,13 @@ export type SendEventForHits = BuiltInSendEventForHits & CustomSendEventForHits;
 export type BuiltInBindEventForHits = (eventType: string, hits: Hit | Hit[], eventName?: string) => string;
 export type CustomBindEventForHits = (customPayload: any) => string;
 export type BindEventForHits = BuiltInBindEventForHits & CustomBindEventForHits;
+export declare function _buildEventPayloadsForHits({ index, widgetType, methodName, args, instantSearchInstance, }: {
+    widgetType: string;
+    index: string;
+    methodName: 'sendEvent' | 'bindEvent';
+    args: any[];
+    instantSearchInstance: InstantSearch;
+}): InsightsEvent[];
 export declare function createSendEventForHits({ instantSearchInstance, index, widgetType, }: {
     instantSearchInstance: InstantSearch;
     index: string;

package/es/lib/utils/createSendEventForHits.js

@@ -1,3 +1,9 @@
+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); }
 import { serializePayload } from "./serializer.js";
 function chunk(arr) {
@@ -8,7 +14,7 @@ function chunk(arr) {
   }
   return chunks;
 }
-var buildPayloads = function buildPayloads(_ref) {
+export function _buildEventPayloadsForHits(_ref) {
   var index = _ref.index,
     widgetType = _ref.widgetType,
     methodName = _ref.methodName,
@@ -18,7 +24,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) {
@@ -65,7 +74,8 @@ var buildPayloads = function buildPayloads(_ref) {
           index: index,
           objectIDs: objectIDsByChunk[i]
         },
-        hits: batch
+        hits: batch,
+        eventModifier: eventModifier
       };
     });
   } else if (eventType === 'click') {
@@ -75,13 +85,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') {
@@ -91,12 +102,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') {
@@ -104,16 +116,18 @@ var buildPayloads = function buildPayloads(_ref) {
   } else {
     return [];
   }
-};
+}
 export 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',
@@ -121,8 +135,16 @@ export 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;
 }
@@ -134,7 +156,7 @@ export 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/es/lib/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "4.54.1";
+declare const _default: "4.55.0";
 export default _default;

package/es/lib/version.js

@@ -1 +1 @@
-export default '4.54.1';
+export default '4.55.0';

package/es/middlewares/createInsightsMiddleware.d.ts

@@ -1,21 +1,21 @@
-import type { InsightsClient, InsightsClientMethod, InternalMiddleware, Hit } from '../types';
-export type InsightsEvent = {
-    insightsMethod?: InsightsClientMethod;
-    payload: any;
-    widgetType: string;
-    eventType: string;
-    hits?: Hit[];
-    attribute?: string;
-};
-export type InsightsProps<TInsightsClient extends null | InsightsClient = InsightsClient | null> = {
-    insightsClient: TInsightsClient;
+import type { InsightsClient, InsightsEvent as _InsightsEvent, InsightsMethod, InternalMiddleware } from '../types';
+type ProvidedInsightsClient = InsightsClient | null | undefined;
+export type InsightsEvent<TMethod extends InsightsMethod = InsightsMethod> = _InsightsEvent<TMethod>;
+export type InsightsProps<TInsightsClient extends ProvidedInsightsClient = ProvidedInsightsClient> = {
+    insightsClient?: TInsightsClient;
     insightsInitParams?: {
         userHasOptedOut?: boolean;
         useCookie?: boolean;
+        anonymousUserToken?: boolean;
         cookieDuration?: number;
         region?: 'de' | 'us';
     };
     onEvent?: (event: InsightsEvent, insightsClient: TInsightsClient) => void;
 };
+export type InsightsClientWithGlobals = InsightsClient & {
+    shouldAddScript?: boolean;
+    version?: string;
+};
 export type CreateInsightsMiddleware = typeof createInsightsMiddleware;
-export declare function createInsightsMiddleware<TInsightsClient extends null | InsightsClient>(props: InsightsProps<TInsightsClient>): InternalMiddleware;
+export declare function createInsightsMiddleware<TInsightsClient extends ProvidedInsightsClient>(props?: InsightsProps<TInsightsClient>): InternalMiddleware;
+export {};

package/es/middlewares/createInsightsMiddleware.js

@@ -6,37 +6,71 @@ 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 _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; }
 import { getInsightsAnonymousUserTokenInternal } from "../helpers/index.js";
-import { warning, noop, getAppIdAndApiKey, find } from "../lib/utils/index.js";
-export 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`.');
-    }
+import { warning, noop, getAppIdAndApiKey, find, safelyRunOnBrowser } from "../lib/utils/index.js";
+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");
+export 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) {
+    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 ? noop : _insightsClient;
+  // if still no insightsClient was found, we use a noop
+  var insightsClient = potentialInsightsClient || 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 = 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' ? 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)) {
@@ -66,15 +100,39 @@ export 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;
@@ -85,15 +143,23 @@ export 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 = 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);
@@ -102,8 +168,10 @@ export 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);
         }
 
@@ -111,16 +179,31 @@ export 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' ? 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' ? 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' ? warning(false, 'Cannot send event to Algolia Insights because `insightsMethod` option is missing.') : void 0;
           }
@@ -130,10 +213,29 @@ export function createInsightsMiddleware(props) {
         insightsClient('onUserTokenChange', undefined);
         instantSearchInstance.sendEventToInsights = 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/es/middlewares/createMetadataMiddleware.d.ts

@@ -7,4 +7,6 @@ export declare function isMetadataEnabled(): boolean;
  * - widget name
  * - connector name
  */
-export declare function createMetadataMiddleware(): InternalMiddleware;
+export declare function createMetadataMiddleware({ $$internal, }?: {
+    $$internal?: boolean;
+}): InternalMiddleware;