instantsearch.js 4.70.0 → 4.71.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.
- package/cjs/connectors/frequently-bought-together/connectFrequentlyBoughtTogether.js +1 -2
- package/cjs/connectors/geo-search/connectGeoSearch.js +4 -3
- package/cjs/connectors/hits/connectHits.js +10 -7
- package/cjs/connectors/infinite-hits/connectInfiniteHits.js +7 -8
- package/cjs/connectors/looking-similar/connectLookingSimilar.js +2 -3
- package/cjs/connectors/related-products/connectRelatedProducts.js +2 -3
- package/cjs/connectors/trending-items/connectTrendingItems.js +5 -3
- package/cjs/lib/InstantSearch.js +2 -2
- package/cjs/lib/version.js +1 -1
- package/cjs/widgets/frequently-bought-together/frequently-bought-together.js +1 -3
- package/cjs/widgets/geo-search/geo-search.js +4 -3
- package/cjs/widgets/hits/defaultTemplates.js +2 -0
- package/cjs/widgets/hits/hits.js +3 -4
- package/cjs/widgets/infinite-hits/infinite-hits.js +3 -4
- package/cjs/widgets/looking-similar/looking-similar.js +4 -6
- package/cjs/widgets/rating-menu/defaultTemplates.js +1 -0
- package/cjs/widgets/related-products/related-products.js +1 -3
- package/cjs/widgets/trending-items/trending-items.js +1 -3
- package/dist/instantsearch.development.d.ts +4298 -235
- package/dist/instantsearch.development.js +8535 -8525
- package/dist/instantsearch.development.js.map +1 -1
- package/dist/instantsearch.production.d.ts +4298 -235
- package/dist/instantsearch.production.min.d.ts +4298 -235
- package/dist/instantsearch.production.min.js +2 -2
- package/dist/instantsearch.production.min.js.map +1 -1
- package/es/connectors/frequently-bought-together/connectFrequentlyBoughtTogether.d.ts +311 -7
- package/es/connectors/frequently-bought-together/connectFrequentlyBoughtTogether.js +2 -3
- package/es/connectors/geo-search/connectGeoSearch.d.ts +218 -8
- package/es/connectors/geo-search/connectGeoSearch.js +5 -4
- package/es/connectors/hits/connectHits.d.ts +128 -7
- package/es/connectors/hits/connectHits.js +11 -8
- package/es/connectors/hits/connectHitsWithInsights.d.ts +190 -1
- package/es/connectors/infinite-hits/connectInfiniteHits.d.ts +192 -12
- package/es/connectors/infinite-hits/connectInfiniteHits.js +8 -9
- package/es/connectors/infinite-hits/connectInfiniteHitsWithInsights.d.ts +249 -1
- package/es/connectors/looking-similar/connectLookingSimilar.d.ts +303 -7
- package/es/connectors/looking-similar/connectLookingSimilar.js +3 -4
- package/es/connectors/related-products/connectRelatedProducts.d.ts +303 -7
- package/es/connectors/related-products/connectRelatedProducts.js +3 -4
- package/es/connectors/trending-items/connectTrendingItems.d.ts +310 -9
- package/es/connectors/trending-items/connectTrendingItems.js +7 -5
- package/es/lib/InstantSearch.d.ts +1 -2
- package/es/lib/InstantSearch.js +1 -1
- package/es/lib/utils/checkIndexUiState.d.ts +1 -2
- package/es/lib/utils/checkRendering.d.ts +1 -1
- package/es/lib/utils/getWidgetAttribute.d.ts +1 -2
- package/es/lib/utils/isIndexWidget.d.ts +1 -2
- package/es/lib/utils/render-args.d.ts +1 -2
- package/es/lib/utils/resolveSearchParameters.d.ts +1 -1
- package/es/lib/utils/setIndexHelperState.d.ts +1 -2
- package/es/lib/version.d.ts +1 -1
- package/es/lib/version.js +1 -1
- package/es/types/index.d.ts +0 -1
- package/es/types/index.js +1 -4
- package/es/types/results.d.ts +4 -3
- package/es/types/widget.d.ts +2 -2
- package/es/widgets/frequently-bought-together/frequently-bought-together.d.ts +306 -9
- package/es/widgets/frequently-bought-together/frequently-bought-together.js +2 -4
- package/es/widgets/geo-search/geo-search.d.ts +328 -8
- package/es/widgets/geo-search/geo-search.js +5 -4
- package/es/widgets/hits/defaultTemplates.d.ts +32 -2
- package/es/widgets/hits/defaultTemplates.js +3 -0
- package/es/widgets/hits/hits.d.ts +204 -8
- package/es/widgets/hits/hits.js +4 -5
- package/es/widgets/index.d.ts +1 -0
- package/es/widgets/infinite-hits/infinite-hits.d.ts +262 -9
- package/es/widgets/infinite-hits/infinite-hits.js +4 -5
- package/es/widgets/looking-similar/looking-similar.d.ts +309 -9
- package/es/widgets/looking-similar/looking-similar.js +5 -7
- package/es/widgets/rating-menu/defaultTemplates.js +1 -0
- package/es/widgets/related-products/related-products.d.ts +306 -9
- package/es/widgets/related-products/related-products.js +2 -4
- package/es/widgets/trending-items/trending-items.d.ts +310 -9
- package/es/widgets/trending-items/trending-items.js +2 -4
- package/package.json +5 -5
|
@@ -29,7 +29,7 @@ var $$type = 'ais.geoSearch';
|
|
|
29
29
|
*
|
|
30
30
|
* Currently, the feature is not compatible with multiple values in the _geoloc attribute.
|
|
31
31
|
*/
|
|
32
|
-
|
|
32
|
+
export default (function connectGeoSearch(renderFn) {
|
|
33
33
|
var unmountFn = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : noop;
|
|
34
34
|
checkRendering(renderFn, withUsage());
|
|
35
35
|
return function (widgetParams) {
|
|
@@ -170,7 +170,9 @@ var connectGeoSearch = function connectGeoSearch(renderFn) {
|
|
|
170
170
|
widgetParams: widgetParams
|
|
171
171
|
};
|
|
172
172
|
},
|
|
173
|
-
getRenderState: function getRenderState(renderState, renderOptions
|
|
173
|
+
getRenderState: function getRenderState(renderState, renderOptions
|
|
174
|
+
// Type is explicitly redefined, to avoid having the TWidgetParams type in the definition
|
|
175
|
+
) {
|
|
174
176
|
return _objectSpread(_objectSpread({}, renderState), {}, {
|
|
175
177
|
geoSearch: this.getWidgetRenderState(renderOptions)
|
|
176
178
|
});
|
|
@@ -201,5 +203,4 @@ var connectGeoSearch = function connectGeoSearch(renderFn) {
|
|
|
201
203
|
}
|
|
202
204
|
};
|
|
203
205
|
};
|
|
204
|
-
};
|
|
205
|
-
export default connectGeoSearch;
|
|
206
|
+
});
|
|
@@ -1,12 +1,17 @@
|
|
|
1
1
|
import type { SendEventForHits, BindEventForHits } from '../../lib/utils';
|
|
2
|
-
import type { TransformItems, Connector, Hit, WidgetRenderState, BaseHit } from '../../types';
|
|
2
|
+
import type { TransformItems, Connector, Hit, WidgetRenderState, BaseHit, Unmounter, Renderer, IndexRenderState } from '../../types';
|
|
3
3
|
import type { SearchResults } from 'algoliasearch-helper';
|
|
4
4
|
type Banner = NonNullable<NonNullable<Required<SearchResults<Hit>['renderingContent']>>['widgets']['banners']>[number];
|
|
5
|
-
export type HitsRenderState<THit extends
|
|
5
|
+
export type HitsRenderState<THit extends NonNullable<object> = BaseHit> = {
|
|
6
6
|
/**
|
|
7
7
|
* The matched hits from Algolia API.
|
|
8
|
+
* @deprecated use `items` instead
|
|
8
9
|
*/
|
|
9
10
|
hits: Array<Hit<THit>>;
|
|
11
|
+
/**
|
|
12
|
+
* The matched hits from Algolia API.
|
|
13
|
+
*/
|
|
14
|
+
items: Array<Hit<THit>>;
|
|
10
15
|
/**
|
|
11
16
|
* The response from the Algolia API.
|
|
12
17
|
*/
|
|
@@ -24,7 +29,7 @@ export type HitsRenderState<THit extends BaseHit = BaseHit> = {
|
|
|
24
29
|
*/
|
|
25
30
|
bindEvent: BindEventForHits;
|
|
26
31
|
};
|
|
27
|
-
export type HitsConnectorParams<THit extends
|
|
32
|
+
export type HitsConnectorParams<THit extends NonNullable<object> = BaseHit> = {
|
|
28
33
|
/**
|
|
29
34
|
* Whether to escape HTML tags from hits string values.
|
|
30
35
|
*
|
|
@@ -36,13 +41,129 @@ export type HitsConnectorParams<THit extends BaseHit = BaseHit> = {
|
|
|
36
41
|
*/
|
|
37
42
|
transformItems?: TransformItems<Hit<THit>>;
|
|
38
43
|
};
|
|
39
|
-
export type HitsWidgetDescription<THit extends
|
|
44
|
+
export type HitsWidgetDescription<THit extends NonNullable<object> = BaseHit> = {
|
|
40
45
|
$$type: 'ais.hits';
|
|
41
46
|
renderState: HitsRenderState<THit>;
|
|
42
47
|
indexRenderState: {
|
|
43
48
|
hits: WidgetRenderState<HitsRenderState<THit>, HitsConnectorParams<THit>>;
|
|
44
49
|
};
|
|
45
50
|
};
|
|
46
|
-
export type HitsConnector<THit extends
|
|
47
|
-
declare const
|
|
48
|
-
|
|
51
|
+
export type HitsConnector<THit extends NonNullable<object> = BaseHit> = Connector<HitsWidgetDescription<THit>, HitsConnectorParams<THit>>;
|
|
52
|
+
declare const _default: <TWidgetParams>(renderFn: Renderer<HitsRenderState<BaseHit>, TWidgetParams & HitsConnectorParams<BaseHit>>, unmountFn?: Unmounter) => <THit extends object = BaseHit>(widgetParams: TWidgetParams & HitsConnectorParams<THit>) => {
|
|
53
|
+
$$type: "ais.hits";
|
|
54
|
+
init(initOptions: import("../../types").InitOptions): void;
|
|
55
|
+
render(renderOptions: import("../../types").RenderOptions): void;
|
|
56
|
+
getRenderState(renderState: {
|
|
57
|
+
answers?: WidgetRenderState<import("../answers/connectAnswers").AnswersRenderState, import("../answers/connectAnswers").AnswersConnectorParams> | undefined;
|
|
58
|
+
autocomplete?: WidgetRenderState<import("../autocomplete/connectAutocomplete").AutocompleteRenderState, import("../autocomplete/connectAutocomplete").AutocompleteConnectorParams> | undefined;
|
|
59
|
+
breadcrumb?: {
|
|
60
|
+
[rootAttribute: string]: WidgetRenderState<import("../breadcrumb/connectBreadcrumb").BreadcrumbRenderState, import("../breadcrumb/connectBreadcrumb").BreadcrumbConnectorParams>;
|
|
61
|
+
} | undefined;
|
|
62
|
+
clearRefinements?: WidgetRenderState<import("../clear-refinements/connectClearRefinements").ClearRefinementsRenderState, import("../clear-refinements/connectClearRefinements").ClearRefinementsConnectorParams> | undefined;
|
|
63
|
+
configure?: WidgetRenderState<import("../configure/connectConfigure").ConfigureRenderState, import("../configure/connectConfigure").ConfigureConnectorParams> | undefined;
|
|
64
|
+
currentRefinements?: WidgetRenderState<import("../current-refinements/connectCurrentRefinements").CurrentRefinementsRenderState, import("../current-refinements/connectCurrentRefinements").CurrentRefinementsConnectorParams> | undefined;
|
|
65
|
+
geoSearch?: WidgetRenderState<import("../geo-search/connectGeoSearch").GeoSearchRenderState<import("../../types").GeoHit>, import("../geo-search/connectGeoSearch").GeoSearchConnectorParams<import("../../types").GeoHit>> | undefined;
|
|
66
|
+
hierarchicalMenu?: {
|
|
67
|
+
[rootAttribute: string]: WidgetRenderState<import("../hierarchical-menu/connectHierarchicalMenu").HierarchicalMenuRenderState, import("../hierarchical-menu/connectHierarchicalMenu").HierarchicalMenuConnectorParams>;
|
|
68
|
+
} | undefined;
|
|
69
|
+
hits?: WidgetRenderState<HitsRenderState<BaseHit>, HitsConnectorParams<BaseHit>> | undefined;
|
|
70
|
+
hitsPerPage?: WidgetRenderState<import("../hits-per-page/connectHitsPerPage").HitsPerPageRenderState, import("../hits-per-page/connectHitsPerPage").HitsPerPageConnectorParams> | undefined;
|
|
71
|
+
infiniteHits?: WidgetRenderState<import("../infinite-hits/connectInfiniteHits").InfiniteHitsRenderState<BaseHit>, import("../infinite-hits/connectInfiniteHits").InfiniteHitsConnectorParams<BaseHit>> | undefined;
|
|
72
|
+
menu?: {
|
|
73
|
+
[attribute: string]: WidgetRenderState<import("../menu/connectMenu").MenuRenderState, import("../menu/connectMenu").MenuConnectorParams>;
|
|
74
|
+
} | undefined;
|
|
75
|
+
numericMenu?: {
|
|
76
|
+
[attribute: string]: WidgetRenderState<import("../numeric-menu/connectNumericMenu").NumericMenuRenderState, import("../numeric-menu/connectNumericMenu").NumericMenuConnectorParams>;
|
|
77
|
+
} | undefined;
|
|
78
|
+
pagination?: WidgetRenderState<import("../pagination/connectPagination").PaginationRenderState, import("../pagination/connectPagination").PaginationConnectorParams> | undefined;
|
|
79
|
+
poweredBy?: WidgetRenderState<import("../powered-by/connectPoweredBy").PoweredByRenderState, import("../powered-by/connectPoweredBy").PoweredByConnectorParams> | undefined;
|
|
80
|
+
queryRules?: WidgetRenderState<import("../query-rules/connectQueryRules").QueryRulesRenderState, import("../query-rules/connectQueryRules").QueryRulesConnectorParams> | undefined;
|
|
81
|
+
range?: {
|
|
82
|
+
[attribute: string]: WidgetRenderState<import("../range/connectRange").RangeRenderState, import("../range/connectRange").RangeConnectorParams>;
|
|
83
|
+
} | undefined;
|
|
84
|
+
ratingMenu?: {
|
|
85
|
+
[attribute: string]: WidgetRenderState<import("../rating-menu/connectRatingMenu").RatingMenuRenderState, import("../rating-menu/connectRatingMenu").RatingMenuConnectorParams>;
|
|
86
|
+
} | undefined;
|
|
87
|
+
refinementList?: {
|
|
88
|
+
[attribute: string]: WidgetRenderState<import("../refinement-list/connectRefinementList").RefinementListRenderState, import("../refinement-list/connectRefinementList").RefinementListConnectorParams>;
|
|
89
|
+
} | undefined;
|
|
90
|
+
relevantSort?: WidgetRenderState<import("../relevant-sort/connectRelevantSort").RelevantSortRenderState, import("../relevant-sort/connectRelevantSort").RelevantSortConnectorParams> | undefined;
|
|
91
|
+
searchBox?: WidgetRenderState<import("../search-box/connectSearchBox").SearchBoxRenderState, import("../search-box/connectSearchBox").SearchBoxConnectorParams> | undefined;
|
|
92
|
+
sortBy?: WidgetRenderState<import("../sort-by/connectSortBy").SortByRenderState, import("../sort-by/connectSortBy").SortByConnectorParams> | undefined;
|
|
93
|
+
stats?: WidgetRenderState<import("../stats/connectStats").StatsRenderState, import("../stats/connectStats").StatsConnectorParams> | undefined;
|
|
94
|
+
toggleRefinement?: {
|
|
95
|
+
[attribute: string]: WidgetRenderState<import("../toggle-refinement/connectToggleRefinement").ToggleRefinementRenderState, import("../toggle-refinement/connectToggleRefinement").ToggleRefinementConnectorParams>;
|
|
96
|
+
} | undefined;
|
|
97
|
+
voiceSearch?: WidgetRenderState<import("../voice-search/connectVoiceSearch").VoiceSearchRenderState, import("../voice-search/connectVoiceSearch").VoiceSearchConnectorParams> | undefined;
|
|
98
|
+
analytics?: WidgetRenderState<Record<string, unknown>, import("../../widgets/analytics/analytics").AnalyticsWidgetParams> | undefined;
|
|
99
|
+
places?: WidgetRenderState<Record<string, unknown>, import("../../widgets/places/places").PlacesWidgetParams> | undefined;
|
|
100
|
+
}, renderOptions: import("../../types").InitOptions | import("../../types").RenderOptions): IndexRenderState & HitsWidgetDescription['indexRenderState'];
|
|
101
|
+
getWidgetRenderState({ results, helper, instantSearchInstance }: import("../../types").InitOptions | import("../../types").RenderOptions): {
|
|
102
|
+
hits: never[];
|
|
103
|
+
items: never[];
|
|
104
|
+
results: undefined;
|
|
105
|
+
banner: undefined;
|
|
106
|
+
sendEvent: SendEventForHits;
|
|
107
|
+
bindEvent: BindEventForHits;
|
|
108
|
+
widgetParams: TWidgetParams & HitsConnectorParams<THit>;
|
|
109
|
+
} | {
|
|
110
|
+
hits: Hit<BaseHit>[] | Hit<THit>[];
|
|
111
|
+
items: Hit<BaseHit>[] | Hit<THit>[];
|
|
112
|
+
results: SearchResults<any>;
|
|
113
|
+
banner: {
|
|
114
|
+
image: {
|
|
115
|
+
urls: {
|
|
116
|
+
url: string;
|
|
117
|
+
}[];
|
|
118
|
+
title?: string | undefined;
|
|
119
|
+
};
|
|
120
|
+
link?: {
|
|
121
|
+
url: string;
|
|
122
|
+
target?: "_blank" | "_self" | undefined;
|
|
123
|
+
} | undefined;
|
|
124
|
+
} | undefined;
|
|
125
|
+
sendEvent: SendEventForHits;
|
|
126
|
+
bindEvent: BindEventForHits;
|
|
127
|
+
widgetParams: TWidgetParams & HitsConnectorParams<THit>;
|
|
128
|
+
};
|
|
129
|
+
dispose({ state }: import("../../types").DisposeOptions): import("algoliasearch-helper").SearchParameters;
|
|
130
|
+
getWidgetSearchParameters(state: import("algoliasearch-helper").SearchParameters, _uiState: {
|
|
131
|
+
uiState: {
|
|
132
|
+
query?: string | undefined;
|
|
133
|
+
configure?: import("algoliasearch-helper").PlainSearchParameters | undefined;
|
|
134
|
+
geoSearch?: {
|
|
135
|
+
boundingBox: string;
|
|
136
|
+
} | undefined;
|
|
137
|
+
hierarchicalMenu?: {
|
|
138
|
+
[rootAttribute: string]: string[];
|
|
139
|
+
} | undefined;
|
|
140
|
+
hitsPerPage?: number | undefined;
|
|
141
|
+
page?: number | undefined;
|
|
142
|
+
menu?: {
|
|
143
|
+
[attribute: string]: string;
|
|
144
|
+
} | undefined;
|
|
145
|
+
numericMenu?: {
|
|
146
|
+
[attribute: string]: string;
|
|
147
|
+
} | undefined;
|
|
148
|
+
range?: {
|
|
149
|
+
[attribute: string]: string;
|
|
150
|
+
} | undefined;
|
|
151
|
+
ratingMenu?: {
|
|
152
|
+
[attribute: string]: number | undefined;
|
|
153
|
+
} | undefined;
|
|
154
|
+
refinementList?: {
|
|
155
|
+
[attribute: string]: string[];
|
|
156
|
+
} | undefined;
|
|
157
|
+
relevantSort?: number | undefined;
|
|
158
|
+
sortBy?: string | undefined;
|
|
159
|
+
toggle?: {
|
|
160
|
+
[attribute: string]: boolean;
|
|
161
|
+
} | undefined;
|
|
162
|
+
places?: {
|
|
163
|
+
query: string;
|
|
164
|
+
position: string;
|
|
165
|
+
} | undefined;
|
|
166
|
+
};
|
|
167
|
+
}): import("algoliasearch-helper").SearchParameters;
|
|
168
|
+
};
|
|
169
|
+
export default _default;
|
|
@@ -9,7 +9,7 @@ var withUsage = createDocumentationMessageGenerator({
|
|
|
9
9
|
name: 'hits',
|
|
10
10
|
connector: true
|
|
11
11
|
});
|
|
12
|
-
|
|
12
|
+
export default (function connectHits(renderFn) {
|
|
13
13
|
var unmountFn = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : noop;
|
|
14
14
|
checkRendering(renderFn, withUsage());
|
|
15
15
|
return function (widgetParams) {
|
|
@@ -34,9 +34,11 @@ var connectHits = function connectHits(renderFn) {
|
|
|
34
34
|
renderFn(_objectSpread(_objectSpread({}, renderState), {}, {
|
|
35
35
|
instantSearchInstance: renderOptions.instantSearchInstance
|
|
36
36
|
}), false);
|
|
37
|
-
renderState.sendEvent('view:internal', renderState.
|
|
37
|
+
renderState.sendEvent('view:internal', renderState.items);
|
|
38
38
|
},
|
|
39
|
-
getRenderState: function getRenderState(renderState, renderOptions
|
|
39
|
+
getRenderState: function getRenderState(renderState, renderOptions
|
|
40
|
+
// Type is explicitly redefined, to avoid having the TWidgetParams type in the definition
|
|
41
|
+
) {
|
|
40
42
|
return _objectSpread(_objectSpread({}, renderState), {}, {
|
|
41
43
|
hits: this.getWidgetRenderState(renderOptions)
|
|
42
44
|
});
|
|
@@ -67,6 +69,7 @@ var connectHits = function connectHits(renderFn) {
|
|
|
67
69
|
if (!results) {
|
|
68
70
|
return {
|
|
69
71
|
hits: [],
|
|
72
|
+
items: [],
|
|
70
73
|
results: undefined,
|
|
71
74
|
banner: undefined,
|
|
72
75
|
sendEvent: sendEvent,
|
|
@@ -79,12 +82,13 @@ var connectHits = function connectHits(renderFn) {
|
|
|
79
82
|
}
|
|
80
83
|
var hitsWithAbsolutePosition = addAbsolutePosition(results.hits, results.page, results.hitsPerPage);
|
|
81
84
|
var hitsWithAbsolutePositionAndQueryID = addQueryID(hitsWithAbsolutePosition, results.queryID);
|
|
82
|
-
var
|
|
85
|
+
var items = transformItems(hitsWithAbsolutePositionAndQueryID, {
|
|
83
86
|
results: results
|
|
84
87
|
});
|
|
85
88
|
var banner = (_results$renderingCon = results.renderingContent) === null || _results$renderingCon === void 0 ? void 0 : (_results$renderingCon2 = _results$renderingCon.widgets) === null || _results$renderingCon2 === void 0 ? void 0 : (_results$renderingCon3 = _results$renderingCon2.banners) === null || _results$renderingCon3 === void 0 ? void 0 : _results$renderingCon3[0];
|
|
86
89
|
return {
|
|
87
|
-
hits:
|
|
90
|
+
hits: items,
|
|
91
|
+
items: items,
|
|
88
92
|
results: results,
|
|
89
93
|
banner: banner,
|
|
90
94
|
sendEvent: sendEvent,
|
|
@@ -102,7 +106,7 @@ var connectHits = function connectHits(renderFn) {
|
|
|
102
106
|
return _objectSpread(_objectSpread({}, acc), {}, _defineProperty({}, key, undefined));
|
|
103
107
|
}, {}));
|
|
104
108
|
},
|
|
105
|
-
getWidgetSearchParameters: function getWidgetSearchParameters(state) {
|
|
109
|
+
getWidgetSearchParameters: function getWidgetSearchParameters(state, _uiState) {
|
|
106
110
|
if (!escapeHTML) {
|
|
107
111
|
return state;
|
|
108
112
|
}
|
|
@@ -112,5 +116,4 @@ var connectHits = function connectHits(renderFn) {
|
|
|
112
116
|
}
|
|
113
117
|
};
|
|
114
118
|
};
|
|
115
|
-
};
|
|
116
|
-
export default connectHits;
|
|
119
|
+
});
|
|
@@ -1,2 +1,191 @@
|
|
|
1
|
-
|
|
1
|
+
import type { HitsConnectorParams } from './connectHits';
|
|
2
|
+
declare const connectHitsWithInsights: <TWidgetParams>(renderFn: import("../../types").Renderer<import("./connectHits").HitsRenderState<import("../../types").BaseHit>, TWidgetParams & HitsConnectorParams<import("../../types").BaseHit>>, unmountFn?: import("../../types").Unmounter) => <THit extends object = import("../../types").BaseHit>(widgetParams: TWidgetParams & HitsConnectorParams<THit>) => {
|
|
3
|
+
$$type: "ais.hits";
|
|
4
|
+
init(initOptions: import("../../types").InitOptions): void;
|
|
5
|
+
render(renderOptions: import("../../types").RenderOptions): void;
|
|
6
|
+
getRenderState(renderState: {
|
|
7
|
+
answers?: import("../../types").WidgetRenderState<import("../answers/connectAnswers").AnswersRenderState, import("../answers/connectAnswers").AnswersConnectorParams> | undefined;
|
|
8
|
+
autocomplete?: import("../../types").WidgetRenderState<import("../autocomplete/connectAutocomplete").AutocompleteRenderState, import("../autocomplete/connectAutocomplete").AutocompleteConnectorParams> | undefined;
|
|
9
|
+
breadcrumb?: {
|
|
10
|
+
[rootAttribute: string]: import("../../types").WidgetRenderState<import("../breadcrumb/connectBreadcrumb").BreadcrumbRenderState, import("../breadcrumb/connectBreadcrumb").BreadcrumbConnectorParams>;
|
|
11
|
+
} | undefined;
|
|
12
|
+
clearRefinements?: import("../../types").WidgetRenderState<import("../clear-refinements/connectClearRefinements").ClearRefinementsRenderState, import("../clear-refinements/connectClearRefinements").ClearRefinementsConnectorParams> | undefined;
|
|
13
|
+
configure?: import("../../types").WidgetRenderState<import("../configure/connectConfigure").ConfigureRenderState, import("../configure/connectConfigure").ConfigureConnectorParams> | undefined;
|
|
14
|
+
currentRefinements?: import("../../types").WidgetRenderState<import("../current-refinements/connectCurrentRefinements").CurrentRefinementsRenderState, import("../current-refinements/connectCurrentRefinements").CurrentRefinementsConnectorParams> | undefined;
|
|
15
|
+
geoSearch?: import("../../types").WidgetRenderState<import("../geo-search/connectGeoSearch").GeoSearchRenderState<import("../../types").GeoHit>, import("../geo-search/connectGeoSearch").GeoSearchConnectorParams<import("../../types").GeoHit>> | undefined;
|
|
16
|
+
hierarchicalMenu?: {
|
|
17
|
+
[rootAttribute: string]: import("../../types").WidgetRenderState<import("../hierarchical-menu/connectHierarchicalMenu").HierarchicalMenuRenderState, import("../hierarchical-menu/connectHierarchicalMenu").HierarchicalMenuConnectorParams>;
|
|
18
|
+
} | undefined;
|
|
19
|
+
hits?: import("../../types").WidgetRenderState<import("./connectHits").HitsRenderState<import("../../types").BaseHit>, HitsConnectorParams<import("../../types").BaseHit>> | undefined;
|
|
20
|
+
hitsPerPage?: import("../../types").WidgetRenderState<import("../hits-per-page/connectHitsPerPage").HitsPerPageRenderState, import("../hits-per-page/connectHitsPerPage").HitsPerPageConnectorParams> | undefined;
|
|
21
|
+
infiniteHits?: import("../../types").WidgetRenderState<import("../infinite-hits/connectInfiniteHits").InfiniteHitsRenderState<import("../../types").BaseHit>, import("../infinite-hits/connectInfiniteHits").InfiniteHitsConnectorParams<import("../../types").BaseHit>> | undefined;
|
|
22
|
+
menu?: {
|
|
23
|
+
[attribute: string]: import("../../types").WidgetRenderState<import("../menu/connectMenu").MenuRenderState, import("../menu/connectMenu").MenuConnectorParams>;
|
|
24
|
+
} | undefined;
|
|
25
|
+
numericMenu?: {
|
|
26
|
+
[attribute: string]: import("../../types").WidgetRenderState<import("../numeric-menu/connectNumericMenu").NumericMenuRenderState, import("../numeric-menu/connectNumericMenu").NumericMenuConnectorParams>;
|
|
27
|
+
} | undefined;
|
|
28
|
+
pagination?: import("../../types").WidgetRenderState<import("../pagination/connectPagination").PaginationRenderState, import("../pagination/connectPagination").PaginationConnectorParams> | undefined;
|
|
29
|
+
poweredBy?: import("../../types").WidgetRenderState<import("../powered-by/connectPoweredBy").PoweredByRenderState, import("../powered-by/connectPoweredBy").PoweredByConnectorParams> | undefined;
|
|
30
|
+
queryRules?: import("../../types").WidgetRenderState<import("../query-rules/connectQueryRules").QueryRulesRenderState, import("../query-rules/connectQueryRules").QueryRulesConnectorParams> | undefined;
|
|
31
|
+
range?: {
|
|
32
|
+
[attribute: string]: import("../../types").WidgetRenderState<import("../range/connectRange").RangeRenderState, import("../range/connectRange").RangeConnectorParams>;
|
|
33
|
+
} | undefined;
|
|
34
|
+
ratingMenu?: {
|
|
35
|
+
[attribute: string]: import("../../types").WidgetRenderState<import("../rating-menu/connectRatingMenu").RatingMenuRenderState, import("../rating-menu/connectRatingMenu").RatingMenuConnectorParams>;
|
|
36
|
+
} | undefined;
|
|
37
|
+
refinementList?: {
|
|
38
|
+
[attribute: string]: import("../../types").WidgetRenderState<import("../refinement-list/connectRefinementList").RefinementListRenderState, import("../refinement-list/connectRefinementList").RefinementListConnectorParams>;
|
|
39
|
+
} | undefined;
|
|
40
|
+
relevantSort?: import("../../types").WidgetRenderState<import("../relevant-sort/connectRelevantSort").RelevantSortRenderState, import("../relevant-sort/connectRelevantSort").RelevantSortConnectorParams> | undefined;
|
|
41
|
+
searchBox?: import("../../types").WidgetRenderState<import("../search-box/connectSearchBox").SearchBoxRenderState, import("../search-box/connectSearchBox").SearchBoxConnectorParams> | undefined;
|
|
42
|
+
sortBy?: import("../../types").WidgetRenderState<import("../sort-by/connectSortBy").SortByRenderState, import("../sort-by/connectSortBy").SortByConnectorParams> | undefined;
|
|
43
|
+
stats?: import("../../types").WidgetRenderState<import("../stats/connectStats").StatsRenderState, import("../stats/connectStats").StatsConnectorParams> | undefined;
|
|
44
|
+
toggleRefinement?: {
|
|
45
|
+
[attribute: string]: import("../../types").WidgetRenderState<import("../toggle-refinement/connectToggleRefinement").ToggleRefinementRenderState, import("../toggle-refinement/connectToggleRefinement").ToggleRefinementConnectorParams>;
|
|
46
|
+
} | undefined;
|
|
47
|
+
voiceSearch?: import("../../types").WidgetRenderState<import("../voice-search/connectVoiceSearch").VoiceSearchRenderState, import("../voice-search/connectVoiceSearch").VoiceSearchConnectorParams> | undefined;
|
|
48
|
+
analytics?: import("../../types").WidgetRenderState<Record<string, unknown>, import("../../widgets/analytics/analytics").AnalyticsWidgetParams> | undefined;
|
|
49
|
+
places?: import("../../types").WidgetRenderState<Record<string, unknown>, import("../../widgets/places/places").PlacesWidgetParams> | undefined;
|
|
50
|
+
}, renderOptions: import("../../types").InitOptions | import("../../types").RenderOptions): Partial<{
|
|
51
|
+
answers: import("../../types").WidgetRenderState<import("../answers/connectAnswers").AnswersRenderState, import("../answers/connectAnswers").AnswersConnectorParams>;
|
|
52
|
+
} & {
|
|
53
|
+
autocomplete: import("../../types").WidgetRenderState<import("../autocomplete/connectAutocomplete").AutocompleteRenderState, import("../autocomplete/connectAutocomplete").AutocompleteConnectorParams>;
|
|
54
|
+
} & {
|
|
55
|
+
breadcrumb: {
|
|
56
|
+
[rootAttribute: string]: import("../../types").WidgetRenderState<import("../breadcrumb/connectBreadcrumb").BreadcrumbRenderState, import("../breadcrumb/connectBreadcrumb").BreadcrumbConnectorParams>;
|
|
57
|
+
};
|
|
58
|
+
} & {
|
|
59
|
+
clearRefinements: import("../../types").WidgetRenderState<import("../clear-refinements/connectClearRefinements").ClearRefinementsRenderState, import("../clear-refinements/connectClearRefinements").ClearRefinementsConnectorParams>;
|
|
60
|
+
} & {
|
|
61
|
+
configure: import("../../types").WidgetRenderState<import("../configure/connectConfigure").ConfigureRenderState, import("../configure/connectConfigure").ConfigureConnectorParams>;
|
|
62
|
+
} & {
|
|
63
|
+
currentRefinements: import("../../types").WidgetRenderState<import("../current-refinements/connectCurrentRefinements").CurrentRefinementsRenderState, import("../current-refinements/connectCurrentRefinements").CurrentRefinementsConnectorParams>;
|
|
64
|
+
} & {
|
|
65
|
+
geoSearch: import("../../types").WidgetRenderState<import("../geo-search/connectGeoSearch").GeoSearchRenderState<import("../../types").GeoHit>, import("../geo-search/connectGeoSearch").GeoSearchConnectorParams<import("../../types").GeoHit>>;
|
|
66
|
+
} & {
|
|
67
|
+
hierarchicalMenu: {
|
|
68
|
+
[rootAttribute: string]: import("../../types").WidgetRenderState<import("../hierarchical-menu/connectHierarchicalMenu").HierarchicalMenuRenderState, import("../hierarchical-menu/connectHierarchicalMenu").HierarchicalMenuConnectorParams>;
|
|
69
|
+
};
|
|
70
|
+
} & {
|
|
71
|
+
hits: import("../../types").WidgetRenderState<import("./connectHits").HitsRenderState<import("../../types").BaseHit>, HitsConnectorParams<import("../../types").BaseHit>>;
|
|
72
|
+
} & {
|
|
73
|
+
hitsPerPage: import("../../types").WidgetRenderState<import("../hits-per-page/connectHitsPerPage").HitsPerPageRenderState, import("../hits-per-page/connectHitsPerPage").HitsPerPageConnectorParams>;
|
|
74
|
+
} & {
|
|
75
|
+
infiniteHits: import("../../types").WidgetRenderState<import("../infinite-hits/connectInfiniteHits").InfiniteHitsRenderState<import("../../types").BaseHit>, import("../infinite-hits/connectInfiniteHits").InfiniteHitsConnectorParams<import("../../types").BaseHit>>;
|
|
76
|
+
} & {
|
|
77
|
+
menu: {
|
|
78
|
+
[attribute: string]: import("../../types").WidgetRenderState<import("../menu/connectMenu").MenuRenderState, import("../menu/connectMenu").MenuConnectorParams>;
|
|
79
|
+
};
|
|
80
|
+
} & {
|
|
81
|
+
numericMenu: {
|
|
82
|
+
[attribute: string]: import("../../types").WidgetRenderState<import("../numeric-menu/connectNumericMenu").NumericMenuRenderState, import("../numeric-menu/connectNumericMenu").NumericMenuConnectorParams>;
|
|
83
|
+
};
|
|
84
|
+
} & {
|
|
85
|
+
pagination: import("../../types").WidgetRenderState<import("../pagination/connectPagination").PaginationRenderState, import("../pagination/connectPagination").PaginationConnectorParams>;
|
|
86
|
+
} & {
|
|
87
|
+
poweredBy: import("../../types").WidgetRenderState<import("../powered-by/connectPoweredBy").PoweredByRenderState, import("../powered-by/connectPoweredBy").PoweredByConnectorParams>;
|
|
88
|
+
} & {
|
|
89
|
+
queryRules: import("../../types").WidgetRenderState<import("../query-rules/connectQueryRules").QueryRulesRenderState, import("../query-rules/connectQueryRules").QueryRulesConnectorParams>;
|
|
90
|
+
} & {
|
|
91
|
+
range: {
|
|
92
|
+
[attribute: string]: import("../../types").WidgetRenderState<import("../range/connectRange").RangeRenderState, import("../range/connectRange").RangeConnectorParams>;
|
|
93
|
+
};
|
|
94
|
+
} & {
|
|
95
|
+
ratingMenu: {
|
|
96
|
+
[attribute: string]: import("../../types").WidgetRenderState<import("../rating-menu/connectRatingMenu").RatingMenuRenderState, import("../rating-menu/connectRatingMenu").RatingMenuConnectorParams>;
|
|
97
|
+
};
|
|
98
|
+
} & {
|
|
99
|
+
refinementList: {
|
|
100
|
+
[attribute: string]: import("../../types").WidgetRenderState<import("../refinement-list/connectRefinementList").RefinementListRenderState, import("../refinement-list/connectRefinementList").RefinementListConnectorParams>;
|
|
101
|
+
};
|
|
102
|
+
} & {
|
|
103
|
+
relevantSort: import("../../types").WidgetRenderState<import("../relevant-sort/connectRelevantSort").RelevantSortRenderState, import("../relevant-sort/connectRelevantSort").RelevantSortConnectorParams>;
|
|
104
|
+
} & {
|
|
105
|
+
searchBox: import("../../types").WidgetRenderState<import("../search-box/connectSearchBox").SearchBoxRenderState, import("../search-box/connectSearchBox").SearchBoxConnectorParams>;
|
|
106
|
+
} & {
|
|
107
|
+
sortBy: import("../../types").WidgetRenderState<import("../sort-by/connectSortBy").SortByRenderState, import("../sort-by/connectSortBy").SortByConnectorParams>;
|
|
108
|
+
} & {
|
|
109
|
+
stats: import("../../types").WidgetRenderState<import("../stats/connectStats").StatsRenderState, import("../stats/connectStats").StatsConnectorParams>;
|
|
110
|
+
} & {
|
|
111
|
+
toggleRefinement: {
|
|
112
|
+
[attribute: string]: import("../../types").WidgetRenderState<import("../toggle-refinement/connectToggleRefinement").ToggleRefinementRenderState, import("../toggle-refinement/connectToggleRefinement").ToggleRefinementConnectorParams>;
|
|
113
|
+
};
|
|
114
|
+
} & {
|
|
115
|
+
voiceSearch: import("../../types").WidgetRenderState<import("../voice-search/connectVoiceSearch").VoiceSearchRenderState, import("../voice-search/connectVoiceSearch").VoiceSearchConnectorParams>;
|
|
116
|
+
} & {
|
|
117
|
+
analytics: import("../../types").WidgetRenderState<Record<string, unknown>, import("../../widgets/analytics/analytics").AnalyticsWidgetParams>;
|
|
118
|
+
} & {
|
|
119
|
+
places: import("../../types").WidgetRenderState<Record<string, unknown>, import("../../widgets/places/places").PlacesWidgetParams>;
|
|
120
|
+
}> & {
|
|
121
|
+
hits: import("../../types").WidgetRenderState<import("./connectHits").HitsRenderState<import("../../types").BaseHit>, HitsConnectorParams<import("../../types").BaseHit>>;
|
|
122
|
+
};
|
|
123
|
+
getWidgetRenderState({ results, helper, instantSearchInstance }: import("../../types").InitOptions | import("../../types").RenderOptions): {
|
|
124
|
+
hits: never[];
|
|
125
|
+
items: never[];
|
|
126
|
+
results: undefined;
|
|
127
|
+
banner: undefined;
|
|
128
|
+
sendEvent: import("../../lib/utils").SendEventForHits;
|
|
129
|
+
bindEvent: import("../../lib/utils").BindEventForHits;
|
|
130
|
+
widgetParams: TWidgetParams & HitsConnectorParams<THit>;
|
|
131
|
+
} | {
|
|
132
|
+
hits: import("../../types").Hit<import("../../types").BaseHit>[] | import("../../types").Hit<THit>[];
|
|
133
|
+
items: import("../../types").Hit<import("../../types").BaseHit>[] | import("../../types").Hit<THit>[];
|
|
134
|
+
results: import("algoliasearch-helper").SearchResults<any>;
|
|
135
|
+
banner: {
|
|
136
|
+
image: {
|
|
137
|
+
urls: {
|
|
138
|
+
url: string;
|
|
139
|
+
}[];
|
|
140
|
+
title?: string | undefined;
|
|
141
|
+
};
|
|
142
|
+
link?: {
|
|
143
|
+
url: string;
|
|
144
|
+
target?: "_blank" | "_self" | undefined;
|
|
145
|
+
} | undefined;
|
|
146
|
+
} | undefined;
|
|
147
|
+
sendEvent: import("../../lib/utils").SendEventForHits;
|
|
148
|
+
bindEvent: import("../../lib/utils").BindEventForHits;
|
|
149
|
+
widgetParams: TWidgetParams & HitsConnectorParams<THit>;
|
|
150
|
+
};
|
|
151
|
+
dispose({ state }: import("../../types").DisposeOptions): import("algoliasearch-helper").SearchParameters;
|
|
152
|
+
getWidgetSearchParameters(state: import("algoliasearch-helper").SearchParameters, _uiState: {
|
|
153
|
+
uiState: {
|
|
154
|
+
query?: string | undefined;
|
|
155
|
+
configure?: import("algoliasearch-helper").PlainSearchParameters | undefined;
|
|
156
|
+
geoSearch?: {
|
|
157
|
+
boundingBox: string;
|
|
158
|
+
} | undefined;
|
|
159
|
+
hierarchicalMenu?: {
|
|
160
|
+
[rootAttribute: string]: string[];
|
|
161
|
+
} | undefined;
|
|
162
|
+
hitsPerPage?: number | undefined;
|
|
163
|
+
page?: number | undefined;
|
|
164
|
+
menu?: {
|
|
165
|
+
[attribute: string]: string;
|
|
166
|
+
} | undefined;
|
|
167
|
+
numericMenu?: {
|
|
168
|
+
[attribute: string]: string;
|
|
169
|
+
} | undefined;
|
|
170
|
+
range?: {
|
|
171
|
+
[attribute: string]: string;
|
|
172
|
+
} | undefined;
|
|
173
|
+
ratingMenu?: {
|
|
174
|
+
[attribute: string]: number | undefined;
|
|
175
|
+
} | undefined;
|
|
176
|
+
refinementList?: {
|
|
177
|
+
[attribute: string]: string[];
|
|
178
|
+
} | undefined;
|
|
179
|
+
relevantSort?: number | undefined;
|
|
180
|
+
sortBy?: string | undefined;
|
|
181
|
+
toggle?: {
|
|
182
|
+
[attribute: string]: boolean;
|
|
183
|
+
} | undefined;
|
|
184
|
+
places?: {
|
|
185
|
+
query: string;
|
|
186
|
+
position: string;
|
|
187
|
+
} | undefined;
|
|
188
|
+
};
|
|
189
|
+
}): import("algoliasearch-helper").SearchParameters;
|
|
190
|
+
};
|
|
2
191
|
export default connectHitsWithInsights;
|