instantsearch.js 4.32.0 → 4.34.0

package/es/lib/utils/safelyRunOnBrowser.d.ts

@@ -0,0 +1,14 @@
+declare type BrowserCallback<TReturn> = (params: {
+    window: typeof window;
+}) => TReturn;
+declare type SafelyRunOnBrowserOptions<TReturn> = {
+    /**
+     * Fallback to run on server environments.
+     */
+    fallback: () => TReturn;
+};
+/**
+ * Runs code on browser enviromnents safely.
+ */
+export declare function safelyRunOnBrowser<TReturn>(callback: BrowserCallback<TReturn>, { fallback }?: SafelyRunOnBrowserOptions<TReturn>): TReturn;
+export {};

package/es/lib/utils/safelyRunOnBrowser.js

@@ -0,0 +1,23 @@
+// eslint-disable-next-line no-restricted-globals
+
+/**
+ * Runs code on browser enviromnents safely.
+ */
+export 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/es/lib/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "4.32.0";
+declare const _default: "4.34.0";
 export default _default;

package/es/lib/version.js

@@ -1 +1 @@
-export default '4.32.0';
+export default '4.34.0';

package/es/lib/voiceSearchHelper/index.js

@@ -4,6 +4,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/es/middlewares/createMetadataMiddleware.js

@@ -1,3 +1,5 @@
+import { safelyRunOnBrowser } from '../lib/utils';
+
 function extractPayload(widgets, instantSearchInstance, payload) {
   var parent = instantSearchInstance.mainIndex;
   var initOptions = {
@@ -43,7 +45,14 @@ function extractPayload(widgets, instantSearchInstance, payload) {
 }
 
 export function isMetadataEnabled() {
-  return typeof window !== 'undefined' && window.navigator.userAgent.indexOf('Algolia Crawler') > -1;
+  return 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
@@ -54,8 +63,8 @@ export function isMetadataEnabled() {
  */
 
 export function createMetadataMiddleware() {
-  return function (_ref) {
-    var instantSearchInstance = _ref.instantSearchInstance;
+  return function (_ref2) {
+    var instantSearchInstance = _ref2.instantSearchInstance;
     var payload = {
       widgets: []
     };

package/es/types/results.d.ts

@@ -1,3 +1,4 @@
+import type { PlainSearchParameters, SearchResults } from 'algoliasearch-helper';
 export declare type HitAttributeHighlightResult = {
     value: string;
     matchLevel: 'none' | 'partial' | 'full';
@@ -64,3 +65,9 @@ export declare type NumericRefinement = {
     operator: string;
 };
 export declare type Refinement = FacetRefinement | NumericRefinement;
+declare type InitialResult = {
+    state: PlainSearchParameters;
+    results: SearchResults['_rawResults'];
+};
+export declare type InitialResults = Record<string, InitialResult>;
+export {};

package/es/widgets/index/index.js

@@ -275,7 +275,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,
@@ -333,11 +334,21 @@ var index = function index(widgetParams) {
 
       derivedHelper = mainHelper.derive(function () {
         return mergeSearchParameters.apply(void 0, _toConsumableArray(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.SearchResults(new algoliasearchHelper.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;
 
@@ -438,6 +449,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;
@@ -541,7 +559,7 @@ var index = function index(widgetParams) {
       localUiState = getLocalWidgetsUiState(localWidgets, {
         searchParameters: this.getHelper().state,
         helper: this.getHelper()
-      });
+      }, localUiState);
     }
   };
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "instantsearch.js",
-  "version": "4.32.0",
+  "version": "4.34.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",
@@ -61,10 +61,10 @@
     "hogan.js": "^3.0.2",
     "preact": "^10.0.0",
     "qs": "^6.5.1 < 6.10",
-    "search-insights": "^2.0.5"
+    "search-insights": "^2.1.0"
   },
   "devDependencies": {
-    "@algolia/client-search": "4.10.3",
+    "@algolia/client-search": "4.11.0",
     "@babel/cli": "7.8.4",
     "@babel/core": "7.9.6",
     "@babel/plugin-proposal-class-properties": "7.8.3",
@@ -95,7 +95,7 @@
     "@wdio/selenium-standalone-service": "5.16.5",
     "@wdio/spec-reporter": "5.16.5",
     "@wdio/static-server-service": "5.16.5",
-    "algoliasearch": "4.10.3",
+    "algoliasearch": "4.11.0",
     "algoliasearch-v3": "npm:algoliasearch@3.35.1",
     "babel-eslint": "10.0.3",
     "babel-jest": "27.1.0",
@@ -150,7 +150,7 @@
   "bundlesize": [
     {
       "path": "./dist/instantsearch.production.min.js",
-      "maxSize": "69 kB"
+      "maxSize": "69.50 kB"
     },
     {
       "path": "./dist/instantsearch.development.js",