@wix/search 1.0.35 → 1.0.37

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,2 +1,3 @@
1
- export * as wixSiteSearch from '@wix/search_wix-site-search';
2
- export * as siteSearch from '@wix/search_site-search';
1
+ import * as wixSiteSearch from '@wix/search_wix-site-search';
2
+ import * as siteSearch from '@wix/search_site-search';
3
+ export { wixSiteSearch, siteSearch };
@@ -24,6 +24,8 @@ var __importStar = (this && this.__importStar) || function (mod) {
24
24
  };
25
25
  Object.defineProperty(exports, "__esModule", { value: true });
26
26
  exports.siteSearch = exports.wixSiteSearch = void 0;
27
- exports.wixSiteSearch = __importStar(require("@wix/search_wix-site-search"));
28
- exports.siteSearch = __importStar(require("@wix/search_site-search"));
27
+ const wixSiteSearch = __importStar(require("@wix/search_wix-site-search"));
28
+ exports.wixSiteSearch = wixSiteSearch;
29
+ const siteSearch = __importStar(require("@wix/search_site-search"));
30
+ exports.siteSearch = siteSearch;
29
31
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6EAA6D;AAC7D,sEAAsD"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2EAA6D;AAGpD,sCAAa;AAFtB,oEAAsD;AAE9B,gCAAU"}
@@ -1,2 +1,3 @@
1
- export * as wixSiteSearch from '@wix/search_wix-site-search';
2
- export * as siteSearch from '@wix/search_site-search';
1
+ import * as wixSiteSearch from '@wix/search_wix-site-search';
2
+ import * as siteSearch from '@wix/search_site-search';
3
+ export { wixSiteSearch, siteSearch };
package/build/es/index.js CHANGED
@@ -1,3 +1,4 @@
1
- export * as wixSiteSearch from '@wix/search_wix-site-search';
2
- export * as siteSearch from '@wix/search_site-search';
1
+ import * as wixSiteSearch from '@wix/search_wix-site-search';
2
+ import * as siteSearch from '@wix/search_site-search';
3
+ export { wixSiteSearch, siteSearch };
3
4
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,aAAa,MAAM,6BAA6B,CAAC;AAC7D,OAAO,KAAK,UAAU,MAAM,yBAAyB,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,aAAa,MAAM,6BAA6B,CAAC;AAC7D,OAAO,KAAK,UAAU,MAAM,yBAAyB,CAAC;AAEtD,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/search",
3
- "version": "1.0.35",
3
+ "version": "1.0.37",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -18,8 +18,8 @@
18
18
  "type-bundles"
19
19
  ],
20
20
  "dependencies": {
21
- "@wix/search_site-search": "1.0.22",
22
- "@wix/search_wix-site-search": "1.0.13"
21
+ "@wix/search_site-search": "1.0.24",
22
+ "@wix/search_wix-site-search": "1.0.15"
23
23
  },
24
24
  "devDependencies": {
25
25
  "glob": "^10.4.1",
@@ -28,8 +28,9 @@
28
28
  "typescript": "^5.3.2"
29
29
  },
30
30
  "scripts": {
31
- "build": "tsc -b tsconfig.json tsconfig.esm.json && npm run build:dts-bundles",
31
+ "build": "tsc -b tsconfig.json tsconfig.esm.json && npm run build:dts-bundles && npm run build:validate-dts",
32
32
  "build:dts-bundles": "test -f config/rollup-config.js && NODE_OPTIONS=--max-old-space-size=8192 rollup --config config/rollup-config.js || echo 'Warning: config/rollup-config.js not found!'",
33
+ "build:validate-dts": "tsc type-bundles/*.d.ts --noEmit",
33
34
  "test": ":"
34
35
  },
35
36
  "wix": {
@@ -43,5 +44,5 @@
43
44
  "fqdn": ""
44
45
  }
45
46
  },
46
- "falconPackageHash": "6e9546e4a42a6f8816d19a13e686abe6bcb58c56ac0760b5740b7801"
47
+ "falconPackageHash": "6323dd4dd320358e403019c826eaeaf75534e19c74cbeda637857c36"
47
48
  }
