instantsearch.js 4.50.3 → 4.51.0

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

@@ -9,12 +9,15 @@ type ParseURL<TRouteState> = (args: {
     qsModule: typeof qs;
     location: Location;
 }) => TRouteState;
-type BrowserHistoryArgs<TRouteState> = {
+export type BrowserHistoryArgs<TRouteState> = {
     windowTitle?: (routeState: TRouteState) => string;
     writeDelay: number;
     createURL: CreateURL<TRouteState>;
     parseURL: ParseURL<TRouteState>;
     getLocation(): Location;
+    start?: (onUpdate: () => void) => void;
+    dispose?: () => void;
+    push?: (url: string) => void;
 };
 declare class BrowserHistory<TRouteState> implements Router<TRouteState> {
     /**
@@ -61,11 +64,14 @@ declare class BrowserHistory<TRouteState> implements Router<TRouteState> {
      * and thus to prevent the `write` method from calling `pushState`.
      */
     private latestAcknowledgedHistory;
+    private _start?;
+    private _dispose?;
+    private _push?;
     /**
      * Initializes a new storage provider that syncs the search state to the URL
      * using web APIs (`window.location.pushState` and `onpopstate` event).
      */
-    constructor({ windowTitle, writeDelay, createURL, parseURL, getLocation, }: BrowserHistoryArgs<TRouteState>);
+    constructor({ windowTitle, writeDelay, createURL, parseURL, getLocation, start, dispose, push, }: BrowserHistoryArgs<TRouteState>);
     /**
      * Reads the URL and returns a syncable UI search state.
      */
@@ -93,5 +99,5 @@ declare class BrowserHistory<TRouteState> implements Router<TRouteState> {
     dispose(): void;
     private shouldWrite;
 }
-export default function historyRouter<TRouteState = UiState>({ createURL, parseURL, writeDelay, windowTitle, getLocation, }?: Partial<BrowserHistoryArgs<TRouteState>>): BrowserHistory<TRouteState>;
+export default function historyRouter<TRouteState = UiState>({ createURL, parseURL, writeDelay, windowTitle, getLocation, start, dispose, push, }?: Partial<BrowserHistoryArgs<TRouteState>>): BrowserHistory<TRouteState>;
 export {};

package/es/lib/routers/history.js

@@ -26,7 +26,10 @@ var BrowserHistory = /*#__PURE__*/function () {
       writeDelay = _ref$writeDelay === void 0 ? 400 : _ref$writeDelay,
       createURL = _ref.createURL,
       parseURL = _ref.parseURL,
-      getLocation = _ref.getLocation;
+      getLocation = _ref.getLocation,
+      start = _ref.start,
+      dispose = _ref.dispose,
+      push = _ref.push;
     _classCallCheck(this, BrowserHistory);
     _defineProperty(this, "windowTitle", void 0);
     _defineProperty(this, "writeDelay", void 0);
@@ -37,12 +40,18 @@ var BrowserHistory = /*#__PURE__*/function () {
     _defineProperty(this, "inPopState", false);
     _defineProperty(this, "isDisposed", false);
     _defineProperty(this, "latestAcknowledgedHistory", 0);
+    _defineProperty(this, "_start", void 0);
+    _defineProperty(this, "_dispose", void 0);
+    _defineProperty(this, "_push", void 0);
     this.windowTitle = windowTitle;
     this.writeTimer = undefined;
     this.writeDelay = writeDelay;
     this._createURL = createURL;
     this.parseURL = parseURL;
     this.getLocation = getLocation;
+    this._start = start;
+    this._dispose = dispose;
+    this._push = push;
     safelyRunOnBrowser(function (_ref2) {
       var window = _ref2.window;
       var title = _this.windowTitle && _this.windowTitle(_this.read());
@@ -80,7 +89,11 @@ var BrowserHistory = /*#__PURE__*/function () {
         _this2.writeTimer = setTimeout(function () {
           setWindowTitle(title);
           if (_this2.shouldWrite(url)) {
-            window.history.pushState(routeState, title || '', url);
+            if (_this2._push) {
+              _this2._push(url);
+            } else {
+              window.history.pushState(routeState, title || '', url);
+            }
             _this2.latestAcknowledgedHistory = window.history.length;
           }
           _this2.inPopState = false;
@@ -97,6 +110,11 @@ var BrowserHistory = /*#__PURE__*/function () {
     key: "onUpdate",
     value: function onUpdate(callback) {
       var _this3 = this;
+      if (this._start) {
+        this._start(function () {
+          callback(_this3.read());
+        });
+      }
       this._onPopState = function () {
         if (_this3.writeTimer) {
           clearTimeout(_this3.writeTimer);
@@ -138,6 +156,9 @@ var BrowserHistory = /*#__PURE__*/function () {
     key: "dispose",
     value: function dispose() {
       var _this4 = this;
+      if (this._dispose) {
+        this._dispose();
+      }
       this.isDisposed = true;
       safelyRunOnBrowser(function (_ref5) {
         var window = _ref5.window;
@@ -229,12 +250,18 @@ export default function historyRouter() {
           throw new Error('You need to provide `getLocation` to the `history` router in environments where `window` does not exist.');
         }
       });
-    } : _ref7$getLocation;
+    } : _ref7$getLocation,
+    start = _ref7.start,
+    dispose = _ref7.dispose,
+    push = _ref7.push;
   return new BrowserHistory({
     createURL: createURL,
     parseURL: parseURL,
     writeDelay: writeDelay,
     windowTitle: windowTitle,
-    getLocation: getLocation
+    getLocation: getLocation,
+    start: start,
+    dispose: dispose,
+    push: push
   });
 }

package/es/lib/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "4.50.3";
+declare const _default: "4.51.0";
 export default _default;

package/es/lib/version.js

@@ -1 +1 @@
-export default '4.50.3';
+export default '4.51.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "instantsearch.js",
-  "version": "4.50.3",
+  "version": "4.51.0",
   "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",
@@ -55,9 +55,9 @@
     "version": "./scripts/version/update-version.js"
   },
   "devDependencies": {
-    "@instantsearch/mocks": "1.4.0",
-    "@instantsearch/tests": "1.4.0",
-    "@instantsearch/testutils": "1.0.7",
+    "@instantsearch/mocks": "1.5.0",
+    "@instantsearch/tests": "1.5.0",
+    "@instantsearch/testutils": "1.0.8",
     "@storybook/html": "5.3.9",
     "@types/scriptjs": "0.0.2",
     "algoliasearch": "4.14.3",
@@ -65,5 +65,5 @@
     "scriptjs": "2.5.9",
     "webpack": "4.41.5"
   },
-  "gitHead": "cbcf03650d0bda8dd4f57f50e6c7e890e38c352a"
+  "gitHead": "dbe09ac288e92ef1b277b5e6aea79fce1029d452"
 }