instantsearch.js 4.75.7 → 4.77.0

package/dist/instantsearch.development.d.ts

@@ -1,6 +1,7 @@
 import { AlgoliaSearchHelper } from 'algoliasearch-helper';
 import { Banner } from 'algoliasearch-helper';
 import type { CarouselProps } from 'instantsearch-ui-components';
+import { CompositionClient } from 'algoliasearch-helper/types/algoliasearch.js';
 import EventEmitter from '@algolia/events';
 import { FindAnswersOptions } from 'algoliasearch-helper/types/algoliasearch.js';
 import type { FrequentlyBoughtTogetherProps } from 'instantsearch-ui-components';
@@ -562,13 +563,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 function carousel<TObject extends Record<string, unknown>>({ cssClasses, templates, }?: CreateCarouselTemplateProps<TObject>): ({ items, templates: widgetTemplates, cssClasses: widgetCssClasses, sendEvent, }: 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']>;
+} & {
+    sendEvent?: CarouselProps<TObject>['sendEvent'];
 };
 
 declare const clearRefinements: ClearRefinementsWidget;
@@ -1798,7 +1801,7 @@ declare const _default_12: <THit extends NonNullable<object> = BaseHit>(widgetPa
         analytics?: WidgetRenderState<Record<string, unknown>, AnalyticsWidgetParams> | undefined;
         places?: WidgetRenderState<Record<string, unknown>, PlacesWidgetParams> | undefined;
     };
