instantsearch.js 4.67.0 → 4.68.1

package/cjs/components/Template/Template.js

@@ -48,7 +48,7 @@ var RawHtml = /*#__PURE__*/function (_Component) {
       var fragment = new DocumentFragment();
       var root = document.createElement('div');
       root.innerHTML = this.props.content;
-      this.nodes = _toConsumableArray(root.children);
+      this.nodes = _toConsumableArray(root.childNodes);
       this.nodes.forEach(function (node) {
         return fragment.appendChild(node);
       });
@@ -58,8 +58,17 @@ var RawHtml = /*#__PURE__*/function (_Component) {
     key: "componentWillUnmount",
     value: function componentWillUnmount() {
       this.nodes.forEach(function (node) {
-        return node.outerHTML = '';
+        if (node instanceof Element) {
+          node.outerHTML = '';
+          return;
+        }
+        node.nodeValue = '';
       });
+      // if there is one TextNode first and one TextNode last, the
+      // last one's nodeValue will be assigned to the first.
+      if (this.nodes[0].nodeValue) {
+        this.nodes[0].nodeValue = '';
+      }
     }
   }, {
     key: "render",

package/cjs/connectors/hits/connectHits.js

@@ -48,6 +48,7 @@ var connectHits = function connectHits(renderFn) {
         });
       },
       getWidgetRenderState: function getWidgetRenderState(_ref2) {
+        var _results$renderingCon, _results$renderingCon2, _results$renderingCon3;
         var results = _ref2.results,
           helper = _ref2.helper,
           instantSearchInstance = _ref2.instantSearchInstance;
@@ -73,6 +74,7 @@ var connectHits = function connectHits(renderFn) {
           return {
             hits: [],
             results: undefined,
+            banner: undefined,
             sendEvent: sendEvent,
             bindEvent: bindEvent,
             widgetParams: widgetParams
@@ -86,9 +88,11 @@ var connectHits = function connectHits(renderFn) {
         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

package/cjs/lib/version.js

@@ -4,5 +4,5 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _default = '4.67.0';
+var _default = '4.68.1';
 exports.default = _default;

package/cjs/widgets/hits/hits.js

@@ -43,7 +43,8 @@ var renderer = function renderer(_ref) {
       instantSearchInstance = _ref2.instantSearchInstance,
       insights = _ref2.insights,
       bindEvent = _ref2.bindEvent,
-      sendEvent = _ref2.sendEvent;
+      sendEvent = _ref2.sendEvent,
+      banner = _ref2.banner;
     if (isFirstRendering) {
       renderState.templateProps = (0, _templating.prepareTemplateProps)({
         defaultTemplates: _defaultTemplates.default,
@@ -61,7 +62,8 @@ var renderer = function renderer(_ref) {
       return (0, _preact.h)(_Template.default, _extends({}, renderState.templateProps, {
         rootProps: rootProps,
         templateKey: "empty",
-        data: results
+        data: results,
+        rootTagName: "fragment"
       }));
     };
 
@@ -94,12 +96,21 @@ var renderer = function renderer(_ref) {
         sendEvent: sendEvent
       }));
     };
+    var bannerComponent = function bannerComponent(props) {
+      return (0, _preact.h)(_Template.default, _extends({}, renderState.templateProps, {
+        templateKey: "banner",
+        data: props,
+        rootTagName: "fragment"
+      }));
+    };
     (0, _preact.render)((0, _preact.h)(Hits, {
       hits: receivedHits,
       itemComponent: itemComponent,
       sendEvent: sendEvent,
       classNames: cssClasses,
-      emptyComponent: emptyComponent
+      emptyComponent: emptyComponent,
+      banner: banner,
+      bannerComponent: templates.banner ? bannerComponent : undefined
     }), containerNode);
   };
 };

package/cjs/widgets/index/index.js

@@ -159,9 +159,18 @@ var index = function index(widgetParams) {
     },
     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() {
@@ -499,7 +508,7 @@ var index = function index(widgetParams) {
         _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

package/dist/instantsearch.development.d.ts

@@ -303,6 +303,8 @@ declare type AutocompleteWidgetDescription = {
     };
 };
 
+declare type Banner = NonNullable<NonNullable<Required<SearchResults<Hit>['renderingContent']>>['widgets']['banners']>[number];
+
 declare type BaseHit = Record<string, unknown>;
 
 declare type BindEventForHits = BuiltInBindEventForHits & CustomBindEventForHits;
@@ -1994,6 +1996,10 @@ declare type HitsRenderState<THit extends BaseHit = BaseHit> = {
      * The response from the Algolia API.
      */
     results?: SearchResults<Hit<THit>>;
+    /**
+     * The banner to display above the hits.
+     */
+    banner?: Banner;
     /**
      * Sends an event to the Insights middleware.
      */
@@ -2020,6 +2026,13 @@ declare type HitsTemplates = Partial<{
         /** @deprecated the index in the hits array, use __position instead, which is the absolute position */
         __hitIndex: number;
     }>;
+    /**
+     * Template to use for the banner.
+     */
+    banner: Template<{
+        banner: Required<HitsRenderState['banner']>;
+        className: string;
+    }>;
 }>;
 
 declare type HitsWidget = WidgetFactory<HitsWidgetDescription & {

package/dist/instantsearch.development.js

@@ -1,4 +1,4 @@
-/*! InstantSearch.js 4.67.0 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch */
+/*! InstantSearch.js 4.68.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) :
@@ -2666,6 +2666,7 @@
           });
         },
         getWidgetRenderState: function getWidgetRenderState(_ref2) {
+          var _results$renderingCon, _results$renderingCon2, _results$renderingCon3;
           var results = _ref2.results,
             helper = _ref2.helper,
             instantSearchInstance = _ref2.instantSearchInstance;
@@ -2691,6 +2692,7 @@
             return {
               hits: [],
               results: undefined,
+              banner: undefined,
               sendEvent: sendEvent,
               bindEvent: bindEvent,
               widgetParams: widgetParams
@@ -2704,9 +2706,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
@@ -10203,7 +10207,7 @@
 
   var SearchResults_1 = SearchResults;
 
-  var version = '3.18.0';
+  var version = '3.19.0';
 
   var escapeFacetValue$4 = escapeFacetValue_1.escapeFacetValue;
 
@@ -14951,9 +14955,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() {
@@ -15291,7 +15304,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
@@ -15415,7 +15428,7 @@
     };
   }
 
-  var version$1 = '4.67.0';
+  var version$1 = '4.68.1';
 
   var withUsage$r = createDocumentationMessageGenerator({
     name: 'instantsearch'
@@ -16185,12 +16198,43 @@
     };
   }
 
-  var _excluded$a = ["classNames", "hits", "itemComponent", "sendEvent", "emptyComponent"];
+  var _excluded$a = ["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,
@@ -16198,15 +16242,18 @@
         ItemComponent = userProps.itemComponent,
         sendEvent = userProps.sendEvent,
         EmptyComponent = userProps.emptyComponent,
+        banner = userProps.banner,
+        BannerComponent = userProps.bannerComponent,
         props = _objectWithoutProperties$1(userProps, _excluded$a);
-      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$1({}, 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, {
@@ -17267,7 +17314,7 @@
         var fragment = new DocumentFragment();
         var root = document.createElement('div');
         root.innerHTML = this.props.content;
-        this.nodes = _toConsumableArray(root.children);
+        this.nodes = _toConsumableArray(root.childNodes);
         this.nodes.forEach(function (node) {
           return fragment.appendChild(node);
         });
@@ -17277,8 +17324,17 @@
       key: "componentWillUnmount",
       value: function componentWillUnmount() {
         this.nodes.forEach(function (node) {
-          return node.outerHTML = '';
+          if (node instanceof Element) {
+            node.outerHTML = '';
+            return;
+          }
+          node.nodeValue = '';
         });
+        // if there is one TextNode first and one TextNode last, the
+        // last one's nodeValue will be assigned to the first.
+        if (this.nodes[0].nodeValue) {
+          this.nodes[0].nodeValue = '';
+        }
       }
     }, {
       key: "render",
@@ -19310,7 +19366,8 @@
         instantSearchInstance = _ref2.instantSearchInstance,
         insights = _ref2.insights,
         bindEvent = _ref2.bindEvent,
-        sendEvent = _ref2.sendEvent;
+        sendEvent = _ref2.sendEvent,
+        banner = _ref2.banner;
       if (isFirstRendering) {
         renderState.templateProps = prepareTemplateProps({
           defaultTemplates: defaultTemplates$5,
@@ -19328,7 +19385,8 @@
         return h(Template, _extends({}, renderState.templateProps, {
           rootProps: rootProps,
           templateKey: "empty",
-          data: results
+          data: results,
+          rootTagName: "fragment"
         }));
       };
 
@@ -19361,12 +19419,21 @@
           sendEvent: sendEvent
         }));
       };
+      var bannerComponent = function bannerComponent(props) {
+        return h(Template, _extends({}, renderState.templateProps, {
+          templateKey: "banner",
+          data: props,
+          rootTagName: "fragment"
+        }));
+      };
       P(h(Hits, {
         hits: receivedHits,
         itemComponent: itemComponent,
         sendEvent: sendEvent,
         classNames: cssClasses,
-        emptyComponent: emptyComponent
+        emptyComponent: emptyComponent,
+        banner: banner,
+        bannerComponent: templates.banner ? bannerComponent : undefined
       }), containerNode);
     };
   };