instantsearch.js 4.40.2 → 4.40.5

package/dist/instantsearch.development.js

@@ -1,4 +1,4 @@
-/*! InstantSearch.js 4.40.2 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch.js */
+/*! InstantSearch.js 4.40.5 | © 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,44 @@
     );
   };
 
+  /**
+   * Replaces a leading - with \-
+   * @private
+   * @param {any} value the facet value to replace
+   * @returns any
+   */
+  function escapeFacetValue(value) {
+    if (typeof value !== 'string') return value;
+
+    return String(value).replace(/^-/, '\\-');
+  }
+
+  /**
+   * Replaces a leading \- with -
+   * @private
+   * @param {any} value the escaped facet value
+   * @returns any
+   */
+  function unescapeFacetValue(value) {
+    if (typeof value !== 'string') return 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 +2327,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 +2403,7 @@
               facetCount,
               facetValue,
               hierarchicalSeparator,
-              currentRefinement,
+              unescapeFacetValue$1(currentRefinement),
               hierarchicalFacetResult.exhaustive
             );
           }),
@@ -2433,6 +2466,7 @@
     return {
       name: parts[parts.length - 1].trim(),
       path: facetValue,
+      escapedValue: escapeFacetValue$1(facetValue),
       count: facetCount,
       isRefined:
         currentRefinement === facetValue ||
@@ -2442,6 +2476,11 @@
     };
   }
 
