instantsearch.js 4.43.1 → 4.45.0

package/cjs/helpers/components/Snippet.js

@@ -0,0 +1,45 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Snippet = Snippet;
+
+var _preact = require("preact");
+
+var _Snippet = require("../../components/Snippet/Snippet.js");
+
+var _getHighlightedParts = _interopRequireDefault(require("../../lib/utils/getHighlightedParts.js"));
+
+var _getPropertyByPath = _interopRequireDefault(require("../../lib/utils/getPropertyByPath.js"));
+
+var _unescape = _interopRequireDefault(require("../../lib/utils/unescape.js"));
+
+var _logger = require("../../lib/utils/logger.js");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
+
+function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
+
+function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
+
+function Snippet(_ref) {
+  var hit = _ref.hit,
+      attribute = _ref.attribute,
+      cssClasses = _ref.cssClasses,
+      props = _objectWithoutProperties(_ref, ["hit", "attribute", "cssClasses"]);
+
+  var property = (0, _getPropertyByPath.default)(hit._snippetResult, attribute) || [];
+  var properties = Array.isArray(property) ? property : [property];
+  process.env.NODE_ENV === 'development' ? (0, _logger.warning)(Boolean(properties.length), "Could not enable snippet for \"".concat(attribute.toString(), "\", will display an empty string.\nPlease check whether this attribute exists and is specified in `attributesToSnippet`.\n\nSee: https://alg.li/highlighting\n")) : void 0;
+  var parts = properties.map(function (_ref2) {
+    var value = _ref2.value;
+    return (0, _getHighlightedParts.default)((0, _unescape.default)(value || ''));
+  });
+  return (0, _preact.h)(_Snippet.Snippet, _extends({}, props, {
+    parts: parts,
+    classNames: cssClasses
+  }));
+}

package/cjs/helpers/components/index.js

@@ -0,0 +1,57 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+
+var _Highlight = require("./Highlight.js");
+
+Object.keys(_Highlight).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _Highlight[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _Highlight[key];
+    }
+  });
+});
+
+var _ReverseHighlight = require("./ReverseHighlight.js");
+
+Object.keys(_ReverseHighlight).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _ReverseHighlight[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _ReverseHighlight[key];
+    }
+  });
+});
+
+var _ReverseSnippet = require("./ReverseSnippet.js");
+
+Object.keys(_ReverseSnippet).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _ReverseSnippet[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _ReverseSnippet[key];
+    }
+  });
+});
+
+var _Snippet = require("./Snippet.js");
+
+Object.keys(_Snippet).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _Snippet[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _Snippet[key];
+    }
+  });
+});

package/cjs/lib/version.js

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

package/dist/instantsearch.development.d.ts

@@ -1169,7 +1169,7 @@ declare const EXPERIMENTAL_connectDynamicWidgets: DynamicWidgetsConnector;
 /** @deprecated use dynamicWidgets */
 declare const EXPERIMENTAL_dynamicWidgets: DynamicWidgetsWidget;
 
