instantsearch.js 4.40.2 → 4.40.5

package/es/connectors/breadcrumb/connectBreadcrumb.js

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

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

@@ -187,7 +187,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,
@@ -211,4 +211,16 @@ 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;
+}
+
 export default connectCurrentRefinements;

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

@@ -106,13 +106,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/es/connectors/menu/connectMenu.js

@@ -161,8 +161,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/es/connectors/refinement-list/connectRefinementList.js

@@ -64,11 +64,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
       });
     };
@@ -126,11 +127,12 @@ var connectRefinementList = function connectRefinementList(renderFn) {
             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 _objectSpread(_objectSpread({}, item), {}, {
-                  value: value,
+                  value: escapedValue,
                   label: value
                 });
               }), {

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

@@ -4,7 +4,7 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
-import { checkRendering, escapeRefinement, unescapeRefinement, createDocumentationMessageGenerator, find, noop, toArray } from "../../lib/utils/index.js";
+import { checkRendering, escapeFacetValue, createDocumentationMessageGenerator, find, noop, toArray } from "../../lib/utils/index.js";
 var withUsage = createDocumentationMessageGenerator({
   name: 'toggle-refinement',
   connector: true
@@ -81,8 +81,8 @@ var connectToggleRefinement = function connectToggleRefinement(renderFn) {
     }
 
     var hasAnOffValue = userOff !== undefined;
-    var on = toArray(userOn).map(escapeRefinement);
-    var off = hasAnOffValue ? toArray(userOff).map(escapeRefinement) : undefined;
+    var on = toArray(userOn).map(escapeFacetValue);
+    var off = hasAnOffValue ? toArray(userOff).map(escapeFacetValue) : undefined;
     var sendEvent;
 
     var toggleRefinementFactory = function toggleRefinementFactory(helper) {
@@ -195,16 +195,16 @@ var connectToggleRefinement = function connectToggleRefinement(renderFn) {
           var allFacetValues = results.getFacetValues(attribute, {}) || [];
           var onData = on.map(function (v) {
             return find(allFacetValues, function (_ref7) {
-              var name = _ref7.name;
-              return name === unescapeRefinement(v);
+              var escapedValue = _ref7.escapedValue;
+              return escapedValue === escapeFacetValue(String(v));
             });
           }).filter(function (v) {
             return v !== undefined;
           });
           var offData = hasAnOffValue ? offValue.map(function (v) {
             return find(allFacetValues, function (_ref8) {
-              var name = _ref8.name;
-              return name === unescapeRefinement(v);
+              var escapedValue = _ref8.escapedValue;
+              return escapedValue === escapeFacetValue(String(v));
             });
           }).filter(function (v) {
             return v !== undefined;

package/es/lib/routers/history.d.ts

@@ -47,10 +47,9 @@ declare class BrowserHistory<TRouteState> implements Router<TRouteState> {
     private writeTimer?;
     private _onPopState;
     /**
-     * Indicates if history.pushState should be executed.
-     * It needs to avoid pushing state to history in case of back/forward in browser
+     * Indicates if last action was back/forward in the browser.
      */
-    private shouldPushState;
+    private inPopState;
     /**
      * Indicates whether the history router is disposed or not.
      */
@@ -92,6 +91,7 @@ declare class BrowserHistory<TRouteState> implements Router<TRouteState> {
      * Removes the event listener and cleans up the URL.
      */
     dispose(): void;
+    private shouldWrite;
 }
 export default function historyRouter<TRouteState = UiState>({ createURL, parseURL, writeDelay, windowTitle, getLocation, }?: Partial<BrowserHistoryArgs<TRouteState>>): BrowserHistory<TRouteState>;
 export {};

package/es/lib/routers/history.js

@@ -46,7 +46,7 @@ var BrowserHistory = /*#__PURE__*/function () {
 
     _defineProperty(this, "writeTimer", void 0);
 
-    _defineProperty(this, "shouldPushState", true);
+    _defineProperty(this, "inPopState", false);
 
     _defineProperty(this, "isDisposed", false);
 
@@ -101,20 +101,14 @@ var BrowserHistory = /*#__PURE__*/function () {
         }
 
         _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);
       });
@@ -135,7 +129,7 @@ var BrowserHistory = /*#__PURE__*/function () {
           _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.
@@ -193,18 +187,39 @@ var BrowserHistory = /*#__PURE__*/function () {
 
       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;
 }();
 
 export default 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,
@@ -220,11 +235,11 @@ export default function historyRouter() {
     }
 
     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
@@ -238,21 +253,21 @@ export default function historyRouter() {
     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,

package/es/lib/utils/escapeFacetValue.d.ts

@@ -0,0 +1,4 @@
+declare type FacetValue = string | number | undefined;
+export declare function unescapeFacetValue<TFacetValue extends FacetValue>(value: TFacetValue): TFacetValue;
+export declare function escapeFacetValue<TFacetValue extends FacetValue>(value: TFacetValue): TFacetValue;
+export {};

package/es/lib/utils/escapeFacetValue.js

@@ -0,0 +1,14 @@
+export function unescapeFacetValue(value) {
+  if (typeof value === 'string') {
+    return value.replace(/^\\-/, '-');
+  }
+
+  return value;
+}
+export function escapeFacetValue(value) {
+  if (typeof value === 'number' && value < 0 || typeof value === 'string') {
+    return String(value).replace(/^-/, '\\-');
+  }
+
+  return value;
+}

package/es/lib/utils/getRefinements.d.ts

@@ -1,24 +1,39 @@
 import type { SearchParameters, SearchResults } from 'algoliasearch-helper';
 export declare type FacetRefinement = {
-    type: 'facet' | 'exclude' | 'disjunctive' | 'hierarchical' | 'numeric' | 'tag' | 'query';
+    type: 'facet' | 'disjunctive' | 'hierarchical';
     attribute: string;
     name: string;
+    escapedValue: string;
     count?: number;
     exhaustive?: boolean;
 };
+export declare type TagRefinement = {
+    type: 'tag';
+    attribute: string;
+    name: string;
+};
 export declare type QueryRefinement = {
     type: 'query';
+    attribute: 'query';
     query: string;
-} & Pick<FacetRefinement, 'type' | 'attribute' | 'name'>;
+    name: string;
+};
 export declare type NumericRefinement = {
     type: 'numeric';
     numericValue: number;
     operator: '<' | '<=' | '=' | '!=' | '>=' | '>';
-} & FacetRefinement;
+    attribute: string;
+    name: string;
+    count?: number;
+    exhaustive?: boolean;
+};
 export declare type FacetExcludeRefinement = {
     type: 'exclude';
     exclude: boolean;
-} & FacetRefinement;
-export declare type Refinement = FacetRefinement | QueryRefinement | NumericRefinement | FacetExcludeRefinement;
-declare function getRefinements(results: SearchResults | Record<string, never>, state: SearchParameters, includesQuery?: boolean): Refinement[];
-export default getRefinements;
+    attribute: string;
+    name: string;
+    count?: number;
+    exhaustive?: boolean;
+};
+export declare type Refinement = FacetRefinement | QueryRefinement | NumericRefinement | FacetExcludeRefinement | TagRefinement;
+export default function getRefinements(results: SearchResults | Record<string, never>, state: SearchParameters, includesQuery?: boolean): Refinement[];

package/es/lib/utils/getRefinements.js

@@ -1,12 +1,13 @@
 import find from "./find.js";
-import unescapeRefinement from "./unescapeRefinement.js";
+import { unescapeFacetValue, escapeFacetValue } from "./escapeFacetValue.js";
 
 function getRefinement(state, type, attribute, name) {
   var resultsFacets = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : [];
   var res = {
     type: type,
     attribute: attribute,
-    name: name
+    name: name,
+    escapedValue: escapeFacetValue(name)
   };
   var facet = find(resultsFacets, function (resultsFacet) {
     return resultsFacet.name === attribute;
@@ -40,20 +41,18 @@ 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;
 }
 
-function getRefinements(results, state) {
+export default function getRefinements(results, state) {
   var includesQuery = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
   var refinements = [];
   var _state$facetsRefineme = state.facetsRefinements,
@@ -88,9 +87,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`.
-      unescapeRefinement(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`.
+      unescapeFacetValue(refinementName), results.disjunctiveFacets));
     });
   });
   Object.keys(hierarchicalFacetsRefinements).forEach(function (attribute) {
@@ -134,6 +133,4 @@ function getRefinements(results, state) {
   }
 
   return refinements;
-}
-
-export default getRefinements;
+}

package/es/lib/utils/index.d.ts

@@ -7,8 +7,7 @@ export { default as prepareTemplateProps } from './prepareTemplateProps';
 export { default as renderTemplate } from './renderTemplate';
 export { default as getRefinements } from './getRefinements';
 export { default as clearRefinements } from './clearRefinements';
-export { default as escapeRefinement } from './escapeRefinement';
-export { default as unescapeRefinement } from './unescapeRefinement';
+export { escapeFacetValue, unescapeFacetValue } from './escapeFacetValue';
 export { default as checkRendering } from './checkRendering';
 export { checkIndexUiState } from './checkIndexUiState';
 export { default as getPropertyByPath } from './getPropertyByPath';

package/es/lib/utils/index.js

@@ -7,8 +7,7 @@ export { default as prepareTemplateProps } from "./prepareTemplateProps.js";
 export { default as renderTemplate } from "./renderTemplate.js";
 export { default as getRefinements } from "./getRefinements.js";
 export { default as clearRefinements } from "./clearRefinements.js";
-export { default as escapeRefinement } from "./escapeRefinement.js";
-export { default as unescapeRefinement } from "./unescapeRefinement.js";
+export { escapeFacetValue, unescapeFacetValue } from "./escapeFacetValue.js";
 export { default as checkRendering } from "./checkRendering.js";
 export { checkIndexUiState } from "./checkIndexUiState.js";
 export { default as getPropertyByPath } from "./getPropertyByPath.js";

package/es/lib/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "4.40.2";
+declare const _default: "4.40.5";
 export default _default;

package/es/lib/version.js

@@ -1 +1 @@
-export default '4.40.2';
+export default '4.40.5';

package/es/types/results.d.ts

@@ -1,4 +1,4 @@
-import type { PlainSearchParameters, SearchResults } from 'algoliasearch-helper';
+import type { PlainSearchParameters, SearchForFacetValues, SearchResults } from 'algoliasearch-helper';
 export declare type HitAttributeHighlightResult = {
     value: string;
     matchLevel: 'none' | 'partial' | 'full';
@@ -52,12 +52,7 @@ export declare type Hits = Hit[];
 export declare type EscapedHits<THit = Hit> = THit[] & {
     __escaped: boolean;
 };
-export declare type FacetHit = {
-    value: string;
-    highlighted: string;
-    count: number;
-    isRefined: boolean;
-};
+export declare type FacetHit = SearchForFacetValues.Hit;
 export declare type FacetRefinement = {
     value: string;
     type: 'conjunctive' | 'disjunctive' | 'exclude';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "instantsearch.js",
-  "version": "4.40.2",
+  "version": "4.40.5",
   "description": "InstantSearch.js is a JavaScript library for building performant and instant search experiences with Algolia.",
   "homepage": "https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/",
   "types": "es/index.d.ts",
@@ -56,7 +56,7 @@
     "@types/google.maps": "^3.45.3",
     "@types/hogan.js": "^3.0.0",
     "@types/qs": "^6.5.3",
-    "algoliasearch-helper": "^3.7.4",
+    "algoliasearch-helper": "^3.8.2",
     "classnames": "^2.2.5",
     "@algolia/events": "^4.0.1",
     "hogan.js": "^3.0.2",
@@ -154,7 +154,7 @@
   "bundlesize": [
     {
       "path": "./dist/instantsearch.production.min.js",
-      "maxSize": "70.00 kB"
+      "maxSize": "70.25 kB"
     },
     {
       "path": "./dist/instantsearch.development.js",

package/cjs/lib/utils/escapeRefinement.js

@@ -1,17 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-function escapeRefinement(value) {
-  if (typeof value === 'number' && value < 0) {
-    value = String(value).replace(/^-/, '\\-');
-  }
-
-  return value;
-}
-
-var _default = escapeRefinement;
-exports.default = _default;

package/cjs/lib/utils/unescapeRefinement.js

@@ -1,13 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-function unescapeRefinement(value) {
-  return String(value).replace(/^\\-/, '-');
-}
-
-var _default = unescapeRefinement;
-exports.default = _default;

package/es/lib/utils/escapeRefinement.d.ts

@@ -1,3 +0,0 @@
-declare function escapeRefinement(value: number): string | number;
-declare function escapeRefinement(value: string): string;
-export default escapeRefinement;

package/es/lib/utils/escapeRefinement.js

@@ -1,9 +0,0 @@
-function escapeRefinement(value) {
-  if (typeof value === 'number' && value < 0) {
-    value = String(value).replace(/^-/, '\\-');
-  }
-
-  return value;
-}
-
-export default escapeRefinement;

package/es/lib/utils/unescapeRefinement.d.ts

@@ -1,2 +0,0 @@
-declare function unescapeRefinement(value: string | number): string;
-export default unescapeRefinement;

package/es/lib/utils/unescapeRefinement.js

@@ -1,5 +0,0 @@
-function unescapeRefinement(value) {
-  return String(value).replace(/^\\-/, '-');
-}
-
-export default unescapeRefinement;