react-instantsearch 7.7.2 → 7.8.0

package/dist/cjs/widgets/Hits.js

@@ -8,7 +8,7 @@ exports.Hits = Hits;
 var _instantsearchUiComponents = require("instantsearch-ui-components");
 var _react = _interopRequireWildcard(require("react"));
 var _reactInstantsearchCore = require("react-instantsearch-core");
-var _excluded = ["escapeHTML", "transformItems", "hitComponent"],
+var _excluded = ["escapeHTML", "transformItems", "hitComponent", "bannerComponent"],
   _excluded2 = ["hit", "index"];
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
@@ -34,6 +34,7 @@ function Hits(_ref2) {
     transformItems = _ref2.transformItems,
     _ref2$hitComponent = _ref2.hitComponent,
     HitComponent = _ref2$hitComponent === void 0 ? DefaultHitComponent : _ref2$hitComponent,
+    BannerComponent = _ref2.bannerComponent,
     props = _objectWithoutProperties(_ref2, _excluded);
   var _useHits = (0, _reactInstantsearchCore.useHits)({
       escapeHTML: escapeHTML,
@@ -42,6 +43,7 @@ function Hits(_ref2) {
       $$widgetType: 'ais.hits'
     }),
     hits = _useHits.hits,
+    banner = _useHits.banner,
     sendEvent = _useHits.sendEvent;
   var itemComponent = function itemComponent(_ref3) {
     var hit = _ref3.hit,
@@ -54,10 +56,15 @@ function Hits(_ref2) {
       sendEvent: sendEvent
     }));
   };
+  var bannerComponent = BannerComponent === false ? function () {
+    return null;
+  } : BannerComponent;
   var uiProps = {
     hits: hits,
     sendEvent: sendEvent,
-    itemComponent: itemComponent
+    itemComponent: itemComponent,
+    banner: banner,
+    bannerComponent: bannerComponent
   };
   return /*#__PURE__*/_react.default.createElement(HitsUiComponent, _extends({}, props, uiProps));
 }

package/dist/es/widgets/Hits.d.ts

@@ -3,12 +3,17 @@ import type { HitsProps as HitsUiComponentProps } from 'instantsearch-ui-compone
 import type { Hit, BaseHit } from 'instantsearch.js';
 import type { SendEventForHits } from 'instantsearch.js/es/lib/utils';
 import type { UseHitsProps } from 'react-instantsearch-core';
-type UiProps<THit extends BaseHit> = Pick<HitsUiComponentProps<Hit<THit>>, 'hits' | 'sendEvent' | 'itemComponent' | 'emptyComponent'>;
+type UiProps<THit extends BaseHit> = Pick<HitsUiComponentProps<Hit<THit>>, 'hits' | 'sendEvent' | 'itemComponent' | 'emptyComponent' | 'banner' | 'bannerComponent'>;
 export type HitsProps<THit extends BaseHit> = Omit<HitsUiComponentProps<Hit<THit>>, keyof UiProps<THit>> & {
     hitComponent?: React.JSXElementConstructor<{
         hit: Hit<THit>;
         sendEvent: SendEventForHits;
     }>;
+} & {
+    bannerComponent?: React.JSXElementConstructor<{
+        banner: Required<HitsUiComponentProps<Hit<THit>>>['banner'];
+        className: string;
+    }> | false;
 } & UseHitsProps<THit>;
-export declare function Hits<THit extends BaseHit = BaseHit>({ escapeHTML, transformItems, hitComponent: HitComponent, ...props }: HitsProps<THit>): JSX.Element;
+export declare function Hits<THit extends BaseHit = BaseHit>({ escapeHTML, transformItems, hitComponent: HitComponent, bannerComponent: BannerComponent, ...props }: HitsProps<THit>): JSX.Element;
 export {};

package/dist/es/widgets/Hits.js

@@ -1,4 +1,4 @@
-var _excluded = ["escapeHTML", "transformItems", "hitComponent"],
+var _excluded = ["escapeHTML", "transformItems", "hitComponent", "bannerComponent"],
   _excluded2 = ["hit", "index"];
 function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
 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; }
@@ -25,6 +25,7 @@ export function Hits(_ref2) {
     transformItems = _ref2.transformItems,
     _ref2$hitComponent = _ref2.hitComponent,
     HitComponent = _ref2$hitComponent === void 0 ? DefaultHitComponent : _ref2$hitComponent,
+    BannerComponent = _ref2.bannerComponent,
     props = _objectWithoutProperties(_ref2, _excluded);
   var _useHits = useHits({
       escapeHTML: escapeHTML,
@@ -33,6 +34,7 @@ export function Hits(_ref2) {
       $$widgetType: 'ais.hits'
     }),
     hits = _useHits.hits,
+    banner = _useHits.banner,
     sendEvent = _useHits.sendEvent;
   var itemComponent = function itemComponent(_ref3) {
     var hit = _ref3.hit,
@@ -45,10 +47,15 @@ export function Hits(_ref2) {
       sendEvent: sendEvent
     }));
   };
