instantsearch.js 4.73.4 → 4.74.0

package/dist/instantsearch.production.min.d.ts

@@ -1,5 +1,6 @@
 import { AlgoliaSearchHelper } from 'algoliasearch-helper';
 import { Banner } from 'algoliasearch-helper';
+import type { CarouselProps } from 'instantsearch-ui-components';
 import EventEmitter from '@algolia/events';
 import { FindAnswersOptions } from 'algoliasearch-helper/types/algoliasearch.js';
 import type { FrequentlyBoughtTogetherProps } from 'instantsearch-ui-components';
@@ -8,7 +9,7 @@ import type { HighlightClassNames as HighlightClassNames_2 } from 'instantsearch
 import type { HighlightProps as HighlightProps_3 } from 'instantsearch-ui-components';
 import type { HitsClassNames } from 'instantsearch-ui-components';
 import type { HoganOptions } from 'hogan.js';
-import type { html } from 'htm/preact';
+import { html } from 'htm/preact';
 import type { InsightsClient as InsightsClient_2 } from 'search-insights';
 import type { InsightsMethodMap as InsightsMethodMap_2 } from 'search-insights';
 import type { LookingSimilarProps } from 'instantsearch-ui-components';
@@ -18,7 +19,7 @@ import { default as qs_2 } from 'qs';
 import type { RecommendClassNames } from 'instantsearch-ui-components';
 import { RecommendParameters } from 'algoliasearch-helper';
 import type { RecommendParametersOptions } from 'algoliasearch-helper';
-import type { RecommendResultItem } from 'algoliasearch-helper';
+import { RecommendResponse } from 'algoliasearch-helper/types/algoliasearch.js';
 import type { RecommendResults } from 'algoliasearch-helper';
 import type { RelatedProductsProps } from 'instantsearch-ui-components';
 import { SearchClient } from 'algoliasearch-helper/types/algoliasearch.js';
@@ -27,6 +28,7 @@ import { SearchParameters } from 'algoliasearch-helper';
 import { SearchResults } from 'algoliasearch-helper';
 import type { TrendingItemsProps } from 'instantsearch-ui-components';
 import { VNode } from 'preact';
