instantsearch.js 4.68.1 → 4.70.0

package/es/lib/server.js

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

package/es/lib/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,3 @@
+import type { Widget } from '../../types';
+export declare function addWidgetId(widget: Widget): void;
+export declare function resetWidgetId(): void;

package/es/lib/utils/addWidgetId.js

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

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

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

package/es/lib/utils/hydrateRecommendCache.js

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

package/es/lib/utils/hydrateSearchClient.js

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

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

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

package/es/lib/utils/index.js

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

package/es/lib/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.70.0";
 export default _default;

package/es/lib/version.js

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

package/es/types/results.d.ts

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

package/es/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;