instantsearch.js 4.37.1 → 4.38.1

package/cjs/lib/routers/history.js

@@ -58,16 +58,23 @@ var BrowserHistory = /*#__PURE__*/function () {
 
     _defineProperty(this, "shouldPushState", true);
 
+    _defineProperty(this, "isDisposed", false);
+
+    _defineProperty(this, "latestAcknowledgedHistory", 0);
+
     this.windowTitle = windowTitle;
     this.writeTimer = undefined;
     this.writeDelay = writeDelay;
     this._createURL = createURL;
     this.parseURL = parseURL;
     this.getLocation = getLocation;
-    (0, _index.safelyRunOnBrowser)(function () {
+    (0, _index.safelyRunOnBrowser)(function (_ref2) {
+      var window = _ref2.window;
+
       var title = _this.windowTitle && _this.windowTitle(_this.read());
 
       setWindowTitle(title);
+      _this.latestAcknowledgedHistory = window.history.length;
     });
   }
   /**
@@ -92,8 +99,8 @@ var BrowserHistory = /*#__PURE__*/function () {
     value: function write(routeState) {
       var _this2 = this;
 
-      (0, _index.safelyRunOnBrowser)(function (_ref2) {
-        var window = _ref2.window;
+      (0, _index.safelyRunOnBrowser)(function (_ref3) {
+        var window = _ref3.window;
 
         var url = _this2.createURL(routeState);
 
@@ -104,10 +111,17 @@ var BrowserHistory = /*#__PURE__*/function () {
         }
 
         _this2.writeTimer = setTimeout(function () {
-          setWindowTitle(title);
+          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)
+
+          var lastPushWasByISAfterDispose = !_this2.isDisposed || _this2.latestAcknowledgedHistory === window.history.length;
 
-          if (_this2.shouldPushState) {
+          if (_this2.shouldPushState && lastPushWasByISAfterDispose) {
             window.history.pushState(routeState, title || '', url);
+            _this2.latestAcknowledgedHistory = window.history.length;
           }
 
           _this2.shouldPushState = true;
@@ -143,8 +157,8 @@ var BrowserHistory = /*#__PURE__*/function () {
         }
       };
 
-      (0, _index.safelyRunOnBrowser)(function (_ref3) {
-        var window = _ref3.window;
+      (0, _index.safelyRunOnBrowser)(function (_ref4) {
+        var window = _ref4.window;
         window.addEventListener('popstate', _this3._onPopState);
       });
     }
@@ -174,8 +188,9 @@ var BrowserHistory = /*#__PURE__*/function () {
     value: function dispose() {
       var _this4 = this;
 
-      (0, _index.safelyRunOnBrowser)(function (_ref4) {
-        var window = _ref4.window;
+      this.isDisposed = true;
+      (0, _index.safelyRunOnBrowser)(function (_ref5) {
+        var window = _ref5.window;
 
         if (_this4._onPopState) {
           window.removeEventListener('popstate', _this4._onPopState);
@@ -194,12 +209,12 @@ var BrowserHistory = /*#__PURE__*/function () {
 }();
 
 function historyRouter() {
-  var _ref5 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
-      _ref5$createURL = _ref5.createURL,
-      createURL = _ref5$createURL === void 0 ? function (_ref6) {
-    var qsModule = _ref6.qsModule,
-        routeState = _ref6.routeState,
-        location = _ref6.location;
+  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 protocol = location.protocol,
         hostname = location.hostname,
         _location$port = location.port,
@@ -215,11 +230,11 @@ function historyRouter() {
     }
 
     return "".concat(protocol, "//").concat(hostname).concat(portWithPrefix).concat(pathname, "?").concat(queryString).concat(hash);
-  } : _ref5$createURL,
-      _ref5$parseURL = _ref5.parseURL,
-      parseURL = _ref5$parseURL === void 0 ? function (_ref7) {
-    var qsModule = _ref7.qsModule,
-        location = _ref7.location;
+  } : _ref6$createURL,
+      _ref6$parseURL = _ref6.parseURL,
+      parseURL = _ref6$parseURL === void 0 ? function (_ref8) {
+    var qsModule = _ref8.qsModule,
+        location = _ref8.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
@@ -233,21 +248,21 @@ function historyRouter() {
     return qsModule.parse(location.search.slice(1), {
       arrayLimit: 99
     });
-  } : _ref5$parseURL,
-      _ref5$writeDelay = _ref5.writeDelay,
-      writeDelay = _ref5$writeDelay === void 0 ? 400 : _ref5$writeDelay,
-      windowTitle = _ref5.windowTitle,
-      _ref5$getLocation = _ref5.getLocation,
-      getLocation = _ref5$getLocation === void 0 ? function () {
-    return (0, _index.safelyRunOnBrowser)(function (_ref8) {
-      var window = _ref8.window;
+  } : _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 (0, _index.safelyRunOnBrowser)(function (_ref9) {
+      var window = _ref9.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.');
       }
     });
-  } : _ref5$getLocation;
+  } : _ref6$getLocation;
 
   return new BrowserHistory({
     createURL: createURL,

package/cjs/lib/version.js

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

package/cjs/middlewares/createMetadataMiddleware.js

@@ -54,8 +54,10 @@ function extractPayload(widgets, instantSearchInstance, payload) {
 
 function isMetadataEnabled() {
   return (0, _index.safelyRunOnBrowser)(function (_ref) {
+    var _window$navigator, _window$navigator$use;
+
     var window = _ref.window;
-    return window.navigator.userAgent.indexOf('Algolia Crawler') > -1;
+    return ((_window$navigator = window.navigator) === null || _window$navigator === void 0 ? void 0 : (_window$navigator$use = _window$navigator.userAgent) === null || _window$navigator$use === void 0 ? void 0 : _window$navigator$use.indexOf('Algolia Crawler')) > -1;
   }, {
     fallback: function fallback() {
       return false;

package/dist/instantsearch.development.d.ts

@@ -466,6 +466,17 @@ declare class BrowserHistory<TRouteState> implements Router<TRouteState> {
      * It needs to avoid pushing state to history in case of back/forward in browser
      */
     private shouldPushState;
+    /**
+     * Indicates whether the history router is disposed or not.
+     */
+    private isDisposed;
+    /**
+     * Indicates the window.history.length before the last call to
+     * window.history.pushState (called in `write`).
+     * It allows to determine if a `pushState` has been triggered elsewhere,
+     * and thus to prevent the `write` method from calling `pushState`.
+     */
+    private latestAcknowledgedHistory;
     /**
      * Initializes a new storage provider that syncs the search state to the URL
      * using web APIs (`window.location.pushState` and `onpopstate` event).
@@ -1098,9 +1109,9 @@ declare type DynamicWidgetsConnectorParams = {
      * Function to transform the items to render.
      * The function also exposes the full search response.
      */
-    transformItems?(items: string[], metadata: {
-        results: SearchResults;
-    }): string[];
+    transformItems?: TransformItems<string, Omit<TransformItemsMetadata, 'results'> & {
+        results: NonNullable<TransformItemsMetadata['results']>;
+    }>;
     /**
      * To prevent unneeded extra network requests when widgets mount or unmount,
      * we request all facet values.
@@ -3203,8 +3214,6 @@ declare type ParamTrackedFilters = {
     [facetName: string]: (facetValues: TrackedFilterRefinement[]) => TrackedFilterRefinement[];
 };
 
-declare type ParamTransformItems = TransformItems<any>;
-
 declare type ParamTransformRuleContexts = (ruleContexts: string[]) => string[];
 
 declare type ParseURL<TRouteState> = (args: {
@@ -3345,7 +3354,7 @@ declare type QueryRulesConnector = Connector<QueryRulesWidgetDescription, QueryR
 declare type QueryRulesConnectorParams = {
     trackedFilters?: ParamTrackedFilters;
     transformRuleContexts?: ParamTransformRuleContexts;
-    transformItems?: ParamTransformItems;
+    transformItems?: TransformItems<any>;
 };
 
 declare type QueryRulesRenderState = {
@@ -4915,7 +4924,9 @@ declare const toggleRefinement: ToggleRefinementWidget;
 declare type ToggleRefinementConnector = Connector<ToggleRefinementWidgetDescription, ToggleRefinementConnectorParams>;
 
 declare type ToggleRefinementConnectorParams = {
-    /** Name of the attribute for faceting (eg. "free_shipping"). */
+    /**
+     * Name of the attribute for faceting (e.g., "free_shipping").
+     */
     attribute: string;
     /**
      * Value to filter on when toggled.
@@ -4950,19 +4961,42 @@ declare type ToggleRefinementCSSClasses = Partial<{
 declare type ToggleRefinementRenderState = {
     /** The current toggle value */
     value: {
+        /**
+         * The attribute name of this toggle.
+         */
         name: string;
+        /**
+         * Whether the current option is "on" (true) or "off" (false)
+         */
         isRefined: boolean;
+        /**
+         * Number of results if this option is toggled.
+         */
         count: number | null;
+        /**
+         * Information about the "on" toggle.
+         */
         onFacetValue: ToggleRefinementValue;
+        /**
+         * Information about the "off" toggle.
+         */
         offFacetValue: ToggleRefinementValue;
     };
-    /** Creates an URL for the next state. */
+    /**
+     * Creates an URL for the next state.
+     */
     createURL: CreateURL<string>;
-    /** send a "facet clicked" insights event */
+    /**
+     * Send a "Facet Clicked" Insights event.
+     */
     sendEvent: SendEventForToggle;
-    /** Indicates if search state can be refined. */
+    /**
+     * Indicates if search state can be refined.
+     */
     canRefine: boolean;
-    /** Updates to the next state by applying the toggle refinement. */
+    /**
+     * Updates to the next state by applying the toggle refinement.
+     */
     refine: (value?: {
         isRefined: boolean;
     }) => void;
@@ -4976,9 +5010,13 @@ declare type ToggleRefinementTemplates = Partial<{
 }>;
 
 declare type ToggleRefinementValue = {
-    /** whether this option is enabled */
+    /**
+     * Whether this option is enabled.
+     */
     isRefined: boolean;
-    /** number of result if this option is enabled */
+    /**
+     * Number of result if this option is toggled.
+     */
     count: number | null;
 };
 
@@ -5021,7 +5059,11 @@ declare type TrackedFilterRefinement = string | number | boolean;
 /**
  * Transforms the given items.
  */
-declare type TransformItems<TItem> = (items: TItem[]) => TItem[];
+declare type TransformItems<TItem, TMetadata = TransformItemsMetadata> = (items: TItem[], metadata: TMetadata) => TItem[];
+
+declare type TransformItemsMetadata = {
+    results?: SearchResults;
+};
 
 declare type TransformSearchParameters = (searchParameters: SearchParameters) => PlainSearchParameters;