instantsearch.js 4.72.1 → 4.73.0

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 (43) hide show
  1. package/README.md +0 -1
  2. package/cjs/components/InfiniteHits/InfiniteHits.js +62 -19
  3. package/cjs/components/Template/Template.js +1 -1
  4. package/cjs/connectors/pagination/Paginator.js +2 -2
  5. package/cjs/lib/version.js +1 -1
  6. package/cjs/widgets/infinite-hits/infinite-hits.js +14 -3
  7. package/dist/instantsearch.development.d.ts +117 -1659
  8. package/dist/instantsearch.development.js +87 -29
  9. package/dist/instantsearch.development.js.map +1 -1
  10. package/dist/instantsearch.production.d.ts +117 -1659
  11. package/dist/instantsearch.production.min.d.ts +117 -1659
  12. package/dist/instantsearch.production.min.js +2 -2
  13. package/dist/instantsearch.production.min.js.map +1 -1
  14. package/es/components/InfiniteHits/InfiniteHits.d.ts +4 -3
  15. package/es/components/InfiniteHits/InfiniteHits.js +62 -19
  16. package/es/components/Template/Template.js +1 -1
  17. package/es/connectors/frequently-bought-together/connectFrequentlyBoughtTogether.d.ts +7 -195
  18. package/es/connectors/geo-search/connectGeoSearch.d.ts +3 -3
  19. package/es/connectors/hits/connectHits.d.ts +2 -2
  20. package/es/connectors/hits/connectHitsWithInsights.d.ts +3 -75
  21. package/es/connectors/infinite-hits/connectInfiniteHits.d.ts +3 -3
  22. package/es/connectors/infinite-hits/connectInfiniteHitsWithInsights.d.ts +3 -75
  23. package/es/connectors/looking-similar/connectLookingSimilar.d.ts +7 -187
  24. package/es/connectors/pagination/Paginator.js +2 -2
  25. package/es/connectors/related-products/connectRelatedProducts.d.ts +7 -187
  26. package/es/connectors/trending-items/connectTrendingItems.d.ts +7 -192
  27. package/es/lib/insights/client.d.ts +1 -1
  28. package/es/lib/utils/createConcurrentSafePromise.d.ts +1 -1
  29. package/es/lib/utils/render-args.d.ts +2 -222
  30. package/es/lib/utils/typedObject.d.ts +1 -1
  31. package/es/lib/version.d.ts +1 -1
  32. package/es/lib/version.js +1 -1
  33. package/es/widgets/frequently-bought-together/frequently-bought-together.d.ts +5 -115
  34. package/es/widgets/geo-search/createHTMLMarker.d.ts +0 -2
  35. package/es/widgets/geo-search/geo-search.d.ts +12 -96
  36. package/es/widgets/hits/defaultTemplates.d.ts +9 -9
  37. package/es/widgets/hits/hits.d.ts +2 -77
  38. package/es/widgets/infinite-hits/infinite-hits.d.ts +21 -79
  39. package/es/widgets/infinite-hits/infinite-hits.js +14 -3
  40. package/es/widgets/looking-similar/looking-similar.d.ts +5 -118
  41. package/es/widgets/related-products/related-products.d.ts +5 -115
  42. package/es/widgets/trending-items/trending-items.d.ts +7 -121
  43. package/package.json +6 -6
@@ -1,5 +1,3 @@
1
- /// <reference types="google.maps" />
2
- /// <reference types="googlemaps" />
3
1
  import type { GeoSearchConnectorParams, GeoSearchWidgetDescription, GeoHit } from '../../connectors/geo-search/connectGeoSearch';
4
2
  import type { GeoLoc, Template, WidgetFactory } from '../../types';
5
3
  import type { HTMLMarkerArguments } from './createHTMLMarker';
