instantsearch.js 4.68.0 → 4.69.0

package/es/connectors/frequently-bought-together/connectFrequentlyBoughtTogether.d.ts

@@ -0,0 +1,45 @@
+import type { Connector, TransformItems, Hit, BaseHit } from '../../types';
+import type { PlainSearchParameters, RecommendResultItem } from 'algoliasearch-helper';
+export type FrequentlyBoughtTogetherRenderState<THit extends BaseHit = BaseHit> = {
+    /**
+     * The matched recommendations from Algolia API.
+     */
+    items: Array<Hit<THit>>;
+};
+export type FrequentlyBoughtTogetherConnectorParams<THit extends BaseHit = BaseHit> = {
+    /**
+     * The objectIDs of the items to get the frequently bought together items for.
+     */
+    objectIDs: string[];
+    /**
+     * Threshold for the recommendations confidence score (between 0 and 100). Only recommendations with a greater score are returned.
+     */
+    threshold?: number;
+    /**
+     * The maximum number of recommendations to return.
+     */
+    limit?: number;
+    /**
+     * Parameters to pass to the request.
+     */
+    queryParameters?: Omit<PlainSearchParameters, 'page' | 'hitsPerPage' | 'offset' | 'length'>;
+    /**
+     * Whether to escape HTML tags from items string values.
+     *
+     * @default true
+     */
+    escapeHTML?: boolean;
+    /**
+     * Function to transform the items passed to the templates.
+     */
+    transformItems?: TransformItems<Hit<THit>, {
+        results: RecommendResultItem;
+    }>;
+};
+export type FrequentlyBoughtTogetherWidgetDescription<THit extends BaseHit = BaseHit> = {
+    $$type: 'ais.frequentlyBoughtTogether';
+    renderState: FrequentlyBoughtTogetherRenderState<THit>;
+};
+export type FrequentlyBoughtTogetherConnector<THit extends BaseHit = BaseHit> = Connector<FrequentlyBoughtTogetherWidgetDescription<THit>, FrequentlyBoughtTogetherConnectorParams<THit>>;
+declare const connectFrequentlyBoughtTogether: FrequentlyBoughtTogetherConnector;
+export default connectFrequentlyBoughtTogether;

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

@@ -0,0 +1,86 @@
+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); }
+import { createDocumentationMessageGenerator, checkRendering, noop, escapeHits, TAG_PLACEHOLDER } from "../../lib/utils/index.js";
+var withUsage = createDocumentationMessageGenerator({
+  name: 'frequently-bought-together',
+  connector: true
+});
+var connectFrequentlyBoughtTogether = function connectFrequentlyBoughtTogether(renderFn) {
+  var unmountFn = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : noop;
+  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 = 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 ? TAG_PLACEHOLDER : {}),
+            $$id: _this.$$id
+          });
+        }, state.removeParams(this.$$id));
+      }
+    };
+  };
+};
+export default connectFrequentlyBoughtTogether;

package/es/connectors/index.d.ts

@@ -17,11 +17,13 @@ export { default as connectNumericMenu } from './numeric-menu/connectNumericMenu
 export { default as connectPagination } from './pagination/connectPagination';
 export { default as connectRange } from './range/connectRange';
 export { default as connectRefinementList } from './refinement-list/connectRefinementList';
+export { default as connectRelatedProducts } from './related-products/connectRelatedProducts';
 export { default as connectSearchBox } from './search-box/connectSearchBox';
 export { default as connectSortBy } from './sort-by/connectSortBy';
 export { default as connectRatingMenu } from './rating-menu/connectRatingMenu';
 export { default as connectStats } from './stats/connectStats';
 export { default as connectToggleRefinement } from './toggle-refinement/connectToggleRefinement';
+export { default as connectTrendingItems } from './trending-items/connectTrendingItems';
 export { default as connectBreadcrumb } from './breadcrumb/connectBreadcrumb';
 export { default as connectGeoSearch } from './geo-search/connectGeoSearch';
 export { default as connectPoweredBy } from './powered-by/connectPoweredBy';
