instantsearch.js 4.32.0 → 4.34.0

package/dist/instantsearch.development.js

@@ -1,4 +1,4 @@
-/*! InstantSearch.js 4.32.0 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch.js */
+/*! InstantSearch.js 4.34.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) :
@@ -7909,6 +7909,30 @@
     return attribute;
   }
 
+  // eslint-disable-next-line no-restricted-globals
+
+  /**
+   * Runs code on browser enviromnents safely.
+   */
+  function safelyRunOnBrowser(callback) {
+    var _ref = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {
+      fallback: function fallback() {
+        return undefined;
+      }
+    },
+        fallback = _ref.fallback;
+
+    // eslint-disable-next-line no-restricted-globals
+    if (typeof window === 'undefined') {
+      return fallback();
+    } // eslint-disable-next-line no-restricted-globals
+
+
+    return callback({
+      window: window
+    });
+  }
+
   var withUsage = createDocumentationMessageGenerator({
     name: 'index-widget'
   });
@@ -8162,7 +8186,8 @@
         return this;
       },
       init: function init(_ref2) {
-        var _this3 = this;
+        var _this3 = this,
+            _instantSearchInstanc;
 
         var instantSearchInstance = _ref2.instantSearchInstance,
             parent = _ref2.parent,
@@ -8220,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;
 
@@ -8325,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;
@@ -8428,7 +8470,7 @@
         localUiState = getLocalWidgetsUiState(localWidgets, {
           searchParameters: this.getHelper().state,
           helper: this.getHelper()
-        });
+        }, localUiState);
       }
     };
   };
@@ -8441,7 +8483,7 @@
     instantSearchInstance.renderState = _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState), {}, _defineProperty({}, parentIndexName, _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState[parentIndexName]), renderState)));
   }
 
