instantsearch.js 4.40.0 → 4.40.3

package/CHANGELOG.md

@@ -1,3 +1,30 @@
+## [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)
+
+
+### Bug Fixes
+
+* **types:** update to latest algoliasearch-helper ([6bbe790](https://github.com/algolia/instantsearch.js/commit/6bbe790a99320b4237b81614472c048ffe4426d8))
+
+
+
 # [4.40.0](https://github.com/algolia/instantsearch.js/compare/v4.39.2...v4.40.0) (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/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/lib/version.js

@@ -4,5 +4,5 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _default = '4.40.0';
+var _default = '4.40.3';
 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.
      */

package/dist/instantsearch.development.js

@@ -1,4 +1,4 @@
-/*! InstantSearch.js 4.40.0 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch.js */
+/*! InstantSearch.js 4.40.3 | © 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) :
@@ -2244,12 +2244,40 @@
     );
   };
 
+  /**
+   * Replaces a leading - with \-
+   * @private
+   * @param {string} value the facet value to replace
+   * @returns string
+   */
+  function escapeFacetValue(value) {
+    return value.replace(/^-/, '\\-');
+  }
+
+  /**
+   * Replaces a leading \- with -
+   * @private
+   * @param {string} value the escaped facet value
+   * @returns string
+   */
+  function unescapeFacetValue(value) {
+    return value.replace(/^\\-/, '-');
+  }
+
+  var escapeFacetValue_1 = {
+    escapeFacetValue: escapeFacetValue,
+    unescapeFacetValue: unescapeFacetValue
+  };
+
   var generateHierarchicalTree_1 = generateTrees;
 
 
 
 
 
+  var escapeFacetValue$1 = escapeFacetValue_1.escapeFacetValue;
+  var unescapeFacetValue$1 = escapeFacetValue_1.unescapeFacetValue;
+
   function generateTrees(state) {
     return function generate(hierarchicalFacetResult, hierarchicalFacetIndex) {
       var hierarchicalFacet = state.hierarchicalFacets[hierarchicalFacetIndex];
@@ -2295,6 +2323,7 @@
         count: null, // root level, no count
         isRefined: true, // root level, always refined
         path: null, // root level, no path
+        escapedValue: null,
         exhaustive: rootExhaustive,
         data: null
       });
@@ -2370,7 +2399,7 @@
               facetCount,
               facetValue,
               hierarchicalSeparator,
-              currentRefinement,
+              unescapeFacetValue$1(currentRefinement),
               hierarchicalFacetResult.exhaustive
             );
           }),
@@ -2433,6 +2462,7 @@
     return {
       name: parts[parts.length - 1].trim(),
       path: facetValue,
+      escapedValue: escapeFacetValue$1(facetValue),
       count: facetCount,
       isRefined:
         currentRefinement === facetValue ||
@@ -2442,6 +2472,11 @@
     };
   }
 
+  var escapeFacetValue$2 = escapeFacetValue_1.escapeFacetValue;
+  var unescapeFacetValue$2 = escapeFacetValue_1.unescapeFacetValue;
+
+
+
   /**
    * @typedef SearchResults.Facet
    * @type {object}
@@ -2940,7 +2975,7 @@
             state.disjunctiveFacetsRefinements[dfacet].forEach(function(refinementValue) {
               // add the disjunctive refinements if it is no more retrieved
               if (!self.disjunctiveFacets[position].data[refinementValue] &&
-                state.disjunctiveFacetsRefinements[dfacet].indexOf(refinementValue) > -1) {
+                state.disjunctiveFacetsRefinements[dfacet].indexOf(unescapeFacetValue$2(refinementValue)) > -1) {
                 self.disjunctiveFacets[position].data[refinementValue] = 0;
               }
             });
@@ -3072,10 +3107,12 @@
       if (!facet) return [];
 
       return Object.keys(facet.data).map(function(name) {
+        var value = escapeFacetValue$2(name);
         return {
           name: name,
+          escapedValue: value,
           count: facet.data[name],
-          isRefined: results._state.isFacetRefined(attribute, name),
+          isRefined: results._state.isFacetRefined(attribute, value),
           isExcluded: results._state.isExcludeRefined(attribute, name)
         };
       });
@@ -3084,10 +3121,12 @@
       if (!disjunctiveFacet) return [];
 
       return Object.keys(disjunctiveFacet.data).map(function(name) {
+        var value = escapeFacetValue$2(name);
         return {
           name: name,
+          escapedValue: value,
           count: disjunctiveFacet.data[name],
-          isRefined: results._state.isDisjunctiveFacetRefined(attribute, name)
+          isRefined: results._state.isDisjunctiveFacetRefined(attribute, value)
         };
       });
     } else if (results._state.isHierarchicalFacet(attribute)) {
@@ -4120,7 +4159,9 @@
 
   var requestBuilder_1 = requestBuilder;
 
-  var version = '3.7.3';
+  var version = '3.8.0';
+
+  var escapeFacetValue$3 = escapeFacetValue_1.escapeFacetValue;
 
   /**
    * Event triggered when a parameter is set or updated
@@ -4470,9 +4511,10 @@
       content = Array.isArray(content) ? content[0] : content;
 
       content.facetHits.forEach(function(f) {
+        f.escapedValue = escapeFacetValue$3(f.value);
         f.isRefined = isDisjunctive
-          ? state.isDisjunctiveFacetRefined(facet, f.value)
-          : state.isFacetRefined(facet, f.value);
+          ? state.isDisjunctiveFacetRefined(facet, f.escapedValue)
+          : state.isFacetRefined(facet, f.escapedValue);
       });
 
       return content;
@@ -8488,7 +8530,7 @@
     instantSearchInstance.renderState = _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState), {}, _defineProperty({}, parentIndexName, _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState[parentIndexName]), renderState)));
   }
 
-  var version$1 = '4.40.0';
+  var version$1 = '4.40.3';
 
   var NAMESPACE = 'ais';
   var component = function component(componentName) {
@@ -10922,13 +10964,14 @@
       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 = _objectSpread2(_objectSpread2({}, subValue), {}, {
-            label: label,
             value: value,
+            label: label,
             data: null
           });
 
@@ -11887,8 +11930,9 @@
             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 _objectSpread2(_objectSpread2({}, item), {}, {
                 label: label,
@@ -12851,11 +12895,12 @@
 
       var formatItems = function formatItems(_ref2) {
         var label = _ref2.name,
-            item = _objectWithoutProperties(_ref2, ["name"]);
+            value = _ref2.escapedValue,
+            item = _objectWithoutProperties(_ref2, ["name", "escapedValue"]);
 
         return _objectSpread2(_objectSpread2({}, item), {}, {
+          value: value,
           label: label,
-          value: label,
           highlighted: label
         });
       };
@@ -12913,11 +12958,12 @@
               Math.min(getLimit(), 100), tags).then(function (results) {
                 var facetValues = escapeFacetValues ? 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 _objectSpread2(_objectSpread2({}, item), {}, {
-                    value: value,
+                    value: escapedValue,
                     label: value
                   });
                 }), {
@@ -14057,7 +14103,7 @@
       if (currentItem.isRefined) {
         result.push({
           label: currentItem.name,
-          value: currentItem.path
+          value: currentItem.escapedValue
         });
 
         if (Array.isArray(currentItem.data)) {