instantsearch.js 4.54.0 → 4.55.0

package/es/components/Hits/Hits.d.ts

@@ -2,7 +2,7 @@
 import { h } from 'preact';
 import type { PreparedTemplateProps } from '../../lib/templating';
 import type { BindEventForHits, SendEventForHits } from '../../lib/utils';
-import type { ComponentCSSClasses, Hit } from '../../types';
+import type { ComponentCSSClasses, Hit, InsightsClient } from '../../types';
 import type { HitsCSSClasses, HitsTemplates } from '../../widgets/hits/hits';
 import type { SearchResults } from 'algoliasearch-helper';
 export type HitsComponentCSSClasses = ComponentCSSClasses<HitsCSSClasses>;
@@ -10,10 +10,10 @@ export type HitsComponentTemplates = Required<HitsTemplates>;
 export type HitsProps = {
     results: SearchResults;
     hits: Hit[];
-    sendEvent?: SendEventForHits;
-    bindEvent?: BindEventForHits;
+    insights?: InsightsClient;
+    sendEvent: SendEventForHits;
+    bindEvent: BindEventForHits;
     cssClasses: HitsComponentCSSClasses;
     templateProps: PreparedTemplateProps<HitsComponentTemplates>;
 };
-declare const Hits: ({ results, hits, bindEvent, sendEvent, cssClasses, templateProps, }: HitsProps) => h.JSX.Element;
-export default Hits;
+export default function Hits({ results, hits, insights, bindEvent, sendEvent, cssClasses, templateProps, }: HitsProps): h.JSX.Element;

package/es/components/Hits/Hits.js

@@ -7,20 +7,27 @@ function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input ==
 function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
 import { cx } from '@algolia/ui-components-shared';
 import { h } from 'preact';
+import { createInsightsEventHandler } from "../../lib/insights/listener.js";
 import { warning } from "../../lib/utils/index.js";
 import Template from "../Template/Template.js";
-var Hits = function Hits(_ref) {
+export default function Hits(_ref) {
   var results = _ref.results,
     hits = _ref.hits,
+    insights = _ref.insights,
     bindEvent = _ref.bindEvent,
     sendEvent = _ref.sendEvent,
     cssClasses = _ref.cssClasses,
     templateProps = _ref.templateProps;
+  var handleInsightsClick = createInsightsEventHandler({
+    insights: insights,
+    sendEvent: sendEvent
+  });
   if (results.hits.length === 0) {
     return h(Template, _extends({}, templateProps, {
       templateKey: "empty",
       rootProps: {
-        className: cx(cssClasses.root, cssClasses.emptyRoot)
+        className: cx(cssClasses.root, cssClasses.emptyRoot),
+        onClick: handleInsightsClick
       },
       data: results
     }));
@@ -34,7 +41,11 @@ var Hits = function Hits(_ref) {
       templateKey: "item",
       rootTagName: "li",
       rootProps: {
-        className: cssClasses.item
+        className: cssClasses.item,
+        onClick: function onClick(event) {
+          handleInsightsClick(event);
+          sendEvent('click:internal', hit, 'Hit Clicked');
+        }
       },
       key: hit.objectID,
       data: _objectSpread(_objectSpread({}, hit), {}, {
@@ -47,5 +58,4 @@ var Hits = function Hits(_ref) {
       sendEvent: sendEvent
     }));
   })));
-};
-export default Hits;
+}

package/es/components/InfiniteHits/InfiniteHits.d.ts

@@ -1,7 +1,7 @@
 
 import { h } from 'preact';
 import type { SendEventForHits, BindEventForHits } from '../../lib/utils';
-import type { ComponentCSSClasses, Hit } from '../../types';
+import type { ComponentCSSClasses, Hit, InsightsClient } from '../../types';
 import type { InfiniteHitsCSSClasses, InfiniteHitsTemplates } from '../../widgets/infinite-hits/infinite-hits';
 import type { SearchResults } from 'algoliasearch-helper';
 export type InfiniteHitsComponentCSSClasses = ComponentCSSClasses<InfiniteHitsCSSClasses>;
