@wix/search 1.0.2 → 1.0.4

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.
@@ -1,7 +1,5 @@
1
1
  import { serializer } from '@wix/metro-runtime/ambassador';
2
2
  import { resolveUrl } from '@wix/metro-runtime';
3
- const _autocompleteRequest = {};
4
- const _autocompleteResponse = {};
5
3
  const _facetClause = { hierarchical: '_hierarchicalFacet' };
6
4
  const _facetClauses = { clauses: '_facetClause' };
7
5
  const _facetsResponse = {
@@ -11,12 +9,6 @@ const _facetsResponse = {
11
9
  hierarchicalAggregation: '_hierarchicalAggregationResponse',
12
10
  sumAggregation: '_sumAggregationResponse',
13
11
  };
14
- const _federatedAutocompleteRequest = {};
15
- const _federatedAutocompleteResponse = {};
16
- const _federatedSearchRequest = {};
17
- const _federatedSearchResponse = {};
18
- const _federatedSuggestRequest = {};
19
- const _federatedSuggestResponse = {};
20
12
  const _hierarchicalAggregationResponse = { values: '_value' };
21
13
  const _hierarchicalFacet = { nestedAggregation: '_hierarchicalFacet' };
22
14
  const _maxAggregationResponse = { maxValue: 'google.protobuf.DoubleValue' };
@@ -25,15 +17,9 @@ const _minMaxAggregationResponse = {
25
17
  minValue: 'google.protobuf.DoubleValue',
26
18
  maxValue: 'google.protobuf.DoubleValue',
27
19
  };
28
- const _relatedRequest = {};
29
- const _relatedResponse = {};
30
20
  const _searchRequest = { facets: '_facetClauses' };
31
21
  const _searchResponse = { facets: '_facetsResponse' };
32
- const _suggestRequest = {};
33
- const _suggestResponse = {};
34
22
  const _sumAggregationResponse = { value: 'google.protobuf.DoubleValue' };
35
- const _trendingRequest = {};
36
- const _trendingResponse = {};
37
23
  const _value = { facets: '_facetsResponse' };
38
24
  function resolveWixSearchV1SiteSearchServiceUrl(opts) {
39
25
  const domainToMappings = {
@@ -132,174 +118,4 @@ export function search(payload) {
132
118
  __search.fromReq = fromReq;
133
119
  return __search;
134
120
  }
135
- /** Searches in multiple document types at once. */
136
- export function federatedSearch(payload) {
137
- const { toJSON: toReq, fromJSON: fromReq } = serializer(_federatedSearchRequest, {});
138
- const { fromJSON: fromRes } = serializer(_federatedSearchResponse, {});
139
- function __federatedSearch({ host }) {
140
- const serializedData = toReq(payload);
141
- const metadata = {
142
- entityFqdn: 'wix.search.v1.sitedocument',
143
- method: 'POST',
144
- methodFqn: 'wix.search.v1.SiteSearchService.FederatedSearch',
145
- url: resolveWixSearchV1SiteSearchServiceUrl({
146
- protoPath: '/api/v1/search/federated',
147
- data: serializedData,
148
- host,
149
- }),
150
- data: serializedData,
151
- transformResponse: fromRes,
152
- };
153
- return metadata;
154
- }
155
- __federatedSearch.fromReq = fromReq;
156
- return __federatedSearch;
157
- }
158
- /**
159
- * Executes search query to fetch suggested items. Unlike search query suggest will match
160
- * partial phrases (for example "blu" will match documents containing "blue", "blues" and "blunt").
161
- * Phrase needs to be at least 3 symbols long. Suggestions can also perform optimisations in search
162
- * results and generally do not guarantee the same level of quality as regular Search endpoint.
163
- */
164
- export function suggest(payload) {
165
- const { toJSON: toReq, fromJSON: fromReq } = serializer(_suggestRequest, {});
166
- const { fromJSON: fromRes } = serializer(_suggestResponse, {});
167
- function __suggest({ host }) {
168
- const serializedData = toReq(payload);
169
- const metadata = {
170
- entityFqdn: 'wix.search.v1.sitedocument',
171
- method: 'POST',
172
- methodFqn: 'wix.search.v1.SiteSearchService.Suggest',
173
- url: resolveWixSearchV1SiteSearchServiceUrl({
174
- protoPath: '/api/v1/suggest',
175
- data: serializedData,
176
- host,
177
- }),
178
- data: serializedData,
179
- transformResponse: fromRes,
180
- };
181
- return metadata;
182
- }
183
- __suggest.fromReq = fromReq;
184
- return __suggest;
185
- }
186
- /** Searches for suggestions in multiple document types at once. */
187
- export function federatedSuggest(payload) {
188
- const { toJSON: toReq, fromJSON: fromReq } = serializer(_federatedSuggestRequest, {});
189
- const { fromJSON: fromRes } = serializer(_federatedSuggestResponse, {});
190
- function __federatedSuggest({ host }) {
191
- const serializedData = toReq(payload);
192
- const metadata = {
193
- entityFqdn: 'wix.search.v1.sitedocument',
194
- method: 'POST',
195
- methodFqn: 'wix.search.v1.SiteSearchService.FederatedSuggest',
196
- url: resolveWixSearchV1SiteSearchServiceUrl({
197
- protoPath: '/api/v1/suggest/federated',
198
- data: serializedData,
199
- host,
200
- }),
201
- data: serializedData,
202
- transformResponse: fromRes,
203
- };
204
- return metadata;
205
- }
206
- __federatedSuggest.fromReq = fromReq;
207
- return __federatedSuggest;
208
- }
209
- /**
210
- * Fetches documents similar to one single document.
211
- * This is typically used to implement "related to" scenarios (for example to fetch related store products when
212
- * consumer is already viewing one).
213
- */
214
- export function related(payload) {
215
- const { toJSON: toReq, fromJSON: fromReq } = serializer(_relatedRequest, {});
216
- const { fromJSON: fromRes } = serializer(_relatedResponse, {});
217
- function __related({ host }) {
218
- const serializedData = toReq(payload);
219
- const metadata = {
220
- entityFqdn: 'wix.search.v1.sitedocument',
221
- method: 'POST',
222
- methodFqn: 'wix.search.v1.SiteSearchService.Related',
223
- url: resolveWixSearchV1SiteSearchServiceUrl({
224
- protoPath: '/api/v1/related',
225
- data: serializedData,
226
- host,
227
- }),
228
- data: serializedData,
229
- transformResponse: fromRes,
230
- };
231
- return metadata;
232
- }
233
- __related.fromReq = fromReq;
234
- return __related;
235
- }
236
- /** Provides phrase completion. For example "blu" could return "blue", "blues" and "blunt" as candidate phrases. This operation is resource heavy at index time and is reserved for special use cases. */
237
- export function autocomplete(payload) {
238
- const { toJSON: toReq, fromJSON: fromReq } = serializer(_autocompleteRequest, {});
239
- const { fromJSON: fromRes } = serializer(_autocompleteResponse, {});
240
- function __autocomplete({ host }) {
241
- const serializedData = toReq(payload);
242
- const metadata = {
243
- entityFqdn: 'wix.search.v1.sitedocument',
244
- method: 'POST',
245
- methodFqn: 'wix.search.v1.SiteSearchService.Autocomplete',
246
- url: resolveWixSearchV1SiteSearchServiceUrl({
247
- protoPath: '/api/v1/autocomplete',
248
- data: serializedData,
249
- host,
250
- }),
251
- data: serializedData,
252
- transformResponse: fromRes,
253
- };
254
- return metadata;
255
- }
256
- __autocomplete.fromReq = fromReq;
257
- return __autocomplete;
258
- }
259
- /** Provides phrase completion from multiple document types at once */
260
- export function federatedAutocomplete(payload) {
261
- const { toJSON: toReq, fromJSON: fromReq } = serializer(_federatedAutocompleteRequest, {});
262
- const { fromJSON: fromRes } = serializer(_federatedAutocompleteResponse, {});
263
- function __federatedAutocomplete({ host }) {
264
- const serializedData = toReq(payload);
265
- const metadata = {
266
- entityFqdn: 'wix.search.v1.sitedocument',
267
- method: 'POST',
268
- methodFqn: 'wix.search.v1.SiteSearchService.FederatedAutocomplete',
269
- url: resolveWixSearchV1SiteSearchServiceUrl({
270
- protoPath: '/api/v1/autocomplete/federated',
271
- data: serializedData,
272
- host,
273
- }),
274
- data: serializedData,
275
- transformResponse: fromRes,
276
- };
277
- return metadata;
278
- }
279
- __federatedAutocomplete.fromReq = fromReq;
280
- return __federatedAutocomplete;
281
- }
282
- /** Returns trending documents for given document types */
283
- export function trending(payload) {
284
- const { toJSON: toReq, fromJSON: fromReq } = serializer(_trendingRequest, {});
285
- const { fromJSON: fromRes } = serializer(_trendingResponse, {});
286
- function __trending({ host }) {
287
- const serializedData = toReq(payload);
288
- const metadata = {
289
- entityFqdn: 'wix.search.v1.sitedocument',
290
- method: 'POST',
291
- methodFqn: 'wix.search.v1.SiteSearchService.Trending',
292
- url: resolveWixSearchV1SiteSearchServiceUrl({
293
- protoPath: '/api/v1/trending',
294
- data: serializedData,
295
- host,
296
- }),
297
- data: serializedData,
298
- transformResponse: fromRes,
299
- };
300
- return metadata;
301
- }
302
- __trending.fromReq = fromReq;
303
- return __trending;
304
- }
305
121
  //# sourceMappingURL=search-v1-sitedocument.http.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"search-v1-sitedocument.http.js","sourceRoot":"","sources":["../../../src/search-v1-sitedocument.http.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAsBhD,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAChC,MAAM,qBAAqB,GAAG,EAAE,CAAC;AACjC,MAAM,YAAY,GAAG,EAAE,YAAY,EAAE,oBAAoB,EAAE,CAAC;AAC5D,MAAM,aAAa,GAAG,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC;AAClD,MAAM,eAAe,GAAG;IACtB,cAAc,EAAE,yBAAyB;IACzC,cAAc,EAAE,yBAAyB;IACzC,iBAAiB,EAAE,4BAA4B;IAC/C,uBAAuB,EAAE,kCAAkC;IAC3D,cAAc,EAAE,yBAAyB;CAC1C,CAAC;AACF,MAAM,6BAA6B,GAAG,EAAE,CAAC;AACzC,MAAM,8BAA8B,GAAG,EAAE,CAAC;AAC1C,MAAM,uBAAuB,GAAG,EAAE,CAAC;AACnC,MAAM,wBAAwB,GAAG,EAAE,CAAC;AACpC,MAAM,wBAAwB,GAAG,EAAE,CAAC;AACpC,MAAM,yBAAyB,GAAG,EAAE,CAAC;AACrC,MAAM,gCAAgC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;AAC9D,MAAM,kBAAkB,GAAG,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,CAAC;AACvE,MAAM,uBAAuB,GAAG,EAAE,QAAQ,EAAE,6BAA6B,EAAE,CAAC;AAC5E,MAAM,uBAAuB,GAAG,EAAE,QAAQ,EAAE,6BAA6B,EAAE,CAAC;AAC5E,MAAM,0BAA0B,GAAG;IACjC,QAAQ,EAAE,6BAA6B;IACvC,QAAQ,EAAE,6BAA6B;CACxC,CAAC;AACF,MAAM,eAAe,GAAG,EAAE,CAAC;AAC3B,MAAM,gBAAgB,GAAG,EAAE,CAAC;AAC5B,MAAM,cAAc,GAAG,EAAE,MAAM,EAAE,eAAe,EAAE,CAAC;AACnD,MAAM,eAAe,GAAG,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAC;AACtD,MAAM,eAAe,GAAG,EAAE,CAAC;AAC3B,MAAM,gBAAgB,GAAG,EAAE,CAAC;AAC5B,MAAM,uBAAuB,GAAG,EAAE,KAAK,EAAE,6BAA6B,EAAE,CAAC;AACzE,MAAM,gBAAgB,GAAG,EAAE,CAAC;AAC5B,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAC7B,MAAM,MAAM,GAAG,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAC;AAE7C,SAAS,sCAAsC,CAC7C,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,kCAAkC;gBAC3C,QAAQ,EAAE,MAAM;aACjB;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,kCAAkC;gBAC3C,QAAQ,EAAE,MAAM;aACjB;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,kCAAkC;gBAC3C,QAAQ,EAAE,MAAM;aACjB;SACF;QACD,gBAAgB,EAAE;YAChB;gBACE,OAAO,EAAE,kCAAkC;gBAC3C,QAAQ,EAAE,MAAM;aACjB;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,kCAAkC;gBAC3C,QAAQ,EAAE,MAAM;aACjB;SACF;QACD,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,kCAAkC;gBAC3C,QAAQ,EAAE,MAAM;aACjB;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,kCAAkC;gBAC3C,QAAQ,EAAE,MAAM;aACjB;SACF;QACD,CAAC,EAAE;YACD;gBACE,OAAO,EAAE,kCAAkC;gBAC3C,QAAQ,EAAE,MAAM;aACjB;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,aAAa;gBACtB,QAAQ,EAAE,MAAM;aACjB;SACF;KACF,CAAC;IAEF,OAAO,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,MAAM,CACpB,OAAsB;IAEtB,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,cAAc,EAAE;QACtE,YAAY;QACZ,aAAa;QACb,kBAAkB;KACnB,CAAC,CAAC;IACH,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,eAAe,EAAE;QACxD,eAAe;QACf,gCAAgC;QAChC,uBAAuB;QACvB,uBAAuB;QACvB,0BAA0B;QAC1B,uBAAuB;QACvB,MAAM;KACP,CAAC,CAAC;IAEH,SAAS,QAAQ,CAAC,EAAE,IAAI,EAAO;QAC7B,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,4BAA4B;YACxC,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,wCAAwC;YACnD,GAAG,EAAE,sCAAsC,CAAC;gBAC1C,SAAS,EAAE,gBAAgB;gBAC3B,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAC;IAE3B,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,mDAAmD;AACnD,MAAM,UAAU,eAAe,CAC7B,OAA+B;IAE/B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,uBAAuB,EACvB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,wBAAwB,EAAE,EAAE,CAAC,CAAC;IAEvE,SAAS,iBAAiB,CAAC,EAAE,IAAI,EAAO;QACtC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,4BAA4B;YACxC,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,iDAAiD;YAC5D,GAAG,EAAE,sCAAsC,CAAC;gBAC1C,SAAS,EAAE,0BAA0B;gBACrC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,iBAAiB,CAAC,OAAO,GAAG,OAAO,CAAC;IAEpC,OAAO,iBAAiB,CAAC;AAC3B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,OAAO,CACrB,OAAuB;IAEvB,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;IAC7E,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC;IAE/D,SAAS,SAAS,CAAC,EAAE,IAAI,EAAO;QAC9B,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,4BAA4B;YACxC,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,yCAAyC;YACpD,GAAG,EAAE,sCAAsC,CAAC;gBAC1C,SAAS,EAAE,iBAAiB;gBAC5B,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,SAAS,CAAC,OAAO,GAAG,OAAO,CAAC;IAE5B,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,mEAAmE;AACnE,MAAM,UAAU,gBAAgB,CAC9B,OAAgC;IAEhC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,wBAAwB,EACxB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,yBAAyB,EAAE,EAAE,CAAC,CAAC;IAExE,SAAS,kBAAkB,CAAC,EAAE,IAAI,EAAO;QACvC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,4BAA4B;YACxC,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,kDAAkD;YAC7D,GAAG,EAAE,sCAAsC,CAAC;gBAC1C,SAAS,EAAE,2BAA2B;gBACtC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,kBAAkB,CAAC,OAAO,GAAG,OAAO,CAAC;IAErC,OAAO,kBAAkB,CAAC;AAC5B,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,OAAO,CACrB,OAAuB;IAEvB,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;IAC7E,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC;IAE/D,SAAS,SAAS,CAAC,EAAE,IAAI,EAAO;QAC9B,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,4BAA4B;YACxC,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,yCAAyC;YACpD,GAAG,EAAE,sCAAsC,CAAC;gBAC1C,SAAS,EAAE,iBAAiB;gBAC5B,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,SAAS,CAAC,OAAO,GAAG,OAAO,CAAC;IAE5B,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,yMAAyM;AACzM,MAAM,UAAU,YAAY,CAC1B,OAA4B;IAE5B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,oBAAoB,EACpB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,qBAAqB,EAAE,EAAE,CAAC,CAAC;IAEpE,SAAS,cAAc,CAAC,EAAE,IAAI,EAAO;QACnC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,4BAA4B;YACxC,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,8CAA8C;YACzD,GAAG,EAAE,sCAAsC,CAAC;gBAC1C,SAAS,EAAE,sBAAsB;gBACjC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,cAAc,CAAC,OAAO,GAAG,OAAO,CAAC;IAEjC,OAAO,cAAc,CAAC;AACxB,CAAC;AAED,sEAAsE;AACtE,MAAM,UAAU,qBAAqB,CACnC,OAAqC;IAErC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CACrD,6BAA6B,EAC7B,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,8BAA8B,EAAE,EAAE,CAAC,CAAC;IAE7E,SAAS,uBAAuB,CAAC,EAAE,IAAI,EAAO;QAC5C,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,4BAA4B;YACxC,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,uDAAuD;YAClE,GAAG,EAAE,sCAAsC,CAAC;gBAC1C,SAAS,EAAE,gCAAgC;gBAC3C,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,uBAAuB,CAAC,OAAO,GAAG,OAAO,CAAC;IAE1C,OAAO,uBAAuB,CAAC;AACjC,CAAC;AAED,0DAA0D;AAC1D,MAAM,UAAU,QAAQ,CACtB,OAAwB;IAExB,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC;IAC9E,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC;IAEhE,SAAS,UAAU,CAAC,EAAE,IAAI,EAAO;QAC/B,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,4BAA4B;YACxC,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,0CAA0C;YACrD,GAAG,EAAE,sCAAsC,CAAC;gBAC1C,SAAS,EAAE,kBAAkB;gBAC7B,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,UAAU,CAAC,OAAO,GAAG,OAAO,CAAC;IAE7B,OAAO,UAAU,CAAC;AACpB,CAAC"}
1
+ {"version":3,"file":"search-v1-sitedocument.http.js","sourceRoot":"","sources":["../../../src/search-v1-sitedocument.http.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAKhD,MAAM,YAAY,GAAG,EAAE,YAAY,EAAE,oBAAoB,EAAE,CAAC;AAC5D,MAAM,aAAa,GAAG,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC;AAClD,MAAM,eAAe,GAAG;IACtB,cAAc,EAAE,yBAAyB;IACzC,cAAc,EAAE,yBAAyB;IACzC,iBAAiB,EAAE,4BAA4B;IAC/C,uBAAuB,EAAE,kCAAkC;IAC3D,cAAc,EAAE,yBAAyB;CAC1C,CAAC;AACF,MAAM,gCAAgC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;AAC9D,MAAM,kBAAkB,GAAG,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,CAAC;AACvE,MAAM,uBAAuB,GAAG,EAAE,QAAQ,EAAE,6BAA6B,EAAE,CAAC;AAC5E,MAAM,uBAAuB,GAAG,EAAE,QAAQ,EAAE,6BAA6B,EAAE,CAAC;AAC5E,MAAM,0BAA0B,GAAG;IACjC,QAAQ,EAAE,6BAA6B;IACvC,QAAQ,EAAE,6BAA6B;CACxC,CAAC;AACF,MAAM,cAAc,GAAG,EAAE,MAAM,EAAE,eAAe,EAAE,CAAC;AACnD,MAAM,eAAe,GAAG,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAC;AACtD,MAAM,uBAAuB,GAAG,EAAE,KAAK,EAAE,6BAA6B,EAAE,CAAC;AACzE,MAAM,MAAM,GAAG,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAC;AAE7C,SAAS,sCAAsC,CAC7C,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,kCAAkC;gBAC3C,QAAQ,EAAE,MAAM;aACjB;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,kCAAkC;gBAC3C,QAAQ,EAAE,MAAM;aACjB;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,kCAAkC;gBAC3C,QAAQ,EAAE,MAAM;aACjB;SACF;QACD,gBAAgB,EAAE;YAChB;gBACE,OAAO,EAAE,kCAAkC;gBAC3C,QAAQ,EAAE,MAAM;aACjB;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,kCAAkC;gBAC3C,QAAQ,EAAE,MAAM;aACjB;SACF;QACD,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,kCAAkC;gBAC3C,QAAQ,EAAE,MAAM;aACjB;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,kCAAkC;gBAC3C,QAAQ,EAAE,MAAM;aACjB;SACF;QACD,CAAC,EAAE;YACD;gBACE,OAAO,EAAE,kCAAkC;gBAC3C,QAAQ,EAAE,MAAM;aACjB;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,aAAa;gBACtB,QAAQ,EAAE,MAAM;aACjB;SACF;KACF,CAAC;IAEF,OAAO,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,MAAM,CACpB,OAAsB;IAEtB,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,cAAc,EAAE;QACtE,YAAY;QACZ,aAAa;QACb,kBAAkB;KACnB,CAAC,CAAC;IACH,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,eAAe,EAAE;QACxD,eAAe;QACf,gCAAgC;QAChC,uBAAuB;QACvB,uBAAuB;QACvB,0BAA0B;QAC1B,uBAAuB;QACvB,MAAM;KACP,CAAC,CAAC;IAEH,SAAS,QAAQ,CAAC,EAAE,IAAI,EAAO;QAC7B,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,4BAA4B;YACxC,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,wCAAwC;YACnD,GAAG,EAAE,sCAAsC,CAAC;gBAC1C,SAAS,EAAE,gBAAgB;gBAC3B,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAC;IAE3B,OAAO,QAAQ,CAAC;AAClB,CAAC"}
@@ -1,15 +1,8 @@
1
1
  import { HttpClient } from '@wix/sdk-types';
2
- import { AutocompleteOptions, FederatedAutocompleteOptions, FederatedSearchOptions, FederatedSuggestOptions, RelatedOptions, SearchOptions, SuggestOptions, TrendingOptions } from './search-v1-sitedocument.universal';
2
+ import { SearchOptions } from './search-v1-sitedocument.universal';
3
3
  export declare const __metadata: {
4
4
  PACKAGE_NAME: string;
5
5
  };
6
6
  export declare function search(httpClient: HttpClient): (options?: SearchOptions | undefined) => Promise<import("./search-v1-sitedocument.universal").SearchResponse>;
7
- export declare function federatedSearch(httpClient: HttpClient): (options?: FederatedSearchOptions | undefined) => Promise<import("./search-v1-sitedocument.universal").FederatedSearchResponse>;
8
- export declare function suggest(httpClient: HttpClient): (options?: SuggestOptions | undefined) => Promise<import("./search-v1-sitedocument.universal").SuggestResponse>;
9
- export declare function federatedSuggest(httpClient: HttpClient): (options?: FederatedSuggestOptions | undefined) => Promise<import("./search-v1-sitedocument.universal").FederatedSuggestResponse>;
10
- export declare function related(httpClient: HttpClient): (options?: RelatedOptions | undefined) => Promise<import("./search-v1-sitedocument.universal").RelatedResponse>;
11
- export declare function autocomplete(httpClient: HttpClient): (options?: AutocompleteOptions | undefined) => Promise<import("./search-v1-sitedocument.universal").AutocompleteResponse>;
12
- export declare function federatedAutocomplete(httpClient: HttpClient): (options?: FederatedAutocompleteOptions | undefined) => Promise<import("./search-v1-sitedocument.universal").FederatedAutocompleteResponse>;
13
- export declare function trending(httpClient: HttpClient): (options?: TrendingOptions | undefined) => Promise<import("./search-v1-sitedocument.universal").TrendingResponse>;
14
7
  export { VersioningMode, Enum, Direction, Aggregation, } from './search-v1-sitedocument.universal';
15
- export { SiteDocument, UpdateInternalDocumentsEvent, UpdateInternalDocumentsEventOperationOneOf, InternalDocument, InternalDocumentUpdateOperation, DeleteByIdsOperation, DeleteByFilterOperation, InternalDocumentUpdateByFilterOperation, InternalUpdateExistingOperation, VersionedDocumentUpdateOperation, VersionedDeleteByIdsOperation, VersionedDocumentId, UpdateDocumentsEvent, UpdateDocumentsEventOperationOneOf, DocumentUpdateOperation, IndexDocument, DocumentPayload, DocumentImage, V1DeleteByIdsOperation, V1DeleteByFilterOperation, UpdateByFilterOperation, UpdateExistingOperation, Empty, DiffMatokyPayload, ErrorInformation, SearchRequest, OrderingClauses, OrderingClause, SearchPaging, FacetClauses, FacetClause, FacetClauseClauseOneOf, HierarchicalFacet, HierarchicalFacetClauseOneOf, TermFacet, AggregationFacet, SearchProperty, SearchResponse, NextPageResponse, FacetsResponse, FacetsResponseResponseOneOf, FacetCountResponse, Value, TermAggregationResponse, MinAggregationResponse, MaxAggregationResponse, MinMaxAggregationResponse, HierarchicalAggregationResponse, SumAggregationResponse, FederatedSearchRequest, FederatedSearchResponse, FederatedSearchDocuments, SuggestRequest, SuggestResponse, FederatedSuggestRequest, FederatedSuggestResponse, FederatedSuggestDocuments, RelatedRequest, RelatedResponse, AutocompleteRequest, AutocompleteResponse, AutocompleteResponseValue, FederatedAutocompleteRequest, FederatedAutocompleteResponse, FederatedAutocompleteResults, TrendingRequest, TrendingResponse, TrendingItems, SearchOptions, FederatedSearchOptions, SuggestOptions, FederatedSuggestOptions, RelatedOptions, AutocompleteOptions, FederatedAutocompleteOptions, TrendingOptions, } from './search-v1-sitedocument.universal';
8
+ export { SiteDocument, UpdateInternalDocumentsEvent, UpdateInternalDocumentsEventOperationOneOf, InternalDocument, InternalDocumentUpdateOperation, DeleteByIdsOperation, DeleteByFilterOperation, InternalDocumentUpdateByFilterOperation, InternalUpdateExistingOperation, VersionedDocumentUpdateOperation, VersionedDeleteByIdsOperation, VersionedDocumentId, UpdateDocumentsEvent, UpdateDocumentsEventOperationOneOf, DocumentUpdateOperation, IndexDocument, DocumentPayload, DocumentImage, V1DeleteByIdsOperation, V1DeleteByFilterOperation, UpdateByFilterOperation, UpdateExistingOperation, Empty, DiffMatokyPayload, ErrorInformation, SearchRequest, OrderingClauses, OrderingClause, SearchPaging, FacetClauses, FacetClause, FacetClauseClauseOneOf, HierarchicalFacet, HierarchicalFacetClauseOneOf, TermFacet, AggregationFacet, SearchProperty, SearchResponse, NextPageResponse, FacetsResponse, FacetsResponseResponseOneOf, FacetCountResponse, Value, TermAggregationResponse, MinAggregationResponse, MaxAggregationResponse, MinMaxAggregationResponse, HierarchicalAggregationResponse, SumAggregationResponse, FederatedSearchRequest, FederatedSearchResponse, FederatedSearchDocuments, SuggestRequest, SuggestResponse, FederatedSuggestRequest, FederatedSuggestResponse, FederatedSuggestDocuments, RelatedRequest, RelatedResponse, AutocompleteRequest, AutocompleteResponse, AutocompleteResponseValue, FederatedAutocompleteRequest, FederatedAutocompleteResponse, FederatedAutocompleteResults, TrendingRequest, TrendingResponse, TrendingItems, SearchOptions, } from './search-v1-sitedocument.universal';
@@ -1,44 +1,9 @@
1
- import { search as universalSearch, federatedSearch as universalFederatedSearch, suggest as universalSuggest, federatedSuggest as universalFederatedSuggest, related as universalRelated, autocomplete as universalAutocomplete, federatedAutocomplete as universalFederatedAutocomplete, trending as universalTrending, } from './search-v1-sitedocument.universal';
1
+ import { search as universalSearch, } from './search-v1-sitedocument.universal';
2
2
  export const __metadata = { PACKAGE_NAME: '@wix/search' };
3
3
  export function search(httpClient) {
4
4
  return (options) => universalSearch(options,
5
5
  // @ts-ignore
6
6
  { httpClient });
7
7
  }
8
- export function federatedSearch(httpClient) {
9
- return (options) => universalFederatedSearch(options,
10
- // @ts-ignore
11
- { httpClient });
12
- }
13
- export function suggest(httpClient) {
14
- return (options) => universalSuggest(options,
15
- // @ts-ignore
16
- { httpClient });
17
- }
18
- export function federatedSuggest(httpClient) {
19
- return (options) => universalFederatedSuggest(options,
20
- // @ts-ignore
21
- { httpClient });
22
- }
23
- export function related(httpClient) {
24
- return (options) => universalRelated(options,
25
- // @ts-ignore
26
- { httpClient });
27
- }
28
- export function autocomplete(httpClient) {
29
- return (options) => universalAutocomplete(options,
30
- // @ts-ignore
31
- { httpClient });
32
- }
33
- export function federatedAutocomplete(httpClient) {
34
- return (options) => universalFederatedAutocomplete(options,
35
- // @ts-ignore
36
- { httpClient });
37
- }
38
- export function trending(httpClient) {
39
- return (options) => universalTrending(options,
40
- // @ts-ignore
41
- { httpClient });
42
- }
43
8
  export { VersioningMode, Enum, Direction, Aggregation, } from './search-v1-sitedocument.universal';
44
9
  //# sourceMappingURL=search-v1-sitedocument.public.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"search-v1-sitedocument.public.js","sourceRoot":"","sources":["../../../src/search-v1-sitedocument.public.ts"],"names":[],"mappings":"AACA,OAAO,EACL,MAAM,IAAI,eAAe,EACzB,eAAe,IAAI,wBAAwB,EAC3C,OAAO,IAAI,gBAAgB,EAC3B,gBAAgB,IAAI,yBAAyB,EAC7C,OAAO,IAAI,gBAAgB,EAC3B,YAAY,IAAI,qBAAqB,EACrC,qBAAqB,IAAI,8BAA8B,EACvD,QAAQ,IAAI,iBAAiB,GAS9B,MAAM,oCAAoC,CAAC;AAE5C,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,YAAY,EAAE,aAAa,EAAE,CAAC;AAE1D,MAAM,UAAU,MAAM,CAAC,UAAsB;IAC3C,OAAO,CAAC,OAAuB,EAAE,EAAE,CACjC,eAAe,CACb,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,UAAsB;IACpD,OAAO,CAAC,OAAgC,EAAE,EAAE,CAC1C,wBAAwB,CACtB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,UAAsB;IAC5C,OAAO,CAAC,OAAwB,EAAE,EAAE,CAClC,gBAAgB,CACd,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,UAAsB;IACrD,OAAO,CAAC,OAAiC,EAAE,EAAE,CAC3C,yBAAyB,CACvB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,UAAsB;IAC5C,OAAO,CAAC,OAAwB,EAAE,EAAE,CAClC,gBAAgB,CACd,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,UAAsB;IACjD,OAAO,CAAC,OAA6B,EAAE,EAAE,CACvC,qBAAqB,CACnB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,UAAsB;IAC1D,OAAO,CAAC,OAAsC,EAAE,EAAE,CAChD,8BAA8B,CAC5B,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,UAAsB;IAC7C,OAAO,CAAC,OAAyB,EAAE,EAAE,CACnC,iBAAiB,CACf,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,OAAO,EACL,cAAc,EACd,IAAI,EACJ,SAAS,EACT,WAAW,GACZ,MAAM,oCAAoC,CAAC"}
1
+ {"version":3,"file":"search-v1-sitedocument.public.js","sourceRoot":"","sources":["../../../src/search-v1-sitedocument.public.ts"],"names":[],"mappings":"AACA,OAAO,EACL,MAAM,IAAI,eAAe,GAE1B,MAAM,oCAAoC,CAAC;AAE5C,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,YAAY,EAAE,aAAa,EAAE,CAAC;AAE1D,MAAM,UAAU,MAAM,CAAC,UAAsB;IAC3C,OAAO,CAAC,OAAuB,EAAE,EAAE,CACjC,eAAe,CACb,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAED,OAAO,EACL,cAAc,EACd,IAAI,EACJ,SAAS,EACT,WAAW,GACZ,MAAM,oCAAoC,CAAC"}
@@ -589,162 +589,3 @@ export interface SearchOptions {
589
589
  /** Include seo hidden documents. Defaults to false if not provided. */
590
590
  includeSeoHidden?: boolean | null;
591
591
  }
592
- /**
593
- * Searches in multiple document types at once.
594
- * @public
595
- * @documentationMaturity preview
596
- */
597
- export declare function federatedSearch(options?: FederatedSearchOptions): Promise<FederatedSearchResponse>;
598
- export interface FederatedSearchOptions {
599
- /** Query phrase to use. */
600
- query?: string | null;
601
- /** Language to search in. */
602
- language?: string | null;
603
- /** Limit of documents to return per document type. */
604
- limit?: number | null;
605
- /** Enable fuzzy search (for example query 'kalvin clein' will match document with 'calvin klein' in title). */
606
- fuzzy?: boolean | null;
607
- /** Highlight texts matching the query. Highlighted text will be wrapped with <mark/> tag. Defaults to true if not provided. */
608
- highlight?: boolean | null;
609
- /** Searchable fields to search in. If not provided, search is executed on all searchable fields in schemas */
610
- searchFields?: string[];
611
- /** Document types to search in. If not provided, search is executed on all document types enabled for the site */
612
- documentTypes?: string[];
613
- /** Include seo hidden documents. Defaults to false if not provided. */
614
- includeSeoHidden?: boolean | null;
615
- }
616
- /**
617
- * Executes search query to fetch suggested items. Unlike search query suggest will match
618
- * partial phrases (for example "blu" will match documents containing "blue", "blues" and "blunt").
619
- * Phrase needs to be at least 3 symbols long. Suggestions can also perform optimisations in search
620
- * results and generally do not guarantee the same level of quality as regular Search endpoint.
621
- * @public
622
- * @documentationMaturity preview
623
- */
624
- export declare function suggest(options?: SuggestOptions): Promise<SuggestResponse>;
625
- export interface SuggestOptions {
626
- /** Text to search for. Fields configured in suggester configuration will be searched. */
627
- query?: string | null;
628
- /** Document type of documents to search for. All document types are searched if not provided. */
629
- documentType?: string | null;
630
- /** Fields to order by. */
631
- ordering?: OrderingClauses;
632
- /** Number of suggested document to return. */
633
- limit?: number;
634
- /** Language to search in. */
635
- language?: string | null;
636
- /** Filter in platformized query language (for example {'field': {'$eq': 'value'}}) */
637
- filter?: Record<string, any> | null;
638
- /** Searchable fields to search in. If not provided, search is executed on all suggestable fields in schema */
639
- searchFields?: string[];
640
- /** A list of fields to include in the result set. If not provided, all fields of schema will be included. */
641
- fields?: string[];
642
- /** Include seo hidden documents. Defaults to false if not provided. */
643
- includeSeoHidden?: boolean | null;
644
- /** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`. */
645
- properties?: SearchProperty[];
646
- }
647
- /**
648
- * Searches for suggestions in multiple document types at once.
649
- * @public
650
- * @documentationMaturity preview
651
- */
652
- export declare function federatedSuggest(options?: FederatedSuggestOptions): Promise<FederatedSuggestResponse>;
653
- export interface FederatedSuggestOptions {
654
- /** Text to search for. Fields configured in suggester configuration will be searched. */
655
- query?: string | null;
656
- /** Language to search in. */
657
- language?: string | null;
658
- /** Number of suggested document to return per document type. */
659
- limit?: number;
660
- /** Searchable fields to search in. If not provided, search is executed on all suggestable fields in schemas */
661
- searchFields?: string[];
662
- /** Document types to search in. If not provided, search is executed on all document types enabled for the site */
663
- documentTypes?: string[];
664
- /** Include seo hidden documents. Defaults to false if not provided. */
665
- includeSeoHidden?: boolean | null;
666
- }
667
- /**
668
- * Fetches documents similar to one single document.
669
- * This is typically used to implement "related to" scenarios (for example to fetch related store products when
670
- * consumer is already viewing one).
671
- * @public
672
- * @documentationMaturity preview
673
- */
674
- export declare function related(options?: RelatedOptions): Promise<RelatedResponse>;
675
- export interface RelatedOptions {
676
- /** ID of the document to fetch related documents for. */
677
- documentId?: string | null;
678
- /** Document type of the document. */
679
- documentType?: string | null;
680
- /** Fields to order by. */
681
- ordering?: OrderingClauses;
682
- /** Language to search in. */
683
- language?: string | null;
684
- /** Filter in platformized query language (for example {'field': {'$eq': 'value'}}). */
685
- filter?: Record<string, any> | null;
686
- /** Searchable fields to compare documents by. If not provided, all searchable fields in schema are used */
687
- searchFields?: string[];
688
- /** A list of fields to include in the result set. If not provided, all fields of schema will be included. */
689
- fields?: string[];
690
- /** Number of related documents to return */
691
- limit?: number;
692
- /** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`. */
693
- properties?: SearchProperty[];
694
- /** Include seo hidden documents. Defaults to false if not provided. */
695
- includeSeoHidden?: boolean | null;
696
- }
697
- /**
698
- * Provides phrase completion. For example "blu" could return "blue", "blues" and "blunt" as candidate phrases. This operation is resource heavy at index time and is reserved for special use cases.
699
- * @public
700
- * @documentationMaturity preview
701
- */
702
- export declare function autocomplete(options?: AutocompleteOptions): Promise<AutocompleteResponse>;
703
- export interface AutocompleteOptions {
704
- /** Query phrase to fetch completions for. */
705
- query?: string | null;
706
- /** Document type to use to search for phrases. */
707
- documentType?: string | null;
708
- /** Limit of phrases to fetch. */
709
- limit?: number;
710
- /** Language to search in. */
711
- language?: string | null;
712
- /** Filter in platfromized query language (for example {'field': {'$eq': 'value'}}) */
713
- filter?: Record<string, any> | null;
714
- /** Searchable fields to use for query completion. If not provided, all searchable fields in schema are used */
715
- searchFields?: string[];
716
- /** Include seo hidden documents. Defaults to false if not provided. */
717
- includeSeoHidden?: boolean | null;
718
- }
719
- /**
720
- * Provides phrase completion from multiple document types at once
721
- * @public
722
- * @documentationMaturity preview
723
- */
724
- export declare function federatedAutocomplete(options?: FederatedAutocompleteOptions): Promise<FederatedAutocompleteResponse>;
725
- export interface FederatedAutocompleteOptions {
726
- /** Query phrase to fetch completions for. */
727
- query?: string | null;
728
- /** Language to search in. */
729
- language?: string | null;
730
- /** Number of queries to return per document type. */
731
- limit?: number;
732
- /** Searchable fields to search in. If not provided, search is executed on all autocompletable fields in schemas */
733
- searchFields?: string[];
734
- /** Document types to autocomplete in. If not provided, autocomplete is executed on all document types enabled for the site */
735
- documentTypes?: string[];
736
- /** Include seo hidden documents. Defaults to false if not provided. */
737
- includeSeoHidden?: boolean | null;
738
- }
739
- /**
740
- * Returns trending documents for given document types
741
- * @public
742
- * @documentationMaturity preview
743
- */
744
- export declare function trending(options?: TrendingOptions): Promise<TrendingResponse>;
745
- export interface TrendingOptions {
746
- documentTypes?: string[];
747
- language?: string | null;
748
- /** Include seo hidden documents. Defaults to false if not provided. */
749
- includeSeoHidden?: boolean | null;
750
- }