instantsearch.js 4.40.3 → 4.40.4

package/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [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)
 
 

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/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.3';
+var _default = '4.40.4';
 exports.default = _default;

package/dist/instantsearch.development.js

@@ -1,4 +1,4 @@
-/*! InstantSearch.js 4.40.3 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch.js */
+/*! InstantSearch.js 4.40.4 | © 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) :
@@ -2247,20 +2247,24 @@
   /**
    * Replaces a leading - with \-
    * @private
-   * @param {string} value the facet value to replace
-   * @returns string
+   * @param {any} value the facet value to replace
+   * @returns any
    */
   function escapeFacetValue(value) {
-    return value.replace(/^-/, '\\-');
+    if (typeof value !== 'string') return value;
+
+    return String(value).replace(/^-/, '\\-');
   }
 
   /**
    * Replaces a leading \- with -
    * @private
-   * @param {string} value the escaped facet value
-   * @returns string
+   * @param {any} value the escaped facet value
+   * @returns any
    */
   function unescapeFacetValue(value) {
+    if (typeof value !== 'string') return value;
+
     return value.replace(/^\\-/, '-');
   }
 
@@ -4159,7 +4163,7 @@
 
   var requestBuilder_1 = requestBuilder;
 
-  var version = '3.8.0';
+  var version = '3.8.2';
 
   var escapeFacetValue$3 = escapeFacetValue_1.escapeFacetValue;
 
@@ -6654,8 +6658,19 @@
     return undefined;
   }
 
-  function unescapeRefinement(value) {
-    return String(value).replace(/^\\-/, '-');
+  function unescapeFacetValue$3(value) {
+    if (typeof value === 'string') {
+      return value.replace(/^\\-/, '-');
+    }
+
+    return value;
+  }
+  function escapeFacetValue$4(value) {
+    if (typeof value === 'number' && value < 0 || typeof value === 'string') {
+      return String(value).replace(/^-/, '\\-');
+    }
+
+    return value;
   }
 
   function getRefinement$1(state, type, attribute, name) {
@@ -6663,7 +6678,8 @@
     var res = {
       type: type,
       attribute: attribute,
-      name: name
+      name: name,
+      escapedValue: escapeFacetValue$4(name)
     };
     var facet = find$1(resultsFacets, function (resultsFacet) {
       return resultsFacet.name === attribute;
@@ -6697,14 +6713,12 @@
       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;
@@ -6745,9 +6759,9 @@
     Object.keys(disjunctiveFacetsRefinements).forEach(function (attribute) {
       var refinementNames = disjunctiveFacetsRefinements[attribute];
       refinementNames.forEach(function (refinementName) {
-        refinements.push(getRefinement$1(state, 'disjunctive', attribute, // We unescape any disjunctive refined values with `unescapeRefinement` because
-        // they can be escaped on negative numeric values with `escapeRefinement`.
-        unescapeRefinement(refinementName), results.disjunctiveFacets));
+        refinements.push(getRefinement$1(state, 'disjunctive', attribute, // We unescape any disjunctive refined values with `unescapeFacetValue` because
+        // they can be escaped on negative numeric values with `escapeFacetValue`.
+        unescapeFacetValue$3(refinementName), results.disjunctiveFacets));
       });
     });
     Object.keys(hierarchicalFacetsRefinements).forEach(function (attribute) {
@@ -6834,14 +6848,6 @@
     return finalState;
   }
 
-  function escapeRefinement(value) {
-    if (typeof value === 'number' && value < 0) {
-      value = String(value).replace(/^-/, '\\-');
-    }
-
-    return value;
-  }
-
   function getObjectType(object) {
     return Object.prototype.toString.call(object).slice(8, -1);
   }
@@ -8530,7 +8536,7 @@
     instantSearchInstance.renderState = _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState), {}, _defineProperty({}, parentIndexName, _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState[parentIndexName]), renderState)));
   }
 
-  var version$1 = '4.40.3';
+  var version$1 = '4.40.4';
 
   var NAMESPACE = 'ais';
   var component = function component(componentName) {
@@ -10855,7 +10861,7 @@
   }
 
   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,
@@ -10879,6 +10885,18 @@
     return normalizedRefinement;
   }
 
+  function getValue(refinement) {
+    if (refinement.type === 'numeric') {
+      return Number(refinement.name);
+    }
+
+    if ('escapedValue' in refinement) {
+      return refinement.escapedValue;
+    }
+
+    return refinement.name;
+  }
+
   var withUsage$4 = createDocumentationMessageGenerator({
     name: 'hierarchical-menu',
     connector: true
@@ -13745,8 +13763,8 @@
       }
 
       var hasAnOffValue = userOff !== undefined;
-      var on = toArray(userOn).map(escapeRefinement);
-      var off = hasAnOffValue ? toArray(userOff).map(escapeRefinement) : undefined;
+      var on = toArray(userOn).map(escapeFacetValue$4);
+      var off = hasAnOffValue ? toArray(userOff).map(escapeFacetValue$4) : undefined;
       var sendEvent;
 
       var toggleRefinementFactory = function toggleRefinementFactory(helper) {
@@ -13859,16 +13877,16 @@
             var allFacetValues = results.getFacetValues(attribute, {}) || [];
             var onData = on.map(function (v) {
               return find$1(allFacetValues, function (_ref7) {
-                var name = _ref7.name;
-                return name === unescapeRefinement(v);
+                var escapedValue = _ref7.escapedValue;
+                return escapedValue === escapeFacetValue$4(String(v));
               });
             }).filter(function (v) {
               return v !== undefined;
             });
             var offData = hasAnOffValue ? offValue.map(function (v) {
               return find$1(allFacetValues, function (_ref8) {
-                var name = _ref8.name;
-                return name === unescapeRefinement(v);
+                var escapedValue = _ref8.escapedValue;
+                return escapedValue === escapeFacetValue$4(String(v));
               });
             }).filter(function (v) {
               return v !== undefined;
@@ -19452,7 +19470,7 @@
     return (value - min) / (max - min) * 100;
   }
 
-  function getValue(pos, min, max) {
+  function getValue$1(pos, min, max) {
     var decimal = pos / 100;
 
     if (pos === 0) {
@@ -19663,7 +19681,7 @@
         var _ref = this.props,
             max = _ref.max,
             min = _ref.min;
-        var value = getValue(positionPercent, min, max);
+        var value = getValue$1(positionPercent, min, max);
         var snapValue = this.getClosestSnapPoint(value);
         return getPosition(snapValue, min, max);
       }
@@ -19757,7 +19775,7 @@
         return {
           handlePos: nextHandlePos,
           values: nextHandlePos.map(function (pos) {
-            return getValue(pos, min, max);
+            return getValue$1(pos, min, max);
           })
         };
       }