instantsearch.js 4.68.1 → 4.69.0

package/es/lib/utils/render-args.d.ts

@@ -1,4 +1,4 @@
-import type { InstantSearch, UiState } from '../../types';
+import type { InstantSearch, UiState, Widget } from '../../types';
 import type { IndexWidget } from '../../widgets/index/index';
 export declare function createInitArgs(instantSearchInstance: InstantSearch, parent: IndexWidget, uiState: UiState): {
     uiState: UiState;
@@ -126,11 +126,11 @@ export declare function createInitArgs(instantSearchInstance: InstantSearch, par
     status: import("../InstantSearch").InstantSearchStatus;
     error: Error | undefined;
 };
-export declare function createRenderArgs(instantSearchInstance: InstantSearch, parent: IndexWidget): {
+export declare function createRenderArgs(instantSearchInstance: InstantSearch, parent: IndexWidget, widget: IndexWidget | Widget): {
     helper: import("algoliasearch-helper").AlgoliaSearchHelper;
     parent: IndexWidget;
     instantSearchInstance: InstantSearch<UiState, UiState>;
-    results: import("algoliasearch-helper").SearchResults<any>;
+    results: import("algoliasearch-helper").SearchResults<any> | import("algoliasearch-helper").RecommendResultItem;
     scopedResults: import("../../types").ScopedResult[];
     state: import("algoliasearch-helper").SearchParameters;
     renderState: import("../../types").RenderState;

package/es/lib/utils/render-args.js

@@ -17,8 +17,8 @@ export function createInitArgs(instantSearchInstance, parent, uiState) {
     error: instantSearchInstance.error
   };
 }
-export function createRenderArgs(instantSearchInstance, parent) {
-  var results = parent.getResults();
+export function createRenderArgs(instantSearchInstance, parent, widget) {
+  var results = parent.getResultsForWidget(widget);
   var helper = parent.getHelper();
   return {
     helper: helper,
@@ -26,7 +26,7 @@ export function createRenderArgs(instantSearchInstance, parent) {
     instantSearchInstance: instantSearchInstance,
     results: results,
     scopedResults: parent.getScopedResults(),
-    state: results ? results._state : helper.state,
+    state: results && '_state' in results ? results._state : helper.state,
     renderState: instantSearchInstance.renderState,
     templatesConfig: instantSearchInstance.templatesConfig,
     createURL: parent.createURL,

package/es/lib/version.d.ts

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

package/es/lib/version.js

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

package/es/types/templates.d.ts

@@ -2,7 +2,7 @@ import type { Highlight, ReverseHighlight, ReverseSnippet, Snippet } from '../he
 import type { BuiltInBindEventForHits, CustomBindEventForHits, SendEventForHits } from '../lib/utils';
 import type { html } from 'htm/preact';
 import type { VNode } from 'preact';
-export type Template<TTemplateData = void> = string | ((data: TTemplateData, params: TemplateParams) => VNode | VNode[] | string);
+export type Template<TTemplateData = void> = string | ((data: TTemplateData, params: TemplateParams) => VNode | VNode[] | string | null);
 export type TemplateParams = {
     html: typeof html;
     components: {

package/es/types/widget.d.ts

@@ -3,7 +3,7 @@ import type { InstantSearch } from './instantsearch';
 import type { IndexRenderState, WidgetRenderState } from './render-state';
 import type { IndexUiState, UiState } from './ui-state';
 import type { Expand, RequiredKeys } from './utils';
-import type { AlgoliaSearchHelper as Helper, SearchParameters, SearchResults, RecommendParameters } from 'algoliasearch-helper';
+import type { AlgoliaSearchHelper as Helper, SearchParameters, SearchResults, RecommendParameters, RecommendResultItem } from 'algoliasearch-helper';
 export type ScopedResult = {
     indexId: string;
     results: SearchResults;
@@ -39,10 +39,11 @@ export type RenderOptions = SharedRenderOptions & {
 export type DisposeOptions = {
     helper: Helper;
     state: SearchParameters;
+    recommendState: RecommendParameters;
     parent: IndexWidget;
 };
-export type BuiltinTypes = 'ais.analytics' | 'ais.answers' | 'ais.autocomplete' | 'ais.breadcrumb' | 'ais.clearRefinements' | 'ais.configure' | 'ais.configureRelatedItems' | 'ais.currentRefinements' | 'ais.dynamicWidgets' | 'ais.geoSearch' | 'ais.hierarchicalMenu' | 'ais.hits' | 'ais.hitsPerPage' | 'ais.index' | 'ais.infiniteHits' | 'ais.menu' | 'ais.numericMenu' | 'ais.pagination' | 'ais.places' | 'ais.poweredBy' | 'ais.queryRules' | 'ais.range' | 'ais.rangeSlider' | 'ais.rangeInput' | 'ais.ratingMenu' | 'ais.refinementList' | 'ais.searchBox' | 'ais.relevantSort' | 'ais.sortBy' | 'ais.stats' | 'ais.toggleRefinement' | 'ais.voiceSearch';
-export type BuiltinWidgetTypes = 'ais.analytics' | 'ais.answers' | 'ais.autocomplete' | 'ais.breadcrumb' | 'ais.clearRefinements' | 'ais.configure' | 'ais.configureRelatedItems' | 'ais.currentRefinements' | 'ais.dynamicWidgets' | 'ais.geoSearch' | 'ais.hierarchicalMenu' | 'ais.hits' | 'ais.hitsPerPage' | 'ais.index' | 'ais.infiniteHits' | 'ais.menu' | 'ais.menuSelect' | 'ais.numericMenu' | 'ais.pagination' | 'ais.places' | 'ais.poweredBy' | 'ais.queryRuleCustomData' | 'ais.queryRuleContext' | 'ais.rangeInput' | 'ais.rangeSlider' | 'ais.ratingMenu' | 'ais.refinementList' | 'ais.searchBox' | 'ais.relevantSort' | 'ais.sortBy' | 'ais.stats' | 'ais.toggleRefinement' | 'ais.voiceSearch';
+export type BuiltinTypes = 'ais.analytics' | 'ais.answers' | 'ais.autocomplete' | 'ais.breadcrumb' | 'ais.clearRefinements' | 'ais.configure' | 'ais.configureRelatedItems' | 'ais.currentRefinements' | 'ais.dynamicWidgets' | 'ais.frequentlyBoughtTogether' | 'ais.geoSearch' | 'ais.hierarchicalMenu' | 'ais.hits' | 'ais.hitsPerPage' | 'ais.index' | 'ais.infiniteHits' | 'ais.lookingSimilar' | 'ais.menu' | 'ais.numericMenu' | 'ais.pagination' | 'ais.places' | 'ais.poweredBy' | 'ais.queryRules' | 'ais.range' | 'ais.rangeSlider' | 'ais.rangeInput' | 'ais.ratingMenu' | 'ais.refinementList' | 'ais.relatedProducts' | 'ais.searchBox' | 'ais.relevantSort' | 'ais.sortBy' | 'ais.stats' | 'ais.toggleRefinement' | 'ais.trendingItems' | 'ais.voiceSearch';
+export type BuiltinWidgetTypes = 'ais.analytics' | 'ais.answers' | 'ais.autocomplete' | 'ais.breadcrumb' | 'ais.clearRefinements' | 'ais.configure' | 'ais.configureRelatedItems' | 'ais.currentRefinements' | 'ais.dynamicWidgets' | 'ais.frequentlyBoughtTogether' | 'ais.geoSearch' | 'ais.hierarchicalMenu' | 'ais.hits' | 'ais.hitsPerPage' | 'ais.index' | 'ais.infiniteHits' | 'ais.lookingSimilar' | 'ais.menu' | 'ais.menuSelect' | 'ais.numericMenu' | 'ais.pagination' | 'ais.places' | 'ais.poweredBy' | 'ais.queryRuleCustomData' | 'ais.queryRuleContext' | 'ais.rangeInput' | 'ais.rangeSlider' | 'ais.ratingMenu' | 'ais.refinementList' | 'ais.relatedProducts' | 'ais.searchBox' | 'ais.relevantSort' | 'ais.sortBy' | 'ais.stats' | 'ais.toggleRefinement' | 'ais.trendingItems' | 'ais.voiceSearch';
 export type UnknownWidgetParams = NonNullable<object>;
 export type WidgetParams = {
     widgetParams?: UnknownWidgetParams;
@@ -54,17 +55,23 @@ export type WidgetDescription = {
     indexRenderState?: Record<string, unknown>;
     indexUiState?: Record<string, unknown>;
 };
-type SearchWidgetLifeCycle<TWidgetDescription extends WidgetDescription> = {
+type SearchWidget<TWidgetDescription extends WidgetDescription> = {
     dependsOn?: 'search';
     getWidgetParameters?: (state: SearchParameters, widgetParametersOptions: {
         uiState: Expand<Partial<TWidgetDescription['indexUiState'] & IndexUiState>>;
     }) => SearchParameters;
 };
-type RecommendWidgetLifeCycle<TWidgetDescription extends WidgetDescription> = {
-    dependsOn?: 'recommend';
+type RecommendRenderOptions = SharedRenderOptions & {
+    results: RecommendResultItem;
+};
+type RecommendWidget<TWidgetDescription extends WidgetDescription & WidgetParams> = {
+    dependsOn: 'recommend';
+    $$id?: number;
     getWidgetParameters: (state: RecommendParameters, widgetParametersOptions: {
         uiState: Expand<Partial<TWidgetDescription['indexUiState'] & IndexUiState>>;
     }) => RecommendParameters;
+    getRenderState: (renderState: Expand<IndexRenderState & Partial<TWidgetDescription['indexRenderState']>>, renderOptions: InitOptions | RecommendRenderOptions) => IndexRenderState & TWidgetDescription['indexRenderState'];
+    getWidgetRenderState: (renderOptions: InitOptions | RecommendRenderOptions) => Expand<WidgetRenderState<TWidgetDescription['renderState'], TWidgetDescription['widgetParams']>>;
 };
 type RequiredWidgetLifeCycle<TWidgetDescription extends WidgetDescription> = {
     /**
@@ -87,7 +94,7 @@ type RequiredWidgetLifeCycle<TWidgetDescription extends WidgetDescription> = {
      * Called when this widget is unmounted. Used to remove refinements set by
      * during this widget's initialization and life time.
      */
-    dispose?: (options: DisposeOptions) => SearchParameters | void;
+    dispose?: (options: DisposeOptions) => SearchParameters | RecommendParameters | void;
 };
 type RequiredWidgetType<TWidgetDescription extends WidgetDescription> = {
     /**
@@ -135,7 +142,7 @@ type RequiredUiStateLifeCycle<TWidgetDescription extends WidgetDescription> = {
     getWidgetSearchParameters: (state: SearchParameters, widgetSearchParametersOptions: {
         uiState: Expand<Partial<TWidgetDescription['indexUiState'] & IndexUiState>>;
     }) => SearchParameters;
-} & (SearchWidgetLifeCycle<TWidgetDescription> | RecommendWidgetLifeCycle<TWidgetDescription>);
+};
 type UiStateLifeCycle<TWidgetDescription extends WidgetDescription> = TWidgetDescription extends RequiredKeys<WidgetDescription, 'indexUiState'> ? RequiredUiStateLifeCycle<TWidgetDescription> : Partial<RequiredUiStateLifeCycle<TWidgetDescription>>;
 type RequiredRenderStateLifeCycle<TWidgetDescription extends WidgetDescription & WidgetParams> = {
     /**
@@ -151,7 +158,7 @@ type RequiredRenderStateLifeCycle<TWidgetDescription extends WidgetDescription &
 type RenderStateLifeCycle<TWidgetDescription extends WidgetDescription & WidgetParams> = TWidgetDescription extends RequiredKeys<WidgetDescription, 'renderState' | 'indexRenderState'> & WidgetParams ? RequiredRenderStateLifeCycle<TWidgetDescription> : Partial<RequiredRenderStateLifeCycle<TWidgetDescription>>;
 export type Widget<TWidgetDescription extends WidgetDescription & WidgetParams = {
     $$type: string;
-}> = Expand<RequiredWidgetLifeCycle<TWidgetDescription> & WidgetType<TWidgetDescription> & UiStateLifeCycle<TWidgetDescription> & RenderStateLifeCycle<TWidgetDescription>>;
+}> = Expand<RequiredWidgetLifeCycle<TWidgetDescription> & WidgetType<TWidgetDescription> & UiStateLifeCycle<TWidgetDescription> & RenderStateLifeCycle<TWidgetDescription>> & (SearchWidget<TWidgetDescription> | RecommendWidget<TWidgetDescription>);
 export type TransformItemsMetadata = {
     results?: SearchResults;
 };

package/es/widgets/frequently-bought-together/frequently-bought-together.d.ts

@@ -0,0 +1,41 @@
+
+import type { FrequentlyBoughtTogetherWidgetDescription, FrequentlyBoughtTogetherConnectorParams } from '../../connectors/frequently-bought-together/connectFrequentlyBoughtTogether';
+import type { Template, WidgetFactory, Hit } from '../../types';
+import type { RecommendResultItem } from 'algoliasearch-helper';
+import type { RecommendClassNames, FrequentlyBoughtTogetherProps as FrequentlyBoughtTogetherUiProps } from 'instantsearch-ui-components';
+export type FrequentlyBoughtTogetherCSSClasses = Partial<RecommendClassNames>;
+export type FrequentlyBoughtTogetherTemplates = Partial<{
+    /**
+     * Template to use when there are no results.
+     */
+    empty: Template<RecommendResultItem>;
+    /**
+     * Template to use for the header of the widget.
+     */
+    header: Template<Pick<Parameters<NonNullable<FrequentlyBoughtTogetherUiProps<Hit>['headerComponent']>>[0], 'items'> & {
+        cssClasses: RecommendClassNames;
+    }>;
+    /**
+     * Template to use for each result. This template will receive an object containing a single record.
+     */
+    item: Template<Hit>;
+}>;
+type FrequentlyBoughtTogetherWidgetParams = {
+    /**
+     * CSS Selector or HTMLElement to insert the widget.
+     */
+    container: string | HTMLElement;
+    /**
+     * Templates to use for the widget.
+     */
+    templates?: FrequentlyBoughtTogetherTemplates;
+    /**
+     * CSS classes to add.
+     */
+    cssClasses?: FrequentlyBoughtTogetherCSSClasses;
+};
+export type FrequentlyBoughtTogetherWidget = WidgetFactory<FrequentlyBoughtTogetherWidgetDescription & {
+    $$widgetType: 'ais.frequentlyBoughtTogether';
+}, FrequentlyBoughtTogetherConnectorParams, FrequentlyBoughtTogetherWidgetParams>;
+declare const frequentlyBoughtTogether: FrequentlyBoughtTogetherWidget;
+export default frequentlyBoughtTogether;

package/es/widgets/frequently-bought-together/frequently-bought-together.js

@@ -0,0 +1,112 @@
+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 _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
+import { createFrequentlyBoughtTogetherComponent } from 'instantsearch-ui-components';
+import { Fragment, h, render } from 'preact';
+import TemplateComponent from "../../components/Template/Template.js";
+import connectFrequentlyBoughtTogether from "../../connectors/frequently-bought-together/connectFrequentlyBoughtTogether.js";
+import { prepareTemplateProps } from "../../lib/templating/index.js";
+import { getContainerNode, createDocumentationMessageGenerator } from "../../lib/utils/index.js";
+var withUsage = createDocumentationMessageGenerator({
+  name: 'frequently-bought-together'
+});
+var FrequentlyBoughtTogether = createFrequentlyBoughtTogetherComponent({
+  createElement: h,
+  Fragment: Fragment
+});
+var renderer = function renderer(_ref) {
+  var renderState = _ref.renderState,
+    cssClasses = _ref.cssClasses,
+    containerNode = _ref.containerNode,
+    templates = _ref.templates;
+  return function (_ref2, isFirstRendering) {
+    var items = _ref2.items,
+      results = _ref2.results,
+      instantSearchInstance = _ref2.instantSearchInstance;
+    if (isFirstRendering) {
+      renderState.templateProps = prepareTemplateProps({
+        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+        defaultTemplates: {},
+        templatesConfig: instantSearchInstance.templatesConfig,
+        templates: templates
+      });
+      return;
+    }
+    var headerComponent = templates.header ? function (data) {
+      return h(TemplateComponent, _extends({}, renderState.templateProps, {
+        templateKey: "header",
+        rootTagName: "fragment",
+        data: {
+          cssClasses: data.classNames,
+          items: data.items
+        }
+      }));
+    } : undefined;
+    var itemComponent = templates.item ? function (_ref3) {
+      var item = _ref3.item;
+      return h(TemplateComponent, _extends({}, renderState.templateProps, {
+        templateKey: "item",
+        rootTagName: "fragment",
+        data: item
+      }));
+    } : undefined;
+    var emptyComponent = templates.empty ? function () {
+      return h(TemplateComponent, _extends({}, renderState.templateProps, {
+        templateKey: "empty",
+        rootTagName: "fragment",
+        data: results
+      }));
+    } : undefined;
+    render(h(FrequentlyBoughtTogether, {
+      items: items,
+      headerComponent: headerComponent,
+      itemComponent: itemComponent,
+      sendEvent: function sendEvent() {},
+      classNames: cssClasses,
+      emptyComponent: emptyComponent,
+      status: instantSearchInstance.status
+    }), containerNode);
+  };
+};
+var frequentlyBoughtTogether = function frequentlyBoughtTogether(widgetParams) {
+  var _ref4 = widgetParams || {},
+    container = _ref4.container,
+    objectIDs = _ref4.objectIDs,
+    limit = _ref4.limit,
+    queryParameters = _ref4.queryParameters,
+    threshold = _ref4.threshold,
+    escapeHTML = _ref4.escapeHTML,
+    transformItems = _ref4.transformItems,
+    _ref4$templates = _ref4.templates,
+    templates = _ref4$templates === void 0 ? {} : _ref4$templates,
+    _ref4$cssClasses = _ref4.cssClasses,
+    cssClasses = _ref4$cssClasses === void 0 ? {} : _ref4$cssClasses;
+  if (!container) {
+    throw new Error(withUsage('The `container` option is required.'));
+  }
+  var containerNode = getContainerNode(container);
+  var specializedRenderer = renderer({
+    containerNode: containerNode,
+    cssClasses: cssClasses,
+    renderState: {},
+    templates: templates
+  });
+  var makeWidget = connectFrequentlyBoughtTogether(specializedRenderer, function () {
+    return render(null, containerNode);
+  });
+  return _objectSpread(_objectSpread({}, makeWidget({
+    objectIDs: objectIDs,
+    limit: limit,
+    queryParameters: queryParameters,
+    threshold: threshold,
+    escapeHTML: escapeHTML,
+    transformItems: transformItems
+  })), {}, {
+    $$widgetType: 'ais.frequentlyBoughtTogether'
+  });
+};
+export default frequentlyBoughtTogether;

package/es/widgets/index/index.d.ts

@@ -1,5 +1,5 @@
 import type { InstantSearch, UiState, IndexUiState, Widget, ScopedResult } from '../../types';
-import type { AlgoliaSearchHelper as Helper, SearchParameters, SearchResults } from 'algoliasearch-helper';
+import type { AlgoliaSearchHelper as Helper, SearchParameters, SearchResults, RecommendResultItem } from 'algoliasearch-helper';
 export type IndexWidgetParams = {
     indexName: string;
     indexId?: string;
@@ -23,6 +23,7 @@ export type IndexWidget<TUiState extends UiState = UiState> = Omit<Widget<IndexW
     getIndexId: () => string;
     getHelper: () => Helper | null;
     getResults: () => SearchResults | null;
+    getResultsForWidget: (widget: IndexWidget | Widget) => SearchResults | RecommendResultItem | null;
     getPreviousState: () => SearchParameters | null;
     getScopedResults: () => ScopedResult[];
     getParent: () => IndexWidget | null;

package/es/widgets/index/index.js

@@ -16,6 +16,7 @@ function _objectWithoutProperties(source, excluded) { if (source == null) return
 function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
 import algoliasearchHelper from 'algoliasearch-helper';
 import { checkIndexUiState, createDocumentationMessageGenerator, resolveSearchParameters, mergeSearchParameters, warning, isIndexWidget, createInitArgs, createRenderArgs } from "../../lib/utils/index.js";
+import { addWidgetId } from "../../lib/utils/addWidgetId.js";
 var withUsage = createDocumentationMessageGenerator({
   name: 'index-widget'
 });
@@ -123,6 +124,8 @@ var index = function index(widgetParams) {
   var helper = null;
   var derivedHelper = null;
   var lastValidSearchParameters = null;
+  var hasRecommendWidget = false;
+  var hasSearchWidget = false;
   return {
     $$type: 'ais.index',
     $$widgetType: 'ais.index',
@@ -147,6 +150,16 @@ var index = function index(widgetParams) {
       derivedHelper.lastResults._state = helper.state;
       return derivedHelper.lastResults;
     },
+    getResultsForWidget: function getResultsForWidget(widget) {
+      var _helper;
+      if (widget.dependsOn !== 'recommend' || isIndexWidget(widget) || widget.$$id === undefined) {
+        return this.getResults();
+      }
+      if (!((_helper = helper) !== null && _helper !== void 0 && _helper.lastRecommendResults)) {
+        return null;
+      }
+      return helper.lastRecommendResults[widget.$$id];
+    },
     getPreviousState: function getPreviousState() {
       return lastValidSearchParameters;
     },
@@ -191,6 +204,21 @@ var index = function index(widgetParams) {
       })) {
         throw new Error(withUsage('The widget definition expects a `render` and/or an `init` method.'));
       }
+      widgets.forEach(function (widget) {
+        if (isIndexWidget(widget)) {
+          return;
+        }
+        if (localInstantSearchInstance && widget.dependsOn === 'recommend') {
+          localInstantSearchInstance._hasRecommendWidget = true;
+        } else if (localInstantSearchInstance) {
+          localInstantSearchInstance._hasSearchWidget = true;
+        } else if (widget.dependsOn === 'recommend') {
+          hasRecommendWidget = true;
+        } else {
+          hasSearchWidget = true;
+        }
+        addWidgetId(widget);
+      });
       localWidgets = localWidgets.concat(widgets);
       if (localInstantSearchInstance && Boolean(widgets.length)) {
         privateHelperSetState(helper, {
@@ -240,16 +268,41 @@ var index = function index(widgetParams) {
       localWidgets = localWidgets.filter(function (widget) {
         return widgets.indexOf(widget) === -1;
       });
+      localWidgets.forEach(function (widget) {
+        if (isIndexWidget(widget)) {
+          return;
+        }
+        if (localInstantSearchInstance && widget.dependsOn === 'recommend') {
+          localInstantSearchInstance._hasRecommendWidget = true;
+        } else if (localInstantSearchInstance) {
+          localInstantSearchInstance._hasSearchWidget = true;
+        } else if (widget.dependsOn === 'recommend') {
+          hasRecommendWidget = true;
+        } else {
+          hasSearchWidget = true;
+        }
+      });
       if (localInstantSearchInstance && Boolean(widgets.length)) {
-        var cleanedState = widgets.reduce(function (state, widget) {
-          // the `dispose` method exists at this point we already assert it
-          var next = widget.dispose({
-            helper: helper,
-            state: state,
-            parent: _this2
-          });
-          return next || state;
-        }, helper.state);
+        var _widgets$reduce = widgets.reduce(function (states, widget) {
+            // the `dispose` method exists at this point we already assert it
+            var next = widget.dispose({
+              helper: helper,
+              state: states.cleanedSearchState,
+              recommendState: states.cleanedRecommendState,
+              parent: _this2
+            });
+            if (next instanceof algoliasearchHelper.RecommendParameters) {
+              states.cleanedRecommendState = next;
+            } else if (next) {
+              states.cleanedSearchState = next;
+            }
+            return states;
+          }, {
+            cleanedSearchState: helper.state,
+            cleanedRecommendState: helper.recommendState
+          }),
+          cleanedSearchState = _widgets$reduce.cleanedSearchState,
+          cleanedRecommendState = _widgets$reduce.cleanedRecommendState;
         var newState = localInstantSearchInstance.future.preserveSharedStateOnUnmount ? getLocalWidgetsSearchParameters(localWidgets, {
           uiState: localUiState,
           initialSearchParameters: new algoliasearchHelper.SearchParameters({
@@ -257,16 +310,17 @@ var index = function index(widgetParams) {
           })
         }) : getLocalWidgetsSearchParameters(localWidgets, {
           uiState: getLocalWidgetsUiState(localWidgets, {
-            searchParameters: cleanedState,
+            searchParameters: cleanedSearchState,
             helper: helper
           }),
-          initialSearchParameters: cleanedState
+          initialSearchParameters: cleanedSearchState
         });
         localUiState = getLocalWidgetsUiState(localWidgets, {
           searchParameters: newState,
           helper: helper
         });
         helper.setState(newState);
+        helper.recommendState = cleanedRecommendState;
         if (localWidgets.length) {
           localInstantSearchInstance.scheduleSearch();
         }
@@ -452,9 +506,16 @@ var index = function index(widgetParams) {
         // schedule a render that will render the results injected on the helper.
         instantSearchInstance.scheduleRender();
       }
+      if (hasRecommendWidget) {
+        instantSearchInstance._hasRecommendWidget = true;
+      }
+      if (hasSearchWidget) {
+        instantSearchInstance._hasSearchWidget = true;
+      }
     },
     render: function render(_ref6) {
-      var _this4 = this;
+      var _derivedHelper2,
+        _this4 = this;
       var instantSearchInstance = _ref6.instantSearchInstance;
       // we can't attach a listener to the error event of search, as the error
       // then would no longer be thrown for global handlers.
@@ -464,7 +525,7 @@ var index = function index(widgetParams) {
 
       // We only render index widgets if there are no results.
       // This makes sure `render` is never called with `results` being `null`.
-      var widgetsToRender = this.getResults() ? localWidgets : localWidgets.filter(isIndexWidget);
+      var widgetsToRender = this.getResults() || (_derivedHelper2 = derivedHelper) !== null && _derivedHelper2 !== void 0 && _derivedHelper2.lastRecommendResults ? localWidgets : localWidgets.filter(isIndexWidget);
       widgetsToRender = widgetsToRender.filter(function (widget) {
         if (!widget.shouldRender) {
           return true;
@@ -475,7 +536,7 @@ var index = function index(widgetParams) {
       });
       widgetsToRender.forEach(function (widget) {
         if (widget.getRenderState) {
-          var renderState = widget.getRenderState(instantSearchInstance.renderState[_this4.getIndexId()] || {}, createRenderArgs(instantSearchInstance, _this4));
+          var renderState = widget.getRenderState(instantSearchInstance.renderState[_this4.getIndexId()] || {}, createRenderArgs(instantSearchInstance, _this4, widget));
           storeRenderState({
             renderState: renderState,
             instantSearchInstance: instantSearchInstance,
@@ -492,14 +553,14 @@ var index = function index(widgetParams) {
         // not have results yet.
 
         if (widget.render) {
-          widget.render(createRenderArgs(instantSearchInstance, _this4));
+          widget.render(createRenderArgs(instantSearchInstance, _this4, widget));
         }
       });
     },
     dispose: function dispose() {
       var _this5 = this,
-        _helper,
-        _derivedHelper2;
+        _helper2,
+        _derivedHelper3;
       localWidgets.forEach(function (widget) {
         if (widget.dispose && helper) {
           // The dispose function is always called once the instance is started
@@ -511,15 +572,16 @@ var index = function index(widgetParams) {
           widget.dispose({
             helper: helper,
             state: helper.state,
+            recommendState: helper.recommendState,
             parent: _this5
           });
         }
       });
       localInstantSearchInstance = null;
       localParent = null;
-      (_helper = helper) === null || _helper === void 0 ? void 0 : _helper.removeAllListeners();
+      (_helper2 = helper) === null || _helper2 === void 0 ? void 0 : _helper2.removeAllListeners();
       helper = null;
-      (_derivedHelper2 = derivedHelper) === null || _derivedHelper2 === void 0 ? void 0 : _derivedHelper2.detach();
+      (_derivedHelper3 = derivedHelper) === null || _derivedHelper3 === void 0 ? void 0 : _derivedHelper3.detach();
       derivedHelper = null;
     },
     getWidgetUiState: function getWidgetUiState(uiState) {

package/es/widgets/index.d.ts

@@ -25,6 +25,7 @@ export { default as places } from './places/places';
 export { default as poweredBy } from './powered-by/powered-by';
 export { default as queryRuleContext } from './query-rule-context/query-rule-context';
 export { default as queryRuleCustomData } from './query-rule-custom-data/query-rule-custom-data';
+export { default as relatedProducts } from './related-products/related-products';
 export { default as rangeInput } from './range-input/range-input';
 export { default as rangeSlider } from './range-slider/range-slider';
 export { default as ratingMenu } from './rating-menu/rating-menu';
@@ -34,4 +35,7 @@ export { default as searchBox } from './search-box/search-box';
 export { default as sortBy } from './sort-by/sort-by';
 export { default as stats } from './stats/stats';
 export { default as toggleRefinement } from './toggle-refinement/toggle-refinement';
+export { default as trendingItems } from './trending-items/trending-items';
 export { default as voiceSearch } from './voice-search/voice-search';
+export { default as frequentlyBoughtTogether } from './frequently-bought-together/frequently-bought-together';
+export { default as lookingSimilar } from './looking-similar/looking-similar';

package/es/widgets/index.js

@@ -29,6 +29,7 @@ export { default as places } from "./places/places.js";
 export { default as poweredBy } from "./powered-by/powered-by.js";
 export { default as queryRuleContext } from "./query-rule-context/query-rule-context.js";
 export { default as queryRuleCustomData } from "./query-rule-custom-data/query-rule-custom-data.js";
+export { default as relatedProducts } from "./related-products/related-products.js";
 export { default as rangeInput } from "./range-input/range-input.js";
 export { default as rangeSlider } from "./range-slider/range-slider.js";
 export { default as ratingMenu } from "./rating-menu/rating-menu.js";
@@ -38,4 +39,7 @@ export { default as searchBox } from "./search-box/search-box.js";
 export { default as sortBy } from "./sort-by/sort-by.js";
 export { default as stats } from "./stats/stats.js";
 export { default as toggleRefinement } from "./toggle-refinement/toggle-refinement.js";
-export { default as voiceSearch } from "./voice-search/voice-search.js";
+export { default as trendingItems } from "./trending-items/trending-items.js";
+export { default as voiceSearch } from "./voice-search/voice-search.js";
+export { default as frequentlyBoughtTogether } from "./frequently-bought-together/frequently-bought-together.js";
+export { default as lookingSimilar } from "./looking-similar/looking-similar.js";

package/es/widgets/looking-similar/looking-similar.d.ts

@@ -0,0 +1,41 @@
+
+import type { LookingSimilarWidgetDescription, LookingSimilarConnectorParams } from '../../connectors/looking-similar/connectLookingSimilar';
+import type { Template, WidgetFactory, Hit } from '../../types';
+import type { RecommendResultItem } from 'algoliasearch-helper';
+import type { RecommendClassNames, LookingSimilarProps as LookingSimilarUiProps } from 'instantsearch-ui-components';
+export type LookingSimilarCSSClasses = Partial<RecommendClassNames>;
+export type LookingSimilarTemplates = Partial<{
+    /**
+     * Template to use when there are no results.
+     */
+    empty: Template<RecommendResultItem>;
+    /**
+     * Template to use for the header of the widget.
+     */
+    header: Template<Pick<Parameters<NonNullable<LookingSimilarUiProps<Hit>['headerComponent']>>[0], 'items'> & {
+        cssClasses: RecommendClassNames;
+    }>;
+    /**
+     * Template to use for each result. This template will receive an object containing a single record.
+     */
+    item: Template<Hit>;
+}>;
+type LookingSimilarWidgetParams = {
+    /**
+     * CSS Selector or HTMLElement to insert the widget.
+     */
+    container: string | HTMLElement;
+    /**
+     * Templates to use for the widget.
+     */
+    templates?: LookingSimilarTemplates;
+    /**
+     * CSS classes to add.
+     */
+    cssClasses?: LookingSimilarCSSClasses;
+};
+export type LookingSimilarWidget = WidgetFactory<LookingSimilarWidgetDescription & {
+    $$widgetType: 'ais.lookingSimilar';
+}, LookingSimilarConnectorParams, LookingSimilarWidgetParams>;
+declare const lookingSimilar: LookingSimilarWidget;
+export default lookingSimilar;