instantsearch.js 4.46.2 → 4.47.0

package/dist/instantsearch.development.js

@@ -1,4 +1,4 @@
-/*! InstantSearch.js 4.46.2 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch.js */
+/*! InstantSearch.js 4.47.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) :
@@ -6304,7 +6304,7 @@
   function createSendEventForFacet(_ref) {
     var instantSearchInstance = _ref.instantSearchInstance,
         helper = _ref.helper,
-        attribute = _ref.attribute,
+        attr = _ref.attribute,
         widgetType = _ref.widgetType;
 
     var sendEventForFacet = function sendEventForFacet() {
@@ -6316,6 +6316,7 @@
           facetValue = args[1],
           _args$ = args[2],
           eventName = _args$ === void 0 ? 'Filter Applied' : _args$;
+      var attribute = typeof attr === 'string' ? attr : attr(facetValue);
 
       if (args.length === 1 && _typeof(args[0]) === 'object') {
         instantSearchInstance.sendEventToInsights(args[0]);
@@ -6481,7 +6482,7 @@
         index: index,
         methodName: 'sendEvent',
         args: args,
-        isSearchStalled: instantSearchInstance._isSearchStalled
+        isSearchStalled: instantSearchInstance.status === 'stalled'
       });
       payloads.forEach(function (payload) {
         return instantSearchInstance.sendEventToInsights(payload);
@@ -7219,6 +7220,45 @@
     });
   }
 
+  function createInitArgs(instantSearchInstance, parent, uiState) {
+    var helper = parent.getHelper();
+    return {
+      uiState: uiState,
+      helper: helper,
+      parent: parent,
+      instantSearchInstance: instantSearchInstance,
+      state: helper.state,
+      renderState: instantSearchInstance.renderState,
+      templatesConfig: instantSearchInstance.templatesConfig,
+      createURL: parent.createURL,
+      scopedResults: [],
+      searchMetadata: {
+        isSearchStalled: instantSearchInstance.status === 'stalled'
+      },
+      status: instantSearchInstance.status,
+      error: instantSearchInstance.error
+    };
+  }
+  function createRenderArgs(instantSearchInstance, parent) {
+    var results = parent.getResults();
+    return {
+      helper: parent.getHelper(),
+      parent: parent,
+      instantSearchInstance: instantSearchInstance,
+      results: results,
+      scopedResults: parent.getScopedResults(),
+      state: results._state,
+      renderState: instantSearchInstance.renderState,
+      templatesConfig: instantSearchInstance.templatesConfig,
+      createURL: parent.createURL,
+      searchMetadata: {
+        isSearchStalled: instantSearchInstance.status === 'stalled'
+      },
+      status: instantSearchInstance.status,
+      error: instantSearchInstance.error
+    };
+  }
+
   function resolveSearchParameters(current) {
     var parent = current.getParent();
     var states = [current.getHelper().state];
@@ -7439,20 +7479,7 @@
 
           widgets.forEach(function (widget) {
             if (widget.getRenderState) {
-              var renderState = widget.getRenderState(localInstantSearchInstance.renderState[_this.getIndexId()] || {}, {
-                uiState: localInstantSearchInstance._initialUiState,
-                helper: _this.getHelper(),
-                parent: _this,
-                instantSearchInstance: localInstantSearchInstance,
-                state: helper.state,
-                renderState: localInstantSearchInstance.renderState,
-                templatesConfig: localInstantSearchInstance.templatesConfig,
-                createURL: _this.createURL,
-                scopedResults: [],
-                searchMetadata: {
-                  isSearchStalled: localInstantSearchInstance._isSearchStalled
-                }
-              });
+              var renderState = widget.getRenderState(localInstantSearchInstance.renderState[_this.getIndexId()] || {}, createInitArgs(localInstantSearchInstance, _this, localInstantSearchInstance._initialUiState));
               storeRenderState({
                 renderState: renderState,
                 instantSearchInstance: localInstantSearchInstance,
@@ -7462,20 +7489,7 @@
           });
           widgets.forEach(function (widget) {
             if (widget.init) {
-              widget.init({
-                helper: helper,
-                parent: _this,
-                uiState: localInstantSearchInstance._initialUiState,
-                instantSearchInstance: localInstantSearchInstance,
-                state: helper.state,
-                renderState: localInstantSearchInstance.renderState,
-                templatesConfig: localInstantSearchInstance.templatesConfig,
-                createURL: _this.createURL,
-                scopedResults: [],
-                searchMetadata: {
-                  isSearchStalled: localInstantSearchInstance._isSearchStalled
-                }
-              });
+              widget.init(createInitArgs(localInstantSearchInstance, _this, localInstantSearchInstance._initialUiState));
             }
           });
           localInstantSearchInstance.scheduleSearch();
@@ -7641,20 +7655,7 @@
 
         localWidgets.forEach(function (widget) {
           if (widget.getRenderState) {
-            var renderState = widget.getRenderState(instantSearchInstance.renderState[_this3.getIndexId()] || {}, {
-              uiState: uiState,
-              helper: helper,
-              parent: _this3,
-              instantSearchInstance: instantSearchInstance,
-              state: helper.state,
-              renderState: instantSearchInstance.renderState,
-              templatesConfig: instantSearchInstance.templatesConfig,
-              createURL: _this3.createURL,
-              scopedResults: [],
-              searchMetadata: {
-                isSearchStalled: instantSearchInstance._isSearchStalled
-              }
-            });
+            var renderState = widget.getRenderState(instantSearchInstance.renderState[_this3.getIndexId()] || {}, createInitArgs(instantSearchInstance, _this3, uiState));
             storeRenderState({
               renderState: renderState,
               instantSearchInstance: instantSearchInstance,
@@ -7668,20 +7669,7 @@
           !widget.getWidgetState || Boolean(widget.getWidgetUiState), 'The `getWidgetState` method is renamed `getWidgetUiState` and will no longer exist under that name in InstantSearch.js 5.x. Please use `getWidgetUiState` instead.') ;
 
           if (widget.init) {
-            widget.init({
-              uiState: uiState,
-              helper: helper,
-              parent: _this3,
-              instantSearchInstance: instantSearchInstance,
-              state: helper.state,
-              renderState: instantSearchInstance.renderState,
-              templatesConfig: instantSearchInstance.templatesConfig,
-              createURL: _this3.createURL,
-              scopedResults: [],
-              searchMetadata: {
-                isSearchStalled: instantSearchInstance._isSearchStalled
-              }
-            });
+            widget.init(createInitArgs(instantSearchInstance, _this3, uiState));
           }
         }); // Subscribe to the Helper state changes for the `uiState` once widgets
         // are initialized. Until the first render, state changes are part of the
@@ -7722,20 +7710,7 @@
 
         localWidgets.forEach(function (widget) {
           if (widget.getRenderState) {
-            var renderState = widget.getRenderState(instantSearchInstance.renderState[_this4.getIndexId()] || {}, {
-              helper: _this4.getHelper(),
-              parent: _this4,
-              instantSearchInstance: instantSearchInstance,
-              results: _this4.getResults(),
-              scopedResults: _this4.getScopedResults(),
-              state: _this4.getResults()._state,
-              renderState: instantSearchInstance.renderState,
-              templatesConfig: instantSearchInstance.templatesConfig,
-              createURL: _this4.createURL,
-              searchMetadata: {
-                isSearchStalled: instantSearchInstance._isSearchStalled
-              }
-            });
+            var renderState = widget.getRenderState(instantSearchInstance.renderState[_this4.getIndexId()] || {}, createRenderArgs(instantSearchInstance, _this4));
             storeRenderState({
               renderState: renderState,
               instantSearchInstance: instantSearchInstance,
@@ -7751,20 +7726,7 @@
           // be delayed. The render is triggered for the complete tree but some parts do
           // not have results yet.
           if (widget.render) {
-            widget.render({
-              helper: helper,
-              parent: _this4,
-              instantSearchInstance: instantSearchInstance,
-              results: _this4.getResults(),
-              scopedResults: _this4.getScopedResults(),
-              state: _this4.getResults()._state,
-              renderState: instantSearchInstance.renderState,
-              templatesConfig: instantSearchInstance.templatesConfig,
-              createURL: _this4.createURL,
-              searchMetadata: {
-                isSearchStalled: instantSearchInstance._isSearchStalled
-              }
-            });
+            widget.render(createRenderArgs(instantSearchInstance, _this4));
           }
         });
       },
@@ -7826,7 +7788,7 @@
     instantSearchInstance.renderState = _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState), {}, _defineProperty({}, parentIndexName, _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState[parentIndexName]), renderState)));
   }
 
-  var version$1 = '4.46.2';
+  var version$1 = '4.47.0';
 
   var NAMESPACE = 'ais';
   var component = function component(componentName) {
@@ -9224,21 +9186,7 @@
   };
 
   function extractPayload(widgets, instantSearchInstance, payload) {
-    var parent = instantSearchInstance.mainIndex;
-    var initOptions = {
-      instantSearchInstance: instantSearchInstance,
-      parent: parent,
-      scopedResults: [],
-      state: parent.getHelper().state,
-      helper: parent.getHelper(),
-      createURL: parent.createURL,
-      uiState: instantSearchInstance._initialUiState,
-      renderState: instantSearchInstance.renderState,
-      templatesConfig: instantSearchInstance.templatesConfig,
-      searchMetadata: {
-        isSearchStalled: instantSearchInstance._isSearchStalled
-      }
-    };
+    var initOptions = createInitArgs(instantSearchInstance, instantSearchInstance.mainIndex, instantSearchInstance._initialUiState);
     widgets.forEach(function (widget) {
       var widgetParams = {};
 
@@ -9368,8 +9316,6 @@
 
       _defineProperty(_assertThisInitialized(_this), "_searchStalledTimer", void 0);
 
-      _defineProperty(_assertThisInitialized(_this), "_isSearchStalled", void 0);
-
       _defineProperty(_assertThisInitialized(_this), "_initialUiState", void 0);
 
       _defineProperty(_assertThisInitialized(_this), "_initialResults", void 0);
@@ -9384,6 +9330,10 @@
 
       _defineProperty(_assertThisInitialized(_this), "sendEventToInsights", void 0);
 
+      _defineProperty(_assertThisInitialized(_this), "status", 'idle');
+
+      _defineProperty(_assertThisInitialized(_this), "error", undefined);
+
       _defineProperty(_assertThisInitialized(_this), "scheduleSearch", defer(function () {
         if (_this.started) {
           _this.mainHelper.search();
@@ -9391,10 +9341,16 @@
       }));
 
       _defineProperty(_assertThisInitialized(_this), "scheduleRender", defer(function () {
+        var shouldResetStatus = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
+
         if (!_this.mainHelper.hasPendingRequests()) {
           clearTimeout(_this._searchStalledTimer);
           _this._searchStalledTimer = null;
-          _this._isSearchStalled = false;
+
+          if (shouldResetStatus) {
+            _this.status = 'idle';
+            _this.error = undefined;
+          }
         }
 
         _this.mainIndex.render({
@@ -9475,7 +9431,6 @@
       };
       _this._stalledSearchDelay = stalledSearchDelay;
       _this._searchStalledTimer = null;
-      _this._isSearchStalled = false;
       _this._createURL = defaultCreateURL;
       _this._initialUiState = initialUiState;
       _this._initialResults = null;
@@ -9504,6 +9459,25 @@
 
 
     _createClass(InstantSearch, [{
+      key: "_isSearchStalled",
+      get:
+      /**
+       * The status of the search. Can be "idle", "loading", "stalled", or "error".
+       */
+
+      /**
+       * The last returned error from the Search API.
+       * The error gets cleared when the next valid search response is rendered.
+       */
+
+      /**
+       * @deprecated use `status === 'stalled'` instead
+       */
+      function get() {
+         _warning(false, "`InstantSearch._isSearchStalled` is deprecated and will be removed in InstantSearch.js 5.0.\n\nUse `InstantSearch.status === \"stalled\"` instead.") ;
+        return this.status === 'stalled';
+      }
+    }, {
       key: "use",
       value: function use() {
         var _this2 = this;
@@ -9665,10 +9639,18 @@
         var mainHelper = this.mainHelper || algoliasearchHelper_1(this.client, this.indexName);
 
         mainHelper.search = function () {
-          // This solution allows us to keep the exact same API for the users but
+          _this3.status = 'loading'; // @MAJOR: use scheduleRender here
+          // For now, widgets don't expect to be rendered at the start of `loading`,
+          // so it would be a breaking change to add an extra render. We don't have
+          // these guarantees about the render event, thus emitting it once more
+          // isn't a breaking change.
+
+          _this3.emit('render'); // This solution allows us to keep the exact same API for the users but
           // under the hood, we have a different implementation. It should be
           // completely transparent for the rest of the codebase. Only this module
           // is impacted.
+
+
           return mainHelper.searchOnlyWithDerivedHelpers();
         };
 
@@ -9725,6 +9707,11 @@
 
 
           error.error = error;
+          _this3.error = error;
+          _this3.status = 'error';
+
+          _this3.scheduleRender(false); // This needs to execute last because it throws the error.
+
 
           _this3.emit('error', error);
         });
