react-instantsearch-core 6.22.0 → 6.23.2

package/dist/cjs/connectors/connectBreadcrumb.js

@@ -34,9 +34,9 @@ function transformValue(values) {
     if (item.isRefined) {
       acc.push({
         label: item.name,
-        // If dealing with a nested "items", "value" is equal to the previous value concatenated with the current label
-        // If dealing with the first level, "value" is equal to the current label
-        value: item.path
+        // If dealing with a nested "items", "value" is equal to the previous value concatenated with the current value
+        // If dealing with the first level, "value" is equal to the current value
+        value: item.escapedValue
       }); // Create a variable in order to keep the same acc for the recursion, otherwise "reduce" returns a new one
 
       if (item.data) {

package/dist/cjs/connectors/connectHierarchicalMenu.js

@@ -38,7 +38,7 @@ function getCurrentRefinement(props, searchState, context) {
   return currentRefinement;
 }
 
-function getValue(path, props, searchState, context) {
+function getValue(value, props, searchState, context) {
   var id = props.id,
       attributes = props.attributes,
       separator = props.separator,
@@ -48,7 +48,7 @@ function getValue(path, props, searchState, context) {
   var nextRefinement;
 
   if (currentRefinement === null) {
-    nextRefinement = path;
+    nextRefinement = value;
   } else {
     var tmpSearchParameters = new _algoliasearchHelper.default.SearchParameters({
       hierarchicalFacets: [{
@@ -59,7 +59,7 @@ function getValue(path, props, searchState, context) {
         showParentLevel: showParentLevel
       }]
     });
-    nextRefinement = tmpSearchParameters.toggleHierarchicalFacetRefinement(id, currentRefinement).toggleHierarchicalFacetRefinement(id, path).getHierarchicalRefinement(id)[0];
+    nextRefinement = tmpSearchParameters.toggleHierarchicalFacetRefinement(id, currentRefinement).toggleHierarchicalFacetRefinement(id, value).getHierarchicalRefinement(id)[0];
   }
 
   return nextRefinement;
@@ -69,7 +69,7 @@ function transformValue(value, props, searchState, context) {
   return value.map(function (v) {
     return {
       label: v.name,
-      value: getValue(v.path, props, searchState, context),
+      value: getValue(v.escapedValue, props, searchState, context),
       count: v.count,
       isRefined: v.isRefined,
       items: v.data && transformValue(v.data, props, searchState, context)
@@ -107,7 +107,7 @@ var sortBy = ['name:asc'];
  * websites. From a UX point of view, we suggest not displaying more than two levels deep.
  * @name connectHierarchicalMenu
  * @requirements To use this widget, your attributes must be formatted in a specific way.
- * If you want for example to have a hiearchical menu of categories, objects in your index
+ * If you want for example to have a hierarchical menu of categories, objects in your index
  * should be formatted this way:
  *
  * ```json

package/dist/cjs/connectors/connectMenu.js

@@ -31,9 +31,9 @@ function getCurrentRefinement(props, searchState, context) {
   return currentRefinement;
 }
 
-function getValue(name, props, searchState, context) {
+function getValue(value, props, searchState, context) {
   var currentRefinement = getCurrentRefinement(props, searchState, context);
-  return name === currentRefinement ? '' : name;
+  return value === currentRefinement ? '' : value;
 }
 
 function getLimit(_ref) {
@@ -129,7 +129,7 @@ var _default = (0, _createConnector.default)({
       items = searchForFacetValuesResults[attribute].map(function (v) {
         return {
           label: v.value,
-          value: getValue(v.value, props, searchState, {
+          value: getValue(v.escapedValue, props, searchState, {
             ais: props.contextValue,
             multiIndexContext: props.indexContextValue
           }),
@@ -149,7 +149,7 @@ var _default = (0, _createConnector.default)({
       }).map(function (v) {
         return {
           label: v.name,
-          value: getValue(v.name, props, searchState, {
+          value: getValue(v.escapedValue, props, searchState, {
             ais: props.contextValue,
             multiIndexContext: props.indexContextValue
           }),

package/dist/cjs/connectors/connectRefinementList.js

@@ -35,12 +35,12 @@ function getCurrentRefinement(props, searchState, context) {
   return [];
 }
 
-function getValue(name, props, searchState, context) {
+function getValue(value, props, searchState, context) {
   var currentRefinement = getCurrentRefinement(props, searchState, context);
-  var isAnewValue = currentRefinement.indexOf(name) === -1;
-  var nextRefinement = isAnewValue ? currentRefinement.concat([name]) // cannot use .push(), it mutates
+  var isAnewValue = currentRefinement.indexOf(value) === -1;
+  var nextRefinement = isAnewValue ? currentRefinement.concat([value]) // cannot use .push(), it mutates
   : currentRefinement.filter(function (selectedValue) {
-    return selectedValue !== name;
+    return selectedValue !== value;
   }); // cannot use .splice(), it mutates
 
   return nextRefinement;
@@ -150,7 +150,7 @@ var _default = (0, _createConnector.default)({
     var items = isFromSearch ? searchForFacetValuesResults[attribute].map(function (v) {
       return {
         label: v.value,
-        value: getValue(v.value, props, searchState, {
+        value: getValue(v.escapedValue, props, searchState, {
           ais: props.contextValue,
           multiIndexContext: props.indexContextValue
         }),
@@ -168,7 +168,7 @@ var _default = (0, _createConnector.default)({
     }).map(function (v) {
       return {
         label: v.name,
-        value: getValue(v.name, props, searchState, {
+        value: getValue(v.escapedValue, props, searchState, {
           ais: props.contextValue,
           multiIndexContext: props.indexContextValue
         }),

package/dist/cjs/core/version.js

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

package/dist/es/connectors/connectBreadcrumb.js

@@ -21,9 +21,9 @@ function transformValue(values) {
     if (item.isRefined) {
       acc.push({
         label: item.name,
-        // If dealing with a nested "items", "value" is equal to the previous value concatenated with the current label
-        // If dealing with the first level, "value" is equal to the current label
-        value: item.path
+        // If dealing with a nested "items", "value" is equal to the previous value concatenated with the current value
+        // If dealing with the first level, "value" is equal to the current value
+        value: item.escapedValue
       }); // Create a variable in order to keep the same acc for the recursion, otherwise "reduce" returns a new one
 
       if (item.data) {

package/dist/es/connectors/connectHierarchicalMenu.js

@@ -23,7 +23,7 @@ function getCurrentRefinement(props, searchState, context) {
   return currentRefinement;
 }
 
-function getValue(path, props, searchState, context) {
+function getValue(value, props, searchState, context) {
   var id = props.id,
       attributes = props.attributes,
       separator = props.separator,
@@ -33,7 +33,7 @@ function getValue(path, props, searchState, context) {
   var nextRefinement;
 
   if (currentRefinement === null) {
-    nextRefinement = path;
+    nextRefinement = value;
   } else {
     var tmpSearchParameters = new algoliasearchHelper.SearchParameters({
       hierarchicalFacets: [{
@@ -44,7 +44,7 @@ function getValue(path, props, searchState, context) {
         showParentLevel: showParentLevel
       }]
     });
-    nextRefinement = tmpSearchParameters.toggleHierarchicalFacetRefinement(id, currentRefinement).toggleHierarchicalFacetRefinement(id, path).getHierarchicalRefinement(id)[0];
+    nextRefinement = tmpSearchParameters.toggleHierarchicalFacetRefinement(id, currentRefinement).toggleHierarchicalFacetRefinement(id, value).getHierarchicalRefinement(id)[0];
   }
 
   return nextRefinement;
@@ -54,7 +54,7 @@ function transformValue(value, props, searchState, context) {
   return value.map(function (v) {
     return {
       label: v.name,
-      value: getValue(v.path, props, searchState, context),
+      value: getValue(v.escapedValue, props, searchState, context),
       count: v.count,
       isRefined: v.isRefined,
       items: v.data && transformValue(v.data, props, searchState, context)
@@ -94,7 +94,7 @@ var sortBy = ['name:asc'];
  * websites. From a UX point of view, we suggest not displaying more than two levels deep.
  * @name connectHierarchicalMenu
  * @requirements To use this widget, your attributes must be formatted in a specific way.
- * If you want for example to have a hiearchical menu of categories, objects in your index
+ * If you want for example to have a hierarchical menu of categories, objects in your index
  * should be formatted this way:
  *
  * ```json

package/dist/es/connectors/connectMenu.js

@@ -18,9 +18,9 @@ function getCurrentRefinement(props, searchState, context) {
   return currentRefinement;
 }
 
-function getValue(name, props, searchState, context) {
+function getValue(value, props, searchState, context) {
   var currentRefinement = getCurrentRefinement(props, searchState, context);
-  return name === currentRefinement ? '' : name;
+  return value === currentRefinement ? '' : value;
 }
 
 function getLimit(_ref) {
@@ -118,7 +118,7 @@ export default createConnector({
       items = searchForFacetValuesResults[attribute].map(function (v) {
         return {
           label: v.value,
-          value: getValue(v.value, props, searchState, {
+          value: getValue(v.escapedValue, props, searchState, {
             ais: props.contextValue,
             multiIndexContext: props.indexContextValue
           }),
@@ -138,7 +138,7 @@ export default createConnector({
       }).map(function (v) {
         return {
           label: v.name,
-          value: getValue(v.name, props, searchState, {
+          value: getValue(v.escapedValue, props, searchState, {
             ais: props.contextValue,
             multiIndexContext: props.indexContextValue
           }),

package/dist/es/connectors/connectRefinementList.js

@@ -22,12 +22,12 @@ function getCurrentRefinement(props, searchState, context) {
   return [];
 }
 
-function getValue(name, props, searchState, context) {
+function getValue(value, props, searchState, context) {
   var currentRefinement = getCurrentRefinement(props, searchState, context);
-  var isAnewValue = currentRefinement.indexOf(name) === -1;
-  var nextRefinement = isAnewValue ? currentRefinement.concat([name]) // cannot use .push(), it mutates
+  var isAnewValue = currentRefinement.indexOf(value) === -1;
+  var nextRefinement = isAnewValue ? currentRefinement.concat([value]) // cannot use .push(), it mutates
   : currentRefinement.filter(function (selectedValue) {
-    return selectedValue !== name;
+    return selectedValue !== value;
   }); // cannot use .splice(), it mutates
 
   return nextRefinement;
@@ -137,7 +137,7 @@ export default createConnector({
     var items = isFromSearch ? searchForFacetValuesResults[attribute].map(function (v) {
       return {
         label: v.value,
-        value: getValue(v.value, props, searchState, {
+        value: getValue(v.escapedValue, props, searchState, {
           ais: props.contextValue,
           multiIndexContext: props.indexContextValue
         }),
@@ -155,7 +155,7 @@ export default createConnector({
     }).map(function (v) {
       return {
         label: v.name,
-        value: getValue(v.name, props, searchState, {
+        value: getValue(v.escapedValue, props, searchState, {
           ais: props.contextValue,
           multiIndexContext: props.indexContextValue
         }),

package/dist/es/core/version.js

@@ -1 +1 @@
-export default '6.22.0';
+export default '6.23.2';

package/dist/umd/ReactInstantSearchCore.js

@@ -1,4 +1,4 @@
-/*! React InstantSearchCore 6.22.0 | © Algolia, inc. | https://github.com/algolia/react-instantsearch */
+/*! React InstantSearchCore 6.23.2 | © Algolia, inc. | https://github.com/algolia/react-instantsearch */
 (function (global, factory) {
   typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('react')) :
   typeof define === 'function' && define.amd ? define(['exports', 'react'], factory) :
@@ -839,7 +839,7 @@
     });
   }
 
-  var version = '6.22.0';
+  var version = '6.23.2';
 
   function _createSuper$1(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct$1(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }
 
@@ -3227,12 +3227,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];
@@ -3278,6 +3306,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
       });
@@ -3353,7 +3382,7 @@
               facetCount,
               facetValue,
               hierarchicalSeparator,
-              currentRefinement,
+              unescapeFacetValue$1(currentRefinement),
               hierarchicalFacetResult.exhaustive
             );
           }),
@@ -3416,6 +3445,7 @@
     return {
       name: parts[parts.length - 1].trim(),
       path: facetValue,
+      escapedValue: escapeFacetValue$1(facetValue),
       count: facetCount,
       isRefined:
         currentRefinement === facetValue ||
@@ -3425,6 +3455,11 @@
     };
   }
 
+  var escapeFacetValue$2 = escapeFacetValue_1.escapeFacetValue;
+  var unescapeFacetValue$2 = escapeFacetValue_1.unescapeFacetValue;
+
+
+
   /**
    * @typedef SearchResults.Facet
    * @type {object}
@@ -3639,7 +3674,7 @@
   }
    **/
   /*eslint-enable */
-  function SearchResults(state, results) {
+  function SearchResults(state, results, options) {
     var mainSubResponse = results[0];
 
     this._rawResults = results;
@@ -3651,6 +3686,11 @@
       self[key] = mainSubResponse[key];
     });
 
+    // Make every key of the result options reachable from the instance
+    Object.keys(options || {}).forEach(function(key) {
+      self[key] = options[key];
+    });
+
     /**
      * query used to generate the results
      * @name query
@@ -3918,7 +3958,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;
               }
             });
@@ -4050,10 +4090,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)
         };
       });
@@ -4062,10 +4104,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)) {
@@ -5098,7 +5142,9 @@
 
   var requestBuilder_1 = requestBuilder;
 
-  var version$1 = '3.7.0';
+  var version$1 = '3.8.0';
+
+  var escapeFacetValue$3 = escapeFacetValue_1.escapeFacetValue;
 
   /**
    * Event triggered when a parameter is set or updated
@@ -5448,9 +5494,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;
@@ -8292,9 +8339,9 @@
       if (item.isRefined) {
         acc.push({
           label: item.name,
-          // If dealing with a nested "items", "value" is equal to the previous value concatenated with the current label
-          // If dealing with the first level, "value" is equal to the current label
-          value: item.path
+          // If dealing with a nested "items", "value" is equal to the previous value concatenated with the current value
+          // If dealing with the first level, "value" is equal to the current value
+          value: item.escapedValue
         }); // Create a variable in order to keep the same acc for the recursion, otherwise "reduce" returns a new one
 
         if (item.data) {
@@ -8657,7 +8704,7 @@
     return currentRefinement;
   }
 
-  function getValue(path, props, searchState, context) {
+  function getValue(value, props, searchState, context) {
     var id = props.id,
         attributes = props.attributes,
         separator = props.separator,
@@ -8667,7 +8714,7 @@
     var nextRefinement;
 
     if (currentRefinement === null) {
-      nextRefinement = path;
+      nextRefinement = value;
     } else {
       var tmpSearchParameters = new algoliasearchHelper_1.SearchParameters({
         hierarchicalFacets: [{
@@ -8678,7 +8725,7 @@
           showParentLevel: showParentLevel
         }]
       });
-      nextRefinement = tmpSearchParameters.toggleHierarchicalFacetRefinement(id, currentRefinement).toggleHierarchicalFacetRefinement(id, path).getHierarchicalRefinement(id)[0];
+      nextRefinement = tmpSearchParameters.toggleHierarchicalFacetRefinement(id, currentRefinement).toggleHierarchicalFacetRefinement(id, value).getHierarchicalRefinement(id)[0];
     }
 
     return nextRefinement;
@@ -8688,7 +8735,7 @@
     return value.map(function (v) {
       return {
         label: v.name,
-        value: getValue(v.path, props, searchState, context),
+        value: getValue(v.escapedValue, props, searchState, context),
         count: v.count,
         isRefined: v.isRefined,
         items: v.data && transformValue$1(v.data, props, searchState, context)
@@ -8728,7 +8775,7 @@
    * websites. From a UX point of view, we suggest not displaying more than two levels deep.
    * @name connectHierarchicalMenu
    * @requirements To use this widget, your attributes must be formatted in a specific way.
-   * If you want for example to have a hiearchical menu of categories, objects in your index
+   * If you want for example to have a hierarchical menu of categories, objects in your index
    * should be formatted this way:
    *
    * ```json
@@ -9328,9 +9375,9 @@
     return currentRefinement;
   }
 
-  function getValue$1(name, props, searchState, context) {
+  function getValue$1(value, props, searchState, context) {
     var currentRefinement = getCurrentRefinement$5(props, searchState, context);
-    return name === currentRefinement ? '' : name;
+    return value === currentRefinement ? '' : value;
   }
 
   function getLimit(_ref) {
@@ -9428,7 +9475,7 @@
         items = searchForFacetValuesResults[attribute].map(function (v) {
           return {
             label: v.value,
-            value: getValue$1(v.value, props, searchState, {
+            value: getValue$1(v.escapedValue, props, searchState, {
               ais: props.contextValue,
               multiIndexContext: props.indexContextValue
             }),
@@ -9448,7 +9495,7 @@
         }).map(function (v) {
           return {
             label: v.name,
-            value: getValue$1(v.name, props, searchState, {
+            value: getValue$1(v.escapedValue, props, searchState, {
               ais: props.contextValue,
               multiIndexContext: props.indexContextValue
             }),
@@ -10228,12 +10275,12 @@
     return [];
   }
 
-  function getValue$2(name, props, searchState, context) {
+  function getValue$2(value, props, searchState, context) {
     var currentRefinement = getCurrentRefinement$9(props, searchState, context);
-    var isAnewValue = currentRefinement.indexOf(name) === -1;
-    var nextRefinement = isAnewValue ? currentRefinement.concat([name]) // cannot use .push(), it mutates
+    var isAnewValue = currentRefinement.indexOf(value) === -1;
+    var nextRefinement = isAnewValue ? currentRefinement.concat([value]) // cannot use .push(), it mutates
     : currentRefinement.filter(function (selectedValue) {
-      return selectedValue !== name;
+      return selectedValue !== value;
     }); // cannot use .splice(), it mutates
 
     return nextRefinement;
@@ -10343,7 +10390,7 @@
       var items = isFromSearch ? searchForFacetValuesResults[attribute].map(function (v) {
         return {
           label: v.value,
-          value: getValue$2(v.value, props, searchState, {
+          value: getValue$2(v.escapedValue, props, searchState, {
             ais: props.contextValue,
             multiIndexContext: props.indexContextValue
           }),
@@ -10361,7 +10408,7 @@
       }).map(function (v) {
         return {
           label: v.name,
-          value: getValue$2(v.name, props, searchState, {
+          value: getValue$2(v.escapedValue, props, searchState, {
             ais: props.contextValue,
             multiIndexContext: props.indexContextValue
           }),