+import type { VNode as VNode_2 } from 'instantsearch-ui-components';
 
 declare type AlgoliaHit<THit extends NonNullable<object> = Record<string, any>> = {
     objectID: string;
@@ -560,6 +562,15 @@ declare type BuiltInSendEventForHits = (eventType: string, hits: Hit | Hit[], ev
 
 declare type BuiltInSendEventForToggle = (eventType: string, isRefined: boolean, eventName?: string) => void;
 
+declare function carousel<TObject extends Record<string, unknown>>({ cssClasses, templates, }?: CreateCarouselTemplateProps<TObject>): ({ items, templates: widgetTemplates, cssClasses: widgetCssClasses, }: CarouselTemplateProps<TObject>) => h.JSX.Element;
+
+declare type CarouselTemplateProps<TObject extends Record<string, unknown>> = Pick<CarouselProps<TObject>, 'items'> & {
+    templates: {
+        item?: CarouselProps<TObject>['itemComponent'];
+    };
+    cssClasses?: Partial<CarouselProps<TObject>['classNames']>;
+};
+
 declare const clearRefinements: ClearRefinementsWidget;
 
 declare type ClearRefinementsConnector = Connector<ClearRefinementsWidgetDescription, ClearRefinementsConnectorParams>;
@@ -666,8 +677,6 @@ declare type ConfigureConnectorParams = {
     searchParameters: PlainSearchParameters;
 };
 
-declare const configureRelatedItems: ConfigureRelatedItemsWidget;
-
 declare type ConfigureRelatedItemsConnector = Connector<ConfigureRelatedItemsWidgetDescription, ConfigureRelatedItemsConnectorParams>;
 
 declare type ConfigureRelatedItemsConnectorParams = {
@@ -733,8 +742,6 @@ declare const connectClearRefinements: ClearRefinementsConnector;
 
 declare const connectConfigure: ConfigureConnector;
 
-declare const connectConfigureRelatedItems: ConfigureRelatedItemsConnector;
-
 declare const connectCurrentRefinements: CurrentRefinementsConnector;
 
 declare const connectDynamicWidgets: DynamicWidgetsConnector;
@@ -1075,6 +1082,7 @@ declare type ConnectorRenderStates = AnswersWidgetDescription['indexRenderState'
 declare namespace connectors {
     export {
         EXPERIMENTAL_connectAnswers,
+        EXPERIMENTAL_connectConfigureRelatedItems,
         EXPERIMENTAL_connectDynamicWidgets,
         connectDynamicWidgets,
         connectClearRefinements,
@@ -1101,7 +1109,6 @@ declare namespace connectors {
         _default_5 as connectGeoSearch,
         connectPoweredBy,
         connectConfigure,
-        connectConfigureRelatedItems as EXPERIMENTAL_connectConfigureRelatedItems,
         connectAutocomplete,
         connectQueryRules,
         connectVoiceSearch,
@@ -1189,6 +1196,14 @@ declare const connectToggleRefinement: ToggleRefinementConnector;
 
 declare const connectVoiceSearch: VoiceSearchConnector;
 
+declare type CreateCarouselTemplateProps<TObject extends Record<string, unknown>> = {
+    templates?: Partial<{
+        previous: Exclude<Template_2, string>;
+        next: Exclude<Template_2, string>;
+    }>;
+    cssClasses?: Partial<CarouselProps<TObject>['classNames']>;
+};
+
 declare function createInfiniteHitsSessionStorageCache(): InfiniteHitsCache;
 
 declare type CreateInsightsMiddleware = typeof createInsightsMiddleware;
@@ -1862,9 +1877,9 @@ declare const _default_12: <THit extends NonNullable<object> = BaseHit>(widgetPa
         error: InstantSearch["error"];
         createURL: (nextState: SearchParameters | ((state: IndexUiState) => IndexUiState)) => string;
     } & {
-        results: RecommendResultItem;
+        results: RecommendResponse<any>;
     })): {
-        items: Hit<BaseHit>[] | Hit<THit>[];
+        items: AlgoliaHit<BaseHit>[] | AlgoliaHit<THit>[];
         widgetParams: Partial<RelatedProductsWidgetParams<BaseHit>> & RelatedProductsConnectorParams<THit>;
     };
     dispose({ recommendState }: DisposeOptions): RecommendParameters;
@@ -2051,9 +2066,9 @@ declare const _default_13: <THit extends NonNullable<object> = BaseHit>(widgetPa
         error: InstantSearch["error"];
         createURL: (nextState: SearchParameters | ((state: IndexUiState) => IndexUiState)) => string;
     } & {
-        results: RecommendResultItem;
+        results: RecommendResponse<any>;
     })): {
-        items: Hit<THit>[];
+        items: AlgoliaHit<THit>[];
         widgetParams: Partial<TrendingItemsWidgetParams<BaseHit>> & TrendingItemsConnectorParams<THit>;
     };
     dispose({ recommendState }: DisposeOptions): RecommendParameters;
@@ -2240,9 +2255,9 @@ declare const _default_14: <THit extends NonNullable<object> = BaseHit>(widgetPa
         error: InstantSearch["error"];
         createURL: (nextState: SearchParameters | ((state: IndexUiState) => IndexUiState)) => string;
     } & {
-        results: RecommendResultItem;
+        results: RecommendResponse<any>;
     })): {
-        items: Hit<THit>[];
+        items: AlgoliaHit<THit>[];
         widgetParams: Partial<FrequentlyBoughtTogetherWidgetParams<BaseHit>> & FrequentlyBoughtTogetherConnectorParams<THit>;
     };
     dispose({ recommendState }: DisposeOptions): RecommendParameters;
@@ -2429,9 +2444,9 @@ declare const _default_15: <THit extends NonNullable<object> = BaseHit>(widgetPa
         error: InstantSearch["error"];
         createURL: (nextState: SearchParameters | ((state: IndexUiState) => IndexUiState)) => string;
     } & {
-        results: RecommendResultItem;
+        results: RecommendResponse<any>;
     })): {
-        items: Hit<THit>[];
+        items: AlgoliaHit<THit>[];
         widgetParams: Partial<LookingSimilarWidgetParams<BaseHit>> & LookingSimilarConnectorParams<THit>;
     };
     dispose({ recommendState }: DisposeOptions): RecommendParameters;
