react-instantsearch 7.6.0 → 7.7.1

package/dist/umd/ReactInstantSearch.js

@@ -7,7 +7,7 @@
 
   var React__default = 'default' in React ? React['default'] : React;
 
-  var version = '7.6.0';
+  var version = '7.7.1';
 
   // Copyright Joyent, Inc. and other Node contributors.
   //
@@ -497,6 +497,42 @@
 
   var omit = _objectWithoutPropertiesLoose;
 
+  /**
+   * RecommendParameters is the data structure that contains all the information
+   * usable for getting recommendations from the Algolia API. It doesn't do the
+   * search itself, nor does it contains logic about the parameters.
+   * It is an immutable object, therefore it has been created in a way that each
+   * changes does not change the object itself but returns a copy with the
+   * modification.
+   * This object should probably not be instantiated outside of the helper. It
+   * will be provided when needed.
+   * @constructor
+   * @classdesc contains all the parameters for recommendations
+   * @param {RecommendParametersOptions} opts the options to create the object
+   */
+  function RecommendParameters(opts) {
+    opts = opts || {};
+    this.params = opts.params || [];
+  }
+
+  RecommendParameters.prototype = {
+    constructor: RecommendParameters,
+
+    addParams: function (params) {
+      return new RecommendParameters({ params: this.params.concat(params) });
+    },
+
+    removeParams: function (id) {
+      return new RecommendParameters({
+        params: this.params.filter(function (param) {
+          return param.$$id !== id;
+        }),
+      });
+    },
+  };
+
+  var RecommendParameters_1 = RecommendParameters;
+
   function sortObject(obj) {
     return Object.keys(obj)
       .sort()
@@ -3942,7 +3978,8 @@
    * @return {undefined} function mutates the item
    */
   function setIsRefined(item, currentRefinement, depth) {
-    item.isRefined = item.name === currentRefinement[depth];
+    item.isRefined =
+      item.name === (currentRefinement[depth] && currentRefinement[depth].trim());
     if (item.data) {
       item.data.forEach(function (child) {
         setIsRefined(child, currentRefinement, depth + 1);
@@ -4343,7 +4380,7 @@
 
   var SearchResults_1 = SearchResults;
 
-  var version$1 = '3.16.2';
+  var version$1 = '3.17.0';
 
   var escapeFacetValue$3 = escapeFacetValue_1.escapeFacetValue;
 
@@ -4355,6 +4392,7 @@
 
 
 
+
   /**
    * Event triggered when a parameter is set or updated
    * @event AlgoliaSearchHelper#event:change
@@ -4468,6 +4506,9 @@
     var opts = options || {};
     opts.index = index;
     this.state = SearchParameters_1.make(opts);
+    this.recommendState = new RecommendParameters_1({
+      params: opts.recommendState,
+    });
     this.lastResults = null;
     this._queryId = 0;
     this._lastQueryIdReceived = -1;
@@ -5851,6 +5892,17 @@
     }
   };
 
+  AlgoliaSearchHelper.prototype._recommendChange = function (event) {
+    var state = event.state;
+
+    if (state !== this.recommendState) {
+      this.recommendState = state;
+
+      // eslint-disable-next-line no-warning-comments
+      // TODO: emit "change" event when events for Recommend are implemented
+    }
+  };
+
   /**
    * Clears the cache of the underlying Algolia client.
    * @return {AlgoliaSearchHelper} Method is chainable, it returns itself
@@ -8630,7 +8682,7 @@
 
       // Scenario 1: the widget is added for the first time.
       if (!cleanupTimerRef.current) {
-        if (!shouldAddWidgetEarly) {
+        if (!shouldSsr) {
           parentIndex.addWidgets([widget]);
         }
       }
@@ -8667,7 +8719,7 @@
           });
         });
       };
-    }, [parentIndex, widget, shouldAddWidgetEarly, search, props]);
+    }, [parentIndex, widget, shouldSsr, search, props]);
     if (shouldAddWidgetEarly || (waitingForResultsRef === null || waitingForResultsRef === void 0 ? void 0 : (_waitingForResultsRef = waitingForResultsRef.current) === null || _waitingForResultsRef === void 0 ? void 0 : _waitingForResultsRef.status) === 'pending') {
       parentIndex.addWidgets([widget]);
     }
@@ -12204,7 +12256,7 @@
     };
   }
 
-  var version$3 = '4.65.0';
+  var version$3 = '4.66.1';
 
   function _typeof$o(obj) {
     "@babel/helpers - typeof";
@@ -14892,6 +14944,8 @@
           if (!escapeHTML) {
             return state;
           }
+
+          // @MAJOR: set this globally, not in the Hits widget to allow Hits to be conditionally used
           return state.setQueryParameters(TAG_PLACEHOLDER);
         }
       };
@@ -15471,6 +15525,7 @@
           var uiState = _ref10.uiState;
           var widgetSearchParameters = searchParameters;
           if (escapeHTML) {
+            // @MAJOR: set this globally, not in the InfiniteHits widget to allow InfiniteHits to be conditionally used
             widgetSearchParameters = searchParameters.setQueryParameters(TAG_PLACEHOLDER);
           }
 
@@ -19098,8 +19153,6 @@
       Fragment: Fragment
     });
     return function Highlight(userProps) {
-      // Not destructured in function signature, to make sure it's not exposed in
-      // the type definition.
       var parts = userProps.parts,
         _userProps$highlighte = userProps.highlightedTagName,
         highlightedTagName = _userProps$highlighte === void 0 ? 'mark' : _userProps$highlighte,
@@ -19132,12 +19185,52 @@
     };
   }
 
+  var _excluded$d = ["classNames", "hits", "itemComponent", "sendEvent", "emptyComponent"];
+
+  // Should be imported from a shared package in the future
+
+  function createHitsComponent(_ref) {
+    var createElement = _ref.createElement;
+    return function Hits(userProps) {
+      var _userProps$classNames = userProps.classNames,
+        classNames = _userProps$classNames === void 0 ? {} : _userProps$classNames,
+        hits = userProps.hits,
+        ItemComponent = userProps.itemComponent,
+        sendEvent = userProps.sendEvent,
+        EmptyComponent = userProps.emptyComponent,
+        props = _objectWithoutProperties$d(userProps, _excluded$d);
+      if (hits.length === 0 && EmptyComponent) {
+        return createElement(EmptyComponent, {
+          className: cx('ais-Hits', classNames.root, cx('ais-Hits--empty', classNames.emptyRoot), props.className)
+        });
+      }
+      return createElement("div", _extends$2({}, props, {
+        className: cx('ais-Hits', classNames.root, hits.length === 0 && cx('ais-Hits--empty', classNames.emptyRoot), props.className)
+      }), createElement("ol", {
+        className: cx('ais-Hits-list', classNames.list)
+      }, hits.map(function (hit, index) {
+        return createElement(ItemComponent, {
+          key: hit.objectID,
+          hit: hit,
+          index: index,
+          className: cx('ais-Hits-item', classNames.item),
+          onClick: function onClick() {
+            sendEvent('click:internal', hit, 'Hit Clicked');
+          },
+          onAuxClick: function onAuxClick() {
+            sendEvent('click:internal', hit, 'Hit Clicked');
+          }
+        });
+      })));
+    };
+  }
+
   function isModifierClick(event) {
     var isMiddleClick = event.button === 1;
     return Boolean(isMiddleClick || event.altKey || event.ctrlKey || event.metaKey || event.shiftKey);
   }
 
-  var _excluded$d = ["classNames", "items", "hasItems", "createURL", "onNavigate", "separator", "translations"];
+  var _excluded$e = ["classNames", "items", "hasItems", "createURL", "onNavigate", "separator", "translations"];
   function Breadcrumb(_ref) {
     var _ref$classNames = _ref.classNames,
       classNames = _ref$classNames === void 0 ? {} : _ref$classNames,
@@ -19149,7 +19242,7 @@
       _ref$separator = _ref.separator,
       separator = _ref$separator === void 0 ? '>' : _ref$separator,
       translations = _ref.translations,
-      props = _objectWithoutProperties$c(_ref, _excluded$d);
+      props = _objectWithoutProperties$c(_ref, _excluded$e);
     var handleClick = function handleClick(value) {
       return function (event) {
         if (!isModifierClick(event)) {
@@ -19184,14 +19277,14 @@
     })));
   }
 
-  var _excluded$e = ["attributes", "rootPath", "separator", "transformItems", "translations"];
+  var _excluded$f = ["attributes", "rootPath", "separator", "transformItems", "translations"];
   function Breadcrumb$1(_ref) {
     var attributes = _ref.attributes,
       rootPath = _ref.rootPath,
       separator = _ref.separator,
       transformItems = _ref.transformItems,
       translations = _ref.translations,
-      props = _objectWithoutProperties$c(_ref, _excluded$e);
+      props = _objectWithoutProperties$c(_ref, _excluded$f);
     var _useBreadcrumb = useBreadcrumb({
         attributes: attributes,
         rootPath: rootPath,
@@ -19215,7 +19308,7 @@
     return /*#__PURE__*/React__default.createElement(Breadcrumb, _extends$1({}, props, uiProps));
   }
 
-  var _excluded$f = ["classNames", "disabled", "onClick", "translations"];
+  var _excluded$g = ["classNames", "disabled", "onClick", "translations"];
   function ClearRefinements(_ref) {
     var _ref$classNames = _ref.classNames,
       classNames = _ref$classNames === void 0 ? {} : _ref$classNames,
@@ -19224,7 +19317,7 @@
       _ref$onClick = _ref.onClick,
       onClick = _ref$onClick === void 0 ? function () {} : _ref$onClick,
       translations = _ref.translations,
-      props = _objectWithoutProperties$c(_ref, _excluded$f);
+      props = _objectWithoutProperties$c(_ref, _excluded$g);
     return /*#__PURE__*/React__default.createElement("div", _extends$1({}, props, {
       className: cx('ais-ClearRefinements', classNames.root, props.className)
     }), /*#__PURE__*/React__default.createElement("button", {
@@ -19234,13 +19327,13 @@
     }, translations.resetButtonText));
   }
 
-  var _excluded$g = ["includedAttributes", "excludedAttributes", "transformItems", "translations"];
+  var _excluded$h = ["includedAttributes", "excludedAttributes", "transformItems", "translations"];
   function ClearRefinements$1(_ref) {
     var includedAttributes = _ref.includedAttributes,
       excludedAttributes = _ref.excludedAttributes,
       transformItems = _ref.transformItems,
       translations = _ref.translations,
-      props = _objectWithoutProperties$c(_ref, _excluded$g);
+      props = _objectWithoutProperties$c(_ref, _excluded$h);
     var _useClearRefinements = useClearRefinements({
         includedAttributes: includedAttributes,
         excludedAttributes: excludedAttributes,
@@ -19264,7 +19357,7 @@
     return text.toString().charAt(0).toUpperCase() + text.toString().slice(1);
   }
 
-  var _excluded$h = ["classNames", "items", "hasRefinements"];
+  var _excluded$i = ["classNames", "items", "hasRefinements"];
   function CurrentRefinements(_ref) {
     var _ref$classNames = _ref.classNames,
       classNames = _ref$classNames === void 0 ? {} : _ref$classNames,
@@ -19272,7 +19365,7 @@
       items = _ref$items === void 0 ? [] : _ref$items,
       _ref$hasRefinements = _ref.hasRefinements,
       hasRefinements = _ref$hasRefinements === void 0 ? false : _ref$hasRefinements,
-      props = _objectWithoutProperties$c(_ref, _excluded$h);
+      props = _objectWithoutProperties$c(_ref, _excluded$i);
     return /*#__PURE__*/React__default.createElement("div", _extends$1({}, props, {
       className: cx('ais-CurrentRefinements', classNames.root, !hasRefinements && cx('ais-CurrentRefinements--noRefinement', classNames.noRefinementRoot), props.className)
     }), /*#__PURE__*/React__default.createElement("ul", {
@@ -19304,12 +19397,12 @@
     })));
   }
 
-  var _excluded$i = ["includedAttributes", "excludedAttributes", "transformItems"];
+  var _excluded$j = ["includedAttributes", "excludedAttributes", "transformItems"];
   function CurrentRefinements$1(_ref) {
     var includedAttributes = _ref.includedAttributes,
       excludedAttributes = _ref.excludedAttributes,
       transformItems = _ref.transformItems,
-      props = _objectWithoutProperties$c(_ref, _excluded$i);
+      props = _objectWithoutProperties$c(_ref, _excluded$j);
     var _useCurrentRefinement = useCurrentRefinements({
         includedAttributes: includedAttributes,
         excludedAttributes: excludedAttributes,
@@ -19326,17 +19419,17 @@
     return /*#__PURE__*/React__default.createElement(CurrentRefinements, _extends$1({}, props, uiProps));
   }
 
-  var _excluded$j = ["isShowingMore", "translations"];
+  var _excluded$k = ["isShowingMore", "translations"];
   function ShowMoreButton(_ref) {
     var isShowingMore = _ref.isShowingMore,
       translations = _ref.translations,
-      props = _objectWithoutProperties$c(_ref, _excluded$j);
+      props = _objectWithoutProperties$c(_ref, _excluded$k);
     return /*#__PURE__*/React__default.createElement("button", props, translations.showMoreButtonText({
       isShowingMore: isShowingMore
     }));
   }
 
-  var _excluded$k = ["classNames", "items", "hasItems", "onNavigate", "createURL", "showMore", "canToggleShowMore", "onToggleShowMore", "isShowingMore", "translations"];
+  var _excluded$l = ["classNames", "items", "hasItems", "onNavigate", "createURL", "showMore", "canToggleShowMore", "onToggleShowMore", "isShowingMore", "translations"];
   function HierarchicalList(_ref) {
     var className = _ref.className,
       _ref$classNames = _ref.classNames,
@@ -19388,7 +19481,7 @@
       onToggleShowMore = _ref2.onToggleShowMore,
       isShowingMore = _ref2.isShowingMore,
       translations = _ref2.translations,
-      props = _objectWithoutProperties$c(_ref2, _excluded$k);
+      props = _objectWithoutProperties$c(_ref2, _excluded$l);
     return /*#__PURE__*/React__default.createElement("div", _extends$1({}, props, {
       className: cx('ais-HierarchicalMenu', classNames.root, !hasItems && cx('ais-HierarchicalMenu--noRefinement', classNames.noRefinementRoot), props.className)
     }), /*#__PURE__*/React__default.createElement(HierarchicalList, {
@@ -19405,7 +19498,7 @@
     }));
   }
 
-  var _excluded$l = ["attributes", "limit", "rootPath", "separator", "showMore", "showMoreLimit", "showParentLevel", "sortBy", "transformItems", "translations"];
+  var _excluded$m = ["attributes", "limit", "rootPath", "separator", "showMore", "showMoreLimit", "showParentLevel", "sortBy", "transformItems", "translations"];
   function HierarchicalMenu$1(_ref) {
     var attributes = _ref.attributes,
       limit = _ref.limit,
@@ -19417,7 +19510,7 @@
       sortBy = _ref.sortBy,
       transformItems = _ref.transformItems,
       translations = _ref.translations,
-      props = _objectWithoutProperties$c(_ref, _excluded$l);
+      props = _objectWithoutProperties$c(_ref, _excluded$m);
     var _useHierarchicalMenu = useHierarchicalMenu({
         attributes: attributes,
         limit: limit,
@@ -19462,11 +19555,11 @@
     Fragment: React.Fragment
   });
 
-  var _excluded$m = ["classNames"];
+  var _excluded$n = ["classNames"];
   function Highlight(_ref) {
     var _ref$classNames = _ref.classNames,
       classNames = _ref$classNames === void 0 ? {} : _ref$classNames,
-      props = _objectWithoutProperties$c(_ref, _excluded$m);
+      props = _objectWithoutProperties$c(_ref, _excluded$n);
     return /*#__PURE__*/React__default.createElement(InternalHighlight, _extends$1({
       classNames: {
         root: cx('ais-Highlight', classNames.root),
@@ -19477,14 +19570,14 @@
     }, props));
   }
 
-  var _excluded$n = ["hit", "attribute", "highlightedTagName", "nonHighlightedTagName", "separator"];
+  var _excluded$o = ["hit", "attribute", "highlightedTagName", "nonHighlightedTagName", "separator"];
   function Highlight$1(_ref) {
     var hit = _ref.hit,
       attribute = _ref.attribute,
       highlightedTagName = _ref.highlightedTagName,
       nonHighlightedTagName = _ref.nonHighlightedTagName,
       separator = _ref.separator,
-      props = _objectWithoutProperties$c(_ref, _excluded$n);
+      props = _objectWithoutProperties$c(_ref, _excluded$o);
     var property = getPropertyByPath(hit._highlightResult, attribute) || [];
     var properties = Array.isArray(property) ? property : [property];
     var parts = properties.map(function (singleValue) {
@@ -19498,7 +19591,10 @@
     }));
   }
 
-  var _excluded$o = ["hits", "sendEvent", "hitComponent", "classNames"];
+  var _excluded$p = ["escapeHTML", "transformItems", "hitComponent"],
+    _excluded2$3 = ["hit", "index"];
+  // @MAJOR: Move default hit component back to the UI library
+  // once flavour specificities are erased
   function DefaultHitComponent(_ref) {
     var hit = _ref.hit;
     return /*#__PURE__*/React__default.createElement("div", {
@@ -19507,40 +19603,16 @@
       }
     }, JSON.stringify(hit).slice(0, 100), "\u2026");
   }
+  var HitsUiComponent = createHitsComponent({
+    createElement: React.createElement,
+    Fragment: React.Fragment
+  });
   function Hits(_ref2) {
-    var hits = _ref2.hits,
-      sendEvent = _ref2.sendEvent,
+    var escapeHTML = _ref2.escapeHTML,
+      transformItems = _ref2.transformItems,
       _ref2$hitComponent = _ref2.hitComponent,
       HitComponent = _ref2$hitComponent === void 0 ? DefaultHitComponent : _ref2$hitComponent,
-      _ref2$classNames = _ref2.classNames,
-      classNames = _ref2$classNames === void 0 ? {} : _ref2$classNames,
-      props = _objectWithoutProperties$c(_ref2, _excluded$o);
-    return /*#__PURE__*/React__default.createElement("div", _extends$1({}, props, {
-      className: cx('ais-Hits', classNames.root, hits.length === 0 && cx('ais-Hits--empty', classNames.emptyRoot), props.className)
-    }), /*#__PURE__*/React__default.createElement("ol", {
-      className: cx('ais-Hits-list', classNames.list)
-    }, hits.map(function (hit) {
-      return /*#__PURE__*/React__default.createElement("li", {
-        key: hit.objectID,
-        className: cx('ais-Hits-item', classNames.item),
-        onClick: function onClick() {
-          sendEvent('click:internal', hit, 'Hit Clicked');
-        },
-        onAuxClick: function onAuxClick() {
-          sendEvent('click:internal', hit, 'Hit Clicked');
-        }
-      }, /*#__PURE__*/React__default.createElement(HitComponent, {
-        hit: hit,
-        sendEvent: sendEvent
-      }));
-    })));
-  }
-
-  var _excluded$p = ["escapeHTML", "transformItems"];
-  function Hits$1(_ref) {
-    var escapeHTML = _ref.escapeHTML,
-      transformItems = _ref.transformItems,
-      props = _objectWithoutProperties$c(_ref, _excluded$p);
+      props = _objectWithoutProperties$c(_ref2, _excluded$p);
     var _useHits = useHits({
         escapeHTML: escapeHTML,
         transformItems: transformItems
@@ -19549,11 +19621,23 @@
       }),
       hits = _useHits.hits,
       sendEvent = _useHits.sendEvent;
+    var itemComponent = function itemComponent(_ref3) {
+      var hit = _ref3.hit,
+        index = _ref3.index,
+        itemProps = _objectWithoutProperties$c(_ref3, _excluded2$3);
+      return /*#__PURE__*/React__default.createElement("li", _extends$1({
+        key: hit.objectID
+      }, itemProps), /*#__PURE__*/React__default.createElement(HitComponent, {
+        hit: hit,
+        sendEvent: sendEvent
+      }));
+    };
     var uiProps = {
       hits: hits,
-      sendEvent: sendEvent
+      sendEvent: sendEvent,
+      itemComponent: itemComponent
     };
-    return /*#__PURE__*/React__default.createElement(Hits, _extends$1({}, props, uiProps));
+    return /*#__PURE__*/React__default.createElement(HitsUiComponent, _extends$1({}, props, uiProps));
   }
 
   var _excluded$q = ["items", "onChange", "currentValue", "classNames"];
@@ -19788,7 +19872,7 @@
   }
 
   var _excluded$w = ["pages", "currentPage", "nbPages", "isFirstPage", "isLastPage", "showFirst", "showPrevious", "showNext", "showLast", "createURL", "onNavigate", "translations", "classNames"],
-    _excluded2$3 = ["isDisabled", "className", "classNames", "href", "onClick"];
+    _excluded2$4 = ["isDisabled", "className", "classNames", "href", "onClick"];
   function Pagination(_ref) {
     var pages = _ref.pages,
       currentPage = _ref.currentPage,
@@ -19879,7 +19963,7 @@
       classNames = _ref2.classNames,
       href = _ref2.href,
       _onClick = _ref2.onClick,
-      props = _objectWithoutProperties$c(_ref2, _excluded2$3);
+      props = _objectWithoutProperties$c(_ref2, _excluded2$4);
     if (isDisabled) {
       return /*#__PURE__*/React__default.createElement("li", {
         className: cx('ais-Pagination-item', classNames.item, 'ais-Pagination-item--disabled', classNames.disabledItem, className)
@@ -20155,7 +20239,7 @@
       translations = _ref.translations,
       props = _objectWithoutProperties$c(_ref, _excluded$B);
     return /*#__PURE__*/React__default.createElement("div", _extends$1({}, props, {
-      className: cx('ais-RefinementList', classNames.root, !canRefine && cx('ais-RefinementList--noRefinement', classNames.noRefinementRoot), className)
+      className: cx('ais-RefinementList', classNames.root, items.length === 0 && cx('ais-RefinementList--noRefinement', classNames.noRefinementRoot), className)
     }), searchBox && /*#__PURE__*/React__default.createElement("div", {
       className: cx('ais-RefinementList-searchBox', classNames.searchBox)
     }, searchBox), noResults ? /*#__PURE__*/React__default.createElement("div", {
@@ -20728,7 +20812,7 @@
   exports.DynamicWidgets = DynamicWidgets;
   exports.HierarchicalMenu = HierarchicalMenu$1;
   exports.Highlight = Highlight$1;
-  exports.Hits = Hits$1;
+  exports.Hits = Hits;
   exports.HitsPerPage = HitsPerPage$1;
   exports.Index = Index;
   exports.InfiniteHits = InfiniteHits$1;