instantsearch.js 4.76.0 → 4.77.1

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.1 | © 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) :
@@ -1182,9 +1182,9 @@
       var queryParameters = transporter.queryParameters || transporter.baseQueryParameters;
       var APP_ID = 'x-algolia-application-id';
       var API_KEY = 'x-algolia-api-key';
-      var _appId = headers[APP_ID] || queryParameters[APP_ID];
-      var _apiKey = headers[API_KEY] || queryParameters[API_KEY];
-      return [_appId, _apiKey];
+      var appId = headers[APP_ID] || queryParameters[APP_ID];
+      var apiKey = headers[API_KEY] || queryParameters[API_KEY];
+      return [appId, apiKey];
     } else {
       // searchClient v3
       return [searchClient.applicationID, searchClient.apiKey];
@@ -5063,6 +5063,34 @@
     );
   };
 
+  // NOTE: this behaves like lodash/defaults, but doesn't mutate the target
+  // it also preserve keys order and keep the highest numeric value
+  function mergeNumericMax() {
+    var sources = Array.prototype.slice.call(arguments);
+
+    return sources.reduceRight(function (acc, source) {
+      Object.keys(Object(source)).forEach(function (key) {
+        var accValue = typeof acc[key] === 'number' ? acc[key] : 0;
+        var sourceValue = source[key];
+
+        if (sourceValue === undefined) {
+          return;
+        }
+
+        if (sourceValue >= accValue) {
+          if (acc[key] !== undefined) {
+            // remove if already added, so that we can add it in correct order
+            delete acc[key];
+          }
+          acc[key] = sourceValue;
+        }
+      });
+      return acc;
+    }, {});
+  }
+
+  var mergeNumericMax_1 = mergeNumericMax;
+
   function compareAscending(value, other) {
     if (value !== other) {
       var valIsDefined = value !== undefined;
@@ -5850,7 +5878,7 @@
 
           self.hierarchicalFacets[position][attributeIndex].data =
             self.persistHierarchicalRootCount
-              ? defaultsPure(
+              ? mergeNumericMax_1(
                   self.hierarchicalFacets[position][attributeIndex].data,
                   facetResults
                 )
@@ -5866,7 +5894,7 @@
 
           self.disjunctiveFacets[position] = {
             name: dfacet,
-            data: defaultsPure(dataFromMainRequest, facetResults),
+            data: mergeNumericMax_1(dataFromMainRequest, facetResults),
             exhaustive: result.exhaustiveFacetsCount,
           };
           assignFacetStats(
@@ -6555,7 +6583,7 @@
 
   var sortAndMergeRecommendations_1 = sortAndMergeRecommendations;
 
-  var version = '3.23.0';
+  var version = '3.23.1';
 
   var escapeFacetValue$4 = escapeFacetValue_1.escapeFacetValue;
 
@@ -11565,6 +11593,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 +11612,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 +12519,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 +12538,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 +13621,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 +13640,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 +13717,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 +13736,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 +16408,7 @@
     };
   }
 
-  var version$1 = '4.76.0';
+  var version$1 = '4.77.1';
 
   var withUsage$v = createDocumentationMessageGenerator({
     name: 'instantsearch'
@@ -17173,16 +17268,21 @@
         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
+          item: item,
+          sendEvent: sendEvent
         }));
       })));
     };
   }
 
-  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 +17357,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,9 +17432,16 @@
           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
