instantsearch.js 4.33.1 → 4.36.0

package/dist/instantsearch.development.js

@@ -1,4 +1,4 @@
-/*! InstantSearch.js 4.33.1 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch.js */
+/*! InstantSearch.js 4.36.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) :
@@ -3475,7 +3475,7 @@
   var events = EventEmitter;
 
   // Backwards-compat with node 0.10.x
-  EventEmitter.EventEmitter = EventEmitter;
+  // EventEmitter.EventEmitter = EventEmitter;
 
   EventEmitter.prototype._events = undefined;
   EventEmitter.prototype._maxListeners = undefined;
@@ -3779,7 +3779,7 @@
     this.lastResults = null;
   }
 
-  inherits_1(DerivedHelper, events.EventEmitter);
+  inherits_1(DerivedHelper, events);
 
   /**
    * Detach this helper from the main helper
@@ -4115,7 +4115,7 @@
 
   var requestBuilder_1 = requestBuilder;
 
-  var version = '3.6.2';
+  var version = '3.7.0';
 
   /**
    * Event triggered when a parameter is set or updated
@@ -4236,7 +4236,7 @@
     this._currentNbQueries = 0;
   }
 
-  inherits_1(AlgoliaSearchHelper, events.EventEmitter);
+  inherits_1(AlgoliaSearchHelper, events);
 
   /**
    * Start the search with the parameters set in the state. When the
@@ -8186,7 +8186,8 @@
         return this;
       },
       init: function init(_ref2) {
-        var _this3 = this;
+        var _this3 = this,
+            _instantSearchInstanc;
 
         var instantSearchInstance = _ref2.instantSearchInstance,
             parent = _ref2.parent,
@@ -8244,11 +8245,21 @@
 
         derivedHelper = mainHelper.derive(function () {
           return merge$1.apply(void 0, _toConsumableArray(resolveSearchParameters(_this3)));
-        }); // Subscribe to the Helper state changes for the page before widgets
+        });
+        var indexInitialResults = (_instantSearchInstanc = instantSearchInstance._initialResults) === null || _instantSearchInstanc === void 0 ? void 0 : _instantSearchInstanc[this.getIndexId()];
+
+        if (indexInitialResults) {
+          // We restore the shape of the results provided to the instance to respect
+          // the helper's structure.
+          var results = new algoliasearchHelper_1.SearchResults(new algoliasearchHelper_1.SearchParameters(indexInitialResults.state), indexInitialResults.results);
+          derivedHelper.lastResults = results;
+          helper.lastResults = results;
+        } // Subscribe to the Helper state changes for the page before widgets
         // are initialized. This behavior mimics the original one of the Helper.
         // It makes sense to replicate it at the `init` step. We have another
         // listener on `change` below, once `init` is done.
 
+
         helper.on('change', function (_ref3) {
           var isPageReset = _ref3.isPageReset;
 
@@ -8349,6 +8360,13 @@
             instantSearchInstance.onInternalStateChange();
           }
         });
+
+        if (indexInitialResults) {
+          // If there are initial results, we're not notified of the next results
+          // because we don't trigger an initial search. We therefore need to directly
+          // schedule a render that will render the results injected on the helper.
+          instantSearchInstance.scheduleRender();
+        }
       },
       render: function render(_ref5) {
         var _this4 = this;
@@ -8465,7 +8483,7 @@
     instantSearchInstance.renderState = _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState), {}, _defineProperty({}, parentIndexName, _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState[parentIndexName]), renderState)));
   }
 
-  var version$1 = '4.33.1';
+  var version$1 = '4.36.0';
 
   var NAMESPACE = 'ais';
   var component = function component(componentName) {
@@ -9962,6 +9980,8 @@
 
       _defineProperty(_assertThisInitialized(_this), "_initialUiState", void 0);
 
+      _defineProperty(_assertThisInitialized(_this), "_initialResults", void 0);
+
       _defineProperty(_assertThisInitialized(_this), "_createURL", void 0);
 
       _defineProperty(_assertThisInitialized(_this), "_searchFunction", void 0);
@@ -10066,6 +10086,7 @@
       _this._isSearchStalled = false;
       _this._createURL = defaultCreateURL;
       _this._initialUiState = initialUiState;
+      _this._initialResults = null;
 
       if (searchFunction) {
         _this._searchFunction = searchFunction;
@@ -10308,9 +10329,27 @@
           parent: null,
           uiState: this._initialUiState
         });
-        this.scheduleSearch(); // Keep the previous reference for legacy purpose, some pattern use
+
+        if (this._initialResults) {
+          var originalScheduleSearch = this.scheduleSearch; // We don't schedule a first search when initial results are provided
+          // because we already have the results to render. This skips the initial
+          // network request on the browser on `start`.
+
+          this.scheduleSearch = defer(noop); // We also skip the initial network request when widgets are dynamically
+          // added in the first tick (that's the case in all the framework-based flavors).
+          // When we add a widget to `index`, it calls `scheduleSearch`. We can rely
+          // on our `defer` util to restore the original `scheduleSearch` value once
+          // widgets are added to hook back to the regular lifecycle.
+
+          defer(function () {
+            _this3.scheduleSearch = originalScheduleSearch;
+          })();
+        } else {
+          this.scheduleSearch();
+        } // Keep the previous reference for legacy purpose, some pattern use
         // the direct Helper access `search.helper` (e.g multi-index).
 
+
         this.helper = this.mainIndex.getHelper(); // track we started the search if we add more widgets,
         // to init them directly after add
 
@@ -11563,7 +11602,7 @@
               index: helper.getIndex(),
               widgetType: this.$$type
             });
-            isFirstPage = helper.state.page === undefined || getFirstReceivedPage(helper.state, cachedHits) === 0;
+            isFirstPage = state.page === undefined || getFirstReceivedPage(state, cachedHits) === 0;
           } else {
             var _state$page3 = state.page,
                 _page = _state$page3 === void 0 ? 0 : _state$page3;
@@ -12068,6 +12107,8 @@
     if (option.start !== undefined && option.end !== undefined) {
       if (option.start === option.end) {
         return hasNumericRefinement(currentRefinements, '=', option.start);
+      } else {
+        return hasNumericRefinement(currentRefinements, '>=', option.start) && hasNumericRefinement(currentRefinements, '<=', option.end);
       }
     }
 
@@ -12121,17 +12162,17 @@
     if (refinedOption.start !== undefined) {
       if (hasNumericRefinement(currentRefinements, '>=', refinedOption.start)) {
         resolvedState = resolvedState.removeNumericRefinement(attribute, '>=', refinedOption.start);
-      } else {
-        resolvedState = resolvedState.addNumericRefinement(attribute, '>=', refinedOption.start);
       }
+
+      resolvedState = resolvedState.addNumericRefinement(attribute, '>=', refinedOption.start);
     }
 
     if (refinedOption.end !== undefined) {
       if (hasNumericRefinement(currentRefinements, '<=', refinedOption.end)) {
         resolvedState = resolvedState.removeNumericRefinement(attribute, '<=', refinedOption.end);
-      } else {
-        resolvedState = resolvedState.addNumericRefinement(attribute, '<=', refinedOption.end);
       }
+
+      resolvedState = resolvedState.addNumericRefinement(attribute, '<=', refinedOption.end);
     }
 
     if (typeof resolvedState.page === 'number') {
@@ -12289,6 +12330,7 @@
         getWidgetRenderState: function getWidgetRenderState(_ref6) {
           var results = _ref6.results,
               helper = _ref6.helper,
+              state = _ref6.state,
               createURL = _ref6.createURL;
 
           if (!connectorState.refine) {
@@ -12299,14 +12341,13 @@
           }
 
           if (!connectorState.createURL) {
-            connectorState.createURL = function (state) {
+            connectorState.createURL = function (helperState) {
               return function (page) {
-                return createURL(state.setPage(page));
+                return createURL(helperState.setPage(page));
               };
             };
           }
 
-          var state = helper.state;
           var page = state.page || 0;
           var nbPages = getMaxPage(results || {
             nbPages: 0
@@ -13026,11 +13067,12 @@
         },
         getWidgetRenderState: function getWidgetRenderState(_ref3) {
           var helper = _ref3.helper,
-              searchMetadata = _ref3.searchMetadata;
+              searchMetadata = _ref3.searchMetadata,
+              state = _ref3.state;
 
           if (!_refine) {
             var setQueryAndSearch = function setQueryAndSearch(query) {
-              if (query !== helper.state.query) {
+              if (query !== state.query) {
                 helper.setQuery(query).search();
               }
             };
@@ -13047,7 +13089,7 @@
 
           _clear = clear(helper);
           return {
-            query: helper.state.query || '',
+            query: state.query || '',
             refine: _refine,
             clear: _cachedClear,
             widgetParams: widgetParams,
@@ -13133,6 +13175,7 @@
         getWidgetRenderState: function getWidgetRenderState(_ref3) {
           var results = _ref3.results,
               helper = _ref3.helper,
+              state = _ref3.state,
               parent = _ref3.parent;
 
           if (!connectorState.initialIndex && parent) {
@@ -13146,7 +13189,7 @@
           }
 
           return {
-            currentRefinement: helper.state.index,
+            currentRefinement: state.index,
             options: transformItems(items),
             refine: connectorState.setIndex,
             hasNoResults: results ? results.nbHits === 0 : true,
@@ -13490,18 +13533,18 @@
         },
         getWidgetRenderState: function getWidgetRenderState(_ref) {
           var results = _ref.results,
-              helper = _ref.helper;
+              state = _ref.state;
 
           if (!results) {
             return {
-              hitsPerPage: helper.state.hitsPerPage,
+              hitsPerPage: state.hitsPerPage,
               nbHits: 0,
               nbSortedHits: undefined,
               areHitsSorted: false,
               nbPages: 0,
-              page: helper.state.page || 0,
+              page: state.page || 0,
               processingTimeMS: -1,
-              query: helper.state.query || '',
+              query: state.query || '',
               widgetParams: widgetParams
             };
           }
@@ -13694,7 +13737,7 @@
               createURL = _ref6.createURL,
               instantSearchInstance = _ref6.instantSearchInstance;
           var isRefined = results ? on.every(function (v) {
-            return helper.state.isDisjunctiveFacetRefined(attribute, v);
+            return state.isDisjunctiveFacetRefined(attribute, v);
           }) : on.every(function (v) {
             return state.isDisjunctiveFacetRefined(attribute, v);
           });
@@ -14462,6 +14505,7 @@
           var _this = this;
 
           var helper = _ref4.helper,
+              state = _ref4.state,
               scopedResults = _ref4.scopedResults,
               instantSearchInstance = _ref4.instantSearchInstance;
 
@@ -14489,7 +14533,7 @@
             };
           });
           return {
-            currentRefinement: helper.state.query || '',
+            currentRefinement: state.query || '',
             indices: indices,
             refine: connectorState.refine,
             widgetParams: widgetParams
@@ -15177,12 +15221,17 @@
     name: 'dynamic-widgets',
     connector: true
   });
+  var MAX_WILDCARD_FACETS = 20;
 
   var connectDynamicWidgets = function connectDynamicWidgets(renderFn) {
     var unmountFn = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : noop;
     checkRendering(renderFn, withUsage$r());
     return function (widgetParams) {
       var widgets = widgetParams.widgets,
+          _widgetParams$maxValu = widgetParams.maxValuesPerFacet,
+          maxValuesPerFacet = _widgetParams$maxValu === void 0 ? 20 : _widgetParams$maxValu,
+          _widgetParams$facets = widgetParams.facets,
+          facets = _widgetParams$facets === void 0 ? ['*'] : _widgetParams$facets,
           _widgetParams$transfo = widgetParams.transformItems,
           transformItems = _widgetParams$transfo === void 0 ? function (items) {
         return items;
@@ -15195,6 +15244,10 @@
         throw new Error(withUsage$r('The `widgets` option expects an array of widgets.'));
       }
 
+      if (!(Array.isArray(facets) && facets.length <= 1 && (facets[0] === '*' || facets[0] === undefined))) {
+        throw new Error(withUsage$r("The `facets` option only accepts [] or [\"*\"], you passed ".concat(JSON.stringify(facets))));
+      }
+
       var localWidgets = new Map();
       return {
         $$type: 'ais.dynamicWidgets',
@@ -15274,6 +15327,14 @@
           parent.removeWidgets(toRemove);
           unmountFn();
         },
+        getWidgetSearchParameters: function getWidgetSearchParameters(state) {
+          // broadening the scope of facets to avoid conflict between never and *
+          return facets.reduce(function (acc, curr) {
+            return acc.addFacet(curr);
+          }, state.setQueryParameters({
+            maxValuesPerFacet: Math.max(maxValuesPerFacet || 0, state.maxValuesPerFacet || 0)
+          }));
+        },
         getRenderState: function getRenderState(renderState, renderOptions) {
           return _objectSpread2(_objectSpread2({}, renderState), {}, {
             dynamicWidgets: this.getWidgetRenderState(renderOptions)
@@ -15282,7 +15343,8 @@
         getWidgetRenderState: function getWidgetRenderState(_ref4) {
           var _results$renderingCon, _results$renderingCon2, _results$renderingCon3, _results$renderingCon4;
 
-          var results = _ref4.results;
+          var results = _ref4.results,
+              state = _ref4.state;
 
           if (!results) {
             return {
@@ -15291,11 +15353,18 @@
             };
           }
 
-          var attributesToRender = (_results$renderingCon = (_results$renderingCon2 = results.renderingContent) === null || _results$renderingCon2 === void 0 ? void 0 : (_results$renderingCon3 = _results$renderingCon2.facetOrdering) === null || _results$renderingCon3 === void 0 ? void 0 : (_results$renderingCon4 = _results$renderingCon3.facets) === null || _results$renderingCon4 === void 0 ? void 0 : _results$renderingCon4.order) !== null && _results$renderingCon !== void 0 ? _results$renderingCon : [];
+          var attributesToRender = transformItems((_results$renderingCon = (_results$renderingCon2 = results.renderingContent) === null || _results$renderingCon2 === void 0 ? void 0 : (_results$renderingCon3 = _results$renderingCon2.facetOrdering) === null || _results$renderingCon3 === void 0 ? void 0 : (_results$renderingCon4 = _results$renderingCon3.facets) === null || _results$renderingCon4 === void 0 ? void 0 : _results$renderingCon4.order) !== null && _results$renderingCon !== void 0 ? _results$renderingCon : [], {
+            results: results
+          });
+
+          if (!Array.isArray(attributesToRender)) {
+            throw new Error(withUsage$r('The `transformItems` option expects a function that returns an Array.'));
+          }
+
+           _warning(maxValuesPerFacet >= (state.maxValuesPerFacet || 0), "The maxValuesPerFacet set by dynamic widgets (".concat(maxValuesPerFacet, ") is smaller than one of the limits set by a widget (").concat(state.maxValuesPerFacet, "). This causes a mismatch in query parameters and thus an extra network request when that widget is mounted.")) ;
+           _warning(attributesToRender.length <= MAX_WILDCARD_FACETS || widgetParams.facets !== undefined, "More than ".concat(MAX_WILDCARD_FACETS, " facets are requested to be displayed without explicitly setting which facets to retrieve. This could have a performance impact. Set \"facets\" to [] to do two smaller network requests, or explicitly to ['*'] to avoid this warning.")) ;
           return {
-            attributesToRender: transformItems(attributesToRender, {
-              results: results
-            }),
+            attributesToRender: attributesToRender,
             widgetParams: widgetParams
           };
         }
@@ -16167,9 +16236,9 @@
   var dynamicWidgets = function dynamicWidgets(widgetParams) {
     var _ref = widgetParams || {},
         containerSelector = _ref.container,
-        transformItems = _ref.transformItems,
         widgets = _ref.widgets,
-        fallbackWidget = _ref.fallbackWidget;
+        fallbackWidget = _ref.fallbackWidget,
+        otherWidgetParams = _objectWithoutProperties(_ref, ["container", "widgets", "fallbackWidget"]);
 
     if (!containerSelector) {
       throw new Error(withUsage$x('The `container` option is required.'));
@@ -16204,8 +16273,7 @@
     }, function () {
       userContainer.removeChild(rootContainer);
     });
-    var widget = makeWidget({
-      transformItems: transformItems,
+    var widget = makeWidget(_objectSpread2(_objectSpread2({}, otherWidgetParams), {}, {
       widgets: connectorWidgets,
       fallbackWidget: typeof fallbackWidget === 'function' ? function (_ref3) {
         var attribute = _ref3.attribute;
@@ -16216,7 +16284,7 @@
           container: container
         });
       } : undefined
-    });
+    }));
     return _objectSpread2(_objectSpread2({}, widget), {}, {
       init: function init(initOptions) {
         widgets.forEach(function (cb) {