instantsearch.js 4.69.0 → 4.70.0

package/cjs/lib/InstantSearch.js

@@ -467,6 +467,7 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
       });
       if (this._initialResults) {
         (0, _utils.hydrateSearchClient)(this.client, this._initialResults);
+        (0, _utils.hydrateRecommendCache)(this.mainHelper, 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

package/cjs/lib/server.js

@@ -17,13 +17,14 @@ function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input ==
  * in `getServerState()`.
  */
 function waitForResults(search) {
+  var skipRecommend = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
   var helper = search.mainHelper;
 
   // Extract search parameters from the search client to use them
   // later during hydration.
   var requestParamsList;
   var client = helper.getClient();
-  helper.setClient({
+  helper.setClient(_objectSpread(_objectSpread({}, client), {}, {
     search: function search(queries) {
       requestParamsList = queries.map(function (_ref) {
         var params = _ref.params;
@@ -31,13 +32,25 @@ function waitForResults(search) {
       });
       return client.search(queries);
     }
-  });
-  helper.searchOnlyWithDerivedHelpers();
+  }));
+  search._hasSearchWidget && helper.searchOnlyWithDerivedHelpers();
+  !skipRecommend && search._hasRecommendWidget && helper.recommend();
   return new Promise(function (resolve, reject) {
+    var searchResultsReceived = !search._hasSearchWidget;
+    var recommendResultsReceived = !search._hasRecommendWidget || skipRecommend;
     // All derived helpers resolve in the same tick so we're safe only relying
     // on the first one.
     helper.derivedHelpers[0].on('result', function () {
-      resolve(requestParamsList);
+      searchResultsReceived = true;
+      if (recommendResultsReceived) {
+        resolve(requestParamsList);
+      }
+    });
+    helper.derivedHelpers[0].on('recommend:result', function () {
+      recommendResultsReceived = true;
+      if (searchResultsReceived) {
+        resolve(requestParamsList);
+      }
     });
 
     // However, we listen to errors that can happen on any derived helper because
@@ -68,15 +81,21 @@ requestParamsList) {
   var initialResults = {};
   var requestParamsIndex = 0;
   (0, _utils.walkIndex)(rootIndex, function (widget) {
+    var _widget$getHelper;
     var searchResults = widget.getResults();
-    if (searchResults) {
+    var recommendResults = (_widget$getHelper = widget.getHelper()) === null || _widget$getHelper === void 0 ? void 0 : _widget$getHelper.lastRecommendResults;
+    if (searchResults || recommendResults) {
       var requestParams = requestParamsList === null || requestParamsList === void 0 ? void 0 : requestParamsList[requestParamsIndex++];
-      initialResults[widget.getIndexId()] = _objectSpread({
-        // We convert the Helper state to a plain object to pass parsable data
-        // structures from server to client.
+      initialResults[widget.getIndexId()] = _objectSpread(_objectSpread(_objectSpread({}, searchResults && {
         state: _objectSpread({}, searchResults._state),
         results: searchResults._rawResults
-      }, requestParams && {
+      }), recommendResults && {
+        recommendResults: {
+          // We have to stringify + parse because of some explicitly undefined values.
+          params: JSON.parse(JSON.stringify(recommendResults._state.params)),
+          results: recommendResults._rawResults
+        }
+      }), requestParams && {
         requestParams: requestParams
       });
     }

package/cjs/lib/utils/addWidgetId.js

@@ -4,10 +4,14 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.addWidgetId = addWidgetId;
+exports.resetWidgetId = resetWidgetId;
 var id = 0;
 function addWidgetId(widget) {
   if (widget.dependsOn !== 'recommend') {
     return;
   }
   widget.$$id = id++;
+}
+function resetWidgetId() {
+  id = 0;
 }

package/cjs/lib/utils/hydrateRecommendCache.js

@@ -0,0 +1,23 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.hydrateRecommendCache = hydrateRecommendCache;
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+function hydrateRecommendCache(helper, initialResults) {
+  var recommendCache = Object.keys(initialResults).reduce(function (acc, indexName) {
+    var initialResult = initialResults[indexName];
+    if (initialResult.recommendResults) {
+      // @MAJOR: Use `Object.assign` instead of spread operator
+      return _objectSpread(_objectSpread({}, acc), initialResult.recommendResults.results);
+    }
+    return acc;
+  }, {});
+  helper._recommendCache = recommendCache;
+}

package/cjs/lib/utils/hydrateSearchClient.js

@@ -33,16 +33,20 @@ function hydrateSearchClient(client, results) {
       state = _results$key.state,
       requestParams = _results$key.requestParams,
       serverResults = _results$key.results;
-    return serverResults.map(function (result) {
+    return serverResults && state ? serverResults.map(function (result) {
       return _objectSpread({
         indexName: state.index || result.index
       }, requestParams || result.params ? {
         params: serializeQueryParameters(requestParams || deserializeQueryParameters(result.params))
       } : {});
-    });
+    }) : [];
   });
   var cachedResults = Object.keys(results).reduce(function (acc, key) {
-    return acc.concat(results[key].results);
+    var res = results[key].results;
+    if (!res) {
+      return acc;
+    }
+    return acc.concat(res);
   }, []);
 
   // Algoliasearch API Client >= v4

package/cjs/lib/utils/index.js

@@ -3,6 +3,17 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+var _addWidgetId = require("./addWidgetId");
+Object.keys(_addWidgetId).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _addWidgetId[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _addWidgetId[key];
+    }
+  });
+});
 var _capitalize = require("./capitalize");
 Object.keys(_capitalize).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
@@ -322,6 +333,17 @@ Object.keys(_hitsQueryId).forEach(function (key) {
     }
   });
 });
+var _hydrateRecommendCache = require("./hydrateRecommendCache");
+Object.keys(_hydrateRecommendCache).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _hydrateRecommendCache[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _hydrateRecommendCache[key];
+    }
+  });
+});
 var _hydrateSearchClient = require("./hydrateSearchClient");
 Object.keys(_hydrateSearchClient).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;