+          item: item,
+          sendEvent: sendEvent
         }));
       })), createElement("button", {
         ref: nextButtonRef,
@@ -17843,11 +17951,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({
@@ -20686,8 +20797,8 @@
     }, {
       key: "componentDidUpdate",
       value: function componentDidUpdate() {
-        var _this$listRef$current, _this$listRef$current2;
-        (_this$listRef$current = this.listRef.current) === null || _this$listRef$current === void 0 ? void 0 : (_this$listRef$current2 = _this$listRef$current.querySelector("input[value=\"".concat(this.lastRefinedValue, "\"]"))) === null || _this$listRef$current2 === void 0 ? void 0 : _this$listRef$current2.focus();
+        var _this$listRef$current, _this$listRef$current2, _this$lastRefinedValu;
+        (_this$listRef$current = this.listRef.current) === null || _this$listRef$current === void 0 ? void 0 : (_this$listRef$current2 = _this$listRef$current.querySelector("input[value=\"".concat((_this$lastRefinedValu = this.lastRefinedValue) === null || _this$lastRefinedValu === void 0 ? void 0 : _this$lastRefinedValu.replace('"', '\\"'), "\"]"))) === null || _this$listRef$current2 === void 0 ? void 0 : _this$listRef$current2.focus();
         this.lastRefinedValue = undefined;
       }
     }, {
@@ -22560,6 +22671,7 @@
     });
   };
 
+  var _excluded$t = ["item", "sendEvent"];
   var withUsage$P = createDocumentationMessageGenerator({
     name: 'related-products'
   });
@@ -22575,7 +22687,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: {},
@@ -22595,11 +22708,15 @@
         }));
       } : undefined;
       var itemComponent = templates.item ? function (_ref3) {
-        var item = _ref3.item;
+        var item = _ref3.item,
+          _sendEvent = _ref3.sendEvent,
+          rootProps = _objectWithoutProperties(_ref3, _excluded$t);
         return h(Template, _extends({}, renderState.templateProps, {
           templateKey: "item",
           rootTagName: "fragment",
-          data: item
+          data: item,
+          sendEvent: _sendEvent,
+          rootProps: _objectSpread2({}, rootProps)
         }));
       } : undefined;
       var emptyComponent = templates.empty ? function () {
@@ -22614,6 +22731,7 @@
           templateKey: "layout",
           rootTagName: "fragment",
           data: {
+            sendEvent: sendEvent,
             items: data.items,
             templates: {
               item: templates.item ? function (_ref4) {
@@ -22621,7 +22739,8 @@
                 return h(Template, _extends({}, renderState.templateProps, {
                   templateKey: "item",
                   rootTagName: "fragment",
-                  data: item
+                  data: item,
+                  sendEvent: sendEvent
                 }));
               } : undefined
             },
@@ -22629,12 +22748,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,
@@ -24472,13 +24592,13 @@
     });
   };
 
-  var _excluded$t = ["nbHits", "nbSortedHits", "cssClasses", "templateProps"];
+  var _excluded$u = ["nbHits", "nbSortedHits", "cssClasses", "templateProps"];
   var Stats = function Stats(_ref) {
     var nbHits = _ref.nbHits,
       nbSortedHits = _ref.nbSortedHits,
       cssClasses = _ref.cssClasses,
       templateProps = _ref.templateProps,
-      rest = _objectWithoutProperties(_ref, _excluded$t);
+      rest = _objectWithoutProperties(_ref, _excluded$u);
     return h("div", {
       className: cx(cssClasses.root)
     }, h(Template, _extends({}, templateProps, {
@@ -24740,6 +24860,7 @@
     });
   };
 
+  var _excluded$v = ["item", "sendEvent"];
   var withUsage$Z = createDocumentationMessageGenerator({
     name: 'trending-items'
   });
@@ -24755,7 +24876,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: {},
@@ -24775,11 +24897,15 @@
         }));
       } : undefined;
       var itemComponent = templates.item ? function (_ref3) {
-        var item = _ref3.item;
+        var item = _ref3.item,
+          _sendEvent = _ref3.sendEvent,
+          rootProps = _objectWithoutProperties(_ref3, _excluded$v);
         return h(Template, _extends({}, renderState.templateProps, {
           templateKey: "item",
           rootTagName: "fragment",
-          data: item
+          data: item,
+          sendEvent: _sendEvent,
+          rootProps: _objectSpread2({}, rootProps)
         }));
       } : undefined;
       var emptyComponent = templates.empty ? function () {
@@ -24794,6 +24920,7 @@
           templateKey: "layout",
           rootTagName: "fragment",
           data: {
+            sendEvent: sendEvent,
             items: data.items,
             templates: {
               item: templates.item ? function (_ref4) {
@@ -24801,7 +24928,8 @@
                 return h(Template, _extends({}, renderState.templateProps, {
                   templateKey: "item",
                   rootTagName: "fragment",
-                  data: item
+                  data: item,
+                  sendEvent: sendEvent
                 }));
               } : undefined
             },
@@ -24809,12 +24937,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,
@@ -25072,6 +25201,7 @@
     });
   };
 
