instantsearch.js 4.32.0 → 4.34.0

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.34.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/cjs/widgets/index/index.js

@@ -289,7 +289,8 @@ var index = function index(widgetParams) {
       return this;
     },
     init: function init(_ref2) {
-      var _this3 = this;
+      var _this3 = this,
+          _instantSearchInstanc;
 
       var instantSearchInstance = _ref2.instantSearchInstance,
           parent = _ref2.parent,
@@ -347,11 +348,21 @@ var index = function index(widgetParams) {
 
       derivedHelper = mainHelper.derive(function () {
         return _utils.mergeSearchParameters.apply(void 0, _toConsumableArray((0, _utils.resolveSearchParameters)(_this3)));
-      }); // Subscribe to the Helper state changes for the page before widgets
+      });
+      var indexInitialResults = (_instantSearchInstanc = instantSearchInstance._initialResults) === null || _instantSearchInstanc === void 0 ? void 0 : _instantSearchInstanc[this.getIndexId()];
+
+      if (indexInitialResults) {
+        // We restore the shape of the results provided to the instance to respect
+        // the helper's structure.
+        var results = new _algoliasearchHelper.default.SearchResults(new _algoliasearchHelper.default.SearchParameters(indexInitialResults.state), indexInitialResults.results);
+        derivedHelper.lastResults = results;
+        helper.lastResults = results;
+      } // Subscribe to the Helper state changes for the page before widgets
       // are initialized. This behavior mimics the original one of the Helper.
       // It makes sense to replicate it at the `init` step. We have another
       // listener on `change` below, once `init` is done.
 
+
       helper.on('change', function (_ref3) {
         var isPageReset = _ref3.isPageReset;
 
@@ -452,6 +463,13 @@ var index = function index(widgetParams) {
           instantSearchInstance.onInternalStateChange();
         }
       });
+
+      if (indexInitialResults) {
+        // If there are initial results, we're not notified of the next results
+        // because we don't trigger an initial search. We therefore need to directly
+        // schedule a render that will render the results injected on the helper.
+        instantSearchInstance.scheduleRender();
+      }
     },
     render: function render(_ref5) {
       var _this4 = this;
@@ -555,7 +573,7 @@ var index = function index(widgetParams) {
       localUiState = getLocalWidgetsUiState(localWidgets, {
         searchParameters: this.getHelper().state,
         helper: this.getHelper()
-      });
+      }, localUiState);
     }
   };
 };

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;
@@ -2183,6 +2194,13 @@ declare type InfiniteHitsWidgetParams = {
     cache?: InfiniteHitsCache;
 };
 
+declare type InitialResult = {
+    state: PlainSearchParameters;
+    results: SearchResults['_rawResults'];
+};
+
+declare type InitialResults = Record<string, InitialResult>;
+
 declare type InitOptions = SharedRenderOptions & {
     uiState: UiState;
     results?: undefined;
@@ -2247,6 +2265,7 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
     _searchStalledTimer: any;
     _isSearchStalled: boolean;
     _initialUiState: UiState;
+    _initialResults: InitialResults | null;
     _createURL: CreateURL<UiState>;
     _searchFunction?: InstantSearchOptions['searchFunction'];
     _mainHelperSearch?: AlgoliaSearchHelper['search'];