@@ -172,24 +170,15 @@ declare const _default: <THit extends GeoHit = GeoHit>(widgetParams: GeoSearchWi
172
170
  hasMapMoveSinceLastRefine: () => boolean;
173
171
  widgetParams: {
174
172
  renderState: {
175
- templateProps?: import("../../lib/templating").PreparedTemplateProps<Partial<{
176
- /** Template to use for the marker. */
177
- HTMLMarker: Template<GeoHit>;
178
- /** Template for the reset button. */
179
- reset: Template;
180
- /** Template for the toggle label. */
181
- toggle: Template;
182
- /** Template for the redo button. */
183
- redo: Template;
184
- }>> | undefined;
185
- isUserInteraction?: boolean | undefined;
186
- isPendingRefine?: boolean | undefined;
187
- markers?: any[] | undefined;
173
+ templateProps?: import("../../lib/templating").PreparedTemplateProps<GeoSearchTemplates>;
174
+ isUserInteraction?: boolean;
175
+ isPendingRefine?: boolean;
176
+ markers?: any[];
188
177
  };
189
178
  container: HTMLElement;
190
- googleReference: typeof google;
191
- initialZoom: number | undefined;
192
- initialPosition: GeoLoc | undefined;
179
+ googleReference: GeoSearchWidgetParams["googleReference"];
180
+ initialZoom: GeoSearchWidgetParams["initialZoom"];
181
+ initialPosition: GeoSearchWidgetParams["initialPosition"];
193
182
  templates: Partial<{
194
183
  /** Template to use for the marker. */
195
184
  HTMLMarker: Template<GeoHit>;
@@ -221,10 +210,10 @@ declare const _default: <THit extends GeoHit = GeoHit>(widgetParams: GeoSearchWi
221
210
  reset: string | string[];
222
211
  }> | undefined>;
223
212
  createMarker: CreateMarker;
224
- markerOptions: GeoSearchMarker<any>;
225
- enableRefine: boolean | undefined;
226
- enableClearMapRefinement: boolean | undefined;
227
- enableRefineControl: boolean | undefined;
213
+ markerOptions: GeoSearchMarker<typeof google.maps.MarkerOptions | Partial<HTMLMarkerArguments>>;
214
+ enableRefine: GeoSearchWidgetParams["enableRefine"];
215
+ enableClearMapRefinement: GeoSearchWidgetParams["enableClearMapRefinement"];
216
+ enableRefineControl: GeoSearchWidgetParams["enableRefineControl"];
228
217
  } & GeoSearchConnectorParams<THit>;
229
218
  };
230
219
  getRenderState(renderState: {
@@ -271,80 +260,7 @@ declare const _default: <THit extends GeoHit = GeoHit>(widgetParams: GeoSearchWi
271
260
  voiceSearch?: import("../../types").WidgetRenderState<import("../../connectors/voice-search/connectVoiceSearch").VoiceSearchRenderState, import("../../connectors/voice-search/connectVoiceSearch").VoiceSearchConnectorParams> | undefined;
272
261
  analytics?: import("../../types").WidgetRenderState<Record<string, unknown>, import("../analytics/analytics").AnalyticsWidgetParams> | undefined;
273
262
  places?: import("../../types").WidgetRenderState<Record<string, unknown>, import("../places/places").PlacesWidgetParams> | undefined;
274
- }, renderOptions: import("../../types").InitOptions | import("../../types").RenderOptions): Partial<{
275
- answers: import("../../types").WidgetRenderState<import("../../connectors/answers/connectAnswers").AnswersRenderState, import("../../connectors/answers/connectAnswers").AnswersConnectorParams>;
276
- } & {
277
- autocomplete: import("../../types").WidgetRenderState<import("../../connectors/autocomplete/connectAutocomplete").AutocompleteRenderState, import("../../connectors/autocomplete/connectAutocomplete").AutocompleteConnectorParams>;
278
- } & {
279
- breadcrumb: {
280
- [rootAttribute: string]: import("../../types").WidgetRenderState<import("../../connectors/breadcrumb/connectBreadcrumb").BreadcrumbRenderState, import("../../connectors/breadcrumb/connectBreadcrumb").BreadcrumbConnectorParams>;
281
- };
282
- } & {
283
- /** The map container of the widget. */
284
- clearRefinements: import("../../types").WidgetRenderState<import("../../connectors/clear-refinements/connectClearRefinements").ClearRefinementsRenderState, import("../../connectors/clear-refinements/connectClearRefinements").ClearRefinementsConnectorParams>;
285
- } & {
286
- configure: import("../../types").WidgetRenderState<import("../../connectors/configure/connectConfigure").ConfigureRenderState, import("../../connectors/configure/connectConfigure").ConfigureConnectorParams>;
287
- } & {
288
- currentRefinements: import("../../types").WidgetRenderState<import("../../connectors/current-refinements/connectCurrentRefinements").CurrentRefinementsRenderState, import("../../connectors/current-refinements/connectCurrentRefinements").CurrentRefinementsConnectorParams>;
289
- } & {
290
- geoSearch: import("../../types").WidgetRenderState<import("../../connectors/geo-search/connectGeoSearch").GeoSearchRenderState<GeoHit>, GeoSearchConnectorParams<GeoHit>>;
291
- } & {
292
- hierarchicalMenu: {
293
- [rootAttribute: string]: import("../../types").WidgetRenderState<import("../../connectors/hierarchical-menu/connectHierarchicalMenu").HierarchicalMenuRenderState, import("../../connectors/hierarchical-menu/connectHierarchicalMenu").HierarchicalMenuConnectorParams>;
294
- };
295
- } & {
296
- hits: import("../../types").WidgetRenderState<import("../../connectors/hits/connectHits").HitsRenderState<import("../../types").BaseHit>, import("../../connectors/hits/connectHits").HitsConnectorParams<import("../../types").BaseHit>>;
297
- } & {
298
- hitsPerPage: import("../../types").WidgetRenderState<import("../../connectors/hits-per-page/connectHitsPerPage").HitsPerPageRenderState, import("../../connectors/hits-per-page/connectHitsPerPage").HitsPerPageConnectorParams>;
299
- } & {
300
- infiniteHits: import("../../types").WidgetRenderState<import("../../connectors/infinite-hits/connectInfiniteHits").InfiniteHitsRenderState<import("../../types").BaseHit>, import("../../connectors/infinite-hits/connectInfiniteHits").InfiniteHitsConnectorParams<import("../../types").BaseHit>>;
301
- } & {
302
- menu: {
303
- [attribute: string]: import("../../types").WidgetRenderState<import("../../connectors/menu/connectMenu").MenuRenderState, import("../../connectors/menu/connectMenu").MenuConnectorParams>;
304
- };
305
- } & {
306
- numericMenu: {
307
- [attribute: string]: import("../../types").WidgetRenderState<import("../../connectors/numeric-menu/connectNumericMenu").NumericMenuRenderState, import("../../connectors/numeric-menu/connectNumericMenu").NumericMenuConnectorParams>;
308
- };
309
- } & {
310
- pagination: import("../../types").WidgetRenderState<import("../../connectors/pagination/connectPagination").PaginationRenderState, import("../../connectors/pagination/connectPagination").PaginationConnectorParams>;
311
- } & {
312
- poweredBy: import("../../types").WidgetRenderState<import("../../connectors/powered-by/connectPoweredBy").PoweredByRenderState, import("../../connectors/powered-by/connectPoweredBy").PoweredByConnectorParams>;
313
- } & {
314
- queryRules: import("../../types").WidgetRenderState<import("../../connectors/query-rules/connectQueryRules").QueryRulesRenderState, import("../../connectors/query-rules/connectQueryRules").QueryRulesConnectorParams>;
315
- } & {
316
- range: {
317
- [attribute: string]: import("../../types").WidgetRenderState<import("../../connectors/range/connectRange").RangeRenderState, import("../../connectors/range/connectRange").RangeConnectorParams>;
318
- };
319
- } & {
320
- ratingMenu: {
321
- [attribute: string]: import("../../types").WidgetRenderState<import("../../connectors/rating-menu/connectRatingMenu").RatingMenuRenderState, import("../../connectors/rating-menu/connectRatingMenu").RatingMenuConnectorParams>;
322
- };
323
- } & {
324
- refinementList: {
325
- [attribute: string]: import("../../types").WidgetRenderState<import("../../connectors/refinement-list/connectRefinementList").RefinementListRenderState, import("../../connectors/refinement-list/connectRefinementList").RefinementListConnectorParams>;
326
- };
327
- } & {
328
- relevantSort: import("../../types").WidgetRenderState<import("../../connectors/relevant-sort/connectRelevantSort").RelevantSortRenderState, import("../../connectors/relevant-sort/connectRelevantSort").RelevantSortConnectorParams>;
329
- } & {
330
- searchBox: import("../../types").WidgetRenderState<import("../../connectors/search-box/connectSearchBox").SearchBoxRenderState, import("../../connectors/search-box/connectSearchBox").SearchBoxConnectorParams>;
331
- } & {
332
- sortBy: import("../../types").WidgetRenderState<import("../../connectors/sort-by/connectSortBy").SortByRenderState, import("../../connectors/sort-by/connectSortBy").SortByConnectorParams>;
333
- } & {
334
- stats: import("../../types").WidgetRenderState<import("../../connectors/stats/connectStats").StatsRenderState, import("../../connectors/stats/connectStats").StatsConnectorParams>;
335
- } & {
336
- toggleRefinement: {
337
- [attribute: string]: import("../../types").WidgetRenderState<import("../../connectors/toggle-refinement/connectToggleRefinement").ToggleRefinementRenderState, import("../../connectors/toggle-refinement/connectToggleRefinement").ToggleRefinementConnectorParams>;
338
- };
339
- } & {
340
- voiceSearch: import("../../types").WidgetRenderState<import("../../connectors/voice-search/connectVoiceSearch").VoiceSearchRenderState, import("../../connectors/voice-search/connectVoiceSearch").VoiceSearchConnectorParams>;
341
- } & {
342
- analytics: import("../../types").WidgetRenderState<Record<string, unknown>, import("../analytics/analytics").AnalyticsWidgetParams>;
343
- } & {
344
- places: import("../../types").WidgetRenderState<Record<string, unknown>, import("../places/places").PlacesWidgetParams>;
345
- }> & {
346
- geoSearch: import("../../types").WidgetRenderState<import("../../connectors/geo-search/connectGeoSearch").GeoSearchRenderState<GeoHit>, GeoSearchConnectorParams<GeoHit>>;
347
- };
263
+ }, renderOptions: import("../../types").InitOptions | import("../../types").RenderOptions): import("../../types").IndexRenderState & GeoSearchWidgetDescription["indexRenderState"];
348
264
  dispose({ state }: import("../../types").DisposeOptions): import("algoliasearch-helper").SearchParameters;