@@ -2725,9 +2740,9 @@ declare const _default_3: <TWidgetParams extends UnknownWidgetParams>(renderFn:
         error: InstantSearch["error"];
         createURL: (nextState: SearchParameters | ((state: IndexUiState) => IndexUiState)) => string;
     } & {
-        results: RecommendResultItem;
+        results: RecommendResponse<any>;
     })): {
-        items: Hit<BaseHit>[] | Hit<THit>[];
+        items: AlgoliaHit<BaseHit>[] | AlgoliaHit<THit>[];
         widgetParams: TWidgetParams & RelatedProductsConnectorParams<THit>;
     };
     dispose({ recommendState }: DisposeOptions): RecommendParameters;
@@ -2843,9 +2858,9 @@ declare const _default_4: <TWidgetParams extends UnknownWidgetParams>(renderFn:
         error: InstantSearch["error"];
         createURL: (nextState: SearchParameters | ((state: IndexUiState) => IndexUiState)) => string;
     } & {
-        results: RecommendResultItem;
+        results: RecommendResponse<any>;
     })): {
-        items: Hit<THit>[];
+        items: AlgoliaHit<THit>[];
         widgetParams: TWidgetParams & TrendingItemsConnectorParams<THit>;
     };
     dispose({ recommendState }: DisposeOptions): RecommendParameters;
@@ -3181,9 +3196,9 @@ declare const _default_6: <TWidgetParams extends UnknownWidgetParams>(renderFn:
         error: InstantSearch["error"];
         createURL: (nextState: SearchParameters | ((state: IndexUiState) => IndexUiState)) => string;
     } & {
-        results: RecommendResultItem;
+        results: RecommendResponse<any>;
     })): {
-        items: Hit<THit>[];
+        items: AlgoliaHit<THit>[];
         widgetParams: TWidgetParams & FrequentlyBoughtTogetherConnectorParams<THit>;
     };
     dispose({ recommendState }: DisposeOptions): RecommendParameters;
@@ -3299,9 +3314,9 @@ declare const _default_7: <TWidgetParams extends UnknownWidgetParams>(renderFn:
         error: InstantSearch["error"];
         createURL: (nextState: SearchParameters | ((state: IndexUiState) => IndexUiState)) => string;
     } & {
-        results: RecommendResultItem;
+        results: RecommendResponse<any>;
     })): {
-        items: Hit<THit>[];
+        items: AlgoliaHit<THit>[];
         widgetParams: TWidgetParams & LookingSimilarConnectorParams<THit>;
     };
     dispose({ recommendState }: DisposeOptions): RecommendParameters;
