instantsearch.js 4.76.0 → 4.77.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/cjs/components/RefinementList/RefinementList.js +2 -2
  2. package/cjs/connectors/frequently-bought-together/connectFrequentlyBoughtTogether.js +20 -4
  3. package/cjs/connectors/looking-similar/connectLookingSimilar.js +23 -6
  4. package/cjs/connectors/related-products/connectRelatedProducts.js +23 -6
  5. package/cjs/connectors/trending-items/connectTrendingItems.js +23 -6
  6. package/cjs/lib/utils/getAppIdAndApiKey.js +3 -3
  7. package/cjs/lib/version.js +1 -1
  8. package/cjs/templates/carousel/carousel.js +4 -1
  9. package/cjs/widgets/frequently-bought-together/frequently-bought-together.js +17 -6
  10. package/cjs/widgets/looking-similar/looking-similar.js +16 -5
  11. package/cjs/widgets/related-products/related-products.js +17 -6
  12. package/cjs/widgets/trending-items/trending-items.js +17 -6
  13. package/dist/instantsearch.development.d.ts +39 -13
  14. package/dist/instantsearch.development.js +211 -64
  15. package/dist/instantsearch.development.js.map +1 -1
  16. package/dist/instantsearch.production.d.ts +39 -13
  17. package/dist/instantsearch.production.min.d.ts +39 -13
  18. package/dist/instantsearch.production.min.js +2 -2
  19. package/dist/instantsearch.production.min.js.map +1 -1
  20. package/es/components/RefinementList/RefinementList.js +2 -2
  21. package/es/connectors/frequently-bought-together/connectFrequentlyBoughtTogether.d.ts +7 -1
  22. package/es/connectors/frequently-bought-together/connectFrequentlyBoughtTogether.js +21 -5
  23. package/es/connectors/looking-similar/connectLookingSimilar.d.ts +7 -1
  24. package/es/connectors/looking-similar/connectLookingSimilar.js +24 -7
  25. package/es/connectors/related-products/connectRelatedProducts.d.ts +7 -1
  26. package/es/connectors/related-products/connectRelatedProducts.js +24 -7
  27. package/es/connectors/trending-items/connectTrendingItems.d.ts +7 -1
  28. package/es/connectors/trending-items/connectTrendingItems.js +24 -7
  29. package/es/lib/utils/getAppIdAndApiKey.js +3 -3
  30. package/es/lib/version.d.ts +1 -1
  31. package/es/lib/version.js +1 -1
  32. package/es/templates/carousel/carousel.d.ts +3 -1
  33. package/es/templates/carousel/carousel.js +4 -1
  34. package/es/widgets/frequently-bought-together/frequently-bought-together.d.ts +4 -3
  35. package/es/widgets/frequently-bought-together/frequently-bought-together.js +17 -6
  36. package/es/widgets/looking-similar/looking-similar.d.ts +4 -3
  37. package/es/widgets/looking-similar/looking-similar.js +16 -5
  38. package/es/widgets/related-products/related-products.d.ts +4 -3
  39. package/es/widgets/related-products/related-products.js +17 -6
  40. package/es/widgets/trending-items/trending-items.d.ts +4 -3
  41. package/es/widgets/trending-items/trending-items.js +17 -6
  42. package/package.json +7 -7
