instantsearch.js 4.73.4 → 4.74.0

package/es/connectors/answers/connectAnswers.js

@@ -41,14 +41,15 @@ var connectAnswers = function connectAnswers(renderFn) {
     var lastHits = [];
     var isLoading = false;
     var debouncedRender = debounce(renderFn, renderDebounceTime);
-
-    // this does not directly use DebouncedFunction<findAnswers>, since then the generic will disappear
     var debouncedRefine;
     return {
       $$type: 'ais.answers',
       init: function init(initOptions) {
         var state = initOptions.state,
           instantSearchInstance = initOptions.instantSearchInstance;
+        if (typeof instantSearchInstance.client.initIndex !== 'function') {
+          throw new Error(withUsage('`algoliasearch` <5 required.'));
+        }
         var answersIndex = instantSearchInstance.client.initIndex(state.index);
         if (!hasFindAnswersMethod(answersIndex)) {
           throw new Error(withUsage('`algoliasearch` >= 4.8.0 required.'));

package/es/connectors/configure-related-items/connectConfigureRelatedItems.d.ts

@@ -32,4 +32,5 @@ export type ConfigureRelatedItemsWidgetDescription = {
 } & Omit<ConfigureWidgetDescription, '$$type'>;
 export type ConfigureRelatedItemsConnector = Connector<ConfigureRelatedItemsWidgetDescription, ConfigureRelatedItemsConnectorParams>;
 declare const connectConfigureRelatedItems: ConfigureRelatedItemsConnector;
+/** @deprecated use connectRelatedItems instead */
 export default connectConfigureRelatedItems;

package/es/connectors/configure-related-items/connectConfigureRelatedItems.js

@@ -74,4 +74,6 @@ var connectConfigureRelatedItems = function connectConfigureRelatedItems(renderF
     });
   };
 };
+
+/** @deprecated use connectRelatedItems instead */
 export default connectConfigureRelatedItems;

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

@@ -1,10 +1,10 @@
-import type { Connector, TransformItems, Hit, BaseHit, Renderer, Unmounter, UnknownWidgetParams } from '../../types';
-import type { PlainSearchParameters, RecommendResultItem } from 'algoliasearch-helper';
+import type { Connector, TransformItems, BaseHit, Renderer, Unmounter, UnknownWidgetParams, RecommendResponse, AlgoliaHit } from '../../types';
+import type { PlainSearchParameters } from 'algoliasearch-helper';
 export type FrequentlyBoughtTogetherRenderState<THit extends NonNullable<object> = BaseHit> = {
     /**
      * The matched recommendations from Algolia API.
      */
-    items: Array<Hit<THit>>;
+    items: Array<AlgoliaHit<THit>>;
 };
 export type FrequentlyBoughtTogetherConnectorParams<THit extends NonNullable<object> = BaseHit> = {
     /**
@@ -32,8 +32,8 @@ export type FrequentlyBoughtTogetherConnectorParams<THit extends NonNullable<obj
     /**
      * Function to transform the items passed to the templates.
      */
-    transformItems?: TransformItems<Hit<THit>, {
-        results: RecommendResultItem;
+    transformItems?: TransformItems<AlgoliaHit<THit>, {
+        results: RecommendResponse<AlgoliaHit<THit>>;
     }>;
 };
 export type FrequentlyBoughtTogetherWidgetDescription<THit extends NonNullable<object> = BaseHit> = {
@@ -150,9 +150,9 @@ declare const _default: <TWidgetParams extends UnknownWidgetParams>(renderFn: Re
         error: import("../../types").InstantSearch["error"];
         createURL: (nextState: import("algoliasearch-helper").SearchParameters | ((state: import("../../types").IndexUiState) => import("../../types").IndexUiState)) => string;
     } & {
-        results: RecommendResultItem;
+        results: RecommendResponse<any>;
     })): {
-        items: Hit<THit>[];
+        items: AlgoliaHit<THit>[];
         widgetParams: TWidgetParams & FrequentlyBoughtTogetherConnectorParams<THit>;
     };
     dispose({ recommendState }: import("../../types").DisposeOptions): import("algoliasearch-helper").RecommendParameters;

package/es/connectors/index.d.ts

@@ -1,6 +1,8 @@
 import connectDynamicWidgets from './dynamic-widgets/connectDynamicWidgets';
 /** @deprecated answers is no longer supported */
 export declare const EXPERIMENTAL_connectAnswers: import("./answers/connectAnswers").AnswersConnector;
+/** @deprecated use connectRelatedItems instead */
+export declare const EXPERIMENTAL_connectConfigureRelatedItems: import("./configure-related-items/connectConfigureRelatedItems").ConfigureRelatedItemsConnector;
 /** @deprecated use connectDynamicWidgets */
 export declare const EXPERIMENTAL_connectDynamicWidgets: import("./dynamic-widgets/connectDynamicWidgets").DynamicWidgetsConnector;
 export { connectDynamicWidgets };
@@ -28,7 +30,6 @@ export { default as connectBreadcrumb } from './breadcrumb/connectBreadcrumb';
 export { default as connectGeoSearch } from './geo-search/connectGeoSearch';
 export { default as connectPoweredBy } from './powered-by/connectPoweredBy';
 export { default as connectConfigure } from './configure/connectConfigure';
-export { default as EXPERIMENTAL_connectConfigureRelatedItems } from './configure-related-items/connectConfigureRelatedItems';
 export { default as connectAutocomplete } from './autocomplete/connectAutocomplete';
 export { default as connectQueryRules } from './query-rules/connectQueryRules';
 export { default as connectVoiceSearch } from './voice-search/connectVoiceSearch';

package/es/connectors/index.js

@@ -1,10 +1,14 @@
 import { deprecate } from "../lib/utils/index.js";
 import connectAnswers from "./answers/connectAnswers.js";
+import connectConfigureRelatedItems from "./configure-related-items/connectConfigureRelatedItems.js";
 import connectDynamicWidgets from "./dynamic-widgets/connectDynamicWidgets.js";
 
 /** @deprecated answers is no longer supported */
 export var EXPERIMENTAL_connectAnswers = deprecate(connectAnswers, 'answers is no longer supported');
 
+/** @deprecated use connectRelatedItems instead */
+export var EXPERIMENTAL_connectConfigureRelatedItems = deprecate(connectConfigureRelatedItems, 'EXPERIMENTAL_connectConfigureRelatedItems is deprecated and will be removed in a next minor version of InstantSearch. Please use connectRelatedItems instead.');
+
 /** @deprecated use connectDynamicWidgets */
 export var EXPERIMENTAL_connectDynamicWidgets = deprecate(connectDynamicWidgets, 'use connectDynamicWidgets');
 export { connectDynamicWidgets };
@@ -32,7 +36,6 @@ 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";
 export { default as connectConfigure } from "./configure/connectConfigure.js";
-export { default as EXPERIMENTAL_connectConfigureRelatedItems } from "./configure-related-items/connectConfigureRelatedItems.js";
 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";

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

@@ -1,10 +1,10 @@
-import type { Connector, TransformItems, Hit, BaseHit, Renderer, Unmounter, UnknownWidgetParams } from '../../types';
-import type { PlainSearchParameters, RecommendResultItem } from 'algoliasearch-helper';
+import type { Connector, TransformItems, BaseHit, Renderer, Unmounter, UnknownWidgetParams, RecommendResponse, AlgoliaHit } from '../../types';
+import type { PlainSearchParameters } from 'algoliasearch-helper';
 export type LookingSimilarRenderState<THit extends NonNullable<object> = BaseHit> = {
     /**
      * The matched recommendations from the Algolia API.
      */
-    items: Array<Hit<THit>>;
+    items: Array<AlgoliaHit<THit>>;
 };
 export type LookingSimilarConnectorParams<THit extends NonNullable<object> = BaseHit> = {
     /**
@@ -36,8 +36,8 @@ export type LookingSimilarConnectorParams<THit extends NonNullable<object> = Bas
     /**
      * Function to transform the items passed to the templates.
      */
-    transformItems?: TransformItems<Hit<THit>, {
-        results: RecommendResultItem;
+    transformItems?: TransformItems<AlgoliaHit<THit>, {
+        results: RecommendResponse<AlgoliaHit<THit>>;
     }>;
 };
 export type LookingSimilarWidgetDescription<THit extends NonNullable<object> = BaseHit> = {
@@ -154,9 +154,9 @@ declare const _default: <TWidgetParams extends UnknownWidgetParams>(renderFn: Re
         error: import("../../types").InstantSearch["error"];
         createURL: (nextState: import("algoliasearch-helper").SearchParameters | ((state: import("../../types").IndexUiState) => import("../../types").IndexUiState)) => string;
     } & {
-        results: RecommendResultItem;
+        results: RecommendResponse<any>;
     })): {
-        items: Hit<THit>[];
+        items: AlgoliaHit<THit>[];
         widgetParams: TWidgetParams & LookingSimilarConnectorParams<THit>;
     };
     dispose({ recommendState }: import("../../types").DisposeOptions): import("algoliasearch-helper").RecommendParameters;

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

@@ -1,10 +1,10 @@
-import type { Connector, TransformItems, Hit, BaseHit, Renderer, Unmounter, UnknownWidgetParams } from '../../types';
-import type { PlainSearchParameters, RecommendResultItem } from 'algoliasearch-helper';
+import type { Connector, TransformItems, BaseHit, Renderer, Unmounter, UnknownWidgetParams, RecommendResponse, AlgoliaHit } from '../../types';
+import type { PlainSearchParameters } from 'algoliasearch-helper';
 export type RelatedProductsRenderState<THit extends NonNullable<object> = BaseHit> = {
     /**
      * The matched recommendations from the Algolia API.
      */
-    items: Array<Hit<THit>>;
+    items: Array<AlgoliaHit<THit>>;
 };
 export type RelatedProductsConnectorParams<THit extends NonNullable<object> = BaseHit> = {
     /**
@@ -36,8 +36,8 @@ export type RelatedProductsConnectorParams<THit extends NonNullable<object> = Ba
     /**
      * Function to transform the items passed to the templates.
      */
-    transformItems?: TransformItems<Hit<THit>, {
-        results: RecommendResultItem;
+    transformItems?: TransformItems<AlgoliaHit<THit>, {
+        results: RecommendResponse<AlgoliaHit<THit>>;
     }>;
 };
 export type RelatedProductsWidgetDescription<THit extends NonNullable<object> = BaseHit> = {
@@ -154,9 +154,9 @@ declare const _default: <TWidgetParams extends UnknownWidgetParams>(renderFn: Re
         error: import("../../types").InstantSearch["error"];
         createURL: (nextState: import("algoliasearch-helper").SearchParameters | ((state: import("../../types").IndexUiState) => import("../../types").IndexUiState)) => string;
     } & {
-        results: RecommendResultItem;
+        results: RecommendResponse<any>;
     })): {
-        items: Hit<BaseHit>[] | Hit<THit>[];
+        items: AlgoliaHit<BaseHit>[] | AlgoliaHit<THit>[];
         widgetParams: TWidgetParams & RelatedProductsConnectorParams<THit>;
     };
     dispose({ recommendState }: import("../../types").DisposeOptions): import("algoliasearch-helper").RecommendParameters;

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

@@ -1,10 +1,10 @@
-import type { Connector, TransformItems, Hit, BaseHit, Renderer, Unmounter, UnknownWidgetParams } from '../../types';
-import type { PlainSearchParameters, RecommendResultItem } from 'algoliasearch-helper';
+import type { Connector, TransformItems, BaseHit, Renderer, Unmounter, UnknownWidgetParams, RecommendResponse, AlgoliaHit } from '../../types';
+import type { PlainSearchParameters } from 'algoliasearch-helper';
 export type TrendingItemsRenderState<THit extends NonNullable<object> = BaseHit> = {
     /**
      * The matched recommendations from the Algolia API.
      */
-    items: Array<Hit<THit>>;
+    items: Array<AlgoliaHit<THit>>;
 };
 export type TrendingItemsConnectorParams<THit extends NonNullable<object> = BaseHit> = ({
     /**
@@ -44,8 +44,8 @@ export type TrendingItemsConnectorParams<THit extends NonNullable<object> = Base
     /**
      * Function to transform the items passed to the templates.
      */
-    transformItems?: TransformItems<Hit<THit>, {
-        results: RecommendResultItem;
+    transformItems?: TransformItems<AlgoliaHit<THit>, {
+        results: RecommendResponse<AlgoliaHit<THit>>;
     }>;
 };
 export type TrendingItemsWidgetDescription<THit extends NonNullable<object> = BaseHit> = {
@@ -162,9 +162,9 @@ declare const _default: <TWidgetParams extends UnknownWidgetParams>(renderFn: Re
         error: import("../../types").InstantSearch["error"];
         createURL: (nextState: import("algoliasearch-helper").SearchParameters | ((state: import("../../types").IndexUiState) => import("../../types").IndexUiState)) => string;
     } & {
-        results: RecommendResultItem;
+        results: RecommendResponse<any>;
     })): {
-        items: Hit<THit>[];
+        items: AlgoliaHit<THit>[];
         widgetParams: TWidgetParams & TrendingItemsConnectorParams<THit>;
     };
     dispose({ recommendState }: import("../../types").DisposeOptions): import("algoliasearch-helper").RecommendParameters;

package/es/connectors/voice-search/connectVoiceSearch.js

@@ -47,12 +47,13 @@ var connectVoiceSearch = function connectVoiceSearch(renderFn) {
           this._refine = function (query) {
             if (query !== helper.state.query) {
               var queryLanguages = language ? [language.split('-')[0]] : undefined;
+              // @ts-ignore queryLanguages is allowed to be a string, not just an array
               helper.setQueryParameter('queryLanguages', queryLanguages);
               if (typeof additionalQueryParameters === 'function') {
                 helper.setState(helper.state.setQueryParameters(_objectSpread({
                   ignorePlurals: true,
                   removeStopWords: true,
-                  // @ts-ignore (optionalWords only allows array in v3, while string is also valid)
+                  // @ts-ignore optionalWords is allowed to be a string too
                   optionalWords: query
                 }, additionalQueryParameters({
                   query: query

package/es/index.js

@@ -39,5 +39,10 @@ Object.defineProperty(instantsearch, 'connectors', {
     throw new ReferenceError("\"instantsearch.connectors\" are not available from the ES build.\n\nTo import the connectors:\n\nimport { connectSearchBox } from 'instantsearch.js/es/connectors'");
   }
 });
+Object.defineProperty(instantsearch, 'templates', {
+  get: function get() {
+    throw new ReferenceError("\"instantsearch.templates\" are not available from the ES build.\n\nTo import the templates:\n\nimport { carousel } from 'instantsearch.js/es/templates'");
+  }
+});
 export default instantsearch;
 export * from "./types/index.js";

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

@@ -19,9 +19,9 @@ export declare function createRenderArgs(instantSearchInstance: InstantSearch, p
     helper: import("algoliasearch-helper").AlgoliaSearchHelper;
     parent: IndexWidget;
     instantSearchInstance: InstantSearch<UiState, UiState>;
-    results: import("algoliasearch-helper").SearchResults<any> | import("algoliasearch-helper").RecommendResultItem;
+    results: import("algoliasearch").RecommendationsResults | import("algoliasearch-helper").SearchResults<any>;
     scopedResults: import("../../types").ScopedResult[];
-    state: import("algoliasearch-helper").SearchParameters;
+    state: any;
     renderState: import("../../types").RenderState;
     templatesConfig: Record<string, unknown>;
     createURL: (nextState: import("algoliasearch-helper").SearchParameters | ((state: import("../../types").IndexUiState) => import("../../types").IndexUiState)) => string;

package/es/lib/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "4.73.4";
+declare const _default: "4.74.0";
 export default _default;

package/es/lib/version.js

@@ -1 +1 @@
-export default '4.73.4';
+export default '4.74.0';

package/es/templates/carousel/carousel.d.ts

@@ -0,0 +1,22 @@
+
+import { html } from 'htm/preact';
+import { h } from 'preact';
+import type { CarouselProps as CarouselUiProps, VNode } from 'instantsearch-ui-components';
+type Template = (params: {
+    html: typeof html;
+}) => VNode | VNode[] | null;
+type CreateCarouselTemplateProps<TObject extends Record<string, unknown>> = {
+    templates?: Partial<{
+        previous: Exclude<Template, string>;
+        next: Exclude<Template, string>;
+    }>;
+    cssClasses?: Partial<CarouselUiProps<TObject>['classNames']>;
+};
+type CarouselTemplateProps<TObject extends Record<string, unknown>> = Pick<CarouselUiProps<TObject>, 'items'> & {
+    templates: {
+        item?: CarouselUiProps<TObject>['itemComponent'];
+    };
+    cssClasses?: Partial<CarouselUiProps<TObject>['classNames']>;
+};
+export declare function carousel<TObject extends Record<string, unknown>>({ cssClasses, templates, }?: CreateCarouselTemplateProps<TObject>): ({ items, templates: widgetTemplates, cssClasses: widgetCssClasses, }: CarouselTemplateProps<TObject>) => h.JSX.Element;
+export {};

package/es/templates/carousel/carousel.js

@@ -0,0 +1,56 @@
+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 { html } from 'htm/preact';
+import { createCarouselComponent, cx, generateCarouselId } from 'instantsearch-ui-components';
+import { Fragment, h } from 'preact';
+import { useRef } from 'preact/hooks';
+var Carousel = createCarouselComponent({
+  createElement: h,
+  Fragment: Fragment
+});
+function CarouselWithRefs(props) {
+  var carouselRefs = {
+    listRef: useRef(null),
+    nextButtonRef: useRef(null),
+    previousButtonRef: useRef(null),
+    carouselIdRef: useRef(generateCarouselId())
+  };
+  return h(Carousel, _extends({}, carouselRefs, props));
+}
+export function carousel() {
+  var _ref = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
+    cssClasses = _ref.cssClasses,
+    _ref$templates = _ref.templates,
+    templates = _ref$templates === void 0 ? {} : _ref$templates;
+  return function CarouselTemplate(_ref2) {
+    var items = _ref2.items,
+      widgetTemplates = _ref2.templates,
+      _ref2$cssClasses = _ref2.cssClasses,
+      widgetCssClasses = _ref2$cssClasses === void 0 ? {} : _ref2$cssClasses;
+    var previous = templates.previous,
+      next = templates.next;
+    return h(CarouselWithRefs, {
+      items: items,
+      itemComponent: widgetTemplates.item,
+      previousIconComponent: previous ? function () {
+        return previous({
+          html: html
+        });
+      } : undefined,
+      nextIconComponent: next ? function () {
+        return next({
+          html: html
+        });
+      } : undefined,
+      classNames: _objectSpread(_objectSpread({}, cssClasses), {
+        list: cx(cssClasses === null || cssClasses === void 0 ? void 0 : cssClasses.list, widgetCssClasses === null || widgetCssClasses === void 0 ? void 0 : widgetCssClasses.list),
+        item: cx(cssClasses === null || cssClasses === void 0 ? void 0 : cssClasses.item, widgetCssClasses === null || widgetCssClasses === void 0 ? void 0 : widgetCssClasses.item)
+      })
+    });
+  };
+}

package/es/templates/index.d.ts

@@ -0,0 +1 @@
+export * from './carousel/carousel';

package/es/templates/index.js

@@ -0,0 +1 @@
+export * from "./carousel/carousel.js";

package/es/types/widget.d.ts

@@ -1,9 +1,10 @@
 import type { IndexWidget } from '../widgets';
+import type { RecommendResponse } from './algoliasearch';
 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, RecommendResultItem } from 'algoliasearch-helper';
+import type { AlgoliaSearchHelper as Helper, SearchParameters, SearchResults, RecommendParameters } from 'algoliasearch-helper';
 export type ScopedResult = {
     indexId: string;
     results: SearchResults;
@@ -62,7 +63,7 @@ type SearchWidget<TWidgetDescription extends WidgetDescription> = {
     }) => SearchParameters;
 };
 type RecommendRenderOptions = SharedRenderOptions & {
-    results: RecommendResultItem;
+    results: RecommendResponse<any>;
 };
 type RecommendWidget<TWidgetDescription extends WidgetDescription & WidgetParams> = {
     dependsOn: 'recommend';

package/es/widgets/configure-related-items/configure-related-items.d.ts

@@ -6,4 +6,5 @@ export type ConfigureRelatedItemsWidget = WidgetFactory<ConfigureRelatedItemsWid
 }, ConfigureRelatedItemsConnectorParams, ConfigureRelatedItemsWidgetParams>;
 export type ConfigureRelatedItemsWidgetParams = PlainSearchParameters;
 declare const configureRelatedItems: ConfigureRelatedItemsWidget;
+/** @deprecated use relatedItems instead */
 export default configureRelatedItems;

package/es/widgets/configure-related-items/configure-related-items.js

@@ -12,4 +12,6 @@ var configureRelatedItems = function configureRelatedItems(widgetParams) {
     $$widgetType: 'ais.configureRelatedItems'
   });
 };
+
+/** @deprecated use relatedItems instead */
 export default configureRelatedItems;

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

@@ -1,24 +1,32 @@
 
 import type { FrequentlyBoughtTogetherWidgetDescription, FrequentlyBoughtTogetherConnectorParams } from '../../connectors/frequently-bought-together/connectFrequentlyBoughtTogether';
-import type { Template, WidgetFactory, Hit, BaseHit } from '../../types';
-import type { RecommendResultItem } from 'algoliasearch-helper';
+import type { Template, WidgetFactory, AlgoliaHit, BaseHit, RecommendResponse } from '../../types';
 import type { RecommendClassNames, FrequentlyBoughtTogetherProps as FrequentlyBoughtTogetherUiProps } from 'instantsearch-ui-components';
 export type FrequentlyBoughtTogetherCSSClasses = Partial<RecommendClassNames>;
 export type FrequentlyBoughtTogetherTemplates<THit extends NonNullable<object> = BaseHit> = Partial<{
     /**
      * Template to use when there are no results.
      */
-    empty: Template<RecommendResultItem<Hit<THit>>>;
+    empty: Template<RecommendResponse<AlgoliaHit<THit>>>;
     /**
      * Template to use for the header of the widget.
      */
-    header: Template<Pick<Parameters<NonNullable<FrequentlyBoughtTogetherUiProps<Hit<THit>>['headerComponent']>>[0], 'items'> & {
+    header: Template<Pick<Parameters<NonNullable<FrequentlyBoughtTogetherUiProps<AlgoliaHit<THit>>['headerComponent']>>[0], 'items'> & {
         cssClasses: RecommendClassNames;
     }>;
     /**
      * Template to use for each result. This template will receive an object containing a single record.
      */
-    item: Template<Hit<THit>>;
+    item: Template<AlgoliaHit<THit>>;
+    /**
+     * Template to use to wrap all items.
+     */
+    layout: Template<Pick<Parameters<NonNullable<FrequentlyBoughtTogetherUiProps<AlgoliaHit<THit>>['layout']>>[0], 'items'> & {
+        templates: {
+            item: FrequentlyBoughtTogetherUiProps<AlgoliaHit<THit>>['itemComponent'];
+        };
+        cssClasses: Pick<FrequentlyBoughtTogetherCSSClasses, 'list' | 'item'>;
+    }>;
 }>;
 type FrequentlyBoughtTogetherWidgetParams<THit extends NonNullable<object> = BaseHit> = {
     /**
@@ -217,9 +225,9 @@ declare const _default: <THit extends NonNullable<object> = BaseHit>(widgetParam
         error: import("../../types").InstantSearch["error"];
         createURL: (nextState: import("algoliasearch-helper").SearchParameters | ((state: import("../../types").IndexUiState) => import("../../types").IndexUiState)) => string;
     } & {
-        results: RecommendResultItem;
+        results: RecommendResponse<any>;
     })): {
-        items: Hit<THit>[];
+        items: AlgoliaHit<THit>[];
         widgetParams: Partial<FrequentlyBoughtTogetherWidgetParams<BaseHit>> & FrequentlyBoughtTogetherConnectorParams<THit>;
     };
     dispose({ recommendState }: import("../../types").DisposeOptions): import("algoliasearch-helper").RecommendParameters;

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

@@ -60,6 +60,29 @@ var renderer = function renderer(_ref) {
         data: results
       }));
     } : undefined;
+    var layoutComponent = templates.layout ? function (data) {
+      return h(TemplateComponent, _extends({}, renderState.templateProps, {
+        templateKey: "layout",
+        rootTagName: "fragment",
+        data: {
+          items: data.items,
+          templates: {
+            item: templates.item ? function (_ref4) {
+              var item = _ref4.item;
+              return h(TemplateComponent, _extends({}, renderState.templateProps, {
+                templateKey: "item",
+                rootTagName: "fragment",
+                data: item
+              }));
+            } : undefined
+          },
+          cssClasses: {
+            list: data.classNames.list,
+            item: data.classNames.item
+          }
+        }
+      }));
+    } : undefined;
     render(h(FrequentlyBoughtTogether, {
       items: items,
       headerComponent: headerComponent,
@@ -67,23 +90,24 @@ var renderer = function renderer(_ref) {
       sendEvent: function sendEvent() {},
       classNames: cssClasses,
       emptyComponent: emptyComponent,
+      layout: layoutComponent,
       status: instantSearchInstance.status
     }), containerNode);
   };
 };
 export default (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;
+  var _ref5 = widgetParams || {},
+    container = _ref5.container,
+    objectIDs = _ref5.objectIDs,
+    limit = _ref5.limit,
+    queryParameters = _ref5.queryParameters,
+    threshold = _ref5.threshold,
+    escapeHTML = _ref5.escapeHTML,
+    transformItems = _ref5.transformItems,
+    _ref5$templates = _ref5.templates,
+    templates = _ref5$templates === void 0 ? {} : _ref5$templates,
+    _ref5$cssClasses = _ref5.cssClasses,
+    cssClasses = _ref5$cssClasses === void 0 ? {} : _ref5$cssClasses;
   if (!container) {
     throw new Error(withUsage('The `container` option is required.'));
   }

package/es/widgets/geo-search/geo-search.d.ts

@@ -210,7 +210,7 @@ declare const _default: <THit extends GeoHit = GeoHit>(widgetParams: GeoSearchWi
                 reset: string | string[];
             }> | undefined>;
             createMarker: CreateMarker;
-            markerOptions: GeoSearchMarker<typeof google.maps.MarkerOptions | Partial<HTMLMarkerArguments>>;
+            markerOptions: GeoSearchMarker<google.maps.MarkerOptions | Partial<HTMLMarkerArguments>>;
             enableRefine: GeoSearchWidgetParams["enableRefine"];
             enableClearMapRefinement: GeoSearchWidgetParams["enableClearMapRefinement"];
             enableRefineControl: GeoSearchWidgetParams["enableRefineControl"];

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, RecommendResultItem } from 'algoliasearch-helper';
+import type { InstantSearch, UiState, IndexUiState, Widget, ScopedResult, RecommendResponse } from '../../types';
+import type { AlgoliaSearchHelper as Helper, SearchParameters, SearchResults } from 'algoliasearch-helper';
 export type IndexWidgetParams = {
     indexName: string;
     indexId?: string;
@@ -23,7 +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;
+    getResultsForWidget: (widget: IndexWidget | Widget) => SearchResults | RecommendResponse<any> | null;
     getPreviousState: () => SearchParameters | null;
     getScopedResults: () => ScopedResult[];
     getParent: () => IndexWidget | null;

package/es/widgets/index.d.ts

@@ -1,6 +1,8 @@
 import dynamicWidgets from './dynamic-widgets/dynamic-widgets';
 /** @deprecated answers is no longer supported */
 export declare const EXPERIMENTAL_answers: import("./answers/answers").AnswersWidget;
+/** @deprecated use relatedItems instead */
+export declare const EXPERIMENTAL_configureRelatedItems: import("./configure-related-items/configure-related-items").ConfigureRelatedItemsWidget;
 /** @deprecated use dynamicWidgets */
 export declare const EXPERIMENTAL_dynamicWidgets: import("./dynamic-widgets/dynamic-widgets").DynamicWidgetsWidget;
 export { dynamicWidgets };
@@ -9,7 +11,6 @@ export { default as breadcrumb } from './breadcrumb/breadcrumb';
 export { default as clearRefinements } from './clear-refinements/clear-refinements';
 export { default as configure } from './configure/configure';
 export { default as currentRefinements } from './current-refinements/current-refinements';
-export { default as EXPERIMENTAL_configureRelatedItems } from './configure-related-items/configure-related-items';
 export { default as geoSearch } from './geo-search/geo-search';
 export { default as hierarchicalMenu } from './hierarchical-menu/hierarchical-menu';
 export { default as hits } from './hits/hits';

package/es/widgets/index.js

@@ -1,10 +1,14 @@
 import { deprecate } from "../lib/utils/index.js";
 import answers from "./answers/answers.js";
+import configureRelatedItems from "./configure-related-items/configure-related-items.js";
 import dynamicWidgets from "./dynamic-widgets/dynamic-widgets.js";
 
 /** @deprecated answers is no longer supported */
 export var EXPERIMENTAL_answers = deprecate(answers, 'answers is no longer supported');
 
+/** @deprecated use relatedItems instead */
+export var EXPERIMENTAL_configureRelatedItems = deprecate(configureRelatedItems, 'EXPERIMENTAL_configureRelatedItems is deprecated and will be removed in a next minor version of InstantSearch. Please use relatedItems instead.');
+
 /** @deprecated use dynamicWidgets */
 export var EXPERIMENTAL_dynamicWidgets = deprecate(dynamicWidgets, 'use dynamicWidgets');
 export { dynamicWidgets };
@@ -13,7 +17,6 @@ export { default as breadcrumb } from "./breadcrumb/breadcrumb.js";
 export { default as clearRefinements } from "./clear-refinements/clear-refinements.js";
 export { default as configure } from "./configure/configure.js";
 export { default as currentRefinements } from "./current-refinements/current-refinements.js";
-export { default as EXPERIMENTAL_configureRelatedItems } from "./configure-related-items/configure-related-items.js";
 export { default as geoSearch } from "./geo-search/geo-search.js";
 export { default as hierarchicalMenu } from "./hierarchical-menu/hierarchical-menu.js";
 export { default as hits } from "./hits/hits.js";