@wix/export-async-job 1.0.8 → 1.0.9
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/context.js +1 -0
- package/build/cjs/context.js.map +1 -0
- package/build/cjs/index.js +1 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/meta.js +1 -0
- package/build/cjs/meta.js.map +1 -0
- package/package.json +3 -3
- package/type-bundles/context.bundle.d.ts +448 -126
- package/type-bundles/index.bundle.d.ts +448 -126
|
@@ -1,8 +1,51 @@
|
|
|
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
|
+
|
|
1
43
|
type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
|
|
2
44
|
interface HttpClient {
|
|
3
45
|
request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
|
|
4
46
|
fetchWithAuth: typeof fetch;
|
|
5
47
|
wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
|
|
48
|
+
getActiveToken?: () => string | undefined;
|
|
6
49
|
}
|
|
7
50
|
type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
|
|
8
51
|
type HttpResponse<T = any> = {
|
|
@@ -24,6 +67,65 @@ type APIMetadata = {
|
|
|
24
67
|
packageName?: string;
|
|
25
68
|
};
|
|
26
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;
|
|
27
129
|
|
|
28
130
|
declare global {
|
|
29
131
|
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
|
|
@@ -32,6 +134,348 @@ declare global {
|
|
|
32
134
|
}
|
|
33
135
|
}
|
|
34
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
|
+
|
|
35
479
|
interface ExportAsyncJob {
|
|
36
480
|
/** @readonly */
|
|
37
481
|
_id?: string;
|
|
@@ -773,7 +1217,7 @@ interface Keyword {
|
|
|
773
1217
|
term?: string;
|
|
774
1218
|
/** Whether the keyword is the main focus keyword. */
|
|
775
1219
|
isMain?: boolean;
|
|
776
|
-
/**
|
|
1220
|
+
/** The source that added the keyword terms to the SEO settings. */
|
|
777
1221
|
origin?: string | null;
|
|
778
1222
|
}
|
|
779
1223
|
interface Tag {
|
|
@@ -890,116 +1334,6 @@ interface ProductOrVariantV2 {
|
|
|
890
1334
|
product?: Product;
|
|
891
1335
|
variant?: Variant;
|
|
892
1336
|
}
|
|
893
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
894
|
-
createdEvent?: EntityCreatedEvent;
|
|
895
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
896
|
-
deletedEvent?: EntityDeletedEvent;
|
|
897
|
-
actionEvent?: ActionEvent;
|
|
898
|
-
/**
|
|
899
|
-
* Unique event ID.
|
|
900
|
-
* Allows clients to ignore duplicate webhooks.
|
|
901
|
-
*/
|
|
902
|
-
_id?: string;
|
|
903
|
-
/**
|
|
904
|
-
* Assumes actions are also always typed to an entity_type
|
|
905
|
-
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
906
|
-
*/
|
|
907
|
-
entityFqdn?: string;
|
|
908
|
-
/**
|
|
909
|
-
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
910
|
-
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
911
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
912
|
-
*/
|
|
913
|
-
slug?: string;
|
|
914
|
-
/** ID of the entity associated with the event. */
|
|
915
|
-
entityId?: string;
|
|
916
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
917
|
-
eventTime?: Date;
|
|
918
|
-
/**
|
|
919
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
920
|
-
* (for example, GDPR).
|
|
921
|
-
*/
|
|
922
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
923
|
-
/** If present, indicates the action that triggered the event. */
|
|
924
|
-
originatedFrom?: string | null;
|
|
925
|
-
/**
|
|
926
|
-
* A sequence number defining the order of updates to the underlying entity.
|
|
927
|
-
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
928
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
929
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
930
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
931
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
932
|
-
*/
|
|
933
|
-
entityEventSequence?: string | null;
|
|
934
|
-
}
|
|
935
|
-
/** @oneof */
|
|
936
|
-
interface DomainEventBodyOneOf {
|
|
937
|
-
createdEvent?: EntityCreatedEvent;
|
|
938
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
939
|
-
deletedEvent?: EntityDeletedEvent;
|
|
940
|
-
actionEvent?: ActionEvent;
|
|
941
|
-
}
|
|
942
|
-
interface EntityCreatedEvent {
|
|
943
|
-
entity?: string;
|
|
944
|
-
}
|
|
945
|
-
interface RestoreInfo {
|
|
946
|
-
deletedDate?: Date;
|
|
947
|
-
}
|
|
948
|
-
interface EntityUpdatedEvent {
|
|
949
|
-
/**
|
|
950
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
951
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
952
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
953
|
-
*/
|
|
954
|
-
currentEntity?: string;
|
|
955
|
-
}
|
|
956
|
-
interface EntityDeletedEvent {
|
|
957
|
-
/** Entity that was deleted */
|
|
958
|
-
deletedEntity?: string | null;
|
|
959
|
-
}
|
|
960
|
-
interface ActionEvent {
|
|
961
|
-
body?: string;
|
|
962
|
-
}
|
|
963
|
-
interface MessageEnvelope {
|
|
964
|
-
/** App instance ID. */
|
|
965
|
-
instanceId?: string | null;
|
|
966
|
-
/** Event type. */
|
|
967
|
-
eventType?: string;
|
|
968
|
-
/** The identification type and identity data. */
|
|
969
|
-
identity?: IdentificationData;
|
|
970
|
-
/** Stringify payload. */
|
|
971
|
-
data?: string;
|
|
972
|
-
}
|
|
973
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
974
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
975
|
-
anonymousVisitorId?: string;
|
|
976
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
977
|
-
memberId?: string;
|
|
978
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
979
|
-
wixUserId?: string;
|
|
980
|
-
/** ID of an app. */
|
|
981
|
-
appId?: string;
|
|
982
|
-
/** @readonly */
|
|
983
|
-
identityType?: WebhookIdentityType;
|
|
984
|
-
}
|
|
985
|
-
/** @oneof */
|
|
986
|
-
interface IdentificationDataIdOneOf {
|
|
987
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
988
|
-
anonymousVisitorId?: string;
|
|
989
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
990
|
-
memberId?: string;
|
|
991
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
992
|
-
wixUserId?: string;
|
|
993
|
-
/** ID of an app. */
|
|
994
|
-
appId?: string;
|
|
995
|
-
}
|
|
996
|
-
declare enum WebhookIdentityType {
|
|
997
|
-
UNKNOWN = "UNKNOWN",
|
|
998
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
999
|
-
MEMBER = "MEMBER",
|
|
1000
|
-
WIX_USER = "WIX_USER",
|
|
1001
|
-
APP = "APP"
|
|
1002
|
-
}
|
|
1003
1337
|
interface SortingNonNullableFields {
|
|
1004
1338
|
fieldName: string;
|
|
1005
1339
|
order: SortOrder;
|
|
@@ -1094,10 +1428,9 @@ interface GetExportAsyncJobSignature {
|
|
|
1094
1428
|
(jobId: string): Promise<ExportAsyncJob & ExportAsyncJobNonNullableFields>;
|
|
1095
1429
|
}
|
|
1096
1430
|
|
|
1097
|
-
declare const createExportAsyncJob: BuildRESTFunction<typeof createExportAsyncJob$1> & typeof createExportAsyncJob$1
|
|
1098
|
-
declare const getExportAsyncJob: BuildRESTFunction<typeof getExportAsyncJob$1> & typeof getExportAsyncJob$1
|
|
1431
|
+
declare const createExportAsyncJob: MaybeContext<BuildRESTFunction<typeof createExportAsyncJob$1> & typeof createExportAsyncJob$1>;
|
|
1432
|
+
declare const getExportAsyncJob: MaybeContext<BuildRESTFunction<typeof getExportAsyncJob$1> & typeof getExportAsyncJob$1>;
|
|
1099
1433
|
|
|
1100
|
-
type context_ActionEvent = ActionEvent;
|
|
1101
1434
|
type context_AdditionalInfoSection = AdditionalInfoSection;
|
|
1102
1435
|
type context_ApplicationError = ApplicationError;
|
|
1103
1436
|
type context_ArrayFieldDelimiter = ArrayFieldDelimiter;
|
|
@@ -1117,11 +1450,6 @@ type context_DetailsKindOneOf = DetailsKindOneOf;
|
|
|
1117
1450
|
type context_Discount = Discount;
|
|
1118
1451
|
type context_DiscountType = DiscountType;
|
|
1119
1452
|
declare const context_DiscountType: typeof DiscountType;
|
|
1120
|
-
type context_DomainEvent = DomainEvent;
|
|
1121
|
-
type context_DomainEventBodyOneOf = DomainEventBodyOneOf;
|
|
1122
|
-
type context_EntityCreatedEvent = EntityCreatedEvent;
|
|
1123
|
-
type context_EntityDeletedEvent = EntityDeletedEvent;
|
|
1124
|
-
type context_EntityUpdatedEvent = EntityUpdatedEvent;
|
|
1125
1453
|
type context_ExportAsyncJob = ExportAsyncJob;
|
|
1126
1454
|
type context_ExportAsyncJobData = ExportAsyncJobData;
|
|
1127
1455
|
type context_ExportAsyncJobNonNullableFields = ExportAsyncJobNonNullableFields;
|
|
@@ -1138,8 +1466,6 @@ type context_GenerateExportAsyncJobDownloadUrlResponse = GenerateExportAsyncJobD
|
|
|
1138
1466
|
type context_GetExportAsyncJobRequest = GetExportAsyncJobRequest;
|
|
1139
1467
|
type context_GetExportAsyncJobResponse = GetExportAsyncJobResponse;
|
|
1140
1468
|
type context_GetExportAsyncJobResponseNonNullableFields = GetExportAsyncJobResponseNonNullableFields;
|
|
1141
|
-
type context_IdentificationData = IdentificationData;
|
|
1142
|
-
type context_IdentificationDataIdOneOf = IdentificationDataIdOneOf;
|
|
1143
1469
|
type context_InventoryStatus = InventoryStatus;
|
|
1144
1470
|
declare const context_InventoryStatus: typeof InventoryStatus;
|
|
1145
1471
|
type context_Keyword = Keyword;
|
|
@@ -1152,7 +1478,6 @@ type context_MediaItemType = MediaItemType;
|
|
|
1152
1478
|
declare const context_MediaItemType: typeof MediaItemType;
|
|
1153
1479
|
type context_MediaItemUrlAndSize = MediaItemUrlAndSize;
|
|
1154
1480
|
type context_MediaItemVideo = MediaItemVideo;
|
|
1155
|
-
type context_MessageEnvelope = MessageEnvelope;
|
|
1156
1481
|
type context_MethodMetadata = MethodMetadata;
|
|
1157
1482
|
type context_MethodSpec = MethodSpec;
|
|
1158
1483
|
type context_NumericPropertyRange = NumericPropertyRange;
|
|
@@ -1177,7 +1502,6 @@ declare const context_QueryFieldNumber: typeof QueryFieldNumber;
|
|
|
1177
1502
|
type context_QueryProductsExportSpiResponse = QueryProductsExportSpiResponse;
|
|
1178
1503
|
type context_QueryRequestLoose = QueryRequestLoose;
|
|
1179
1504
|
type context_QueryVariantsExportSpiResponse = QueryVariantsExportSpiResponse;
|
|
1180
|
-
type context_RestoreInfo = RestoreInfo;
|
|
1181
1505
|
type context_Ribbon = Ribbon;
|
|
1182
1506
|
type context_RuleType = RuleType;
|
|
1183
1507
|
declare const context_RuleType: typeof RuleType;
|
|
@@ -1198,12 +1522,10 @@ type context_Variant = Variant;
|
|
|
1198
1522
|
type context_VariantDataWithNoStock = VariantDataWithNoStock;
|
|
1199
1523
|
type context_VariantStock = VariantStock;
|
|
1200
1524
|
type context_VideoResolution = VideoResolution;
|
|
1201
|
-
type context_WebhookIdentityType = WebhookIdentityType;
|
|
1202
|
-
declare const context_WebhookIdentityType: typeof WebhookIdentityType;
|
|
1203
1525
|
declare const context_createExportAsyncJob: typeof createExportAsyncJob;
|
|
1204
1526
|
declare const context_getExportAsyncJob: typeof getExportAsyncJob;
|
|
1205
1527
|
declare namespace context {
|
|
1206
|
-
export { type
|
|
1528
|
+
export { type context_AdditionalInfoSection as AdditionalInfoSection, type context_ApplicationError as ApplicationError, context_ArrayFieldDelimiter as ArrayFieldDelimiter, type context_CancelExportAsyncJobRequest as CancelExportAsyncJobRequest, type context_CancelExportAsyncJobResponse as CancelExportAsyncJobResponse, type context_Choice as Choice, type context_CostAndProfitData as CostAndProfitData, type context_CreateExportAsyncJobOptions as CreateExportAsyncJobOptions, type context_CreateExportAsyncJobRequest as CreateExportAsyncJobRequest, type context_CreateExportAsyncJobResponse as CreateExportAsyncJobResponse, type context_CreateExportAsyncJobResponseNonNullableFields as CreateExportAsyncJobResponseNonNullableFields, type context_Cursors as Cursors, type context_CustomTextField as CustomTextField, type context_Details as Details, type context_DetailsKindOneOf as DetailsKindOneOf, type context_Discount as Discount, context_DiscountType as DiscountType, type context_ExportAsyncJob as ExportAsyncJob, type context_ExportAsyncJobData as ExportAsyncJobData, type context_ExportAsyncJobNonNullableFields as ExportAsyncJobNonNullableFields, type context_ExportCursorPaging as ExportCursorPaging, type context_ExportQueryV2 as ExportQueryV2, type context_ExportQueryV2PagingMethodOneOf as ExportQueryV2PagingMethodOneOf, type context_FieldDescriptor as FieldDescriptor, type context_FieldViolation as FieldViolation, context_FileType as FileType, type context_FormattedPrice as FormattedPrice, type context_GenerateExportAsyncJobDownloadUrlRequest as GenerateExportAsyncJobDownloadUrlRequest, type context_GenerateExportAsyncJobDownloadUrlResponse as GenerateExportAsyncJobDownloadUrlResponse, type context_GetExportAsyncJobRequest as GetExportAsyncJobRequest, type context_GetExportAsyncJobResponse as GetExportAsyncJobResponse, type context_GetExportAsyncJobResponseNonNullableFields as GetExportAsyncJobResponseNonNullableFields, context_InventoryStatus as InventoryStatus, type context_Keyword as Keyword, context_MeasurementUnit as MeasurementUnit, type context_Media as Media, type context_MediaItem as MediaItem, type context_MediaItemItemOneOf as MediaItemItemOneOf, context_MediaItemType as MediaItemType, type context_MediaItemUrlAndSize as MediaItemUrlAndSize, type context_MediaItemVideo as MediaItemVideo, type context_MethodMetadata as MethodMetadata, type context_MethodSpec as MethodSpec, type context_NumericPropertyRange as NumericPropertyRange, context_OptionType as OptionType, type context_PageUrl as PageUrl, type context_Paging as Paging, type context_PagingMetadataV2 as PagingMetadataV2, type context_PlatformMedia as PlatformMedia, type context_PlatformMediaMediaOneOf as PlatformMediaMediaOneOf, type context_PreorderInfo as PreorderInfo, type context_PriceData as PriceData, type context_PricePerUnitData as PricePerUnitData, type context_Product as Product, type context_ProductOption as ProductOption, type context_ProductOrVariant as ProductOrVariant, type context_ProductOrVariantV2 as ProductOrVariantV2, context_ProductType as ProductType, context_QueryFieldNumber as QueryFieldNumber, type context_QueryProductsExportSpiResponse as QueryProductsExportSpiResponse, type context_QueryRequestLoose as QueryRequestLoose, type context_QueryVariantsExportSpiResponse as QueryVariantsExportSpiResponse, type context_Ribbon as Ribbon, context_RuleType as RuleType, type context_SecuredMedia as SecuredMedia, type context_SeoSchema as SeoSchema, type context_Settings as Settings, context_SortOrder as SortOrder, type context_Sorting as Sorting, context_Status as Status, type context_Stock as Stock, type context_StoreVariant as StoreVariant, type context_SystemError as SystemError, type context_Tag as Tag, type context_ValidationError as ValidationError, type context_Variant as Variant, type context_VariantDataWithNoStock as VariantDataWithNoStock, type context_VariantStock as VariantStock, type context_VideoResolution as VideoResolution, context_createExportAsyncJob as createExportAsyncJob, context_getExportAsyncJob as getExportAsyncJob };
|
|
1207
1529
|
}
|
|
1208
1530
|
|
|
1209
1531
|
export { context as exportAsyncJob };
|