instantsearch.js 4.32.0 → 4.34.0

package/CHANGELOG.md

@@ -1,3 +1,46 @@
+# [4.34.0](https://github.com/algolia/instantsearch.js/compare/v4.33.2...v4.34.0) (2021-12-07)
+
+
+### Features
+
+* rely on `state` in `getWidgetRenderState` ([#4960](https://github.com/algolia/instantsearch.js/issues/4960)) ([5006841](https://github.com/algolia/instantsearch.js/commit/50068417e5e7211802bc717b582946f6e630d7ac))
+* support initial results (experimental) ([#4967](https://github.com/algolia/instantsearch.js/issues/4967)) ([db11c13](https://github.com/algolia/instantsearch.js/commit/db11c13ea55433491f5e924633bff12a303c1bc6))
+
+
+
+## [4.33.2](https://github.com/algolia/instantsearch.js/compare/v4.33.1...v4.33.2) (2021-11-16)
+
+
+### Bug Fixes
+
+* **connectNumericMenu:** allow option for same start/end values ([#4951](https://github.com/algolia/instantsearch.js/issues/4951)) ([18da714](https://github.com/algolia/instantsearch.js/commit/18da714574fa98957d29014add3123e9c377551f))
+
+
+
+## [4.33.1](https://github.com/algolia/instantsearch.js/compare/v4.33.0...v4.33.1) (2021-11-02)
+
+
+### Bug Fixes
+
+* **getUiState:** support `initialUiState` ([#4948](https://github.com/algolia/instantsearch.js/issues/4948)) ([532474d](https://github.com/algolia/instantsearch.js/commit/532474dfaf49446ab59a2a27424ca220947dd5bd))
+
+
+
+# [4.33.0](https://github.com/algolia/instantsearch.js/compare/v4.32.0...v4.33.0) (2021-10-26)
+
+
+### Bug Fixes
+
+* **router:** skip history push on browser back and forward actions ([#4933](https://github.com/algolia/instantsearch.js/issues/4933)) ([7909da4](https://github.com/algolia/instantsearch.js/commit/7909da4903eb1aee885811e280b909a3bda488be))
+* **setUiState:** reset UI state with empty object ([#4944](https://github.com/algolia/instantsearch.js/issues/4944)) ([5faae4a](https://github.com/algolia/instantsearch.js/commit/5faae4ac44ac5ad2f8086ad2a306bcfaa14bc754))
+
+
+### Features
+
+* **router:** support server environments ([#4940](https://github.com/algolia/instantsearch.js/issues/4940)) ([a002962](https://github.com/algolia/instantsearch.js/commit/a002962df0e7683b29bef8bfaaddb494fa551a14))
+
+
+
 # [4.32.0](https://github.com/algolia/instantsearch.js/compare/v4.31.1...v4.32.0) (2021-10-20)
 
 

package/README.md

@@ -29,6 +29,7 @@ InstantSearch.js is a vanilla JavaScript library that lets you create an instant
 - [Why](#why)
 - [Getting started](#getting-started)
 - [Installation](#installation)
+  - [TypeScript users](#typescript-users)
 - [Documentation](#documentation)
 - [Demos](#demos)
 - [Playground](#playground)
@@ -102,6 +103,28 @@ npm install instantsearch.js algoliasearch
 yarn add instantsearch.js algoliasearch
 ```
 
+### TypeScript users
+
+To use InstantSearch.js in a TypeScript environment, depending on your [`algoliasearch`](https://github.com/algolia/algoliasearch-client-javascript) version, you need to import different types.
+
+>You still need to import these types even if you don't use InstantSearch.js with [`algoliasearch`](https://github.com/algolia/algoliasearch-client-javascript).
+
+#### `algoliasearch` v4.x
+
+This version uses types provided by both `algoliasearch` and `@algolia/client-search`.
+
+```bash
+yarn add algoliasearch@4 @algolia/client-search
+```
+
+#### `algoliasearch` v3.x
+
+```bash
+yarn add @types/algoliasearch@3
+```
+
+>v3.x is deprecated and will soon no longer be supported.
+
 ## Documentation
 
 The documentation is available on the [Algolia website](https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/).
@@ -110,7 +133,7 @@ The documentation is available on the [Algolia website](https://www.algolia.com/
 
 | E-commerce                                                                                                                                                                                                                   | Media                                                                                                                                                                                                         | Travel                                                                                                                                                                                                              |
 | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a href="https://instantsearchjs.netlify.com/examples/e-commerce/"><img src="https://www.algolia.com/doc/assets/images/build-search-ui/demos/e-commerce-2c7ed6b6.png" width="250" alt="E-commerce demo preview"></a> | <a href="https://instantsearchjs.netlify.com/examples/media/"><img src="https://instantsearchjs.netlify.com/examples/media/capture.png" width="250" alt="Media demo preview"></a> | <a href="https://instantsearchjs.netlify.com/examples/tourism/"><img src="https://instantsearchjs.netlify.com/examples/tourism/capture.png" width="250" alt="Tourism demo preview"></a> |
+| <a href="https://instantsearchjs.netlify.com/examples/e-commerce/"><img src="https://www.algolia.com/doc/assets/images/build-search-ui/demos/e-commerce-2c7ed6b6.png" width="250" alt="E-commerce demo preview"></a> | <a href="https://instantsearchjs.netlify.com/examples/media/"><img src="./examples/media/capture.png" width="250" alt="Media demo preview"></a> | <a href="https://instantsearchjs.netlify.com/examples/tourism/"><img src="https://instantsearchjs.netlify.com/examples/tourism/capture.png" width="250" alt="Tourism demo preview"></a> |
 
 See more demos [on the website](https://www.algolia.com/doc/guides/building-search-ui/resources/demos/js/).
 

package/cjs/connectors/autocomplete/connectAutocomplete.js

@@ -60,6 +60,7 @@ var connectAutocomplete = function connectAutocomplete(renderFn) {
         var _this = this;
 
         var helper = _ref4.helper,
+            state = _ref4.state,
             scopedResults = _ref4.scopedResults,
             instantSearchInstance = _ref4.instantSearchInstance;
 
@@ -87,7 +88,7 @@ var connectAutocomplete = function connectAutocomplete(renderFn) {
           };
         });
         return {
-          currentRefinement: helper.state.query || '',
+          currentRefinement: state.query || '',
           indices: indices,
           refine: connectorState.refine,
           widgetParams: widgetParams

package/cjs/connectors/infinite-hits/connectInfiniteHits.js

@@ -173,7 +173,7 @@ var connectInfiniteHits = function connectInfiniteHits(renderFn) {
             index: helper.getIndex(),
             widgetType: this.$$type
           });
-          isFirstPage = helper.state.page === undefined || getFirstReceivedPage(helper.state, cachedHits) === 0;
+          isFirstPage = state.page === undefined || getFirstReceivedPage(state, cachedHits) === 0;
         } else {
           var _state$page3 = state.page,
               _page = _state$page3 === void 0 ? 0 : _state$page3;

package/cjs/connectors/numeric-menu/connectNumericMenu.js

@@ -242,6 +242,8 @@ function isRefined(state, attribute, option) {
   if (option.start !== undefined && option.end !== undefined) {
     if (option.start === option.end) {
       return hasNumericRefinement(currentRefinements, '=', option.start);
+    } else {
+      return hasNumericRefinement(currentRefinements, '>=', option.start) && hasNumericRefinement(currentRefinements, '<=', option.end);
     }
   }
 
@@ -295,17 +297,17 @@ function getRefinedState(state, attribute, facetValue) {
   if (refinedOption.start !== undefined) {
     if (hasNumericRefinement(currentRefinements, '>=', refinedOption.start)) {
       resolvedState = resolvedState.removeNumericRefinement(attribute, '>=', refinedOption.start);
-    } else {
-      resolvedState = resolvedState.addNumericRefinement(attribute, '>=', refinedOption.start);
     }
+
+    resolvedState = resolvedState.addNumericRefinement(attribute, '>=', refinedOption.start);
   }
 
   if (refinedOption.end !== undefined) {
     if (hasNumericRefinement(currentRefinements, '<=', refinedOption.end)) {
       resolvedState = resolvedState.removeNumericRefinement(attribute, '<=', refinedOption.end);
-    } else {
-      resolvedState = resolvedState.addNumericRefinement(attribute, '<=', refinedOption.end);
     }
+
+    resolvedState = resolvedState.addNumericRefinement(attribute, '<=', refinedOption.end);
   }
 
   if (typeof resolvedState.page === 'number') {

package/cjs/connectors/pagination/connectPagination.js

@@ -89,6 +89,7 @@ var connectPagination = function connectPagination(renderFn) {
       getWidgetRenderState: function getWidgetRenderState(_ref6) {
         var results = _ref6.results,
             helper = _ref6.helper,
+            state = _ref6.state,
             createURL = _ref6.createURL;
 
         if (!connectorState.refine) {
@@ -99,14 +100,13 @@ var connectPagination = function connectPagination(renderFn) {
         }
 
         if (!connectorState.createURL) {
-          connectorState.createURL = function (state) {
+          connectorState.createURL = function (helperState) {
             return function (page) {
-              return createURL(state.setPage(page));
+              return createURL(helperState.setPage(page));
             };
           };
         }
 
-        var state = helper.state;
         var page = state.page || 0;
         var nbPages = getMaxPage(results || {
           nbPages: 0

package/cjs/connectors/powered-by/connectPoweredBy.js

@@ -25,11 +25,20 @@ var withUsage = (0, _utils.createDocumentationMessageGenerator)({
 var connectPoweredBy = function connectPoweredBy(renderFn) {
   var unmountFn = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : _utils.noop;
   (0, _utils.checkRendering)(renderFn, withUsage());
-  var defaultUrl = 'https://www.algolia.com/?' + 'utm_source=instantsearch.js&' + 'utm_medium=website&' + "utm_content=".concat(typeof window !== 'undefined' && window.location ? window.location.hostname : '', "&") + 'utm_campaign=poweredby';
+  var defaultUrl = 'https://www.algolia.com/?' + 'utm_source=instantsearch.js&' + 'utm_medium=website&' + "utm_content=".concat((0, _utils.safelyRunOnBrowser)(function (_ref) {
+    var _window$location;
+
+    var window = _ref.window;
+    return ((_window$location = window.location) === null || _window$location === void 0 ? void 0 : _window$location.hostname) || '';
+  }, {
+    fallback: function fallback() {
+      return '';
+    }
+  }), "&") + 'utm_campaign=poweredby';
   return function (widgetParams) {
-    var _ref = widgetParams || {},
-        _ref$url = _ref.url,
-        url = _ref$url === void 0 ? defaultUrl : _ref$url;
+    var _ref2 = widgetParams || {},
+        _ref2$url = _ref2.url,
+        url = _ref2$url === void 0 ? defaultUrl : _ref2$url;
 
     return {
       $$type: 'ais.poweredBy',

package/cjs/connectors/search-box/connectSearchBox.js

@@ -71,11 +71,12 @@ var connectSearchBox = function connectSearchBox(renderFn) {
       },
       getWidgetRenderState: function getWidgetRenderState(_ref3) {
         var helper = _ref3.helper,
-            searchMetadata = _ref3.searchMetadata;
+            searchMetadata = _ref3.searchMetadata,
+            state = _ref3.state;
 
         if (!_refine) {
           var setQueryAndSearch = function setQueryAndSearch(query) {
-            if (query !== helper.state.query) {
+            if (query !== state.query) {
               helper.setQuery(query).search();
             }
           };
@@ -92,7 +93,7 @@ var connectSearchBox = function connectSearchBox(renderFn) {
 
         _clear = clear(helper);
         return {
-          query: helper.state.query || '',
+          query: state.query || '',
           refine: _refine,
           clear: _cachedClear,
           widgetParams: widgetParams,

package/cjs/connectors/sort-by/connectSortBy.js

@@ -72,6 +72,7 @@ var connectSortBy = function connectSortBy(renderFn) {
       getWidgetRenderState: function getWidgetRenderState(_ref3) {
         var results = _ref3.results,
             helper = _ref3.helper,
+            state = _ref3.state,
             parent = _ref3.parent;
 
         if (!connectorState.initialIndex && parent) {
@@ -85,7 +86,7 @@ var connectSortBy = function connectSortBy(renderFn) {
         }
 
         return {
-          currentRefinement: helper.state.index,
+          currentRefinement: state.index,
           options: transformItems(items),
           refine: connectorState.setIndex,
           hasNoResults: results ? results.nbHits === 0 : true,

package/cjs/connectors/stats/connectStats.js

@@ -50,18 +50,18 @@ var connectStats = function connectStats(renderFn) {
       },
       getWidgetRenderState: function getWidgetRenderState(_ref) {
         var results = _ref.results,
-            helper = _ref.helper;
+            state = _ref.state;
 
         if (!results) {
           return {
-            hitsPerPage: helper.state.hitsPerPage,
+            hitsPerPage: state.hitsPerPage,
             nbHits: 0,
             nbSortedHits: undefined,
             areHitsSorted: false,
             nbPages: 0,
-            page: helper.state.page || 0,
+            page: state.page || 0,
             processingTimeMS: -1,
-            query: helper.state.query || '',
+            query: state.query || '',
             widgetParams: widgetParams
           };
         }

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

@@ -185,7 +185,7 @@ var connectToggleRefinement = function connectToggleRefinement(renderFn) {
             createURL = _ref6.createURL,
             instantSearchInstance = _ref6.instantSearchInstance;
         var isRefined = results ? on.every(function (v) {
-          return helper.state.isDisjunctiveFacetRefined(attribute, v);
+          return state.isDisjunctiveFacetRefined(attribute, v);
         }) : on.every(function (v) {
           return state.isDisjunctiveFacetRefined(attribute, v);
         });

package/cjs/lib/InstantSearch.js

@@ -112,6 +112,8 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
 
     _defineProperty(_assertThisInitialized(_this), "_initialUiState", void 0);
 
+    _defineProperty(_assertThisInitialized(_this), "_initialResults", void 0);
+
     _defineProperty(_assertThisInitialized(_this), "_createURL", void 0);
 
     _defineProperty(_assertThisInitialized(_this), "_searchFunction", void 0);
@@ -216,6 +218,7 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
     _this._isSearchStalled = false;
     _this._createURL = defaultCreateURL;
     _this._initialUiState = initialUiState;
+    _this._initialResults = null;
 
     if (searchFunction) {
       _this._searchFunction = searchFunction;
@@ -458,9 +461,27 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
         parent: null,
         uiState: this._initialUiState
       });
-      this.scheduleSearch(); // Keep the previous reference for legacy purpose, some pattern use
+
+      if (this._initialResults) {
+        var originalScheduleSearch = this.scheduleSearch; // We don't schedule a first search when initial results are provided
+        // because we already have the results to render. This skips the initial
+        // network request on the browser on `start`.
+
+        this.scheduleSearch = (0, _utils.defer)(_utils.noop); // We also skip the initial network request when widgets are dynamically
+        // added in the first tick (that's the case in all the framework-based flavors).
+        // When we add a widget to `index`, it calls `scheduleSearch`. We can rely
+        // on our `defer` util to restore the original `scheduleSearch` value once
+        // widgets are added to hook back to the regular lifecycle.
+
+        (0, _utils.defer)(function () {
+          _this3.scheduleSearch = originalScheduleSearch;
+        })();
+      } else {
+        this.scheduleSearch();
+      } // Keep the previous reference for legacy purpose, some pattern use
       // the direct Helper access `search.helper` (e.g multi-index).
 
+
       this.helper = this.mainIndex.getHelper(); // track we started the search if we add more widgets,
       // to init them directly after add
 
@@ -522,15 +543,17 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
       var nextUiState = typeof uiState === 'function' ? uiState(this.mainIndex.getWidgetUiState({})) : uiState;
 
       var setIndexHelperState = function setIndexHelperState(indexWidget) {
+        var nextIndexUiState = nextUiState[indexWidget.getIndexId()] || {};
+
         if (process.env.NODE_ENV === 'development') {
           (0, _utils.checkIndexUiState)({
             index: indexWidget,
-            indexUiState: nextUiState[indexWidget.getIndexId()]
+            indexUiState: nextIndexUiState
           });
         }
 
         indexWidget.getHelper().setState(indexWidget.getWidgetSearchParameters(indexWidget.getHelper().state, {
-          uiState: nextUiState[indexWidget.getIndexId()]
+          uiState: nextIndexUiState
         }));
         indexWidget.getWidgets().filter(_index.isIndexWidget).forEach(setIndexHelperState);
       };

package/cjs/lib/infiniteHitsCache/sessionStorage.js

@@ -21,27 +21,27 @@ function getStateWithoutPage(state) {
 
 var KEY = 'ais.infiniteHits';
 
-function hasSessionStorage() {
-  return typeof window !== 'undefined' && typeof window.sessionStorage !== 'undefined';
-}
-
 function createInfiniteHitsSessionStorageCache() {
   return {
     read: function read(_ref2) {
       var state = _ref2.state;
+      var sessionStorage = (0, _utils.safelyRunOnBrowser)(function (_ref3) {
+        var window = _ref3.window;
+        return window.sessionStorage;
+      });
 
-      if (!hasSessionStorage()) {
+      if (!sessionStorage) {
         return null;
       }
 
       try {
         var cache = JSON.parse( // @ts-expect-error JSON.parse() requires a string, but it actually accepts null, too.
-        window.sessionStorage.getItem(KEY));
+        sessionStorage.getItem(KEY));
         return cache && (0, _utils.isEqual)(cache.state, getStateWithoutPage(state)) ? cache.hits : null;
       } catch (error) {
         if (error instanceof SyntaxError) {
           try {
-            window.sessionStorage.removeItem(KEY);
+            sessionStorage.removeItem(KEY);
           } catch (err) {// do nothing
           }
         }
@@ -49,16 +49,20 @@ function createInfiniteHitsSessionStorageCache() {
         return null;
       }
     },
-    write: function write(_ref3) {
-      var state = _ref3.state,
-          hits = _ref3.hits;
+    write: function write(_ref4) {
+      var state = _ref4.state,
+          hits = _ref4.hits;
+      var sessionStorage = (0, _utils.safelyRunOnBrowser)(function (_ref5) {
+        var window = _ref5.window;
+        return window.sessionStorage;
+      });
 
-      if (!hasSessionStorage()) {
+      if (!sessionStorage) {
         return;
       }
 
       try {
-        window.sessionStorage.setItem(KEY, JSON.stringify({
+        sessionStorage.setItem(KEY, JSON.stringify({
           state: getStateWithoutPage(state),
           hits: hits
         }));

package/cjs/lib/routers/history.js

@@ -7,6 +7,8 @@ exports.default = historyRouter;
 
 var _qs = _interopRequireDefault(require("qs"));
 
+var _utils = require("../utils");
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
@@ -19,6 +21,8 @@ function _defineProperty(obj, key, value) { if (key in obj) { Object.definePrope
 
 var setWindowTitle = function setWindowTitle(title) {
   if (title) {
+    // This function is only executed on browsers so we can disable this check.
+    // eslint-disable-next-line no-restricted-globals
     window.document.title = title;
   }
 };
@@ -29,11 +33,14 @@ var BrowserHistory = /*#__PURE__*/function () {
    * using web APIs (`window.location.pushState` and `onpopstate` event).
    */
   function BrowserHistory(_ref) {
+    var _this = this;
+
     var windowTitle = _ref.windowTitle,
         _ref$writeDelay = _ref.writeDelay,
         writeDelay = _ref$writeDelay === void 0 ? 400 : _ref$writeDelay,
         createURL = _ref.createURL,
-        parseURL = _ref.parseURL;
+        parseURL = _ref.parseURL,
+        getLocation = _ref.getLocation;
 
     _classCallCheck(this, BrowserHistory);
 
@@ -45,15 +52,23 @@ var BrowserHistory = /*#__PURE__*/function () {
 
     _defineProperty(this, "parseURL", void 0);
 
+    _defineProperty(this, "getLocation", void 0);
+
     _defineProperty(this, "writeTimer", void 0);
 
+    _defineProperty(this, "shouldPushState", true);
+
     this.windowTitle = windowTitle;
     this.writeTimer = undefined;
     this.writeDelay = writeDelay;
     this._createURL = createURL;
     this.parseURL = parseURL;
-    var title = this.windowTitle && this.windowTitle(this.read());
-    setWindowTitle(title);
+    this.getLocation = getLocation;
+    (0, _utils.safelyRunOnBrowser)(function () {
+      var title = _this.windowTitle && _this.windowTitle(_this.read());
+
+      setWindowTitle(title);
+    });
   }
   /**
    * Reads the URL and returns a syncable UI search state.
@@ -65,7 +80,7 @@ var BrowserHistory = /*#__PURE__*/function () {
     value: function read() {
       return this.parseURL({
         qsModule: _qs.default,
-        location: window.location
+        location: this.getLocation()
       });
     }
     /**
@@ -75,20 +90,30 @@ var BrowserHistory = /*#__PURE__*/function () {
   }, {
     key: "write",
     value: function write(routeState) {
-      var _this = this;
+      var _this2 = this;
 
-      var url = this.createURL(routeState);
-      var title = this.windowTitle && this.windowTitle(routeState);
+      (0, _utils.safelyRunOnBrowser)(function (_ref2) {
+        var window = _ref2.window;
 
-      if (this.writeTimer) {
-        window.clearTimeout(this.writeTimer);
-      }
+        var url = _this2.createURL(routeState);
+
+        var title = _this2.windowTitle && _this2.windowTitle(routeState);
+
+        if (_this2.writeTimer) {
+          clearTimeout(_this2.writeTimer);
+        }
+
+        _this2.writeTimer = setTimeout(function () {
+          setWindowTitle(title);
 
-      this.writeTimer = window.setTimeout(function () {
-        setWindowTitle(title);
-        window.history.pushState(routeState, title || '', url);
-        _this.writeTimer = undefined;
-      }, this.writeDelay);
+          if (_this2.shouldPushState) {
+            window.history.pushState(routeState, title || '', url);
+          }
+
+          _this2.shouldPushState = true;
+          _this2.writeTimer = undefined;
+        }, _this2.writeDelay);
+      });
     }
     /**
      * Sets a callback on the `onpopstate` event of the history API of the current page.
@@ -98,26 +123,30 @@ var BrowserHistory = /*#__PURE__*/function () {
   }, {
     key: "onUpdate",
     value: function onUpdate(callback) {
-      var _this2 = this;
+      var _this3 = this;
 
       this._onPopState = function (event) {
-        if (_this2.writeTimer) {
-          window.clearTimeout(_this2.writeTimer);
-          _this2.writeTimer = undefined;
+        if (_this3.writeTimer) {
+          clearTimeout(_this3.writeTimer);
+          _this3.writeTimer = undefined;
         }
 
+        _this3.shouldPushState = false;
         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.
 
         if (!routeState) {
-          callback(_this2.read());
+          callback(_this3.read());
         } else {
           callback(routeState);
         }
       };
 
-      window.addEventListener('popstate', this._onPopState);
+      (0, _utils.safelyRunOnBrowser)(function (_ref3) {
+        var window = _ref3.window;
+        window.addEventListener('popstate', _this3._onPopState);
+      });
     }
     /**
      * Creates a complete URL from a given syncable UI state.
@@ -133,7 +162,7 @@ var BrowserHistory = /*#__PURE__*/function () {
       return this._createURL({
         qsModule: _qs.default,
         routeState: routeState,
-        location: window.location
+        location: this.getLocation()
       });
     }
     /**
@@ -143,12 +172,18 @@ var BrowserHistory = /*#__PURE__*/function () {
   }, {
     key: "dispose",
     value: function dispose() {
-      if (this._onPopState) {
-        window.removeEventListener('popstate', this._onPopState);
-      }
+      var _this4 = this;
+
+      (0, _utils.safelyRunOnBrowser)(function (_ref4) {
+        var window = _ref4.window;
+
+        if (_this4._onPopState) {
+          window.removeEventListener('popstate', _this4._onPopState);
+        }
+      });
 
       if (this.writeTimer) {
-        window.clearTimeout(this.writeTimer);
+        clearTimeout(this.writeTimer);
       }
 
       this.write({});
@@ -159,12 +194,12 @@ var BrowserHistory = /*#__PURE__*/function () {
 }();
 
 function historyRouter() {
-  var _ref2 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
-      _ref2$createURL = _ref2.createURL,
-      createURL = _ref2$createURL === void 0 ? function (_ref3) {
-    var qsModule = _ref3.qsModule,
-        routeState = _ref3.routeState,
-        location = _ref3.location;
+  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 protocol = location.protocol,
         hostname = location.hostname,
         _location$port = location.port,
@@ -180,11 +215,11 @@ function historyRouter() {
     }
 
     return "".concat(protocol, "//").concat(hostname).concat(portWithPrefix).concat(pathname, "?").concat(queryString).concat(hash);
-  } : _ref2$createURL,
-      _ref2$parseURL = _ref2.parseURL,
-      parseURL = _ref2$parseURL === void 0 ? function (_ref4) {
-    var qsModule = _ref4.qsModule,
-        location = _ref4.location;
+  } : _ref5$createURL,
+      _ref5$parseURL = _ref5.parseURL,
+      parseURL = _ref5$parseURL === void 0 ? function (_ref7) {
+    var qsModule = _ref7.qsModule,
+        location = _ref7.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
@@ -198,15 +233,27 @@ function historyRouter() {
     return qsModule.parse(location.search.slice(1), {
       arrayLimit: 99
     });
-  } : _ref2$parseURL,
-      _ref2$writeDelay = _ref2.writeDelay,
-      writeDelay = _ref2$writeDelay === void 0 ? 400 : _ref2$writeDelay,
-      windowTitle = _ref2.windowTitle;
+  } : _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, _utils.safelyRunOnBrowser)(function (_ref8) {
+      var window = _ref8.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;
 
   return new BrowserHistory({
     createURL: createURL,
     parseURL: parseURL,
     writeDelay: writeDelay,
-    windowTitle: windowTitle
+    windowTitle: windowTitle,
+    getLocation: getLocation
   });
 }