@@ -1,20 +1,54 @@
1
- interface SearchRequest$1 {
2
- /** Search query and aggregation information. */
3
- search: Search;
4
- /** Document type of the documents to search in. */
5
- documentType: DocumentType;
6
- /** Language to search in. */
7
- language?: string | null;
1
+ type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
2
+ interface HttpClient {
3
+ request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
4
+ fetchWithAuth: typeof fetch;
5
+ wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
8
6
  }
7
+ type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
8
+ type HttpResponse<T = any> = {
9
+ data: T;
10
+ status: number;
11
+ statusText: string;
12
+ headers: any;
13
+ request?: any;
14
+ };
15
+ type RequestOptions<_TResponse = any, Data = any> = {
16
+ method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
17
+ url: string;
18
+ data?: Data;
19
+ params?: URLSearchParams;
20
+ } & APIMetadata;
21
+ type APIMetadata = {
22
+ methodFqn?: string;
23
+ entityFqdn?: string;
24
+ packageName?: string;
25
+ };
26
+ type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
27
+
28
+ declare global {
29
+ // eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
30
+ interface SymbolConstructor {
31
+ readonly observable: symbol;
32
+ }
33
+ }
34
+
9
35
  interface SiteDocument$1 {
10
36
  /**
11
- * Results ID.
37
+ * Result ID.
12
38
  * @readonly
13
39
  */
14
40
  _id?: string;
15
- /** The docuement payload. */
41
+ /** The document payload. */
16
42
  data?: Record<string, any> | null;
17
43
  }
44
+ interface SearchRequest$1 {
45
+ /** Search query and aggregation information. */
46
+ search: Search;
47
+ /** Document type to search in. */
48
+ documentType: DocumentType;
49
+ /** Language to search in. */
50
+ language?: string | null;
51
+ }
18
52
  interface Search extends SearchPagingMethodOneOf {
19
53
  /** Paging options to limit and skip the number of items. */
20
54
  paging?: Paging;
@@ -32,12 +66,9 @@ interface Search extends SearchPagingMethodOneOf {
32
66
  * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
33
67
  */
34
68
  sort?: Sorting[];
35
- /**
36
- * A search method for grouping data into various categories (facets) and providing summaries for each category.
37
- * For example, use aggregations to allow site visitors to narrow down their search results by selecting specific categories such as price ranges, brand names, and ratings.
38
- */
69
+ /** A search method for grouping data into various categories (facets) and providing summaries for each category. For example, use aggregations to categorize search results by specific price ranges, brand names, or ratings. */
39
70
  aggregations?: Aggregation$1[];
40
- /** Free text to match in searchable fields. */
71
+ /** Search information. */
41
72
  search?: SearchDetails;
42
73
  }
43
74
  /** @oneof */
@@ -56,14 +87,11 @@ declare enum SortOrder {
56
87
  DESC = "DESC"
57
88
  }
58
89
  interface Aggregation$1 extends AggregationKindOneOf {
59
- /** A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number of products (count) for each price listed in the store. */
90
+ /** Pass if `type` is `VALUE`. A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number of products (count) for each price listed in the store. */
60
91
  value?: ValueAggregation;
61
- /** A scalar aggregation calculates a single numerical value from a dataset, such as the total sum, average, min, or max, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the minimum price listed in the store. */
92
+ /** Pass if `type` is `SCALAR`. A scalar aggregation calculates a single numerical value from a dataset, such as the tota, minimum, or maximum value, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the minimum price listed in a store. */
62
93
  scalar?: ScalarAggregation;
63
- /**
64
- * A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy.
65
- * For example, to get the number of products that are in stock and out of stock for each price listed, first perform a value aggregation on `discountedPriceNumeric`, and a second value aggregation on `inStock`.
66
- */
94
+ /** Pass if `type` is `NESTED`. A nested aggregation is applied to the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. This allows for more complex analyses that summarize data at different levels of detail or hierarchy. For example, to get the number of products that are in stock and out of stock for each price listed, first perform a value aggregation on the field containing the price, and a second value aggregation on the field indicating whether a product is in stock. You can nest up to a maximum of 3 aggregations. Each aggregation can be either value-based or scalar, allowing flexibility in how the data is grouped and analyzed. */
67
95
  nested?: NestedAggregation;
68
96
  /** Aggregation name displayed in the return. */
69
97
  name?: string | null;
@@ -74,23 +102,20 @@ interface Aggregation$1 extends AggregationKindOneOf {
74
102
  }
75
103
  /** @oneof */
76
104
  interface AggregationKindOneOf {
77
- /** A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number of products (count) for each price listed in the store. */
105
+ /** Pass if `type` is `VALUE`. A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number of products (count) for each price listed in the store. */
78
106
  value?: ValueAggregation;
79
- /** A scalar aggregation calculates a single numerical value from a dataset, such as the total sum, average, min, or max, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the minimum price listed in the store. */
107
+ /** Pass if `type` is `SCALAR`. A scalar aggregation calculates a single numerical value from a dataset, such as the tota, minimum, or maximum value, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the minimum price listed in a store. */
80
108
  scalar?: ScalarAggregation;
81
- /**
82
- * A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy.
83
- * For example, to get the number of products that are in stock and out of stock for each price listed, first perform a value aggregation on `discountedPriceNumeric`, and a second value aggregation on `inStock`.
84
- */
109
+ /** Pass if `type` is `NESTED`. A nested aggregation is applied to the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. This allows for more complex analyses that summarize data at different levels of detail or hierarchy. For example, to get the number of products that are in stock and out of stock for each price listed, first perform a value aggregation on the field containing the price, and a second value aggregation on the field indicating whether a product is in stock. You can nest up to a maximum of 3 aggregations. Each aggregation can be either value-based or scalar, allowing flexibility in how the data is grouped and analyzed. */
85
110
  nested?: NestedAggregation;
86
111
  }
87
112
  declare enum ScalarType {
88
113
  UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
89
- /** Minimum value */
114
+ /** Minimum value. */
90
115
  MIN = "MIN",
91
- /** Maximum value */
116
+ /** Maximum value. */
92
117
  MAX = "MAX",
93
- /** Sum of values */
118
+ /** Sum of values. */
94
119
  SUM = "SUM"
95
120
  }
96
121
  declare enum NestedAggregationType {
@@ -102,7 +127,7 @@ declare enum NestedAggregationType {
102
127
  }
103
128
  interface ValueAggregation {
104
129
  /**
105
- * Number of aggregation results to return.
130
+ * Maximum number of aggregation results to return.
106
131
  * Min: `1`
107
132
  * Max: `250`
108
133
  * Default: `10`
@@ -110,13 +135,13 @@ interface ValueAggregation {
110
135
  limit?: number | null;
111
136
  }
112
137
  interface ScalarAggregation {
113
- /** Operation type for the scalar aggregation. */
138
+ /** Type of scalar aggregation. */
114
139
  type?: ScalarType;
115
140
  }
116
141
  interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
117
- /** A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number of products (count) for each price listed in the store. */
142
+ /** Pass if `type` is `VALUE`. A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number of products (count) for each price listed in the store. */
118
143
  value?: ValueAggregation;
119
- /** A scalar aggregation calculates a single numerical value from a dataset, such as the total sum, average, min, or max, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the minimum price listed in the store. */
144
+ /** Pass if `type` is `SCALAR`. A scalar aggregation calculates a single numerical value from a dataset, such as the tota, minimum, or maximum value, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the minimum price listed in a store. */
120
145
  scalar?: ScalarAggregation;
121
146
  /** Aggregation name displayed in the return. */
122
147
  name?: string | null;
@@ -127,9 +152,9 @@ interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
127
152
  }
128
153
  /** @oneof */
129
154
  interface NestedAggregationItemKindOneOf {
130
- /** A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number of products (count) for each price listed in the store. */
155
+ /** Pass if `type` is `VALUE`. A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number of products (count) for each price listed in the store. */
131
156
  value?: ValueAggregation;
132
- /** A scalar aggregation calculates a single numerical value from a dataset, such as the total sum, average, min, or max, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the minimum price listed in the store. */
157
+ /** Pass if `type` is `SCALAR`. A scalar aggregation calculates a single numerical value from a dataset, such as the tota, minimum, or maximum value, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the minimum price listed in a store. */
133
158
  scalar?: ScalarAggregation;
134
159
  }
135
160
  declare enum AggregationType {
@@ -141,9 +166,9 @@ declare enum AggregationType {
141
166
  /** Multi-level aggregation, where each next aggregation is nested within previous one */
142
167
  NESTED = "NESTED"
143
168
  }
144
- /** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
169
+ /** List of aggregations. Each aggregation is nested within the previous one. */
145
170
  interface NestedAggregation {
146
- /** Flattened list of aggregations, where each aggregation is nested within previous one. */
171
+ /** List of aggregations, where each aggregation is nested within previous one. */
147
172
  nestedAggregations?: NestedAggregationItem[];
148
173
  }
149
174
  interface SearchDetails {
@@ -154,10 +179,7 @@ interface SearchDetails {
154
179
  * If the array is empty, all fields are searched.
155
180
  */
156
181
  fields?: string[];
157
- /**
158
- * Whether to allow the search function to automatically correct typos or minor mistakes in the search expression.
159
- * The search function uses an algorithm to find results that are close to what the site visitor typed.
160
- */
182
+ /** Whether to allow the search function to automatically correct typos or minor mistakes in the search expression. The search function uses an algorithm to find results that are close to the text provided. */
161
183
  fuzzy?: boolean;
162
184
  }
163
185
  interface Paging {
@@ -177,7 +199,7 @@ declare enum DocumentType {
177
199
  STORES_PRODUCTS = "STORES_PRODUCTS"
178
200
  }
179
201
  interface SearchResponse$1 extends SearchResponsePagingOneOf {
180
- /** Paging metadata for the next page of results. */
202
+ /** Paging metadata. */
181
203
  pagingOffsetMetadata?: PagingMetadata;
182
204
  /** Documents matching the search query. */
183
205
  siteDocumentItems?: SiteDocument$1[];
@@ -186,7 +208,7 @@ interface SearchResponse$1 extends SearchResponsePagingOneOf {
186
208
  }
187
209
  /** @oneof */
188
210
  interface SearchResponsePagingOneOf {
189
- /** Paging metadata for the next page of results. */
211
+ /** Paging metadata. */
190
212
  pagingOffsetMetadata?: PagingMetadata;
191
213
  }
192
214
  interface AggregationData {
@@ -194,24 +216,25 @@ interface AggregationData {
194
216
  results?: AggregationResults[];
195
217
  }
196
218
  interface ValueAggregationResult {
197
- /** Value of the field */
219
+ /** Value contained in the field specified in `fieldPath` for this aggregation in the request. */
198
220
  value?: string;
221
+ /** Number of documents containing the specified value in the specified field. */
199
222
  count?: number;
200
223
  }
201
224
  interface ValueResults {
202
- /** List of value aggregations */
225
+ /** List of value aggregation results. */
203
226
  results?: ValueAggregationResult[];
204
227
  }
205
228
  interface AggregationResultsScalarResult {
206
- /** Type of scalar aggregation */
229
+ /** Type of scalar aggregation. */
207
230
  type?: ScalarType;
208
- /** Value of the scalar aggregation */
231
+ /** Value of the scalar aggregation. For example, the minimum, maximum, or total value for the specified field. */
209
232
  value?: number;
210
233
  }
211
234
  interface ValueResult {
212
- /** Value of the field */
235
+ /** Value contained in the field specified in `fieldPath` for this aggregation in the request. */
213
236
  value?: string;
214
- /** Count of entities with this value */
237
+ /** Number of documents containing the specified value in the specified field. */
215
238
  count?: number | null;
216
239
  }
217
240
  interface ScalarResult {
@@ -232,7 +255,7 @@ interface NestedResultValueResultOneOf {
232
255
  scalar?: ScalarResult;
233
256
  }
234
257
  interface Results {
235
- /** List of nested aggregation results. */
258
+ /** Aggregation results. */
236
259
  results?: Record<string, NestedResultValue>;
237
260
  }
238
261
  /**
@@ -273,7 +296,7 @@ interface PagingMetadata {
273
296
  offset?: number | null;
274
297
  /** Total number of items that match the query. */
275
298
  total?: number | null;
276
- /** Flag that indicates the server failed to calculate the `total` field. */
299
+ /** Whether the server failed to calculate the `total` field. */
277
300
  tooManyToCount?: boolean | null;
278
301
  }
279
302
  interface SiteDocumentNonNullableFields {
@@ -309,43 +332,24 @@ interface SearchOptions$1 {
309
332
  language?: string | null;
310
333
  }
311
334
 
312
- type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
313
- interface HttpClient {
314
- request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
315
- fetchWithAuth: typeof fetch;
316
- wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
317
- }
318
- type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
319
- type HttpResponse<T = any> = {
320
- data: T;
321
- status: number;
322
- statusText: string;
323
- headers: any;
324
- request?: any;
325
- };
326
- type RequestOptions<_TResponse = any, Data = any> = {
327
- method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
328
- url: string;
329
- data?: Data;
330
- params?: URLSearchParams;
331
- } & APIMetadata;
332
- type APIMetadata = {
333
- methodFqn?: string;
334
- entityFqdn?: string;
335
- packageName?: string;
336
- };
337
- type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
338
-
339
- declare global {
340
- // eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
341
- interface SymbolConstructor {
342
- readonly observable: symbol;
343
- }
335
+ declare function search$3(httpClient: HttpClient): SearchSignature$1;
336
+ interface SearchSignature$1 {
337
+ /**
338
+ * Retrieves a list of site documents that match the provided search query and optionally performs aggregations on the data queried.
339
+ *
340
+ * The Search API supports the document types listed in the [Introduction](https://dev.wix.com/docs/rest/business-management/search/wix-site-search/introduction), each with its own schema. These schemas define the fields available for filtering, sorting, and free-text searching.
341
+ *
342
+ * To learn more about working with the search query, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
343
+ * @param - Search query and aggregation information.
344
+ * @param - Document type to search in.
345
+ */
346
+ (search: Search, documentType: DocumentType, options?: SearchOptions$1 | undefined): Promise<SearchResponse$1 & SearchResponseNonNullableFields$1>;
344
347
  }
345
348
 
346
349
  declare function createRESTModule$1<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
347
350
 
348
- declare const search$1: ReturnType<typeof createRESTModule$1<typeof publicSearch>>;
351
+ type _publicSearchType$1 = typeof search$3;
352
+ declare const search$2: ReturnType<typeof createRESTModule$1<_publicSearchType>>;
349
353
 
350
354
  type context$1_AggregationData = AggregationData;
351
355
  type context$1_AggregationKindOneOf = AggregationKindOneOf;
@@ -383,7 +387,7 @@ type context$1_ValueAggregationResult = ValueAggregationResult;
383
387
  type context$1_ValueResult = ValueResult;
384
388
  type context$1_ValueResults = ValueResults;
385
389
  declare namespace context$1 {
386
- export { type Aggregation$1 as Aggregation, type context$1_AggregationData as AggregationData, type context$1_AggregationKindOneOf as AggregationKindOneOf, type context$1_AggregationResults as AggregationResults, type context$1_AggregationResultsResultOneOf as AggregationResultsResultOneOf, type context$1_AggregationResultsScalarResult as AggregationResultsScalarResult, context$1_AggregationType as AggregationType, context$1_DocumentType as DocumentType, type context$1_NestedAggregation as NestedAggregation, type context$1_NestedAggregationItem as NestedAggregationItem, type context$1_NestedAggregationItemKindOneOf as NestedAggregationItemKindOneOf, context$1_NestedAggregationType as NestedAggregationType, type context$1_NestedResultValue as NestedResultValue, type context$1_NestedResultValueResultOneOf as NestedResultValueResultOneOf, type context$1_NestedResults as NestedResults, type context$1_Paging as Paging, type context$1_PagingMetadata as PagingMetadata, type context$1_Results as Results, type context$1_ScalarAggregation as ScalarAggregation, type context$1_ScalarResult as ScalarResult, context$1_ScalarType as ScalarType, type context$1_Search as Search, type context$1_SearchDetails as SearchDetails, type SearchOptions$1 as SearchOptions, type context$1_SearchPagingMethodOneOf as SearchPagingMethodOneOf, type SearchRequest$1 as SearchRequest, type SearchResponse$1 as SearchResponse, type SearchResponseNonNullableFields$1 as SearchResponseNonNullableFields, type context$1_SearchResponsePagingOneOf as SearchResponsePagingOneOf, type SiteDocument$1 as SiteDocument, context$1_SortOrder as SortOrder, type context$1_Sorting as Sorting, type context$1_ValueAggregation as ValueAggregation, type context$1_ValueAggregationResult as ValueAggregationResult, type context$1_ValueResult as ValueResult, type context$1_ValueResults as ValueResults, search$1 as search };
390
+ export { type Aggregation$1 as Aggregation, type context$1_AggregationData as AggregationData, type context$1_AggregationKindOneOf as AggregationKindOneOf, type context$1_AggregationResults as AggregationResults, type context$1_AggregationResultsResultOneOf as AggregationResultsResultOneOf, type context$1_AggregationResultsScalarResult as AggregationResultsScalarResult, context$1_AggregationType as AggregationType, context$1_DocumentType as DocumentType, type context$1_NestedAggregation as NestedAggregation, type context$1_NestedAggregationItem as NestedAggregationItem, type context$1_NestedAggregationItemKindOneOf as NestedAggregationItemKindOneOf, context$1_NestedAggregationType as NestedAggregationType, type context$1_NestedResultValue as NestedResultValue, type context$1_NestedResultValueResultOneOf as NestedResultValueResultOneOf, type context$1_NestedResults as NestedResults, type context$1_Paging as Paging, type context$1_PagingMetadata as PagingMetadata, type context$1_Results as Results, type context$1_ScalarAggregation as ScalarAggregation, type context$1_ScalarResult as ScalarResult, context$1_ScalarType as ScalarType, type context$1_Search as Search, type context$1_SearchDetails as SearchDetails, type SearchOptions$1 as SearchOptions, type context$1_SearchPagingMethodOneOf as SearchPagingMethodOneOf, type SearchRequest$1 as SearchRequest, type SearchResponse$1 as SearchResponse, type SearchResponseNonNullableFields$1 as SearchResponseNonNullableFields, type context$1_SearchResponsePagingOneOf as SearchResponsePagingOneOf, type SiteDocument$1 as SiteDocument, context$1_SortOrder as SortOrder, type context$1_Sorting as Sorting, type context$1_ValueAggregation as ValueAggregation, type context$1_ValueAggregationResult as ValueAggregationResult, type context$1_ValueResult as ValueResult, type context$1_ValueResults as ValueResults, type _publicSearchType$1 as _publicSearchType, search$2 as search };
387
391
  }
388
392
 
389
393
  /** API is not yet fully migrated to FQDN entity */
@@ -1188,16 +1192,87 @@ interface TrendingOptions {
1188
1192
  includeSeoHidden?: boolean | null;
1189
1193
  }
1190
1194
 
1195
+ declare function search$1(httpClient: HttpClient): SearchSignature;
1196
+ interface SearchSignature {
1197
+ /**
1198
+ * Executes a regular search query.
1199
+ * If you are unsure, this is likely the search method you want to used.
1200
+ */
1201
+ (options?: SearchOptions | undefined): Promise<SearchResponse & SearchResponseNonNullableFields>;
1202
+ }
1203
+ declare function federatedSearch$1(httpClient: HttpClient): FederatedSearchSignature;
1204
+ interface FederatedSearchSignature {
1205
+ /**
1206
+ * Searches in multiple document types at once.
1207
+ */
1208
+ (options?: FederatedSearchOptions | undefined): Promise<FederatedSearchResponse & FederatedSearchResponseNonNullableFields>;
1209
+ }
1210
+ declare function suggest$1(httpClient: HttpClient): SuggestSignature;
1211
+ interface SuggestSignature {
1212
+ /**
1213
+ * Executes search query to fetch suggested items. Unlike search query suggest will match
1214
+ * partial phrases (for example "blu" will match documents containing "blue", "blues" and "blunt").
1215
+ * Phrase needs to be at least 3 symbols long. Suggestions can also perform optimisations in search
1216
+ * results and generally do not guarantee the same level of quality as regular Search endpoint.
1217
+ */
1218
+ (options?: SuggestOptions | undefined): Promise<SuggestResponse>;
1219
+ }
1220
+ declare function federatedSuggest$1(httpClient: HttpClient): FederatedSuggestSignature;
1221
+ interface FederatedSuggestSignature {
1222
+ /**
1223
+ * Searches for suggestions in multiple document types at once.
1224
+ */
1225
+ (options?: FederatedSuggestOptions | undefined): Promise<FederatedSuggestResponse>;
1226
+ }
1227
+ declare function related$1(httpClient: HttpClient): RelatedSignature;
1228
+ interface RelatedSignature {
1229
+ /**
1230
+ * Fetches documents similar to one single document.
1231
+ * This is typically used to implement "related to" scenarios (for example to fetch related store products when
1232
+ * consumer is already viewing one).
1233
+ */
1234
+ (options?: RelatedOptions | undefined): Promise<RelatedResponse>;
1235
+ }
1236
+ declare function autocomplete$1(httpClient: HttpClient): AutocompleteSignature;
1237
+ interface AutocompleteSignature {
1238
+ /**
1239
+ * 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.
1240
+ */
1241
+ (options?: AutocompleteOptions | undefined): Promise<AutocompleteResponse & AutocompleteResponseNonNullableFields>;
1242
+ }
1243
+ declare function federatedAutocomplete$1(httpClient: HttpClient): FederatedAutocompleteSignature;
1244
+ interface FederatedAutocompleteSignature {
1245
+ /**
1246
+ * Provides phrase completion from multiple document types at once
1247
+ */
1248
+ (options?: FederatedAutocompleteOptions | undefined): Promise<FederatedAutocompleteResponse & FederatedAutocompleteResponseNonNullableFields>;
1249
+ }
1250
+ declare function trending$1(httpClient: HttpClient): TrendingSignature;
1251
+ interface TrendingSignature {
1252
+ /**
1253
+ * Returns trending documents for given document types
1254
+ */
1255
+ (options?: TrendingOptions | undefined): Promise<TrendingResponse & TrendingResponseNonNullableFields>;
1256
+ }
1257
+
1191
1258
  declare function createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
1192
1259
 
1193
- declare const search: ReturnType<typeof createRESTModule<typeof publicSearch>>;
1194
- declare const federatedSearch: ReturnType<typeof createRESTModule<typeof publicFederatedSearch>>;
1195
- declare const suggest: ReturnType<typeof createRESTModule<typeof publicSuggest>>;
1196
- declare const federatedSuggest: ReturnType<typeof createRESTModule<typeof publicFederatedSuggest>>;
1197
- declare const related: ReturnType<typeof createRESTModule<typeof publicRelated>>;
1198
- declare const autocomplete: ReturnType<typeof createRESTModule<typeof publicAutocomplete>>;
1199
- declare const federatedAutocomplete: ReturnType<typeof createRESTModule<typeof publicFederatedAutocomplete>>;
1200
- declare const trending: ReturnType<typeof createRESTModule<typeof publicTrending>>;
1260
+ type _publicSearchType = typeof search$1;
1261
+ declare const search: ReturnType<typeof createRESTModule<_publicSearchType>>;
1262
+ type _publicFederatedSearchType = typeof federatedSearch$1;
1263
+ declare const federatedSearch: ReturnType<typeof createRESTModule<_publicFederatedSearchType>>;
1264
+ type _publicSuggestType = typeof suggest$1;
1265
+ declare const suggest: ReturnType<typeof createRESTModule<_publicSuggestType>>;
1266
+ type _publicFederatedSuggestType = typeof federatedSuggest$1;
1267
+ declare const federatedSuggest: ReturnType<typeof createRESTModule<_publicFederatedSuggestType>>;
1268
+ type _publicRelatedType = typeof related$1;
1269
+ declare const related: ReturnType<typeof createRESTModule<_publicRelatedType>>;
1270
+ type _publicAutocompleteType = typeof autocomplete$1;
1271
+ declare const autocomplete: ReturnType<typeof createRESTModule<_publicAutocompleteType>>;
1272
+ type _publicFederatedAutocompleteType = typeof federatedAutocomplete$1;
1273
+ declare const federatedAutocomplete: ReturnType<typeof createRESTModule<_publicFederatedAutocompleteType>>;
1274
+ type _publicTrendingType = typeof trending$1;
1275
+ declare const trending: ReturnType<typeof createRESTModule<_publicTrendingType>>;
1201
1276
 
1202
1277
  type context_Aggregation = Aggregation;
1203
1278
  declare const context_Aggregation: typeof Aggregation;
@@ -1291,6 +1366,14 @@ type context_VersioningMode = VersioningMode;
1291
1366
  declare const context_VersioningMode: typeof VersioningMode;
1292
1367
  type context_WebhookIdentityType = WebhookIdentityType;
1293
1368
  declare const context_WebhookIdentityType: typeof WebhookIdentityType;
1369
+ type context__publicAutocompleteType = _publicAutocompleteType;
1370
+ type context__publicFederatedAutocompleteType = _publicFederatedAutocompleteType;
1371
+ type context__publicFederatedSearchType = _publicFederatedSearchType;
1372
+ type context__publicFederatedSuggestType = _publicFederatedSuggestType;
1373
+ type context__publicRelatedType = _publicRelatedType;
1374
+ type context__publicSearchType = _publicSearchType;
1375
+ type context__publicSuggestType = _publicSuggestType;
1376
+ type context__publicTrendingType = _publicTrendingType;
1294
1377
  declare const context_autocomplete: typeof autocomplete;
1295
1378
  declare const context_federatedAutocomplete: typeof federatedAutocomplete;
1296
1379
  declare const context_federatedSearch: typeof federatedSearch;
@@ -1300,7 +1383,7 @@ declare const context_search: typeof search;
1300
1383
  declare const context_suggest: typeof suggest;
1301
1384
  declare const context_trending: typeof trending;
1302
1385
  declare namespace context {
1303
- export { context_Aggregation as Aggregation, type context_AggregationFacet as AggregationFacet, type context_AutocompleteOptions as AutocompleteOptions, type context_AutocompleteRequest as AutocompleteRequest, type context_AutocompleteResponse as AutocompleteResponse, type context_AutocompleteResponseNonNullableFields as AutocompleteResponseNonNullableFields, type context_AutocompleteResponseValue as AutocompleteResponseValue, type context_DeleteByFilterOperation as DeleteByFilterOperation, type context_DeleteByIdsOperation as DeleteByIdsOperation, context_Direction as Direction, type context_DocumentImage as DocumentImage, type context_DocumentPayload as DocumentPayload, type context_DocumentUpdateOperation as DocumentUpdateOperation, type context_Empty as Empty, context_Enum as Enum, type context_FacetClause as FacetClause, type context_FacetClauseClauseOneOf as FacetClauseClauseOneOf, type context_FacetClauses as FacetClauses, type context_FacetCountResponse as FacetCountResponse, type context_FacetsResponse as FacetsResponse, type context_FacetsResponseResponseOneOf as FacetsResponseResponseOneOf, type context_FederatedAutocompleteOptions as FederatedAutocompleteOptions, type context_FederatedAutocompleteRequest as FederatedAutocompleteRequest, type context_FederatedAutocompleteResponse as FederatedAutocompleteResponse, type context_FederatedAutocompleteResponseNonNullableFields as FederatedAutocompleteResponseNonNullableFields, type context_FederatedAutocompleteResults as FederatedAutocompleteResults, type context_FederatedSearchDocuments as FederatedSearchDocuments, type context_FederatedSearchOptions as FederatedSearchOptions, type context_FederatedSearchRequest as FederatedSearchRequest, type context_FederatedSearchResponse as FederatedSearchResponse, type context_FederatedSearchResponseNonNullableFields as FederatedSearchResponseNonNullableFields, type context_FederatedSuggestDocuments as FederatedSuggestDocuments, type context_FederatedSuggestOptions as FederatedSuggestOptions, type context_FederatedSuggestRequest as FederatedSuggestRequest, type context_FederatedSuggestResponse as FederatedSuggestResponse, type context_HierarchicalAggregationResponse as HierarchicalAggregationResponse, type context_HierarchicalFacet as HierarchicalFacet, type context_HierarchicalFacetClauseOneOf as HierarchicalFacetClauseOneOf, type context_IdentificationData as IdentificationData, type context_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type context_IndexDocument as IndexDocument, type context_InternalDocument as InternalDocument, type context_InternalDocumentUpdateByFilterOperation as InternalDocumentUpdateByFilterOperation, type context_InternalDocumentUpdateOperation as InternalDocumentUpdateOperation, type context_InternalUpdateExistingOperation as InternalUpdateExistingOperation, type context_MaxAggregationResponse as MaxAggregationResponse, type context_MessageEnvelope as MessageEnvelope, type context_MinAggregationResponse as MinAggregationResponse, type context_MinMaxAggregationResponse as MinMaxAggregationResponse, type context_NextPageResponse as NextPageResponse, type context_OrderingClause as OrderingClause, type context_OrderingClauses as OrderingClauses, type context_RelatedOptions as RelatedOptions, type context_RelatedRequest as RelatedRequest, type context_RelatedResponse as RelatedResponse, type context_SearchOptions as SearchOptions, type context_SearchPaging as SearchPaging, type context_SearchProperty as SearchProperty, type context_SearchRequest as SearchRequest, type context_SearchResponse as SearchResponse, type context_SearchResponseNonNullableFields as SearchResponseNonNullableFields, type context_SiteDocument as SiteDocument, type context_SuggestOptions as SuggestOptions, type context_SuggestRequest as SuggestRequest, type context_SuggestResponse as SuggestResponse, type context_SumAggregationResponse as SumAggregationResponse, type context_TermAggregationResponse as TermAggregationResponse, type context_TermFacet as TermFacet, type context_TrendingItems as TrendingItems, type context_TrendingOptions as TrendingOptions, type context_TrendingRequest as TrendingRequest, type context_TrendingResponse as TrendingResponse, type context_TrendingResponseNonNullableFields as TrendingResponseNonNullableFields, type context_UpdateByFilterOperation as UpdateByFilterOperation, type context_UpdateDocumentsEvent as UpdateDocumentsEvent, type context_UpdateDocumentsEventOperationOneOf as UpdateDocumentsEventOperationOneOf, type context_UpdateExistingOperation as UpdateExistingOperation, type context_UpdateInternalDocumentsEvent as UpdateInternalDocumentsEvent, type context_UpdateInternalDocumentsEventOperationOneOf as UpdateInternalDocumentsEventOperationOneOf, type context_V1DeleteByFilterOperation as V1DeleteByFilterOperation, type context_V1DeleteByIdsOperation as V1DeleteByIdsOperation, type context_Value as Value, type context_VersionedDeleteByIdsOperation as VersionedDeleteByIdsOperation, type context_VersionedDocumentId as VersionedDocumentId, type context_VersionedDocumentUpdateOperation as VersionedDocumentUpdateOperation, context_VersioningMode as VersioningMode, context_WebhookIdentityType as WebhookIdentityType, context_autocomplete as autocomplete, context_federatedAutocomplete as federatedAutocomplete, context_federatedSearch as federatedSearch, context_federatedSuggest as federatedSuggest, context_related as related, context_search as search, context_suggest as suggest, context_trending as trending };
1386
+ export { context_Aggregation as Aggregation, type context_AggregationFacet as AggregationFacet, type context_AutocompleteOptions as AutocompleteOptions, type context_AutocompleteRequest as AutocompleteRequest, type context_AutocompleteResponse as AutocompleteResponse, type context_AutocompleteResponseNonNullableFields as AutocompleteResponseNonNullableFields, type context_AutocompleteResponseValue as AutocompleteResponseValue, type context_DeleteByFilterOperation as DeleteByFilterOperation, type context_DeleteByIdsOperation as DeleteByIdsOperation, context_Direction as Direction, type context_DocumentImage as DocumentImage, type context_DocumentPayload as DocumentPayload, type context_DocumentUpdateOperation as DocumentUpdateOperation, type context_Empty as Empty, context_Enum as Enum, type context_FacetClause as FacetClause, type context_FacetClauseClauseOneOf as FacetClauseClauseOneOf, type context_FacetClauses as FacetClauses, type context_FacetCountResponse as FacetCountResponse, type context_FacetsResponse as FacetsResponse, type context_FacetsResponseResponseOneOf as FacetsResponseResponseOneOf, type context_FederatedAutocompleteOptions as FederatedAutocompleteOptions, type context_FederatedAutocompleteRequest as FederatedAutocompleteRequest, type context_FederatedAutocompleteResponse as FederatedAutocompleteResponse, type context_FederatedAutocompleteResponseNonNullableFields as FederatedAutocompleteResponseNonNullableFields, type context_FederatedAutocompleteResults as FederatedAutocompleteResults, type context_FederatedSearchDocuments as FederatedSearchDocuments, type context_FederatedSearchOptions as FederatedSearchOptions, type context_FederatedSearchRequest as FederatedSearchRequest, type context_FederatedSearchResponse as FederatedSearchResponse, type context_FederatedSearchResponseNonNullableFields as FederatedSearchResponseNonNullableFields, type context_FederatedSuggestDocuments as FederatedSuggestDocuments, type context_FederatedSuggestOptions as FederatedSuggestOptions, type context_FederatedSuggestRequest as FederatedSuggestRequest, type context_FederatedSuggestResponse as FederatedSuggestResponse, type context_HierarchicalAggregationResponse as HierarchicalAggregationResponse, type context_HierarchicalFacet as HierarchicalFacet, type context_HierarchicalFacetClauseOneOf as HierarchicalFacetClauseOneOf, type context_IdentificationData as IdentificationData, type context_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type context_IndexDocument as IndexDocument, type context_InternalDocument as InternalDocument, type context_InternalDocumentUpdateByFilterOperation as InternalDocumentUpdateByFilterOperation, type context_InternalDocumentUpdateOperation as InternalDocumentUpdateOperation, type context_InternalUpdateExistingOperation as InternalUpdateExistingOperation, type context_MaxAggregationResponse as MaxAggregationResponse, type context_MessageEnvelope as MessageEnvelope, type context_MinAggregationResponse as MinAggregationResponse, type context_MinMaxAggregationResponse as MinMaxAggregationResponse, type context_NextPageResponse as NextPageResponse, type context_OrderingClause as OrderingClause, type context_OrderingClauses as OrderingClauses, type context_RelatedOptions as RelatedOptions, type context_RelatedRequest as RelatedRequest, type context_RelatedResponse as RelatedResponse, type context_SearchOptions as SearchOptions, type context_SearchPaging as SearchPaging, type context_SearchProperty as SearchProperty, type context_SearchRequest as SearchRequest, type context_SearchResponse as SearchResponse, type context_SearchResponseNonNullableFields as SearchResponseNonNullableFields, type context_SiteDocument as SiteDocument, type context_SuggestOptions as SuggestOptions, type context_SuggestRequest as SuggestRequest, type context_SuggestResponse as SuggestResponse, type context_SumAggregationResponse as SumAggregationResponse, type context_TermAggregationResponse as TermAggregationResponse, type context_TermFacet as TermFacet, type context_TrendingItems as TrendingItems, type context_TrendingOptions as TrendingOptions, type context_TrendingRequest as TrendingRequest, type context_TrendingResponse as TrendingResponse, type context_TrendingResponseNonNullableFields as TrendingResponseNonNullableFields, type context_UpdateByFilterOperation as UpdateByFilterOperation, type context_UpdateDocumentsEvent as UpdateDocumentsEvent, type context_UpdateDocumentsEventOperationOneOf as UpdateDocumentsEventOperationOneOf, type context_UpdateExistingOperation as UpdateExistingOperation, type context_UpdateInternalDocumentsEvent as UpdateInternalDocumentsEvent, type context_UpdateInternalDocumentsEventOperationOneOf as UpdateInternalDocumentsEventOperationOneOf, type context_V1DeleteByFilterOperation as V1DeleteByFilterOperation, type context_V1DeleteByIdsOperation as V1DeleteByIdsOperation, type context_Value as Value, type context_VersionedDeleteByIdsOperation as VersionedDeleteByIdsOperation, type context_VersionedDocumentId as VersionedDocumentId, type context_VersionedDocumentUpdateOperation as VersionedDocumentUpdateOperation, context_VersioningMode as VersioningMode, context_WebhookIdentityType as WebhookIdentityType, type context__publicAutocompleteType as _publicAutocompleteType, type context__publicFederatedAutocompleteType as _publicFederatedAutocompleteType, type context__publicFederatedSearchType as _publicFederatedSearchType, type context__publicFederatedSuggestType as _publicFederatedSuggestType, type context__publicRelatedType as _publicRelatedType, type context__publicSearchType as _publicSearchType, type context__publicSuggestType as _publicSuggestType, type context__publicTrendingType as _publicTrendingType, context_autocomplete as autocomplete, context_federatedAutocomplete as federatedAutocomplete, context_federatedSearch as federatedSearch, context_federatedSuggest as federatedSuggest, context_related as related, context_search as search, context_suggest as suggest, context_trending as trending };
1304
1387
  }
1305
1388
 
1306
1389
  export { context as siteSearch, context$1 as wixSiteSearch };