instantsearch.js 4.44.1 → 4.45.0

package/CHANGELOG.md

@@ -1,3 +1,12 @@
+# [4.45.0](https://github.com/algolia/instantsearch.js/compare/v4.44.1...v4.45.0) (2022-08-29)
+
+
+### Features
+
+* **connectors:** deprecate `hasNoResults` in favor of `canRefine` ([#5091](https://github.com/algolia/instantsearch.js/issues/5091)) ([1749a4e](https://github.com/algolia/instantsearch.js/commit/1749a4eb9a2f28fa4a8d442163e3b10acbde7c22))
+
+
+
 ## [4.44.1](https://github.com/algolia/instantsearch.js/compare/v4.44.0...v4.44.1) (2022-08-25)
 
 

package/cjs/connectors/hits-per-page/connectHitsPerPage.js

@@ -127,6 +127,7 @@ var connectHitsPerPage = function connectHitsPerPage(renderFn) {
             results = _ref5.results,
             createURL = _ref5.createURL,
             helper = _ref5.helper;
+        var canRefine = results ? results.nbHits > 0 : false;
         return {
           items: transformItems(normalizeItems(state), {
             results: results
@@ -136,7 +137,8 @@ var connectHitsPerPage = function connectHitsPerPage(renderFn) {
             state: state,
             createURL: createURL
           }),
-          hasNoResults: results ? results.nbHits === 0 : true,
+          hasNoResults: !canRefine,
+          canRefine: canRefine,
           widgetParams: widgetParams
         };
       },

package/cjs/connectors/numeric-menu/connectNumericMenu.js

@@ -7,6 +7,8 @@ exports.default = void 0;
 
 var _index = require("../../lib/utils/index.js");
 
+function _createForOfIteratorHelper(o, allowArrayLike) { var it; if (typeof Symbol === "undefined" || o[Symbol.iterator] == null) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e2) { throw _e2; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = o[Symbol.iterator](); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e3) { didErr = true; err = _e3; }, f: function f() { try { if (!normalCompletion && it.return != null) it.return(); } finally { if (didErr) throw err; } } }; }
+
 function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
 
 function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
@@ -185,12 +187,35 @@ var connectNumericMenu = function connectNumericMenu(renderFn) {
           });
         }
 
