instantsearch.js 4.71.1 → 4.72.1

package/README.md

@@ -20,6 +20,7 @@ InstantSearch.js is a vanilla JavaScript library that lets you create an instant
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
+
 - [Why](#why)
 - [Getting started](#getting-started)
 - [Installation](#installation)

package/cjs/connectors/infinite-hits/connectInfiniteHits.js

@@ -139,6 +139,7 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
         });
       },
       getWidgetRenderState: function getWidgetRenderState(_ref6) {
+        var _results$renderingCon, _results$renderingCon2, _results$renderingCon3;
         var results = _ref6.results,
           helper = _ref6.helper,
           parent = _ref6.parent,
@@ -155,6 +156,7 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
         var cachedHits = cache.read({
           state: normalizeState(state)
         }) || {};
+        var banner = results === null || results === void 0 ? void 0 : (_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];
         if (!results) {
           showPrevious = getShowPrevious(helper);
           showMore = getShowMore(helper);
@@ -219,6 +221,7 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
           currentPageHits: currentPageHits,
           sendEvent: sendEvent,
           bindEvent: bindEvent,
+          banner: banner,
           results: results,
           showPrevious: showPrevious,
           showMore: showMore,

package/cjs/lib/version.js

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

package/cjs/middlewares/createRouterMiddleware.js

@@ -57,6 +57,7 @@ var createRouterMiddleware = function createRouterMiddleware() {
         }
       },
       subscribe: function subscribe() {
+        process.env.NODE_ENV === 'development' ? (0, _utils.warning)(Object.keys(initialUiState).length === 0, 'Using `initialUiState` together with routing is not recommended. The `initialUiState` will be overwritten by the URL parameters.') : void 0;
         instantSearchInstance._initialUiState = _objectSpread(_objectSpread({}, initialUiState), stateMapping.routeToState(router.read()));
         router.onUpdate(function (route) {
           if (instantSearchInstance.mainIndex.getWidgets().length > 0) {

package/dist/instantsearch.development.d.ts

@@ -2,6 +2,7 @@
 /// <reference types="googlemaps" />
 
 import { AlgoliaSearchHelper } from 'algoliasearch-helper';
+import { Banner } from 'algoliasearch-helper';
 import EventEmitter from '@algolia/events';
 import { FindAnswersOptions } from 'algoliasearch-helper/types/algoliasearch.js';
 import type { FrequentlyBoughtTogetherProps } from 'instantsearch-ui-components';
@@ -311,8 +312,6 @@ declare type AutocompleteWidgetDescription = {
     };
 };
 
-declare type Banner = NonNullable<NonNullable<Required<SearchResults<Hit>['renderingContent']>>['widgets']['banners']>[number];
-
 declare type BaseHit = Record<string, any>;
 
 declare type BindEventForHits = BuiltInBindEventForHits & CustomBindEventForHits;
@@ -893,18 +892,7 @@ declare const connectHitsWithInsights: <TWidgetParams>(renderFn: Renderer<HitsRe
         hits: Hit<BaseHit>[] | Hit<THit>[];
         items: Hit<BaseHit>[] | Hit<THit>[];
         results: SearchResults<any>;
-        banner: {
-            image: {
-                urls: {
-                    url: string;
-                }[];
-                title?: string | undefined;
-            };
-            link?: {
-                url: string;
-                target?: "_blank" | "_self" | undefined;
-            } | undefined;
-        } | undefined;
+        banner: Banner | undefined;
         sendEvent: SendEventForHits;
         bindEvent: BindEventForHits;
         widgetParams: TWidgetParams & HitsConnectorParams<THit>;
@@ -1077,6 +1065,7 @@ declare const connectInfiniteHitsWithInsights: <TWidgetParams extends object>(re
         currentPageHits: Hit<THit>[];
         sendEvent: SendEventForHits;
         bindEvent: BindEventForHits;
+        banner: Banner | undefined;
         results: SearchResults<any> | undefined;
         showPrevious: () => void;
         showMore: () => void;
@@ -1613,18 +1602,7 @@ declare const _default: <TWidgetParams>(renderFn: Renderer<HitsRenderState<BaseH
         hits: Hit<BaseHit>[] | Hit<THit>[];
         items: Hit<BaseHit>[] | Hit<THit>[];
         results: SearchResults<any>;
-        banner: {
-            image: {
-                urls: {
-                    url: string;
-                }[];
-                title?: string | undefined;
-            };
-            link?: {
-                url: string;
-                target?: "_blank" | "_self" | undefined;
-            } | undefined;
-        } | undefined;
+        banner: Banner | undefined;
         sendEvent: SendEventForHits;
         bindEvent: BindEventForHits;
         widgetParams: TWidgetParams & HitsConnectorParams<THit>;
@@ -1803,6 +1781,7 @@ declare const _default_10: <THit extends object = BaseHit>(widgetParams: Infinit
         currentPageHits: Hit<THit>[];
         sendEvent: SendEventForHits;
         bindEvent: BindEventForHits;
+        banner: Banner | undefined;
         results: SearchResults<any> | undefined;
         showPrevious: () => void;
         showMore: () => void;
@@ -3185,6 +3164,7 @@ declare const _default_2: <TWidgetParams extends object>(renderFn: Renderer<Infi
         currentPageHits: Hit<THit>[];
         sendEvent: SendEventForHits;
         bindEvent: BindEventForHits;
+        banner: Banner | undefined;
         results: SearchResults<any> | undefined;
         showPrevious: () => void;
         showMore: () => void;
@@ -5192,11 +5172,7 @@ declare const _default_9: <THit extends object = BaseHit>(widgetParams: HitsWidg
     getWidgetRenderState({ results, helper, instantSearchInstance }: InitOptions | RenderOptions): {
         hits: never[];
         items: never[];
-        results: undefined; /**
-        * Template to use for each result. This template will receive an object containing a single record.
-        *
-        * @default ''
-        */
+        results: undefined;
         banner: undefined;
         sendEvent: SendEventForHits;
         bindEvent: BindEventForHits;
@@ -5205,22 +5181,11 @@ declare const _default_9: <THit extends object = BaseHit>(widgetParams: HitsWidg
         hits: Hit<BaseHit>[] | Hit<THit>[];
         items: Hit<BaseHit>[] | Hit<THit>[];
         results: SearchResults<any>;
+        banner: Banner | undefined;
+        sendEvent: SendEventForHits;
         /**
-         * CSS classes to add.
+         * Templates to use for the widget.
          */
-        banner: {
-            image: {
-                urls: {
-                    url: string;
-                }[];
-                title?: string | undefined;
-            };
-            link?: {
-                url: string;
-                target?: "_blank" | "_self" | undefined;
-            } | undefined;
-        } | undefined;
-        sendEvent: SendEventForHits;
         bindEvent: BindEventForHits;
         widgetParams: Partial<HitsWidgetParams<BaseHit>> & HitsConnectorParams<THit>;
     };
@@ -6451,6 +6416,10 @@ declare type InfiniteHitsRenderState<THit extends NonNullable<object> = BaseHit>
      * The response from the Algolia API.
      */
     results?: SearchResults<Hit<THit>>;
+    /**
+     * The banner to display above the hits.
+     */
+    banner?: Banner;
 };
 
 declare type InfiniteHitsTemplates<THit extends NonNullable<object> = BaseHit> = Partial<{

package/dist/instantsearch.development.js

@@ -1,4 +1,4 @@
-/*! InstantSearch.js 4.71.1 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch */
+/*! InstantSearch.js 4.72.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) :
@@ -3231,6 +3231,7 @@
           });
         },
         getWidgetRenderState: function getWidgetRenderState(_ref6) {
+          var _results$renderingCon, _results$renderingCon2, _results$renderingCon3;
           var results = _ref6.results,
             helper = _ref6.helper,
             parent = _ref6.parent,
@@ -3247,6 +3248,7 @@
           var cachedHits = cache.read({
             state: normalizeState(state)
           }) || {};
+          var banner = results === null || results === void 0 ? void 0 : (_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];
           if (!results) {
             showPrevious = getShowPrevious(helper);
             showMore = getShowMore(helper);
@@ -3311,6 +3313,7 @@
             currentPageHits: currentPageHits,
             sendEvent: sendEvent,
             bindEvent: bindEvent,
+            banner: banner,
             results: results,
             showPrevious: showPrevious,
             showMore: showMore,
@@ -6711,10 +6714,15 @@
       var facetFilters = requestBuilder._getFacetFilters(state);
       var numericFilters = requestBuilder._getNumericFilters(state);
       var tagFilters = requestBuilder._getTagFilters(state);
-      var additionalParams = {
-        facets: facets.indexOf('*') > -1 ? ['*'] : facets,
-        tagFilters: tagFilters,
-      };
+      var additionalParams = {};
+
+      if (facets.length > 0) {
+        additionalParams.facets = facets.indexOf('*') > -1 ? ['*'] : facets;
+      }
+
+      if (tagFilters.length > 0) {
+        additionalParams.tagFilters = tagFilters;
+      }
 
       if (facetFilters.length > 0) {
         additionalParams.facetFilters = facetFilters;
@@ -9495,7 +9503,7 @@
   }
    **/
   function SearchResults(state, results, options) {
-    var mainSubResponse = results[0];
+    var mainSubResponse = results[0] || {};
 
     this._rawResults = results;
 
@@ -10078,8 +10086,9 @@
   function sortViaFacetOrdering(facetValues, facetOrdering) {
     var orderedFacets = [];
     var remainingFacets = [];
-
+    var hide = facetOrdering.hide || [];
     var order = facetOrdering.order || [];
+
     /**
      * an object with the keys being the values in order, the values their index:
      * ['one', 'two'] -> { one: 0, two: 1 }
@@ -10092,9 +10101,10 @@
     facetValues.forEach(function (item) {
       // hierarchical facets get sorted using their raw name
       var name = item.path || item.name;
-      if (reverseOrder[name] !== undefined) {
+      var hidden = hide.indexOf(name) > -1;
+      if (!hidden && reverseOrder[name] !== undefined) {
         orderedFacets[reverseOrder[name]] = item;
-      } else {
+      } else if (!hidden) {
         remainingFacets.push(item);
       }
     });
@@ -10480,7 +10490,7 @@
 
   var sortAndMergeRecommendations_1 = sortAndMergeRecommendations;
 
-  var version = '3.21.0';
+  var version = '3.22.1';
 
   var escapeFacetValue$4 = escapeFacetValue_1.escapeFacetValue;
 
@@ -15290,6 +15300,7 @@
           }
         },
         subscribe: function subscribe() {
+           _warning(Object.keys(initialUiState).length === 0, 'Using `initialUiState` together with routing is not recommended. The `initialUiState` will be overwritten by the URL parameters.') ;
           instantSearchInstance._initialUiState = _objectSpread2(_objectSpread2({}, initialUiState), stateMapping.routeToState(router.read()));
           router.onUpdate(function (route) {
             if (instantSearchInstance.mainIndex.getWidgets().length > 0) {
@@ -23982,7 +23993,7 @@
     };
   }
 
-  var version$1 = '4.71.1';
+  var version$1 = '4.72.1';
 
   var withUsage$10 = createDocumentationMessageGenerator({
     name: 'instantsearch'