instantsearch.js 4.30.3 → 4.33.0

package/dist/instantsearch.development.js

@@ -1,4 +1,4 @@
-/*! InstantSearch.js 4.30.3 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch.js */
+/*! InstantSearch.js 4.33.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) :
@@ -318,7 +318,10 @@
     }
 
     for (var key in source) {
-      if (!Object.prototype.hasOwnProperty.call(source, key)) {
+      if (
+        !Object.prototype.hasOwnProperty.call(source, key) ||
+        key === '__proto__'
+      ) {
         continue;
       }
 
@@ -329,7 +332,10 @@
         continue;
       }
 
-      if (isObjectOrArrayOrFunction(targetVal) && isObjectOrArrayOrFunction(sourceVal)) {
+      if (
+        isObjectOrArrayOrFunction(targetVal) &&
+        isObjectOrArrayOrFunction(sourceVal)
+      ) {
         target[key] = _merge(targetVal, sourceVal);
       } else {
         target[key] = clone(sourceVal);
@@ -1906,9 +1912,17 @@
 
     managedParameters: [
       'index',
-      'facets', 'disjunctiveFacets', 'facetsRefinements',
-      'facetsExcludes', 'disjunctiveFacetsRefinements',
-      'numericRefinements', 'tagRefinements', 'hierarchicalFacets', 'hierarchicalFacetsRefinements'
+
+      'facets',
+      'disjunctiveFacets',
+      'facetsRefinements',
+      'hierarchicalFacets',
+      'facetsExcludes',
+
+      'disjunctiveFacetsRefinements',
+      'numericRefinements',
+      'tagRefinements',
+      'hierarchicalFacetsRefinements'
     ],
     getQueryParams: function getQueryParams() {
       var managedParameters = this.managedParameters;
@@ -3146,6 +3160,10 @@
       }
     });
 
+    orderedFacets = orderedFacets.filter(function(facet) {
+      return facet;
+    });
+
     var sortRemainingBy = facetOrdering.sortRemainingBy;
     var ordering;
     if (sortRemainingBy === 'hidden') {
@@ -3837,7 +3855,7 @@
       var numericFilters = requestBuilder._getNumericFilters(state);
       var tagFilters = requestBuilder._getTagFilters(state);
       var additionalParams = {
-        facets: facets,
+        facets: facets.indexOf('*') > -1 ? ['*'] : facets,
         tagFilters: tagFilters
       };
 
@@ -4097,7 +4115,7 @@
 
   var requestBuilder_1 = requestBuilder;
 
-  var version = '3.5.5';
+  var version = '3.6.2';
 
   /**
    * Event triggered when a parameter is set or updated
@@ -7868,17 +7886,51 @@
   }
 
   function getWidgetAttribute(widget, initOptions) {
-    try {
-      // assume the type to be the correct one, but throw a nice error if it isn't the case
-      var _getWidgetRenderState = widget.getWidgetRenderState(initOptions),
-          widgetParams = _getWidgetRenderState.widgetParams;
+    var _widget$getWidgetRend;
 
-      var attribute = 'attribute' in widgetParams ? widgetParams.attribute : widgetParams.attributes[0];
-      if (typeof attribute !== 'string') throw new Error();
-      return attribute;
-    } catch (e) {
+    var renderState = (_widget$getWidgetRend = widget.getWidgetRenderState) === null || _widget$getWidgetRend === void 0 ? void 0 : _widget$getWidgetRend.call(widget, initOptions);
+    var attribute = null;
+
+    if (renderState && renderState.widgetParams) {
+      // casting as widgetParams is checked just before
+      var widgetParams = renderState.widgetParams;
+
+      if (widgetParams.attribute) {
+        attribute = widgetParams.attribute;
+      } else if (Array.isArray(widgetParams.attributes)) {
+        attribute = widgetParams.attributes[0];
+      }
+    }
+
+    if (typeof attribute !== 'string') {
       throw new Error("Could not find the attribute of the widget:\n\n".concat(JSON.stringify(widget), "\n\nPlease check whether the widget's getWidgetRenderState returns widgetParams.attribute correctly."));
     }
+
+    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({
@@ -8413,7 +8465,7 @@
     instantSearchInstance.renderState = _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState), {}, _defineProperty({}, parentIndexName, _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState[parentIndexName]), renderState)));
   }
 
-  var version$1 = '4.30.3';
+  var version$1 = '4.33.0';
 
   var NAMESPACE = 'ais';
   var component = function component(componentName) {
@@ -9481,6 +9533,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;
     }
   };
@@ -9491,11 +9545,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);
 
@@ -9507,15 +9564,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.
@@ -9527,7 +9592,7 @@
       value: function read() {
         return this.parseURL({
           qsModule: lib$1,
-          location: window.location
+          location: this.getLocation()
         });
       }
       /**
@@ -9537,20 +9602,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);
+
+          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);
+            }
 
-        this.writeTimer = window.setTimeout(function () {
-          setWindowTitle(title);
-          window.history.pushState(routeState, title || '', url);
-          _this.writeTimer = undefined;
-        }, this.writeDelay);
+            _this2.shouldPushState = true;
+            _this2.writeTimer = undefined;
+          }, _this2.writeDelay);
+        });
       }
       /**
        * Sets a callback on the `onpopstate` event of the history API of the current page.
@@ -9560,26 +9635,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.
@@ -9595,7 +9674,7 @@
         return this._createURL({
           qsModule: lib$1,
           routeState: routeState,
-          location: window.location
+          location: this.getLocation()
         });
       }
       /**
@@ -9605,12 +9684,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({});
@@ -9621,12 +9706,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,
@@ -9642,11 +9727,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
@@ -9660,16 +9745,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
     });
   }
 
@@ -9740,7 +9837,8 @@
       if (widget.getWidgetRenderState) {
         var renderState = widget.getWidgetRenderState(initOptions);
 
-        if (renderState && _typeof(renderState.widgetParams) === 'object') {
+        if (renderState && renderState.widgetParams) {
+          // casting, as we just earlier checked widgetParams exists, and thus an object
           widgetParams = renderState.widgetParams;
         }
       } // since we destructure in all widgets, the parameters with defaults are set to "undefined"
@@ -9762,7 +9860,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
@@ -9773,8 +9878,8 @@
    */
 
   function createMetadataMiddleware() {
-    return function (_ref) {
-      var instantSearchInstance = _ref.instantSearchInstance;
+    return function (_ref2) {
+      var instantSearchInstance = _ref2.instantSearchInstance;
       var payload = {
         widgets: []
       };
@@ -10203,7 +10308,7 @@
           parent: null,
           uiState: this._initialUiState
         });
-        mainHelper.search(); // Keep the previous reference for legacy purpose, some pattern use
+        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,
@@ -10267,15 +10372,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);
         };
@@ -11051,7 +11158,12 @@
   };
 
   var wrapInsightsClient = function wrapInsightsClient(aa, results, hits) {
-    return function (method, payload) {
+    return function (method) {
+      for (var _len = arguments.length, payloads = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
+        payloads[_key - 1] = arguments[_key];
+      }
+
+      var payload = payloads[0];
        _warning(false, "`insights` function has been deprecated. It is still supported in 4.x releases, but not further. It is replaced by the `insights` middleware.\n\nFor more information, visit https://www.algolia.com/doc/guides/getting-insights-and-analytics/search-analytics/click-through-and-conversions/how-to/send-click-and-conversion-events-with-instantsearch/js/") ;
 
       if (!aa) {
@@ -14088,11 +14200,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',
@@ -14577,6 +14698,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,
@@ -21453,28 +21579,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
             }
           }
@@ -21482,16 +21607,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
           }));