@@ -31,3 +33,5 @@ export { default as connectAutocomplete } from './autocomplete/connectAutocomple
 export { default as connectQueryRules } from './query-rules/connectQueryRules';
 export { default as connectVoiceSearch } from './voice-search/connectVoiceSearch';
 export { default as connectRelevantSort } from './relevant-sort/connectRelevantSort';
+export { default as connectFrequentlyBoughtTogether } from './frequently-bought-together/connectFrequentlyBoughtTogether';
+export { default as connectLookingSimilar } from './looking-similar/connectLookingSimilar';

package/es/connectors/index.js

@@ -21,11 +21,13 @@ export { default as connectNumericMenu } from "./numeric-menu/connectNumericMenu
 export { default as connectPagination } from "./pagination/connectPagination.js";
 export { default as connectRange } from "./range/connectRange.js";
 export { default as connectRefinementList } from "./refinement-list/connectRefinementList.js";
+export { default as connectRelatedProducts } from "./related-products/connectRelatedProducts.js";
 export { default as connectSearchBox } from "./search-box/connectSearchBox.js";
 export { default as connectSortBy } from "./sort-by/connectSortBy.js";
 export { default as connectRatingMenu } from "./rating-menu/connectRatingMenu.js";
 export { default as connectStats } from "./stats/connectStats.js";
 export { default as connectToggleRefinement } from "./toggle-refinement/connectToggleRefinement.js";
+export { default as connectTrendingItems } from "./trending-items/connectTrendingItems.js";
 export { default as connectBreadcrumb } from "./breadcrumb/connectBreadcrumb.js";
 export { default as connectGeoSearch } from "./geo-search/connectGeoSearch.js";
 export { default as connectPoweredBy } from "./powered-by/connectPoweredBy.js";
@@ -34,4 +36,6 @@ export { default as EXPERIMENTAL_connectConfigureRelatedItems } from "./configur
 export { default as connectAutocomplete } from "./autocomplete/connectAutocomplete.js";
 export { default as connectQueryRules } from "./query-rules/connectQueryRules.js";
 export { default as connectVoiceSearch } from "./voice-search/connectVoiceSearch.js";
-export { default as connectRelevantSort } from "./relevant-sort/connectRelevantSort.js";
+export { default as connectRelevantSort } from "./relevant-sort/connectRelevantSort.js";
+export { default as connectFrequentlyBoughtTogether } from "./frequently-bought-together/connectFrequentlyBoughtTogether.js";
+export { default as connectLookingSimilar } from "./looking-similar/connectLookingSimilar.js";

package/es/connectors/looking-similar/connectLookingSimilar.d.ts

@@ -0,0 +1,49 @@
+import type { Connector, TransformItems, Hit, BaseHit } from '../../types';
+import type { PlainSearchParameters, RecommendResultItem } from 'algoliasearch-helper';
+export type LookingSimilarRenderState<THit extends BaseHit = BaseHit> = {
+    /**
+     * The matched recommendations from the Algolia API.
+     */
+    items: Array<Hit<THit>>;
+};
+export type LookingSimilarConnectorParams<THit extends BaseHit = BaseHit> = {
+    /**
+     * The `objectIDs` of the items to get similar looking products from.
+     */
+    objectIDs: string[];
+    /**
+     * The number of recommendations to retrieve.
+     */
+    limit?: number;
+    /**
+     * The threshold for the recommendations confidence score (between 0 and 100).
+     */
+    threshold?: number;
+    /**
+     * List of search parameters to send.
+     */
+    fallbackParameters?: Omit<PlainSearchParameters, 'page' | 'hitsPerPage' | 'offset' | 'length'>;
+    /**
+     * List of search parameters to send.
+     */
+    queryParameters?: Omit<PlainSearchParameters, 'page' | 'hitsPerPage' | 'offset' | 'length'>;
+    /**
+     * Whether to escape HTML tags from items string values.
+     *
+     * @default true
+     */
+    escapeHTML?: boolean;
+    /**
+     * Function to transform the items passed to the templates.
+     */
+    transformItems?: TransformItems<Hit<THit>, {
+        results: RecommendResultItem;
+    }>;
+};
+export type LookingSimilarWidgetDescription<THit extends BaseHit = BaseHit> = {
+    $$type: 'ais.lookingSimilar';
+    renderState: LookingSimilarRenderState<THit>;
+};
+export type LookingSimilarConnector<THit extends BaseHit = BaseHit> = Connector<LookingSimilarWidgetDescription<THit>, LookingSimilarConnectorParams<THit>>;
+declare const connectLookingSimilar: LookingSimilarConnector;
+export default connectLookingSimilar;

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