-  var version$1 = '4.32.0';
+  var version$1 = '4.34.0';
 
   var NAMESPACE = 'ais';
   var component = function component(componentName) {
@@ -9509,6 +9551,8 @@
 
   var setWindowTitle = function setWindowTitle(title) {
     if (title) {
+      // This function is only executed on browsers so we can disable this check.
+      // eslint-disable-next-line no-restricted-globals
       window.document.title = title;
     }
   };
@@ -9519,11 +9563,14 @@
      * using web APIs (`window.location.pushState` and `onpopstate` event).
      */
     function BrowserHistory(_ref) {
+      var _this = this;
+
       var windowTitle = _ref.windowTitle,
           _ref$writeDelay = _ref.writeDelay,
           writeDelay = _ref$writeDelay === void 0 ? 400 : _ref$writeDelay,
           createURL = _ref.createURL,
-          parseURL = _ref.parseURL;
+          parseURL = _ref.parseURL,
+          getLocation = _ref.getLocation;
 
       _classCallCheck(this, BrowserHistory);
 
@@ -9535,15 +9582,23 @@
 
       _defineProperty(this, "parseURL", void 0);
 
+      _defineProperty(this, "getLocation", void 0);
+
       _defineProperty(this, "writeTimer", void 0);
 
+      _defineProperty(this, "shouldPushState", true);
+
       this.windowTitle = windowTitle;
       this.writeTimer = undefined;
       this.writeDelay = writeDelay;
       this._createURL = createURL;
       this.parseURL = parseURL;
-      var title = this.windowTitle && this.windowTitle(this.read());
-      setWindowTitle(title);
+      this.getLocation = getLocation;
+      safelyRunOnBrowser(function () {
+        var title = _this.windowTitle && _this.windowTitle(_this.read());
+
+        setWindowTitle(title);
+      });
     }
     /**
      * Reads the URL and returns a syncable UI search state.
@@ -9555,7 +9610,7 @@
       value: function read() {
         return this.parseURL({
           qsModule: lib$1,
-          location: window.location
+          location: this.getLocation()
         });
       }
       /**
@@ -9565,20 +9620,30 @@
     }, {
       key: "write",
       value: function write(routeState) {
-        var _this = this;
+        var _this2 = this;
 
-        var url = this.createURL(routeState);
-        var title = this.windowTitle && this.windowTitle(routeState);
+        safelyRunOnBrowser(function (_ref2) {
+          var window = _ref2.window;
 
-        if (this.writeTimer) {
-          window.clearTimeout(this.writeTimer);
-        }
+          var url = _this2.createURL(routeState);
 
-        this.writeTimer = window.setTimeout(function () {
-          setWindowTitle(title);
-          window.history.pushState(routeState, title || '', url);
-          _this.writeTimer = undefined;
-        }, this.writeDelay);
+          var title = _this2.windowTitle && _this2.windowTitle(routeState);
+
+          if (_this2.writeTimer) {
+            clearTimeout(_this2.writeTimer);
+          }
+
+          _this2.writeTimer = setTimeout(function () {
+            setWindowTitle(title);
+
+            if (_this2.shouldPushState) {
+              window.history.pushState(routeState, title || '', url);
+            }
+
+            _this2.shouldPushState = true;
+            _this2.writeTimer = undefined;
+          }, _this2.writeDelay);
+        });
       }
       /**
        * Sets a callback on the `onpopstate` event of the history API of the current page.
@@ -9588,26 +9653,30 @@
     }, {
       key: "onUpdate",
       value: function onUpdate(callback) {
-        var _this2 = this;
+        var _this3 = this;
 
         this._onPopState = function (event) {
-          if (_this2.writeTimer) {
-            window.clearTimeout(_this2.writeTimer);
-            _this2.writeTimer = undefined;
+          if (_this3.writeTimer) {
+            clearTimeout(_this3.writeTimer);
+            _this3.writeTimer = undefined;
           }
 
+          _this3.shouldPushState = false;
           var routeState = event.state; // At initial load, the state is read from the URL without update.
           // Therefore the state object is not available.
           // In this case, we fallback and read the URL.
 
           if (!routeState) {
-            callback(_this2.read());
+            callback(_this3.read());
           } else {
             callback(routeState);
           }
         };
 
-        window.addEventListener('popstate', this._onPopState);
+        safelyRunOnBrowser(function (_ref3) {
+          var window = _ref3.window;
+          window.addEventListener('popstate', _this3._onPopState);
+        });
       }
       /**
        * Creates a complete URL from a given syncable UI state.
@@ -9623,7 +9692,7 @@
         return this._createURL({
           qsModule: lib$1,
           routeState: routeState,
-          location: window.location
+          location: this.getLocation()
         });
       }
       /**
@@ -9633,12 +9702,18 @@
     }, {
       key: "dispose",
       value: function dispose() {
-        if (this._onPopState) {
-          window.removeEventListener('popstate', this._onPopState);
-        }
+        var _this4 = this;
+
+        safelyRunOnBrowser(function (_ref4) {
+          var window = _ref4.window;
+
+          if (_this4._onPopState) {
+            window.removeEventListener('popstate', _this4._onPopState);
+          }
+        });
 
         if (this.writeTimer) {
-          window.clearTimeout(this.writeTimer);
+          clearTimeout(this.writeTimer);
         }
 
         this.write({});
@@ -9649,12 +9724,12 @@
   }();
 
   function historyRouter() {
-    var _ref2 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
-        _ref2$createURL = _ref2.createURL,
-        createURL = _ref2$createURL === void 0 ? function (_ref3) {
-      var qsModule = _ref3.qsModule,
-          routeState = _ref3.routeState,
-          location = _ref3.location;
+    var _ref5 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
+        _ref5$createURL = _ref5.createURL,
+        createURL = _ref5$createURL === void 0 ? function (_ref6) {
+      var qsModule = _ref6.qsModule,
+          routeState = _ref6.routeState,
+          location = _ref6.location;
       var protocol = location.protocol,
           hostname = location.hostname,
           _location$port = location.port,
@@ -9670,11 +9745,11 @@
       }
 
       return "".concat(protocol, "//").concat(hostname).concat(portWithPrefix).concat(pathname, "?").concat(queryString).concat(hash);
-    } : _ref2$createURL,
-        _ref2$parseURL = _ref2.parseURL,
-        parseURL = _ref2$parseURL === void 0 ? function (_ref4) {
-      var qsModule = _ref4.qsModule,
-          location = _ref4.location;
+    } : _ref5$createURL,
+        _ref5$parseURL = _ref5.parseURL,
+        parseURL = _ref5$parseURL === void 0 ? function (_ref7) {
+      var qsModule = _ref7.qsModule,
+          location = _ref7.location;
       // `qs` by default converts arrays with more than 20 items to an object.
       // We want to avoid this because the data structure manipulated can therefore vary.
       // Setting the limit to `100` seems a good number because the engine's default is 100
@@ -9688,16 +9763,28 @@
       return qsModule.parse(location.search.slice(1), {
         arrayLimit: 99
       });
-    } : _ref2$parseURL,
-        _ref2$writeDelay = _ref2.writeDelay,
-        writeDelay = _ref2$writeDelay === void 0 ? 400 : _ref2$writeDelay,
-        windowTitle = _ref2.windowTitle;
+    } : _ref5$parseURL,
+        _ref5$writeDelay = _ref5.writeDelay,
+        writeDelay = _ref5$writeDelay === void 0 ? 400 : _ref5$writeDelay,
+        windowTitle = _ref5.windowTitle,
+        _ref5$getLocation = _ref5.getLocation,
+        getLocation = _ref5$getLocation === void 0 ? function () {
+      return safelyRunOnBrowser(function (_ref8) {
+        var window = _ref8.window;
+        return window.location;
+      }, {
+        fallback: function fallback() {
+          throw new Error('You need to provide `getLocation` to the `history` router in environments where `window` does not exist.');
+        }
+      });
+    } : _ref5$getLocation;
 
     return new BrowserHistory({
       createURL: createURL,
       parseURL: parseURL,
       writeDelay: writeDelay,
-      windowTitle: windowTitle
+      windowTitle: windowTitle,
+      getLocation: getLocation
     });
   }
 
@@ -9791,7 +9878,14 @@
   }
 
   function isMetadataEnabled() {
-    return typeof window !== 'undefined' && window.navigator.userAgent.indexOf('Algolia Crawler') > -1;
+    return safelyRunOnBrowser(function (_ref) {
+      var window = _ref.window;
+      return window.navigator.userAgent.indexOf('Algolia Crawler') > -1;
+    }, {
+      fallback: function fallback() {
+        return false;
+      }
+    });
   }
   /**
    * Exposes the metadata of mounted widgets in a custom
@@ -9802,8 +9896,8 @@
    */
 
   function createMetadataMiddleware() {
-    return function (_ref) {
-      var instantSearchInstance = _ref.instantSearchInstance;
+    return function (_ref2) {
+      var instantSearchInstance = _ref2.instantSearchInstance;
       var payload = {
         widgets: []
       };
@@ -9886,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);
@@ -9990,6 +10086,7 @@
       _this._isSearchStalled = false;
       _this._createURL = defaultCreateURL;
       _this._initialUiState = initialUiState;
+      _this._initialResults = null;
 
       if (searchFunction) {
         _this._searchFunction = searchFunction;
@@ -10232,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
 
@@ -10296,15 +10411,17 @@
         var nextUiState = typeof uiState === 'function' ? uiState(this.mainIndex.getWidgetUiState({})) : uiState;
 
         var setIndexHelperState = function setIndexHelperState(indexWidget) {
+          var nextIndexUiState = nextUiState[indexWidget.getIndexId()] || {};
+
           {
             checkIndexUiState({
               index: indexWidget,
-              indexUiState: nextUiState[indexWidget.getIndexId()]
+              indexUiState: nextIndexUiState
             });
           }
 
           indexWidget.getHelper().setState(indexWidget.getWidgetSearchParameters(indexWidget.getHelper().state, {
-            uiState: nextUiState[indexWidget.getIndexId()]
+            uiState: nextIndexUiState
           }));
           indexWidget.getWidgets().filter(isIndexWidget).forEach(setIndexHelperState);
         };
@@ -11485,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;
@@ -11990,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);
       }
     }
 
@@ -12043,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') {
@@ -12211,6 +12330,7 @@
         getWidgetRenderState: function getWidgetRenderState(_ref6) {
           var results = _ref6.results,
               helper = _ref6.helper,
+              state = _ref6.state,
               createURL = _ref6.createURL;
 
           if (!connectorState.refine) {
@@ -12221,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
@@ -12948,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();
               }
             };
@@ -12969,7 +13089,7 @@
 
           _clear = clear(helper);
           return {
-            query: helper.state.query || '',
+            query: state.query || '',
             refine: _refine,
             clear: _cachedClear,
             widgetParams: widgetParams,
@@ -13055,6 +13175,7 @@
         getWidgetRenderState: function getWidgetRenderState(_ref3) {
           var results = _ref3.results,
               helper = _ref3.helper,
+              state = _ref3.state,
               parent = _ref3.parent;
 
           if (!connectorState.initialIndex && parent) {
@@ -13068,7 +13189,7 @@
           }
 
           return {
-            currentRefinement: helper.state.index,
+            currentRefinement: state.index,
             options: transformItems(items),
             refine: connectorState.setIndex,
             hasNoResults: results ? results.nbHits === 0 : true,
@@ -13412,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
             };
           }
@@ -13616,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);
           });