+  var _excluded$w = ["item", "sendEvent"];
   var withUsage$$ = createDocumentationMessageGenerator({
     name: 'frequently-bought-together'
   });
@@ -25087,7 +25217,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: {},
@@ -25107,11 +25238,15 @@
         }));
       } : undefined;
       var itemComponent = templates.item ? function (_ref3) {
-        var item = _ref3.item;
+        var item = _ref3.item,
+          _sendEvent = _ref3.sendEvent,
+          rootProps = _objectWithoutProperties(_ref3, _excluded$w);
         return h(Template, _extends({}, renderState.templateProps, {
           templateKey: "item",
           rootTagName: "fragment",
-          data: item
+          data: item,
+          sendEvent: _sendEvent,
+          rootProps: _objectSpread2({}, rootProps)
         }));
       } : undefined;
       var emptyComponent = templates.empty ? function () {
@@ -25126,6 +25261,7 @@
           templateKey: "layout",
           rootTagName: "fragment",
           data: {
+            sendEvent: sendEvent,
             items: data.items,
             templates: {
               item: templates.item ? function (_ref4) {
@@ -25133,7 +25269,8 @@
                 return h(Template, _extends({}, renderState.templateProps, {
                   templateKey: "item",
                   rootTagName: "fragment",
-                  data: item
+                  data: item,
+                  sendEvent: sendEvent
                 }));
               } : undefined
             },
@@ -25141,14 +25278,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,
@@ -25194,6 +25332,7 @@
     });
   });
 
+  var _excluded$x = ["item", "sendEvent"];
   var withUsage$10 = createDocumentationMessageGenerator({
     name: 'looking-similar'
   });
@@ -25209,7 +25348,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: {},
@@ -25229,11 +25369,15 @@
         }));
       } : undefined;
       var itemComponent = templates.item ? function (_ref3) {
-        var item = _ref3.item;
+        var item = _ref3.item,
+          _sendEvent = _ref3.sendEvent,
+          rootProps = _objectWithoutProperties(_ref3, _excluded$x);
         return h(Template, _extends({}, renderState.templateProps, {
           templateKey: "item",
           rootTagName: "fragment",
-          data: item
+          data: item,
+          sendEvent: _sendEvent,
+          rootProps: _objectSpread2({}, rootProps)
         }));
       } : undefined;
       var emptyComponent = templates.empty ? function () {
@@ -25248,6 +25392,7 @@
           templateKey: "layout",
           rootTagName: "fragment",
           data: {
+            sendEvent: sendEvent,
             items: data.items,
             templates: {
               item: templates.item ? function (_ref4) {
@@ -25255,7 +25400,8 @@
                 return h(Template, _extends({}, renderState.templateProps, {
                   templateKey: "item",
                   rootTagName: "fragment",
-                  data: item
+                  data: item,
+                  sendEvent: sendEvent
                 }));
               } : undefined
             },
@@ -25263,7 +25409,8 @@
               list: data.classNames.list,
               item: data.classNames.item
             }
-          }
+          },
+          sendEvent: sendEvent
         }));
       } : undefined;
       P(h(LookingSimilar, {