@@ -0,0 +1,87 @@
+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); }
+import { createDocumentationMessageGenerator, checkRendering, noop, escapeHits, TAG_PLACEHOLDER } from "../../lib/utils/index.js";
+var withUsage = createDocumentationMessageGenerator({
+  name: 'looking-similar',
+  connector: true
+});
+var connectLookingSimilar = function connectLookingSimilar(renderFn) {
+  var unmountFn = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : noop;
+  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 = 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 ? TAG_PLACEHOLDER : {}),
+            queryParameters: _objectSpread(_objectSpread({}, queryParameters), escapeHTML ? TAG_PLACEHOLDER : {}),
+            $$id: _this.$$id
+          });
+        }, state.removeParams(this.$$id));
+      }
+    };
+  };
+};
+export default connectLookingSimilar;

package/es/connectors/related-products/connectRelatedProducts.d.ts

@@ -0,0 +1,49 @@
+import type { Connector, TransformItems, Hit, BaseHit } from '../../types';
+import type { PlainSearchParameters, RecommendResultItem } from 'algoliasearch-helper';
+export type RelatedProductsRenderState<THit extends BaseHit = BaseHit> = {
+    /**
+     * The matched recommendations from the Algolia API.
+     */
+    items: Array<Hit<THit>>;
+};
+export type RelatedProductsConnectorParams<THit extends BaseHit = BaseHit> = {
+    /**
+     * The `objectIDs` of the items to get related products from.
+     */
+    objectIDs: string[];
+    /**
+     * The number of recommendations to retrieve.
+     */
+    limit?: number;
+    /**
+     * The threshold for the recommendations confidence score (between 0 and 100).
+     */
+    threshold?: number;
+    /**
+     * List of search parameters to send.
+     */
+    fallbackParameters?: Omit<PlainSearchParameters, 'page' | 'hitsPerPage' | 'offset' | 'length'>;
+    /**
+     * List of search parameters to send.
+     */
+    queryParameters?: Omit<PlainSearchParameters, 'page' | 'hitsPerPage' | 'offset' | 'length'>;
+    /**
+     * Whether to escape HTML tags from items string values.
+     *
+     * @default true
+     */
+    escapeHTML?: boolean;
+    /**
+     * Function to transform the items passed to the templates.
+     */
+    transformItems?: TransformItems<Hit<THit>, {
+        results: RecommendResultItem;
+    }>;
+};
+export type RelatedProductsWidgetDescription<THit extends BaseHit = BaseHit> = {
+    $$type: 'ais.relatedProducts';
+    renderState: RelatedProductsRenderState<THit>;
+};
+export type RelatedProductsConnector<THit extends BaseHit = BaseHit> = Connector<RelatedProductsWidgetDescription<THit>, RelatedProductsConnectorParams<THit>>;
+declare const connectRelatedProducts: RelatedProductsConnector;
+export default connectRelatedProducts;

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

@@ -0,0 +1,87 @@
+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); }
+import { createDocumentationMessageGenerator, checkRendering, noop, escapeHits, TAG_PLACEHOLDER } from "../../lib/utils/index.js";
+var withUsage = createDocumentationMessageGenerator({
+  name: 'related-products',
+  connector: true
+});
+var connectRelatedProducts = function connectRelatedProducts(renderFn) {
+  var unmountFn = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : noop;
+  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 = 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 ? TAG_PLACEHOLDER : {}),
+            queryParameters: _objectSpread(_objectSpread({}, queryParameters), escapeHTML ? TAG_PLACEHOLDER : {}),
+            $$id: _this.$$id
+          });
+        }, state.removeParams(this.$$id));
+      }
+    };
+  };
+};
+export default connectRelatedProducts;

package/es/connectors/trending-items/connectTrendingItems.d.ts