package/cjs/lib/version.js

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

package/cjs/widgets/index/index.js

@@ -403,13 +403,20 @@ var index = function index(widgetParams) {
         return _this3.getHelper().recommendState;
       });
       var indexInitialResults = (_instantSearchInstanc = instantSearchInstance._initialResults) === null || _instantSearchInstanc === void 0 ? void 0 : _instantSearchInstanc[this.getIndexId()];
-      if (indexInitialResults) {
+      if (indexInitialResults !== null && indexInitialResults !== void 0 && indexInitialResults.results) {
         // 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;
       }
+      if (indexInitialResults !== null && indexInitialResults !== void 0 && indexInitialResults.recommendResults) {
+        var recommendResults = new _algoliasearchHelper.default.RecommendResults(new _algoliasearchHelper.default.RecommendParameters({
+          params: indexInitialResults.recommendResults.params
+        }), indexInitialResults.recommendResults.results);
+        derivedHelper.lastRecommendResults = recommendResults;
+        helper.lastRecommendResults = recommendResults;
+      }
 
       // Subscribe to the Helper state changes for the page before widgets
       // are initialized. This behavior mimics the original one of the Helper.

package/dist/instantsearch.development.d.ts

@@ -19,7 +19,9 @@ import type { PlainSearchParameters } from 'algoliasearch-helper';
 import { default as qs_2 } from 'qs';
 import type { RecommendClassNames } from 'instantsearch-ui-components';
 import type { RecommendParameters } from 'algoliasearch-helper';
+import type { RecommendParametersOptions } from 'algoliasearch-helper';
 import type { RecommendResultItem } from 'algoliasearch-helper';
+import type { RecommendResults } from 'algoliasearch-helper';
 import type { RelatedProductsProps } from 'instantsearch-ui-components';
 import { SearchClient } from 'algoliasearch-helper/types/algoliasearch.js';
 import { SearchOptions } from 'algoliasearch-helper/types/algoliasearch.js';
@@ -2418,8 +2420,12 @@ declare type InfiniteHitsWidgetParams = {
 };
 
 declare type InitialResult = {
-    state: PlainSearchParameters;
-    results: SearchResults['_rawResults'];
+    state?: PlainSearchParameters;
+    results?: SearchResults['_rawResults'];
+    recommendResults?: {
+        params: RecommendParametersOptions['params'];
+        results: RecommendResults['_rawResults'];
+    };
     requestParams?: SearchOptions;
 };
 

package/dist/instantsearch.development.js

@@ -1,10 +1,18 @@
-/*! InstantSearch.js 4.69.0 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch */
+/*! InstantSearch.js 4.70.0 | © Algolia, Inc. and contributors; MIT License | https://github.com/algolia/instantsearch */
 (function (global, factory) {
   typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
   typeof define === 'function' && define.amd ? define(factory) :
   (global = global || self, global.instantsearch = factory());
 }(this, (function () { 'use strict';
 
+  var id = 0;
+  function addWidgetId(widget) {
+    if (widget.dependsOn !== 'recommend') {
+      return;
+    }
+    widget.$$id = id++;
+  }
+
   function capitalize(text) {
     return text.toString().charAt(0).toUpperCase() + text.toString().slice(1);
   }
@@ -1411,6 +1419,18 @@
     });
   }
 
+  function hydrateRecommendCache(helper, initialResults) {
+    var recommendCache = Object.keys(initialResults).reduce(function (acc, indexName) {
+      var initialResult = initialResults[indexName];
+      if (initialResult.recommendResults) {
+        // @MAJOR: Use `Object.assign` instead of spread operator
+        return _objectSpread2(_objectSpread2({}, acc), initialResult.recommendResults.results);
+      }
+      return acc;
+    }, {});
+    helper._recommendCache = recommendCache;
+  }
+
   function hydrateSearchClient(client, results) {
     if (!results) {
       return;
@@ -1428,16 +1448,20 @@
         state = _results$key.state,
         requestParams = _results$key.requestParams,
         serverResults = _results$key.results;
-      return serverResults.map(function (result) {
+      return serverResults && state ? serverResults.map(function (result) {
         return _objectSpread2({
           indexName: state.index || result.index
         }, requestParams || result.params ? {
           params: serializeQueryParameters(requestParams || deserializeQueryParameters(result.params))
         } : {});
-      });
+      }) : [];
     });
     var cachedResults = Object.keys(results).reduce(function (acc, key) {
-      return acc.concat(results[key].results);
+      var res = results[key].results;
+      if (!res) {
+        return acc;
+      }
+      return acc.concat(res);
     }, []);
 
     // Algoliasearch API Client >= v4
@@ -6523,7 +6547,7 @@
    **/
   function RecommendResults(state, results) {
     this._state = state;
-    this._rawResults = results;
+    this._rawResults = {};
 
     // eslint-disable-next-line consistent-this
     var self = this;
@@ -6531,6 +6555,7 @@
     state.params.forEach(function (param) {
       var id = param.$$id;
       self[id] = results[id];
+      self._rawResults[id] = results[id];
     });
   }
 
@@ -10446,7 +10471,7 @@
 
   var sortAndMergeRecommendations_1 = sortAndMergeRecommendations;
 
-  var version = '3.20.0';
+  var version = '3.21.0';
 
   var escapeFacetValue$4 = escapeFacetValue_1.escapeFacetValue;
 
@@ -10587,7 +10612,7 @@
     this._currentNbQueries = 0;
     this._currentNbRecommendQueries = 0;
     this._searchResultsOptions = searchResultsOptions;
-    this.recommendCache = {};
+    this._recommendCache = {};
   }
 
   inherits_1(AlgoliaSearchHelper, events);
@@ -12036,7 +12061,7 @@
       },
     });
 
