instantsearch.js 4.69.0 → 4.70.0

package/es/lib/InstantSearch.js

@@ -21,7 +21,7 @@ import { createMetadataMiddleware, isMetadataEnabled } from "../middlewares/crea
 import { createRouterMiddleware } from "../middlewares/createRouterMiddleware.js";
 import index from "../widgets/index/index.js";
 import createHelpers from "./createHelpers.js";
-import { createDocumentationMessageGenerator, createDocumentationLink, defer, hydrateSearchClient, noop, warning, setIndexHelperState, isIndexWidget } from "./utils/index.js";
+import { createDocumentationMessageGenerator, createDocumentationLink, defer, hydrateRecommendCache, hydrateSearchClient, noop, warning, setIndexHelperState, isIndexWidget } from "./utils/index.js";
 import version from "./version.js";
 var withUsage = createDocumentationMessageGenerator({
   name: 'instantsearch'
@@ -459,6 +459,7 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
       });
       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

package/es/lib/server.d.ts

@@ -3,7 +3,7 @@ import type { IndexWidget, InitialResults, InstantSearch, SearchOptions } from '
  * Waits for the results from the search instance to coordinate the next steps
  * in `getServerState()`.
  */
-export declare function waitForResults(search: InstantSearch): Promise<SearchOptions[]>;
+export declare function waitForResults(search: InstantSearch, skipRecommend?: boolean): Promise<SearchOptions[]>;
 /**
  * Walks the InstantSearch root index to construct the initial results.
  */

package/es/lib/server.js

@@ -10,13 +10,14 @@ import { walkIndex } from "./utils/index.js";
  * in `getServerState()`.
  */
 export 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;
@@ -24,13 +25,25 @@ export 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
@@ -61,15 +74,21 @@ requestParamsList) {
   var initialResults = {};
   var requestParamsIndex = 0;
   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/es/lib/utils/addWidgetId.d.ts

@@ -1,2 +1,3 @@
 import type { Widget } from '../../types';
 export declare function addWidgetId(widget: Widget): void;
+export declare function resetWidgetId(): void;

package/es/lib/utils/addWidgetId.js

@@ -4,4 +4,7 @@ export function addWidgetId(widget) {
     return;
   }
   widget.$$id = id++;
+}
+export function resetWidgetId() {
+  id = 0;
 }

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

@@ -0,0 +1,3 @@
+import type { InitialResults } from '../../types';
+import type { AlgoliaSearchHelper } from 'algoliasearch-helper';
+export declare function hydrateRecommendCache(helper: AlgoliaSearchHelper, initialResults: InitialResults): void;

package/es/lib/utils/hydrateRecommendCache.js

@@ -0,0 +1,17 @@
+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); }
+export 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/es/lib/utils/hydrateSearchClient.js

@@ -27,16 +27,20 @@ export 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/es/lib/utils/index.d.ts

@@ -1,3 +1,4 @@
+export * from './addWidgetId';
 export * from './capitalize';
 export * from './checkIndexUiState';
 export * from './checkRendering';
@@ -27,6 +28,7 @@ export * from './getRefinements';
 export * from './getWidgetAttribute';
 export * from './hits-absolute-position';
 export * from './hits-query-id';
+export * from './hydrateRecommendCache';
 export * from './hydrateSearchClient';
 export * from './isDomElement';
 export * from './isEqual';

package/es/lib/utils/index.js

@@ -1,3 +1,4 @@
+export * from "./addWidgetId.js";
 export * from "./capitalize.js";
 export * from "./checkIndexUiState.js";
 export * from "./checkRendering.js";
@@ -27,6 +28,7 @@ export * from "./getRefinements.js";
 export * from "./getWidgetAttribute.js";
 export * from "./hits-absolute-position.js";
 export * from "./hits-query-id.js";
+export * from "./hydrateRecommendCache.js";
 export * from "./hydrateSearchClient.js";
 export * from "./isDomElement.js";
 export * from "./isEqual.js";

package/es/lib/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "4.69.0";
+declare const _default: "4.70.0";
 export default _default;

package/es/lib/version.js

@@ -1 +1 @@
-export default '4.69.0';
+export default '4.70.0';

package/es/types/results.d.ts

@@ -1,5 +1,5 @@
 import type { SearchOptions } from './algoliasearch';
-import type { PlainSearchParameters, SearchForFacetValues, SearchResults } from 'algoliasearch-helper';
+import type { PlainSearchParameters, RecommendParametersOptions, RecommendResults, SearchForFacetValues, SearchResults } from 'algoliasearch-helper';
 export type HitAttributeHighlightResult = {
     value: string;
     matchLevel: 'none' | 'partial' | 'full';
@@ -65,8 +65,12 @@ export type NumericRefinement = {
 };
 export type Refinement = FacetRefinement | NumericRefinement;
 type InitialResult = {
-    state: PlainSearchParameters;
-    results: SearchResults['_rawResults'];
+    state?: PlainSearchParameters;
+    results?: SearchResults['_rawResults'];
+    recommendResults?: {
+        params: RecommendParametersOptions['params'];
+        results: RecommendResults['_rawResults'];
+    };
     requestParams?: SearchOptions;
 };
 export type InitialResults = Record<string, InitialResult>;

package/es/widgets/index/index.js

@@ -396,13 +396,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.SearchResults(new algoliasearchHelper.SearchParameters(indexInitialResults.state), indexInitialResults.results);
         derivedHelper.lastResults = results;
         helper.lastResults = results;
       }
+      if (indexInitialResults !== null && indexInitialResults !== void 0 && indexInitialResults.recommendResults) {
+        var recommendResults = new algoliasearchHelper.RecommendResults(new algoliasearchHelper.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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "instantsearch.js",
-  "version": "4.69.0",
+  "version": "4.70.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",
@@ -31,7 +31,7 @@
     "@types/google.maps": "^3.45.3",
     "@types/hogan.js": "^3.0.0",
     "@types/qs": "^6.5.3",
-    "algoliasearch-helper": "3.20.0",
+    "algoliasearch-helper": "3.21.0",
     "hogan.js": "^3.0.2",
     "htm": "^3.0.0",
     "instantsearch-ui-components": "0.6.0",
@@ -56,9 +56,9 @@
     "watch:es": "yarn --silent build:es:base --watch"
   },
   "devDependencies": {
-    "@instantsearch/mocks": "1.44.0",
-    "@instantsearch/tests": "1.44.0",
-    "@instantsearch/testutils": "1.33.0",
+    "@instantsearch/mocks": "1.45.0",
+    "@instantsearch/tests": "1.45.0",
+    "@instantsearch/testutils": "1.34.0",
     "@storybook/html": "5.3.9",
     "@types/scriptjs": "0.0.2",
     "algoliasearch": "4.23.2",
@@ -66,5 +66,5 @@
     "scriptjs": "2.5.9",
     "webpack": "4.47.0"
   },
-  "gitHead": "95ec6c4ce746c77eeb92fab1e42b5f833f3f04bc"
+  "gitHead": "5bf02d0f65e6e1fc70265319dbad660696d8ba81"
 }