instantsearch.js 4.76.0 → 4.77.0

package/dist/instantsearch.development.js

@@ -1,4 +1,4 @@
-/*! InstantSearch.js 4.76.0 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch */
+/*! InstantSearch.js 4.77.0 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch */
 (function (global, factory) {
   typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
   typeof define === 'function' && define.amd ? define(factory) :
@@ -11565,6 +11565,7 @@
       if (!objectIDs || objectIDs.length === 0) {
         throw new Error(withUsage$f('The `objectIDs` option is required.'));
       }
+      var sendEvent;
       return {
         dependsOn: 'recommend',
         $$type: 'ais.relatedProducts',
@@ -11583,21 +11584,37 @@
           return renderState;
         },
         getWidgetRenderState: function getWidgetRenderState(_ref2) {
-          var results = _ref2.results;
+          var results = _ref2.results,
+            helper = _ref2.helper,
+            instantSearchInstance = _ref2.instantSearchInstance;
+          if (!sendEvent) {
+            sendEvent = createSendEventForHits({
+              instantSearchInstance: instantSearchInstance,
+              getIndex: function getIndex() {
+                return helper.getIndex();
+              },
+              widgetType: this.$$type
+            });
+          }
           if (results === null || results === undefined) {
             return {
               items: [],
-              widgetParams: widgetParams
+              widgetParams: widgetParams,
+              sendEvent: sendEvent
             };
           }
           if (escapeHTML && results.hits.length > 0) {
             results.hits = escapeHits(results.hits);
           }
+          var itemsWithAbsolutePosition = addAbsolutePosition(results.hits, 0, 1);
+          var itemsWithAbsolutePositionAndQueryID = addQueryID(itemsWithAbsolutePosition, results.queryID);
+          var transformedItems = transformItems(itemsWithAbsolutePositionAndQueryID, {
+            results: results
+          });
           return {
-            items: transformItems(results.hits, {
-              results: results
-            }),
-            widgetParams: widgetParams
+            items: transformedItems,
+            widgetParams: widgetParams,
+            sendEvent: sendEvent
           };
         },
         dispose: function dispose(_ref3) {
@@ -12474,6 +12491,7 @@
       if (facetName && !facetValue || !facetName && facetValue) {
         throw new Error(withUsage$l("When you provide facetName (received type ".concat(getObjectType(facetName), "), you must also provide facetValue (received type ").concat(getObjectType(facetValue), ").")));
       }
+      var sendEvent;
       return {
         dependsOn: 'recommend',
         $$type: 'ais.trendingItems',
@@ -12492,21 +12510,37 @@
           return renderState;
         },
         getWidgetRenderState: function getWidgetRenderState(_ref2) {
-          var results = _ref2.results;
+          var results = _ref2.results,
+            helper = _ref2.helper,
+            instantSearchInstance = _ref2.instantSearchInstance;
+          if (!sendEvent) {
+            sendEvent = createSendEventForHits({
+              instantSearchInstance: instantSearchInstance,
+              getIndex: function getIndex() {
+                return helper.getIndex();
+              },
+              widgetType: this.$$type
+            });
+          }
           if (results === null || results === undefined) {
             return {
               items: [],
-              widgetParams: widgetParams
+              widgetParams: widgetParams,
+              sendEvent: sendEvent
             };
           }
           if (escapeHTML && results.hits.length > 0) {
             results.hits = escapeHits(results.hits);
           }
+          var itemsWithAbsolutePosition = addAbsolutePosition(results.hits, 0, 1);
+          var itemsWithAbsolutePositionAndQueryID = addQueryID(itemsWithAbsolutePosition, results.queryID);
+          var transformedItems = transformItems(itemsWithAbsolutePositionAndQueryID, {
+            results: results
+          });
           return {
-            items: transformItems(results.hits, {
-              results: results
-            }),
-            widgetParams: widgetParams
+            items: transformedItems,
+            widgetParams: widgetParams,
+            sendEvent: sendEvent
           };
         },
         dispose: function dispose(_ref3) {
@@ -13559,6 +13593,7 @@
       if (!objectIDs || objectIDs.length === 0) {
         throw new Error(withUsage$s('The `objectIDs` option is required.'));
       }
+      var sendEvent;
       return {
         dependsOn: 'recommend',
         $$type: 'ais.frequentlyBoughtTogether',
@@ -13577,22 +13612,37 @@
           return renderState;
         },
         getWidgetRenderState: function getWidgetRenderState(_ref2) {
-          var results = _ref2.results;
+          var results = _ref2.results,
+            helper = _ref2.helper,
+            instantSearchInstance = _ref2.instantSearchInstance;
+          if (!sendEvent) {
+            sendEvent = createSendEventForHits({
+              instantSearchInstance: instantSearchInstance,
+              getIndex: function getIndex() {
+                return helper.getIndex();
+              },
+              widgetType: this.$$type
+            });
+          }
           if (results === null || results === undefined) {
             return {
               items: [],
-              widgetParams: widgetParams
+              widgetParams: widgetParams,
+              sendEvent: sendEvent
             };
           }
           if (escapeHTML && results.hits.length > 0) {
             results.hits = escapeHits(results.hits);
           }
-          var transformedItems = transformItems(results.hits, {
+          var itemsWithAbsolutePosition = addAbsolutePosition(results.hits, 0, 1);
+          var itemsWithAbsolutePositionAndQueryID = addQueryID(itemsWithAbsolutePosition, results.queryID);
+          var transformedItems = transformItems(itemsWithAbsolutePositionAndQueryID, {
             results: results
           });
           return {
             items: transformedItems,
-            widgetParams: widgetParams
+            widgetParams: widgetParams,
+            sendEvent: sendEvent
           };
         },
         dispose: function dispose(_ref3) {
@@ -13639,6 +13689,7 @@
       if (!objectIDs || objectIDs.length === 0) {
         throw new Error(withUsage$t('The `objectIDs` option is required.'));
       }
+      var sendEvent;
       return {
         dependsOn: 'recommend',
         $$type: 'ais.lookingSimilar',
@@ -13657,21 +13708,37 @@
           return renderState;
         },
         getWidgetRenderState: function getWidgetRenderState(_ref2) {
-          var results = _ref2.results;
+          var results = _ref2.results,
+            helper = _ref2.helper,
+            instantSearchInstance = _ref2.instantSearchInstance;
+          if (!sendEvent) {
+            sendEvent = createSendEventForHits({
+              instantSearchInstance: instantSearchInstance,
+              getIndex: function getIndex() {
+                return helper.getIndex();
+              },
+              widgetType: this.$$type
+            });
+          }
           if (results === null || results === undefined) {
             return {
               items: [],
-              widgetParams: widgetParams
+              widgetParams: widgetParams,
+              sendEvent: sendEvent
             };
           }
           if (escapeHTML && results.hits.length > 0) {
             results.hits = escapeHits(results.hits);
           }
+          var itemsWithAbsolutePosition = addAbsolutePosition(results.hits, 0, 1);
+          var itemsWithAbsolutePositionAndQueryID = addQueryID(itemsWithAbsolutePosition, results.queryID);
+          var transformedItems = transformItems(itemsWithAbsolutePositionAndQueryID, {
+            results: results
+          });
           return {
-            items: transformItems(results.hits, {
-              results: results
-            }),
-            widgetParams: widgetParams
+            items: transformedItems,
+            widgetParams: widgetParams,
+            sendEvent: sendEvent
           };
         },
         dispose: function dispose(_ref3) {
@@ -16313,7 +16380,7 @@
     };
   }
 
-  var version$1 = '4.76.0';
+  var version$1 = '4.77.0';
 
   var withUsage$v = createDocumentationMessageGenerator({
     name: 'instantsearch'
@@ -17173,8 +17240,12 @@
         return createElement("li", {
           key: item.objectID,
           className: classNames.item,
-          onClick: sendEvent,
-          onAuxClick: sendEvent
+          onClick: function onClick() {
+            sendEvent('click:internal', item, 'Item Clicked');
+          },
+          onAuxClick: function onAuxClick() {
+            sendEvent('click:internal', item, 'Item Clicked');
+          }
         }, createElement(ItemComponent, {
           item: item
         }));
@@ -17182,7 +17253,7 @@
     };
   }
 
-  var _excluded$9 = ["listRef", "nextButtonRef", "previousButtonRef", "carouselIdRef", "classNames", "itemComponent", "previousIconComponent", "nextIconComponent", "items", "translations"];
+  var _excluded$9 = ["listRef", "nextButtonRef", "previousButtonRef", "carouselIdRef", "classNames", "itemComponent", "previousIconComponent", "nextIconComponent", "items", "translations", "sendEvent"];
   function ownKeys$1(e, r) {
     var t = Object.keys(e);
     if (Object.getOwnPropertySymbols) {
@@ -17257,6 +17328,7 @@
         NextIconComponent = _userProps$nextIconCo === void 0 ? NextIconDefaultComponent : _userProps$nextIconCo,
         items = userProps.items,
         userTranslations = userProps.translations,
+        sendEvent = userProps.sendEvent,
         props = _objectWithoutProperties$1(userProps, _excluded$9);
       var translations = _objectSpread({
         listLabel: 'Items',
@@ -17331,7 +17403,13 @@
           key: item.objectID,
           className: cx(cssClasses.item),
           "aria-roledescription": "slide",
-          "aria-label": "".concat(index + 1, " of ").concat(items.length)
+          "aria-label": "".concat(index + 1, " of ").concat(items.length),
+          onClick: function onClick() {
+            sendEvent('click:internal', item, 'Item Clicked');
+          },
+          onAuxClick: function onAuxClick() {
+            sendEvent('click:internal', item, 'Item Clicked');
+          }
         }, createElement(ItemComponent, {
           item: item
         }));
@@ -17843,11 +17921,14 @@
       var items = _ref2.items,
         widgetTemplates = _ref2.templates,
         _ref2$cssClasses = _ref2.cssClasses,
-        widgetCssClasses = _ref2$cssClasses === void 0 ? {} : _ref2$cssClasses;
+        widgetCssClasses = _ref2$cssClasses === void 0 ? {} : _ref2$cssClasses,
+        _ref2$sendEvent = _ref2.sendEvent,
+        sendEvent = _ref2$sendEvent === void 0 ? function () {} : _ref2$sendEvent;
       var previous = templates.previous,
         next = templates.next;
       return h(CarouselWithRefs, {
         items: items,
+        sendEvent: sendEvent,
         itemComponent: widgetTemplates.item,
         previousIconComponent: previous ? function () {
           return previous({
@@ -22575,7 +22656,8 @@
     return function renderer(_ref2, isFirstRendering) {
       var items = _ref2.items,
         results = _ref2.results,
-        instantSearchInstance = _ref2.instantSearchInstance;
+        instantSearchInstance = _ref2.instantSearchInstance,
+        sendEvent = _ref2.sendEvent;
       if (isFirstRendering) {
         renderState.templateProps = prepareTemplateProps({
           defaultTemplates: {},
@@ -22599,7 +22681,8 @@
         return h(Template, _extends({}, renderState.templateProps, {
           templateKey: "item",
           rootTagName: "fragment",
-          data: item
+          data: item,
+          sendEvent: sendEvent
         }));
       } : undefined;
       var emptyComponent = templates.empty ? function () {
@@ -22614,6 +22697,7 @@
           templateKey: "layout",
           rootTagName: "fragment",
           data: {
+            sendEvent: sendEvent,
             items: data.items,
             templates: {
               item: templates.item ? function (_ref4) {
@@ -22621,7 +22705,8 @@
                 return h(Template, _extends({}, renderState.templateProps, {
                   templateKey: "item",
                   rootTagName: "fragment",
-                  data: item
+                  data: item,
+                  sendEvent: sendEvent
                 }));
               } : undefined
             },
@@ -22629,12 +22714,13 @@
               list: data.classNames.list,
               item: data.classNames.item
             }
-          }
+          },
+          sendEvent: sendEvent
         }));
       } : undefined;
       P(h(RelatedProducts, {
         items: items,
-        sendEvent: function sendEvent() {},
+        sendEvent: sendEvent,
         classNames: cssClasses,
         headerComponent: headerComponent,
         itemComponent: itemComponent,
@@ -24755,7 +24841,8 @@
     return function renderer(_ref2, isFirstRendering) {
       var items = _ref2.items,
         results = _ref2.results,
-        instantSearchInstance = _ref2.instantSearchInstance;
+        instantSearchInstance = _ref2.instantSearchInstance,
+        sendEvent = _ref2.sendEvent;
       if (isFirstRendering) {
         renderState.templateProps = prepareTemplateProps({
           defaultTemplates: {},
@@ -24779,7 +24866,8 @@
         return h(Template, _extends({}, renderState.templateProps, {
           templateKey: "item",
           rootTagName: "fragment",
-          data: item
+          data: item,
+          sendEvent: sendEvent
         }));
       } : undefined;
       var emptyComponent = templates.empty ? function () {
@@ -24794,6 +24882,7 @@
           templateKey: "layout",
           rootTagName: "fragment",
           data: {
+            sendEvent: sendEvent,
             items: data.items,
             templates: {
               item: templates.item ? function (_ref4) {
@@ -24801,7 +24890,8 @@
                 return h(Template, _extends({}, renderState.templateProps, {
                   templateKey: "item",
                   rootTagName: "fragment",
-                  data: item
+                  data: item,
+                  sendEvent: sendEvent
                 }));
               } : undefined
             },
@@ -24809,12 +24899,13 @@
               list: data.classNames.list,
               item: data.classNames.item
             }
-          }
+          },
+          sendEvent: sendEvent
         }));
       } : undefined;
       P(h(TrendingItems, {
         items: items,
-        sendEvent: function sendEvent() {},
+        sendEvent: sendEvent,
         classNames: cssClasses,
         headerComponent: headerComponent,
         itemComponent: itemComponent,
@@ -25087,7 +25178,8 @@
     return function (_ref2, isFirstRendering) {
       var items = _ref2.items,
         results = _ref2.results,
-        instantSearchInstance = _ref2.instantSearchInstance;
+        instantSearchInstance = _ref2.instantSearchInstance,
+        sendEvent = _ref2.sendEvent;
       if (isFirstRendering) {
         renderState.templateProps = prepareTemplateProps({
           defaultTemplates: {},
@@ -25111,7 +25203,8 @@
         return h(Template, _extends({}, renderState.templateProps, {
           templateKey: "item",
           rootTagName: "fragment",
-          data: item
+          data: item,
+          sendEvent: sendEvent
         }));
       } : undefined;
       var emptyComponent = templates.empty ? function () {
@@ -25126,6 +25219,7 @@
           templateKey: "layout",
           rootTagName: "fragment",
           data: {
+            sendEvent: sendEvent,
             items: data.items,
             templates: {
               item: templates.item ? function (_ref4) {
@@ -25133,7 +25227,8 @@
                 return h(Template, _extends({}, renderState.templateProps, {
                   templateKey: "item",
                   rootTagName: "fragment",
-                  data: item
+                  data: item,
+                  sendEvent: sendEvent
                 }));
               } : undefined
             },
@@ -25141,14 +25236,15 @@
               list: data.classNames.list,
               item: data.classNames.item
             }
-          }
+          },
+          sendEvent: sendEvent
         }));
       } : undefined;
       P(h(FrequentlyBoughtTogether, {
         items: items,
         headerComponent: headerComponent,
         itemComponent: itemComponent,
-        sendEvent: function sendEvent() {},
+        sendEvent: sendEvent,
         classNames: cssClasses,
         emptyComponent: emptyComponent,
         layout: layoutComponent,
@@ -25209,7 +25305,8 @@
     return function (_ref2, isFirstRendering) {
       var items = _ref2.items,
         results = _ref2.results,
-        instantSearchInstance = _ref2.instantSearchInstance;
+        instantSearchInstance = _ref2.instantSearchInstance,
+        sendEvent = _ref2.sendEvent;
       if (isFirstRendering) {
         renderState.templateProps = prepareTemplateProps({
           defaultTemplates: {},
@@ -25233,7 +25330,8 @@
         return h(Template, _extends({}, renderState.templateProps, {
           templateKey: "item",
           rootTagName: "fragment",
-          data: item
+          data: item,
+          sendEvent: sendEvent
         }));
       } : undefined;
       var emptyComponent = templates.empty ? function () {
@@ -25248,6 +25346,7 @@
           templateKey: "layout",
           rootTagName: "fragment",
           data: {
+            sendEvent: sendEvent,
             items: data.items,
             templates: {
               item: templates.item ? function (_ref4) {
@@ -25255,7 +25354,8 @@
                 return h(Template, _extends({}, renderState.templateProps, {
                   templateKey: "item",
                   rootTagName: "fragment",
-                  data: item
+                  data: item,
+                  sendEvent: sendEvent
                 }));
               } : undefined
             },
@@ -25263,7 +25363,8 @@
               list: data.classNames.list,
               item: data.classNames.item
             }
-          }
+          },
+          sendEvent: sendEvent
         }));
       } : undefined;
       P(h(LookingSimilar, {