instantsearch.js 4.37.0 → 4.38.0

package/dist/instantsearch.development.js

@@ -1,4 +1,4 @@
-/*! InstantSearch.js 4.37.0 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch.js */
+/*! InstantSearch.js 4.38.0 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch.js */
 (function (global, factory) {
   typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
   typeof define === 'function' && define.amd ? define(factory) :
@@ -8483,7 +8483,7 @@
     instantSearchInstance.renderState = _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState), {}, _defineProperty({}, parentIndexName, _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState[parentIndexName]), renderState)));
   }
 
-  var version$1 = '4.37.0';
+  var version$1 = '4.38.0';
 
   var NAMESPACE = 'ais';
   var component = function component(componentName) {
@@ -8506,8 +8506,11 @@
         hit = _ref.hit,
         _ref$cssClasses = _ref.cssClasses,
         cssClasses = _ref$cssClasses === void 0 ? {} : _ref$cssClasses;
+    var highlightAttributeResult = getPropertyByPath(hit._highlightResult, attribute); // @MAJOR fallback to attribute value if highlight is not found
 
-    var _ref2 = getPropertyByPath(hit._highlightResult, attribute) || {},
+     _warning(highlightAttributeResult, "Could not enable highlight for \"".concat(attribute, "\", will display an empty string.\nPlease check whether this attribute exists and is either searchable or specified in `attributesToHighlight`.\n\nSee: https://alg.li/highlighting\n")) ;
+
+    var _ref2 = highlightAttributeResult || {},
         _ref2$value = _ref2.value,
         attributeValue = _ref2$value === void 0 ? '' : _ref2$value; // cx is not used, since it would be bundled as a dependency for Vue & Angular
 
@@ -8526,8 +8529,11 @@
         hit = _ref.hit,
         _ref$cssClasses = _ref.cssClasses,
         cssClasses = _ref$cssClasses === void 0 ? {} : _ref$cssClasses;
+    var highlightAttributeResult = getPropertyByPath(hit._highlightResult, attribute); // @MAJOR fallback to attribute value if highlight is not found
+
+     _warning(highlightAttributeResult, "Could not enable reverse highlight for \"".concat(attribute, "\", will display an empty string.\nPlease check whether this attribute exists and is either searchable or specified in `attributesToHighlight`.\n\nSee: https://alg.li/highlighting\n")) ;
 
-    var _ref2 = getPropertyByPath(hit._highlightResult, attribute) || {},
+    var _ref2 = highlightAttributeResult || {},
         _ref2$value = _ref2.value,
         attributeValue = _ref2$value === void 0 ? '' : _ref2$value; // cx is not used, since it would be bundled as a dependency for Vue & Angular
 
@@ -8547,8 +8553,11 @@
         hit = _ref.hit,
         _ref$cssClasses = _ref.cssClasses,
         cssClasses = _ref$cssClasses === void 0 ? {} : _ref$cssClasses;
+    var snippetAttributeResult = getPropertyByPath(hit._snippetResult, attribute); // @MAJOR fallback to attribute value if snippet is not found
 
-    var _ref2 = getPropertyByPath(hit._snippetResult, attribute) || {},
+     _warning(snippetAttributeResult, "Could not enable snippet for \"".concat(attribute, "\", will display an empty string.\nPlease check whether this attribute exists and is specified in `attributesToSnippet`.\n\nSee: https://alg.li/highlighting\n")) ;
+
+    var _ref2 = snippetAttributeResult || {},
         _ref2$value = _ref2.value,
         attributeValue = _ref2$value === void 0 ? '' : _ref2$value; // cx is not used, since it would be bundled as a dependency for Vue & Angular
 
@@ -8567,8 +8576,11 @@
         hit = _ref.hit,
         _ref$cssClasses = _ref.cssClasses,
         cssClasses = _ref$cssClasses === void 0 ? {} : _ref$cssClasses;
+    var snippetAttributeResult = getPropertyByPath(hit._snippetResult, attribute); // @MAJOR fallback to attribute value if snippet is not found
+
+     _warning(snippetAttributeResult, "Could not enable reverse snippet for \"".concat(attribute, "\", will display an empty string.\nPlease check whether this attribute exists and is specified in `attributesToSnippet`.\n\nSee: https://alg.li/highlighting\n")) ;
 
-    var _ref2 = getPropertyByPath(hit._snippetResult, attribute) || {},
+    var _ref2 = snippetAttributeResult || {},
         _ref2$value = _ref2.value,
         attributeValue = _ref2$value === void 0 ? '' : _ref2$value; // cx is not used, since it would be bundled as a dependency for Vue & Angular
 
@@ -10314,10 +10326,15 @@
 
         mainHelper.on('error', function (_ref4) {
           var error = _ref4.error;
-
-          _this3.emit('error', {
-            error: error
-          });
+          // If an error is emitted, it is re-thrown by events. In previous versions
+          // we emitted {error}, which is thrown as:
+          // "Uncaught, unspecified \"error\" event. ([object Object])"
+          // To avoid breaking changes, we make the error available in both
+          // `error` and `error.error`
+          // @MAJOR emit only error
+          error.error = error;
+
+          _this3.emit('error', error);
         });
         this.mainHelper = mainHelper;
         this.middleware.forEach(function (_ref5) {
@@ -10528,13 +10545,15 @@
         },
         getWidgetRenderState: function getWidgetRenderState(_ref2) {
           var createURL = _ref2.createURL,
-              scopedResults = _ref2.scopedResults;
-          connectorState.attributesToClear = scopedResults.reduce(function (results, scopedResult) {
-            return results.concat(getAttributesToClear({
+              scopedResults = _ref2.scopedResults,
+              results = _ref2.results;
+          connectorState.attributesToClear = scopedResults.reduce(function (attributesToClear, scopedResult) {
+            return attributesToClear.concat(getAttributesToClear({
               scopedResult: scopedResult,
               includedAttributes: includedAttributes,
               excludedAttributes: excludedAttributes,
-              transformItems: transformItems
+              transformItems: transformItems,
+              results: results
             }));
           }, []);
 
@@ -10579,7 +10598,8 @@
     var scopedResult = _ref5.scopedResult,
         includedAttributes = _ref5.includedAttributes,
         excludedAttributes = _ref5.excludedAttributes,
-        transformItems = _ref5.transformItems;
+        transformItems = _ref5.transformItems,
+        results = _ref5.results;
     var includesQuery = includedAttributes.indexOf('query') !== -1 || excludedAttributes.indexOf('query') === -1;
     return {
       helper: scopedResult.helper,
@@ -10595,7 +10615,9 @@
           attribute === 'query' && includesQuery || // Otherwise, ignore the excluded attributes
           excludedAttributes.indexOf(attribute) === -1
         );
-      })))
+      })), {
+        results: results
+      })
     };
   }
 