-    var cache = this.recommendCache;
+    var cache = this._recommendCache;
 
     var derivedQueries = this.derivedHelpers.map(function (derivedHelper) {
       var derivedIndex = derivedHelper.getModifiedState(searchState).index;
@@ -12189,7 +12214,7 @@
 
     if (this._currentNbRecommendQueries === 0) this.emit('recommendQueueEmpty');
 
-    var cache = this.recommendCache;
+    var cache = this._recommendCache;
 
     var idsMap = {};
     ids
@@ -12523,6 +12548,13 @@
    */
   algoliasearchHelper.SearchResults = SearchResults_1;
 
+  /**
+   * Constructor for the object containing the results for Recommend.
+   * @member module:algoliasearchHelper.RecommendResults
+   * @type {RecommendResults}
+   */
+  algoliasearchHelper.RecommendResults = RecommendResults_1;
+
   var algoliasearchHelper_1 = algoliasearchHelper;
 
   /**
@@ -15267,14 +15299,6 @@
     };
   };
 
-  var id = 0;
-  function addWidgetId(widget) {
-    if (widget.dependsOn !== 'recommend') {
-      return;
-    }
-    widget.$$id = id++;
-  }
-
   var _excluded$7 = ["initialSearchParameters"],
     _excluded2$2 = ["initialRecommendParameters"];
   var withUsage$u = createDocumentationMessageGenerator({
@@ -15656,13 +15680,20 @@
           return _this3.getHelper().recommendState;
         });
         var indexInitialResults = (_instantSearchInstanc = instantSearchInstance._initialResults) === null || _instantSearchInstanc === void 0 ? void 0 : _instantSearchInstanc[this.getIndexId()];
-        if (indexInitialResults) {
+        if (indexInitialResults !== null && indexInitialResults !== void 0 && indexInitialResults.results) {
           // We restore the shape of the results provided to the instance to respect
           // the helper's structure.
           var results = new algoliasearchHelper_1.SearchResults(new algoliasearchHelper_1.SearchParameters(indexInitialResults.state), indexInitialResults.results);
           derivedHelper.lastResults = results;
           helper.lastResults = results;
         }
+        if (indexInitialResults !== null && indexInitialResults !== void 0 && indexInitialResults.recommendResults) {
+          var recommendResults = new algoliasearchHelper_1.RecommendResults(new algoliasearchHelper_1.RecommendParameters({
+            params: indexInitialResults.recommendResults.params
+          }), indexInitialResults.recommendResults.results);
+          derivedHelper.lastRecommendResults = recommendResults;
+          helper.lastRecommendResults = recommendResults;
+        }
 
         // Subscribe to the Helper state changes for the page before widgets
         // are initialized. This behavior mimics the original one of the Helper.
@@ -15947,7 +15978,7 @@
     };
   }
 
-  var version$1 = '4.69.0';
+  var version$1 = '4.70.0';
 
   var withUsage$v = createDocumentationMessageGenerator({
     name: 'instantsearch'
@@ -16385,6 +16416,7 @@
         });
         if (this._initialResults) {
           hydrateSearchClient(this.client, this._initialResults);
+          hydrateRecommendCache(this.mainHelper, 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