instantsearch.js 4.32.0 → 4.33.0

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+# [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/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/lib/InstantSearch.js

@@ -522,15 +522,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
   });
 }

package/cjs/lib/utils/detect-insights-client.js

@@ -5,6 +5,15 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = hasDetectedInsightsClient;
 
+var _safelyRunOnBrowser = require("./safelyRunOnBrowser");
+
 function hasDetectedInsightsClient() {
-  return typeof window !== 'undefined' && Boolean(window.AlgoliaAnalyticsObject);
+  return (0, _safelyRunOnBrowser.safelyRunOnBrowser)(function (_ref) {
+    var window = _ref.window;
+    return Boolean(window.AlgoliaAnalyticsObject);
+  }, {
+    fallback: function fallback() {
+      return false;
+    }
+  });
 }

package/cjs/lib/utils/index.js

@@ -55,7 +55,8 @@ var _exportNames = {
   debounce: true,
   serializePayload: true,
   deserializePayload: true,
-  getWidgetAttribute: true
+  getWidgetAttribute: true,
+  safelyRunOnBrowser: true
 };
 Object.defineProperty(exports, "capitalize", {
   enumerable: true,
@@ -369,6 +370,12 @@ Object.defineProperty(exports, "getWidgetAttribute", {
     return _getWidgetAttribute.getWidgetAttribute;
   }
 });
+Object.defineProperty(exports, "safelyRunOnBrowser", {
+  enumerable: true,
+  get: function get() {
+    return _safelyRunOnBrowser.safelyRunOnBrowser;
+  }
+});
 
 var _capitalize = _interopRequireDefault(require("./capitalize"));
 
@@ -488,4 +495,6 @@ var _serializer = require("./serializer");
 
 var _getWidgetAttribute = require("./getWidgetAttribute");
 
+var _safelyRunOnBrowser = require("./safelyRunOnBrowser");
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

package/cjs/lib/utils/safelyRunOnBrowser.js

@@ -0,0 +1,30 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.safelyRunOnBrowser = safelyRunOnBrowser;
+
+// eslint-disable-next-line no-restricted-globals
+
+/**
+ * Runs code on browser enviromnents safely.
+ */
+function safelyRunOnBrowser(callback) {
+  var _ref = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {
+    fallback: function fallback() {
+      return undefined;
+    }
+  },
+      fallback = _ref.fallback;
+
+  // eslint-disable-next-line no-restricted-globals
+  if (typeof window === 'undefined') {
+    return fallback();
+  } // eslint-disable-next-line no-restricted-globals
+
+
+  return callback({
+    window: window
+  });
+}

package/cjs/lib/version.js

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

package/cjs/lib/voiceSearchHelper/index.js

@@ -11,6 +11,11 @@ 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; }
 
+// `SpeechRecognition` is an API used on the browser so we can safely disable
+// the `window` check.
+
+/* eslint-disable no-restricted-globals */
+
 /* global SpeechRecognition SpeechRecognitionEvent */
 var createVoiceSearchHelper = function createVoiceSearchHelper(_ref) {
   var searchAsYouSpeak = _ref.searchAsYouSpeak,

package/cjs/middlewares/createMetadataMiddleware.js

@@ -6,6 +6,8 @@ Object.defineProperty(exports, "__esModule", {
 exports.isMetadataEnabled = isMetadataEnabled;
 exports.createMetadataMiddleware = createMetadataMiddleware;
 
+var _utils = require("../lib/utils");
+
 function extractPayload(widgets, instantSearchInstance, payload) {
   var parent = instantSearchInstance.mainIndex;
   var initOptions = {
@@ -51,7 +53,14 @@ function extractPayload(widgets, instantSearchInstance, payload) {
 }
 
 function isMetadataEnabled() {
-  return typeof window !== 'undefined' && window.navigator.userAgent.indexOf('Algolia Crawler') > -1;
+  return (0, _utils.safelyRunOnBrowser)(function (_ref) {
+    var window = _ref.window;
+    return window.navigator.userAgent.indexOf('Algolia Crawler') > -1;
+  }, {
+    fallback: function fallback() {
+      return false;
+    }
+  });
 }
 /**
  * Exposes the metadata of mounted widgets in a custom
@@ -63,8 +72,8 @@ function isMetadataEnabled() {
 
 
 function createMetadataMiddleware() {
-  return function (_ref) {
-    var instantSearchInstance = _ref.instantSearchInstance;
+  return function (_ref2) {
+    var instantSearchInstance = _ref2.instantSearchInstance;
     var payload = {
       widgets: []
     };

package/dist/instantsearch.development.d.ts

@@ -455,13 +455,23 @@ declare class BrowserHistory<TRouteState> implements Router<TRouteState> {
      * It should be symmetrical to `createURL`.
      */
     private readonly parseURL;
+    /**
+     * Returns the location to store in the history.
+     * @default () => window.location
+     */
+    private readonly getLocation;
     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
+     */
+    private shouldPushState;
     /**
      * 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, }: BrowserHistoryArgs<TRouteState>);
+    constructor({ windowTitle, writeDelay, createURL, parseURL, getLocation, }: BrowserHistoryArgs<TRouteState>);
     /**
      * Reads the URL and returns a syncable UI search state.
      */
@@ -494,6 +504,7 @@ declare type BrowserHistoryArgs<TRouteState> = {
     writeDelay: number;
     createURL: CreateURL_2<TRouteState>;
     parseURL: ParseURL<TRouteState>;
+    getLocation(): Location;
 };
 
 declare type BuiltInBindEventForHits = (eventType: string, hits: Hit | Hits, eventName?: string) => string;
@@ -1723,7 +1734,7 @@ declare type HighlightOptions = {
     }>;
 };
 
-declare function historyRouter<TRouteState = UiState>({ createURL, parseURL, writeDelay, windowTitle, }?: Partial<BrowserHistoryArgs<TRouteState>>): BrowserHistory<TRouteState>;
+declare function historyRouter<TRouteState = UiState>({ createURL, parseURL, writeDelay, windowTitle, getLocation, }?: Partial<BrowserHistoryArgs<TRouteState>>): BrowserHistory<TRouteState>;
 
 declare type Hit = {
     __position: number;