+        var hasNoResults = results ? results.nbHits === 0 : true;
+        var preparedItems = prepareItems(state);
+        var allIsSelected = true;
+
+        var _iterator = _createForOfIteratorHelper(preparedItems),
+            _step;
+
+        try {
+          for (_iterator.s(); !(_step = _iterator.n()).done;) {
+            var item = _step.value;
+
+            if (item.isRefined && decodeURI(item.value) !== '{}') {
+              allIsSelected = false;
+              break;
+            }
+          }
+        } catch (err) {
+          _iterator.e(err);
+        } finally {
+          _iterator.f();
+        }
+
         return {
           createURL: connectorState.createURL(state),
-          items: transformItems(prepareItems(state), {
+          items: transformItems(preparedItems, {
             results: results
           }),
-          hasNoResults: results ? results.nbHits === 0 : true,
+          hasNoResults: hasNoResults,
+          canRefine: !(hasNoResults && allIsSelected),
           refine: connectorState.refine,
           sendEvent: connectorState.sendEvent,
           widgetParams: widgetParams

package/cjs/connectors/rating-menu/connectRatingMenu.js

@@ -218,6 +218,9 @@ var connectRatingMenu = function connectRatingMenu(renderFn) {
           });
         }
 
+        var refinementIsApplied = false;
+        var totalCount = 0;
+
         if (results) {
           var facetResults = results.getFacetValues(attribute, {});
           var maxValuesPerFacet = facetResults.length;
@@ -233,6 +236,7 @@ var connectRatingMenu = function connectRatingMenu(renderFn) {
 
           var _loop = function _loop(star) {
             var isRefined = refinedStar === star;
+            refinementIsApplied = refinementIsApplied || isRefined;
             var count = facetResults.filter(function (f) {
               return Number(f.name) >= star && Number(f.name) <= max;
             }).map(function (f) {
@@ -240,6 +244,7 @@ var connectRatingMenu = function connectRatingMenu(renderFn) {
             }).reduce(function (sum, current) {
               return sum + current;
             }, 0);
+            totalCount += count;
 
             if (refinedStar && !isRefined && count === 0) {
               // skip count==0 when at least 1 refinement is enabled
@@ -269,10 +274,11 @@ var connectRatingMenu = function connectRatingMenu(renderFn) {
         }
 
         facetValues = facetValues.reverse();
+        var hasNoResults = results ? results.nbHits === 0 : true;
         return {
           items: facetValues,
-          hasNoResults: results ? results.nbHits === 0 : true,
-          canRefine: facetValues.length > 0,
+          hasNoResults: hasNoResults,
+          canRefine: (!hasNoResults || refinementIsApplied) && totalCount > 0,
           refine: connectorState.toggleRefinementFactory(helper),
           sendEvent: sendEvent,
           createURL: connectorState.createURLFactory({

package/cjs/connectors/sort-by/connectSortBy.js

@@ -85,13 +85,15 @@ var connectSortBy = function connectSortBy(renderFn) {
           };
         }
 
+        var hasNoResults = results ? results.nbHits === 0 : true;
         return {
           currentRefinement: state.index,
           options: transformItems(items, {
             results: results
           }),
           refine: connectorState.setIndex,
-          hasNoResults: results ? results.nbHits === 0 : true,
+          hasNoResults: hasNoResults,
+          canRefine: !hasNoResults && items.length > 0,
           widgetParams: widgetParams
         };
       },

package/cjs/lib/version.js

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

package/dist/instantsearch.development.d.ts

@@ -1872,8 +1872,13 @@ declare type HitsPerPageRenderState = {
     refine: (value: number) => void;
     /**
      * Indicates whether or not the search has results.
+     * @deprecated Use `canRefine` instead.
      */
     hasNoResults: boolean;
+    /**
+     * Indicates if search state can be refined.
+     */
+    canRefine: boolean;
 };
 
 declare type HitsPerPageRenderStateItem = {
@@ -2855,8 +2860,16 @@ declare type NumericMenuRenderState = {
     createURL: CreateURL<NumericMenuRenderStateItem['value']>;
     /**
      * `true` if the last search contains no result
+     * @deprecated Use `canRefine` instead.
      */
     hasNoResults: boolean;
+    /**
+     * Indicates if search state can be refined.
+     *
+     * This is `true` if the last search contains no result and
+     * "All" range is selected
+     */
+    canRefine: boolean;
     /**
      * Sets the selected value and trigger a new search
      */
@@ -3721,6 +3734,8 @@ declare type RatingMenuRenderState = {
     refine: (value: string) => void;
     /**
      * `true` if the last search contains no result.
+     *
+     * @deprecated Use `canRefine` instead.
      */
     hasNoResults: boolean;
     /**
@@ -4683,8 +4698,13 @@ declare type SortByRenderState = {
     refine: (value: string) => void;
     /**
      * `true` if the last search contains no result.
+     * @deprecated Use `canRefine` instead.
      */
     hasNoResults: boolean;
+    /**
+     * `true` if we can refine.
+     */
+    canRefine: boolean;
 };
 
 declare type SortByWidget = WidgetFactory<SortByWidgetDescription & {

package/dist/instantsearch.development.js

@@ -1,4 +1,4 @@
-/*! InstantSearch.js 4.44.1 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch.js */
+/*! InstantSearch.js 4.45.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) :
@@ -297,6 +297,63 @@
     throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
   }
 
+  function _createForOfIteratorHelper(o, allowArrayLike) {
+    var it;
+
+    if (typeof Symbol === "undefined" || o[Symbol.iterator] == null) {
+      if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") {
+        if (it) o = it;
+        var i = 0;
+
+        var F = function () {};
+
+        return {
+          s: F,
+          n: function () {
+            if (i >= o.length) return {
+              done: true
+            };
+            return {
+              done: false,
+              value: o[i++]
+            };
+          },
+          e: function (e) {
+            throw e;
+          },
+          f: F
+        };
+      }
+
+      throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
+    }
+
+    var normalCompletion = true,
+        didErr = false,
+        err;
+    return {
+      s: function () {
+        it = o[Symbol.iterator]();
+      },
+      n: function () {
+        var step = it.next();
+        normalCompletion = step.done;
+        return step;
+      },
+      e: function (e) {
+        didErr = true;
+        err = e;
+      },
+      f: function () {
+        try {
+          if (!normalCompletion && it.return != null) it.return();
+        } finally {
+          if (didErr) throw err;
+        }
+      }
+    };
+  }
+
   function clone(value) {
     if (typeof value === 'object' && value !== null) {
       return _merge(Array.isArray(value) ? [] : {}, value);
@@ -8578,7 +8635,7 @@
     instantSearchInstance.renderState = _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState), {}, _defineProperty({}, parentIndexName, _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState[parentIndexName]), renderState)));
   }
 
-  var version$1 = '4.44.1';
+  var version$1 = '4.45.0';
 
   var NAMESPACE = 'ais';
   var component = function component(componentName) {
@@ -11612,6 +11669,7 @@
               results = _ref5.results,
               createURL = _ref5.createURL,
               helper = _ref5.helper;
+          var canRefine = results ? results.nbHits > 0 : false;
           return {
             items: transformItems(normalizeItems(state), {
               results: results
@@ -11621,7 +11679,8 @@
               state: state,
               createURL: createURL
             }),
-            hasNoResults: results ? results.nbHits === 0 : true,
+            hasNoResults: !canRefine,
+            canRefine: canRefine,
             widgetParams: widgetParams
           };
         },
@@ -12245,12 +12304,35 @@
             });
           }
 
+          var hasNoResults = results ? results.nbHits === 0 : true;
+          var preparedItems = prepareItems(state);
+          var allIsSelected = true;
+
+          var _iterator = _createForOfIteratorHelper(preparedItems),
+              _step;
+
+          try {
+            for (_iterator.s(); !(_step = _iterator.n()).done;) {
+              var item = _step.value;
+
+              if (item.isRefined && decodeURI(item.value) !== '{}') {
+                allIsSelected = false;
+                break;
+              }
+            }
+          } catch (err) {
+            _iterator.e(err);
+          } finally {
+            _iterator.f();
+          }
+
           return {
             createURL: connectorState.createURL(state),
-            items: transformItems(prepareItems(state), {
+            items: transformItems(preparedItems, {
               results: results
             }),
-            hasNoResults: results ? results.nbHits === 0 : true,
+            hasNoResults: hasNoResults,
+            canRefine: !(hasNoResults && allIsSelected),
             refine: connectorState.refine,
             sendEvent: connectorState.sendEvent,
             widgetParams: widgetParams
@@ -13306,13 +13388,15 @@
             };
           }
 
+          var hasNoResults = results ? results.nbHits === 0 : true;
           return {
             currentRefinement: state.index,
             options: transformItems(items, {
               results: results
             }),
             refine: connectorState.setIndex,
-            hasNoResults: results ? results.nbHits === 0 : true,
+            hasNoResults: hasNoResults,
+            canRefine: !hasNoResults && items.length > 0,
             widgetParams: widgetParams
           };
         },
@@ -13516,6 +13600,9 @@
             });
           }
 
+          var refinementIsApplied = false;
+          var totalCount = 0;
+
           if (results) {
             var facetResults = results.getFacetValues(attribute, {});
             var maxValuesPerFacet = facetResults.length;
@@ -13531,6 +13618,7 @@
 
             var _loop = function _loop(star) {
               var isRefined = refinedStar === star;
+              refinementIsApplied = refinementIsApplied || isRefined;
               var count = facetResults.filter(function (f) {
                 return Number(f.name) >= star && Number(f.name) <= max;
               }).map(function (f) {
@@ -13538,6 +13626,7 @@
               }).reduce(function (sum, current) {
                 return sum + current;
               }, 0);
+              totalCount += count;
 
               if (refinedStar && !isRefined && count === 0) {
                 // skip count==0 when at least 1 refinement is enabled
@@ -13567,10 +13656,11 @@
           }
 
           facetValues = facetValues.reverse();
+          var hasNoResults = results ? results.nbHits === 0 : true;
           return {
             items: facetValues,
-            hasNoResults: results ? results.nbHits === 0 : true,
-            canRefine: facetValues.length > 0,
+            hasNoResults: hasNoResults,
+            canRefine: (!hasNoResults || refinementIsApplied) && totalCount > 0,
             refine: connectorState.toggleRefinementFactory(helper),
             sendEvent: sendEvent,
             createURL: connectorState.createURLFactory({