+  var escapeFacetValue$2 = escapeFacetValue_1.escapeFacetValue;
+  var unescapeFacetValue$2 = escapeFacetValue_1.unescapeFacetValue;
+
+
+
   /**
    * @typedef SearchResults.Facet
    * @type {object}
@@ -2940,7 +2979,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 +3111,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 +3125,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 +4163,9 @@
 
   var requestBuilder_1 = requestBuilder;
 
-  var version = '3.7.4';
+  var version = '3.8.2';
+
+  var escapeFacetValue$3 = escapeFacetValue_1.escapeFacetValue;
 
   /**
    * Event triggered when a parameter is set or updated
@@ -4470,9 +4515,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;
@@ -6612,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) {
@@ -6621,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;
@@ -6655,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;
@@ -6703,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) {
@@ -6792,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);
   }
@@ -8488,7 +8536,7 @@
     instantSearchInstance.renderState = _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState), {}, _defineProperty({}, parentIndexName, _objectSpread2(_objectSpread2({}, instantSearchInstance.renderState[parentIndexName]), renderState)));
   }
 
-  var version$1 = '4.40.2';
+  var version$1 = '4.40.5';
 
   var NAMESPACE = 'ais';
   var component = function component(componentName) {
@@ -9603,7 +9651,7 @@
 
       _defineProperty(this, "writeTimer", void 0);
 
-      _defineProperty(this, "shouldPushState", true);
+      _defineProperty(this, "inPopState", false);
 
       _defineProperty(this, "isDisposed", false);
 
@@ -9658,20 +9706,14 @@
           }
 
           _this2.writeTimer = setTimeout(function () {
-            setWindowTitle(title); // We do want to `pushState` if:
-            // - the router is not disposed, IS.js needs to update the URL
-            // OR
-            // - the last write was from InstantSearch.js
-            // (unlike a SPA, where it would have last written)
+            setWindowTitle(title);
 
-            var lastPushWasByISAfterDispose = !_this2.isDisposed || _this2.latestAcknowledgedHistory === window.history.length;
-
-            if (_this2.shouldPushState && lastPushWasByISAfterDispose) {
+            if (_this2.shouldWrite(url)) {
               window.history.pushState(routeState, title || '', url);
               _this2.latestAcknowledgedHistory = window.history.length;
             }
 
-            _this2.shouldPushState = true;
+            _this2.inPopState = false;
             _this2.writeTimer = undefined;
           }, _this2.writeDelay);
         });
@@ -9692,7 +9734,7 @@
             _this3.writeTimer = undefined;
           }
 
-          _this3.shouldPushState = false;
+          _this3.inPopState = true;
           var routeState = event.state; // At initial load, the state is read from the URL without update.
           // Therefore the state object is not available.
           // In this case, we fallback and read the URL.
@@ -9750,18 +9792,39 @@
 
         this.write({});
       }
+    }, {
+      key: "shouldWrite",
+      value: function shouldWrite(url) {
+        var _this5 = this;
+
+        return safelyRunOnBrowser(function (_ref6) {
+          var window = _ref6.window;
+          // We do want to `pushState` if:
+          // - the router is not disposed, IS.js needs to update the URL
+          // OR
+          // - the last write was from InstantSearch.js
+          // (unlike a SPA, where it would have last written)
+          var lastPushWasByISAfterDispose = !(_this5.isDisposed && _this5.latestAcknowledgedHistory !== window.history.length);
+          return (// When the last state change was through popstate, the IS.js state changes,
+            // but that should not write the URL.
+            !_this5.inPopState && // When the previous pushState after dispose was by IS.js, we want to write the URL.
+            lastPushWasByISAfterDispose && // When the URL is the same as the current one, we do not want to write it.
+            url !== window.location.href
+          );
+        });
+      }
     }]);
 
     return BrowserHistory;
   }();
 
   function historyRouter() {
-    var _ref6 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
-        _ref6$createURL = _ref6.createURL,
-        createURL = _ref6$createURL === void 0 ? function (_ref7) {
-      var qsModule = _ref7.qsModule,
-          routeState = _ref7.routeState,
-          location = _ref7.location;
+    var _ref7 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
+        _ref7$createURL = _ref7.createURL,
+        createURL = _ref7$createURL === void 0 ? function (_ref8) {
+      var qsModule = _ref8.qsModule,
+          routeState = _ref8.routeState,
+          location = _ref8.location;
       var protocol = location.protocol,
           hostname = location.hostname,
           _location$port = location.port,
@@ -9777,11 +9840,11 @@
       }
 
       return "".concat(protocol, "//").concat(hostname).concat(portWithPrefix).concat(pathname, "?").concat(queryString).concat(hash);
-    } : _ref6$createURL,
-        _ref6$parseURL = _ref6.parseURL,
-        parseURL = _ref6$parseURL === void 0 ? function (_ref8) {
-      var qsModule = _ref8.qsModule,
-          location = _ref8.location;
+    } : _ref7$createURL,
+        _ref7$parseURL = _ref7.parseURL,
+        parseURL = _ref7$parseURL === void 0 ? function (_ref9) {
+      var qsModule = _ref9.qsModule,
+          location = _ref9.location;
       // `qs` by default converts arrays with more than 20 items to an object.
       // We want to avoid this because the data structure manipulated can therefore vary.
       // Setting the limit to `100` seems a good number because the engine's default is 100
@@ -9795,21 +9858,21 @@
       return qsModule.parse(location.search.slice(1), {
         arrayLimit: 99
       });
-    } : _ref6$parseURL,
-        _ref6$writeDelay = _ref6.writeDelay,
-        writeDelay = _ref6$writeDelay === void 0 ? 400 : _ref6$writeDelay,
-        windowTitle = _ref6.windowTitle,
-        _ref6$getLocation = _ref6.getLocation,
-        getLocation = _ref6$getLocation === void 0 ? function () {
-      return safelyRunOnBrowser(function (_ref9) {
-        var window = _ref9.window;
+    } : _ref7$parseURL,
+        _ref7$writeDelay = _ref7.writeDelay,
+        writeDelay = _ref7$writeDelay === void 0 ? 400 : _ref7$writeDelay,
+        windowTitle = _ref7.windowTitle,
+        _ref7$getLocation = _ref7.getLocation,
+        getLocation = _ref7$getLocation === void 0 ? function () {
+      return safelyRunOnBrowser(function (_ref10) {
+        var window = _ref10.window;
         return window.location;
       }, {
         fallback: function fallback() {
           throw new Error('You need to provide `getLocation` to the `history` router in environments where `window` does not exist.');
         }
       });
-    } : _ref6$getLocation;
+    } : _ref7$getLocation;
 
     return new BrowserHistory({
       createURL: createURL,
@@ -10813,7 +10876,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,
@@ -10837,6 +10900,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
@@ -10922,13 +10997,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 +11963,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 +12928,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 +12991,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
                   });
                 }), {
@@ -13699,8 +13778,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) {
@@ -13813,16 +13892,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;
@@ -14057,7 +14136,7 @@
       if (currentItem.isRefined) {
         result.push({
           label: currentItem.name,
-          value: currentItem.path
+          value: currentItem.escapedValue
         });
 
         if (Array.isArray(currentItem.data)) {
@@ -19406,7 +19485,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) {
@@ -19617,7 +19696,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);
       }
@@ -19711,7 +19790,7 @@
         return {
           handlePos: nextHandlePos,
           values: nextHandlePos.map(function (pos) {
-            return getValue(pos, min, max);
+            return getValue$1(pos, min, max);
           })
         };
       }