@wix/search 1.0.48 → 1.0.50
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/build/cjs/index.d.ts +2 -2
- package/build/cjs/index.js +2 -2
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/meta.d.ts +2 -2
- package/build/cjs/meta.js +2 -2
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.ts +2 -2
- package/build/es/index.js +2 -2
- package/build/es/index.js.map +1 -1
- package/build/es/meta.d.ts +2 -2
- package/build/es/meta.js +2 -2
- package/build/es/meta.js.map +1 -1
- package/build/es/package.json +3 -0
- package/build/internal/cjs/index.d.ts +3 -0
- package/build/internal/cjs/index.js +31 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +2 -0
- package/build/{cjs/context.js → internal/cjs/meta.js} +3 -3
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/es/index.d.ts +3 -0
- package/build/internal/es/index.js +4 -0
- package/build/internal/es/index.js.map +1 -0
- package/build/internal/es/meta.d.ts +2 -0
- package/build/internal/es/meta.js +3 -0
- package/build/internal/es/meta.js.map +1 -0
- package/meta/package.json +1 -5
- package/package.json +24 -18
- package/build/cjs/context.d.ts +0 -2
- package/build/cjs/context.js.map +0 -1
- package/build/es/context.d.ts +0 -2
- package/build/es/context.js +0 -3
- package/build/es/context.js.map +0 -1
- package/context/package.json +0 -7
- package/type-bundles/context.bundle.d.ts +0 -1828
- package/type-bundles/index.bundle.d.ts +0 -1828
- package/type-bundles/meta.bundle.d.ts +0 -1491
|
@@ -1,1828 +0,0 @@
|
|
|
1
|
-
type HostModule<T, H extends Host> = {
|
|
2
|
-
__type: 'host';
|
|
3
|
-
create(host: H): T;
|
|
4
|
-
};
|
|
5
|
-
type HostModuleAPI<T extends HostModule<any, any>> = T extends HostModule<infer U, any> ? U : never;
|
|
6
|
-
type Host<Environment = unknown> = {
|
|
7
|
-
channel: {
|
|
8
|
-
observeState(callback: (props: unknown, environment: Environment) => unknown): {
|
|
9
|
-
disconnect: () => void;
|
|
10
|
-
} | Promise<{
|
|
11
|
-
disconnect: () => void;
|
|
12
|
-
}>;
|
|
13
|
-
};
|
|
14
|
-
environment?: Environment;
|
|
15
|
-
/**
|
|
16
|
-
* Optional name of the environment, use for logging
|
|
17
|
-
*/
|
|
18
|
-
name?: string;
|
|
19
|
-
/**
|
|
20
|
-
* Optional bast url to use for API requests, for example `www.wixapis.com`
|
|
21
|
-
*/
|
|
22
|
-
apiBaseUrl?: string;
|
|
23
|
-
/**
|
|
24
|
-
* Possible data to be provided by every host, for cross cutting concerns
|
|
25
|
-
* like internationalization, billing, etc.
|
|
26
|
-
*/
|
|
27
|
-
essentials?: {
|
|
28
|
-
/**
|
|
29
|
-
* The language of the currently viewed session
|
|
30
|
-
*/
|
|
31
|
-
language?: string;
|
|
32
|
-
/**
|
|
33
|
-
* The locale of the currently viewed session
|
|
34
|
-
*/
|
|
35
|
-
locale?: string;
|
|
36
|
-
/**
|
|
37
|
-
* Any headers that should be passed through to the API requests
|
|
38
|
-
*/
|
|
39
|
-
passThroughHeaders?: Record<string, string>;
|
|
40
|
-
};
|
|
41
|
-
};
|
|
42
|
-
|
|
43
|
-
type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
|
|
44
|
-
interface HttpClient {
|
|
45
|
-
request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
|
|
46
|
-
fetchWithAuth: typeof fetch;
|
|
47
|
-
wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
|
|
48
|
-
getActiveToken?: () => string | undefined;
|
|
49
|
-
}
|
|
50
|
-
type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
|
|
51
|
-
type HttpResponse<T = any> = {
|
|
52
|
-
data: T;
|
|
53
|
-
status: number;
|
|
54
|
-
statusText: string;
|
|
55
|
-
headers: any;
|
|
56
|
-
request?: any;
|
|
57
|
-
};
|
|
58
|
-
type RequestOptions<_TResponse = any, Data = any> = {
|
|
59
|
-
method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
|
|
60
|
-
url: string;
|
|
61
|
-
data?: Data;
|
|
62
|
-
params?: URLSearchParams;
|
|
63
|
-
} & APIMetadata;
|
|
64
|
-
type APIMetadata = {
|
|
65
|
-
methodFqn?: string;
|
|
66
|
-
entityFqdn?: string;
|
|
67
|
-
packageName?: string;
|
|
68
|
-
};
|
|
69
|
-
type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
|
|
70
|
-
type EventDefinition<Payload = unknown, Type extends string = string> = {
|
|
71
|
-
__type: 'event-definition';
|
|
72
|
-
type: Type;
|
|
73
|
-
isDomainEvent?: boolean;
|
|
74
|
-
transformations?: (envelope: unknown) => Payload;
|
|
75
|
-
__payload: Payload;
|
|
76
|
-
};
|
|
77
|
-
declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
|
|
78
|
-
type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
|
|
79
|
-
type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
|
|
80
|
-
|
|
81
|
-
type ServicePluginMethodInput = {
|
|
82
|
-
request: any;
|
|
83
|
-
metadata: any;
|
|
84
|
-
};
|
|
85
|
-
type ServicePluginContract = Record<string, (payload: ServicePluginMethodInput) => unknown | Promise<unknown>>;
|
|
86
|
-
type ServicePluginMethodMetadata = {
|
|
87
|
-
name: string;
|
|
88
|
-
primaryHttpMappingPath: string;
|
|
89
|
-
transformations: {
|
|
90
|
-
fromREST: (...args: unknown[]) => ServicePluginMethodInput;
|
|
91
|
-
toREST: (...args: unknown[]) => unknown;
|
|
92
|
-
};
|
|
93
|
-
};
|
|
94
|
-
type ServicePluginDefinition<Contract extends ServicePluginContract> = {
|
|
95
|
-
__type: 'service-plugin-definition';
|
|
96
|
-
componentType: string;
|
|
97
|
-
methods: ServicePluginMethodMetadata[];
|
|
98
|
-
__contract: Contract;
|
|
99
|
-
};
|
|
100
|
-
declare function ServicePluginDefinition<Contract extends ServicePluginContract>(componentType: string, methods: ServicePluginMethodMetadata[]): ServicePluginDefinition<Contract>;
|
|
101
|
-
type BuildServicePluginDefinition<T extends ServicePluginDefinition<any>> = (implementation: T['__contract']) => void;
|
|
102
|
-
declare const SERVICE_PLUGIN_ERROR_TYPE = "wix_spi_error";
|
|
103
|
-
|
|
104
|
-
type RequestContext = {
|
|
105
|
-
isSSR: boolean;
|
|
106
|
-
host: string;
|
|
107
|
-
protocol?: string;
|
|
108
|
-
};
|
|
109
|
-
type ResponseTransformer = (data: any, headers?: any) => any;
|
|
110
|
-
/**
|
|
111
|
-
* Ambassador request options types are copied mostly from AxiosRequestConfig.
|
|
112
|
-
* They are copied and not imported to reduce the amount of dependencies (to reduce install time).
|
|
113
|
-
* https://github.com/axios/axios/blob/3f53eb6960f05a1f88409c4b731a40de595cb825/index.d.ts#L307-L315
|
|
114
|
-
*/
|
|
115
|
-
type Method = 'get' | 'GET' | 'delete' | 'DELETE' | 'head' | 'HEAD' | 'options' | 'OPTIONS' | 'post' | 'POST' | 'put' | 'PUT' | 'patch' | 'PATCH' | 'purge' | 'PURGE' | 'link' | 'LINK' | 'unlink' | 'UNLINK';
|
|
116
|
-
type AmbassadorRequestOptions<T = any> = {
|
|
117
|
-
_?: T;
|
|
118
|
-
url?: string;
|
|
119
|
-
method?: Method;
|
|
120
|
-
params?: any;
|
|
121
|
-
data?: any;
|
|
122
|
-
transformResponse?: ResponseTransformer | ResponseTransformer[];
|
|
123
|
-
};
|
|
124
|
-
type AmbassadorFactory<Request, Response> = (payload: Request) => ((context: RequestContext) => AmbassadorRequestOptions<Response>) & {
|
|
125
|
-
__isAmbassador: boolean;
|
|
126
|
-
};
|
|
127
|
-
type AmbassadorFunctionDescriptor<Request = any, Response = any> = AmbassadorFactory<Request, Response>;
|
|
128
|
-
type BuildAmbassadorFunction<T extends AmbassadorFunctionDescriptor> = T extends AmbassadorFunctionDescriptor<infer Request, infer Response> ? (req: Request) => Promise<Response> : never;
|
|
129
|
-
|
|
130
|
-
declare global {
|
|
131
|
-
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
|
|
132
|
-
interface SymbolConstructor {
|
|
133
|
-
readonly observable: symbol;
|
|
134
|
-
}
|
|
135
|
-
}
|
|
136
|
-
|
|
137
|
-
declare const emptyObjectSymbol: unique symbol;
|
|
138
|
-
|
|
139
|
-
/**
|
|
140
|
-
Represents a strictly empty plain object, the `{}` value.
|
|
141
|
-
|
|
142
|
-
When you annotate something as the type `{}`, it can be anything except `null` and `undefined`. This means that you cannot use `{}` to represent an empty plain object ([read more](https://stackoverflow.com/questions/47339869/typescript-empty-object-and-any-difference/52193484#52193484)).
|
|
143
|
-
|
|
144
|
-
@example
|
|
145
|
-
```
|
|
146
|
-
import type {EmptyObject} from 'type-fest';
|
|
147
|
-
|
|
148
|
-
// The following illustrates the problem with `{}`.
|
|
149
|
-
const foo1: {} = {}; // Pass
|
|
150
|
-
const foo2: {} = []; // Pass
|
|
151
|
-
const foo3: {} = 42; // Pass
|
|
152
|
-
const foo4: {} = {a: 1}; // Pass
|
|
153
|
-
|
|
154
|
-
// With `EmptyObject` only the first case is valid.
|
|
155
|
-
const bar1: EmptyObject = {}; // Pass
|
|
156
|
-
const bar2: EmptyObject = 42; // Fail
|
|
157
|
-
const bar3: EmptyObject = []; // Fail
|
|
158
|
-
const bar4: EmptyObject = {a: 1}; // Fail
|
|
159
|
-
```
|
|
160
|
-
|
|
161
|
-
Unfortunately, `Record<string, never>`, `Record<keyof any, never>` and `Record<never, never>` do not work. See {@link https://github.com/sindresorhus/type-fest/issues/395 #395}.
|
|
162
|
-
|
|
163
|
-
@category Object
|
|
164
|
-
*/
|
|
165
|
-
type EmptyObject = {[emptyObjectSymbol]?: never};
|
|
166
|
-
|
|
167
|
-
/**
|
|
168
|
-
Returns a boolean for whether the two given types are equal.
|
|
169
|
-
|
|
170
|
-
@link https://github.com/microsoft/TypeScript/issues/27024#issuecomment-421529650
|
|
171
|
-
@link https://stackoverflow.com/questions/68961864/how-does-the-equals-work-in-typescript/68963796#68963796
|
|
172
|
-
|
|
173
|
-
Use-cases:
|
|
174
|
-
- If you want to make a conditional branch based on the result of a comparison of two types.
|
|
175
|
-
|
|
176
|
-
@example
|
|
177
|
-
```
|
|
178
|
-
import type {IsEqual} from 'type-fest';
|
|
179
|
-
|
|
180
|
-
// This type returns a boolean for whether the given array includes the given item.
|
|
181
|
-
// `IsEqual` is used to compare the given array at position 0 and the given item and then return true if they are equal.
|
|
182
|
-
type Includes<Value extends readonly any[], Item> =
|
|
183
|
-
Value extends readonly [Value[0], ...infer rest]
|
|
184
|
-
? IsEqual<Value[0], Item> extends true
|
|
185
|
-
? true
|
|
186
|
-
: Includes<rest, Item>
|
|
187
|
-
: false;
|
|
188
|
-
```
|
|
189
|
-
|
|
190
|
-
@category Type Guard
|
|
191
|
-
@category Utilities
|
|
192
|
-
*/
|
|
193
|
-
type IsEqual<A, B> =
|
|
194
|
-
(<G>() => G extends A ? 1 : 2) extends
|
|
195
|
-
(<G>() => G extends B ? 1 : 2)
|
|
196
|
-
? true
|
|
197
|
-
: false;
|
|
198
|
-
|
|
199
|
-
/**
|
|
200
|
-
Filter out keys from an object.
|
|
201
|
-
|
|
202
|
-
Returns `never` if `Exclude` is strictly equal to `Key`.
|
|
203
|
-
Returns `never` if `Key` extends `Exclude`.
|
|
204
|
-
Returns `Key` otherwise.
|
|
205
|
-
|
|
206
|
-
@example
|
|
207
|
-
```
|
|
208
|
-
type Filtered = Filter<'foo', 'foo'>;
|
|
209
|
-
//=> never
|
|
210
|
-
```
|
|
211
|
-
|
|
212
|
-
@example
|
|
213
|
-
```
|
|
214
|
-
type Filtered = Filter<'bar', string>;
|
|
215
|
-
//=> never
|
|
216
|
-
```
|
|
217
|
-
|
|
218
|
-
@example
|
|
219
|
-
```
|
|
220
|
-
type Filtered = Filter<'bar', 'foo'>;
|
|
221
|
-
//=> 'bar'
|
|
222
|
-
```
|
|
223
|
-
|
|
224
|
-
@see {Except}
|
|
225
|
-
*/
|
|
226
|
-
type Filter<KeyType, ExcludeType> = IsEqual<KeyType, ExcludeType> extends true ? never : (KeyType extends ExcludeType ? never : KeyType);
|
|
227
|
-
|
|
228
|
-
type ExceptOptions = {
|
|
229
|
-
/**
|
|
230
|
-
Disallow assigning non-specified properties.
|
|
231
|
-
|
|
232
|
-
Note that any omitted properties in the resulting type will be present in autocomplete as `undefined`.
|
|
233
|
-
|
|
234
|
-
@default false
|
|
235
|
-
*/
|
|
236
|
-
requireExactProps?: boolean;
|
|
237
|
-
};
|
|
238
|
-
|
|
239
|
-
/**
|
|
240
|
-
Create a type from an object type without certain keys.
|
|
241
|
-
|
|
242
|
-
We recommend setting the `requireExactProps` option to `true`.
|
|
243
|
-
|
|
244
|
-
This type is a stricter version of [`Omit`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-5.html#the-omit-helper-type). The `Omit` type does not restrict the omitted keys to be keys present on the given type, while `Except` does. The benefits of a stricter type are avoiding typos and allowing the compiler to pick up on rename refactors automatically.
|
|
245
|
-
|
|
246
|
-
This type was proposed to the TypeScript team, which declined it, saying they prefer that libraries implement stricter versions of the built-in types ([microsoft/TypeScript#30825](https://github.com/microsoft/TypeScript/issues/30825#issuecomment-523668235)).
|
|
247
|
-
|
|
248
|
-
@example
|
|
249
|
-
```
|
|
250
|
-
import type {Except} from 'type-fest';
|
|
251
|
-
|
|
252
|
-
type Foo = {
|
|
253
|
-
a: number;
|
|
254
|
-
b: string;
|
|
255
|
-
};
|
|
256
|
-
|
|
257
|
-
type FooWithoutA = Except<Foo, 'a'>;
|
|
258
|
-
//=> {b: string}
|
|
259
|
-
|
|
260
|
-
const fooWithoutA: FooWithoutA = {a: 1, b: '2'};
|
|
261
|
-
//=> errors: 'a' does not exist in type '{ b: string; }'
|
|
262
|
-
|
|
263
|
-
type FooWithoutB = Except<Foo, 'b', {requireExactProps: true}>;
|
|
264
|
-
//=> {a: number} & Partial<Record<"b", never>>
|
|
265
|
-
|
|
266
|
-
const fooWithoutB: FooWithoutB = {a: 1, b: '2'};
|
|
267
|
-
//=> errors at 'b': Type 'string' is not assignable to type 'undefined'.
|
|
268
|
-
```
|
|
269
|
-
|
|
270
|
-
@category Object
|
|
271
|
-
*/
|
|
272
|
-
type Except<ObjectType, KeysType extends keyof ObjectType, Options extends ExceptOptions = {requireExactProps: false}> = {
|
|
273
|
-
[KeyType in keyof ObjectType as Filter<KeyType, KeysType>]: ObjectType[KeyType];
|
|
274
|
-
} & (Options['requireExactProps'] extends true
|
|
275
|
-
? Partial<Record<KeysType, never>>
|
|
276
|
-
: {});
|
|
277
|
-
|
|
278
|
-
/**
|
|
279
|
-
Returns a boolean for whether the given type is `never`.
|
|
280
|
-
|
|
281
|
-
@link https://github.com/microsoft/TypeScript/issues/31751#issuecomment-498526919
|
|
282
|
-
@link https://stackoverflow.com/a/53984913/10292952
|
|
283
|
-
@link https://www.zhenghao.io/posts/ts-never
|
|
284
|
-
|
|
285
|
-
Useful in type utilities, such as checking if something does not occur.
|
|
286
|
-
|
|
287
|
-
@example
|
|
288
|
-
```
|
|
289
|
-
import type {IsNever, And} from 'type-fest';
|
|
290
|
-
|
|
291
|
-
// https://github.com/andnp/SimplyTyped/blob/master/src/types/strings.ts
|
|
292
|
-
type AreStringsEqual<A extends string, B extends string> =
|
|
293
|
-
And<
|
|
294
|
-
IsNever<Exclude<A, B>> extends true ? true : false,
|
|
295
|
-
IsNever<Exclude<B, A>> extends true ? true : false
|
|
296
|
-
>;
|
|
297
|
-
|
|
298
|
-
type EndIfEqual<I extends string, O extends string> =
|
|
299
|
-
AreStringsEqual<I, O> extends true
|
|
300
|
-
? never
|
|
301
|
-
: void;
|
|
302
|
-
|
|
303
|
-
function endIfEqual<I extends string, O extends string>(input: I, output: O): EndIfEqual<I, O> {
|
|
304
|
-
if (input === output) {
|
|
305
|
-
process.exit(0);
|
|
306
|
-
}
|
|
307
|
-
}
|
|
308
|
-
|
|
309
|
-
endIfEqual('abc', 'abc');
|
|
310
|
-
//=> never
|
|
311
|
-
|
|
312
|
-
endIfEqual('abc', '123');
|
|
313
|
-
//=> void
|
|
314
|
-
```
|
|
315
|
-
|
|
316
|
-
@category Type Guard
|
|
317
|
-
@category Utilities
|
|
318
|
-
*/
|
|
319
|
-
type IsNever<T> = [T] extends [never] ? true : false;
|
|
320
|
-
|
|
321
|
-
/**
|
|
322
|
-
An if-else-like type that resolves depending on whether the given type is `never`.
|
|
323
|
-
|
|
324
|
-
@see {@link IsNever}
|
|
325
|
-
|
|
326
|
-
@example
|
|
327
|
-
```
|
|
328
|
-
import type {IfNever} from 'type-fest';
|
|
329
|
-
|
|
330
|
-
type ShouldBeTrue = IfNever<never>;
|
|
331
|
-
//=> true
|
|
332
|
-
|
|
333
|
-
type ShouldBeBar = IfNever<'not never', 'foo', 'bar'>;
|
|
334
|
-
//=> 'bar'
|
|
335
|
-
```
|
|
336
|
-
|
|
337
|
-
@category Type Guard
|
|
338
|
-
@category Utilities
|
|
339
|
-
*/
|
|
340
|
-
type IfNever<T, TypeIfNever = true, TypeIfNotNever = false> = (
|
|
341
|
-
IsNever<T> extends true ? TypeIfNever : TypeIfNotNever
|
|
342
|
-
);
|
|
343
|
-
|
|
344
|
-
/**
|
|
345
|
-
Extract the keys from a type where the value type of the key extends the given `Condition`.
|
|
346
|
-
|
|
347
|
-
Internally this is used for the `ConditionalPick` and `ConditionalExcept` types.
|
|
348
|
-
|
|
349
|
-
@example
|
|
350
|
-
```
|
|
351
|
-
import type {ConditionalKeys} from 'type-fest';
|
|
352
|
-
|
|
353
|
-
interface Example {
|
|
354
|
-
a: string;
|
|
355
|
-
b: string | number;
|
|
356
|
-
c?: string;
|
|
357
|
-
d: {};
|
|
358
|
-
}
|
|
359
|
-
|
|
360
|
-
type StringKeysOnly = ConditionalKeys<Example, string>;
|
|
361
|
-
//=> 'a'
|
|
362
|
-
```
|
|
363
|
-
|
|
364
|
-
To support partial types, make sure your `Condition` is a union of undefined (for example, `string | undefined`) as demonstrated below.
|
|
365
|
-
|
|
366
|
-
@example
|
|
367
|
-
```
|
|
368
|
-
import type {ConditionalKeys} from 'type-fest';
|
|
369
|
-
|
|
370
|
-
type StringKeysAndUndefined = ConditionalKeys<Example, string | undefined>;
|
|
371
|
-
//=> 'a' | 'c'
|
|
372
|
-
```
|
|
373
|
-
|
|
374
|
-
@category Object
|
|
375
|
-
*/
|
|
376
|
-
type ConditionalKeys<Base, Condition> =
|
|
377
|
-
{
|
|
378
|
-
// Map through all the keys of the given base type.
|
|
379
|
-
[Key in keyof Base]-?:
|
|
380
|
-
// Pick only keys with types extending the given `Condition` type.
|
|
381
|
-
Base[Key] extends Condition
|
|
382
|
-
// Retain this key
|
|
383
|
-
// If the value for the key extends never, only include it if `Condition` also extends never
|
|
384
|
-
? IfNever<Base[Key], IfNever<Condition, Key, never>, Key>
|
|
385
|
-
// Discard this key since the condition fails.
|
|
386
|
-
: never;
|
|
387
|
-
// Convert the produced object into a union type of the keys which passed the conditional test.
|
|
388
|
-
}[keyof Base];
|
|
389
|
-
|
|
390
|
-
/**
|
|
391
|
-
Exclude keys from a shape that matches the given `Condition`.
|
|
392
|
-
|
|
393
|
-
This is useful when you want to create a new type with a specific set of keys from a shape. For example, you might want to exclude all the primitive properties from a class and form a new shape containing everything but the primitive properties.
|
|
394
|
-
|
|
395
|
-
@example
|
|
396
|
-
```
|
|
397
|
-
import type {Primitive, ConditionalExcept} from 'type-fest';
|
|
398
|
-
|
|
399
|
-
class Awesome {
|
|
400
|
-
name: string;
|
|
401
|
-
successes: number;
|
|
402
|
-
failures: bigint;
|
|
403
|
-
|
|
404
|
-
run() {}
|
|
405
|
-
}
|
|
406
|
-
|
|
407
|
-
type ExceptPrimitivesFromAwesome = ConditionalExcept<Awesome, Primitive>;
|
|
408
|
-
//=> {run: () => void}
|
|
409
|
-
```
|
|
410
|
-
|
|
411
|
-
@example
|
|
412
|
-
```
|
|
413
|
-
import type {ConditionalExcept} from 'type-fest';
|
|
414
|
-
|
|
415
|
-
interface Example {
|
|
416
|
-
a: string;
|
|
417
|
-
b: string | number;
|
|
418
|
-
c: () => void;
|
|
419
|
-
d: {};
|
|
420
|
-
}
|
|
421
|
-
|
|
422
|
-
type NonStringKeysOnly = ConditionalExcept<Example, string>;
|
|
423
|
-
//=> {b: string | number; c: () => void; d: {}}
|
|
424
|
-
```
|
|
425
|
-
|
|
426
|
-
@category Object
|
|
427
|
-
*/
|
|
428
|
-
type ConditionalExcept<Base, Condition> = Except<
|
|
429
|
-
Base,
|
|
430
|
-
ConditionalKeys<Base, Condition>
|
|
431
|
-
>;
|
|
432
|
-
|
|
433
|
-
/**
|
|
434
|
-
* Descriptors are objects that describe the API of a module, and the module
|
|
435
|
-
* can either be a REST module or a host module.
|
|
436
|
-
* This type is recursive, so it can describe nested modules.
|
|
437
|
-
*/
|
|
438
|
-
type Descriptors = RESTFunctionDescriptor | AmbassadorFunctionDescriptor | HostModule<any, any> | EventDefinition<any> | ServicePluginDefinition<any> | {
|
|
439
|
-
[key: string]: Descriptors | PublicMetadata | any;
|
|
440
|
-
};
|
|
441
|
-
/**
|
|
442
|
-
* This type takes in a descriptors object of a certain Host (including an `unknown` host)
|
|
443
|
-
* and returns an object with the same structure, but with all descriptors replaced with their API.
|
|
444
|
-
* Any non-descriptor properties are removed from the returned object, including descriptors that
|
|
445
|
-
* do not match the given host (as they will not work with the given host).
|
|
446
|
-
*/
|
|
447
|
-
type BuildDescriptors<T extends Descriptors, H extends Host<any> | undefined, Depth extends number = 5> = {
|
|
448
|
-
done: T;
|
|
449
|
-
recurse: T extends {
|
|
450
|
-
__type: typeof SERVICE_PLUGIN_ERROR_TYPE;
|
|
451
|
-
} ? never : T extends AmbassadorFunctionDescriptor ? BuildAmbassadorFunction<T> : T extends RESTFunctionDescriptor ? BuildRESTFunction<T> : T extends EventDefinition<any> ? BuildEventDefinition<T> : T extends ServicePluginDefinition<any> ? BuildServicePluginDefinition<T> : T extends HostModule<any, any> ? HostModuleAPI<T> : ConditionalExcept<{
|
|
452
|
-
[Key in keyof T]: T[Key] extends Descriptors ? BuildDescriptors<T[Key], H, [
|
|
453
|
-
-1,
|
|
454
|
-
0,
|
|
455
|
-
1,
|
|
456
|
-
2,
|
|
457
|
-
3,
|
|
458
|
-
4,
|
|
459
|
-
5
|
|
460
|
-
][Depth]> : never;
|
|
461
|
-
}, EmptyObject>;
|
|
462
|
-
}[Depth extends -1 ? 'done' : 'recurse'];
|
|
463
|
-
type PublicMetadata = {
|
|
464
|
-
PACKAGE_NAME?: string;
|
|
465
|
-
};
|
|
466
|
-
|
|
467
|
-
declare global {
|
|
468
|
-
interface ContextualClient {
|
|
469
|
-
}
|
|
470
|
-
}
|
|
471
|
-
/**
|
|
472
|
-
* A type used to create concerete types from SDK descriptors in
|
|
473
|
-
* case a contextual client is available.
|
|
474
|
-
*/
|
|
475
|
-
type MaybeContext<T extends Descriptors> = globalThis.ContextualClient extends {
|
|
476
|
-
host: Host;
|
|
477
|
-
} ? BuildDescriptors<T, globalThis.ContextualClient['host']> : T;
|
|
478
|
-
|
|
479
|
-
interface SiteDocument$1 {
|
|
480
|
-
/**
|
|
481
|
-
* Result ID.
|
|
482
|
-
* @readonly
|
|
483
|
-
*/
|
|
484
|
-
_id?: string;
|
|
485
|
-
/** The document payload. */
|
|
486
|
-
data?: Record<string, any> | null;
|
|
487
|
-
}
|
|
488
|
-
interface SearchRequest$1 {
|
|
489
|
-
/** Search query and aggregation information. */
|
|
490
|
-
search: Search;
|
|
491
|
-
/** Document type to search in. */
|
|
492
|
-
documentType: DocumentType;
|
|
493
|
-
/** Language to search in. */
|
|
494
|
-
language?: string | null;
|
|
495
|
-
}
|
|
496
|
-
interface Search extends SearchPagingMethodOneOf {
|
|
497
|
-
/** Paging options to limit and skip the number of items. */
|
|
498
|
-
paging?: Paging;
|
|
499
|
-
/**
|
|
500
|
-
* Filter object in the following format:
|
|
501
|
-
* `"filter" : {
|
|
502
|
-
* "fieldName1": "value1",
|
|
503
|
-
* "fieldName2":{"$operator":"value2"}
|
|
504
|
-
* }`
|
|
505
|
-
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
506
|
-
*/
|
|
507
|
-
filter?: Record<string, any> | null;
|
|
508
|
-
/**
|
|
509
|
-
* Sort object in the following format:
|
|
510
|
-
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
511
|
-
*/
|
|
512
|
-
sort?: Sorting[];
|
|
513
|
-
/** 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. */
|
|
514
|
-
aggregations?: Aggregation$1[];
|
|
515
|
-
/** Search information. */
|
|
516
|
-
search?: SearchDetails;
|
|
517
|
-
}
|
|
518
|
-
/** @oneof */
|
|
519
|
-
interface SearchPagingMethodOneOf {
|
|
520
|
-
/** Paging options to limit and skip the number of items. */
|
|
521
|
-
paging?: Paging;
|
|
522
|
-
}
|
|
523
|
-
interface Sorting {
|
|
524
|
-
/** Name of the field to sort by. */
|
|
525
|
-
fieldName?: string;
|
|
526
|
-
/** Sort order. */
|
|
527
|
-
order?: SortOrder;
|
|
528
|
-
}
|
|
529
|
-
declare enum SortOrder {
|
|
530
|
-
ASC = "ASC",
|
|
531
|
-
DESC = "DESC"
|
|
532
|
-
}
|
|
533
|
-
interface Aggregation$1 extends AggregationKindOneOf {
|
|
534
|
-
/** 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. */
|
|
535
|
-
value?: ValueAggregation;
|
|
536
|
-
/** Pass if `type` is `SCALAR`. A scalar aggregation calculates a single numerical value from a dataset, such as the total, 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. */
|
|
537
|
-
scalar?: ScalarAggregation;
|
|
538
|
-
/** 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. */
|
|
539
|
-
nested?: NestedAggregation;
|
|
540
|
-
/** Aggregation name displayed in the return. */
|
|
541
|
-
name?: string | null;
|
|
542
|
-
/** Type of aggregation to perform. */
|
|
543
|
-
type?: AggregationType;
|
|
544
|
-
/** Field to aggregate by. */
|
|
545
|
-
fieldPath?: string;
|
|
546
|
-
}
|
|
547
|
-
/** @oneof */
|
|
548
|
-
interface AggregationKindOneOf {
|
|
549
|
-
/** 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. */
|
|
550
|
-
value?: ValueAggregation;
|
|
551
|
-
/** Pass if `type` is `SCALAR`. A scalar aggregation calculates a single numerical value from a dataset, such as the total, 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. */
|
|
552
|
-
scalar?: ScalarAggregation;
|
|
553
|
-
/** 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. */
|
|
554
|
-
nested?: NestedAggregation;
|
|
555
|
-
}
|
|
556
|
-
declare enum ScalarType {
|
|
557
|
-
/** Unknown scalar type. */
|
|
558
|
-
UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
|
|
559
|
-
/** Minimum value. */
|
|
560
|
-
MIN = "MIN",
|
|
561
|
-
/** Maximum value. */
|
|
562
|
-
MAX = "MAX",
|
|
563
|
-
/** Sum of values. */
|
|
564
|
-
SUM = "SUM"
|
|
565
|
-
}
|
|
566
|
-
declare enum NestedAggregationType {
|
|
567
|
-
/** Unknown aggregation type. */
|
|
568
|
-
UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
|
|
569
|
-
/** An aggregation where result buckets are dynamically built - one per unique value. */
|
|
570
|
-
VALUE = "VALUE",
|
|
571
|
-
/** A single-value metric aggregation - e.g. min, max, sum, avg. */
|
|
572
|
-
SCALAR = "SCALAR"
|
|
573
|
-
}
|
|
574
|
-
interface ValueAggregation {
|
|
575
|
-
/**
|
|
576
|
-
* Maximum number of aggregation results to return.
|
|
577
|
-
* Min: `1`
|
|
578
|
-
* Max: `250`
|
|
579
|
-
* Default: `10`
|
|
580
|
-
*/
|
|
581
|
-
limit?: number | null;
|
|
582
|
-
}
|
|
583
|
-
interface ScalarAggregation {
|
|
584
|
-
/** Type of scalar aggregation. */
|
|
585
|
-
type?: ScalarType;
|
|
586
|
-
}
|
|
587
|
-
interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
|
|
588
|
-
/** 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. */
|
|
589
|
-
value?: ValueAggregation;
|
|
590
|
-
/** Pass if `type` is `SCALAR`. A scalar aggregation calculates a single numerical value from a dataset, such as the total, 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. */
|
|
591
|
-
scalar?: ScalarAggregation;
|
|
592
|
-
/** Aggregation name displayed in the return. */
|
|
593
|
-
name?: string | null;
|
|
594
|
-
/** Type of aggregation to perform. */
|
|
595
|
-
type?: NestedAggregationType;
|
|
596
|
-
/** Field to aggregate by. */
|
|
597
|
-
fieldPath?: string;
|
|
598
|
-
}
|
|
599
|
-
/** @oneof */
|
|
600
|
-
interface NestedAggregationItemKindOneOf {
|
|
601
|
-
/** 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. */
|
|
602
|
-
value?: ValueAggregation;
|
|
603
|
-
/** Pass if `type` is `SCALAR`. A scalar aggregation calculates a single numerical value from a dataset, such as the total, 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. */
|
|
604
|
-
scalar?: ScalarAggregation;
|
|
605
|
-
}
|
|
606
|
-
declare enum AggregationType {
|
|
607
|
-
UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
|
|
608
|
-
/** An aggregation where result buckets are dynamically built - one per unique value. */
|
|
609
|
-
VALUE = "VALUE",
|
|
610
|
-
/** A single-value metric aggregation - e.g. min, max, sum, avg. */
|
|
611
|
-
SCALAR = "SCALAR",
|
|
612
|
-
/** Multi-level aggregation, where each next aggregation is nested within previous one. */
|
|
613
|
-
NESTED = "NESTED"
|
|
614
|
-
}
|
|
615
|
-
/** List of aggregations. Each aggregation is nested within the previous one. */
|
|
616
|
-
interface NestedAggregation {
|
|
617
|
-
/** List of aggregations, where each aggregation is nested within previous one. */
|
|
618
|
-
nestedAggregations?: NestedAggregationItem[];
|
|
619
|
-
}
|
|
620
|
-
interface SearchDetails {
|
|
621
|
-
/** Search term or expression. */
|
|
622
|
-
expression?: string | null;
|
|
623
|
-
/**
|
|
624
|
-
* Fields to search in.
|
|
625
|
-
* If the array is empty, all fields are searched.
|
|
626
|
-
*/
|
|
627
|
-
fields?: string[];
|
|
628
|
-
/** 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. */
|
|
629
|
-
fuzzy?: boolean;
|
|
630
|
-
}
|
|
631
|
-
interface Paging {
|
|
632
|
-
/** Number of items to load. */
|
|
633
|
-
limit?: number | null;
|
|
634
|
-
/** Number of items to skip in the current sort order. */
|
|
635
|
-
offset?: number | null;
|
|
636
|
-
}
|
|
637
|
-
declare enum DocumentType {
|
|
638
|
-
UNSPECIFIED = "UNSPECIFIED",
|
|
639
|
-
BLOG_POSTS = "BLOG_POSTS",
|
|
640
|
-
BOOKING_SERVICES = "BOOKING_SERVICES",
|
|
641
|
-
EVENTS = "EVENTS",
|
|
642
|
-
FORUM_CONTENT = "FORUM_CONTENT",
|
|
643
|
-
ONLINE_PROGRAMS = "ONLINE_PROGRAMS",
|
|
644
|
-
PROGALLERY_ITEM = "PROGALLERY_ITEM",
|
|
645
|
-
STORES_PRODUCTS = "STORES_PRODUCTS"
|
|
646
|
-
}
|
|
647
|
-
interface SearchResponse$1 extends SearchResponsePagingOneOf {
|
|
648
|
-
/** Paging metadata. */
|
|
649
|
-
pagingOffsetMetadata?: PagingMetadata;
|
|
650
|
-
/** Documents matching the search query. */
|
|
651
|
-
siteDocumentItems?: SiteDocument$1[];
|
|
652
|
-
/** Aggregated data. */
|
|
653
|
-
aggregationData?: AggregationData;
|
|
654
|
-
}
|
|
655
|
-
/** @oneof */
|
|
656
|
-
interface SearchResponsePagingOneOf {
|
|
657
|
-
/** Paging metadata. */
|
|
658
|
-
pagingOffsetMetadata?: PagingMetadata;
|
|
659
|
-
}
|
|
660
|
-
interface AggregationData {
|
|
661
|
-
/** List of the aggregated data results. */
|
|
662
|
-
results?: AggregationResults[];
|
|
663
|
-
}
|
|
664
|
-
interface ValueAggregationResult {
|
|
665
|
-
/** Value contained in the field specified in `fieldPath` for this aggregation in the request. */
|
|
666
|
-
value?: string;
|
|
667
|
-
/** Number of documents containing the specified value in the specified field. */
|
|
668
|
-
count?: number;
|
|
669
|
-
}
|
|
670
|
-
interface ValueResults {
|
|
671
|
-
/** List of value aggregation results. */
|
|
672
|
-
results?: ValueAggregationResult[];
|
|
673
|
-
}
|
|
674
|
-
interface AggregationResultsScalarResult {
|
|
675
|
-
/** Type of scalar aggregation. */
|
|
676
|
-
type?: ScalarType;
|
|
677
|
-
/** Value of the scalar aggregation. For example, the minimum, maximum, or total value for the specified field. */
|
|
678
|
-
value?: number;
|
|
679
|
-
}
|
|
680
|
-
interface ValueResult {
|
|
681
|
-
/** Value contained in the field specified in `fieldPath` for this aggregation in the request. */
|
|
682
|
-
value?: string;
|
|
683
|
-
/** Number of documents containing the specified value in the specified field. */
|
|
684
|
-
count?: number | null;
|
|
685
|
-
}
|
|
686
|
-
interface ScalarResult {
|
|
687
|
-
/** Scalar aggregation results. */
|
|
688
|
-
value?: number;
|
|
689
|
-
}
|
|
690
|
-
interface NestedResultValue extends NestedResultValueResultOneOf {
|
|
691
|
-
/** Value aggregation results. */
|
|
692
|
-
value?: ValueResult;
|
|
693
|
-
/** Scalar aggregation results. */
|
|
694
|
-
scalar?: ScalarResult;
|
|
695
|
-
}
|
|
696
|
-
/** @oneof */
|
|
697
|
-
interface NestedResultValueResultOneOf {
|
|
698
|
-
/** Value aggregation results. */
|
|
699
|
-
value?: ValueResult;
|
|
700
|
-
/** Scalar aggregation results. */
|
|
701
|
-
scalar?: ScalarResult;
|
|
702
|
-
}
|
|
703
|
-
interface Results {
|
|
704
|
-
/** Aggregation results. */
|
|
705
|
-
results?: Record<string, NestedResultValue>;
|
|
706
|
-
}
|
|
707
|
-
/**
|
|
708
|
-
* Results of `NESTED` aggregation type in a flattened form
|
|
709
|
-
* aggregations in resulting array are keyed by requested aggregation `name`.
|
|
710
|
-
*/
|
|
711
|
-
interface NestedResults {
|
|
712
|
-
/** List of nested aggregation results. */
|
|
713
|
-
results?: Results[];
|
|
714
|
-
}
|
|
715
|
-
interface AggregationResults extends AggregationResultsResultOneOf {
|
|
716
|
-
/** Value aggregation results. */
|
|
717
|
-
values?: ValueResults;
|
|
718
|
-
/** Scalar aggregation results. */
|
|
719
|
-
scalar?: AggregationResultsScalarResult;
|
|
720
|
-
/** Nested aggregation results. */
|
|
721
|
-
nested?: NestedResults;
|
|
722
|
-
/** Aggregation name defined in the request. */
|
|
723
|
-
name?: string;
|
|
724
|
-
/** Type of aggregation that was performed. */
|
|
725
|
-
type?: AggregationType;
|
|
726
|
-
/** Field the data was aggregated by. */
|
|
727
|
-
fieldPath?: string;
|
|
728
|
-
}
|
|
729
|
-
/** @oneof */
|
|
730
|
-
interface AggregationResultsResultOneOf {
|
|
731
|
-
/** Value aggregation results. */
|
|
732
|
-
values?: ValueResults;
|
|
733
|
-
/** Scalar aggregation results. */
|
|
734
|
-
scalar?: AggregationResultsScalarResult;
|
|
735
|
-
/** Nested aggregation results. */
|
|
736
|
-
nested?: NestedResults;
|
|
737
|
-
}
|
|
738
|
-
interface PagingMetadata {
|
|
739
|
-
/** Number of items returned in the response. */
|
|
740
|
-
count?: number | null;
|
|
741
|
-
/** Offset that was requested. */
|
|
742
|
-
offset?: number | null;
|
|
743
|
-
/** Total number of items that match the query. */
|
|
744
|
-
total?: number | null;
|
|
745
|
-
/** Whether the server failed to calculate the `total` field. */
|
|
746
|
-
tooManyToCount?: boolean | null;
|
|
747
|
-
}
|
|
748
|
-
interface SiteDocumentNonNullableFields {
|
|
749
|
-
_id: string;
|
|
750
|
-
}
|
|
751
|
-
interface ValueAggregationResultNonNullableFields {
|
|
752
|
-
value: string;
|
|
753
|
-
count: number;
|
|
754
|
-
}
|
|
755
|
-
interface ValueResultsNonNullableFields {
|
|
756
|
-
results: ValueAggregationResultNonNullableFields[];
|
|
757
|
-
}
|
|
758
|
-
interface AggregationResultsScalarResultNonNullableFields {
|
|
759
|
-
type: ScalarType;
|
|
760
|
-
value: number;
|
|
761
|
-
}
|
|
762
|
-
interface AggregationResultsNonNullableFields {
|
|
763
|
-
values?: ValueResultsNonNullableFields;
|
|
764
|
-
scalar?: AggregationResultsScalarResultNonNullableFields;
|
|
765
|
-
name: string;
|
|
766
|
-
type: AggregationType;
|
|
767
|
-
fieldPath: string;
|
|
768
|
-
}
|
|
769
|
-
interface AggregationDataNonNullableFields {
|
|
770
|
-
results: AggregationResultsNonNullableFields[];
|
|
771
|
-
}
|
|
772
|
-
interface SearchResponseNonNullableFields$1 {
|
|
773
|
-
siteDocumentItems: SiteDocumentNonNullableFields[];
|
|
774
|
-
aggregationData?: AggregationDataNonNullableFields;
|
|
775
|
-
}
|
|
776
|
-
interface SearchOptions$1 {
|
|
777
|
-
/** Language to search in. */
|
|
778
|
-
language?: string | null;
|
|
779
|
-
}
|
|
780
|
-
|
|
781
|
-
declare function search$3(httpClient: HttpClient): SearchSignature$1;
|
|
782
|
-
interface SearchSignature$1 {
|
|
783
|
-
/**
|
|
784
|
-
* Retrieves a list of site documents that match the provided search query and optionally performs aggregations on the data queried.
|
|
785
|
-
*
|
|
786
|
-
* The `search()` API supports the document types listed in the [Introduction](https://dev.wix.com/docs/sdk/backend-modules/search/wix-site-search/introduction), each with its own schema. These schemas define the fields available for filtering, sorting, and free-text searching.
|
|
787
|
-
*
|
|
788
|
-
* To learn more about working with the search query, see [API Query Language](https://dev.wix.com/docs/sdk/articles/working-with-the-sdk/api-query-language).
|
|
789
|
-
* @param - Search query and aggregation information.
|
|
790
|
-
* @param - Document type to search in.
|
|
791
|
-
*/
|
|
792
|
-
(search: Search, documentType: DocumentType, options?: SearchOptions$1 | undefined): Promise<SearchResponse$1 & SearchResponseNonNullableFields$1>;
|
|
793
|
-
}
|
|
794
|
-
|
|
795
|
-
declare const search$2: MaybeContext<BuildRESTFunction<typeof search$3> & typeof search$3>;
|
|
796
|
-
|
|
797
|
-
type context$1_AggregationData = AggregationData;
|
|
798
|
-
type context$1_AggregationKindOneOf = AggregationKindOneOf;
|
|
799
|
-
type context$1_AggregationResults = AggregationResults;
|
|
800
|
-
type context$1_AggregationResultsResultOneOf = AggregationResultsResultOneOf;
|
|
801
|
-
type context$1_AggregationResultsScalarResult = AggregationResultsScalarResult;
|
|
802
|
-
type context$1_AggregationType = AggregationType;
|
|
803
|
-
declare const context$1_AggregationType: typeof AggregationType;
|
|
804
|
-
type context$1_DocumentType = DocumentType;
|
|
805
|
-
declare const context$1_DocumentType: typeof DocumentType;
|
|
806
|
-
type context$1_NestedAggregation = NestedAggregation;
|
|
807
|
-
type context$1_NestedAggregationItem = NestedAggregationItem;
|
|
808
|
-
type context$1_NestedAggregationItemKindOneOf = NestedAggregationItemKindOneOf;
|
|
809
|
-
type context$1_NestedAggregationType = NestedAggregationType;
|
|
810
|
-
declare const context$1_NestedAggregationType: typeof NestedAggregationType;
|
|
811
|
-
type context$1_NestedResultValue = NestedResultValue;
|
|
812
|
-
type context$1_NestedResultValueResultOneOf = NestedResultValueResultOneOf;
|
|
813
|
-
type context$1_NestedResults = NestedResults;
|
|
814
|
-
type context$1_Paging = Paging;
|
|
815
|
-
type context$1_PagingMetadata = PagingMetadata;
|
|
816
|
-
type context$1_Results = Results;
|
|
817
|
-
type context$1_ScalarAggregation = ScalarAggregation;
|
|
818
|
-
type context$1_ScalarResult = ScalarResult;
|
|
819
|
-
type context$1_ScalarType = ScalarType;
|
|
820
|
-
declare const context$1_ScalarType: typeof ScalarType;
|
|
821
|
-
type context$1_Search = Search;
|
|
822
|
-
type context$1_SearchDetails = SearchDetails;
|
|
823
|
-
type context$1_SearchPagingMethodOneOf = SearchPagingMethodOneOf;
|
|
824
|
-
type context$1_SearchResponsePagingOneOf = SearchResponsePagingOneOf;
|
|
825
|
-
type context$1_SortOrder = SortOrder;
|
|
826
|
-
declare const context$1_SortOrder: typeof SortOrder;
|
|
827
|
-
type context$1_Sorting = Sorting;
|
|
828
|
-
type context$1_ValueAggregation = ValueAggregation;
|
|
829
|
-
type context$1_ValueAggregationResult = ValueAggregationResult;
|
|
830
|
-
type context$1_ValueResult = ValueResult;
|
|
831
|
-
type context$1_ValueResults = ValueResults;
|
|
832
|
-
declare namespace context$1 {
|
|
833
|
-
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$2 as search };
|
|
834
|
-
}
|
|
835
|
-
|
|
836
|
-
/** API is not yet fully migrated to FQDN entity */
|
|
837
|
-
interface SiteDocument {
|
|
838
|
-
/** the document payload */
|
|
839
|
-
document?: Record<string, any> | null;
|
|
840
|
-
}
|
|
841
|
-
interface UpdateInternalDocumentsEvent extends UpdateInternalDocumentsEventOperationOneOf {
|
|
842
|
-
/** insert/update documents */
|
|
843
|
-
update?: InternalDocumentUpdateOperation;
|
|
844
|
-
/** delete by document ids */
|
|
845
|
-
deleteByIds?: DeleteByIdsOperation;
|
|
846
|
-
/** delete documents matching filter */
|
|
847
|
-
deleteByFilter?: DeleteByFilterOperation;
|
|
848
|
-
/** update internal documents matching filter */
|
|
849
|
-
updateByFilter?: InternalDocumentUpdateByFilterOperation;
|
|
850
|
-
/** update only existing documents */
|
|
851
|
-
updateExisting?: InternalUpdateExistingOperation;
|
|
852
|
-
/** insert/update documents with versioning */
|
|
853
|
-
versionedUpdate?: VersionedDocumentUpdateOperation;
|
|
854
|
-
/** delete by document ids with versioning */
|
|
855
|
-
versionedDeleteByIds?: VersionedDeleteByIdsOperation;
|
|
856
|
-
/** type of the documents */
|
|
857
|
-
documentType?: string;
|
|
858
|
-
/** language of the documents (mandatory) */
|
|
859
|
-
language?: string | null;
|
|
860
|
-
/**
|
|
861
|
-
* one or more search documents
|
|
862
|
-
* @deprecated
|
|
863
|
-
*/
|
|
864
|
-
addDocuments?: InternalDocument[];
|
|
865
|
-
/**
|
|
866
|
-
* one or more ids of indexed documents to be removed. Removal will happen before addition (if both provided)
|
|
867
|
-
* @deprecated
|
|
868
|
-
*/
|
|
869
|
-
removeDocumentIds?: string[];
|
|
870
|
-
/** id to pass to processing notification */
|
|
871
|
-
correlationId?: string | null;
|
|
872
|
-
/** when event was created / issued */
|
|
873
|
-
issuedAt?: Date | null;
|
|
874
|
-
}
|
|
875
|
-
/** @oneof */
|
|
876
|
-
interface UpdateInternalDocumentsEventOperationOneOf {
|
|
877
|
-
/** insert/update documents */
|
|
878
|
-
update?: InternalDocumentUpdateOperation;
|
|
879
|
-
/** delete by document ids */
|
|
880
|
-
deleteByIds?: DeleteByIdsOperation;
|
|
881
|
-
/** delete documents matching filter */
|
|
882
|
-
deleteByFilter?: DeleteByFilterOperation;
|
|
883
|
-
/** update internal documents matching filter */
|
|
884
|
-
updateByFilter?: InternalDocumentUpdateByFilterOperation;
|
|
885
|
-
/** update only existing documents */
|
|
886
|
-
updateExisting?: InternalUpdateExistingOperation;
|
|
887
|
-
/** insert/update documents with versioning */
|
|
888
|
-
versionedUpdate?: VersionedDocumentUpdateOperation;
|
|
889
|
-
/** delete by document ids with versioning */
|
|
890
|
-
versionedDeleteByIds?: VersionedDeleteByIdsOperation;
|
|
891
|
-
}
|
|
892
|
-
interface InternalDocument {
|
|
893
|
-
/** document with mandatory fields (id) and with fields specific to the type of the document */
|
|
894
|
-
document?: Record<string, any> | null;
|
|
895
|
-
}
|
|
896
|
-
interface InternalDocumentUpdateOperation {
|
|
897
|
-
/** documents to index or update */
|
|
898
|
-
documents?: InternalDocument[];
|
|
899
|
-
}
|
|
900
|
-
interface DeleteByIdsOperation {
|
|
901
|
-
/** ids of the documents to delete */
|
|
902
|
-
documentIds?: string[];
|
|
903
|
-
}
|
|
904
|
-
interface DeleteByFilterOperation {
|
|
905
|
-
/** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
|
|
906
|
-
filter?: Record<string, any> | null;
|
|
907
|
-
}
|
|
908
|
-
interface InternalDocumentUpdateByFilterOperation {
|
|
909
|
-
/** documents matching this filter will be updated */
|
|
910
|
-
filter?: Record<string, any> | null;
|
|
911
|
-
/** partial document to apply */
|
|
912
|
-
document?: InternalDocument;
|
|
913
|
-
}
|
|
914
|
-
interface InternalUpdateExistingOperation {
|
|
915
|
-
/** documents to update */
|
|
916
|
-
documents?: InternalDocument[];
|
|
917
|
-
}
|
|
918
|
-
interface VersionedDocumentUpdateOperation {
|
|
919
|
-
/** documents to create or overwrite */
|
|
920
|
-
documents?: InternalDocument[];
|
|
921
|
-
/** versioning mode to use instead of default */
|
|
922
|
-
versioningMode?: VersioningMode;
|
|
923
|
-
}
|
|
924
|
-
declare enum VersioningMode {
|
|
925
|
-
/** use default versioning mode agreed with search team */
|
|
926
|
-
DEFAULT = "DEFAULT",
|
|
927
|
-
/** execute only if version is greater than existing */
|
|
928
|
-
GREATER_THAN = "GREATER_THAN",
|
|
929
|
-
/** execute only if version is greater or equal to existing */
|
|
930
|
-
GREATER_OR_EQUAL = "GREATER_OR_EQUAL"
|
|
931
|
-
}
|
|
932
|
-
interface VersionedDeleteByIdsOperation {
|
|
933
|
-
/** ids with version of the documents to delete */
|
|
934
|
-
documentIds?: VersionedDocumentId[];
|
|
935
|
-
}
|
|
936
|
-
interface VersionedDocumentId {
|
|
937
|
-
/** document id */
|
|
938
|
-
documentId?: string;
|
|
939
|
-
/** document version */
|
|
940
|
-
version?: string;
|
|
941
|
-
/** versioning mode to use instead of default */
|
|
942
|
-
versioningMode?: VersioningMode;
|
|
943
|
-
}
|
|
944
|
-
interface UpdateDocumentsEvent extends UpdateDocumentsEventOperationOneOf {
|
|
945
|
-
/** insert/update documents */
|
|
946
|
-
update?: DocumentUpdateOperation;
|
|
947
|
-
/** delete by document ids */
|
|
948
|
-
deleteByIds?: V1DeleteByIdsOperation;
|
|
949
|
-
/** delete documents matching filter */
|
|
950
|
-
deleteByFilter?: V1DeleteByFilterOperation;
|
|
951
|
-
/** update documents matching filter */
|
|
952
|
-
updateByFilter?: UpdateByFilterOperation;
|
|
953
|
-
/** update only existing documents */
|
|
954
|
-
updateExisting?: UpdateExistingOperation;
|
|
955
|
-
/** application which owns documents */
|
|
956
|
-
appDefId?: string | null;
|
|
957
|
-
/** type of the documents */
|
|
958
|
-
documentType?: string | null;
|
|
959
|
-
/** language of the documents */
|
|
960
|
-
language?: string | null;
|
|
961
|
-
/** site documents belong to */
|
|
962
|
-
msId?: string | null;
|
|
963
|
-
}
|
|
964
|
-
/** @oneof */
|
|
965
|
-
interface UpdateDocumentsEventOperationOneOf {
|
|
966
|
-
/** insert/update documents */
|
|
967
|
-
update?: DocumentUpdateOperation;
|
|
968
|
-
/** delete by document ids */
|
|
969
|
-
deleteByIds?: V1DeleteByIdsOperation;
|
|
970
|
-
/** delete documents matching filter */
|
|
971
|
-
deleteByFilter?: V1DeleteByFilterOperation;
|
|
972
|
-
/** update documents matching filter */
|
|
973
|
-
updateByFilter?: UpdateByFilterOperation;
|
|
974
|
-
/** update only existing documents */
|
|
975
|
-
updateExisting?: UpdateExistingOperation;
|
|
976
|
-
}
|
|
977
|
-
interface DocumentUpdateOperation {
|
|
978
|
-
/** documents to index or update */
|
|
979
|
-
documents?: IndexDocument[];
|
|
980
|
-
}
|
|
981
|
-
interface IndexDocument {
|
|
982
|
-
/** data bag with non-searchable fields (url, image) */
|
|
983
|
-
payload?: DocumentPayload;
|
|
984
|
-
/** what type of users should documents be visible to */
|
|
985
|
-
exposure?: Enum;
|
|
986
|
-
/** document with mandatory fields (id, title, description) and with fields specific to the type of the document */
|
|
987
|
-
document?: Record<string, any> | null;
|
|
988
|
-
/** what member groups is the document exposed to. Used only with GROUP_PROTECTED exposure */
|
|
989
|
-
permittedMemberGroups?: string[];
|
|
990
|
-
/** if true SEO is disabled for this document */
|
|
991
|
-
seoHidden?: boolean | null;
|
|
992
|
-
/** if true the page is a lightbox popup */
|
|
993
|
-
isPopup?: boolean | null;
|
|
994
|
-
}
|
|
995
|
-
interface DocumentPayload {
|
|
996
|
-
/** url of the page representing the document */
|
|
997
|
-
url?: string | null;
|
|
998
|
-
/** image which represents the document */
|
|
999
|
-
documentImage?: DocumentImage;
|
|
1000
|
-
}
|
|
1001
|
-
interface DocumentImage {
|
|
1002
|
-
/** the name of the image */
|
|
1003
|
-
name?: string;
|
|
1004
|
-
/** the width of the image */
|
|
1005
|
-
width?: number;
|
|
1006
|
-
/** the height of the image */
|
|
1007
|
-
height?: number;
|
|
1008
|
-
}
|
|
1009
|
-
declare enum Enum {
|
|
1010
|
-
/** Default value. Means that permission not set */
|
|
1011
|
-
UNKNOWN = "UNKNOWN",
|
|
1012
|
-
/** Protected exposure. Exposed to members and owners */
|
|
1013
|
-
PROTECTED = "PROTECTED",
|
|
1014
|
-
/** Private exposure. Exposed to owners */
|
|
1015
|
-
PRIVATE = "PRIVATE",
|
|
1016
|
-
/** Public exposure. Visible to everyone */
|
|
1017
|
-
PUBLIC = "PUBLIC",
|
|
1018
|
-
/** Used for partial updates, to state that exposure is not changing */
|
|
1019
|
-
UNCHANGED = "UNCHANGED",
|
|
1020
|
-
/** Protected to members of permitted groups and owners */
|
|
1021
|
-
GROUP_PROTECTED = "GROUP_PROTECTED"
|
|
1022
|
-
}
|
|
1023
|
-
interface V1DeleteByIdsOperation {
|
|
1024
|
-
/** ids of the documents to delete */
|
|
1025
|
-
documentIds?: string[];
|
|
1026
|
-
}
|
|
1027
|
-
interface V1DeleteByFilterOperation {
|
|
1028
|
-
/** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
|
|
1029
|
-
filter?: Record<string, any> | null;
|
|
1030
|
-
}
|
|
1031
|
-
interface UpdateByFilterOperation {
|
|
1032
|
-
/** documents matching this filter will be updated */
|
|
1033
|
-
filter?: Record<string, any> | null;
|
|
1034
|
-
/** partial document to apply */
|
|
1035
|
-
document?: IndexDocument;
|
|
1036
|
-
}
|
|
1037
|
-
interface UpdateExistingOperation {
|
|
1038
|
-
/** documents to update */
|
|
1039
|
-
documents?: IndexDocument[];
|
|
1040
|
-
}
|
|
1041
|
-
interface Empty {
|
|
1042
|
-
}
|
|
1043
|
-
interface MessageEnvelope {
|
|
1044
|
-
/** App instance ID. */
|
|
1045
|
-
instanceId?: string | null;
|
|
1046
|
-
/** Event type. */
|
|
1047
|
-
eventType?: string;
|
|
1048
|
-
/** The identification type and identity data. */
|
|
1049
|
-
identity?: IdentificationData;
|
|
1050
|
-
/** Stringify payload. */
|
|
1051
|
-
data?: string;
|
|
1052
|
-
}
|
|
1053
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1054
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
1055
|
-
anonymousVisitorId?: string;
|
|
1056
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
1057
|
-
memberId?: string;
|
|
1058
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
1059
|
-
wixUserId?: string;
|
|
1060
|
-
/** ID of an app. */
|
|
1061
|
-
appId?: string;
|
|
1062
|
-
/** @readonly */
|
|
1063
|
-
identityType?: WebhookIdentityType;
|
|
1064
|
-
}
|
|
1065
|
-
/** @oneof */
|
|
1066
|
-
interface IdentificationDataIdOneOf {
|
|
1067
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
1068
|
-
anonymousVisitorId?: string;
|
|
1069
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
1070
|
-
memberId?: string;
|
|
1071
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
1072
|
-
wixUserId?: string;
|
|
1073
|
-
/** ID of an app. */
|
|
1074
|
-
appId?: string;
|
|
1075
|
-
}
|
|
1076
|
-
declare enum WebhookIdentityType {
|
|
1077
|
-
UNKNOWN = "UNKNOWN",
|
|
1078
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1079
|
-
MEMBER = "MEMBER",
|
|
1080
|
-
WIX_USER = "WIX_USER",
|
|
1081
|
-
APP = "APP"
|
|
1082
|
-
}
|
|
1083
|
-
interface SearchRequest {
|
|
1084
|
-
/** Text to search for. All searchable fields will be searched. */
|
|
1085
|
-
query?: string | null;
|
|
1086
|
-
/** Document type of documents to search for. All document types are searched if not provided. */
|
|
1087
|
-
documentType?: string | null;
|
|
1088
|
-
/** Fields to order by. */
|
|
1089
|
-
ordering?: OrderingClauses;
|
|
1090
|
-
/** Paging parameters. */
|
|
1091
|
-
paging?: SearchPaging;
|
|
1092
|
-
/** Language to search in. */
|
|
1093
|
-
language?: string | null;
|
|
1094
|
-
/** Filter in platformized query language (for example {'field': {'$eq': 'value'}}) */
|
|
1095
|
-
filter?: Record<string, any> | null;
|
|
1096
|
-
/** The facets to retrieve. */
|
|
1097
|
-
facets?: FacetClauses;
|
|
1098
|
-
/** Enable fuzzy search (eg. query 'kalvin clein' will match document with 'calvin klein' in title). */
|
|
1099
|
-
fuzzy?: boolean | null;
|
|
1100
|
-
/** Highlight texts matching the query. Highlighted text will be wrapped with <mark/> tag. Defaults to true if not provided. */
|
|
1101
|
-
highlight?: boolean | null;
|
|
1102
|
-
/** Searchable fields to search in. If not provided, search is executed on all searchable fields in schema */
|
|
1103
|
-
searchFields?: string[];
|
|
1104
|
-
/** A list of fields to include in the result set. If not provided, all fields of schema will be included. */
|
|
1105
|
-
fields?: string[];
|
|
1106
|
-
/** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`, `result-format`. */
|
|
1107
|
-
properties?: SearchProperty[];
|
|
1108
|
-
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
1109
|
-
includeSeoHidden?: boolean | null;
|
|
1110
|
-
}
|
|
1111
|
-
interface OrderingClauses {
|
|
1112
|
-
ordering?: OrderingClause[];
|
|
1113
|
-
}
|
|
1114
|
-
interface OrderingClause {
|
|
1115
|
-
fieldName?: string | null;
|
|
1116
|
-
direction?: Direction;
|
|
1117
|
-
}
|
|
1118
|
-
declare enum Direction {
|
|
1119
|
-
UninitializedDirection = "UninitializedDirection",
|
|
1120
|
-
ASC = "ASC",
|
|
1121
|
-
DESC = "DESC"
|
|
1122
|
-
}
|
|
1123
|
-
interface SearchPaging {
|
|
1124
|
-
/**
|
|
1125
|
-
* Number of items to skip in the result set.
|
|
1126
|
-
* @deprecated
|
|
1127
|
-
*/
|
|
1128
|
-
skip?: number;
|
|
1129
|
-
/** Number of items to fetch (effectively page size). */
|
|
1130
|
-
limit?: number;
|
|
1131
|
-
/** Number of items to skip in the result set. */
|
|
1132
|
-
offset?: number;
|
|
1133
|
-
}
|
|
1134
|
-
interface FacetClauses {
|
|
1135
|
-
/** Each entry represents a single facet with parameters. */
|
|
1136
|
-
clauses?: FacetClause[];
|
|
1137
|
-
}
|
|
1138
|
-
interface FacetClause extends FacetClauseClauseOneOf {
|
|
1139
|
-
term?: TermFacet;
|
|
1140
|
-
aggregation?: AggregationFacet;
|
|
1141
|
-
hierarchical?: HierarchicalFacet;
|
|
1142
|
-
}
|
|
1143
|
-
/** @oneof */
|
|
1144
|
-
interface FacetClauseClauseOneOf {
|
|
1145
|
-
term?: TermFacet;
|
|
1146
|
-
aggregation?: AggregationFacet;
|
|
1147
|
-
hierarchical?: HierarchicalFacet;
|
|
1148
|
-
}
|
|
1149
|
-
declare enum Aggregation {
|
|
1150
|
-
MIN = "MIN",
|
|
1151
|
-
MAX = "MAX",
|
|
1152
|
-
SUM = "SUM"
|
|
1153
|
-
}
|
|
1154
|
-
interface HierarchicalFacet extends HierarchicalFacetClauseOneOf {
|
|
1155
|
-
term?: TermFacet;
|
|
1156
|
-
aggregation?: AggregationFacet;
|
|
1157
|
-
nestedAggregation?: HierarchicalFacet;
|
|
1158
|
-
}
|
|
1159
|
-
/** @oneof */
|
|
1160
|
-
interface HierarchicalFacetClauseOneOf {
|
|
1161
|
-
term?: TermFacet;
|
|
1162
|
-
aggregation?: AggregationFacet;
|
|
1163
|
-
}
|
|
1164
|
-
interface TermFacet {
|
|
1165
|
-
/** The name of the faceted attribute. */
|
|
1166
|
-
name?: string;
|
|
1167
|
-
/** Limit the number of facet values returned. Default is 10. */
|
|
1168
|
-
limit?: number | null;
|
|
1169
|
-
}
|
|
1170
|
-
interface AggregationFacet {
|
|
1171
|
-
/** The name of the faceted attribute. */
|
|
1172
|
-
name?: string;
|
|
1173
|
-
/** Aggregation type. */
|
|
1174
|
-
aggregation?: Aggregation;
|
|
1175
|
-
}
|
|
1176
|
-
interface SearchProperty {
|
|
1177
|
-
name?: string;
|
|
1178
|
-
value?: any;
|
|
1179
|
-
}
|
|
1180
|
-
interface SearchResponse {
|
|
1181
|
-
/** Documents matching filter and query. */
|
|
1182
|
-
documents?: Record<string, any>[] | null;
|
|
1183
|
-
nextPage?: NextPageResponse;
|
|
1184
|
-
/**
|
|
1185
|
-
* Facets provide "counts in categories" view. For example searching for "Nike" would return
|
|
1186
|
-
* (Shoes, 5), (Socks, 2) indicating numbers for matching by each faceted field.
|
|
1187
|
-
*/
|
|
1188
|
-
facets?: FacetsResponse[];
|
|
1189
|
-
}
|
|
1190
|
-
interface NextPageResponse {
|
|
1191
|
-
/** Total number of items across all pages */
|
|
1192
|
-
total?: number;
|
|
1193
|
-
/** The number of items to skip */
|
|
1194
|
-
skip?: number;
|
|
1195
|
-
/** The number of items to retrieve in one page */
|
|
1196
|
-
limit?: number;
|
|
1197
|
-
}
|
|
1198
|
-
interface FacetsResponse extends FacetsResponseResponseOneOf {
|
|
1199
|
-
terms?: TermAggregationResponse;
|
|
1200
|
-
minAggregation?: MinAggregationResponse;
|
|
1201
|
-
maxAggregation?: MaxAggregationResponse;
|
|
1202
|
-
minMaxAggregation?: MinMaxAggregationResponse;
|
|
1203
|
-
hierarchicalAggregation?: HierarchicalAggregationResponse;
|
|
1204
|
-
sumAggregation?: SumAggregationResponse;
|
|
1205
|
-
}
|
|
1206
|
-
/** @oneof */
|
|
1207
|
-
interface FacetsResponseResponseOneOf {
|
|
1208
|
-
terms?: TermAggregationResponse;
|
|
1209
|
-
minAggregation?: MinAggregationResponse;
|
|
1210
|
-
maxAggregation?: MaxAggregationResponse;
|
|
1211
|
-
minMaxAggregation?: MinMaxAggregationResponse;
|
|
1212
|
-
hierarchicalAggregation?: HierarchicalAggregationResponse;
|
|
1213
|
-
sumAggregation?: SumAggregationResponse;
|
|
1214
|
-
}
|
|
1215
|
-
interface FacetCountResponse {
|
|
1216
|
-
/** Facet field value (for example "Shoes", "Socks") */
|
|
1217
|
-
facetValue?: string;
|
|
1218
|
-
/** Document count within the group */
|
|
1219
|
-
count?: number;
|
|
1220
|
-
}
|
|
1221
|
-
interface Value {
|
|
1222
|
-
value?: string;
|
|
1223
|
-
facets?: FacetsResponse;
|
|
1224
|
-
count?: number;
|
|
1225
|
-
}
|
|
1226
|
-
interface TermAggregationResponse {
|
|
1227
|
-
/** Facet field (for example productCategory) */
|
|
1228
|
-
facet?: string;
|
|
1229
|
-
/** Facet values and document counts */
|
|
1230
|
-
facets?: FacetCountResponse[];
|
|
1231
|
-
}
|
|
1232
|
-
interface MinAggregationResponse {
|
|
1233
|
-
/** Facet field (for example productPrice) */
|
|
1234
|
-
facet?: string;
|
|
1235
|
-
/** The minimum value across all documents */
|
|
1236
|
-
minValue?: number | null;
|
|
1237
|
-
}
|
|
1238
|
-
interface MaxAggregationResponse {
|
|
1239
|
-
/** Facet field (for example productPrice) */
|
|
1240
|
-
facet?: string;
|
|
1241
|
-
/** The maximum value across all documents */
|
|
1242
|
-
maxValue?: number | null;
|
|
1243
|
-
}
|
|
1244
|
-
interface MinMaxAggregationResponse {
|
|
1245
|
-
/** Facet field (for example productPrice) */
|
|
1246
|
-
facet?: string;
|
|
1247
|
-
/** The minimum value across all documents */
|
|
1248
|
-
minValue?: number | null;
|
|
1249
|
-
/** The maximum value across all documents */
|
|
1250
|
-
maxValue?: number | null;
|
|
1251
|
-
}
|
|
1252
|
-
interface HierarchicalAggregationResponse {
|
|
1253
|
-
facet?: string;
|
|
1254
|
-
values?: Value[];
|
|
1255
|
-
}
|
|
1256
|
-
interface SumAggregationResponse {
|
|
1257
|
-
/** Facet field (for example productPrice) */
|
|
1258
|
-
facet?: string;
|
|
1259
|
-
/** The sum value across all documents */
|
|
1260
|
-
value?: number | null;
|
|
1261
|
-
}
|
|
1262
|
-
interface FederatedSearchRequest {
|
|
1263
|
-
/** Query phrase to use. */
|
|
1264
|
-
query?: string | null;
|
|
1265
|
-
/** Language to search in. */
|
|
1266
|
-
language?: string | null;
|
|
1267
|
-
/** Limit of documents to return per document type. */
|
|
1268
|
-
limit?: number | null;
|
|
1269
|
-
/** Enable fuzzy search (for example query 'kalvin clein' will match document with 'calvin klein' in title). */
|
|
1270
|
-
fuzzy?: boolean | null;
|
|
1271
|
-
/** Highlight texts matching the query. Highlighted text will be wrapped with <mark/> tag. Defaults to true if not provided. */
|
|
1272
|
-
highlight?: boolean | null;
|
|
1273
|
-
/** Searchable fields to search in. If not provided, search is executed on all searchable fields in schemas */
|
|
1274
|
-
searchFields?: string[];
|
|
1275
|
-
/** Document types to search in. If not provided, search is executed on all document types enabled for the site */
|
|
1276
|
-
documentTypes?: string[];
|
|
1277
|
-
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
1278
|
-
includeSeoHidden?: boolean | null;
|
|
1279
|
-
/** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`, `result-format`. */
|
|
1280
|
-
properties?: SearchProperty[];
|
|
1281
|
-
}
|
|
1282
|
-
interface FederatedSearchResponse {
|
|
1283
|
-
/** Search results from multiple indexes. */
|
|
1284
|
-
results?: FederatedSearchDocuments[];
|
|
1285
|
-
}
|
|
1286
|
-
interface FederatedSearchDocuments {
|
|
1287
|
-
/** Document type of documents */
|
|
1288
|
-
documentType?: string | null;
|
|
1289
|
-
/** Documents of document type */
|
|
1290
|
-
documents?: Record<string, any>[] | null;
|
|
1291
|
-
/** Total count of matching documents for document type */
|
|
1292
|
-
total?: number;
|
|
1293
|
-
}
|
|
1294
|
-
interface SuggestRequest {
|
|
1295
|
-
/** Text to search for. Fields configured in suggester configuration will be searched. */
|
|
1296
|
-
query?: string | null;
|
|
1297
|
-
/** Document type of documents to search for. All document types are searched if not provided. */
|
|
1298
|
-
documentType?: string | null;
|
|
1299
|
-
/** Fields to order by. */
|
|
1300
|
-
ordering?: OrderingClauses;
|
|
1301
|
-
/** Number of suggested document to return. */
|
|
1302
|
-
limit?: number;
|
|
1303
|
-
/** Language to search in. */
|
|
1304
|
-
language?: string | null;
|
|
1305
|
-
/** Filter in platformized query language (for example {'field': {'$eq': 'value'}}) */
|
|
1306
|
-
filter?: Record<string, any> | null;
|
|
1307
|
-
/** Searchable fields to search in. If not provided, search is executed on all suggestable fields in schema */
|
|
1308
|
-
searchFields?: string[];
|
|
1309
|
-
/** A list of fields to include in the result set. If not provided, all fields of schema will be included. */
|
|
1310
|
-
fields?: string[];
|
|
1311
|
-
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
1312
|
-
includeSeoHidden?: boolean | null;
|
|
1313
|
-
/** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`, `result-format`. */
|
|
1314
|
-
properties?: SearchProperty[];
|
|
1315
|
-
}
|
|
1316
|
-
interface SuggestResponse {
|
|
1317
|
-
/** Suggested documents. */
|
|
1318
|
-
documents?: Record<string, any>[] | null;
|
|
1319
|
-
}
|
|
1320
|
-
interface FederatedSuggestRequest {
|
|
1321
|
-
/** Text to search for. Fields configured in suggester configuration will be searched. */
|
|
1322
|
-
query?: string | null;
|
|
1323
|
-
/** Language to search in. */
|
|
1324
|
-
language?: string | null;
|
|
1325
|
-
/** Number of suggested document to return per document type. */
|
|
1326
|
-
limit?: number;
|
|
1327
|
-
/** Searchable fields to search in. If not provided, search is executed on all suggestable fields in schemas */
|
|
1328
|
-
searchFields?: string[];
|
|
1329
|
-
/** Document types to search in. If not provided, search is executed on all document types enabled for the site */
|
|
1330
|
-
documentTypes?: string[];
|
|
1331
|
-
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
1332
|
-
includeSeoHidden?: boolean | null;
|
|
1333
|
-
/** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`, `result-format`. */
|
|
1334
|
-
properties?: SearchProperty[];
|
|
1335
|
-
}
|
|
1336
|
-
interface FederatedSuggestResponse {
|
|
1337
|
-
/** Suggest results from multiple indexes. */
|
|
1338
|
-
results?: FederatedSuggestDocuments[];
|
|
1339
|
-
}
|
|
1340
|
-
interface FederatedSuggestDocuments {
|
|
1341
|
-
/** Document type of documents */
|
|
1342
|
-
documentType?: string | null;
|
|
1343
|
-
/** Documents of document type */
|
|
1344
|
-
documents?: Record<string, any>[] | null;
|
|
1345
|
-
}
|
|
1346
|
-
interface RelatedRequest {
|
|
1347
|
-
/** ID of the document to fetch related documents for. */
|
|
1348
|
-
documentId?: string | null;
|
|
1349
|
-
/** Document type of the document. */
|
|
1350
|
-
documentType?: string | null;
|
|
1351
|
-
/** Fields to order by. */
|
|
1352
|
-
ordering?: OrderingClauses;
|
|
1353
|
-
/** Language to search in. */
|
|
1354
|
-
language?: string | null;
|
|
1355
|
-
/** Filter in platformized query language (for example {'field': {'$eq': 'value'}}). */
|
|
1356
|
-
filter?: Record<string, any> | null;
|
|
1357
|
-
/** Searchable fields to compare documents by. If not provided, all searchable fields in schema are used */
|
|
1358
|
-
searchFields?: string[];
|
|
1359
|
-
/** A list of fields to include in the result set. If not provided, all fields of schema will be included. */
|
|
1360
|
-
fields?: string[];
|
|
1361
|
-
/** Number of related documents to return */
|
|
1362
|
-
limit?: number;
|
|
1363
|
-
/** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`. */
|
|
1364
|
-
properties?: SearchProperty[];
|
|
1365
|
-
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
1366
|
-
includeSeoHidden?: boolean | null;
|
|
1367
|
-
}
|
|
1368
|
-
interface RelatedResponse {
|
|
1369
|
-
/** Documents matching filter and query. */
|
|
1370
|
-
documents?: Record<string, any>[] | null;
|
|
1371
|
-
}
|
|
1372
|
-
interface AutocompleteRequest {
|
|
1373
|
-
/** Query phrase to fetch completions for. */
|
|
1374
|
-
query?: string | null;
|
|
1375
|
-
/** Document type to use to search for phrases. */
|
|
1376
|
-
documentType?: string | null;
|
|
1377
|
-
/** Limit of phrases to fetch. */
|
|
1378
|
-
limit?: number;
|
|
1379
|
-
/** Language to search in. */
|
|
1380
|
-
language?: string | null;
|
|
1381
|
-
/** Filter in platfromized query language (for example {'field': {'$eq': 'value'}}) */
|
|
1382
|
-
filter?: Record<string, any> | null;
|
|
1383
|
-
/** Searchable fields to use for query completion. If not provided, all searchable fields in schema are used */
|
|
1384
|
-
searchFields?: string[];
|
|
1385
|
-
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
1386
|
-
includeSeoHidden?: boolean | null;
|
|
1387
|
-
}
|
|
1388
|
-
interface AutocompleteResponse {
|
|
1389
|
-
/** Suggested phrases. */
|
|
1390
|
-
values?: AutocompleteResponseValue[];
|
|
1391
|
-
}
|
|
1392
|
-
interface AutocompleteResponseValue {
|
|
1393
|
-
/** Suggested phrase. */
|
|
1394
|
-
query?: string;
|
|
1395
|
-
}
|
|
1396
|
-
interface FederatedAutocompleteRequest {
|
|
1397
|
-
/** Query phrase to fetch completions for. */
|
|
1398
|
-
query?: string | null;
|
|
1399
|
-
/** Language to search in. */
|
|
1400
|
-
language?: string | null;
|
|
1401
|
-
/** Number of queries to return per document type. */
|
|
1402
|
-
limit?: number;
|
|
1403
|
-
/** Searchable fields to search in. If not provided, search is executed on all autocompletable fields in schemas */
|
|
1404
|
-
searchFields?: string[];
|
|
1405
|
-
/** Document types to autocomplete in. If not provided, autocomplete is executed on all document types enabled for the site */
|
|
1406
|
-
documentTypes?: string[];
|
|
1407
|
-
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
1408
|
-
includeSeoHidden?: boolean | null;
|
|
1409
|
-
}
|
|
1410
|
-
interface FederatedAutocompleteResponse {
|
|
1411
|
-
/** Suggested phrases from multiple indexes */
|
|
1412
|
-
results?: FederatedAutocompleteResults[];
|
|
1413
|
-
}
|
|
1414
|
-
interface FederatedAutocompleteResults {
|
|
1415
|
-
/** Document type of queries */
|
|
1416
|
-
documentType?: string | null;
|
|
1417
|
-
/** Suggested phrases */
|
|
1418
|
-
values?: AutocompleteResponseValue[];
|
|
1419
|
-
}
|
|
1420
|
-
interface TrendingRequest {
|
|
1421
|
-
documentTypes?: string[];
|
|
1422
|
-
language?: string | null;
|
|
1423
|
-
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
1424
|
-
includeSeoHidden?: boolean | null;
|
|
1425
|
-
/** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`, `result-format`. */
|
|
1426
|
-
properties?: SearchProperty[];
|
|
1427
|
-
}
|
|
1428
|
-
interface TrendingResponse {
|
|
1429
|
-
results?: TrendingItems[];
|
|
1430
|
-
}
|
|
1431
|
-
interface TrendingItems {
|
|
1432
|
-
documentType?: string;
|
|
1433
|
-
documents?: Record<string, any>[] | null;
|
|
1434
|
-
}
|
|
1435
|
-
interface NextPageResponseNonNullableFields {
|
|
1436
|
-
total: number;
|
|
1437
|
-
skip: number;
|
|
1438
|
-
limit: number;
|
|
1439
|
-
}
|
|
1440
|
-
interface FacetCountResponseNonNullableFields {
|
|
1441
|
-
facetValue: string;
|
|
1442
|
-
count: number;
|
|
1443
|
-
}
|
|
1444
|
-
interface TermAggregationResponseNonNullableFields {
|
|
1445
|
-
facet: string;
|
|
1446
|
-
facets: FacetCountResponseNonNullableFields[];
|
|
1447
|
-
}
|
|
1448
|
-
interface MinAggregationResponseNonNullableFields {
|
|
1449
|
-
facet: string;
|
|
1450
|
-
}
|
|
1451
|
-
interface MaxAggregationResponseNonNullableFields {
|
|
1452
|
-
facet: string;
|
|
1453
|
-
}
|
|
1454
|
-
interface MinMaxAggregationResponseNonNullableFields {
|
|
1455
|
-
facet: string;
|
|
1456
|
-
}
|
|
1457
|
-
interface ValueNonNullableFields {
|
|
1458
|
-
value: string;
|
|
1459
|
-
facets?: FacetsResponseNonNullableFields;
|
|
1460
|
-
count: number;
|
|
1461
|
-
}
|
|
1462
|
-
interface HierarchicalAggregationResponseNonNullableFields {
|
|
1463
|
-
facet: string;
|
|
1464
|
-
values: ValueNonNullableFields[];
|
|
1465
|
-
}
|
|
1466
|
-
interface SumAggregationResponseNonNullableFields {
|
|
1467
|
-
facet: string;
|
|
1468
|
-
}
|
|
1469
|
-
interface FacetsResponseNonNullableFields {
|
|
1470
|
-
terms?: TermAggregationResponseNonNullableFields;
|
|
1471
|
-
minAggregation?: MinAggregationResponseNonNullableFields;
|
|
1472
|
-
maxAggregation?: MaxAggregationResponseNonNullableFields;
|
|
1473
|
-
minMaxAggregation?: MinMaxAggregationResponseNonNullableFields;
|
|
1474
|
-
hierarchicalAggregation?: HierarchicalAggregationResponseNonNullableFields;
|
|
1475
|
-
sumAggregation?: SumAggregationResponseNonNullableFields;
|
|
1476
|
-
}
|
|
1477
|
-
interface SearchResponseNonNullableFields {
|
|
1478
|
-
nextPage?: NextPageResponseNonNullableFields;
|
|
1479
|
-
facets: FacetsResponseNonNullableFields[];
|
|
1480
|
-
}
|
|
1481
|
-
interface FederatedSearchDocumentsNonNullableFields {
|
|
1482
|
-
total: number;
|
|
1483
|
-
}
|
|
1484
|
-
interface FederatedSearchResponseNonNullableFields {
|
|
1485
|
-
results: FederatedSearchDocumentsNonNullableFields[];
|
|
1486
|
-
}
|
|
1487
|
-
interface AutocompleteResponseValueNonNullableFields {
|
|
1488
|
-
query: string;
|
|
1489
|
-
}
|
|
1490
|
-
interface AutocompleteResponseNonNullableFields {
|
|
1491
|
-
values: AutocompleteResponseValueNonNullableFields[];
|
|
1492
|
-
}
|
|
1493
|
-
interface FederatedAutocompleteResultsNonNullableFields {
|
|
1494
|
-
values: AutocompleteResponseValueNonNullableFields[];
|
|
1495
|
-
}
|
|
1496
|
-
interface FederatedAutocompleteResponseNonNullableFields {
|
|
1497
|
-
results: FederatedAutocompleteResultsNonNullableFields[];
|
|
1498
|
-
}
|
|
1499
|
-
interface TrendingItemsNonNullableFields {
|
|
1500
|
-
documentType: string;
|
|
1501
|
-
}
|
|
1502
|
-
interface TrendingResponseNonNullableFields {
|
|
1503
|
-
results: TrendingItemsNonNullableFields[];
|
|
1504
|
-
}
|
|
1505
|
-
interface SearchOptions {
|
|
1506
|
-
/** Text to search for. All searchable fields will be searched. */
|
|
1507
|
-
query?: string | null;
|
|
1508
|
-
/** Document type of documents to search for. All document types are searched if not provided. */
|
|
1509
|
-
documentType?: string | null;
|
|
1510
|
-
/** Fields to order by. */
|
|
1511
|
-
ordering?: OrderingClauses;
|
|
1512
|
-
/** Paging parameters. */
|
|
1513
|
-
paging?: SearchPaging;
|
|
1514
|
-
/** Language to search in. */
|
|
1515
|
-
language?: string | null;
|
|
1516
|
-
/** Filter in platformized query language (for example {'field': {'$eq': 'value'}}) */
|
|
1517
|
-
filter?: Record<string, any> | null;
|
|
1518
|
-
/** The facets to retrieve. */
|
|
1519
|
-
facets?: FacetClauses;
|
|
1520
|
-
/** Enable fuzzy search (eg. query 'kalvin clein' will match document with 'calvin klein' in title). */
|
|
1521
|
-
fuzzy?: boolean | null;
|
|
1522
|
-
/** Highlight texts matching the query. Highlighted text will be wrapped with <mark/> tag. Defaults to true if not provided. */
|
|
1523
|
-
highlight?: boolean | null;
|
|
1524
|
-
/** Searchable fields to search in. If not provided, search is executed on all searchable fields in schema */
|
|
1525
|
-
searchFields?: string[];
|
|
1526
|
-
/** A list of fields to include in the result set. If not provided, all fields of schema will be included. */
|
|
1527
|
-
fields?: string[];
|
|
1528
|
-
/** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`, `result-format`. */
|
|
1529
|
-
properties?: SearchProperty[];
|
|
1530
|
-
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
1531
|
-
includeSeoHidden?: boolean | null;
|
|
1532
|
-
}
|
|
1533
|
-
interface FederatedSearchOptions {
|
|
1534
|
-
/** Query phrase to use. */
|
|
1535
|
-
query?: string | null;
|
|
1536
|
-
/** Language to search in. */
|
|
1537
|
-
language?: string | null;
|
|
1538
|
-
/** Limit of documents to return per document type. */
|
|
1539
|
-
limit?: number | null;
|
|
1540
|
-
/** Enable fuzzy search (for example query 'kalvin clein' will match document with 'calvin klein' in title). */
|
|
1541
|
-
fuzzy?: boolean | null;
|
|
1542
|
-
/** Highlight texts matching the query. Highlighted text will be wrapped with <mark/> tag. Defaults to true if not provided. */
|
|
1543
|
-
highlight?: boolean | null;
|
|
1544
|
-
/** Searchable fields to search in. If not provided, search is executed on all searchable fields in schemas */
|
|
1545
|
-
searchFields?: string[];
|
|
1546
|
-
/** Document types to search in. If not provided, search is executed on all document types enabled for the site */
|
|
1547
|
-
documentTypes?: string[];
|
|
1548
|
-
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
1549
|
-
includeSeoHidden?: boolean | null;
|
|
1550
|
-
/** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`, `result-format`. */
|
|
1551
|
-
properties?: SearchProperty[];
|
|
1552
|
-
}
|
|
1553
|
-
interface SuggestOptions {
|
|
1554
|
-
/** Text to search for. Fields configured in suggester configuration will be searched. */
|
|
1555
|
-
query?: string | null;
|
|
1556
|
-
/** Document type of documents to search for. All document types are searched if not provided. */
|
|
1557
|
-
documentType?: string | null;
|
|
1558
|
-
/** Fields to order by. */
|
|
1559
|
-
ordering?: OrderingClauses;
|
|
1560
|
-
/** Number of suggested document to return. */
|
|
1561
|
-
limit?: number;
|
|
1562
|
-
/** Language to search in. */
|
|
1563
|
-
language?: string | null;
|
|
1564
|
-
/** Filter in platformized query language (for example {'field': {'$eq': 'value'}}) */
|
|
1565
|
-
filter?: Record<string, any> | null;
|
|
1566
|
-
/** Searchable fields to search in. If not provided, search is executed on all suggestable fields in schema */
|
|
1567
|
-
searchFields?: string[];
|
|
1568
|
-
/** A list of fields to include in the result set. If not provided, all fields of schema will be included. */
|
|
1569
|
-
fields?: string[];
|
|
1570
|
-
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
1571
|
-
includeSeoHidden?: boolean | null;
|
|
1572
|
-
/** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`, `result-format`. */
|
|
1573
|
-
properties?: SearchProperty[];
|
|
1574
|
-
}
|
|
1575
|
-
interface FederatedSuggestOptions {
|
|
1576
|
-
/** Text to search for. Fields configured in suggester configuration will be searched. */
|
|
1577
|
-
query?: string | null;
|
|
1578
|
-
/** Language to search in. */
|
|
1579
|
-
language?: string | null;
|
|
1580
|
-
/** Number of suggested document to return per document type. */
|
|
1581
|
-
limit?: number;
|
|
1582
|
-
/** Searchable fields to search in. If not provided, search is executed on all suggestable fields in schemas */
|
|
1583
|
-
searchFields?: string[];
|
|
1584
|
-
/** Document types to search in. If not provided, search is executed on all document types enabled for the site */
|
|
1585
|
-
documentTypes?: string[];
|
|
1586
|
-
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
1587
|
-
includeSeoHidden?: boolean | null;
|
|
1588
|
-
/** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`, `result-format`. */
|
|
1589
|
-
properties?: SearchProperty[];
|
|
1590
|
-
}
|
|
1591
|
-
interface RelatedOptions {
|
|
1592
|
-
/** ID of the document to fetch related documents for. */
|
|
1593
|
-
documentId?: string | null;
|
|
1594
|
-
/** Document type of the document. */
|
|
1595
|
-
documentType?: string | null;
|
|
1596
|
-
/** Fields to order by. */
|
|
1597
|
-
ordering?: OrderingClauses;
|
|
1598
|
-
/** Language to search in. */
|
|
1599
|
-
language?: string | null;
|
|
1600
|
-
/** Filter in platformized query language (for example {'field': {'$eq': 'value'}}). */
|
|
1601
|
-
filter?: Record<string, any> | null;
|
|
1602
|
-
/** Searchable fields to compare documents by. If not provided, all searchable fields in schema are used */
|
|
1603
|
-
searchFields?: string[];
|
|
1604
|
-
/** A list of fields to include in the result set. If not provided, all fields of schema will be included. */
|
|
1605
|
-
fields?: string[];
|
|
1606
|
-
/** Number of related documents to return */
|
|
1607
|
-
limit?: number;
|
|
1608
|
-
/** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`. */
|
|
1609
|
-
properties?: SearchProperty[];
|
|
1610
|
-
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
1611
|
-
includeSeoHidden?: boolean | null;
|
|
1612
|
-
}
|
|
1613
|
-
interface AutocompleteOptions {
|
|
1614
|
-
/** Query phrase to fetch completions for. */
|
|
1615
|
-
query?: string | null;
|
|
1616
|
-
/** Document type to use to search for phrases. */
|
|
1617
|
-
documentType?: string | null;
|
|
1618
|
-
/** Limit of phrases to fetch. */
|
|
1619
|
-
limit?: number;
|
|
1620
|
-
/** Language to search in. */
|
|
1621
|
-
language?: string | null;
|
|
1622
|
-
/** Filter in platfromized query language (for example {'field': {'$eq': 'value'}}) */
|
|
1623
|
-
filter?: Record<string, any> | null;
|
|
1624
|
-
/** Searchable fields to use for query completion. If not provided, all searchable fields in schema are used */
|
|
1625
|
-
searchFields?: string[];
|
|
1626
|
-
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
1627
|
-
includeSeoHidden?: boolean | null;
|
|
1628
|
-
}
|
|
1629
|
-
interface FederatedAutocompleteOptions {
|
|
1630
|
-
/** Query phrase to fetch completions for. */
|
|
1631
|
-
query?: string | null;
|
|
1632
|
-
/** Language to search in. */
|
|
1633
|
-
language?: string | null;
|
|
1634
|
-
/** Number of queries to return per document type. */
|
|
1635
|
-
limit?: number;
|
|
1636
|
-
/** Searchable fields to search in. If not provided, search is executed on all autocompletable fields in schemas */
|
|
1637
|
-
searchFields?: string[];
|
|
1638
|
-
/** Document types to autocomplete in. If not provided, autocomplete is executed on all document types enabled for the site */
|
|
1639
|
-
documentTypes?: string[];
|
|
1640
|
-
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
1641
|
-
includeSeoHidden?: boolean | null;
|
|
1642
|
-
}
|
|
1643
|
-
interface TrendingOptions {
|
|
1644
|
-
documentTypes?: string[];
|
|
1645
|
-
language?: string | null;
|
|
1646
|
-
/** Include seo hidden documents. Defaults to false if not provided. */
|
|
1647
|
-
includeSeoHidden?: boolean | null;
|
|
1648
|
-
/** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`, `result-format`. */
|
|
1649
|
-
properties?: SearchProperty[];
|
|
1650
|
-
}
|
|
1651
|
-
|
|
1652
|
-
declare function search$1(httpClient: HttpClient): SearchSignature;
|
|
1653
|
-
interface SearchSignature {
|
|
1654
|
-
/**
|
|
1655
|
-
* Executes a regular search query.
|
|
1656
|
-
* If you are unsure, this is likely the search method you want to used.
|
|
1657
|
-
*/
|
|
1658
|
-
(options?: SearchOptions | undefined): Promise<SearchResponse & SearchResponseNonNullableFields>;
|
|
1659
|
-
}
|
|
1660
|
-
declare function federatedSearch$1(httpClient: HttpClient): FederatedSearchSignature;
|
|
1661
|
-
interface FederatedSearchSignature {
|
|
1662
|
-
/**
|
|
1663
|
-
* Searches in multiple document types at once.
|
|
1664
|
-
*/
|
|
1665
|
-
(options?: FederatedSearchOptions | undefined): Promise<FederatedSearchResponse & FederatedSearchResponseNonNullableFields>;
|
|
1666
|
-
}
|
|
1667
|
-
declare function suggest$1(httpClient: HttpClient): SuggestSignature;
|
|
1668
|
-
interface SuggestSignature {
|
|
1669
|
-
/**
|
|
1670
|
-
* Executes search query to fetch suggested items. Unlike search query suggest will match
|
|
1671
|
-
* partial phrases (for example "blu" will match documents containing "blue", "blues" and "blunt").
|
|
1672
|
-
* Phrase needs to be at least 3 symbols long. Suggestions can also perform optimisations in search
|
|
1673
|
-
* results and generally do not guarantee the same level of quality as regular Search endpoint.
|
|
1674
|
-
*/
|
|
1675
|
-
(options?: SuggestOptions | undefined): Promise<SuggestResponse>;
|
|
1676
|
-
}
|
|
1677
|
-
declare function federatedSuggest$1(httpClient: HttpClient): FederatedSuggestSignature;
|
|
1678
|
-
interface FederatedSuggestSignature {
|
|
1679
|
-
/**
|
|
1680
|
-
* Searches for suggestions in multiple document types at once.
|
|
1681
|
-
*/
|
|
1682
|
-
(options?: FederatedSuggestOptions | undefined): Promise<FederatedSuggestResponse>;
|
|
1683
|
-
}
|
|
1684
|
-
declare function related$1(httpClient: HttpClient): RelatedSignature;
|
|
1685
|
-
interface RelatedSignature {
|
|
1686
|
-
/**
|
|
1687
|
-
* Fetches documents similar to one single document.
|
|
1688
|
-
* This is typically used to implement "related to" scenarios (for example to fetch related store products when
|
|
1689
|
-
* consumer is already viewing one).
|
|
1690
|
-
*/
|
|
1691
|
-
(options?: RelatedOptions | undefined): Promise<RelatedResponse>;
|
|
1692
|
-
}
|
|
1693
|
-
declare function autocomplete$1(httpClient: HttpClient): AutocompleteSignature;
|
|
1694
|
-
interface AutocompleteSignature {
|
|
1695
|
-
/**
|
|
1696
|
-
* 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.
|
|
1697
|
-
*/
|
|
1698
|
-
(options?: AutocompleteOptions | undefined): Promise<AutocompleteResponse & AutocompleteResponseNonNullableFields>;
|
|
1699
|
-
}
|
|
1700
|
-
declare function federatedAutocomplete$1(httpClient: HttpClient): FederatedAutocompleteSignature;
|
|
1701
|
-
interface FederatedAutocompleteSignature {
|
|
1702
|
-
/**
|
|
1703
|
-
* Provides phrase completion from multiple document types at once
|
|
1704
|
-
*/
|
|
1705
|
-
(options?: FederatedAutocompleteOptions | undefined): Promise<FederatedAutocompleteResponse & FederatedAutocompleteResponseNonNullableFields>;
|
|
1706
|
-
}
|
|
1707
|
-
declare function trending$1(httpClient: HttpClient): TrendingSignature;
|
|
1708
|
-
interface TrendingSignature {
|
|
1709
|
-
/**
|
|
1710
|
-
* Returns trending documents for given document types
|
|
1711
|
-
*/
|
|
1712
|
-
(options?: TrendingOptions | undefined): Promise<TrendingResponse & TrendingResponseNonNullableFields>;
|
|
1713
|
-
}
|
|
1714
|
-
|
|
1715
|
-
declare const search: MaybeContext<BuildRESTFunction<typeof search$1> & typeof search$1>;
|
|
1716
|
-
declare const federatedSearch: MaybeContext<BuildRESTFunction<typeof federatedSearch$1> & typeof federatedSearch$1>;
|
|
1717
|
-
declare const suggest: MaybeContext<BuildRESTFunction<typeof suggest$1> & typeof suggest$1>;
|
|
1718
|
-
declare const federatedSuggest: MaybeContext<BuildRESTFunction<typeof federatedSuggest$1> & typeof federatedSuggest$1>;
|
|
1719
|
-
declare const related: MaybeContext<BuildRESTFunction<typeof related$1> & typeof related$1>;
|
|
1720
|
-
declare const autocomplete: MaybeContext<BuildRESTFunction<typeof autocomplete$1> & typeof autocomplete$1>;
|
|
1721
|
-
declare const federatedAutocomplete: MaybeContext<BuildRESTFunction<typeof federatedAutocomplete$1> & typeof federatedAutocomplete$1>;
|
|
1722
|
-
declare const trending: MaybeContext<BuildRESTFunction<typeof trending$1> & typeof trending$1>;
|
|
1723
|
-
|
|
1724
|
-
type context_Aggregation = Aggregation;
|
|
1725
|
-
declare const context_Aggregation: typeof Aggregation;
|
|
1726
|
-
type context_AggregationFacet = AggregationFacet;
|
|
1727
|
-
type context_AutocompleteOptions = AutocompleteOptions;
|
|
1728
|
-
type context_AutocompleteRequest = AutocompleteRequest;
|
|
1729
|
-
type context_AutocompleteResponse = AutocompleteResponse;
|
|
1730
|
-
type context_AutocompleteResponseNonNullableFields = AutocompleteResponseNonNullableFields;
|
|
1731
|
-
type context_AutocompleteResponseValue = AutocompleteResponseValue;
|
|
1732
|
-
type context_DeleteByFilterOperation = DeleteByFilterOperation;
|
|
1733
|
-
type context_DeleteByIdsOperation = DeleteByIdsOperation;
|
|
1734
|
-
type context_Direction = Direction;
|
|
1735
|
-
declare const context_Direction: typeof Direction;
|
|
1736
|
-
type context_DocumentImage = DocumentImage;
|
|
1737
|
-
type context_DocumentPayload = DocumentPayload;
|
|
1738
|
-
type context_DocumentUpdateOperation = DocumentUpdateOperation;
|
|
1739
|
-
type context_Empty = Empty;
|
|
1740
|
-
type context_Enum = Enum;
|
|
1741
|
-
declare const context_Enum: typeof Enum;
|
|
1742
|
-
type context_FacetClause = FacetClause;
|
|
1743
|
-
type context_FacetClauseClauseOneOf = FacetClauseClauseOneOf;
|
|
1744
|
-
type context_FacetClauses = FacetClauses;
|
|
1745
|
-
type context_FacetCountResponse = FacetCountResponse;
|
|
1746
|
-
type context_FacetsResponse = FacetsResponse;
|
|
1747
|
-
type context_FacetsResponseResponseOneOf = FacetsResponseResponseOneOf;
|
|
1748
|
-
type context_FederatedAutocompleteOptions = FederatedAutocompleteOptions;
|
|
1749
|
-
type context_FederatedAutocompleteRequest = FederatedAutocompleteRequest;
|
|
1750
|
-
type context_FederatedAutocompleteResponse = FederatedAutocompleteResponse;
|
|
1751
|
-
type context_FederatedAutocompleteResponseNonNullableFields = FederatedAutocompleteResponseNonNullableFields;
|
|
1752
|
-
type context_FederatedAutocompleteResults = FederatedAutocompleteResults;
|
|
1753
|
-
type context_FederatedSearchDocuments = FederatedSearchDocuments;
|
|
1754
|
-
type context_FederatedSearchOptions = FederatedSearchOptions;
|
|
1755
|
-
type context_FederatedSearchRequest = FederatedSearchRequest;
|
|
1756
|
-
type context_FederatedSearchResponse = FederatedSearchResponse;
|
|
1757
|
-
type context_FederatedSearchResponseNonNullableFields = FederatedSearchResponseNonNullableFields;
|
|
1758
|
-
type context_FederatedSuggestDocuments = FederatedSuggestDocuments;
|
|
1759
|
-
type context_FederatedSuggestOptions = FederatedSuggestOptions;
|
|
1760
|
-
type context_FederatedSuggestRequest = FederatedSuggestRequest;
|
|
1761
|
-
type context_FederatedSuggestResponse = FederatedSuggestResponse;
|
|
1762
|
-
type context_HierarchicalAggregationResponse = HierarchicalAggregationResponse;
|
|
1763
|
-
type context_HierarchicalFacet = HierarchicalFacet;
|
|
1764
|
-
type context_HierarchicalFacetClauseOneOf = HierarchicalFacetClauseOneOf;
|
|
1765
|
-
type context_IdentificationData = IdentificationData;
|
|
1766
|
-
type context_IdentificationDataIdOneOf = IdentificationDataIdOneOf;
|
|
1767
|
-
type context_IndexDocument = IndexDocument;
|
|
1768
|
-
type context_InternalDocument = InternalDocument;
|
|
1769
|
-
type context_InternalDocumentUpdateByFilterOperation = InternalDocumentUpdateByFilterOperation;
|
|
1770
|
-
type context_InternalDocumentUpdateOperation = InternalDocumentUpdateOperation;
|
|
1771
|
-
type context_InternalUpdateExistingOperation = InternalUpdateExistingOperation;
|
|
1772
|
-
type context_MaxAggregationResponse = MaxAggregationResponse;
|
|
1773
|
-
type context_MessageEnvelope = MessageEnvelope;
|
|
1774
|
-
type context_MinAggregationResponse = MinAggregationResponse;
|
|
1775
|
-
type context_MinMaxAggregationResponse = MinMaxAggregationResponse;
|
|
1776
|
-
type context_NextPageResponse = NextPageResponse;
|
|
1777
|
-
type context_OrderingClause = OrderingClause;
|
|
1778
|
-
type context_OrderingClauses = OrderingClauses;
|
|
1779
|
-
type context_RelatedOptions = RelatedOptions;
|
|
1780
|
-
type context_RelatedRequest = RelatedRequest;
|
|
1781
|
-
type context_RelatedResponse = RelatedResponse;
|
|
1782
|
-
type context_SearchOptions = SearchOptions;
|
|
1783
|
-
type context_SearchPaging = SearchPaging;
|
|
1784
|
-
type context_SearchProperty = SearchProperty;
|
|
1785
|
-
type context_SearchRequest = SearchRequest;
|
|
1786
|
-
type context_SearchResponse = SearchResponse;
|
|
1787
|
-
type context_SearchResponseNonNullableFields = SearchResponseNonNullableFields;
|
|
1788
|
-
type context_SiteDocument = SiteDocument;
|
|
1789
|
-
type context_SuggestOptions = SuggestOptions;
|
|
1790
|
-
type context_SuggestRequest = SuggestRequest;
|
|
1791
|
-
type context_SuggestResponse = SuggestResponse;
|
|
1792
|
-
type context_SumAggregationResponse = SumAggregationResponse;
|
|
1793
|
-
type context_TermAggregationResponse = TermAggregationResponse;
|
|
1794
|
-
type context_TermFacet = TermFacet;
|
|
1795
|
-
type context_TrendingItems = TrendingItems;
|
|
1796
|
-
type context_TrendingOptions = TrendingOptions;
|
|
1797
|
-
type context_TrendingRequest = TrendingRequest;
|
|
1798
|
-
type context_TrendingResponse = TrendingResponse;
|
|
1799
|
-
type context_TrendingResponseNonNullableFields = TrendingResponseNonNullableFields;
|
|
1800
|
-
type context_UpdateByFilterOperation = UpdateByFilterOperation;
|
|
1801
|
-
type context_UpdateDocumentsEvent = UpdateDocumentsEvent;
|
|
1802
|
-
type context_UpdateDocumentsEventOperationOneOf = UpdateDocumentsEventOperationOneOf;
|
|
1803
|
-
type context_UpdateExistingOperation = UpdateExistingOperation;
|
|
1804
|
-
type context_UpdateInternalDocumentsEvent = UpdateInternalDocumentsEvent;
|
|
1805
|
-
type context_UpdateInternalDocumentsEventOperationOneOf = UpdateInternalDocumentsEventOperationOneOf;
|
|
1806
|
-
type context_V1DeleteByFilterOperation = V1DeleteByFilterOperation;
|
|
1807
|
-
type context_V1DeleteByIdsOperation = V1DeleteByIdsOperation;
|
|
1808
|
-
type context_Value = Value;
|
|
1809
|
-
type context_VersionedDeleteByIdsOperation = VersionedDeleteByIdsOperation;
|
|
1810
|
-
type context_VersionedDocumentId = VersionedDocumentId;
|
|
1811
|
-
type context_VersionedDocumentUpdateOperation = VersionedDocumentUpdateOperation;
|
|
1812
|
-
type context_VersioningMode = VersioningMode;
|
|
1813
|
-
declare const context_VersioningMode: typeof VersioningMode;
|
|
1814
|
-
type context_WebhookIdentityType = WebhookIdentityType;
|
|
1815
|
-
declare const context_WebhookIdentityType: typeof WebhookIdentityType;
|
|
1816
|
-
declare const context_autocomplete: typeof autocomplete;
|
|
1817
|
-
declare const context_federatedAutocomplete: typeof federatedAutocomplete;
|
|
1818
|
-
declare const context_federatedSearch: typeof federatedSearch;
|
|
1819
|
-
declare const context_federatedSuggest: typeof federatedSuggest;
|
|
1820
|
-
declare const context_related: typeof related;
|
|
1821
|
-
declare const context_search: typeof search;
|
|
1822
|
-
declare const context_suggest: typeof suggest;
|
|
1823
|
-
declare const context_trending: typeof trending;
|
|
1824
|
-
declare namespace context {
|
|
1825
|
-
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 };
|
|
1826
|
-
}
|
|
1827
|
-
|
|
1828
|
-
export { context as siteSearch, context$1 as wixSiteSearch };
|