@@ -10656,7 +10678,9 @@
                 helper: helper,
                 includedAttributes: includedAttributes,
                 excludedAttributes: excludedAttributes
-              }));
+              }), {
+                results: results
+              });
             }
 
             return scopedResults.reduce(function (accResults, scopedResult) {
@@ -10665,7 +10689,9 @@
                 helper: scopedResult.helper,
                 includedAttributes: includedAttributes,
                 excludedAttributes: excludedAttributes
-              })));
+              }), {
+                results: results
+              }));
             }, []);
           }
 
@@ -10960,7 +10986,9 @@
 
             var hasExhaustiveItems = (state.maxValuesPerFacet || 0) > getLimit() ? facetItems.length <= getLimit() : facetItems.length < getLimit();
             canToggleShowMore = showMore && (isShowingMore || !hasExhaustiveItems);
-            items = transformItems(_prepareFacetValues(facetItems));
+            items = transformItems(_prepareFacetValues(facetItems), {
+              results: results
+            });
           }
 
           return {
@@ -11093,7 +11121,9 @@
 
           var hitsWithAbsolutePosition = addAbsolutePosition(results.hits, results.page, results.hitsPerPage);
           var hitsWithAbsolutePositionAndQueryID = addQueryID(hitsWithAbsolutePosition, results.queryID);
-          var transformedHits = transformItems(hitsWithAbsolutePositionAndQueryID);
+          var transformedHits = transformItems(hitsWithAbsolutePositionAndQueryID, {
+            results: results
+          });
           return {
             hits: transformedHits,
             results: results,
@@ -11426,7 +11456,9 @@
               createURL = _ref5.createURL,
               helper = _ref5.helper;
           return {
-            items: transformItems(normalizeItems(state)),
+            items: transformItems(normalizeItems(state), {
+              results: results
+            }),
             refine: connectorState.getRefine(helper),
             createURL: connectorState.createURLFactory({
               state: state,
@@ -11613,7 +11645,9 @@
 
             var hitsWithAbsolutePosition = addAbsolutePosition(results.hits, results.page, results.hitsPerPage);
             var hitsWithAbsolutePositionAndQueryID = addQueryID(hitsWithAbsolutePosition, results.queryID);
-            var transformedHits = transformItems(hitsWithAbsolutePositionAndQueryID);
+            var transformedHits = transformItems(hitsWithAbsolutePositionAndQueryID, {
+              results: results
+            });
 
             if (cachedHits[_page] === undefined) {
               cachedHits[_page] = transformedHits;
@@ -11837,7 +11871,9 @@
                 label: label,
                 value: value
               });
-            }));
+            }), {
+              results: results
+            });
           }
 
           return {
@@ -11951,8 +11987,8 @@
           _ref2$items = _ref2.items,
           items = _ref2$items === void 0 ? [] : _ref2$items,
           _ref2$transformItems = _ref2.transformItems,
-          transformItems = _ref2$transformItems === void 0 ? function (x) {
-        return x;
+          transformItems = _ref2$transformItems === void 0 ? function (item) {
+        return item;
       } : _ref2$transformItems;
 
       if (attribute === '') {
@@ -12089,7 +12125,9 @@
 
           return {
             createURL: connectorState.createURL(state),
-            items: transformItems(prepareItems(state)),
+            items: transformItems(prepareItems(state), {
+              results: results
+            }),
             hasNoResults: results ? results.nbHits === 0 : true,
             refine: connectorState.refine,
             sendEvent: connectorState.sendEvent,
@@ -12831,7 +12869,8 @@
       var createSearchForFacetValues = function createSearchForFacetValues(helper, widget) {
         return function (renderOptions) {
           return function (query) {
-            var instantSearchInstance = renderOptions.instantSearchInstance;
+            var instantSearchInstance = renderOptions.instantSearchInstance,
+                searchResults = renderOptions.results;
 
             if (query === '' && lastItemsFromMainSearch) {
               // render with previous data from the helper.
@@ -12858,7 +12897,9 @@
                     value: value,
                     label: value
                   });
-                }));
+                }), {
+                  results: searchResults
+                });
                 renderFn(_objectSpread2(_objectSpread2({}, widget.getWidgetRenderState(_objectSpread2(_objectSpread2({}, renderOptions), {}, {
                   results: lastResultsFromMainSearch
                 }))), {}, {
@@ -12922,7 +12963,9 @@
               facetOrdering: sortBy === DEFAULT_SORT$2
             });
             facetValues = values && Array.isArray(values) ? values : [];
-            items = transformItems(facetValues.slice(0, getLimit()).map(formatItems));
+            items = transformItems(facetValues.slice(0, getLimit()).map(formatItems), {
+              results: results
+            });
             var maxValuesPerFacetConfig = state.maxValuesPerFacet;
             var currentLimit = getLimit(); // If the limit is the max number of facet retrieved it is impossible to know
             // if the facets are exhaustive. The only moment we are sure it is exhaustive
@@ -13014,32 +13057,28 @@
     connector: true
   });
 