+  var bannerComponent = BannerComponent === false ? function () {
+    return null;
+  } : BannerComponent;
   var uiProps = {
     hits: hits,
     sendEvent: sendEvent,
-    itemComponent: itemComponent
+    itemComponent: itemComponent,
+    banner: banner,
+    bannerComponent: bannerComponent
   };
   return /*#__PURE__*/React.createElement(HitsUiComponent, _extends({}, props, uiProps));
 }

package/dist/umd/ReactInstantSearch.js

@@ -7,7 +7,7 @@
 
   var React__default = 'default' in React ? React['default'] : React;
 
-  var version = '7.7.2';
+  var version = '7.8.0';
 
   // Copyright Joyent, Inc. and other Node contributors.
   //
@@ -4437,7 +4437,7 @@
 
   var SearchResults_1 = SearchResults;
 
-  var version$1 = '3.18.0';
+  var version$1 = '3.19.0';
 
   var escapeFacetValue$3 = escapeFacetValue_1.escapeFacetValue;
 
@@ -9986,9 +9986,18 @@
       },
       getScopedResults: function getScopedResults() {
         var widgetParent = this.getParent();
-
-        // If the widget is the root, we consider itself as the only sibling.
-        var widgetSiblings = widgetParent ? widgetParent.getWidgets() : [this];
+        var widgetSiblings;
+        if (widgetParent) {
+          widgetSiblings = widgetParent.getWidgets();
+        } else if (indexName.length === 0) {
+          // The widget is the root but has no index name:
+          // we resolve results from its children index widgets
+          widgetSiblings = this.getWidgets();
+        } else {
+          // The widget is the root and has an index name:
+          // we consider itself as the only sibling
+          widgetSiblings = [this];
+        }
         return resolveScopedResultsFromWidgets(widgetSiblings);
       },
       getParent: function getParent() {
@@ -10316,7 +10325,7 @@
           _helper,
           _derivedHelper2;
         localWidgets.forEach(function (widget) {
-          if (widget.dispose) {
+          if (widget.dispose && helper) {
             // The dispose function is always called once the instance is started
             // (it's an effect of `removeWidgets`). The index is initialized and
             // the Helper is available. We don't care about the return value of
@@ -12711,7 +12720,7 @@
     };
   }
 
-  var version$3 = '4.67.0';
+  var version$3 = '4.68.1';
 
   function _typeof$o(obj) {
     "@babel/helpers - typeof";
@@ -15339,6 +15348,7 @@
           });
         },
         getWidgetRenderState: function getWidgetRenderState(_ref2) {
+          var _results$renderingCon, _results$renderingCon2, _results$renderingCon3;
           var results = _ref2.results,
             helper = _ref2.helper,
             instantSearchInstance = _ref2.instantSearchInstance;
@@ -15364,6 +15374,7 @@
             return {
               hits: [],
               results: undefined,
+              banner: undefined,
               sendEvent: sendEvent,
               bindEvent: bindEvent,
               widgetParams: widgetParams
@@ -15377,9 +15388,11 @@
           var transformedHits = transformItems(hitsWithAbsolutePositionAndQueryID, {
             results: results
           });
+          var banner = (_results$renderingCon = results.renderingContent) === null || _results$renderingCon === void 0 ? void 0 : (_results$renderingCon2 = _results$renderingCon.widgets) === null || _results$renderingCon2 === void 0 ? void 0 : (_results$renderingCon3 = _results$renderingCon2.banners) === null || _results$renderingCon3 === void 0 ? void 0 : _results$renderingCon3[0];
           return {
             hits: transformedHits,
             results: results,
+            banner: banner,
             sendEvent: sendEvent,
             bindEvent: bindEvent,
             widgetParams: widgetParams
@@ -18976,6 +18989,14 @@
             results: results,
             scopedResults: searchIndex.getScopedResults()
           });
+        } else if (search.mainIndex.getIndexName().length === 0) {
+          // If the main index has no name, we get the scoped results from
+          // the first child index instead.
+          var childIndex = search.mainIndex.getWidgets().find(isIndexWidget);
+          childIndex && setSearchResults({
+            results: getIndexSearchResults(searchIndex).results,
+            scopedResults: childIndex.getScopedResults()
+          });
         }
       }
       search.addListener('render', handleRender);