-declare type GeoHit = Hit & Required<Pick<Hit, '_geoloc'>>;
+declare type GeoHit<THit extends BaseHit = Record<string, any>> = Hit<THit> & Required<Pick<Hit, '_geoloc'>>;
 
 declare type GeoLoc = {
     lat: number;
@@ -1191,9 +1191,9 @@ declare type GeoLoc = {
  */
 declare const geoSearch: GeoSearchWidget;
 
-declare type GeoSearchConnector = Connector<GeoSearchWidgetDescription, GeoSearchConnectorParams>;
+declare type GeoSearchConnector<THit extends BaseHit = Record<string, any>> = Connector<GeoSearchWidgetDescription<THit>, GeoSearchConnectorParams<THit>>;
 
-declare type GeoSearchConnectorParams = {
+declare type GeoSearchConnectorParams<THit extends BaseHit = Record<string, any>> = {
     /**
      * If true, refine will be triggered as you move the map.
      * @default true
@@ -1203,7 +1203,7 @@ declare type GeoSearchConnectorParams = {
      * Function to transform the items passed to the templates.
      * @default items => items
      */
-    transformItems?: TransformItems<GeoHit>;
+    transformItems?: TransformItems<GeoHit<THit>>;
 };
 
 declare type GeoSearchCSSClasses = Partial<{
@@ -1249,7 +1249,7 @@ declare type GeoSearchMarker<TOptions> = {
     };
 };
 
-declare type GeoSearchRenderState = {
+declare type GeoSearchRenderState<THit extends BaseHit = Record<string, any>> = {
     /**
      * Reset the current bounding box refinement.
      */
@@ -1273,7 +1273,7 @@ declare type GeoSearchRenderState = {
     /**
      * The matched hits from Algolia API.
      */
-    items: GeoHit[];
+    items: Array<GeoHit<THit>>;
     /**
      * The current position of the search.
      */
@@ -1313,11 +1313,11 @@ declare type GeoSearchWidget = WidgetFactory<GeoSearchWidgetDescription & {
     $$widgetType: 'ais.geoSearch';
 }, GeoSearchConnectorParams, GeoSearchWidgetParams>;
 
-declare type GeoSearchWidgetDescription = {
+declare type GeoSearchWidgetDescription<THit extends BaseHit = Record<string, any>> = {
     $$type: 'ais.geoSearch';
-    renderState: GeoSearchRenderState;
+    renderState: GeoSearchRenderState<THit>;
     indexRenderState: {
-        geoSearch: WidgetRenderState<GeoSearchRenderState, GeoSearchConnectorParams>;
+        geoSearch: WidgetRenderState<GeoSearchRenderState<THit>, GeoSearchConnectorParams<THit>>;
     };
     indexUiState: {
         geoSearch: {
@@ -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.43.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);
@@ -7918,31 +7975,6 @@
     }
   }
 
-  function convertNumericRefinementsToFilters(state, attribute) {
-    if (!state) {
-      return null;
-    }
-
-    var filtersObj = state.numericRefinements[attribute];
-    /*
-      filtersObj === {
-        "<=": [10],
-        "=": [],
-        ">=": [5]
-      }
-    */
-
-    var filters = [];
-    Object.keys(filtersObj).filter(function (operator) {
-      return Array.isArray(filtersObj[operator]) && filtersObj[operator].length > 0;
-    }).forEach(function (operator) {
-      filtersObj[operator].forEach(function (value) {
-        filters.push("".concat(attribute).concat(operator).concat(value));
-      });
-    });
-    return filters;
-  }
-
   // copied from
   // https://github.com/algolia/autocomplete.js/blob/307a7acc4283e10a19cb7d067f04f1bea79dc56f/packages/autocomplete-core/src/utils/createConcurrentSafePromise.ts#L1:L1
 
@@ -8603,7 +8635,7 @@
     instantSearchInstance.renderState = _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState), {}, _defineProperty({}, parentIndexName, _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState[parentIndexName]), renderState)));
   }
 
-  var version$1 = '4.43.1';
+  var version$1 = '4.45.0';
 
   var NAMESPACE = 'ais';
   var component = function component(componentName) {
@@ -11637,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
@@ -11646,7 +11679,8 @@
               state: state,
               createURL: createURL
             }),
-            hasNoResults: results ? results.nbHits === 0 : true,
+            hasNoResults: !canRefine,
+            canRefine: canRefine,
             widgetParams: widgetParams
           };
         },
@@ -12117,47 +12151,12 @@
   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]);
+      if (arguments.length === 1) {
+        instantSearchInstance.sendEventToInsights(arguments.length <= 0 ? undefined : arguments[0]);
         return;
       }
-
-      var eventType = args[0],
-          facetValue = args[1],
-          _args$ = args[2],
-          eventName = _args$ === void 0 ? 'Filter Applied' : _args$;
-
-      if (eventType !== 'click') {
-        return;
-      } // facetValue === "%7B%22start%22:5,%22end%22:10%7D"
-
-
-      var filters = 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
-        });
-      }
     };
   };
 
@@ -12301,18 +12300,39 @@
 
           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
@@ -12729,50 +12749,12 @@
         return null;
       };
 
-      var sendEventWithRefinedState = function sendEventWithRefinedState(refinedState, instantSearchInstance, helper) {
-        var eventName = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : 'Filter Applied';
-        var filters = convertNumericRefinementsToFilters(refinedState, attribute);
-
-        if (filters && filters.length > 0) {
-          instantSearchInstance.sendEventToInsights({
-            insightsMethod: 'clickedFilters',
-            widgetType: $$type$1,
-            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);
         };
       };
 
@@ -12818,7 +12800,7 @@
         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),
@@ -12828,7 +12810,6 @@
           var refinedState = getRefinedState(helper, currentRange, nextMin, nextMax);
 
           if (refinedState) {
-            sendEventWithRefinedState(refinedState, instantSearchInstance, helper);
             helper.setState(refinedState).search();
           }
         };
@@ -12874,12 +12855,12 @@
             // 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 {
@@ -12887,7 +12868,7 @@
             canRefine: currentRange.min !== currentRange.max,
             format: rangeFormatter,
             range: currentRange,
-            sendEvent: createSendEvent(instantSearchInstance, helper, currentRange),
+            sendEvent: createSendEvent(instantSearchInstance),
             widgetParams: _objectSpread2(_objectSpread2({}, widgetParams), {}, {
               precision: precision
             }),
@@ -13407,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
           };
         },
@@ -13617,6 +13600,9 @@
             });
           }
 
+          var refinementIsApplied = false;
+          var totalCount = 0;
+
           if (results) {
             var facetResults = results.getFacetValues(attribute, {});
             var maxValuesPerFacet = facetResults.length;
@@ -13632,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) {
@@ -13639,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
@@ -13668,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({