@@ -14122,11 +14243,20 @@
   var connectPoweredBy = function connectPoweredBy(renderFn) {
     var unmountFn = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : noop;
     checkRendering(renderFn, withUsage$k());
-    var defaultUrl = 'https://www.algolia.com/?' + 'utm_source=instantsearch.js&' + 'utm_medium=website&' + "utm_content=".concat(typeof window !== 'undefined' && window.location ? window.location.hostname : '', "&") + 'utm_campaign=poweredby';
+    var defaultUrl = 'https://www.algolia.com/?' + 'utm_source=instantsearch.js&' + 'utm_medium=website&' + "utm_content=".concat(safelyRunOnBrowser(function (_ref) {
+      var _window$location;
+
+      var window = _ref.window;
+      return ((_window$location = window.location) === null || _window$location === void 0 ? void 0 : _window$location.hostname) || '';
+    }, {
+      fallback: function fallback() {
+        return '';
+      }
+    }), "&") + 'utm_campaign=poweredby';
     return function (widgetParams) {
-      var _ref = widgetParams || {},
-          _ref$url = _ref.url,
-          url = _ref$url === void 0 ? defaultUrl : _ref$url;
+      var _ref2 = widgetParams || {},
+          _ref2$url = _ref2.url,
+          url = _ref2$url === void 0 ? defaultUrl : _ref2$url;
 
       return {
         $$type: 'ais.poweredBy',
@@ -14375,6 +14505,7 @@
           var _this = this;
 
           var helper = _ref4.helper,
+              state = _ref4.state,
               scopedResults = _ref4.scopedResults,
               instantSearchInstance = _ref4.instantSearchInstance;
 
@@ -14402,7 +14533,7 @@
             };
           });
           return {
-            currentRefinement: helper.state.query || '',
+            currentRefinement: state.query || '',
             indices: indices,
             refine: connectorState.refine,
             widgetParams: widgetParams
@@ -14611,6 +14742,11 @@
     };
   };
 