@@ -19640,12 +19661,43 @@
     };
   }
 
-  var _excluded$d = ["classNames", "hits", "itemComponent", "sendEvent", "emptyComponent"];
+  var _excluded$d = ["classNames", "hits", "itemComponent", "sendEvent", "emptyComponent", "banner", "bannerComponent"];
 
   // Should be imported from a shared package in the future
 
-  function createHitsComponent(_ref) {
+  function createDefaultBannerComponent(_ref) {
     var createElement = _ref.createElement;
+    return function DefaultBanner(_ref2) {
+      var _banner$link;
+      var classNames = _ref2.classNames,
+        banner = _ref2.banner;
+      if (!banner.image.urls[0].url) {
+        return null;
+      }
+      return createElement("aside", {
+        className: cx('ais-Hits-banner', classNames.bannerRoot)
+      }, (_banner$link = banner.link) !== null && _banner$link !== void 0 && _banner$link.url ? createElement("a", {
+        className: cx('ais-Hits-banner-link', classNames.bannerLink),
+        href: banner.link.url,
+        target: banner.link.target
+      }, createElement("img", {
+        className: cx('ais-Hits-banner-image', classNames.bannerImage),
+        src: banner.image.urls[0].url,
+        alt: banner.image.title
+      })) : createElement("img", {
+        className: cx('ais-Hits-banner-image', classNames.bannerImage),
+        src: banner.image.urls[0].url,
+        alt: banner.image.title
+      }));
+    };
+  }
+  function createHitsComponent(_ref3) {
+    var createElement = _ref3.createElement,
+      Fragment = _ref3.Fragment;
+    var DefaultBannerComponent = createDefaultBannerComponent({
+      createElement: createElement,
+      Fragment: Fragment
+    });
     return function Hits(userProps) {
       var _userProps$classNames = userProps.classNames,
         classNames = _userProps$classNames === void 0 ? {} : _userProps$classNames,
@@ -19653,15 +19705,18 @@
         ItemComponent = userProps.itemComponent,
         sendEvent = userProps.sendEvent,
         EmptyComponent = userProps.emptyComponent,
+        banner = userProps.banner,
+        BannerComponent = userProps.bannerComponent,
         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", {
+      }), banner && (BannerComponent ? createElement(BannerComponent, {
+        className: cx('ais-Hits-banner', classNames.bannerRoot),
+        banner: banner
+      }) : createElement(DefaultBannerComponent, {
+        classNames: classNames,
+        banner: banner
+      })), hits.length === 0 && EmptyComponent ? createElement(EmptyComponent, null) : createElement("ol", {
         className: cx('ais-Hits-list', classNames.list)
       }, hits.map(function (hit, index) {
         return createElement(ItemComponent, {
@@ -20046,7 +20101,7 @@
     }));
   }
 
-  var _excluded$p = ["escapeHTML", "transformItems", "hitComponent"],
+  var _excluded$p = ["escapeHTML", "transformItems", "hitComponent", "bannerComponent"],
     _excluded2$4 = ["hit", "index"];
   // @MAJOR: Move default hit component back to the UI library
   // once flavour specificities are erased
@@ -20067,6 +20122,7 @@
       transformItems = _ref2.transformItems,
       _ref2$hitComponent = _ref2.hitComponent,
       HitComponent = _ref2$hitComponent === void 0 ? DefaultHitComponent : _ref2$hitComponent,
+      BannerComponent = _ref2.bannerComponent,
       props = _objectWithoutProperties$c(_ref2, _excluded$p);
     var _useHits = useHits({
         escapeHTML: escapeHTML,
@@ -20075,6 +20131,7 @@
         $$widgetType: 'ais.hits'
       }),
       hits = _useHits.hits,
+      banner = _useHits.banner,
       sendEvent = _useHits.sendEvent;
     var itemComponent = function itemComponent(_ref3) {
       var hit = _ref3.hit,
@@ -20087,10 +20144,15 @@
         sendEvent: sendEvent
       }));
     };
+    var bannerComponent = BannerComponent === false ? function () {
+      return null;
+    } : BannerComponent;
     var uiProps = {
       hits: hits,
       sendEvent: sendEvent,
-      itemComponent: itemComponent
+      itemComponent: itemComponent,
+      banner: banner,
+      bannerComponent: bannerComponent
     };
     return /*#__PURE__*/React__default.createElement(HitsUiComponent, _extends$1({}, props, uiProps));
   }