instantsearch.js 4.54.1 → 4.56.0

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/current-refinements/connectCurrentRefinements.d.ts

@@ -53,7 +53,7 @@ export type CurrentRefinementsConnectorParamsItem = {
     /**
      * Removes the given refinement and triggers a new search.
      */
-    refine(refinement: CurrentRefinementsConnectorParamsRefinement): void;
+    refine: (refinement: CurrentRefinementsConnectorParamsRefinement) => void;
 };
 export type CurrentRefinementsConnectorParams = {
     /**
@@ -87,7 +87,7 @@ export type CurrentRefinementsRenderState = {
     /**
      * Removes the given refinement and triggers a new search.
      */
-    refine(refinement: CurrentRefinementsConnectorParamsRefinement): void;
+    refine: (refinement: CurrentRefinementsConnectorParamsRefinement) => void;
     /**
      * Generates a URL for the next state.
      */

package/es/connectors/dynamic-widgets/connectDynamicWidgets.d.ts

@@ -11,10 +11,10 @@ export type DynamicWidgetsConnectorParams = {
      * Function to return a fallback widget when an attribute isn't found in
      * `widgets`.
      */
-    fallbackWidget?(args: {
+    fallbackWidget?: (args: {
         /** The attribute name to create a widget for. */
         attribute: string;
-    }): Widget;
+    }) => Widget;
     /**
      * Function to transform the items to render.
      * The function also exposes the full search response.

package/es/connectors/geo-search/connectGeoSearch.d.ts

@@ -15,7 +15,7 @@ export type GeoSearchRenderState<THit extends BaseHit = Record<string, any>> = {
     /**
      * Reset the current bounding box refinement.
      */
-    clearMapRefinement(): void;
+    clearMapRefinement: () => void;
     /**
      * The current bounding box of the search.
      */
@@ -23,15 +23,15 @@ export type GeoSearchRenderState<THit extends BaseHit = Record<string, any>> = {
     /**
      * Return true if the map has move since the last refinement.
      */
-    hasMapMoveSinceLastRefine(): boolean;
+    hasMapMoveSinceLastRefine: () => boolean;
     /**
      * Return true if the current refinement is set with the map bounds.
      */
-    isRefinedWithMap(): boolean;
+    isRefinedWithMap: () => boolean;
     /**
      * Return true if the user is able to refine on map move.
      */
-    isRefineOnMapMove(): boolean;
+    isRefineOnMapMove: () => boolean;
     /**
      * The matched hits from Algolia API.
      */
@@ -43,7 +43,7 @@ export type GeoSearchRenderState<THit extends BaseHit = Record<string, any>> = {
     /**
      * Sets a bounding box to filter the results from the given map bounds.
      */
-    refine(bounds: Bounds): void;
+    refine: (bounds: Bounds) => void;
     /**
      * Send event to insights middleware
      */
@@ -53,11 +53,11 @@ export type GeoSearchRenderState<THit extends BaseHit = Record<string, any>> = {
      * called on each map move. The call to the function triggers a new rendering
      * only when the value change.
      */
-    setMapMoveSinceLastRefine(): void;
+    setMapMoveSinceLastRefine: () => void;
     /**
      * Toggle the fact that the user is able to refine on map move.
      */
-    toggleRefineOnMapMove(): void;
+    toggleRefineOnMapMove: () => void;
 };
 export type GeoSearchConnectorParams<THit extends BaseHit = Record<string, any>> = {
     /**

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; }
@@ -13,7 +14,7 @@ function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToAr
 function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
 function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
 function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
-import { escapeHits, TAG_PLACEHOLDER, checkRendering, createDocumentationMessageGenerator, isEqual, addAbsolutePosition, addQueryID, noop, createSendEventForHits, createBindEventForHits } from "../../lib/utils/index.js";
+import { escapeHits, TAG_PLACEHOLDER, checkRendering, createDocumentationMessageGenerator, isEqual, addAbsolutePosition, addQueryID, noop, createSendEventForHits, createBindEventForHits, walkIndex } from "../../lib/utils/index.js";
 var withUsage = createDocumentationMessageGenerator({
   name: 'infinite-hits',
   connector: true
@@ -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);
@@ -157,6 +165,7 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
           });
           isFirstPage = state.page === undefined || getFirstReceivedPage(state, cachedHits) === 0;
         } else {
+          var _results$disjunctiveF, _results$facets, _results$hierarchical;
           var _state$page3 = state.page,
             _page = _state$page3 === void 0 ? 0 : _state$page3;
           if (escapeHTML && results.hits.length > 0) {
@@ -167,10 +176,24 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
           var transformedHits = transformItems(hitsWithAbsolutePositionAndQueryID, {
             results: results
           });
-          if (cachedHits[_page] === undefined && !results.__isArtificial && instantSearchInstance.status === 'idle') {
+
+          /*
+            With dynamic widgets, facets are not included in the state before their relevant widgets are mounted. Until then, we need to bail out of writing this incomplete state representation in cache.
+          */
+          var hasDynamicWidgets = false;
+          walkIndex(instantSearchInstance.mainIndex, function (indexWidget) {
+            if (!hasDynamicWidgets && indexWidget.getWidgets().some(function (_ref7) {
+              var $$type = _ref7.$$type;
+              return $$type === 'ais.dynamicWidgets';
+            })) {
+              hasDynamicWidgets = true;
+            }
+          });
+          var hasNoFacets = !((_results$disjunctiveF = results.disjunctiveFacets) !== null && _results$disjunctiveF !== void 0 && _results$disjunctiveF.length) && !((_results$facets = results.facets) !== null && _results$facets !== void 0 && _results$facets.length) && !((_results$hierarchical = results.hierarchicalFacets) !== null && _results$hierarchical !== void 0 && _results$hierarchical.length);
+          if (cachedHits[_page] === undefined && !results.__isArtificial && instantSearchInstance.status === 'idle' && !(hasDynamicWidgets && hasNoFacets)) {
             cachedHits[_page] = transformedHits;
             cache.write({
-              state: state,
+              state: normalizeState(state),
               hits: cachedHits
             });
           }
@@ -192,8 +215,8 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
           widgetParams: widgetParams
         };
       },
-      dispose: function dispose(_ref6) {
-        var state = _ref6.state;
+      dispose: function dispose(_ref8) {
+        var state = _ref8.state;
         unmountFn();
         var stateWithoutPage = state.setQueryParameter('page', undefined);
         if (!escapeHTML) {
@@ -203,8 +226,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, _ref9) {
+        var searchParameters = _ref9.searchParameters;
         var page = searchParameters.page || 0;
         if (!page) {
           // return without adding `page` to uiState
@@ -217,8 +240,8 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
           page: page + 1
         });
       },
-      getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref8) {
-        var uiState = _ref8.uiState;
+      getWidgetSearchParameters: function getWidgetSearchParameters(searchParameters, _ref10) {
+        var uiState = _ref10.uiState;
         var widgetSearchParameters = searchParameters;
         if (escapeHTML) {
           widgetSearchParameters = searchParameters.setQueryParameters(TAG_PLACEHOLDER);

package/es/connectors/menu/connectMenu.d.ts

@@ -61,7 +61,7 @@ export type MenuRenderState = {
     /**
      * Filter the search to item value.
      */
-    refine(value: string): void;
+    refine: (value: string) => void;
     /**
      * True if refinement can be applied.
      */
@@ -73,7 +73,7 @@ export type MenuRenderState = {
     /**
      * Toggles the number of values displayed between `limit` and `showMore.limit`.
      */
-    toggleShowMore(): void;
+    toggleShowMore: () => void;
     /**
      * `true` if the toggleShowMore button can be activated (enough items to display more or
      * already displaying more than `limit` items)

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

@@ -14,7 +14,7 @@ export type PaginationRenderState = {
     /** Creates URLs for the next state, the number is the page to generate the URL for. */
     createURL: CreateURL<number>;
     /** Sets the current page and triggers a search. */
-    refine(page: number): void;
+    refine: (page: number) => void;
     /** true if this search returned more than one page */
     canRefine: boolean;
     /** The number of the page currently displayed. */

package/es/connectors/range/connectRange.d.ts

@@ -14,7 +14,7 @@ export type RangeRenderState = {
      * previously set bound or to set an infinite bound.
      * @param rangeValue tuple of [min, max] bounds
      */
-    refine(rangeValue: RangeBoundaries): void;
+    refine: (rangeValue: RangeBoundaries) => void;
     /**
      * Indicates whether this widget can be refined
      */
@@ -36,8 +36,8 @@ export type RangeRenderState = {
      * Both functions take a `number` as input and should output a `string`.
      */
     format: {
-        from(fromValue: number): string;
-        to(toValue: number): string;
+        from: (fromValue: number) => string;
+        to: (toValue: number) => string;
     };
 };
 export type RangeConnectorParams = {

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

@@ -79,7 +79,7 @@ export type RefinementListRenderState = {
     /**
      * Action to apply selected refinements.
      */
-    refine(value: string): void;
+    refine: (value: string) => void;
     /**
      * Send event to insights middleware
      */
@@ -87,7 +87,7 @@ export type RefinementListRenderState = {
     /**
      * Searches for values inside the list.
      */
-    searchForItems(query: string): void;
+    searchForItems: (query: string) => void;
     /**
      * `true` if the values are from an index search.
      */
@@ -108,7 +108,7 @@ export type RefinementListRenderState = {
     /**
      * Toggles the number of values displayed between `limit` and `showMoreLimit`.
      */
-    toggleShowMore(): void;
+    toggleShowMore: () => void;
 };
 export type RefinementListWidgetDescription = {
     $$type: 'ais.refinementList';

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/relevant-sort/connectRelevantSort.d.ts

@@ -1,6 +1,6 @@
 import type { Connector, WidgetRenderState } from '../../types';
 export type RelevantSortConnectorParams = Record<string, unknown>;
-type Refine = (relevancyStrictness: number) => void;
+type Refine = (relevancyStrictness: number | undefined) => void;
 export type RelevantSortRenderState = {
     /**
      * Indicates if it has appliedRelevancyStrictness greater than zero

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/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;

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';
@@ -10,9 +10,9 @@ type NoInfer<T> = T extends infer S ? S : never;
  */
 export type InstantSearchOptions<TUiState extends UiState = UiState, TRouteState = TUiState> = {
     /**
-     * The name of the main index
+     * The name of the main index. If no indexName is provided, you have to manually add an index widget.
      */
-    indexName: string;
+    indexName?: string;
     /**
      * The search client to plug to InstantSearch.js
      *
@@ -61,7 +61,7 @@ export type InstantSearchOptions<TUiState extends UiState = UiState, TRouteState
      */
     onStateChange?: (params: {
         uiState: TUiState;
-        setUiState(uiState: TUiState | ((previousUiState: TUiState) => TUiState)): void;
+        setUiState: (uiState: TUiState | ((previousUiState: TUiState) => TUiState)) => void;
     }) => void;
     /**
      * Injects a `uiState` to the `instantsearch` instance. You can use this option
@@ -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`.
@@ -112,8 +122,8 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
     _searchFunction?: InstantSearchOptions['searchFunction'];
     _mainHelperSearch?: AlgoliaSearchHelper['search'];
     middleware: Array<{
-        creator: Middleware;
-        instance: MiddlewareDefinition;
+        creator: Middleware<TUiState>;
+        instance: MiddlewareDefinition<TUiState>;
     }>;
     sendEventToInsights: (event: InsightsEvent) => void;
     /**
@@ -133,11 +143,11 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
     /**
      * Hooks a middleware into the InstantSearch lifecycle.
      */
-    use(...middleware: Middleware[]): this;
+    use(...middleware: Array<Middleware<TUiState>>): this;
     /**
      * Removes a middleware from the InstantSearch lifecycle.
      */
-    unuse(...middlewareToUnuse: Middleware[]): this;
+    unuse(...middlewareToUnuse: Array<Middleware<TUiState>>): this;
     EXPERIMENTAL_use(...middleware: Middleware[]): this;
     /**
      * Adds a widget to the search instance.
@@ -183,12 +193,12 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
      */
     dispose(): void;
     scheduleSearch: (() => void) & {
-        wait(): Promise<void>;
-        cancel(): void;
+        wait: () => Promise<void>;
+        cancel: () => void;
     };
     scheduleRender: ((shouldResetStatus?: boolean) => void) & {
-        wait(): Promise<void>;
-        cancel(): void;
+        wait: () => Promise<void>;
+        cancel: () => void;
     };
     scheduleStalledRender(): void;
     /**
@@ -199,8 +209,8 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
     setUiState(uiState: TUiState | ((previousUiState: TUiState) => TUiState), callOnStateChange?: boolean): void;
     getUiState(): TUiState;
     onInternalStateChange: (() => void) & {
-        wait(): Promise<void>;
-        cancel(): void;
+        wait: () => Promise<void>;
+        cancel: () => void;
     };
     createURL(nextState?: TUiState): string;
     refresh(): void;