349
265
  getWidgetUiState(uiState: {
350
266
  geoSearch?: {
@@ -2,18 +2,18 @@ declare const defaultTemplates: {
2
2
  empty(): string;
3
3
  item(data: {
4
4
  __position: number;
5
- __queryID?: string | undefined;
5
+ __queryID?: string;
6
6
  } & {
7
7
  objectID: string;
8
- _highlightResult?: import("../../types").HitHighlightResult | undefined;
9
- _snippetResult?: import("../../types").HitSnippetResult | undefined;
8
+ _highlightResult?: import("../../types").HitHighlightResult;
9
+ _snippetResult?: import("../../types").HitSnippetResult;
10
10
  _rankingInfo?: {
11
11
  promoted: boolean;
12
12
  nbTypos: number;
13
13
  firstMatchedWord: number;
14
- proximityDistance?: number | undefined;
14
+ proximityDistance?: number;
15
15
  geoDistance: number;
16
- geoPrecision?: number | undefined;
16
+ geoPrecision?: number;
17
17
  nbExactWords: number;
18
18
  words: number;
19
19
  filters: number;
@@ -22,10 +22,10 @@ declare const defaultTemplates: {
22
22
  lat: number;
23
23
  lng: number;
24
24
  distance: number;
25
- } | undefined;
26
- } | undefined;
27
- _distinctSeqID?: number | undefined;
28
- _geoloc?: import("../../types").GeoLoc | undefined;
25
+ };
26
+ };
27
+ _distinctSeqID?: number;
28
+ _geoloc?: import("../../types").GeoLoc;
29
29
  } & import("../../types").BaseHit & {
30
30
  __hitIndex: number;
31
31
  }): string;
@@ -45,7 +45,7 @@ export type HitsWidgetParams<THit extends NonNullable<object> = BaseHit> = {
45
45
  export type HitsWidget = WidgetFactory<HitsWidgetDescription & {
46
46
  $$widgetType: 'ais.hits';
47
47
  }, HitsConnectorParams, HitsWidgetParams>;
48
- declare const _default: <THit extends object = BaseHit>(widgetParams: HitsWidgetParams<THit> & HitsConnectorParams<THit>) => {
48
+ declare const _default: <THit extends NonNullable<object> = BaseHit>(widgetParams: HitsWidgetParams<THit> & HitsConnectorParams<THit>) => {
49
49
  $$widgetType: "ais.hits";
50
50
  $$type: "ais.hits";
51
51
  init(initOptions: import("../../types").InitOptions): void;
@@ -94,79 +94,7 @@ declare const _default: <THit extends object = BaseHit>(widgetParams: HitsWidget
94
94
  voiceSearch?: import("../../types").WidgetRenderState<import("../../connectors/voice-search/connectVoiceSearch").VoiceSearchRenderState, import("../../connectors/voice-search/connectVoiceSearch").VoiceSearchConnectorParams> | undefined;
95
95
  analytics?: import("../../types").WidgetRenderState<Record<string, unknown>, import("../analytics/analytics").AnalyticsWidgetParams> | undefined;
96
96
  places?: import("../../types").WidgetRenderState<Record<string, unknown>, import("../places/places").PlacesWidgetParams> | undefined;
97
- }, renderOptions: import("../../types").InitOptions | import("../../types").RenderOptions): Partial<{
98
- answers: import("../../types").WidgetRenderState<import("../../connectors/answers/connectAnswers").AnswersRenderState, import("../../connectors/answers/connectAnswers").AnswersConnectorParams>;
99
- } & {
100
- autocomplete: import("../../types").WidgetRenderState<import("../../connectors/autocomplete/connectAutocomplete").AutocompleteRenderState, import("../../connectors/autocomplete/connectAutocomplete").AutocompleteConnectorParams>;
101
- } & {
102
- breadcrumb: {
103
- [rootAttribute: string]: import("../../types").WidgetRenderState<import("../../connectors/breadcrumb/connectBreadcrumb").BreadcrumbRenderState, import("../../connectors/breadcrumb/connectBreadcrumb").BreadcrumbConnectorParams>;
104
- };
105
- } & {
106
- clearRefinements: import("../../types").WidgetRenderState<import("../../connectors/clear-refinements/connectClearRefinements").ClearRefinementsRenderState, import("../../connectors/clear-refinements/connectClearRefinements").ClearRefinementsConnectorParams>;
107
- } & {
108
- configure: import("../../types").WidgetRenderState<import("../../connectors/configure/connectConfigure").ConfigureRenderState, import("../../connectors/configure/connectConfigure").ConfigureConnectorParams>;
109
- } & {
110
- currentRefinements: import("../../types").WidgetRenderState<import("../../connectors/current-refinements/connectCurrentRefinements").CurrentRefinementsRenderState, import("../../connectors/current-refinements/connectCurrentRefinements").CurrentRefinementsConnectorParams>;
111
- } & {
112
- geoSearch: import("../../types").WidgetRenderState<import("../../connectors/geo-search/connectGeoSearch").GeoSearchRenderState<import("../../types").GeoHit>, import("../../connectors/geo-search/connectGeoSearch").GeoSearchConnectorParams<import("../../types").GeoHit>>;
113
- } & {
114
- hierarchicalMenu: {
115
- [rootAttribute: string]: import("../../types").WidgetRenderState<import("../../connectors/hierarchical-menu/connectHierarchicalMenu").HierarchicalMenuRenderState, import("../../connectors/hierarchical-menu/connectHierarchicalMenu").HierarchicalMenuConnectorParams>;
116
- };
117
- } & {
118
- hits: import("../../types").WidgetRenderState<HitsRenderState<BaseHit>, HitsConnectorParams<BaseHit>>;
119
- } & {
120
- hitsPerPage: import("../../types").WidgetRenderState<import("../../connectors/hits-per-page/connectHitsPerPage").HitsPerPageRenderState, import("../../connectors/hits-per-page/connectHitsPerPage").HitsPerPageConnectorParams>;
121
- } & {
122
- infiniteHits: import("../../types").WidgetRenderState<import("../../connectors/infinite-hits/connectInfiniteHits").InfiniteHitsRenderState<BaseHit>, import("../../connectors/infinite-hits/connectInfiniteHits").InfiniteHitsConnectorParams<BaseHit>>;
123
- } & {
124
- menu: {
125
- [attribute: string]: import("../../types").WidgetRenderState<import("../../connectors/menu/connectMenu").MenuRenderState, import("../../connectors/menu/connectMenu").MenuConnectorParams>;
126
- };
127
- } & {
128
- numericMenu: {
129
- [attribute: string]: import("../../types").WidgetRenderState<import("../../connectors/numeric-menu/connectNumericMenu").NumericMenuRenderState, import("../../connectors/numeric-menu/connectNumericMenu").NumericMenuConnectorParams>;
130
- };
131
- } & {
132
- pagination: import("../../types").WidgetRenderState<import("../../connectors/pagination/connectPagination").PaginationRenderState, import("../../connectors/pagination/connectPagination").PaginationConnectorParams>;
133
- } & {
134
- poweredBy: import("../../types").WidgetRenderState<import("../../connectors/powered-by/connectPoweredBy").PoweredByRenderState, import("../../connectors/powered-by/connectPoweredBy").PoweredByConnectorParams>;
135
- } & {
136
- queryRules: import("../../types").WidgetRenderState<import("../../connectors/query-rules/connectQueryRules").QueryRulesRenderState, import("../../connectors/query-rules/connectQueryRules").QueryRulesConnectorParams>;
137
- } & {
138
- range: {
139
- [attribute: string]: import("../../types").WidgetRenderState<import("../../connectors/range/connectRange").RangeRenderState, import("../../connectors/range/connectRange").RangeConnectorParams>;
140
- };
141
- } & {
142
- ratingMenu: {
143
- [attribute: string]: import("../../types").WidgetRenderState<import("../../connectors/rating-menu/connectRatingMenu").RatingMenuRenderState, import("../../connectors/rating-menu/connectRatingMenu").RatingMenuConnectorParams>;
144
- };
145
- } & {
146
- refinementList: {
147
- [attribute: string]: import("../../types").WidgetRenderState<import("../../connectors/refinement-list/connectRefinementList").RefinementListRenderState, import("../../connectors/refinement-list/connectRefinementList").RefinementListConnectorParams>;
148
- };
149
- } & {
150
- relevantSort: import("../../types").WidgetRenderState<import("../../connectors/relevant-sort/connectRelevantSort").RelevantSortRenderState, import("../../connectors/relevant-sort/connectRelevantSort").RelevantSortConnectorParams>;
151
- } & {
152
- searchBox: import("../../types").WidgetRenderState<import("../../connectors/search-box/connectSearchBox").SearchBoxRenderState, import("../../connectors/search-box/connectSearchBox").SearchBoxConnectorParams>;
153
- } & {
154
- sortBy: import("../../types").WidgetRenderState<import("../../connectors/sort-by/connectSortBy").SortByRenderState, import("../../connectors/sort-by/connectSortBy").SortByConnectorParams>;
155
- } & {
156
- stats: import("../../types").WidgetRenderState<import("../../connectors/stats/connectStats").StatsRenderState, import("../../connectors/stats/connectStats").StatsConnectorParams>;
157
- } & {
158
- toggleRefinement: {
159
- [attribute: string]: import("../../types").WidgetRenderState<import("../../connectors/toggle-refinement/connectToggleRefinement").ToggleRefinementRenderState, import("../../connectors/toggle-refinement/connectToggleRefinement").ToggleRefinementConnectorParams>;
160
- };
161
- } & {
162
- voiceSearch: import("../../types").WidgetRenderState<import("../../connectors/voice-search/connectVoiceSearch").VoiceSearchRenderState, import("../../connectors/voice-search/connectVoiceSearch").VoiceSearchConnectorParams>;
163
- } & {
164
- analytics: import("../../types").WidgetRenderState<Record<string, unknown>, import("../analytics/analytics").AnalyticsWidgetParams>;
165
- } & {
166
- places: import("../../types").WidgetRenderState<Record<string, unknown>, import("../places/places").PlacesWidgetParams>;
167
- }> & {
168
- hits: import("../../types").WidgetRenderState<HitsRenderState<BaseHit>, HitsConnectorParams<BaseHit>>;
169
- };
97
+ }, renderOptions: import("../../types").InitOptions | import("../../types").RenderOptions): import("../../types").IndexRenderState & HitsWidgetDescription["indexRenderState"];
170
98
  getWidgetRenderState({ results, helper, instantSearchInstance }: import("../../types").InitOptions | import("../../types").RenderOptions): {
171
99
  hits: never[];
172
100
  items: never[];
@@ -181,9 +109,6 @@ declare const _default: <THit extends object = BaseHit>(widgetParams: HitsWidget
181
109
  results: SearchResults<any>;
182
110
  banner: import("algoliasearch-helper").Banner | undefined;
183
111
  sendEvent: import("../../lib/utils").SendEventForHits;
184
- /**
185
- * Templates to use for the widget.
186
- */
187
112
  bindEvent: import("../../lib/utils").BindEventForHits;
188
113
  widgetParams: Partial<HitsWidgetParams<BaseHit>> & HitsConnectorParams<THit>;
189
114
  };
@@ -35,6 +35,18 @@ export type InfiniteHitsCSSClasses = Partial<{
35
35
  * The disabled “Show more” button.
36
36
  */
37
37
  disabledLoadMore: string | string[];
38
+ /**
39
+ * Class names to apply to the banner element
40
+ */
41
+ bannerRoot: string | string[];
42
+ /**
43
+ * Class names to apply to the banner image element
44
+ */
45
+ bannerImage: string | string[];
46
+ /**
47
+ * Class names to apply to the banner link element
48
+ */
49
+ bannerLink: string | string[];
38
50
  }>;
39
51
  export type InfiniteHitsTemplates<THit extends NonNullable<object> = BaseHit> = Partial<{
40
52
  /**
@@ -56,6 +68,13 @@ export type InfiniteHitsTemplates<THit extends NonNullable<object> = BaseHit> =
56
68
  /** @deprecated the index in the hits array, use __position instead, which is the absolute position */
57
69
  __hitIndex: number;
58
70
  }>;
71
+ /**
72
+ * Template to use for the banner.
73
+ */
74
+ banner: Template<{
75
+ banner: Required<InfiniteHitsRenderState['banner']>;
76
+ className: string;
77
+ }>;
59
78
  }>;
60
79
  export type InfiniteHitsWidgetParams<THit extends NonNullable<object> = BaseHit> = {
61
80
  /**
@@ -80,7 +99,7 @@ export type InfiniteHitsWidgetParams<THit extends NonNullable<object> = BaseHit>
80
99
  export type InfiniteHitsWidget = WidgetFactory<InfiniteHitsWidgetDescription & {
81
100
  $$widgetType: 'ais.infiniteHits';
82
101
  }, InfiniteHitsConnectorParams, InfiniteHitsWidgetParams>;
83
- declare const _default: <THit extends object = BaseHit>(widgetParams: InfiniteHitsWidgetParams<THit> & InfiniteHitsConnectorParams<THit>) => {
102
+ declare const _default: <THit extends NonNullable<object> = BaseHit>(widgetParams: InfiniteHitsWidgetParams<THit> & InfiniteHitsConnectorParams<THit>) => {
84
103
  $$widgetType: "ais.infiniteHits";
85
104
  $$type: "ais.infiniteHits";
86
105
  init(initOptions: import("../../types").InitOptions): void;
@@ -129,84 +148,7 @@ declare const _default: <THit extends object = BaseHit>(widgetParams: InfiniteHi
129
148
  voiceSearch?: import("../../types").WidgetRenderState<import("../../connectors/voice-search/connectVoiceSearch").VoiceSearchRenderState, import("../../connectors/voice-search/connectVoiceSearch").VoiceSearchConnectorParams> | undefined;
130
149
  analytics?: import("../../types").WidgetRenderState<Record<string, unknown>, import("../analytics/analytics").AnalyticsWidgetParams> | undefined;
131
150
  places?: import("../../types").WidgetRenderState<Record<string, unknown>, import("../places/places").PlacesWidgetParams> | undefined;
132
- }, renderOptions: import("../../types").InitOptions | import("../../types").RenderOptions): Partial<{
133
- answers: import("../../types").WidgetRenderState<import("../../connectors/answers/connectAnswers").AnswersRenderState, import("../../connectors/answers/connectAnswers").AnswersConnectorParams>;
134
- } & {
135
- /**
136
- * The list of results.
137
- */
138
- autocomplete: import("../../types").WidgetRenderState<import("../../connectors/autocomplete/connectAutocomplete").AutocompleteRenderState, import("../../connectors/autocomplete/connectAutocomplete").AutocompleteConnectorParams>;
139
- } & {
140
- breadcrumb: {
141
- [rootAttribute: string]: import("../../types").WidgetRenderState<import("../../connectors/breadcrumb/connectBreadcrumb").BreadcrumbRenderState, import("../../connectors/breadcrumb/connectBreadcrumb").BreadcrumbConnectorParams>;
142
- };
143
- } & {
144
- clearRefinements: import("../../types").WidgetRenderState<import("../../connectors/clear-refinements/connectClearRefinements").ClearRefinementsRenderState, import("../../connectors/clear-refinements/connectClearRefinements").ClearRefinementsConnectorParams>; /**
145
- * The disabled “Show previous” button.
146
- */
147
- } & {
148
- configure: import("../../types").WidgetRenderState<import("../../connectors/configure/connectConfigure").ConfigureRenderState, import("../../connectors/configure/connectConfigure").ConfigureConnectorParams>;
149
- } & {
150
- currentRefinements: import("../../types").WidgetRenderState<import("../../connectors/current-refinements/connectCurrentRefinements").CurrentRefinementsRenderState, import("../../connectors/current-refinements/connectCurrentRefinements").CurrentRefinementsConnectorParams>;
151
- } & {
152
- geoSearch: import("../../types").WidgetRenderState<import("../../connectors/geo-search/connectGeoSearch").GeoSearchRenderState<import("../../types").GeoHit>, import("../../connectors/geo-search/connectGeoSearch").GeoSearchConnectorParams<import("../../types").GeoHit>>;
153
- } & {
154
- hierarchicalMenu: {
155
- [rootAttribute: string]: import("../../types").WidgetRenderState<import("../../connectors/hierarchical-menu/connectHierarchicalMenu").HierarchicalMenuRenderState, import("../../connectors/hierarchical-menu/connectHierarchicalMenu").HierarchicalMenuConnectorParams>;
156
- };
157
- } & {
158
- hits: import("../../types").WidgetRenderState<import("../../connectors/hits/connectHits").HitsRenderState<BaseHit>, import("../../connectors/hits/connectHits").HitsConnectorParams<BaseHit>>;
159
- } & {
160
- hitsPerPage: import("../../types").WidgetRenderState<import("../../connectors/hits-per-page/connectHitsPerPage").HitsPerPageRenderState, import("../../connectors/hits-per-page/connectHitsPerPage").HitsPerPageConnectorParams>;
161
- } & {
162
- infiniteHits: import("../../types").WidgetRenderState<InfiniteHitsRenderState<BaseHit>, InfiniteHitsConnectorParams<BaseHit>>;
163
- } & {
164
- menu: {
165
- [attribute: string]: import("../../types").WidgetRenderState<import("../../connectors/menu/connectMenu").MenuRenderState, import("../../connectors/menu/connectMenu").MenuConnectorParams>;
166
- };
167
- } & {
168
- numericMenu: {
169
- [attribute: string]: import("../../types").WidgetRenderState<import("../../connectors/numeric-menu/connectNumericMenu").NumericMenuRenderState, import("../../connectors/numeric-menu/connectNumericMenu").NumericMenuConnectorParams>;
170
- };
171
- } & {
172
- pagination: import("../../types").WidgetRenderState<import("../../connectors/pagination/connectPagination").PaginationRenderState, import("../../connectors/pagination/connectPagination").PaginationConnectorParams>;
173
- } & {
174
- poweredBy: import("../../types").WidgetRenderState<import("../../connectors/powered-by/connectPoweredBy").PoweredByRenderState, import("../../connectors/powered-by/connectPoweredBy").PoweredByConnectorParams>;
175
- } & {
176
- queryRules: import("../../types").WidgetRenderState<import("../../connectors/query-rules/connectQueryRules").QueryRulesRenderState, import("../../connectors/query-rules/connectQueryRules").QueryRulesConnectorParams>;
177
- } & {
178
- range: {
179
- [attribute: string]: import("../../types").WidgetRenderState<import("../../connectors/range/connectRange").RangeRenderState, import("../../connectors/range/connectRange").RangeConnectorParams>;
180
- };
181
- } & {
182
- ratingMenu: {
183
- [attribute: string]: import("../../types").WidgetRenderState<import("../../connectors/rating-menu/connectRatingMenu").RatingMenuRenderState, import("../../connectors/rating-menu/connectRatingMenu").RatingMenuConnectorParams>;
184
- };
185
- } & {
186
- refinementList: {
187
- [attribute: string]: import("../../types").WidgetRenderState<import("../../connectors/refinement-list/connectRefinementList").RefinementListRenderState, import("../../connectors/refinement-list/connectRefinementList").RefinementListConnectorParams>;
188
- };
189
- } & {
190
- relevantSort: import("../../types").WidgetRenderState<import("../../connectors/relevant-sort/connectRelevantSort").RelevantSortRenderState, import("../../connectors/relevant-sort/connectRelevantSort").RelevantSortConnectorParams>;
191
- } & {
192
- searchBox: import("../../types").WidgetRenderState<import("../../connectors/search-box/connectSearchBox").SearchBoxRenderState, import("../../connectors/search-box/connectSearchBox").SearchBoxConnectorParams>;
193
- } & {
194
- sortBy: import("../../types").WidgetRenderState<import("../../connectors/sort-by/connectSortBy").SortByRenderState, import("../../connectors/sort-by/connectSortBy").SortByConnectorParams>;
195
- } & {
196
- stats: import("../../types").WidgetRenderState<import("../../connectors/stats/connectStats").StatsRenderState, import("../../connectors/stats/connectStats").StatsConnectorParams>;
197
- } & {
198
- toggleRefinement: {
199
- [attribute: string]: import("../../types").WidgetRenderState<import("../../connectors/toggle-refinement/connectToggleRefinement").ToggleRefinementRenderState, import("../../connectors/toggle-refinement/connectToggleRefinement").ToggleRefinementConnectorParams>;
200
- };
201
- } & {
202
- voiceSearch: import("../../types").WidgetRenderState<import("../../connectors/voice-search/connectVoiceSearch").VoiceSearchRenderState, import("../../connectors/voice-search/connectVoiceSearch").VoiceSearchConnectorParams>;
203
- } & {
204
- analytics: import("../../types").WidgetRenderState<Record<string, unknown>, import("../analytics/analytics").AnalyticsWidgetParams>;
205
- } & {
206
- places: import("../../types").WidgetRenderState<Record<string, unknown>, import("../places/places").PlacesWidgetParams>;
207
- }> & {
208
- infiniteHits: import("../../types").WidgetRenderState<InfiniteHitsRenderState<BaseHit>, InfiniteHitsConnectorParams<BaseHit>>;
209
- };
151
+ }, renderOptions: import("../../types").InitOptions | import("../../types").RenderOptions): import("../../types").IndexRenderState & InfiniteHitsWidgetDescription["indexRenderState"];
210
152
  getWidgetRenderState({ results, helper, parent, state: existingState, instantSearchInstance, }: import("../../types").InitOptions | import("../../types").RenderOptions): {
211
153
  hits: Hit<THit>[];
212
154
  items: Hit<THit>[];
@@ -33,7 +33,8 @@ var renderer = function renderer(_ref) {
33
33
  instantSearchInstance = _ref2.instantSearchInstance,
34
34
  insights = _ref2.insights,
35
35
  bindEvent = _ref2.bindEvent,
36
- sendEvent = _ref2.sendEvent;
36
+ sendEvent = _ref2.sendEvent,
37
+ banner = _ref2.banner;
37
38
  if (isFirstRendering) {
38
39
  renderState.templateProps = prepareTemplateProps({
39
40
  defaultTemplates: defaultTemplates,
@@ -54,7 +55,8 @@ var renderer = function renderer(_ref) {
54
55
  isLastPage: isLastPage,
55
56
  insights: insights,
56
57
  sendEvent: sendEvent,
57
- bindEvent: bindEvent
58
+ bindEvent: bindEvent,
59
+ banner: banner
58
60
  }), containerNode);
59
61
  };
60
62
  };
@@ -97,7 +99,16 @@ export default (function infiniteHits(widgetParams) {
97
99
  disabledLoadMore: cx(suit({
98
100
  descendantName: 'loadMore',
99
101
  modifierName: 'disabled'
100
- }), userCssClasses.disabledLoadMore)
102
+ }), userCssClasses.disabledLoadMore),
103
+ bannerRoot: cx(suit({
104
+ descendantName: 'banner'
105
+ }), userCssClasses.bannerRoot),
106
+ bannerImage: cx(suit({
107
+ descendantName: 'banner-image'
108
+ }), userCssClasses.bannerImage),
109
+ bannerLink: cx(suit({
110
+ descendantName: 'banner-link'
111
+ }), userCssClasses.bannerLink)
101
112
  };
