instantsearch.js 4.68.1 → 4.70.0

package/cjs/connectors/frequently-bought-together/connectFrequentlyBoughtTogether.js

@@ -0,0 +1,93 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _utils = require("../../lib/utils");
+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); }
+var withUsage = (0, _utils.createDocumentationMessageGenerator)({
+  name: 'frequently-bought-together',
+  connector: true
+});
+var connectFrequentlyBoughtTogether = function connectFrequentlyBoughtTogether(renderFn) {
+  var unmountFn = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : _utils.noop;
+  (0, _utils.checkRendering)(renderFn, withUsage());
+  return function (widgetParams) {
+    var _ref = widgetParams || {},
+      _ref$escapeHTML = _ref.escapeHTML,
+      escapeHTML = _ref$escapeHTML === void 0 ? true : _ref$escapeHTML,
+      _ref$transformItems = _ref.transformItems,
+      transformItems = _ref$transformItems === void 0 ? function (items) {
+        return items;
+      } : _ref$transformItems,
+      objectIDs = _ref.objectIDs,
+      limit = _ref.limit,
+      threshold = _ref.threshold,
+      queryParameters = _ref.queryParameters;
+    if (!objectIDs || objectIDs.length === 0) {
+      throw new Error(withUsage('The `objectIDs` option is required.'));
+    }
+    return {
+      dependsOn: 'recommend',
+      $$type: 'ais.frequentlyBoughtTogether',
+      init: function init(initOptions) {
+        renderFn(_objectSpread(_objectSpread({}, this.getWidgetRenderState(initOptions)), {}, {
+          instantSearchInstance: initOptions.instantSearchInstance
+        }), true);
+      },
+      render: function render(renderOptions) {
+        var renderState = this.getWidgetRenderState(renderOptions);
+        renderFn(_objectSpread(_objectSpread({}, renderState), {}, {
+          instantSearchInstance: renderOptions.instantSearchInstance
+        }), false);
+      },
+      getRenderState: function getRenderState(renderState) {
+        return renderState;
+      },
+      getWidgetRenderState: function getWidgetRenderState(_ref2) {
+        var results = _ref2.results;
+        if (results === null || results === undefined) {
+          return {
+            items: [],
+            widgetParams: widgetParams
+          };
+        }
+        if (escapeHTML && results.hits.length > 0) {
+          results.hits = (0, _utils.escapeHits)(results.hits);
+        }
+        var transformedItems = transformItems(results.hits, {
+          results: results
+        });
+        return {
+          items: transformedItems,
+          widgetParams: widgetParams
+        };
+      },
+      dispose: function dispose(_ref3) {
+        var recommendState = _ref3.recommendState;
+        unmountFn();
+        return recommendState.removeParams(this.$$id);
+      },
+      getWidgetParameters: function getWidgetParameters(state) {
+        var _this = this;
+        return objectIDs.reduce(function (acc, objectID) {
+          return acc.addFrequentlyBoughtTogether({
+            objectID: objectID,
+            threshold: threshold,
+            maxRecommendations: limit,
+            queryParameters: _objectSpread(_objectSpread({}, queryParameters), escapeHTML ? _utils.TAG_PLACEHOLDER : {}),
+            $$id: _this.$$id
+          });
+        }, state.removeParams(this.$$id));
+      }
+    };
+  };
+};
+var _default = connectFrequentlyBoughtTogether;
+exports.default = _default;

package/cjs/connectors/index.js

@@ -47,6 +47,12 @@ Object.defineProperty(exports, "connectDynamicWidgets", {
     return _connectDynamicWidgets.default;
   }
 });