@@ -563,13 +563,15 @@ declare type BuiltInSendEventForHits = (eventType: string, hits: Hit | Hit[], ev
563
563
 
564
564
  declare type BuiltInSendEventForToggle = (eventType: string, isRefined: boolean, eventName?: string) => void;
565
565
 
566
- declare function carousel<TObject extends Record<string, unknown>>({ cssClasses, templates, }?: CreateCarouselTemplateProps<TObject>): ({ items, templates: widgetTemplates, cssClasses: widgetCssClasses, }: CarouselTemplateProps<TObject>) => h.JSX.Element;
566
+ declare function carousel<TObject extends Record<string, unknown>>({ cssClasses, templates, }?: CreateCarouselTemplateProps<TObject>): ({ items, templates: widgetTemplates, cssClasses: widgetCssClasses, sendEvent, }: CarouselTemplateProps<TObject>) => h.JSX.Element;
567
567
 
568
568
  declare type CarouselTemplateProps<TObject extends Record<string, unknown>> = Pick<CarouselProps<TObject>, 'items'> & {
569
569
  templates: {
570
570
  item?: CarouselProps<TObject>['itemComponent'];
571
571
  };
572
572
  cssClasses?: Partial<CarouselProps<TObject>['classNames']>;
573
+ } & {
574
+ sendEvent?: CarouselProps<TObject>['sendEvent'];
573
575
  };
574
576
 
575
577
  declare const clearRefinements: ClearRefinementsWidget;
@@ -1799,7 +1801,7 @@ declare const _default_12: <THit extends NonNullable<object> = BaseHit>(widgetPa
1799
1801
  analytics?: WidgetRenderState<Record<string, unknown>, AnalyticsWidgetParams> | undefined;
1800
1802
  places?: WidgetRenderState<Record<string, unknown>, PlacesWidgetParams> | undefined;
1801
1803
  };
1802
- getWidgetRenderState({ results }: InitOptions | RenderOptions | ({
1804
+ getWidgetRenderState({ results, helper, instantSearchInstance }: InitOptions | RenderOptions | ({
1803
1805
  instantSearchInstance: InstantSearch;
1804
1806
  parent: IndexWidget;
1805
1807
  templatesConfig: Record<string, unknown>;
@@ -1888,6 +1890,7 @@ declare const _default_12: <THit extends NonNullable<object> = BaseHit>(widgetPa
1888
1890
  })): {
1889
1891
  items: AlgoliaHit<BaseHit>[] | AlgoliaHit<THit>[];
1890
1892
  widgetParams: Partial<RelatedProductsWidgetParams<BaseHit>> & RelatedProductsConnectorParams<THit>;
1893
+ sendEvent: SendEventForHits;
1891
1894
  };
1892
1895
  dispose({ recommendState }: DisposeOptions): RecommendParameters;
1893
1896
  getWidgetParameters(state: RecommendParameters): RecommendParameters;
@@ -1988,7 +1991,7 @@ declare const _default_13: <THit extends NonNullable<object> = BaseHit>(widgetPa
1988
1991
  analytics?: WidgetRenderState<Record<string, unknown>, AnalyticsWidgetParams> | undefined;
1989
1992
  places?: WidgetRenderState<Record<string, unknown>, PlacesWidgetParams> | undefined;
1990
1993
  };
1991
- getWidgetRenderState({ results }: InitOptions | RenderOptions | ({
1994
+ getWidgetRenderState({ results, helper, instantSearchInstance }: InitOptions | RenderOptions | ({
1992
1995
  instantSearchInstance: InstantSearch;
1993
1996
  parent: IndexWidget;
1994
1997
  templatesConfig: Record<string, unknown>;
@@ -2077,6 +2080,7 @@ declare const _default_13: <THit extends NonNullable<object> = BaseHit>(widgetPa
2077
2080
  })): {
2078
2081
  items: AlgoliaHit<THit>[];
2079
2082
  widgetParams: Partial<TrendingItemsWidgetParams<BaseHit>> & TrendingItemsConnectorParams<THit>;
2083
+ sendEvent: SendEventForHits;
2080
2084
  };
2081
2085
  dispose({ recommendState }: DisposeOptions): RecommendParameters;
2082
2086
  getWidgetParameters(state: RecommendParameters): RecommendParameters;
@@ -2177,7 +2181,7 @@ declare const _default_14: <THit extends NonNullable<object> = BaseHit>(widgetPa
2177
2181
  analytics?: WidgetRenderState<Record<string, unknown>, AnalyticsWidgetParams> | undefined;
2178
2182
  places?: WidgetRenderState<Record<string, unknown>, PlacesWidgetParams> | undefined;
2179
2183
  };
2180
- getWidgetRenderState({ results }: InitOptions | RenderOptions | ({
2184
+ getWidgetRenderState({ results, helper, instantSearchInstance }: InitOptions | RenderOptions | ({
2181
2185
  instantSearchInstance: InstantSearch;
2182
2186
  parent: IndexWidget;
2183
2187
  templatesConfig: Record<string, unknown>;
@@ -2266,6 +2270,7 @@ declare const _default_14: <THit extends NonNullable<object> = BaseHit>(widgetPa
2266
2270
  })): {
2267
2271
  items: AlgoliaHit<THit>[];
2268
2272
  widgetParams: Partial<FrequentlyBoughtTogetherWidgetParams<BaseHit>> & FrequentlyBoughtTogetherConnectorParams<THit>;
2273
+ sendEvent: SendEventForHits;
2269
2274
  };
2270
2275
  dispose({ recommendState }: DisposeOptions): RecommendParameters;
2271
2276
  getWidgetParameters(state: RecommendParameters): RecommendParameters;
@@ -2366,7 +2371,7 @@ declare const _default_15: <THit extends NonNullable<object> = BaseHit>(widgetPa
2366
2371
  analytics?: WidgetRenderState<Record<string, unknown>, AnalyticsWidgetParams> | undefined;
2367
2372
  places?: WidgetRenderState<Record<string, unknown>, PlacesWidgetParams> | undefined;
2368
2373
  };
2369
- getWidgetRenderState({ results }: InitOptions | RenderOptions | ({
2374
+ getWidgetRenderState({ results, helper, instantSearchInstance }: InitOptions | RenderOptions | ({
2370
2375
  instantSearchInstance: InstantSearch;
2371
2376
  parent: IndexWidget;
2372
2377
  templatesConfig: Record<string, unknown>;
@@ -2455,6 +2460,7 @@ declare const _default_15: <THit extends NonNullable<object> = BaseHit>(widgetPa
2455
2460
  })): {
2456
2461
  items: AlgoliaHit<THit>[];
2457
2462
  widgetParams: Partial<LookingSimilarWidgetParams<BaseHit>> & LookingSimilarConnectorParams<THit>;
2463
+ sendEvent: SendEventForHits;
2458
2464
  };
2459
2465
  dispose({ recommendState }: DisposeOptions): RecommendParameters;
2460
2466
  getWidgetParameters(state: RecommendParameters): RecommendParameters;
@@ -2732,7 +2738,7 @@ declare const _default_3: <TWidgetParams extends UnknownWidgetParams>(renderFn:
2732
2738
  analytics?: WidgetRenderState<Record<string, unknown>, AnalyticsWidgetParams> | undefined;
2733
2739
  places?: WidgetRenderState<Record<string, unknown>, PlacesWidgetParams> | undefined;
2734
2740
  };
2735
- getWidgetRenderState({ results }: InitOptions | RenderOptions | ({
2741
+ getWidgetRenderState({ results, helper, instantSearchInstance }: InitOptions | RenderOptions | ({
2736
2742
  instantSearchInstance: InstantSearch;
2737
2743
  parent: IndexWidget;
2738
2744
  templatesConfig: Record<string, unknown>;
@@ -2751,6 +2757,7 @@ declare const _default_3: <TWidgetParams extends UnknownWidgetParams>(renderFn:
2751
2757
  })): {
2752
2758
  items: AlgoliaHit<BaseHit>[] | AlgoliaHit<THit>[];
2753
2759
  widgetParams: TWidgetParams & RelatedProductsConnectorParams<THit>;
2760
+ sendEvent: SendEventForHits;
2754
2761
  };
2755
2762
  dispose({ recommendState }: DisposeOptions): RecommendParameters;
2756
2763
  getWidgetParameters(state: RecommendParameters): RecommendParameters;
@@ -2850,7 +2857,7 @@ declare const _default_4: <TWidgetParams extends UnknownWidgetParams>(renderFn:
2850
2857
  analytics?: WidgetRenderState<Record<string, unknown>, AnalyticsWidgetParams> | undefined;
2851
2858
  places?: WidgetRenderState<Record<string, unknown>, PlacesWidgetParams> | undefined;
2852
2859
  };
2853
- getWidgetRenderState({ results }: InitOptions | RenderOptions | ({
2860
+ getWidgetRenderState({ results, helper, instantSearchInstance }: InitOptions | RenderOptions | ({
2854
2861
  instantSearchInstance: InstantSearch;
2855
2862
  parent: IndexWidget;
2856
2863
  templatesConfig: Record<string, unknown>;
@@ -2869,6 +2876,7 @@ declare const _default_4: <TWidgetParams extends UnknownWidgetParams>(renderFn:
2869
2876
  })): {
2870
2877
  items: AlgoliaHit<THit>[];
2871
2878
  widgetParams: TWidgetParams & TrendingItemsConnectorParams<THit>;
2879
+ sendEvent: SendEventForHits;
2872
2880
  };
2873
2881
  dispose({ recommendState }: DisposeOptions): RecommendParameters;
2874
2882
  getWidgetParameters(state: RecommendParameters): RecommendParameters;
@@ -3188,7 +3196,7 @@ declare const _default_6: <TWidgetParams extends UnknownWidgetParams>(renderFn:
3188
3196
  analytics?: WidgetRenderState<Record<string, unknown>, AnalyticsWidgetParams> | undefined;
3189
3197
  places?: WidgetRenderState<Record<string, unknown>, PlacesWidgetParams> | undefined;
3190
3198
  };
3191
- getWidgetRenderState({ results }: InitOptions | RenderOptions | ({
3199
+ getWidgetRenderState({ results, helper, instantSearchInstance }: InitOptions | RenderOptions | ({
3192
3200
  instantSearchInstance: InstantSearch;
3193
3201
  parent: IndexWidget;
3194
3202
  templatesConfig: Record<string, unknown>;
@@ -3207,6 +3215,7 @@ declare const _default_6: <TWidgetParams extends UnknownWidgetParams>(renderFn:
3207
3215
  })): {
3208
3216
  items: AlgoliaHit<THit>[];
3209
3217
  widgetParams: TWidgetParams & FrequentlyBoughtTogetherConnectorParams<THit>;
3218
+ sendEvent: SendEventForHits;
3210
3219
  };
3211
3220
  dispose({ recommendState }: DisposeOptions): RecommendParameters;
3212
3221
  getWidgetParameters(state: RecommendParameters): RecommendParameters;
@@ -3306,7 +3315,7 @@ declare const _default_7: <TWidgetParams extends UnknownWidgetParams>(renderFn:
3306
3315
  analytics?: WidgetRenderState<Record<string, unknown>, AnalyticsWidgetParams> | undefined;
3307
3316
  places?: WidgetRenderState<Record<string, unknown>, PlacesWidgetParams> | undefined;
3308
3317
  };
3309
- getWidgetRenderState({ results }: InitOptions | RenderOptions | ({
3318
+ getWidgetRenderState({ results, helper, instantSearchInstance }: InitOptions | RenderOptions | ({
3310
3319
  instantSearchInstance: InstantSearch;
3311
3320
  parent: IndexWidget;
3312
3321
  templatesConfig: Record<string, unknown>;
@@ -3325,6 +3334,7 @@ declare const _default_7: <TWidgetParams extends UnknownWidgetParams>(renderFn:
3325
3334
  })): {
3326
3335
  items: AlgoliaHit<THit>[];
3327
3336
  widgetParams: TWidgetParams & LookingSimilarConnectorParams<THit>;
3337
+ sendEvent: SendEventForHits;
3328
3338
  };
3329
3339
  dispose({ recommendState }: DisposeOptions): RecommendParameters;
3330
3340
  getWidgetParameters(state: RecommendParameters): RecommendParameters;
@@ -3848,6 +3858,10 @@ declare type FrequentlyBoughtTogetherRenderState<THit extends NonNullable<object
3848
3858
  * The matched recommendations from Algolia API.
3849
3859
  */
3850
3860
  items: Array<AlgoliaHit<THit>>;
3861
+ /**
3862
+ * Sends an event to the Insights middleware.
3863
+ */
3864
+ sendEvent: SendEventForHits;
3851
3865
  };
3852
3866
 
3853
3867
  declare type FrequentlyBoughtTogetherTemplates<THit extends NonNullable<object> = BaseHit> = Partial<{
@@ -3864,7 +3878,7 @@ declare type FrequentlyBoughtTogetherTemplates<THit extends NonNullable<object>
3864
3878
  /**
3865
3879
  * Template to use for each result. This template will receive an object containing a single record.
3866
3880
  */
3867
- item: Template<AlgoliaHit<THit>>;
3881
+ item: TemplateWithBindEvent<AlgoliaHit<THit>>;
3868
3882
  /**
3869
3883
  * Template to use to wrap all items.
3870
3884
  */
@@ -5371,6 +5385,10 @@ declare type LookingSimilarRenderState<THit extends NonNullable<object> = BaseHi
5371
5385
  * The matched recommendations from the Algolia API.
5372
5386
  */
5373
5387
  items: Array<AlgoliaHit<THit>>;
5388
+ /**
5389
+ * Sends an event to the Insights middleware.
5390
+ */
5391
+ sendEvent: SendEventForHits;
5374
5392
  };
5375
5393
 
5376
5394
  declare type LookingSimilarTemplates<THit extends NonNullable<object> = BaseHit> = Partial<{
@@ -5387,7 +5405,7 @@ declare type LookingSimilarTemplates<THit extends NonNullable<object> = BaseHit>
5387
5405
  /**
5388
5406
  * Template to use for each result. This template will receive an object containing a single record.
5389
5407
  */
5390
- item: Template<AlgoliaHit<THit>>;
5408
+ item: TemplateWithBindEvent<AlgoliaHit<THit>>;
5391
5409
  /**
5392
5410
  * Template to use to wrap all items.
5393
5411
  */
@@ -7182,6 +7200,10 @@ declare type RelatedProductsRenderState<THit extends NonNullable<object> = BaseH
7182
7200
  * The matched recommendations from the Algolia API.
7183
7201
  */
7184
7202
  items: Array<AlgoliaHit<THit>>;
7203
+ /**
7204
+ * Sends an event to the Insights middleware.
7205
+ */
7206
+ sendEvent: SendEventForHits;
7185
7207
  };
7186
7208
 
7187
7209
  declare type RelatedProductsTemplates<THit extends NonNullable<object> = BaseHit> = Partial<{
@@ -7198,7 +7220,7 @@ declare type RelatedProductsTemplates<THit extends NonNullable<object> = BaseHit
7198
7220
  /**
7199
7221
  * Template to use for each result. This template will receive an object containing a single record.
7200
7222
  */
7201
- item: Template<AlgoliaHit<THit>>;
7223
+ item: TemplateWithBindEvent<AlgoliaHit<THit>>;
7202
7224
  /**
7203
7225
  * Template to use to wrap all items.
7204
7226
  */
@@ -8346,6 +8368,10 @@ declare type TrendingItemsRenderState<THit extends NonNullable<object> = BaseHit
8346
8368
  * The matched recommendations from the Algolia API.
8347
8369
  */
8348
8370
  items: Array<AlgoliaHit<THit>>;
8371
+ /**
8372
+ * Sends an event to the Insights middleware.
8373
+ */
8374
+ sendEvent: SendEventForHits;
8349
8375
  };
8350
8376
 
8351
8377
  declare type TrendingItemsTemplates<THit extends NonNullable<object> = BaseHit> = Partial<{
@@ -8362,7 +8388,7 @@ declare type TrendingItemsTemplates<THit extends NonNullable<object> = BaseHit>
8362
8388
  /**
8363
8389
  * Template to use for each result. This template will receive an object containing a single record.
8364
8390
  */
8365
- item: Template<AlgoliaHit<THit>>;
8391
+ item: TemplateWithBindEvent<AlgoliaHit<THit>>;
8366
8392
  /**
8367
8393
  * Template to use to wrap all items.
8368
8394
  */
@@ -563,13 +563,15 @@ declare type BuiltInSendEventForHits = (eventType: string, hits: Hit | Hit[], ev
563
563
 
564
564
  declare type BuiltInSendEventForToggle = (eventType: string, isRefined: boolean, eventName?: string) => void;
565
565
 
566
- declare function carousel<TObject extends Record<string, unknown>>({ cssClasses, templates, }?: CreateCarouselTemplateProps<TObject>): ({ items, templates: widgetTemplates, cssClasses: widgetCssClasses, }: CarouselTemplateProps<TObject>) => h.JSX.Element;
566
+ declare function carousel<TObject extends Record<string, unknown>>({ cssClasses, templates, }?: CreateCarouselTemplateProps<TObject>): ({ items, templates: widgetTemplates, cssClasses: widgetCssClasses, sendEvent, }: CarouselTemplateProps<TObject>) => h.JSX.Element;
567
567
 
568
568
  declare type CarouselTemplateProps<TObject extends Record<string, unknown>> = Pick<CarouselProps<TObject>, 'items'> & {
569
569
  templates: {
570
570
  item?: CarouselProps<TObject>['itemComponent'];
571
571
  };
572
572
  cssClasses?: Partial<CarouselProps<TObject>['classNames']>;
573
+ } & {
574
+ sendEvent?: CarouselProps<TObject>['sendEvent'];
573
575
  };
574
576
 
575
577
  declare const clearRefinements: ClearRefinementsWidget;
@@ -1799,7 +1801,7 @@ declare const _default_12: <THit extends NonNullable<object> = BaseHit>(widgetPa
1799
1801
  analytics?: WidgetRenderState<Record<string, unknown>, AnalyticsWidgetParams> | undefined;
1800
1802
  places?: WidgetRenderState<Record<string, unknown>, PlacesWidgetParams> | undefined;
1801
1803
  };
1802
- getWidgetRenderState({ results }: InitOptions | RenderOptions | ({
1804
+ getWidgetRenderState({ results, helper, instantSearchInstance }: InitOptions | RenderOptions | ({
1803
1805
  instantSearchInstance: InstantSearch;
1804
1806
  parent: IndexWidget;
1805
1807
  templatesConfig: Record<string, unknown>;
@@ -1888,6 +1890,7 @@ declare const _default_12: <THit extends NonNullable<object> = BaseHit>(widgetPa
1888
1890
  })): {
1889
1891
  items: AlgoliaHit<BaseHit>[] | AlgoliaHit<THit>[];
1890
1892
  widgetParams: Partial<RelatedProductsWidgetParams<BaseHit>> & RelatedProductsConnectorParams<THit>;
1893
+ sendEvent: SendEventForHits;
1891
1894
  };
1892
1895
  dispose({ recommendState }: DisposeOptions): RecommendParameters;
1893
1896
  getWidgetParameters(state: RecommendParameters): RecommendParameters;
@@ -1988,7 +1991,7 @@ declare const _default_13: <THit extends NonNullable<object> = BaseHit>(widgetPa
1988
1991
  analytics?: WidgetRenderState<Record<string, unknown>, AnalyticsWidgetParams> | undefined;
1989
1992
  places?: WidgetRenderState<Record<string, unknown>, PlacesWidgetParams> | undefined;
1990
1993
  };
1991
- getWidgetRenderState({ results }: InitOptions | RenderOptions | ({
1994
+ getWidgetRenderState({ results, helper, instantSearchInstance }: InitOptions | RenderOptions | ({
1992
1995
  instantSearchInstance: InstantSearch;
1993
1996
  parent: IndexWidget;
1994
1997
  templatesConfig: Record<string, unknown>;
@@ -2077,6 +2080,7 @@ declare const _default_13: <THit extends NonNullable<object> = BaseHit>(widgetPa
2077
2080
  })): {
2078
2081
  items: AlgoliaHit<THit>[];
2079
2082
  widgetParams: Partial<TrendingItemsWidgetParams<BaseHit>> & TrendingItemsConnectorParams<THit>;
2083
+ sendEvent: SendEventForHits;
2080
2084
  };
2081
2085
  dispose({ recommendState }: DisposeOptions): RecommendParameters;
2082
2086
  getWidgetParameters(state: RecommendParameters): RecommendParameters;
@@ -2177,7 +2181,7 @@ declare const _default_14: <THit extends NonNullable<object> = BaseHit>(widgetPa
2177
2181
  analytics?: WidgetRenderState<Record<string, unknown>, AnalyticsWidgetParams> | undefined;
2178
2182
  places?: WidgetRenderState<Record<string, unknown>, PlacesWidgetParams> | undefined;
2179
2183
  };
2180
- getWidgetRenderState({ results }: InitOptions | RenderOptions | ({
2184
+ getWidgetRenderState({ results, helper, instantSearchInstance }: InitOptions | RenderOptions | ({
2181
2185
  instantSearchInstance: InstantSearch;
2182
2186
  parent: IndexWidget;
2183
2187
  templatesConfig: Record<string, unknown>;
@@ -2266,6 +2270,7 @@ declare const _default_14: <THit extends NonNullable<object> = BaseHit>(widgetPa
2266
2270
  })): {
2267
2271
  items: AlgoliaHit<THit>[];
2268
2272
  widgetParams: Partial<FrequentlyBoughtTogetherWidgetParams<BaseHit>> & FrequentlyBoughtTogetherConnectorParams<THit>;
2273
+ sendEvent: SendEventForHits;
2269
2274
  };
2270
2275
  dispose({ recommendState }: DisposeOptions): RecommendParameters;
2271
2276
  getWidgetParameters(state: RecommendParameters): RecommendParameters;
@@ -2366,7 +2371,7 @@ declare const _default_15: <THit extends NonNullable<object> = BaseHit>(widgetPa
2366
2371
  analytics?: WidgetRenderState<Record<string, unknown>, AnalyticsWidgetParams> | undefined;
2367
2372
  places?: WidgetRenderState<Record<string, unknown>, PlacesWidgetParams> | undefined;
2368
2373
  };
2369
- getWidgetRenderState({ results }: InitOptions | RenderOptions | ({
2374
+ getWidgetRenderState({ results, helper, instantSearchInstance }: InitOptions | RenderOptions | ({
2370
2375
  instantSearchInstance: InstantSearch;
2371
2376
  parent: IndexWidget;
2372
2377
  templatesConfig: Record<string, unknown>;
@@ -2455,6 +2460,7 @@ declare const _default_15: <THit extends NonNullable<object> = BaseHit>(widgetPa
2455
2460
  })): {
2456
2461
  items: AlgoliaHit<THit>[];
2457
2462
  widgetParams: Partial<LookingSimilarWidgetParams<BaseHit>> & LookingSimilarConnectorParams<THit>;
2463
+ sendEvent: SendEventForHits;
2458
2464
  };
2459
2465
  dispose({ recommendState }: DisposeOptions): RecommendParameters;
2460
2466
  getWidgetParameters(state: RecommendParameters): RecommendParameters;
@@ -2732,7 +2738,7 @@ declare const _default_3: <TWidgetParams extends UnknownWidgetParams>(renderFn:
2732
2738
  analytics?: WidgetRenderState<Record<string, unknown>, AnalyticsWidgetParams> | undefined;
2733
2739
  places?: WidgetRenderState<Record<string, unknown>, PlacesWidgetParams> | undefined;
2734
2740
  };
2735
- getWidgetRenderState({ results }: InitOptions | RenderOptions | ({
2741
+ getWidgetRenderState({ results, helper, instantSearchInstance }: InitOptions | RenderOptions | ({
2736
2742
  instantSearchInstance: InstantSearch;
2737
2743
  parent: IndexWidget;
2738
2744
  templatesConfig: Record<string, unknown>;
@@ -2751,6 +2757,7 @@ declare const _default_3: <TWidgetParams extends UnknownWidgetParams>(renderFn:
2751
2757
  })): {
2752
2758
  items: AlgoliaHit<BaseHit>[] | AlgoliaHit<THit>[];
2753
2759
  widgetParams: TWidgetParams & RelatedProductsConnectorParams<THit>;
2760
+ sendEvent: SendEventForHits;
2754
2761
  };
2755
2762
  dispose({ recommendState }: DisposeOptions): RecommendParameters;
2756
2763
  getWidgetParameters(state: RecommendParameters): RecommendParameters;
@@ -2850,7 +2857,7 @@ declare const _default_4: <TWidgetParams extends UnknownWidgetParams>(renderFn:
2850
2857
  analytics?: WidgetRenderState<Record<string, unknown>, AnalyticsWidgetParams> | undefined;
2851
2858
  places?: WidgetRenderState<Record<string, unknown>, PlacesWidgetParams> | undefined;
2852
2859
  };
2853
- getWidgetRenderState({ results }: InitOptions | RenderOptions | ({
2860
+ getWidgetRenderState({ results, helper, instantSearchInstance }: InitOptions | RenderOptions | ({
2854
2861
  instantSearchInstance: InstantSearch;
2855
2862
  parent: IndexWidget;
2856
2863
  templatesConfig: Record<string, unknown>;
@@ -2869,6 +2876,7 @@ declare const _default_4: <TWidgetParams extends UnknownWidgetParams>(renderFn:
2869
2876
  })): {
2870
2877
  items: AlgoliaHit<THit>[];
2871
2878
  widgetParams: TWidgetParams & TrendingItemsConnectorParams<THit>;
2879
+ sendEvent: SendEventForHits;
2872
2880
  };
2873
2881
  dispose({ recommendState }: DisposeOptions): RecommendParameters;
2874
2882
  getWidgetParameters(state: RecommendParameters): RecommendParameters;
@@ -3188,7 +3196,7 @@ declare const _default_6: <TWidgetParams extends UnknownWidgetParams>(renderFn:
3188
3196
  analytics?: WidgetRenderState<Record<string, unknown>, AnalyticsWidgetParams> | undefined;
3189
3197
  places?: WidgetRenderState<Record<string, unknown>, PlacesWidgetParams> | undefined;
3190
3198
  };
3191
- getWidgetRenderState({ results }: InitOptions | RenderOptions | ({
3199
+ getWidgetRenderState({ results, helper, instantSearchInstance }: InitOptions | RenderOptions | ({
3192
3200
  instantSearchInstance: InstantSearch;
3193
3201
  parent: IndexWidget;
3194
3202
  templatesConfig: Record<string, unknown>;
@@ -3207,6 +3215,7 @@ declare const _default_6: <TWidgetParams extends UnknownWidgetParams>(renderFn:
3207
3215
  })): {
3208
3216
  items: AlgoliaHit<THit>[];
3209
3217
  widgetParams: TWidgetParams & FrequentlyBoughtTogetherConnectorParams<THit>;
3218
+ sendEvent: SendEventForHits;
3210
3219
  };
3211
3220
  dispose({ recommendState }: DisposeOptions): RecommendParameters;
3212
3221
  getWidgetParameters(state: RecommendParameters): RecommendParameters;
@@ -3306,7 +3315,7 @@ declare const _default_7: <TWidgetParams extends UnknownWidgetParams>(renderFn:
3306
3315
  analytics?: WidgetRenderState<Record<string, unknown>, AnalyticsWidgetParams> | undefined;
3307
3316
  places?: WidgetRenderState<Record<string, unknown>, PlacesWidgetParams> | undefined;
3308
3317
  };
3309
- getWidgetRenderState({ results }: InitOptions | RenderOptions | ({
3318
+ getWidgetRenderState({ results, helper, instantSearchInstance }: InitOptions | RenderOptions | ({
3310
3319
  instantSearchInstance: InstantSearch;
3311
3320
  parent: IndexWidget;
3312
3321
  templatesConfig: Record<string, unknown>;
@@ -3325,6 +3334,7 @@ declare const _default_7: <TWidgetParams extends UnknownWidgetParams>(renderFn:
3325
3334
  })): {
3326
3335
  items: AlgoliaHit<THit>[];
3327
3336
  widgetParams: TWidgetParams & LookingSimilarConnectorParams<THit>;
3337
+ sendEvent: SendEventForHits;
3328
3338
  };
3329
3339
  dispose({ recommendState }: DisposeOptions): RecommendParameters;
3330
3340
  getWidgetParameters(state: RecommendParameters): RecommendParameters;
@@ -3848,6 +3858,10 @@ declare type FrequentlyBoughtTogetherRenderState<THit extends NonNullable<object
3848
3858
  * The matched recommendations from Algolia API.
3849
3859
  */
3850
3860
  items: Array<AlgoliaHit<THit>>;
3861
+ /**
3862
+ * Sends an event to the Insights middleware.
3863
+ */
3864
+ sendEvent: SendEventForHits;
3851
3865
  };
3852
3866
 
3853
3867
  declare type FrequentlyBoughtTogetherTemplates<THit extends NonNullable<object> = BaseHit> = Partial<{
@@ -3864,7 +3878,7 @@ declare type FrequentlyBoughtTogetherTemplates<THit extends NonNullable<object>
3864
3878
  /**
3865
3879
  * Template to use for each result. This template will receive an object containing a single record.
3866
3880
  */
3867
- item: Template<AlgoliaHit<THit>>;
3881
+ item: TemplateWithBindEvent<AlgoliaHit<THit>>;
3868
3882
  /**
3869
3883
  * Template to use to wrap all items.
3870
3884
  */
@@ -5371,6 +5385,10 @@ declare type LookingSimilarRenderState<THit extends NonNullable<object> = BaseHi
5371
5385
  * The matched recommendations from the Algolia API.
5372
5386
  */
5373
5387
  items: Array<AlgoliaHit<THit>>;
5388
+ /**
5389
+ * Sends an event to the Insights middleware.
5390
+ */
5391
+ sendEvent: SendEventForHits;
5374
5392
  };
5375
5393
 
5376
5394
  declare type LookingSimilarTemplates<THit extends NonNullable<object> = BaseHit> = Partial<{
@@ -5387,7 +5405,7 @@ declare type LookingSimilarTemplates<THit extends NonNullable<object> = BaseHit>
5387
5405
  /**
5388
5406
  * Template to use for each result. This template will receive an object containing a single record.
5389
5407
  */
5390
- item: Template<AlgoliaHit<THit>>;
5408
+ item: TemplateWithBindEvent<AlgoliaHit<THit>>;
5391
5409
  /**
5392
5410
  * Template to use to wrap all items.
5393
5411
  */
@@ -7182,6 +7200,10 @@ declare type RelatedProductsRenderState<THit extends NonNullable<object> = BaseH
7182
7200
  * The matched recommendations from the Algolia API.
7183
7201
  */
7184
7202
  items: Array<AlgoliaHit<THit>>;
7203
+ /**
7204
+ * Sends an event to the Insights middleware.
7205
+ */
7206
+ sendEvent: SendEventForHits;
7185
7207
  };
7186
7208
 
7187
7209
  declare type RelatedProductsTemplates<THit extends NonNullable<object> = BaseHit> = Partial<{
@@ -7198,7 +7220,7 @@ declare type RelatedProductsTemplates<THit extends NonNullable<object> = BaseHit
7198
7220
  /**
7199
7221
  * Template to use for each result. This template will receive an object containing a single record.
7200
7222
  */
7201
- item: Template<AlgoliaHit<THit>>;
7223
+ item: TemplateWithBindEvent<AlgoliaHit<THit>>;
7202
7224
  /**
7203
7225
  * Template to use to wrap all items.
7204
7226
  */
@@ -8346,6 +8368,10 @@ declare type TrendingItemsRenderState<THit extends NonNullable<object> = BaseHit
8346
8368
  * The matched recommendations from the Algolia API.
8347
8369
  */
8348
8370
  items: Array<AlgoliaHit<THit>>;
8371
+ /**
8372
+ * Sends an event to the Insights middleware.
8373
+ */
8374
+ sendEvent: SendEventForHits;
8349
8375
  };
8350
8376
 
8351
8377
  declare type TrendingItemsTemplates<THit extends NonNullable<object> = BaseHit> = Partial<{
@@ -8362,7 +8388,7 @@ declare type TrendingItemsTemplates<THit extends NonNullable<object> = BaseHit>
8362
8388
  /**
8363
8389
  * Template to use for each result. This template will receive an object containing a single record.
8364
8390
  */
8365
- item: Template<AlgoliaHit<THit>>;
8391
+ item: TemplateWithBindEvent<AlgoliaHit<THit>>;
8366
8392
  /**
8367
8393
  * Template to use to wrap all items.
8368
8394
  */