102
113
  var specializedRenderer = renderer({
103
114
  containerNode: containerNode,
@@ -37,7 +37,7 @@ type LookingSimilarWidgetParams<THit extends NonNullable<object> = BaseHit> = {
37
37
  export type LookingSimilarWidget = WidgetFactory<LookingSimilarWidgetDescription & {
38
38
  $$widgetType: 'ais.lookingSimilar';
39
39
  }, LookingSimilarConnectorParams, LookingSimilarWidgetParams>;
40
- declare const _default: <THit extends object = BaseHit>(widgetParams: LookingSimilarWidgetParams<THit> & LookingSimilarConnectorParams<THit>) => {
40
+ declare const _default: <THit extends NonNullable<object> = BaseHit>(widgetParams: LookingSimilarWidgetParams<THit> & LookingSimilarConnectorParams<THit>) => {
41
41
  $$widgetType: "ais.lookingSimilar";
42
42
  dependsOn: "recommend";
43
43
  $$type: "ais.lookingSimilar";
@@ -133,7 +133,7 @@ declare const _default: <THit extends object = BaseHit>(widgetParams: LookingSim
133
133
  places?: import("../../types").WidgetRenderState<Record<string, unknown>, import("../places/places").PlacesWidgetParams> | undefined;
134
134
  };
135
135
  getWidgetRenderState({ results }: import("../../types").InitOptions | import("../../types").RenderOptions | ({
136
- instantSearchInstance: import("../../lib/InstantSearch").default<import("../../types").UiState, import("../../types").UiState>;
136
+ instantSearchInstance: import("../../types").InstantSearch;
137
137
  parent: import("../index").IndexWidget;
138
138
  templatesConfig: Record<string, unknown>;
139
139
  scopedResults: import("../../types").ScopedResult[];
@@ -213,128 +213,15 @@ declare const _default: <THit extends object = BaseHit>(widgetParams: LookingSim
213
213
  searchMetadata: {
214
214
  isSearchStalled: boolean;
215
215
  };
216
- status: import("../../types").InstantSearchStatus;
217
- error: Error | undefined;
218
- createURL: (nextState: import("algoliasearch-helper").SearchParameters | ((state: Partial<{
219
- query: string;
220
- } & {
221
- configure: import("algoliasearch-helper").PlainSearchParameters;
222
- } & {
223
- geoSearch: {
224
- boundingBox: string;
225
- };
226
- } & {
227
- hierarchicalMenu: {
228
- [rootAttribute: string]: string[];
229
- };
230
- } & {
231
- hitsPerPage: number;
232
- } & {
233
- page: number;
234
- } & {
235
- menu: {
236
- [attribute: string]: string;
237
- };
238
- } & {
239
- numericMenu: {
240
- [attribute: string]: string;
241
- };
242
- } & {
243
- page: number;
244
- } & {
245
- range: {
246
- [attribute: string]: string;
247
- };
248
- } & {
249
- ratingMenu: {
250
- [attribute: string]: number | undefined;
251
- };
252
- } & {
253
- refinementList: {
254
- [attribute: string]: string[];
255
- };
256
- } & {
257
- relevantSort: number;
258
- } & {
259
- query: string;
260
- } & {
261
- sortBy: string;
262
- } & {
263
- toggle: {
264
- [attribute: string]: boolean;
265
- };
266
- } & {
267
- query: string;
268
- } & {
269
- places: {
270
- query: string;
271
- position: string;
272
- };
273
- }>) => Partial<{
274
- query: string;
275
- } & {
276
- configure: import("algoliasearch-helper").PlainSearchParameters;
277
- } & {
278
- geoSearch: {
279
- boundingBox: string;
280
- };
281
- } & {
282
- hierarchicalMenu: {
283
- [rootAttribute: string]: string[];
284
- };
285
- } & {
286
- hitsPerPage: number;
287
- } & {
288
- page: number;
289
- } & {
290
- menu: {
291
- [attribute: string]: string;
292
- };
293
- } & {
294
- numericMenu: {
295
- [attribute: string]: string;
296
- };
297
- } & {
298
- page: number;
299
- } & {
300
- range: {
301
- [attribute: string]: string;
302
- };
303
- } & {
304
- ratingMenu: {
305
- [attribute: string]: number | undefined;
306
- };
307
- } & {
308
- refinementList: {
309
- [attribute: string]: string[];
310
- };
311
- } & {
312
- relevantSort: number;
313
- } & {
314
- query: string;
315
- } & {
316
- sortBy: string;
317
- } & {
318
- toggle: {
319
- [attribute: string]: boolean;
320
- };
321
- } & {
322
- query: string;
323
- } & {
324
- places: {
325
- query: string;
326
- position: string;
327
- };
328
- }>)) => string;
216
+ status: import("../../types").InstantSearch["status"];
217
+ error: import("../../types").InstantSearch["error"];
218
+ createURL: (nextState: import("algoliasearch-helper").SearchParameters | ((state: import("../../types").IndexUiState) => import("../../types").IndexUiState)) => string;
329
219
  } & {
330
220
  results: RecommendResultItem;
331
221
  })): {
332
222
  items: Hit<THit>[];
333
223
  widgetParams: Partial<LookingSimilarWidgetParams<BaseHit>> & LookingSimilarConnectorParams<THit>;
334
224
  };
335
- /**
336
- * Template to use for each result. This template will receive an object containing a single record.
337
- */
338
225
  dispose({ recommendState }: import("../../types").DisposeOptions): import("algoliasearch-helper").RecommendParameters;
339
226
  getWidgetParameters(state: import("algoliasearch-helper").RecommendParameters): import("algoliasearch-helper").RecommendParameters;
340
227
  };