@@ -9813,7 +9800,7 @@
 
         if (!this._searchStalledTimer) {
           this._searchStalledTimer = setTimeout(function () {
-            _this4._isSearchStalled = true;
+            _this4.status = 'stalled';
 
             _this4.scheduleRender();
           }, this._stalledSearchDelay);
@@ -10384,7 +10371,10 @@
             sendEvent = createSendEventForFacet({
               instantSearchInstance: instantSearchInstance,
               helper: helper,
-              attribute: hierarchicalFacetName,
+              attribute: function attribute(facetValue) {
+                var index = facetValue.split(separator).length - 1;
+                return attributes[index];
+              },
               widgetType: this.$$type
             });
           }
@@ -16578,9 +16568,10 @@
 
   var CurrentRefinements = function CurrentRefinements(_ref2) {
     var items = _ref2.items,
-        cssClasses = _ref2.cssClasses;
+        cssClasses = _ref2.cssClasses,
+        canRefine = _ref2.canRefine;
     return h("div", {
-      className: cssClasses.root
+      className: classnames(cssClasses.root, _defineProperty({}, cssClasses.noRefinementRoot, !canRefine))
     }, h("ul", {
       className: cssClasses.list
     }, items.map(function (item, index) {
@@ -16610,7 +16601,8 @@
 
   var renderer$2 = function renderer(_ref, isFirstRender) {
     var items = _ref.items,
-        widgetParams = _ref.widgetParams;
+        widgetParams = _ref.widgetParams,
+        canRefine = _ref.canRefine;
 
     if (isFirstRender) {
       return;
@@ -16621,7 +16613,8 @@
         cssClasses = _ref2.cssClasses;
     P(h(CurrentRefinements, {
       cssClasses: cssClasses,
-      items: items
+      items: items,
+      canRefine: canRefine
     }), container);
   };
 
@@ -16641,6 +16634,9 @@
     var containerNode = getContainerNode(container);
     var cssClasses = {
       root: classnames(suit$6(), userCssClasses.root),
+      noRefinementRoot: classnames(suit$6({
+        modifierName: 'noRefinement'
+      }), userCssClasses.noRefinementRoot),
       list: classnames(suit$6({
         descendantName: 'list'
       }), userCssClasses.list),
@@ -17964,9 +17960,10 @@
       var url = _ref.url,
           label = _ref.label,
           count = _ref.count,
-          cssClasses = _ref.cssClasses;
+          cssClasses = _ref.cssClasses,
+          isRefined = _ref.isRefined;
       return h("a", {
-        className: cx(cssClasses.link),
+        className: cx([cx(cssClasses.link), cx(isRefined ? cssClasses.selectedItemLink : undefined)]),
         href: url
       }, h("span", {
         className: cx(cssClasses.label)
@@ -18124,6 +18121,10 @@
       link: classnames(suit$a({
         descendantName: 'link'
       }), userCssClasses.link),
+      selectedItemLink: classnames(suit$a({
+        descendantName: 'link',
+        modifierName: 'selected'
+      }), userCssClasses.selectedItemLink),
       label: classnames(suit$a({
         descendantName: 'label'
       }), userCssClasses.label),