@@ -19,8 +19,9 @@ export type InfiniteHitsProps = {
     };
     isFirstPage: boolean;
     isLastPage: boolean;
+    insights?: InsightsClient;
     sendEvent: SendEventForHits;
     bindEvent: BindEventForHits;
 };
-declare const InfiniteHits: ({ results, hits, bindEvent, sendEvent, hasShowPrevious, showPrevious, showMore, isFirstPage, isLastPage, cssClasses, templateProps, }: InfiniteHitsProps) => h.JSX.Element;
+declare const InfiniteHits: ({ results, hits, insights, bindEvent, sendEvent, hasShowPrevious, showPrevious, showMore, isFirstPage, isLastPage, cssClasses, templateProps, }: InfiniteHitsProps) => h.JSX.Element;
 export default InfiniteHits;

package/es/components/InfiniteHits/InfiniteHits.js

@@ -7,11 +7,13 @@ function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input ==
 function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
 import { cx } from '@algolia/ui-components-shared';
 import { h } from 'preact';
+import { createInsightsEventHandler } from "../../lib/insights/listener.js";
 import { warning } from "../../lib/utils/index.js";
 import Template from "../Template/Template.js";
 var InfiniteHits = function InfiniteHits(_ref) {
   var results = _ref.results,
     hits = _ref.hits,
+    insights = _ref.insights,
     bindEvent = _ref.bindEvent,
     sendEvent = _ref.sendEvent,
     hasShowPrevious = _ref.hasShowPrevious,
@@ -21,11 +23,16 @@ var InfiniteHits = function InfiniteHits(_ref) {
     isLastPage = _ref.isLastPage,
     cssClasses = _ref.cssClasses,
     templateProps = _ref.templateProps;
+  var handleInsightsClick = createInsightsEventHandler({
+    insights: insights,
+    sendEvent: sendEvent
+  });
   if (results.hits.length === 0) {
     return h(Template, _extends({}, templateProps, {
       templateKey: "empty",
       rootProps: {
-        className: cx(cssClasses.root, cssClasses.emptyRoot)
+        className: cx(cssClasses.root, cssClasses.emptyRoot),
+        onClick: handleInsightsClick
       },
       data: results
     }));
@@ -47,7 +54,11 @@ var InfiniteHits = function InfiniteHits(_ref) {
       templateKey: "item",
       rootTagName: "li",
       rootProps: {
-        className: cssClasses.item
+        className: cssClasses.item,
+        onClick: function onClick(event) {
+          handleInsightsClick(event);
+          sendEvent('click:internal', hit, 'Hit Clicked');
+        }
       },
       key: hit.objectID,
       data: _objectSpread(_objectSpread({}, hit), {}, {

package/es/components/Pagination/Pagination.js

@@ -1,6 +1,7 @@
 import { cx } from '@algolia/ui-components-shared';
 import { h } from 'preact';
 import { isSpecialClick } from "../../lib/utils/index.js";
+import Template from "../Template/Template.js";
 function Pagination(props) {
   function createClickHandler(pageNumber) {
     return function (event) {
@@ -21,7 +22,8 @@ function Pagination(props) {
     ariaLabel: "First",
     className: props.cssClasses.firstPageItem,
     isDisabled: props.isFirstPage,
-    label: props.templates.first,
+    templates: props.templates,
+    templateKey: "first",
     pageNumber: 0,
     createURL: props.createURL,
     cssClasses: props.cssClasses,
@@ -30,7 +32,8 @@ function Pagination(props) {
     ariaLabel: "Previous",
     className: props.cssClasses.previousPageItem,
     isDisabled: props.isFirstPage,
-    label: props.templates.previous,
+    templates: props.templates,
+    templateKey: "previous",
     pageNumber: props.currentPage - 1,
     createURL: props.createURL,
     cssClasses: props.cssClasses,
@@ -41,7 +44,8 @@ function Pagination(props) {
       ariaLabel: "Page ".concat(pageNumber + 1),
       className: props.cssClasses.pageItem,
       isSelected: pageNumber === props.currentPage,
-      label: "".concat(pageNumber + 1),
+      templates: props.templates,
+      templateKey: "page",
       pageNumber: pageNumber,
       createURL: props.createURL,
       cssClasses: props.cssClasses,
@@ -51,7 +55,8 @@ function Pagination(props) {
     ariaLabel: "Next",
     className: props.cssClasses.nextPageItem,
     isDisabled: props.isLastPage,
-    label: props.templates.next,
+    templates: props.templates,
+    templateKey: "next",
     pageNumber: props.currentPage + 1,
     createURL: props.createURL,
     cssClasses: props.cssClasses,
@@ -60,7 +65,8 @@ function Pagination(props) {
     ariaLabel: "Last",
     className: props.cssClasses.lastPageItem,
     isDisabled: props.isLastPage,
-    label: props.templates.last,
+    templates: props.templates,
+    templateKey: "last",
     pageNumber: props.nbPages - 1,
     createURL: props.createURL,
     cssClasses: props.cssClasses,
@@ -68,7 +74,8 @@ function Pagination(props) {
   })));
 }
 function PaginationLink(_ref) {
-  var label = _ref.label,
+  var templates = _ref.templates,
+    templateKey = _ref.templateKey,
     ariaLabel = _ref.ariaLabel,
     pageNumber = _ref.pageNumber,
     className = _ref.className,
@@ -81,18 +88,28 @@ function PaginationLink(_ref) {
     createClickHandler = _ref.createClickHandler;
   return h("li", {
     className: cx(cssClasses.item, className, isDisabled && cssClasses.disabledItem, isSelected && cssClasses.selectedItem)
-  }, isDisabled ? h("span", {
-    className: cssClasses.link,
-    dangerouslySetInnerHTML: {
-      __html: label
+  }, isDisabled ? h(Template, {
+    rootTagName: "span",
+    rootProps: {
+      className: cssClasses.link
+    },
+    templateKey: templateKey,
+    templates: templates,
+    data: {
+      page: pageNumber + 1
     }
-  }) : h("a", {
-    className: cssClasses.link,
-    "aria-label": ariaLabel,
-    href: createURL(pageNumber),
-    onClick: createClickHandler(pageNumber),
-    dangerouslySetInnerHTML: {
-      __html: label
+  }) : h(Template, {
+    rootTagName: "a",
+    rootProps: {
+      className: cssClasses.link,
+      'aria-label': ariaLabel,
+      href: createURL(pageNumber),
+      onClick: createClickHandler(pageNumber)
+    },
+    templateKey: templateKey,
+    templates: templates,
+    data: {
+      page: pageNumber + 1
     }
   }));
 }

package/es/components/Panel/Panel.d.ts

@@ -3,7 +3,7 @@ import { h } from 'preact';
 import type { ComponentCSSClasses, UnknownWidgetFactory } from '../../types';
 import type { PanelCSSClasses, PanelSharedOptions, PanelTemplates } from '../../widgets/panel/panel';
 export type PanelComponentCSSClasses = ComponentCSSClasses<Omit<PanelCSSClasses, 'collapseIcon'>>;
-export type PanelComponentTemplates<TWidget extends UnknownWidgetFactory> = Required<PanelTemplates<TWidget>>;
+export type PanelComponentTemplates<TWidget extends UnknownWidgetFactory> = PanelTemplates<TWidget>;
 export type PanelProps<TWidget extends UnknownWidgetFactory> = {
     hidden: boolean;
     collapsible: boolean;

package/es/components/Template/Template.js

@@ -40,9 +40,12 @@ var Template = /*#__PURE__*/function (_Component) {
     key: "render",
     value: function render() {
       var _this = this;
-      process.env.NODE_ENV === 'development' ? warning(Object.keys(this.props.templates).every(function (key) {
-        return typeof _this.props.templates[key] === 'function';
-      }), "Hogan.js and string-based templates are deprecated and will not be supported in InstantSearch.js 5.x.\n\nYou can replace them with function-form templates and use either the provided `html` function or JSX templates.\n\nSee: https://www.algolia.com/doc/guides/building-search-ui/upgrade-guides/js/#upgrade-templates") : void 0;
+      if (process.env.NODE_ENV === 'development') {
+        var nonFunctionTemplates = Object.keys(this.props.templates).filter(function (key) {
+          return typeof _this.props.templates[key] !== 'function';
+        });
+        process.env.NODE_ENV === 'development' ? warning(nonFunctionTemplates.length === 0, "Hogan.js and string-based templates are deprecated and will not be supported in InstantSearch.js 5.x.\n\nYou can replace them with function-form templates and use either the provided `html` function or JSX templates.\n\nString-based templates: ".concat(nonFunctionTemplates.join(', '), ".\n\nSee: https://www.algolia.com/doc/guides/building-search-ui/upgrade-guides/js/#upgrade-templates")) : void 0;
+      }
       var RootTagName = this.props.rootTagName;
       var useCustomCompileOptions = this.props.useCustomCompileOptions[this.props.templateKey];
       var compileOptions = useCustomCompileOptions ? this.props.templatesConfig.compileOptions : {};

package/es/connectors/autocomplete/connectAutocomplete.js

@@ -35,7 +35,7 @@ var connectAutocomplete = function connectAutocomplete(renderFn) {
         renderState.indices.forEach(function (_ref3) {
           var sendEvent = _ref3.sendEvent,
             hits = _ref3.hits;
-          sendEvent('view', hits);
+          sendEvent('view:internal', hits);
         });
         renderFn(_objectSpread(_objectSpread({}, renderState), {}, {
           instantSearchInstance: instantSearchInstance

package/es/connectors/geo-search/connectGeoSearch.js

@@ -131,7 +131,7 @@ var connectGeoSearch = function connectGeoSearch(renderFn) {
         widgetState.internalToggleRefineOnMapMove = createInternalToggleRefinementOnMapMove(renderArgs, this.render.bind(this));
         widgetState.internalSetMapMoveSinceLastRefine = createInternalSetMapMoveSinceLastRefine(renderArgs, this.render.bind(this));
         var widgetRenderState = this.getWidgetRenderState(renderArgs);
-        sendEvent('view', widgetRenderState.items);
+        sendEvent('view:internal', widgetRenderState.items);
         renderFn(_objectSpread(_objectSpread({}, widgetRenderState), {}, {
           instantSearchInstance: instantSearchInstance
         }), isFirstRendering);

package/es/connectors/hierarchical-menu/connectHierarchicalMenu.js

@@ -155,7 +155,7 @@ var connectHierarchicalMenu = function connectHierarchicalMenu(renderFn) {
         }
         if (!_refine) {
           _refine = function _refine(facetValue) {
-            sendEvent('click', facetValue);
+            sendEvent('click:internal', facetValue);
             helper.toggleFacetRefinement(hierarchicalFacetName, facetValue).search();
           };
         }

package/es/connectors/hits/connectHits.js

@@ -34,7 +34,7 @@ var connectHits = function connectHits(renderFn) {
         renderFn(_objectSpread(_objectSpread({}, renderState), {}, {
           instantSearchInstance: renderOptions.instantSearchInstance
         }), false);
-        renderState.sendEvent('view', renderState.hits);
+        renderState.sendEvent('view:internal', renderState.hits);
       },
       getRenderState: function getRenderState(renderState, renderOptions) {
         return _objectSpread(_objectSpread({}, renderState), {}, {

package/es/connectors/infinite-hits/connectInfiniteHits.js

@@ -1,5 +1,6 @@
 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); }
-var _excluded = ["page"];
+var _excluded = ["page"],
+  _excluded2 = ["clickAnalytics", "userToken"];
 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; }
@@ -24,17 +25,24 @@ function getStateWithoutPage(state) {
     rest = _objectWithoutProperties(_ref, _excluded);
   return rest;
 }
+function normalizeState(state) {
+  var _ref2 = state || {},
+    clickAnalytics = _ref2.clickAnalytics,
+    userToken = _ref2.userToken,
+    rest = _objectWithoutProperties(_ref2, _excluded2);
+  return rest;
+}
 function getInMemoryCache() {
   var cachedHits = null;
   var cachedState = null;
   return {
-    read: function read(_ref2) {
-      var state = _ref2.state;
+    read: function read(_ref3) {
+      var state = _ref3.state;
       return isEqual(cachedState, getStateWithoutPage(state)) ? cachedHits : null;
     },
-    write: function write(_ref3) {
-      var state = _ref3.state,
-        hits = _ref3.hits;
+    write: function write(_ref4) {
+      var state = _ref4.state,
+        hits = _ref4.hits;
       cachedState = getStateWithoutPage(state);
       cachedHits = hits;
     }
@@ -54,15 +62,15 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
   // @TODO: this should be a generic, but a Connector can not yet be generic itself
 
   return function (widgetParams) {
-    var _ref4 = widgetParams || {},
-      _ref4$escapeHTML = _ref4.escapeHTML,
-      escapeHTML = _ref4$escapeHTML === void 0 ? true : _ref4$escapeHTML,
-      _ref4$transformItems = _ref4.transformItems,
-      transformItems = _ref4$transformItems === void 0 ? function (items) {
+    var _ref5 = widgetParams || {},
+      _ref5$escapeHTML = _ref5.escapeHTML,
+      escapeHTML = _ref5$escapeHTML === void 0 ? true : _ref5$escapeHTML,
+      _ref5$transformItems = _ref5.transformItems,
+      transformItems = _ref5$transformItems === void 0 ? function (items) {
         return items;
-      } : _ref4$transformItems,
-      _ref4$cache = _ref4.cache,
-      cache = _ref4$cache === void 0 ? getInMemoryCache() : _ref4$cache;
+      } : _ref5$transformItems,
+      _ref5$cache = _ref5.cache,
+      cache = _ref5$cache === void 0 ? getInMemoryCache() : _ref5$cache;
     var showPrevious;
     var showMore;
     var sendEvent;
@@ -93,7 +101,7 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
         // avoid updating the browser URL when the user displays the previous page.
         helper.overrideStateWithoutTriggeringChangeEvent(_objectSpread(_objectSpread({}, helper.state), {}, {
           page: getFirstReceivedPage(helper.state, cache.read({
-            state: helper.state
+            state: normalizeState(helper.state)
           }) || {}) - 1
         })).searchWithoutTriggeringOnStateChange();
       };
@@ -101,7 +109,7 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
     var getShowMore = function getShowMore(helper) {
       return function () {
         helper.setPage(getLastReceivedPage(helper.state, cache.read({
-          state: helper.state
+          state: normalizeState(helper.state)
         }) || {}) + 1).search();
       };
     };
@@ -118,19 +126,19 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
         renderFn(_objectSpread(_objectSpread({}, widgetRenderState), {}, {
           instantSearchInstance: instantSearchInstance
         }), false);
-        sendEvent('view', widgetRenderState.currentPageHits);
+        sendEvent('view:internal', widgetRenderState.currentPageHits);
       },
       getRenderState: function getRenderState(renderState, renderOptions) {
         return _objectSpread(_objectSpread({}, renderState), {}, {
           infiniteHits: this.getWidgetRenderState(renderOptions)
         });
       },
-      getWidgetRenderState: function getWidgetRenderState(_ref5) {
-        var results = _ref5.results,
-          helper = _ref5.helper,
-          parent = _ref5.parent,
-          existingState = _ref5.state,
-          instantSearchInstance = _ref5.instantSearchInstance;
+      getWidgetRenderState: function getWidgetRenderState(_ref6) {
+        var results = _ref6.results,
+          helper = _ref6.helper,
+          parent = _ref6.parent,
+          existingState = _ref6.state,
+          instantSearchInstance = _ref6.instantSearchInstance;
         var isFirstPage;
         var currentPageHits = [];
         /**
@@ -140,7 +148,7 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
          */
         var state = parent.getPreviousState() || existingState;
         var cachedHits = cache.read({
-          state: state
+          state: normalizeState(state)
         }) || {};
         if (!results) {
           showPrevious = getShowPrevious(helper);
@@ -170,7 +178,7 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
           if (cachedHits[_page] === undefined && !results.__isArtificial && instantSearchInstance.status === 'idle') {
             cachedHits[_page] = transformedHits;
             cache.write({
-              state: state,
+              state: normalizeState(state),
               hits: cachedHits
             });
           }
@@ -192,8 +200,8 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
           widgetParams: widgetParams
         };
       },
-      dispose: function dispose(_ref6) {
-        var state = _ref6.state;
+      dispose: function dispose(_ref7) {
+        var state = _ref7.state;
         unmountFn();
         var stateWithoutPage = state.setQueryParameter('page', undefined);
         if (!escapeHTML) {
@@ -203,8 +211,8 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
           return _objectSpread(_objectSpread({}, acc), {}, _defineProperty({}, key, undefined));
         }, {}));
       },
-      getWidgetUiState: function getWidgetUiState(uiState, _ref7) {
-        var searchParameters = _ref7.searchParameters;
+      getWidgetUiState: function getWidgetUiState(uiState, _ref8) {
+        var searchParameters = _ref8.searchParameters;
         var page = searchParameters.page || 0;
         if (!page) {
           // return without adding `page` to uiState
@@ -217,8 +225,8 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
           page: page + 1
         });
       },
-      getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref8) {
-        var uiState = _ref8.uiState;
+      getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref9) {
+        var uiState = _ref9.uiState;
         var widgetSearchParameters = searchParameters;
         if (escapeHTML) {
           widgetSearchParameters = searchParameters.setQueryParameters(TAG_PLACEHOLDER);

package/es/connectors/menu/connectMenu.js

@@ -121,7 +121,7 @@ var connectMenu = function connectMenu(renderFn) {
             var _helper$getHierarchic = helper.getHierarchicalFacetBreadcrumb(attribute),
               _helper$getHierarchic2 = _slicedToArray(_helper$getHierarchic, 1),
               refinedItem = _helper$getHierarchic2[0];
-            sendEvent('click', facetValue ? facetValue : refinedItem);
+            sendEvent('click:internal', facetValue ? facetValue : refinedItem);
             helper.toggleFacetRefinement(attribute, facetValue ? facetValue : refinedItem).search();
           };
         }

package/es/connectors/numeric-menu/connectNumericMenu.js

@@ -137,7 +137,7 @@ var connectNumericMenu = function connectNumericMenu(renderFn) {
         if (!connectorState.refine) {
           connectorState.refine = function (facetValue) {
             var refinedState = getRefinedState(helper.state, attribute, facetValue);
-            connectorState.sendEvent('click', facetValue);
+            connectorState.sendEvent('click:internal', facetValue);
             helper.setState(refinedState).search();
           };
         }

package/es/connectors/rating-menu/connectRatingMenu.js

@@ -35,10 +35,13 @@ var createSendEvent = function createSendEvent(_ref) {
       instantSearchInstance.sendEventToInsights(args[0]);
       return;
     }
-    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];
     if (eventType !== 'click') {
       return;
     }
@@ -48,6 +51,7 @@ var createSendEvent = function createSendEvent(_ref) {
         insightsMethod: 'clickedFilters',
         widgetType: $$type,
         eventType: eventType,
+        eventModifier: eventModifier,
         payload: {
           eventName: eventName,
           index: helper.getIndex(),
@@ -123,7 +127,7 @@ var connectRatingMenu = function connectRatingMenu(renderFn) {
       return emptyState;
     }
     var toggleRefinement = function toggleRefinement(helper, facetValue) {
-      sendEvent('click', facetValue);
+      sendEvent('click:internal', facetValue);
       helper.setState(getRefinedState(helper.state, facetValue)).search();
     };
     var connectorState = {

package/es/connectors/refinement-list/connectRefinementList.js

@@ -172,7 +172,7 @@ var connectRefinementList = function connectRefinementList(renderFn) {
             widgetType: this.$$type
           });
           triggerRefine = function triggerRefine(facetValue) {
-            sendEvent('click', facetValue);
+            sendEvent('click:internal', facetValue);
             helper.toggleFacetRefinement(attribute, facetValue).search();
           };
           searchForFacetValues = createSearchForFacetValues(helper, this);

package/es/connectors/toggle-refinement/connectToggleRefinement.js

@@ -4,6 +4,12 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 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); }
+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 { checkRendering, escapeFacetValue, createDocumentationMessageGenerator, find, noop, toArray, warning } from "../../lib/utils/index.js";
 var withUsage = createDocumentationMessageGenerator({
   name: 'toggle-refinement',
@@ -23,10 +29,13 @@ var createSendEvent = function createSendEvent(_ref) {
       instantSearchInstance.sendEventToInsights(args[0]);
       return;
     }
-    var eventType = args[0],
-      isRefined = args[1],
+    var isRefined = 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];
     if (eventType !== 'click' || on === undefined) {
       return;
     }
@@ -38,6 +47,7 @@ var createSendEvent = function createSendEvent(_ref) {
         insightsMethod: 'clickedFilters',
         widgetType: $$type,
         eventType: eventType,
+        eventModifier: eventModifier,
         payload: {
           eventName: eventName,
           index: helper.getIndex(),
@@ -84,7 +94,7 @@ var connectToggleRefinement = function connectToggleRefinement(renderFn) {
           },
           isRefined = _ref3.isRefined;
         if (!isRefined) {
-          sendEvent('click', isRefined);
+          sendEvent('click:internal', isRefined);
           if (hasAnOffValue) {
             off.forEach(function (v) {
               return helper.removeDisjunctiveFacetRefinement(attribute, v);

package/es/helpers/highlight.d.ts

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

package/es/helpers/highlight.js

@@ -1,6 +1,10 @@
 import { component } from "../lib/suit.js";
 import { getPropertyByPath, TAG_REPLACEMENT, warning } from "../lib/utils/index.js";
 var suit = component('Highlight');
+
+/**
+ * @deprecated use html tagged templates and the Highlight component instead
+ */
 export default function highlight(_ref) {
   var attribute = _ref.attribute,
     _ref$highlightedTagNa = _ref.highlightedTagName,
@@ -8,6 +12,7 @@ export default function highlight(_ref) {
     hit = _ref.hit,
     _ref$cssClasses = _ref.cssClasses,
     cssClasses = _ref$cssClasses === void 0 ? {} : _ref$cssClasses;
+  process.env.NODE_ENV === 'development' ? warning(false, "`instantsearch.highlight` function has been deprecated. It is still supported in 4.x releases, but not further. It is replaced by the `Highlight` 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/insights.d.ts

@@ -1,9 +1,10 @@
 import type { InsightsClientMethod, InsightsClientPayload } from '../types';
+/** @deprecated use bindEvent instead */
 export declare function readDataAttributes(domElement: HTMLElement): {
     method: InsightsClientMethod;
     payload: Partial<InsightsClientPayload>;
 };
-export declare function hasDataAttributes(domElement: HTMLElement): boolean;
+/** @deprecated use bindEvent instead */
 export declare function writeDataAttributes({ method, payload, }: {
     method: InsightsClientMethod;
     payload: Partial<InsightsClientPayload>;

package/es/helpers/insights.js

@@ -1,5 +1,6 @@
 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 { warning, serializePayload, deserializePayload } from "../lib/utils/index.js";
+/** @deprecated use bindEvent instead */
 export function readDataAttributes(domElement) {
   var method = domElement.getAttribute('data-insights-method');
   var serializedPayload = domElement.getAttribute('data-insights-payload');
@@ -16,9 +17,8 @@ export function readDataAttributes(domElement) {
     throw new Error('The insights helper was unable to parse `data-insights-payload`.');
   }
 }
-export function hasDataAttributes(domElement) {
-  return domElement.hasAttribute('data-insights-method');
-}
+
+/** @deprecated use bindEvent instead */
 export function writeDataAttributes(_ref) {
   var method = _ref.method,
     payload = _ref.payload;