+Object.defineProperty(exports, "connectFrequentlyBoughtTogether", {
+  enumerable: true,
+  get: function get() {
+    return _connectFrequentlyBoughtTogether.default;
+  }
+});
 Object.defineProperty(exports, "connectGeoSearch", {
   enumerable: true,
   get: function get() {
@@ -89,6 +95,12 @@ Object.defineProperty(exports, "connectInfiniteHitsWithInsights", {
     return _connectInfiniteHitsWithInsights.default;
   }
 });
+Object.defineProperty(exports, "connectLookingSimilar", {
+  enumerable: true,
+  get: function get() {
+    return _connectLookingSimilar.default;
+  }
+});
 Object.defineProperty(exports, "connectMenu", {
   enumerable: true,
   get: function get() {
@@ -137,6 +149,12 @@ Object.defineProperty(exports, "connectRefinementList", {
     return _connectRefinementList.default;
   }
 });
+Object.defineProperty(exports, "connectRelatedProducts", {
+  enumerable: true,
+  get: function get() {
+    return _connectRelatedProducts.default;
+  }
+});
 Object.defineProperty(exports, "connectRelevantSort", {
   enumerable: true,
   get: function get() {
@@ -167,6 +185,12 @@ Object.defineProperty(exports, "connectToggleRefinement", {
     return _connectToggleRefinement.default;
   }
 });
+Object.defineProperty(exports, "connectTrendingItems", {
+  enumerable: true,
+  get: function get() {
+    return _connectTrendingItems.default;
+  }
+});
 Object.defineProperty(exports, "connectVoiceSearch", {
   enumerable: true,
   get: function get() {
@@ -189,11 +213,13 @@ var _connectNumericMenu = _interopRequireDefault(require("./numeric-menu/connect
 var _connectPagination = _interopRequireDefault(require("./pagination/connectPagination"));
 var _connectRange = _interopRequireDefault(require("./range/connectRange"));
 var _connectRefinementList = _interopRequireDefault(require("./refinement-list/connectRefinementList"));
+var _connectRelatedProducts = _interopRequireDefault(require("./related-products/connectRelatedProducts"));
 var _connectSearchBox = _interopRequireDefault(require("./search-box/connectSearchBox"));
 var _connectSortBy = _interopRequireDefault(require("./sort-by/connectSortBy"));
 var _connectRatingMenu = _interopRequireDefault(require("./rating-menu/connectRatingMenu"));
 var _connectStats = _interopRequireDefault(require("./stats/connectStats"));
 var _connectToggleRefinement = _interopRequireDefault(require("./toggle-refinement/connectToggleRefinement"));
+var _connectTrendingItems = _interopRequireDefault(require("./trending-items/connectTrendingItems"));
 var _connectBreadcrumb = _interopRequireDefault(require("./breadcrumb/connectBreadcrumb"));
 var _connectGeoSearch = _interopRequireDefault(require("./geo-search/connectGeoSearch"));
 var _connectPoweredBy = _interopRequireDefault(require("./powered-by/connectPoweredBy"));
@@ -203,6 +229,8 @@ var _connectAutocomplete = _interopRequireDefault(require("./autocomplete/connec
 var _connectQueryRules = _interopRequireDefault(require("./query-rules/connectQueryRules"));
 var _connectVoiceSearch = _interopRequireDefault(require("./voice-search/connectVoiceSearch"));
 var _connectRelevantSort = _interopRequireDefault(require("./relevant-sort/connectRelevantSort"));
+var _connectFrequentlyBoughtTogether = _interopRequireDefault(require("./frequently-bought-together/connectFrequentlyBoughtTogether"));
+var _connectLookingSimilar = _interopRequireDefault(require("./looking-similar/connectLookingSimilar"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 /** @deprecated answers is no longer supported */
 var EXPERIMENTAL_connectAnswers = (0, _utils.deprecate)(_connectAnswers.default, 'answers is no longer supported');

package/cjs/connectors/looking-similar/connectLookingSimilar.js

@@ -0,0 +1,94 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _utils = require("../../lib/utils");
+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); }
+var withUsage = (0, _utils.createDocumentationMessageGenerator)({
+  name: 'looking-similar',
+  connector: true
+});
+var connectLookingSimilar = function connectLookingSimilar(renderFn) {
+  var unmountFn = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : _utils.noop;
+  (0, _utils.checkRendering)(renderFn, withUsage());
+  return function LookingSimilar(widgetParams) {
+    var _ref = widgetParams || {},
+      _ref$escapeHTML = _ref.escapeHTML,
+      escapeHTML = _ref$escapeHTML === void 0 ? true : _ref$escapeHTML,
+      objectIDs = _ref.objectIDs,
+      limit = _ref.limit,
+      threshold = _ref.threshold,
+      fallbackParameters = _ref.fallbackParameters,
+      queryParameters = _ref.queryParameters,
+      _ref$transformItems = _ref.transformItems,
+      transformItems = _ref$transformItems === void 0 ? function (items) {
+        return items;
+      } : _ref$transformItems;
+    if (!objectIDs || objectIDs.length === 0) {
+      throw new Error(withUsage('The `objectIDs` option is required.'));
+    }
+    return {
+      dependsOn: 'recommend',
+      $$type: 'ais.lookingSimilar',
+      init: function init(initOptions) {
+        renderFn(_objectSpread(_objectSpread({}, this.getWidgetRenderState(initOptions)), {}, {
+          instantSearchInstance: initOptions.instantSearchInstance
+        }), true);
+      },
+      render: function render(renderOptions) {
+        var renderState = this.getWidgetRenderState(renderOptions);
+        renderFn(_objectSpread(_objectSpread({}, renderState), {}, {
+          instantSearchInstance: renderOptions.instantSearchInstance
+        }), false);
+      },
+      getRenderState: function getRenderState(renderState) {
+        return renderState;
+      },
+      getWidgetRenderState: function getWidgetRenderState(_ref2) {
+        var results = _ref2.results;
+        if (results === null || results === undefined) {
+          return {
+            items: [],
+            widgetParams: widgetParams
+          };
+        }
+        if (escapeHTML && results.hits.length > 0) {
+          results.hits = (0, _utils.escapeHits)(results.hits);
+        }
+        return {
+          items: transformItems(results.hits, {
+            results: results
+          }),
+          widgetParams: widgetParams
+        };
+      },
+      dispose: function dispose(_ref3) {
+        var recommendState = _ref3.recommendState;
+        unmountFn();
+        return recommendState.removeParams(this.$$id);
+      },
+      getWidgetParameters: function getWidgetParameters(state) {
+        var _this = this;
+        return objectIDs.reduce(function (acc, objectID) {
+          return acc.addLookingSimilar({
+            objectID: objectID,
+            maxRecommendations: limit,
+            threshold: threshold,
+            fallbackParameters: _objectSpread(_objectSpread({}, fallbackParameters), escapeHTML ? _utils.TAG_PLACEHOLDER : {}),
+            queryParameters: _objectSpread(_objectSpread({}, queryParameters), escapeHTML ? _utils.TAG_PLACEHOLDER : {}),
+            $$id: _this.$$id
+          });
+        }, state.removeParams(this.$$id));
+      }
+    };
+  };
+};
+var _default = connectLookingSimilar;
+exports.default = _default;

package/cjs/connectors/related-products/connectRelatedProducts.js

@@ -0,0 +1,94 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _utils = require("../../lib/utils");
+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); }
+var withUsage = (0, _utils.createDocumentationMessageGenerator)({
+  name: 'related-products',
+  connector: true
+});
+var connectRelatedProducts = function connectRelatedProducts(renderFn) {
+  var unmountFn = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : _utils.noop;
+  (0, _utils.checkRendering)(renderFn, withUsage());
+  return function relatedProducts(widgetParams) {
+    var _ref = widgetParams || {},
+      _ref$escapeHTML = _ref.escapeHTML,
+      escapeHTML = _ref$escapeHTML === void 0 ? true : _ref$escapeHTML,
+      objectIDs = _ref.objectIDs,
+      limit = _ref.limit,
+      threshold = _ref.threshold,
+      fallbackParameters = _ref.fallbackParameters,
+      queryParameters = _ref.queryParameters,
+      _ref$transformItems = _ref.transformItems,
+      transformItems = _ref$transformItems === void 0 ? function (items) {
+        return items;
+      } : _ref$transformItems;
+    if (!objectIDs || objectIDs.length === 0) {
+      throw new Error(withUsage('The `objectIDs` option is required.'));
+    }
+    return {
+      dependsOn: 'recommend',
+      $$type: 'ais.relatedProducts',
+      init: function init(initOptions) {
+        renderFn(_objectSpread(_objectSpread({}, this.getWidgetRenderState(initOptions)), {}, {
+          instantSearchInstance: initOptions.instantSearchInstance
+        }), true);
+      },
+      render: function render(renderOptions) {
+        var renderState = this.getWidgetRenderState(renderOptions);
+        renderFn(_objectSpread(_objectSpread({}, renderState), {}, {
+          instantSearchInstance: renderOptions.instantSearchInstance
+        }), false);
+      },
+      getRenderState: function getRenderState(renderState) {
+        return renderState;
+      },
+      getWidgetRenderState: function getWidgetRenderState(_ref2) {
+        var results = _ref2.results;
+        if (results === null || results === undefined) {
+          return {
+            items: [],
+            widgetParams: widgetParams
+          };
+        }
+        if (escapeHTML && results.hits.length > 0) {
+          results.hits = (0, _utils.escapeHits)(results.hits);
+        }
+        return {
+          items: transformItems(results.hits, {
+            results: results
+          }),
+          widgetParams: widgetParams
+        };
+      },
+      dispose: function dispose(_ref3) {
+        var recommendState = _ref3.recommendState;
+        unmountFn();
+        return recommendState.removeParams(this.$$id);
+      },
+      getWidgetParameters: function getWidgetParameters(state) {
+        var _this = this;
+        return objectIDs.reduce(function (acc, objectID) {
+          return acc.addRelatedProducts({
+            objectID: objectID,
+            maxRecommendations: limit,
+            threshold: threshold,
+            fallbackParameters: _objectSpread(_objectSpread({}, fallbackParameters), escapeHTML ? _utils.TAG_PLACEHOLDER : {}),
+            queryParameters: _objectSpread(_objectSpread({}, queryParameters), escapeHTML ? _utils.TAG_PLACEHOLDER : {}),
+            $$id: _this.$$id
+          });
+        }, state.removeParams(this.$$id));
+      }
+    };
+  };
+};
+var _default = connectRelatedProducts;
+exports.default = _default;

package/cjs/connectors/trending-items/connectTrendingItems.js

@@ -0,0 +1,90 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _utils = require("../../lib/utils");
+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); }
+var withUsage = (0, _utils.createDocumentationMessageGenerator)({
+  name: 'trending-items',
+  connector: true
+});
+var connectTrendingItems = function connectTrendingItems(renderFn) {
+  var unmountFn = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : _utils.noop;
+  (0, _utils.checkRendering)(renderFn, withUsage());
+  return function trendingItems(widgetParams) {
+    var _ref = widgetParams || {},
+      facetName = _ref.facetName,
+      facetValue = _ref.facetValue,
+      limit = _ref.limit,
+      threshold = _ref.threshold,
+      fallbackParameters = _ref.fallbackParameters,
+      queryParameters = _ref.queryParameters,
+      _ref$escapeHTML = _ref.escapeHTML,
+      escapeHTML = _ref$escapeHTML === void 0 ? true : _ref$escapeHTML,
+      _ref$transformItems = _ref.transformItems,
+      transformItems = _ref$transformItems === void 0 ? function (items) {
+        return items;
+      } : _ref$transformItems;
+    return {
+      dependsOn: 'recommend',
+      $$type: 'ais.trendingItems',
+      init: function init(initOptions) {
+        renderFn(_objectSpread(_objectSpread({}, this.getWidgetRenderState(initOptions)), {}, {
+          instantSearchInstance: initOptions.instantSearchInstance
+        }), true);
+      },
+      render: function render(renderOptions) {
+        var renderState = this.getWidgetRenderState(renderOptions);
+        renderFn(_objectSpread(_objectSpread({}, renderState), {}, {
+          instantSearchInstance: renderOptions.instantSearchInstance
+        }), false);
+      },
+      getRenderState: function getRenderState(renderState) {
+        return renderState;
+      },
+      getWidgetRenderState: function getWidgetRenderState(_ref2) {
+        var results = _ref2.results;
+        if (results === null || results === undefined) {
+          return {
+            items: [],
+            widgetParams: widgetParams
+          };
+        }
+        if (escapeHTML && results.hits.length > 0) {
+          results.hits = (0, _utils.escapeHits)(results.hits);
+        }
+        return {
+          items: transformItems(results.hits, {
+            results: results
+          }),
+          widgetParams: widgetParams
+        };
+      },
+      dispose: function dispose(_ref3) {
+        var recommendState = _ref3.recommendState;
+        unmountFn();
+        return recommendState.removeParams(this.$$id);
+      },
+      getWidgetParameters: function getWidgetParameters(state) {
+        return state.removeParams(this.$$id).addTrendingItems({
+          facetName: facetName,
+          facetValue: facetValue,
+          maxRecommendations: limit,
+          threshold: threshold,
+          fallbackParameters: _objectSpread(_objectSpread({}, fallbackParameters), escapeHTML ? _utils.TAG_PLACEHOLDER : {}),
+          queryParameters: _objectSpread(_objectSpread({}, queryParameters), escapeHTML ? _utils.TAG_PLACEHOLDER : {}),
+          $$id: this.$$id
+        });
+      }
+    };
+  };
+};
+var _default = connectTrendingItems;
+exports.default = _default;

package/cjs/lib/InstantSearch.js

@@ -82,6 +82,8 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
     _defineProperty(_assertThisInitialized(_this), "_createURL", void 0);
     _defineProperty(_assertThisInitialized(_this), "_searchFunction", void 0);
     _defineProperty(_assertThisInitialized(_this), "_mainHelperSearch", void 0);
+    _defineProperty(_assertThisInitialized(_this), "_hasSearchWidget", false);
+    _defineProperty(_assertThisInitialized(_this), "_hasRecommendWidget", false);
     _defineProperty(_assertThisInitialized(_this), "_insights", void 0);
     _defineProperty(_assertThisInitialized(_this), "middleware", []);
     _defineProperty(_assertThisInitialized(_this), "sendEventToInsights", void 0);
@@ -392,7 +394,13 @@ var InstantSearch = /*#__PURE__*/function (_EventEmitter) {
         // under the hood, we have a different implementation. It should be
         // completely transparent for the rest of the codebase. Only this module
         // is impacted.
-        return mainHelper.searchOnlyWithDerivedHelpers() && mainHelper.recommend();
+        if (_this3._hasSearchWidget) {
+          mainHelper.searchOnlyWithDerivedHelpers();
+        }
+        if (_this3._hasRecommendWidget) {
+          mainHelper.recommend();
+        }
+        return mainHelper;
       };
       if (this._searchFunction) {
         // this client isn't used to actually search, but required for the helper
@@ -459,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

@@ -0,0 +1,17 @@
+"use strict";
+
+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;