+  var defaultQueryHook = function defaultQueryHook(query, hook) {
+    return hook(query);
+  };
   /**
    * **SearchBox** connector provides the logic to build a widget that will let the user search for a query.
    *
    * The connector provides to the rendering: `refine()` to set the query. The behaviour of this function
    * may be impacted by the `queryHook` widget parameter.
    */
+
+
   var connectSearchBox = function connectSearchBox(renderFn) {
     var unmountFn = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : noop;
     checkRendering(renderFn, withUsage$d());
     return function (widgetParams) {
       var _ref = widgetParams || {},
-          queryHook = _ref.queryHook;
-
-      function clear(helper) {
-        return function () {
-          helper.setQuery('').search();
-        };
-      }
+          _ref$queryHook = _ref.queryHook,
+          queryHook = _ref$queryHook === void 0 ? defaultQueryHook : _ref$queryHook;
 
       var _refine;
 
-      var _clear = function _clear() {};
-
-      function _cachedClear() {
-        _clear();
-      }
+      var _clear;
 
       return {
         $$type: 'ais.searchBox',
@@ -13071,27 +13110,21 @@
               state = _ref3.state;
 
           if (!_refine) {
-            var setQueryAndSearch = function setQueryAndSearch(query) {
-              if (query !== state.query) {
-                helper.setQuery(query).search();
-              }
-            };
-
             _refine = function _refine(query) {
-              if (queryHook) {
-                queryHook(query, setQueryAndSearch);
-                return;
-              }
+              queryHook(query, function (q) {
+                return helper.setQuery(q).search();
+              });
+            };
 
-              setQueryAndSearch(query);
+            _clear = function _clear() {
+              helper.setQuery('').search();
             };
           }
 
-          _clear = clear(helper);
           return {
             query: state.query || '',
             refine: _refine,
-            clear: _cachedClear,
+            clear: _clear,
             widgetParams: widgetParams,
             isSearchStalled: searchMetadata.isSearchStalled
           };
@@ -13190,7 +13223,9 @@
 
           return {
             currentRefinement: state.index,
-            options: transformItems(items),
+            options: transformItems(items, {
+              results: results
+            }),
             refine: connectorState.setIndex,
             hasNoResults: results ? results.nbHits === 0 : true,
             widgetParams: widgetParams
@@ -13899,7 +13934,9 @@
         if (!facetValue) {
           var breadcrumb = state.getHierarchicalFacetBreadcrumb(hierarchicalFacetName);
 
-          if (breadcrumb.length > 0) {
+          if (breadcrumb.length === 0) {
+            return state;
+          } else {
             return state.resetPage().toggleFacetRefinement(hierarchicalFacetName, breadcrumb[0]);
           }
         }
@@ -13934,7 +13971,10 @@
               state = _ref2.state;
 
           function getItems() {
-            if (!results) {
+            // The hierarchicalFacets condition is required for flavors
+            // that render immediately with empty results, without relying
+            // on init() (like React InstantSearch Hooks).
+            if (!results || state.hierarchicalFacets.length === 0) {
               return [];
             }
 
@@ -13943,7 +13983,9 @@
 
             var facetValues = results.getFacetValues(facetName, {});
             var data = Array.isArray(facetValues.data) ? facetValues.data : [];
-            var items = transformItems(shiftItemsValues(prepareItems(data)));
+            var items = transformItems(shiftItemsValues(prepareItems(data)), {
+              results: results
+            });
             return items;
           }
 
@@ -14169,7 +14211,9 @@
           var state = helper.state;
           var items = results ? transformItems(results.hits.filter(function (hit) {
             return hit._geoloc;
-          })) : [];
+          }), {
+            results: results
+          }) : [];
 
           if (!sendEvent) {
             sendEvent = createSendEventForHits({
@@ -14715,7 +14759,9 @@
               _ref4$userData = _ref4.userData,
               userData = _ref4$userData === void 0 ? [] : _ref4$userData;
 
-          var items = transformItems(userData);
+          var items = transformItems(userData, {
+            results: results
+          });
           return {
             items: items,
             widgetParams: widgetParams
@@ -17569,13 +17615,6 @@
     })));
   };
 
-  Hits.defaultProps = {
-    results: {
-      hits: []
-    },
-    hits: []
-  };
-
   var defaultTemplates$5 = {
     empty: 'No results',
     item: function item(data) {
@@ -18295,130 +18334,104 @@
     });
   };
 
-  /** @jsx h */
-
-  function PaginationLink(_ref) {
-    var label = _ref.label,
-        ariaLabel = _ref.ariaLabel,
-        pageNumber = _ref.pageNumber,
-        _ref$additionalClassN = _ref.additionalClassName,
-        additionalClassName = _ref$additionalClassN === void 0 ? null : _ref$additionalClassN,
-        _ref$isDisabled = _ref.isDisabled,
-        isDisabled = _ref$isDisabled === void 0 ? false : _ref$isDisabled,
-        _ref$isSelected = _ref.isSelected,
-        isSelected = _ref$isSelected === void 0 ? false : _ref$isSelected,
-        cssClasses = _ref.cssClasses,
-        createURL = _ref.createURL,
-        handleClick = _ref.handleClick;
-    var classes = {
-      item: classnames(cssClasses.item, additionalClassName, isDisabled && cssClasses.disabledItem, isSelected && cssClasses.selectedItem),
-      link: cssClasses.link
-    };
-
-    if (isDisabled) {
-      return v("li", {
-        className: classes.item
-      }, v("span", {
-        className: classes.link,
-        dangerouslySetInnerHTML: {
-          __html: label
-        }
-      }));
-    }
-
-    return v("li", {
-      className: classes.item
-    }, v("a", {
-      className: classes.link,
-      "aria-label": ariaLabel,
-      href: createURL(pageNumber),
-      onClick: function onClick(event) {
-        return handleClick(pageNumber, event);
-      },
-      dangerouslySetInnerHTML: {
-        __html: label
-      }
-    }));
-  }
-
-  var defaultProps$3 = {
-    currentPage: 0,
-    nbPages: 0,
-    pages: []
-  };
-
   function Pagination(props) {
-    var handleClick = function handleClick(pageNumber, event) {
-      if (isSpecialClick(event)) {
-        // do not alter the default browser behavior
-        // if one special key is down
-        return;
-      }
+    function createClickHandler(pageNumber) {
+      return function (event) {
+        if (isSpecialClick(event)) {
+          // do not alter the default browser behavior
+          // if one special key is down
+          return;
+        }
 
-      event.preventDefault();
-      props.setCurrentPage(pageNumber);
-    };
+        event.preventDefault();
+        props.setCurrentPage(pageNumber);
+      };
+    }
 
     return v("div", {
       className: classnames(props.cssClasses.root, _defineProperty({}, props.cssClasses.noRefinementRoot, props.nbPages <= 1))
     }, v("ul", {
       className: props.cssClasses.list
     }, props.showFirst && v(PaginationLink, {
-      key: "first",
-      ariaLabel: 'First',
-      additionalClassName: props.cssClasses.firstPageItem,
+      ariaLabel: "First",
+      className: props.cssClasses.firstPageItem,
       isDisabled: props.isFirstPage,
       label: props.templates.first,
       pageNumber: 0,
       createURL: props.createURL,
       cssClasses: props.cssClasses,
-      handleClick: handleClick
+      createClickHandler: createClickHandler
     }), props.showPrevious && v(PaginationLink, {
-      key: "previous",
-      ariaLabel: 'Previous',
-      additionalClassName: props.cssClasses.previousPageItem,
+      ariaLabel: "Previous",
+      className: props.cssClasses.previousPageItem,
       isDisabled: props.isFirstPage,
       label: props.templates.previous,
       pageNumber: props.currentPage - 1,
       createURL: props.createURL,
       cssClasses: props.cssClasses,
-      handleClick: handleClick
+      createClickHandler: createClickHandler
     }), props.pages.map(function (pageNumber) {
       return v(PaginationLink, {
         key: pageNumber,
         ariaLabel: "".concat(pageNumber + 1),
-        additionalClassName: props.cssClasses.pageItem,
+        className: props.cssClasses.pageItem,
         isSelected: pageNumber === props.currentPage,
         label: "".concat(pageNumber + 1),
         pageNumber: pageNumber,
         createURL: props.createURL,
         cssClasses: props.cssClasses,
-        handleClick: handleClick
+        createClickHandler: createClickHandler
       });
     }), props.showNext && v(PaginationLink, {
-      key: "next",
-      ariaLabel: 'Next',
-      additionalClassName: props.cssClasses.nextPageItem,
+      ariaLabel: "Next",
+      className: props.cssClasses.nextPageItem,
       isDisabled: props.isLastPage,
       label: props.templates.next,
       pageNumber: props.currentPage + 1,
       createURL: props.createURL,
       cssClasses: props.cssClasses,
-      handleClick: handleClick
+      createClickHandler: createClickHandler
     }), props.showLast && v(PaginationLink, {
-      key: "last",
-      ariaLabel: 'Last',
-      additionalClassName: props.cssClasses.lastPageItem,
+      ariaLabel: "Last",
+      className: props.cssClasses.lastPageItem,
       isDisabled: props.isLastPage,
       label: props.templates.last,
       pageNumber: props.nbPages - 1,
       createURL: props.createURL,
       cssClasses: props.cssClasses,
-      handleClick: handleClick
+      createClickHandler: createClickHandler
     })));
   }
 
-  Pagination.defaultProps = defaultProps$3;
+  function PaginationLink(_ref) {
+    var label = _ref.label,
+        ariaLabel = _ref.ariaLabel,
+        pageNumber = _ref.pageNumber,
+        className = _ref.className,
+        _ref$isDisabled = _ref.isDisabled,
+        isDisabled = _ref$isDisabled === void 0 ? false : _ref$isDisabled,
+        _ref$isSelected = _ref.isSelected,
+        isSelected = _ref$isSelected === void 0 ? false : _ref$isSelected,
+        cssClasses = _ref.cssClasses,
+        createURL = _ref.createURL,
+        createClickHandler = _ref.createClickHandler;
+    return v("li", {
+      className: classnames(cssClasses.item, className, isDisabled && cssClasses.disabledItem, isSelected && cssClasses.selectedItem)
+    }, isDisabled ? v("span", {
+      className: cssClasses.link,
+      dangerouslySetInnerHTML: {
+        __html: label
+      }
+    }) : v("a", {
+      className: cssClasses.link,
+      "aria-label": ariaLabel,
+      href: createURL(pageNumber),
+      onClick: createClickHandler(pageNumber),
+      dangerouslySetInnerHTML: {
+        __html: label
+      }
+    }));
+  }
 
   var suit$h = component('Pagination');
   var withUsage$G = createDocumentationMessageGenerator({