+  // `SpeechRecognition` is an API used on the browser so we can safely disable
+  // the `window` check.
+
+  /* eslint-disable no-restricted-globals */
+
   /* global SpeechRecognition SpeechRecognitionEvent */
   var createVoiceSearchHelper = function createVoiceSearchHelper(_ref) {
     var searchAsYouSpeak = _ref.searchAsYouSpeak,
@@ -21487,28 +21623,27 @@
   }
 
   var KEY = 'ais.infiniteHits';
-
-  function hasSessionStorage() {
-    return typeof window !== 'undefined' && typeof window.sessionStorage !== 'undefined';
-  }
-
   function createInfiniteHitsSessionStorageCache() {
     return {
       read: function read(_ref2) {
         var state = _ref2.state;
+        var sessionStorage = safelyRunOnBrowser(function (_ref3) {
+          var window = _ref3.window;
+          return window.sessionStorage;
+        });
 
-        if (!hasSessionStorage()) {
+        if (!sessionStorage) {
           return null;
         }
 
         try {
           var cache = JSON.parse( // @ts-expect-error JSON.parse() requires a string, but it actually accepts null, too.
-          window.sessionStorage.getItem(KEY));
+          sessionStorage.getItem(KEY));
           return cache && isEqual(cache.state, getStateWithoutPage$1(state)) ? cache.hits : null;
         } catch (error) {
           if (error instanceof SyntaxError) {
             try {
-              window.sessionStorage.removeItem(KEY);
+              sessionStorage.removeItem(KEY);
             } catch (err) {// do nothing
             }
           }
@@ -21516,16 +21651,20 @@
           return null;
         }
       },
-      write: function write(_ref3) {
-        var state = _ref3.state,
-            hits = _ref3.hits;
+      write: function write(_ref4) {
+        var state = _ref4.state,
+            hits = _ref4.hits;
+        var sessionStorage = safelyRunOnBrowser(function (_ref5) {
+          var window = _ref5.window;
+          return window.sessionStorage;
+        });
 
-        if (!hasSessionStorage()) {
+        if (!sessionStorage) {
           return;
         }
 
         try {
-          window.sessionStorage.setItem(KEY, JSON.stringify({
+          sessionStorage.setItem(KEY, JSON.stringify({
             state: getStateWithoutPage$1(state),
             hits: hits
           }));