@@ -3395,7 +3410,7 @@ declare const _default_8: <THit extends GeoHit = GeoHit>(widgetParams: GeoSearch
             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"];
@@ -3771,9 +3786,15 @@ declare type Expand<T> = T extends infer O ? {
 /** @deprecated answers is no longer supported */
 declare const EXPERIMENTAL_answers: AnswersWidget;
 
+/** @deprecated use relatedItems instead */
+declare const EXPERIMENTAL_configureRelatedItems: ConfigureRelatedItemsWidget;
+
 /** @deprecated answers is no longer supported */
 declare const EXPERIMENTAL_connectAnswers: AnswersConnector;
 
+/** @deprecated use connectRelatedItems instead */
+declare const EXPERIMENTAL_connectConfigureRelatedItems: ConfigureRelatedItemsConnector;
+
 /** @deprecated use connectDynamicWidgets */
 declare const EXPERIMENTAL_connectDynamicWidgets: DynamicWidgetsConnector;
 
@@ -3808,8 +3829,8 @@ declare type FrequentlyBoughtTogetherConnectorParams<THit extends NonNullable<ob
     /**
      * Function to transform the items passed to the templates.
      */
-    transformItems?: TransformItems<Hit<THit>, {
-        results: RecommendResultItem;
+    transformItems?: TransformItems<AlgoliaHit<THit>, {
+        results: RecommendResponse<AlgoliaHit<THit>>;
     }>;
 };
 
@@ -3819,24 +3840,33 @@ declare type FrequentlyBoughtTogetherRenderState<THit extends NonNullable<object
     /**
      * The matched recommendations from Algolia API.
      */
-    items: Array<Hit<THit>>;
+    items: Array<AlgoliaHit<THit>>;
 };
 
 declare 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<FrequentlyBoughtTogetherProps<Hit<THit>>['headerComponent']>>[0], 'items'> & {
+    header: Template<Pick<Parameters<NonNullable<FrequentlyBoughtTogetherProps<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<FrequentlyBoughtTogetherProps<AlgoliaHit<THit>>['layout']>>[0], 'items'> & {
+        templates: {
+            item: FrequentlyBoughtTogetherProps<AlgoliaHit<THit>>['itemComponent'];
+        };
+        cssClasses: Pick<FrequentlyBoughtTogetherCSSClasses, 'list' | 'item'>;
+    }>;
 }>;
 
 declare type FrequentlyBoughtTogetherWidgetParams<THit extends NonNullable<object> = BaseHit> = {
@@ -4701,7 +4731,7 @@ declare type IndexWidget<TUiState extends UiState = UiState> = Omit<Widget<Index
     getIndexId: () => string;
     getHelper: () => AlgoliaSearchHelper | 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;
@@ -5147,6 +5177,7 @@ declare type InstantSearchModule = {
     middlewares: typeof middlewares;
     routers: typeof routers;
     stateMappings: typeof stateMappings;
+    templates: typeof templates;
     createInfiniteHitsSessionStorageCache: typeof createInfiniteHitsSessionStorageCache;
     /** @deprecated use html tagged templates and the Highlight component instead */
     highlight: typeof helpers.highlight;
@@ -5314,8 +5345,8 @@ declare type LookingSimilarConnectorParams<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>>;
     }>;
 };
 
@@ -5325,24 +5356,33 @@ declare type LookingSimilarRenderState<THit extends NonNullable<object> = BaseHi
     /**
      * The matched recommendations from the Algolia API.
      */
-    items: Array<Hit<THit>>;
+    items: Array<AlgoliaHit<THit>>;
 };
 
 declare type LookingSimilarTemplates<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<LookingSimilarProps<Hit<THit>>['headerComponent']>>[0], 'items'> & {
+    header: Template<Pick<Parameters<NonNullable<LookingSimilarProps<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<LookingSimilarProps<AlgoliaHit<THit>>['layout']>>[0], 'items'> & {
+        templates: {
+            item: LookingSimilarProps<AlgoliaHit<THit>>['itemComponent'];
+        };
+        cssClasses: Pick<LookingSimilarCSSClasses, 'list' | 'item'>;
+    }>;
 }>;
 
 declare type LookingSimilarWidgetParams<THit extends NonNullable<object> = BaseHit> = {
@@ -6734,7 +6774,7 @@ declare type Read<THit extends NonNullable<object>> = ({ state, }: {
 }) => InfiniteHitsCachedHits<THit> | null;
 
 declare type RecommendRenderOptions = SharedRenderOptions & {
-    results: RecommendResultItem;
+    results: RecommendResponse<any>;
 };
 
 declare type RecommendWidget<TWidgetDescription extends WidgetDescription & WidgetParams> = {
@@ -7116,8 +7156,8 @@ declare type RelatedProductsConnectorParams<THit extends NonNullable<object> = B
     /**
      * Function to transform the items passed to the templates.
      */
-    transformItems?: TransformItems<Hit<THit>, {
-        results: RecommendResultItem;
+    transformItems?: TransformItems<AlgoliaHit<THit>, {
+        results: RecommendResponse<AlgoliaHit<THit>>;
     }>;
 };
 
@@ -7127,24 +7167,33 @@ declare type RelatedProductsRenderState<THit extends NonNullable<object> = BaseH
     /**
      * The matched recommendations from the Algolia API.
      */
-    items: Array<Hit<THit>>;
+    items: Array<AlgoliaHit<THit>>;
 };
 
 declare type RelatedProductsTemplates<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<RelatedProductsProps<Hit<THit>>['headerComponent']>>[0], 'items'> & {
+    header: Template<Pick<Parameters<NonNullable<RelatedProductsProps<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<RelatedProductsProps<AlgoliaHit<THit>>['layout']>>[0], 'items'> & {
+        templates: {
+            item: RelatedProductsProps<AlgoliaHit<THit>>['itemComponent'];
+        };
+        cssClasses: Pick<RelatedProductsCSSClasses, 'list' | 'item'>;
+    }>;
 }>;
 
 declare type RelatedProductsWidgetParams<THit extends NonNullable<object> = BaseHit> = {
@@ -8024,6 +8073,10 @@ declare type Status = 'initial' | 'askingPermission' | 'waiting' | 'recognizing'
 
 declare type Template<TTemplateData = void> = string | ((data: TTemplateData, params: TemplateParams) => VNode | VNode[] | string | null);
 
+declare type Template_2 = (params: {
+    html: typeof html;
+}) => VNode_2 | VNode_2[] | null;
+
 declare type TemplateParams = {
     html: typeof html;
     components: {
@@ -8039,6 +8092,12 @@ declare type Templates = {
     [key: string]: Template<any> | TemplateWithBindEvent<any> | undefined;
 };
 
+declare namespace templates {
+    export {
+        carousel
+    }
+}
+
 declare type TemplatesConfig = {
     helpers?: HoganHelpers;
     compileOptions?: HoganOptions;
@@ -8261,8 +8320,8 @@ declare type TrendingItemsConnectorParams<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>>;
     }>;
 };
 
@@ -8272,24 +8331,33 @@ declare type TrendingItemsRenderState<THit extends NonNullable<object> = BaseHit
     /**
      * The matched recommendations from the Algolia API.
      */
-    items: Array<Hit<THit>>;
+    items: Array<AlgoliaHit<THit>>;
 };
 
 declare type TrendingItemsTemplates<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<TrendingItemsProps<Hit<THit>>['headerComponent']>>[0], 'items'> & {
+    header: Template<Pick<Parameters<NonNullable<TrendingItemsProps<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<TrendingItemsProps<AlgoliaHit<THit>>['layout']>>[0], 'items'> & {
+        templates: {
+            item: TrendingItemsProps<AlgoliaHit<THit>>['itemComponent'];
+        };
+        cssClasses: Pick<TrendingItemsCSSClasses, 'list' | 'item'>;
+    }>;
 }>;
 
 declare type TrendingItemsWidgetParams<THit extends NonNullable<object> = BaseHit> = {
@@ -8446,6 +8514,7 @@ declare type WidgetRenderStates = AnalyticsWidgetDescription['indexRenderState']
 declare namespace widgets {
     export {
         EXPERIMENTAL_answers,
+        EXPERIMENTAL_configureRelatedItems,
         EXPERIMENTAL_dynamicWidgets,
         dynamicWidgets,
         analytics,
@@ -8453,7 +8522,6 @@ declare namespace widgets {
         clearRefinements,
         configure,
         currentRefinements,
-        configureRelatedItems as EXPERIMENTAL_configureRelatedItems,
         _default_8 as geoSearch,
         hierarchicalMenu,
         _default_9 as hits,