instantsearch.js 4.54.0 → 4.55.0

package/es/helpers/reverseHighlight.d.ts

@@ -7,4 +7,7 @@ export type ReverseHighlightOptions = {
         highlighted: string;
     }>;
 };
+/**
+ * @deprecated use html tagged templates and the ReverseHighlight component instead
+ */
 export default function reverseHighlight({ attribute, highlightedTagName, hit, cssClasses, }: ReverseHighlightOptions): string;

package/es/helpers/reverseHighlight.js

@@ -1,6 +1,10 @@
 import { component } from "../lib/suit.js";
 import { TAG_REPLACEMENT, getPropertyByPath, getHighlightedParts, reverseHighlightedParts, concatHighlightedParts, warning } from "../lib/utils/index.js";
 var suit = component('ReverseHighlight');
+
+/**
+ * @deprecated use html tagged templates and the ReverseHighlight component instead
+ */
 export default function reverseHighlight(_ref) {
   var attribute = _ref.attribute,
     _ref$highlightedTagNa = _ref.highlightedTagName,
@@ -8,6 +12,7 @@ export default function reverseHighlight(_ref) {
     hit = _ref.hit,
     _ref$cssClasses = _ref.cssClasses,
     cssClasses = _ref$cssClasses === void 0 ? {} : _ref$cssClasses;
+  process.env.NODE_ENV === 'development' ? warning(false, "`instantsearch.reverseHighlight` function has been deprecated. It is still supported in 4.x releases, but not further. It is replaced by the `ReverseHighlight` component.\n\nFor more information, visit https://www.algolia.com/doc/guides/building-search-ui/upgrade-guides/js/?client=html+tagged+templates#upgrade-templates") : void 0;
   var highlightAttributeResult = getPropertyByPath(hit._highlightResult, attribute);
 
   // @MAJOR fallback to attribute value if highlight is not found

package/es/helpers/reverseSnippet.d.ts

@@ -7,4 +7,7 @@ export type ReverseSnippetOptions = {
         highlighted: string;
     }>;
 };
+/**
+ * @deprecated use html tagged templates and the ReverseSnippet component instead
+ */
 export default function reverseSnippet({ attribute, highlightedTagName, hit, cssClasses, }: ReverseSnippetOptions): string;

package/es/helpers/reverseSnippet.js

@@ -1,6 +1,10 @@
 import { component } from "../lib/suit.js";
 import { TAG_REPLACEMENT, getPropertyByPath, getHighlightedParts, reverseHighlightedParts, concatHighlightedParts, warning } from "../lib/utils/index.js";
 var suit = component('ReverseSnippet');
+
+/**
+ * @deprecated use html tagged templates and the ReverseSnippet component instead
+ */
 export default function reverseSnippet(_ref) {
   var attribute = _ref.attribute,
     _ref$highlightedTagNa = _ref.highlightedTagName,
@@ -8,6 +12,7 @@ export default function reverseSnippet(_ref) {
     hit = _ref.hit,
     _ref$cssClasses = _ref.cssClasses,
     cssClasses = _ref$cssClasses === void 0 ? {} : _ref$cssClasses;
+  process.env.NODE_ENV === 'development' ? warning(false, "`instantsearch.reverseSnippet` function has been deprecated. It is still supported in 4.x releases, but not further. It is replaced by the `ReverseSnippet` component.\n\nFor more information, visit https://www.algolia.com/doc/guides/building-search-ui/upgrade-guides/js/?client=html+tagged+templates#upgrade-templates") : void 0;
   var snippetAttributeResult = getPropertyByPath(hit._snippetResult, attribute);
 
   // @MAJOR fallback to attribute value if snippet is not found

package/es/helpers/snippet.d.ts

@@ -7,4 +7,7 @@ export type SnippetOptions = {
         highlighted?: string;
     };
 };
+/**
+ * @deprecated use html tagged templates and the Snippet component instead
+ */
 export default function snippet({ attribute, highlightedTagName, hit, cssClasses, }: SnippetOptions): string;

package/es/helpers/snippet.js

@@ -1,6 +1,10 @@
 import { component } from "../lib/suit.js";
 import { TAG_REPLACEMENT, getPropertyByPath, warning } from "../lib/utils/index.js";
 var suit = component('Snippet');
+
+/**
+ * @deprecated use html tagged templates and the Snippet component instead
+ */
 export default function snippet(_ref) {
   var attribute = _ref.attribute,
     _ref$highlightedTagNa = _ref.highlightedTagName,
@@ -8,6 +12,7 @@ export default function snippet(_ref) {
     hit = _ref.hit,
     _ref$cssClasses = _ref.cssClasses,
     cssClasses = _ref$cssClasses === void 0 ? {} : _ref$cssClasses;
+  process.env.NODE_ENV === 'development' ? warning(false, "`instantsearch.snippet` function has been deprecated. It is still supported in 4.x releases, but not further. It is replaced by the `Snippet` component.\n\nFor more information, visit https://www.algolia.com/doc/guides/building-search-ui/upgrade-guides/js/?client=html+tagged+templates#upgrade-templates") : void 0;
   var snippetAttributeResult = getPropertyByPath(hit._snippetResult, attribute);
 
   // @MAJOR fallback to attribute value if snippet is not found

package/es/lib/InstantSearch.d.ts

@@ -1,5 +1,5 @@
 import EventEmitter from '@algolia/events';
-import type { InsightsEvent } from '../middlewares/createInsightsMiddleware';
+import type { InsightsEvent, InsightsProps } from '../middlewares/createInsightsMiddleware';
 import type { RouterProps } from '../middlewares/createRouterMiddleware';
 import type { InsightsClient as AlgoliaInsightsClient, SearchClient, Widget, UiState, CreateURL, Middleware, MiddlewareDefinition, RenderState, InitialResults } from '../types';
 import type { IndexWidget } from '../widgets/index/index';
@@ -79,6 +79,16 @@ export type InstantSearchOptions<TUiState extends UiState = UiState, TRouteState
      * client side persistence. Passing `true` will use the default URL options.
      */
     routing?: RouterProps<TUiState, TRouteState> | boolean;
+    /**
+     * Enables the Insights middleware and loads the Insights library
+     * if not already loaded.
+     *
+     * The Insights middleware sends view and click events automatically, and lets
+     * you set up your own events.
+     *
+     * @default false
+     */
+    insights?: InsightsProps | boolean;
     /**
      * the instance of search-insights to use for sending insights events inside
      * widgets like `hits`.

package/es/lib/InstantSearch.js

@@ -16,6 +16,7 @@ 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); }
 import EventEmitter from '@algolia/events';
 import algoliasearchHelper from 'algoliasearch-helper';
+import { createInsightsMiddleware } from "../middlewares/createInsightsMiddleware.js";
 import { createMetadataMiddleware, isMetadataEnabled } from "../middlewares/createMetadataMiddleware.js";
 import { createRouterMiddleware } from "../middlewares/createRouterMiddleware.js";
 import index from "../widgets/index/index.js";
@@ -105,6 +106,8 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
       initialUiState = _options$initialUiSta === void 0 ? {} : _options$initialUiSta,
       _options$routing = options.routing,
       routing = _options$routing === void 0 ? null : _options$routing,
+      _options$insights = options.insights,
+      insights = _options$insights === void 0 ? false : _options$insights,
       searchFunction = options.searchFunction,
       _options$stalledSearc = options.stalledSearchDelay,
       stalledSearchDelay = _options$stalledSearc === void 0 ? 200 : _options$stalledSearc,
@@ -160,11 +163,22 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
     }
     _this.sendEventToInsights = noop;
     if (routing) {
-      var routerOptions = typeof routing === 'boolean' ? undefined : routing;
+      var routerOptions = typeof routing === 'boolean' ? {} : routing;
+      routerOptions.$$internal = true;
       _this.use(createRouterMiddleware(routerOptions));
     }
+
+    // This is the default middleware,
+    // any user-provided middleware will be added later and override this one.
+    if (insights) {
+      var insightsOptions = typeof insights === 'boolean' ? {} : insights;
+      insightsOptions.$$internal = true;
+      _this.use(createInsightsMiddleware(insightsOptions));
+    }
     if (isMetadataEnabled()) {
-      _this.use(createMetadataMiddleware());
+      _this.use(createMetadataMiddleware({
+        $$internal: true
+      }));
     }
     return _this;
   }
@@ -200,6 +214,8 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
       }
       var newMiddlewareList = middleware.map(function (fn) {
         var newMiddleware = _objectSpread({
+          $$type: '__unknown__',
+          $$internal: false,
           subscribe: noop,
           started: noop,
           unsubscribe: noop,

package/es/lib/insights/listener.d.ts

@@ -2,10 +2,14 @@
 import { h } from 'preact';
 import type { InsightsEvent } from '../../middlewares/createInsightsMiddleware';
 import type { InsightsClient } from '../../types';
-type WithInsightsListenerProps = {
-    [key: string]: unknown;
-    insights: InsightsClient;
-    sendEvent?: (event: InsightsEvent) => void;
+export type InsightsEventHandlerOptions = {
+    insights?: InsightsClient;
+    sendEvent: (event: InsightsEvent) => void;
 };
-declare const insightsListener: (BaseComponent: any) => (props: WithInsightsListenerProps) => h.JSX.Element;
-export default insightsListener;
+export declare const createInsightsEventHandler: ({ insights, sendEvent }: InsightsEventHandlerOptions) => (event: MouseEvent) => void;
+/**
+ * @deprecated use `sendEvent` directly instead
+ */
+export default function withInsightsListener(BaseComponent: any): (props: {
+    [key: string]: any;
+} & InsightsEventHandlerOptions) => h.JSX.Element;

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/server.d.ts

@@ -0,0 +1,10 @@
+import type { IndexWidget, InitialResults, InstantSearch } from '../types';
+/**
+ * Waits for the results from the search instance to coordinate the next steps
+ * in `getServerState()`.
+ */
+export declare function waitForResults(search: InstantSearch): Promise<void>;
+/**
+ * Walks the InstantSearch root index to construct the initial results.
+ */
+export declare function getInitialResults(rootIndex: IndexWidget): InitialResults;

package/es/lib/server.js

@@ -0,0 +1,53 @@
+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 ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+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); }
+import { walkIndex } from "./utils/index.js";
+/**
+ * Waits for the results from the search instance to coordinate the next steps
+ * in `getServerState()`.
+ */
+export function waitForResults(search) {
+  var helper = search.mainHelper;
+  helper.searchOnlyWithDerivedHelpers();
+  return new Promise(function (resolve, reject) {
+    // All derived helpers resolve in the same tick so we're safe only relying
+    // on the first one.
+    helper.derivedHelpers[0].on('result', function () {
+      resolve();
+    });
+
+    // However, we listen to errors that can happen on any derived helper because
+    // any error is critical.
+    helper.on('error', function (error) {
+      reject(error);
+    });
+    search.on('error', function (error) {
+      reject(error);
+    });
+    helper.derivedHelpers.forEach(function (derivedHelper) {
+      return derivedHelper.on('error', function (error) {
+        reject(error);
+      });
+    });
+  });
+}
+
+/**
+ * Walks the InstantSearch root index to construct the initial results.
+ */
+export function getInitialResults(rootIndex) {
+  var initialResults = {};
+  walkIndex(rootIndex, function (widget) {
+    var searchResults = widget.getResults();
+    initialResults[widget.getIndexId()] = {
+      // We convert the Helper state to a plain object to pass parsable data
+      // structures from server to client.
+      state: _objectSpread({}, searchResults._state),
+      results: searchResults._rawResults
+    };
+  });
+  return initialResults;
+}

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/utils/index.d.ts

@@ -33,6 +33,7 @@ export * from './isFacetRefined';
 export * from './isFiniteNumber';
 export * from './isPlainObject';
 export * from './isSpecialClick';
+export * from './walkIndex';
 export * from './logger';
 export * from './mergeSearchParameters';
 export * from './omit';

package/es/lib/utils/index.js

@@ -33,6 +33,7 @@ export * from "./isFacetRefined.js";
 export * from "./isFiniteNumber.js";
 export * from "./isPlainObject.js";
 export * from "./isSpecialClick.js";
+export * from "./walkIndex.js";
 export * from "./logger.js";
 export * from "./mergeSearchParameters.js";
 export * from "./omit.js";

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

@@ -0,0 +1,5 @@
+import type { IndexWidget } from '../../types';
+/**
+ * Recurse over all child indices
+ */
+export declare function walkIndex(indexWidget: IndexWidget, callback: (widget: IndexWidget) => void): void;

package/es/lib/utils/walkIndex.js

@@ -0,0 +1,12 @@
+import { isIndexWidget } from "./isIndexWidget.js";
+/**
+ * Recurse over all child indices
+ */
+export function walkIndex(indexWidget, callback) {
+  callback(indexWidget);
+  indexWidget.getWidgets().forEach(function (widget) {
+    if (isIndexWidget(widget)) {
+      walkIndex(widget, callback);
+    }
+  });
+}

package/es/lib/version.d.ts

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

package/es/lib/version.js

@@ -1 +1 @@
-export default '4.54.0';
+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 {};