@@ -0,0 +1,57 @@
+import type { Connector, TransformItems, Hit, BaseHit } from '../../types';
+import type { PlainSearchParameters, RecommendResultItem } from 'algoliasearch-helper';
+export type TrendingItemsRenderState<THit extends BaseHit = BaseHit> = {
+    /**
+     * The matched recommendations from the Algolia API.
+     */
+    items: Array<Hit<THit>>;
+};
+export type TrendingItemsConnectorParams<THit extends BaseHit = BaseHit> = ({
+    /**
+     * The facet attribute to get recommendations for.
+     */
+    facetName: string;
+    /**
+     * The facet value to get recommendations for.
+     */
+    facetValue: string;
+} | {
+    facetName?: never;
+    facetValue?: never;
+}) & {
+    /**
+     * The number of recommendations to retrieve.
+     */
+    limit?: number;
+    /**
+     * The threshold for the recommendations confidence score (between 0 and 100).
+     */
+    threshold?: number;
+    /**
+     * List of search parameters to send.
+     */
+    fallbackParameters?: Omit<PlainSearchParameters, 'page' | 'hitsPerPage' | 'offset' | 'length'>;
+    /**
+     * List of search parameters to send.
+     */
+    queryParameters?: Omit<PlainSearchParameters, 'page' | 'hitsPerPage' | 'offset' | 'length'>;
+    /**
+     * Whether to escape HTML tags from items string values.
+     *
+     * @default true
+     */
+    escapeHTML?: boolean;
+    /**
+     * Function to transform the items passed to the templates.
+     */
+    transformItems?: TransformItems<Hit<THit>, {
+        results: RecommendResultItem;
+    }>;
+};
+export type TrendingItemsWidgetDescription<THit extends BaseHit = BaseHit> = {
+    $$type: 'ais.trendingItems';
+    renderState: TrendingItemsRenderState<THit>;
+};
+export type TrendingItemsConnector<THit extends BaseHit = BaseHit> = Connector<TrendingItemsWidgetDescription<THit>, TrendingItemsConnectorParams<THit>>;
+declare const connectTrendingItems: TrendingItemsConnector;
+export default connectTrendingItems;

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

@@ -0,0 +1,83 @@
+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); }
+import { createDocumentationMessageGenerator, checkRendering, noop, escapeHits, TAG_PLACEHOLDER } from "../../lib/utils/index.js";
+var withUsage = createDocumentationMessageGenerator({
+  name: 'trending-items',
+  connector: true
+});
+var connectTrendingItems = function connectTrendingItems(renderFn) {
+  var unmountFn = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : noop;
+  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 = 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 ? TAG_PLACEHOLDER : {}),
+          queryParameters: _objectSpread(_objectSpread({}, queryParameters), escapeHTML ? TAG_PLACEHOLDER : {}),
+          $$id: this.$$id
+        });
+      }
+    };
+  };
+};
+export default connectTrendingItems;

package/es/lib/InstantSearch.d.ts

@@ -145,6 +145,8 @@ declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TU
     _createURL: CreateURL<TUiState>;
     _searchFunction?: InstantSearchOptions['searchFunction'];
     _mainHelperSearch?: AlgoliaSearchHelper['search'];
+    _hasSearchWidget: boolean;
+    _hasRecommendWidget: boolean;
     _insights: InstantSearchOptions['insights'];
     middleware: Array<{
         creator: Middleware<TUiState>;

package/es/lib/InstantSearch.js

@@ -74,6 +74,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);
@@ -384,7 +386,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

package/es/lib/templating/renderTemplate.d.ts

@@ -9,4 +9,4 @@ export declare function renderTemplate({ templates, templateKey, compileOptions,
     data?: Record<string, any>;
     bindEvent?: BindEventForHits;
     sendEvent?: SendEventForHits;
-}): string | import("preact").VNode<{}> | import("preact").VNode<{}>[];
+}): string | import("preact").VNode<{}> | import("preact").VNode<{}>[] | null;

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

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

package/es/lib/utils/addWidgetId.js

@@ -0,0 +1,7 @@
+var id = 0;
+export function addWidgetId(widget) {
+  if (widget.dependsOn !== 'recommend') {
+    return;
+  }
+  widget.$$id = id++;
+}