-    getWidgetRenderState({ results }: InitOptions | RenderOptions | ({
+    getWidgetRenderState({ results, helper, instantSearchInstance }: InitOptions | RenderOptions | ({
         instantSearchInstance: InstantSearch;
         parent: IndexWidget;
         templatesConfig: Record<string, unknown>;
@@ -1887,6 +1890,7 @@ declare const _default_12: <THit extends NonNullable<object> = BaseHit>(widgetPa
     })): {
         items: AlgoliaHit<BaseHit>[] | AlgoliaHit<THit>[];
         widgetParams: Partial<RelatedProductsWidgetParams<BaseHit>> & RelatedProductsConnectorParams<THit>;
+        sendEvent: SendEventForHits;
     };
     dispose({ recommendState }: DisposeOptions): RecommendParameters;
     getWidgetParameters(state: RecommendParameters): RecommendParameters;
@@ -1987,7 +1991,7 @@ declare const _default_13: <THit extends NonNullable<object> = BaseHit>(widgetPa
         analytics?: WidgetRenderState<Record<string, unknown>, AnalyticsWidgetParams> | undefined;
         places?: WidgetRenderState<Record<string, unknown>, PlacesWidgetParams> | undefined;
     };
-    getWidgetRenderState({ results }: InitOptions | RenderOptions | ({
+    getWidgetRenderState({ results, helper, instantSearchInstance }: InitOptions | RenderOptions | ({
         instantSearchInstance: InstantSearch;
         parent: IndexWidget;
         templatesConfig: Record<string, unknown>;
@@ -2076,6 +2080,7 @@ declare const _default_13: <THit extends NonNullable<object> = BaseHit>(widgetPa
     })): {
         items: AlgoliaHit<THit>[];
         widgetParams: Partial<TrendingItemsWidgetParams<BaseHit>> & TrendingItemsConnectorParams<THit>;
+        sendEvent: SendEventForHits;
     };
     dispose({ recommendState }: DisposeOptions): RecommendParameters;
     getWidgetParameters(state: RecommendParameters): RecommendParameters;
@@ -2176,7 +2181,7 @@ declare const _default_14: <THit extends NonNullable<object> = BaseHit>(widgetPa
         analytics?: WidgetRenderState<Record<string, unknown>, AnalyticsWidgetParams> | undefined;
         places?: WidgetRenderState<Record<string, unknown>, PlacesWidgetParams> | undefined;
     };
-    getWidgetRenderState({ results }: InitOptions | RenderOptions | ({
+    getWidgetRenderState({ results, helper, instantSearchInstance }: InitOptions | RenderOptions | ({
         instantSearchInstance: InstantSearch;
         parent: IndexWidget;
         templatesConfig: Record<string, unknown>;
@@ -2265,6 +2270,7 @@ declare const _default_14: <THit extends NonNullable<object> = BaseHit>(widgetPa
     })): {
         items: AlgoliaHit<THit>[];
         widgetParams: Partial<FrequentlyBoughtTogetherWidgetParams<BaseHit>> & FrequentlyBoughtTogetherConnectorParams<THit>;
+        sendEvent: SendEventForHits;
     };
     dispose({ recommendState }: DisposeOptions): RecommendParameters;
     getWidgetParameters(state: RecommendParameters): RecommendParameters;
@@ -2365,7 +2371,7 @@ declare const _default_15: <THit extends NonNullable<object> = BaseHit>(widgetPa
         analytics?: WidgetRenderState<Record<string, unknown>, AnalyticsWidgetParams> | undefined;
         places?: WidgetRenderState<Record<string, unknown>, PlacesWidgetParams> | undefined;
     };
-    getWidgetRenderState({ results }: InitOptions | RenderOptions | ({
+    getWidgetRenderState({ results, helper, instantSearchInstance }: InitOptions | RenderOptions | ({
         instantSearchInstance: InstantSearch;
         parent: IndexWidget;
         templatesConfig: Record<string, unknown>;
@@ -2454,6 +2460,7 @@ declare const _default_15: <THit extends NonNullable<object> = BaseHit>(widgetPa
     })): {
         items: AlgoliaHit<THit>[];
         widgetParams: Partial<LookingSimilarWidgetParams<BaseHit>> & LookingSimilarConnectorParams<THit>;
+        sendEvent: SendEventForHits;
     };
     dispose({ recommendState }: DisposeOptions): RecommendParameters;
     getWidgetParameters(state: RecommendParameters): RecommendParameters;
@@ -2731,7 +2738,7 @@ declare const _default_3: <TWidgetParams extends UnknownWidgetParams>(renderFn:
         analytics?: WidgetRenderState<Record<string, unknown>, AnalyticsWidgetParams> | undefined;
         places?: WidgetRenderState<Record<string, unknown>, PlacesWidgetParams> | undefined;
     };
-    getWidgetRenderState({ results }: InitOptions | RenderOptions | ({
+    getWidgetRenderState({ results, helper, instantSearchInstance }: InitOptions | RenderOptions | ({
         instantSearchInstance: InstantSearch;
         parent: IndexWidget;
         templatesConfig: Record<string, unknown>;
@@ -2750,6 +2757,7 @@ declare const _default_3: <TWidgetParams extends UnknownWidgetParams>(renderFn:
     })): {
         items: AlgoliaHit<BaseHit>[] | AlgoliaHit<THit>[];
         widgetParams: TWidgetParams & RelatedProductsConnectorParams<THit>;
+        sendEvent: SendEventForHits;
     };
     dispose({ recommendState }: DisposeOptions): RecommendParameters;
     getWidgetParameters(state: RecommendParameters): RecommendParameters;
@@ -2849,7 +2857,7 @@ declare const _default_4: <TWidgetParams extends UnknownWidgetParams>(renderFn:
         analytics?: WidgetRenderState<Record<string, unknown>, AnalyticsWidgetParams> | undefined;
         places?: WidgetRenderState<Record<string, unknown>, PlacesWidgetParams> | undefined;
     };
-    getWidgetRenderState({ results }: InitOptions | RenderOptions | ({
+    getWidgetRenderState({ results, helper, instantSearchInstance }: InitOptions | RenderOptions | ({
         instantSearchInstance: InstantSearch;
         parent: IndexWidget;
         templatesConfig: Record<string, unknown>;
@@ -2868,6 +2876,7 @@ declare const _default_4: <TWidgetParams extends UnknownWidgetParams>(renderFn:
     })): {
         items: AlgoliaHit<THit>[];
         widgetParams: TWidgetParams & TrendingItemsConnectorParams<THit>;
+        sendEvent: SendEventForHits;
     };
     dispose({ recommendState }: DisposeOptions): RecommendParameters;
     getWidgetParameters(state: RecommendParameters): RecommendParameters;
@@ -3187,7 +3196,7 @@ declare const _default_6: <TWidgetParams extends UnknownWidgetParams>(renderFn:
         analytics?: WidgetRenderState<Record<string, unknown>, AnalyticsWidgetParams> | undefined;
         places?: WidgetRenderState<Record<string, unknown>, PlacesWidgetParams> | undefined;
     };
-    getWidgetRenderState({ results }: InitOptions | RenderOptions | ({
+    getWidgetRenderState({ results, helper, instantSearchInstance }: InitOptions | RenderOptions | ({
         instantSearchInstance: InstantSearch;
         parent: IndexWidget;
         templatesConfig: Record<string, unknown>;
@@ -3206,6 +3215,7 @@ declare const _default_6: <TWidgetParams extends UnknownWidgetParams>(renderFn:
     })): {
         items: AlgoliaHit<THit>[];
         widgetParams: TWidgetParams & FrequentlyBoughtTogetherConnectorParams<THit>;
+        sendEvent: SendEventForHits;
     };
     dispose({ recommendState }: DisposeOptions): RecommendParameters;
     getWidgetParameters(state: RecommendParameters): RecommendParameters;
@@ -3305,7 +3315,7 @@ declare const _default_7: <TWidgetParams extends UnknownWidgetParams>(renderFn:
         analytics?: WidgetRenderState<Record<string, unknown>, AnalyticsWidgetParams> | undefined;
         places?: WidgetRenderState<Record<string, unknown>, PlacesWidgetParams> | undefined;
     };
-    getWidgetRenderState({ results }: InitOptions | RenderOptions | ({
+    getWidgetRenderState({ results, helper, instantSearchInstance }: InitOptions | RenderOptions | ({
         instantSearchInstance: InstantSearch;
         parent: IndexWidget;
         templatesConfig: Record<string, unknown>;
@@ -3324,6 +3334,7 @@ declare const _default_7: <TWidgetParams extends UnknownWidgetParams>(renderFn:
     })): {
         items: AlgoliaHit<THit>[];
         widgetParams: TWidgetParams & LookingSimilarConnectorParams<THit>;
+        sendEvent: SendEventForHits;
     };
     dispose({ recommendState }: DisposeOptions): RecommendParameters;
     getWidgetParameters(state: RecommendParameters): RecommendParameters;
@@ -3847,6 +3858,10 @@ declare type FrequentlyBoughtTogetherRenderState<THit extends NonNullable<object
      * The matched recommendations from Algolia API.
      */
     items: Array<AlgoliaHit<THit>>;
+    /**
+     * Sends an event to the Insights middleware.
+     */
+    sendEvent: SendEventForHits;
 };
 
 declare type FrequentlyBoughtTogetherTemplates<THit extends NonNullable<object> = BaseHit> = Partial<{
@@ -5047,6 +5062,7 @@ declare type InsightsProps<TInsightsClient extends ProvidedInsightsClient = Prov
 declare class InstantSearch<TUiState extends UiState = UiState, TRouteState = TUiState> extends EventEmitter {
     client: InstantSearchOptions['searchClient'];
     indexName: string;
+    compositionID?: string;
     insightsClient: InsightsClient | null;
     onStateChange: InstantSearchOptions<TUiState>['onStateChange'] | null;
     future: NonNullable<InstantSearchOptions<TUiState>['future']>;
@@ -5208,6 +5224,12 @@ declare type InstantSearchOptions<TUiState extends UiState = UiState, TRouteStat
      * The name of the main index. If no indexName is provided, you have to manually add an index widget.
      */
     indexName?: string;
+    /**
+     * The objectID of the composition.
+     * If this is passed, the composition API will be used for search.
+     * Multi-index search is not supported with this option.
+     */
+    compositionID?: string;
     /**
      * The search client to plug to InstantSearch.js
      *
@@ -5235,7 +5257,7 @@ declare type InstantSearchOptions<TUiState extends UiState = UiState, TRouteStat
      * });
      * ```
      */
-    searchClient: SearchClient;
+    searchClient: SearchClient | CompositionClient;
     /**
      * The locale used to display numbers. This will be passed
      * to `Number.prototype.toLocaleString()`
@@ -5363,6 +5385,10 @@ declare type LookingSimilarRenderState<THit extends NonNullable<object> = BaseHi
      * The matched recommendations from the Algolia API.
      */
     items: Array<AlgoliaHit<THit>>;
+    /**
+     * Sends an event to the Insights middleware.
+     */
+    sendEvent: SendEventForHits;
 };
 
 declare type LookingSimilarTemplates<THit extends NonNullable<object> = BaseHit> = Partial<{
@@ -7174,6 +7200,10 @@ declare type RelatedProductsRenderState<THit extends NonNullable<object> = BaseH
      * The matched recommendations from the Algolia API.
      */
     items: Array<AlgoliaHit<THit>>;
+    /**
+     * Sends an event to the Insights middleware.
+     */
+    sendEvent: SendEventForHits;
 };
 
 declare type RelatedProductsTemplates<THit extends NonNullable<object> = BaseHit> = Partial<{
@@ -8338,6 +8368,10 @@ declare type TrendingItemsRenderState<THit extends NonNullable<object> = BaseHit
      * The matched recommendations from the Algolia API.
      */
     items: Array<AlgoliaHit<THit>>;
+    /**
+     * Sends an event to the Insights middleware.
+     */
+    sendEvent: SendEventForHits;
 };
 
 declare type TrendingItemsTemplates<THit extends NonNullable<object> = BaseHit> = Partial<{