instantsearch.js 4.40.1 → 4.40.4

package/CHANGELOG.md

@@ -1,3 +1,30 @@
+## [4.40.4](https://github.com/algolia/instantsearch.js/compare/v4.40.3...v4.40.4) (2022-04-13)
+
+
+### Bug Fixes
+
+* **currentRefinements:** correctly show and allow for refining escaped values ([#5041](https://github.com/algolia/instantsearch.js/issues/5041)) ([277f4df](https://github.com/algolia/instantsearch.js/commit/277f4dff21fb7eeaeb41a8c49aaaf707f880ee58))
+
+
+
+## [4.40.3](https://github.com/algolia/instantsearch.js/compare/v4.40.2...v4.40.3) (2022-04-04)
+
+
+### Bug Fixes
+
+* **refinements:** escape facet values starting with "-" ([#5039](https://github.com/algolia/instantsearch.js/issues/5039)) ([6b6f4e8](https://github.com/algolia/instantsearch.js/commit/6b6f4e86550a3c9dd02f3a8400d832cef64cb45d))
+
+
+
+## [4.40.2](https://github.com/algolia/instantsearch.js/compare/v4.40.1...v4.40.2) (2022-03-29)
+
+
+### Bug Fixes
+
+* **currentRefinements:** more detailed type for item.type ([#5034](https://github.com/algolia/instantsearch.js/issues/5034)) ([773e2c6](https://github.com/algolia/instantsearch.js/commit/773e2c65840f86881eb3dd8825c8c4ad9c73aec9))
+
+
+
 ## [4.40.1](https://github.com/algolia/instantsearch.js/compare/v4.40.0...v4.40.1) (2022-03-21)
 
 

package/cjs/connectors/breadcrumb/connectBreadcrumb.js

@@ -157,7 +157,7 @@ function prepareItems(data) {
     if (currentItem.isRefined) {
       result.push({
         label: currentItem.name,
-        value: currentItem.path
+        value: currentItem.escapedValue
       });
 
       if (Array.isArray(currentItem.data)) {

package/cjs/connectors/current-refinements/connectCurrentRefinements.js

@@ -195,7 +195,7 @@ function getOperatorSymbol(operator) {
 }
 
 function normalizeRefinement(refinement) {
-  var value = refinement.type === 'numeric' ? Number(refinement.name) : refinement.name;
+  var value = getValue(refinement);
   var label = refinement.operator ? "".concat(getOperatorSymbol(refinement.operator), " ").concat(refinement.name) : refinement.name;
   var normalizedRefinement = {
     attribute: refinement.attribute,
@@ -219,5 +219,17 @@ function normalizeRefinement(refinement) {
   return normalizedRefinement;
 }
 
+function getValue(refinement) {
+  if (refinement.type === 'numeric') {
+    return Number(refinement.name);
+  }
+
+  if ('escapedValue' in refinement) {
+    return refinement.escapedValue;
+  }
+
+  return refinement.name;
+}
+
 var _default = connectCurrentRefinements;
 exports.default = _default;

package/cjs/connectors/hierarchical-menu/connectHierarchicalMenu.js

@@ -114,13 +114,14 @@ var connectHierarchicalMenu = function connectHierarchicalMenu(renderFn) {
     function _prepareFacetValues(facetValues) {
       return facetValues.slice(0, getLimit()).map(function (_ref2) {
         var label = _ref2.name,
-            value = _ref2.path,
+            value = _ref2.escapedValue,
             data = _ref2.data,
-            subValue = _objectWithoutProperties(_ref2, ["name", "path", "data"]);
+            path = _ref2.path,
+            subValue = _objectWithoutProperties(_ref2, ["name", "escapedValue", "data", "path"]);
 
         var item = _objectSpread(_objectSpread({}, subValue), {}, {
-          label: label,
           value: value,
+          label: label,
           data: null
         });
 

package/cjs/connectors/menu/connectMenu.js

@@ -169,8 +169,9 @@ var connectMenu = function connectMenu(renderFn) {
           canToggleShowMore = showMore && (isShowingMore || facetItems.length > getLimit());
           items = transformItems(facetItems.slice(0, getLimit()).map(function (_ref3) {
             var label = _ref3.name,
-                value = _ref3.path,
-                item = _objectWithoutProperties(_ref3, ["name", "path"]);
+                value = _ref3.escapedValue,
+                path = _ref3.path,
+                item = _objectWithoutProperties(_ref3, ["name", "escapedValue", "path"]);
 
             return _objectSpread(_objectSpread({}, item), {}, {
               label: label,

package/cjs/connectors/refinement-list/connectRefinementList.js

@@ -72,11 +72,12 @@ var connectRefinementList = function connectRefinementList(renderFn) {
 
     var formatItems = function formatItems(_ref2) {
       var label = _ref2.name,
-          item = _objectWithoutProperties(_ref2, ["name"]);
+          value = _ref2.escapedValue,
+          item = _objectWithoutProperties(_ref2, ["name", "escapedValue"]);
 
       return _objectSpread(_objectSpread({}, item), {}, {
+        value: value,
         label: label,
-        value: label,
         highlighted: label
       });
     };
@@ -134,11 +135,12 @@ var connectRefinementList = function connectRefinementList(renderFn) {
             Math.min(getLimit(), 100), tags).then(function (results) {
               var facetValues = escapeFacetValues ? (0, _index.escapeFacets)(results.facetHits) : results.facetHits;
               var normalizedFacetValues = transformItems(facetValues.map(function (_ref3) {
-                var value = _ref3.value,
-                    item = _objectWithoutProperties(_ref3, ["value"]);
+                var escapedValue = _ref3.escapedValue,
+                    value = _ref3.value,
+                    item = _objectWithoutProperties(_ref3, ["escapedValue", "value"]);
 
                 return _objectSpread(_objectSpread({}, item), {}, {
-                  value: value,
+                  value: escapedValue,
                   label: value
                 });
               }), {

package/cjs/connectors/toggle-refinement/connectToggleRefinement.js

@@ -89,8 +89,8 @@ var connectToggleRefinement = function connectToggleRefinement(renderFn) {
     }
 
     var hasAnOffValue = userOff !== undefined;
-    var on = (0, _index.toArray)(userOn).map(_index.escapeRefinement);
-    var off = hasAnOffValue ? (0, _index.toArray)(userOff).map(_index.escapeRefinement) : undefined;
+    var on = (0, _index.toArray)(userOn).map(_index.escapeFacetValue);
+    var off = hasAnOffValue ? (0, _index.toArray)(userOff).map(_index.escapeFacetValue) : undefined;
     var sendEvent;
 
     var toggleRefinementFactory = function toggleRefinementFactory(helper) {
@@ -203,16 +203,16 @@ var connectToggleRefinement = function connectToggleRefinement(renderFn) {
           var allFacetValues = results.getFacetValues(attribute, {}) || [];
           var onData = on.map(function (v) {
             return (0, _index.find)(allFacetValues, function (_ref7) {
-              var name = _ref7.name;
-              return name === (0, _index.unescapeRefinement)(v);
+              var escapedValue = _ref7.escapedValue;
+              return escapedValue === (0, _index.escapeFacetValue)(String(v));
             });
           }).filter(function (v) {
             return v !== undefined;
           });
           var offData = hasAnOffValue ? offValue.map(function (v) {
             return (0, _index.find)(allFacetValues, function (_ref8) {
-              var name = _ref8.name;
-              return name === (0, _index.unescapeRefinement)(v);
+              var escapedValue = _ref8.escapedValue;
+              return escapedValue === (0, _index.escapeFacetValue)(String(v));
             });
           }).filter(function (v) {
             return v !== undefined;

package/cjs/lib/utils/escapeFacetValue.js

@@ -0,0 +1,23 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.unescapeFacetValue = unescapeFacetValue;
+exports.escapeFacetValue = escapeFacetValue;
+
+function unescapeFacetValue(value) {
+  if (typeof value === 'string') {
+    return value.replace(/^\\-/, '-');
+  }
+
+  return value;
+}
+
+function escapeFacetValue(value) {
+  if (typeof value === 'number' && value < 0 || typeof value === 'string') {
+    return String(value).replace(/^-/, '\\-');
+  }
+
+  return value;
+}

package/cjs/lib/utils/getRefinements.js

@@ -3,11 +3,11 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = void 0;
+exports.default = getRefinements;
 
 var _find = _interopRequireDefault(require("./find.js"));
 
-var _unescapeRefinement = _interopRequireDefault(require("./unescapeRefinement.js"));
+var _escapeFacetValue = require("./escapeFacetValue.js");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
@@ -16,7 +16,8 @@ function getRefinement(state, type, attribute, name) {
   var res = {
     type: type,
     attribute: attribute,
-    name: name
+    name: name,
+    escapedValue: (0, _escapeFacetValue.escapeFacetValue)(name)
   };
   var facet = (0, _find.default)(resultsFacets, function (resultsFacet) {
     return resultsFacet.name === attribute;
@@ -50,14 +51,12 @@ function getRefinement(state, type, attribute, name) {
     count = facet && facet.data && facet.data[res.name];
   }
 
-  var exhaustive = facet && facet.exhaustive;
-
   if (count !== undefined) {
     res.count = count;
   }
 
-  if (exhaustive !== undefined) {
-    res.exhaustive = exhaustive;
+  if (facet && facet.exhaustive !== undefined) {
+    res.exhaustive = facet.exhaustive;
   }
 
   return res;
@@ -98,9 +97,9 @@ function getRefinements(results, state) {
   Object.keys(disjunctiveFacetsRefinements).forEach(function (attribute) {
     var refinementNames = disjunctiveFacetsRefinements[attribute];
     refinementNames.forEach(function (refinementName) {
-      refinements.push(getRefinement(state, 'disjunctive', attribute, // We unescape any disjunctive refined values with `unescapeRefinement` because
-      // they can be escaped on negative numeric values with `escapeRefinement`.
-      (0, _unescapeRefinement.default)(refinementName), results.disjunctiveFacets));
+      refinements.push(getRefinement(state, 'disjunctive', attribute, // We unescape any disjunctive refined values with `unescapeFacetValue` because
+      // they can be escaped on negative numeric values with `escapeFacetValue`.
+      (0, _escapeFacetValue.unescapeFacetValue)(refinementName), results.disjunctiveFacets));
     });
   });
   Object.keys(hierarchicalFacetsRefinements).forEach(function (attribute) {
@@ -144,7 +143,4 @@ function getRefinements(results, state) {
   }
 
   return refinements;
-}
-
-var _default = getRefinements;
-exports.default = _default;
+}

package/cjs/lib/utils/index.js

@@ -13,8 +13,8 @@ var _exportNames = {
   renderTemplate: true,
   getRefinements: true,
   clearRefinements: true,
-  escapeRefinement: true,
-  unescapeRefinement: true,
+  escapeFacetValue: true,
+  unescapeFacetValue: true,
   checkRendering: true,
   checkIndexUiState: true,
   getPropertyByPath: true,
@@ -112,16 +112,16 @@ Object.defineProperty(exports, "clearRefinements", {
     return _clearRefinements.default;
   }
 });
-Object.defineProperty(exports, "escapeRefinement", {
+Object.defineProperty(exports, "escapeFacetValue", {
   enumerable: true,
   get: function get() {
-    return _escapeRefinement.default;
+    return _escapeFacetValue.escapeFacetValue;
   }
 });
-Object.defineProperty(exports, "unescapeRefinement", {
+Object.defineProperty(exports, "unescapeFacetValue", {
   enumerable: true,
   get: function get() {
-    return _unescapeRefinement.default;
+    return _escapeFacetValue.unescapeFacetValue;
   }
 });
 Object.defineProperty(exports, "checkRendering", {
@@ -395,9 +395,7 @@ var _getRefinements = _interopRequireDefault(require("./getRefinements.js"));
 
 var _clearRefinements = _interopRequireDefault(require("./clearRefinements.js"));
 
-var _escapeRefinement = _interopRequireDefault(require("./escapeRefinement.js"));
-
-var _unescapeRefinement = _interopRequireDefault(require("./unescapeRefinement.js"));
+var _escapeFacetValue = require("./escapeFacetValue.js");
 
 var _checkRendering = _interopRequireDefault(require("./checkRendering.js"));
 

package/cjs/lib/version.js

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

package/dist/instantsearch.development.d.ts

@@ -970,10 +970,8 @@ declare type CurrentRefinementsConnectorParamsRefinement = {
     attribute: string;
     /**
      * The type of the refinement.
-     *
-     * It can be one of those: 'facet'|'exclude'|'disjunctive'|'hierarchical'|'numeric'|'query'|'tag'.
      */
-    type: string;
+    type: 'facet' | 'exclude' | 'disjunctive' | 'hierarchical' | 'numeric' | 'query' | 'tag';
     /**
      * The raw value of the refinement.
      */