instantsearch.js 4.44.0 → 4.45.1

package/CHANGELOG.md

@@ -1,3 +1,30 @@
+## [4.45.1](https://github.com/algolia/instantsearch.js/compare/v4.45.0...v4.45.1) (2022-09-06)
+
+
+### Bug Fixes
+
+* **ratingMenu:** fix `undefined` facet values error when `disjunctiveFacets` is empty ([#5096](https://github.com/algolia/instantsearch.js/issues/5096)) ([dd870d5](https://github.com/algolia/instantsearch.js/commit/dd870d5a658ce42b068eadf34f9b69772291aa20))
+
+
+
+# [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)
+
+
+### Bug Fixes
+
+* **connectNumericMenu + connectRange:** stop sending invalid clickedFilters event ([#5085](https://github.com/algolia/instantsearch.js/issues/5085)) ([20996c7](https://github.com/algolia/instantsearch.js/commit/20996c7a159988c58e00ff24d2d2dc98af8b980f))
+
+
+
 # [4.44.0](https://github.com/algolia/instantsearch.js/compare/v4.43.1...v4.44.0) (2022-08-08)
 
 

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."); }
@@ -32,46 +34,11 @@ var withUsage = (0, _index.createDocumentationMessageGenerator)({
 var $$type = 'ais.numericMenu';
 
 var createSendEvent = function createSendEvent(_ref) {
-  var instantSearchInstance = _ref.instantSearchInstance,
-      helper = _ref.helper,
-      attribute = _ref.attribute;
+  var instantSearchInstance = _ref.instantSearchInstance;
   return function () {
-    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
-      args[_key] = arguments[_key];
-    }
-
-    if (args.length === 1) {
-      instantSearchInstance.sendEventToInsights(args[0]);
-      return;
-    }
-
-    var eventType = args[0],
-        facetValue = args[1],
-        _args$ = args[2],
-        eventName = _args$ === void 0 ? 'Filter Applied' : _args$;
-
-    if (eventType !== 'click') {
+    if (arguments.length === 1) {
+      instantSearchInstance.sendEventToInsights(arguments.length <= 0 ? undefined : arguments[0]);
       return;
-    } // facetValue === "%7B%22start%22:5,%22end%22:10%7D"
-
-
-    var filters = (0, _index.convertNumericRefinementsToFilters)(getRefinedState(helper.state, attribute, facetValue), attribute);
-
-    if (filters && filters.length > 0) {
-      /*
-        filters === ["price<=10", "price>=5"]
-      */
-      instantSearchInstance.sendEventToInsights({
-        insightsMethod: 'clickedFilters',
-        widgetType: $$type,
-        eventType: eventType,
-        payload: {
-          eventName: eventName,
-          index: helper.getIndex(),
-          filters: filters
-        },
-        attribute: attribute
-      });
     }
   };
 };
@@ -216,18 +183,39 @@ var connectNumericMenu = function connectNumericMenu(renderFn) {
 
         if (!connectorState.sendEvent) {
           connectorState.sendEvent = createSendEvent({
-            instantSearchInstance: instantSearchInstance,
-            helper: helper,
-            attribute: attribute
+            instantSearchInstance: instantSearchInstance
           });
         }
 
+        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/range/connectRange.js

@@ -156,50 +156,12 @@ var connectRange = function connectRange(renderFn) {
       return null;
     };
 
-    var sendEventWithRefinedState = function sendEventWithRefinedState(refinedState, instantSearchInstance, helper) {
-      var eventName = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : 'Filter Applied';
-      var filters = (0, _index.convertNumericRefinementsToFilters)(refinedState, attribute);
-
-      if (filters && filters.length > 0) {
-        instantSearchInstance.sendEventToInsights({
-          insightsMethod: 'clickedFilters',
-          widgetType: $$type,
-          eventType: 'click',
-          payload: {
-            eventName: eventName,
-            index: helper.getIndex(),
-            filters: filters
-          },
-          attribute: attribute
-        });
-      }
-    };
-
-    var createSendEvent = function createSendEvent(instantSearchInstance, helper, currentRange) {
+    var createSendEvent = function createSendEvent(instantSearchInstance) {
       return function () {
-        for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
-          args[_key] = arguments[_key];
-        }
-
-        if (args.length === 1) {
-          instantSearchInstance.sendEventToInsights(args[0]);
+        if (arguments.length === 1) {
+          instantSearchInstance.sendEventToInsights(arguments.length <= 0 ? undefined : arguments[0]);
           return;
         }
-
-        var eventType = args[0],
-            facetValue = args[1],
-            eventName = args[2];
-
-        if (eventType !== 'click') {
-          return;
-        }
-
-        var _facetValue = _slicedToArray(facetValue, 2),
-            nextMin = _facetValue[0],
-            nextMax = _facetValue[1];
-
-        var refinedState = getRefinedState(helper, currentRange, nextMin, nextMax);
-        sendEventWithRefinedState(refinedState, instantSearchInstance, helper, eventName);
       };
     };
 
@@ -245,7 +207,7 @@ var connectRange = function connectRange(renderFn) {
       return [min, max];
     }
 
-    function _refine(instantSearchInstance, helper, currentRange) {
+    function _refine(helper, currentRange) {
       return function () {
         var _ref11 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [undefined, undefined],
             _ref12 = _slicedToArray(_ref11, 2),
@@ -255,7 +217,6 @@ var connectRange = function connectRange(renderFn) {
         var refinedState = getRefinedState(helper, currentRange, nextMin, nextMax);
 
         if (refinedState) {
-          sendEventWithRefinedState(refinedState, instantSearchInstance, helper);
           helper.setState(refinedState).search();
         }
       };
@@ -301,12 +262,12 @@ var connectRange = function connectRange(renderFn) {
           // On first render pass an empty range
           // to be able to bypass the validation
           // related to it
-          refine = _refine(instantSearchInstance, helper, {
+          refine = _refine(helper, {
             min: undefined,
             max: undefined
           });
         } else {
-          refine = _refine(instantSearchInstance, helper, currentRange);
+          refine = _refine(helper, currentRange);
         }
 
         return {
@@ -314,7 +275,7 @@ var connectRange = function connectRange(renderFn) {
           canRefine: currentRange.min !== currentRange.max,
           format: rangeFormatter,
           range: currentRange,
-          sendEvent: createSendEvent(instantSearchInstance, helper, currentRange),
+          sendEvent: createSendEvent(instantSearchInstance),
           widgetParams: _objectSpread(_objectSpread({}, widgetParams), {}, {
             precision: precision
           }),

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

@@ -218,8 +218,11 @@ var connectRatingMenu = function connectRatingMenu(renderFn) {
           });
         }
 
-        if (results) {
-          var facetResults = results.getFacetValues(attribute, {});
+        var refinementIsApplied = false;
+        var totalCount = 0;
+        var facetResults = results === null || results === void 0 ? void 0 : results.getFacetValues(attribute, {});
+
+        if (results && facetResults) {
           var maxValuesPerFacet = facetResults.length;
           var maxDecimalPlaces = getFacetsMaxDecimalPlaces(facetResults);
           var maxFacets = Math.pow(10, maxDecimalPlaces) * max;
@@ -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.0';
+var _default = '4.45.1';
 exports.default = _default;

package/cjs/widgets/clear-refinements/clear-refinements.js

@@ -39,7 +39,7 @@ var renderer = function renderer(_ref) {
       templates = _ref.templates;
   return function (_ref2, isFirstRendering) {
     var refine = _ref2.refine,
-        hasRefinements = _ref2.hasRefinements,
+        canRefine = _ref2.canRefine,
         instantSearchInstance = _ref2.instantSearchInstance;
 
     if (isFirstRendering) {
@@ -54,7 +54,7 @@ var renderer = function renderer(_ref) {
     (0, _preact.render)((0, _preact.h)(_ClearRefinements.default, {
       refine: refine,
       cssClasses: cssClasses,
-      hasRefinements: hasRefinements,
+      hasRefinements: canRefine,
       templateProps: renderState.templateProps
     }), containerNode);
   };

package/dist/instantsearch.development.d.ts

@@ -173,7 +173,7 @@ declare type AnswersRenderState = {
     /**
      * The matched hits from Algolia API.
      */
-    hits: Hits;
+    hits: Hit[];
     /**
      * Whether it's still loading the results from the Answers API.
      */
@@ -264,7 +264,7 @@ declare type AutocompleteRenderState = {
         /**
          * The resolved hits from the index matching the query.
          */
-        hits: Hits;
+        hits: Hit[];
         /**
          * The full results object from the Algolia API.
          */
@@ -518,11 +518,11 @@ declare type BrowserHistoryArgs<TRouteState> = {
     getLocation(): Location;
 };
 
-declare type BuiltInBindEventForHits = (eventType: string, hits: Hit | Hits, eventName?: string) => string;
+declare type BuiltInBindEventForHits = (eventType: string, hits: Hit | Hit[], eventName?: string) => string;
 
 declare type BuiltInSendEventForFacet = (eventType: string, facetValue: string, eventName?: string) => void;
 
-declare type BuiltInSendEventForHits = (eventType: string, hits: Hit | Hits, eventName?: string) => void;
+declare type BuiltInSendEventForHits = (eventType: string, hits: Hit | Hit[], eventName?: string) => void;
 
 declare type BuiltInSendEventForToggle = (eventType: string, isRefined: boolean, eventName?: string) => void;
 
@@ -1769,11 +1769,6 @@ declare type HitHighlightResult = {
     [attribute: string]: HitAttributeHighlightResult | HitAttributeHighlightResult[] | HitHighlightResult[] | HitHighlightResult;
 };
 
-/**
- * @deprecated use Hit[] directly instead
- */
-declare type Hits = Hit[];
-
 declare const hits: HitsWidget;
 
 declare type HitsConnector<THit extends BaseHit = BaseHit> = Connector<HitsWidgetDescription<THit>, HitsConnectorParams<THit>>;
@@ -1872,8 +1867,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 = {
@@ -2401,6 +2401,10 @@ declare type InstantSearchModule = {
     reverseHighlight: typeof helpers.reverseHighlight;
     snippet: typeof helpers.snippet;
     reverseSnippet: typeof helpers.reverseSnippet;
+    /**
+     * @deprecated use createInsightsMiddleware
+     * @link https://www.algolia.com/doc/api-reference/widgets/insights/js/
+     */
     insights: typeof helpers.insights;
 };
 
@@ -2855,8 +2859,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 +3733,8 @@ declare type RatingMenuRenderState = {
     refine: (value: string) => void;
     /**
      * `true` if the last search contains no result.
+     *
+     * @deprecated Use `canRefine` instead.
      */
     hasNoResults: boolean;
     /**
@@ -4240,7 +4254,7 @@ declare type RendererOptions<TWidgetParams> = {
      * The mutable list of hits. The may change depending
      * of the given transform items function.
      */
-    hits?: Hits;
+    hits?: Hit[];
     /**
      * The current insights client, if any.
      */
@@ -4683,8 +4697,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 & {