@wix/seatings 1.0.14 → 1.0.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,39 +1,127 @@
1
- type RESTFunctionDescriptor$1<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient$1) => T;
2
- interface HttpClient$1 {
3
- request<TResponse, TData = any>(req: RequestOptionsFactory$1<TResponse, TData>): Promise<HttpResponse$1<TResponse>>;
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 bast url to use for API requests, for example `www.wixapis.com`
17
+ */
18
+ apiBaseUrl?: string;
19
+ /**
20
+ * Possible data to be provided by every host, for cross cutting concerns
21
+ * like internationalization, billing, etc.
22
+ */
23
+ essentials?: {
24
+ /**
25
+ * The language of the currently viewed session
26
+ */
27
+ language?: string;
28
+ /**
29
+ * The locale of the currently viewed session
30
+ */
31
+ locale?: string;
32
+ /**
33
+ * Any headers that should be passed through to the API requests
34
+ */
35
+ passThroughHeaders?: Record<string, string>;
36
+ };
37
+ };
38
+
39
+ type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
40
+ interface HttpClient {
41
+ request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
4
42
  fetchWithAuth: typeof fetch;
5
43
  wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
44
+ getActiveToken?: () => string | undefined;
6
45
  }
7
- type RequestOptionsFactory$1<TResponse = any, TData = any> = (context: any) => RequestOptions$1<TResponse, TData>;
8
- type HttpResponse$1<T = any> = {
46
+ type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
47
+ type HttpResponse<T = any> = {
9
48
  data: T;
10
49
  status: number;
11
50
  statusText: string;
12
51
  headers: any;
13
52
  request?: any;
14
53
  };
15
- type RequestOptions$1<_TResponse = any, Data = any> = {
54
+ type RequestOptions<_TResponse = any, Data = any> = {
16
55
  method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
17
56
  url: string;
18
57
  data?: Data;
19
58
  params?: URLSearchParams;
20
- } & APIMetadata$1;
21
- type APIMetadata$1 = {
59
+ } & APIMetadata;
60
+ type APIMetadata = {
22
61
  methodFqn?: string;
23
62
  entityFqdn?: string;
24
63
  packageName?: string;
25
64
  };
26
- type BuildRESTFunction$1<T extends RESTFunctionDescriptor$1> = T extends RESTFunctionDescriptor$1<infer U> ? U : never;
27
- type EventDefinition$1<Payload = unknown, Type extends string = string> = {
65
+ type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
66
+ type EventDefinition$2<Payload = unknown, Type extends string = string> = {
28
67
  __type: 'event-definition';
29
68
  type: Type;
30
69
  isDomainEvent?: boolean;
31
70
  transformations?: (envelope: unknown) => Payload;
32
71
  __payload: Payload;
33
72
  };
34
- declare function EventDefinition$1<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition$1<Payload, Type>;
35
- type EventHandler$1<T extends EventDefinition$1> = (payload: T['__payload']) => void | Promise<void>;
36
- type BuildEventDefinition$1<T extends EventDefinition$1<any, string>> = (handler: EventHandler$1<T>) => void;
73
+ declare function EventDefinition$2<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition$2<Payload, Type>;
74
+ type EventHandler$2<T extends EventDefinition$2> = (payload: T['__payload']) => void | Promise<void>;
75
+ type BuildEventDefinition$2<T extends EventDefinition$2<any, string>> = (handler: EventHandler$2<T>) => void;
76
+
77
+ type ServicePluginMethodInput = {
78
+ request: any;
79
+ metadata: any;
80
+ };
81
+ type ServicePluginContract = Record<string, (payload: ServicePluginMethodInput) => unknown | Promise<unknown>>;
82
+ type ServicePluginMethodMetadata = {
83
+ name: string;
84
+ primaryHttpMappingPath: string;
85
+ transformations: {
86
+ fromREST: (...args: unknown[]) => ServicePluginMethodInput;
87
+ toREST: (...args: unknown[]) => unknown;
88
+ };
89
+ };
90
+ type ServicePluginDefinition<Contract extends ServicePluginContract> = {
91
+ __type: 'service-plugin-definition';
92
+ componentType: string;
93
+ methods: ServicePluginMethodMetadata[];
94
+ __contract: Contract;
95
+ };
96
+ declare function ServicePluginDefinition<Contract extends ServicePluginContract>(componentType: string, methods: ServicePluginMethodMetadata[]): ServicePluginDefinition<Contract>;
97
+ type BuildServicePluginDefinition<T extends ServicePluginDefinition<any>> = (implementation: T['__contract']) => void;
98
+ declare const SERVICE_PLUGIN_ERROR_TYPE = "wix_spi_error";
99
+
100
+ type RequestContext = {
101
+ isSSR: boolean;
102
+ host: string;
103
+ protocol?: string;
104
+ };
105
+ type ResponseTransformer = (data: any, headers?: any) => any;
106
+ /**
107
+ * Ambassador request options types are copied mostly from AxiosRequestConfig.
108
+ * They are copied and not imported to reduce the amount of dependencies (to reduce install time).
109
+ * https://github.com/axios/axios/blob/3f53eb6960f05a1f88409c4b731a40de595cb825/index.d.ts#L307-L315
110
+ */
111
+ type Method = 'get' | 'GET' | 'delete' | 'DELETE' | 'head' | 'HEAD' | 'options' | 'OPTIONS' | 'post' | 'POST' | 'put' | 'PUT' | 'patch' | 'PATCH' | 'purge' | 'PURGE' | 'link' | 'LINK' | 'unlink' | 'UNLINK';
112
+ type AmbassadorRequestOptions<T = any> = {
113
+ _?: T;
114
+ url?: string;
115
+ method?: Method;
116
+ params?: any;
117
+ data?: any;
118
+ transformResponse?: ResponseTransformer | ResponseTransformer[];
119
+ };
120
+ type AmbassadorFactory<Request, Response> = (payload: Request) => ((context: RequestContext) => AmbassadorRequestOptions<Response>) & {
121
+ __isAmbassador: boolean;
122
+ };
123
+ type AmbassadorFunctionDescriptor<Request = any, Response = any> = AmbassadorFactory<Request, Response>;
124
+ type BuildAmbassadorFunction<T extends AmbassadorFunctionDescriptor> = T extends AmbassadorFunctionDescriptor<infer Request, infer Response> ? (req: Request) => Promise<Response> : never;
37
125
 
38
126
  declare global {
39
127
  // eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
@@ -42,6 +130,284 @@ declare global {
42
130
  }
43
131
  }
44
132
 
133
+ declare const emptyObjectSymbol: unique symbol;
134
+
135
+ /**
136
+ Represents a strictly empty plain object, the `{}` value.
137
+
138
+ 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)).
139
+
140
+ @example
141
+ ```
142
+ import type {EmptyObject} from 'type-fest';
143
+
144
+ // The following illustrates the problem with `{}`.
145
+ const foo1: {} = {}; // Pass
146
+ const foo2: {} = []; // Pass
147
+ const foo3: {} = 42; // Pass
148
+ const foo4: {} = {a: 1}; // Pass
149
+
150
+ // With `EmptyObject` only the first case is valid.
151
+ const bar1: EmptyObject = {}; // Pass
152
+ const bar2: EmptyObject = 42; // Fail
153
+ const bar3: EmptyObject = []; // Fail
154
+ const bar4: EmptyObject = {a: 1}; // Fail
155
+ ```
156
+
157
+ 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}.
158
+
159
+ @category Object
160
+ */
161
+ type EmptyObject = {[emptyObjectSymbol]?: never};
162
+
163
+ /**
164
+ Returns a boolean for whether the two given types are equal.
165
+
166
+ @link https://github.com/microsoft/TypeScript/issues/27024#issuecomment-421529650
167
+ @link https://stackoverflow.com/questions/68961864/how-does-the-equals-work-in-typescript/68963796#68963796
168
+
169
+ Use-cases:
170
+ - If you want to make a conditional branch based on the result of a comparison of two types.
171
+
172
+ @example
173
+ ```
174
+ import type {IsEqual} from 'type-fest';
175
+
176
+ // This type returns a boolean for whether the given array includes the given item.
177
+ // `IsEqual` is used to compare the given array at position 0 and the given item and then return true if they are equal.
178
+ type Includes<Value extends readonly any[], Item> =
179
+ Value extends readonly [Value[0], ...infer rest]
180
+ ? IsEqual<Value[0], Item> extends true
181
+ ? true
182
+ : Includes<rest, Item>
183
+ : false;
184
+ ```
185
+
186
+ @category Type Guard
187
+ @category Utilities
188
+ */
189
+ type IsEqual<A, B> =
190
+ (<G>() => G extends A ? 1 : 2) extends
191
+ (<G>() => G extends B ? 1 : 2)
192
+ ? true
193
+ : false;
194
+
195
+ /**
196
+ Filter out keys from an object.
197
+
198
+ Returns `never` if `Exclude` is strictly equal to `Key`.
199
+ Returns `never` if `Key` extends `Exclude`.
200
+ Returns `Key` otherwise.
201
+
202
+ @example
203
+ ```
204
+ type Filtered = Filter<'foo', 'foo'>;
205
+ //=> never
206
+ ```
207
+
208
+ @example
209
+ ```
210
+ type Filtered = Filter<'bar', string>;
211
+ //=> never
212
+ ```
213
+
214
+ @example
215
+ ```
216
+ type Filtered = Filter<'bar', 'foo'>;
217
+ //=> 'bar'
218
+ ```
219
+
220
+ @see {Except}
221
+ */
222
+ type Filter<KeyType, ExcludeType> = IsEqual<KeyType, ExcludeType> extends true ? never : (KeyType extends ExcludeType ? never : KeyType);
223
+
224
+ type ExceptOptions = {
225
+ /**
226
+ Disallow assigning non-specified properties.
227
+
228
+ Note that any omitted properties in the resulting type will be present in autocomplete as `undefined`.
229
+
230
+ @default false
231
+ */
232
+ requireExactProps?: boolean;
233
+ };
234
+
235
+ /**
236
+ Create a type from an object type without certain keys.
237
+
238
+ We recommend setting the `requireExactProps` option to `true`.
239
+
240
+ 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.
241
+
242
+ 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)).
243
+
244
+ @example
245
+ ```
246
+ import type {Except} from 'type-fest';
247
+
248
+ type Foo = {
249
+ a: number;
250
+ b: string;
251
+ };
252
+
253
+ type FooWithoutA = Except<Foo, 'a'>;
254
+ //=> {b: string}
255
+
256
+ const fooWithoutA: FooWithoutA = {a: 1, b: '2'};
257
+ //=> errors: 'a' does not exist in type '{ b: string; }'
258
+
259
+ type FooWithoutB = Except<Foo, 'b', {requireExactProps: true}>;
260
+ //=> {a: number} & Partial<Record<"b", never>>
261
+
262
+ const fooWithoutB: FooWithoutB = {a: 1, b: '2'};
263
+ //=> errors at 'b': Type 'string' is not assignable to type 'undefined'.
264
+ ```
265
+
266
+ @category Object
267
+ */
268
+ type Except<ObjectType, KeysType extends keyof ObjectType, Options extends ExceptOptions = {requireExactProps: false}> = {
269
+ [KeyType in keyof ObjectType as Filter<KeyType, KeysType>]: ObjectType[KeyType];
270
+ } & (Options['requireExactProps'] extends true
271
+ ? Partial<Record<KeysType, never>>
272
+ : {});
273
+
274
+ /**
275
+ Extract the keys from a type where the value type of the key extends the given `Condition`.
276
+
277
+ Internally this is used for the `ConditionalPick` and `ConditionalExcept` types.
278
+
279
+ @example
280
+ ```
281
+ import type {ConditionalKeys} from 'type-fest';
282
+
283
+ interface Example {
284
+ a: string;
285
+ b: string | number;
286
+ c?: string;
287
+ d: {};
288
+ }
289
+
290
+ type StringKeysOnly = ConditionalKeys<Example, string>;
291
+ //=> 'a'
292
+ ```
293
+
294
+ To support partial types, make sure your `Condition` is a union of undefined (for example, `string | undefined`) as demonstrated below.
295
+
296
+ @example
297
+ ```
298
+ import type {ConditionalKeys} from 'type-fest';
299
+
300
+ type StringKeysAndUndefined = ConditionalKeys<Example, string | undefined>;
301
+ //=> 'a' | 'c'
302
+ ```
303
+
304
+ @category Object
305
+ */
306
+ type ConditionalKeys<Base, Condition> = NonNullable<
307
+ // Wrap in `NonNullable` to strip away the `undefined` type from the produced union.
308
+ {
309
+ // Map through all the keys of the given base type.
310
+ [Key in keyof Base]:
311
+ // Pick only keys with types extending the given `Condition` type.
312
+ Base[Key] extends Condition
313
+ // Retain this key since the condition passes.
314
+ ? Key
315
+ // Discard this key since the condition fails.
316
+ : never;
317
+
318
+ // Convert the produced object into a union type of the keys which passed the conditional test.
319
+ }[keyof Base]
320
+ >;
321
+
322
+ /**
323
+ Exclude keys from a shape that matches the given `Condition`.
324
+
325
+ 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.
326
+
327
+ @example
328
+ ```
329
+ import type {Primitive, ConditionalExcept} from 'type-fest';
330
+
331
+ class Awesome {
332
+ name: string;
333
+ successes: number;
334
+ failures: bigint;
335
+
336
+ run() {}
337
+ }
338
+
339
+ type ExceptPrimitivesFromAwesome = ConditionalExcept<Awesome, Primitive>;
340
+ //=> {run: () => void}
341
+ ```
342
+
343
+ @example
344
+ ```
345
+ import type {ConditionalExcept} from 'type-fest';
346
+
347
+ interface Example {
348
+ a: string;
349
+ b: string | number;
350
+ c: () => void;
351
+ d: {};
352
+ }
353
+
354
+ type NonStringKeysOnly = ConditionalExcept<Example, string>;
355
+ //=> {b: string | number; c: () => void; d: {}}
356
+ ```
357
+
358
+ @category Object
359
+ */
360
+ type ConditionalExcept<Base, Condition> = Except<
361
+ Base,
362
+ ConditionalKeys<Base, Condition>
363
+ >;
364
+
365
+ /**
366
+ * Descriptors are objects that describe the API of a module, and the module
367
+ * can either be a REST module or a host module.
368
+ * This type is recursive, so it can describe nested modules.
369
+ */
370
+ type Descriptors = RESTFunctionDescriptor | AmbassadorFunctionDescriptor | HostModule<any, any> | EventDefinition$2<any> | ServicePluginDefinition<any> | {
371
+ [key: string]: Descriptors | PublicMetadata | any;
372
+ };
373
+ /**
374
+ * This type takes in a descriptors object of a certain Host (including an `unknown` host)
375
+ * and returns an object with the same structure, but with all descriptors replaced with their API.
376
+ * Any non-descriptor properties are removed from the returned object, including descriptors that
377
+ * do not match the given host (as they will not work with the given host).
378
+ */
379
+ type BuildDescriptors<T extends Descriptors, H extends Host<any> | undefined, Depth extends number = 5> = {
380
+ done: T;
381
+ recurse: T extends {
382
+ __type: typeof SERVICE_PLUGIN_ERROR_TYPE;
383
+ } ? never : T extends AmbassadorFunctionDescriptor ? BuildAmbassadorFunction<T> : T extends RESTFunctionDescriptor ? BuildRESTFunction<T> : T extends EventDefinition$2<any> ? BuildEventDefinition$2<T> : T extends ServicePluginDefinition<any> ? BuildServicePluginDefinition<T> : T extends HostModule<any, any> ? HostModuleAPI<T> : ConditionalExcept<{
384
+ [Key in keyof T]: T[Key] extends Descriptors ? BuildDescriptors<T[Key], H, [
385
+ -1,
386
+ 0,
387
+ 1,
388
+ 2,
389
+ 3,
390
+ 4,
391
+ 5
392
+ ][Depth]> : never;
393
+ }, EmptyObject>;
394
+ }[Depth extends -1 ? 'done' : 'recurse'];
395
+ type PublicMetadata = {
396
+ PACKAGE_NAME?: string;
397
+ };
398
+
399
+ declare global {
400
+ interface ContextualClient {
401
+ }
402
+ }
403
+ /**
404
+ * A type used to create concerete types from SDK descriptors in
405
+ * case a contextual client is available.
406
+ */
407
+ type MaybeContext<T extends Descriptors> = globalThis.ContextualClient extends {
408
+ host: Host;
409
+ } ? BuildDescriptors<T, globalThis.ContextualClient['host']> : T;
410
+
45
411
  interface SeatingPlan$1 {
46
412
  /**
47
413
  * Auto generated unique plan id
@@ -971,7 +1337,7 @@ interface FindSeatingPlanOptions {
971
1337
  seatingPlanMask?: SeatingPlanMask;
972
1338
  }
973
1339
 
974
- declare function createSeatingPlan$1(httpClient: HttpClient$1): CreateSeatingPlanSignature;
1340
+ declare function createSeatingPlan$1(httpClient: HttpClient): CreateSeatingPlanSignature;
975
1341
  interface CreateSeatingPlanSignature {
976
1342
  /**
977
1343
  * Crates a seating plan
@@ -980,7 +1346,7 @@ interface CreateSeatingPlanSignature {
980
1346
  */
981
1347
  (plan: SeatingPlan$1): Promise<SeatingPlan$1 & SeatingPlanNonNullableFields$1>;
982
1348
  }
983
- declare function updateSeatingPlan$1(httpClient: HttpClient$1): UpdateSeatingPlanSignature;
1349
+ declare function updateSeatingPlan$1(httpClient: HttpClient): UpdateSeatingPlanSignature;
984
1350
  interface UpdateSeatingPlanSignature {
985
1351
  /**
986
1352
  * Updates the seating plan
@@ -988,7 +1354,7 @@ interface UpdateSeatingPlanSignature {
988
1354
  */
989
1355
  (options?: UpdateSeatingPlanOptions | undefined): Promise<SeatingPlan$1 & SeatingPlanNonNullableFields$1>;
990
1356
  }
991
- declare function copySeatingPlan$1(httpClient: HttpClient$1): CopySeatingPlanSignature;
1357
+ declare function copySeatingPlan$1(httpClient: HttpClient): CopySeatingPlanSignature;
992
1358
  interface CopySeatingPlanSignature {
993
1359
  /**
994
1360
  * Copies the seating plan
@@ -996,14 +1362,14 @@ interface CopySeatingPlanSignature {
996
1362
  */
997
1363
  (_id: string | null, options: CopySeatingPlanOptions): Promise<CopySeatingPlanResponse & CopySeatingPlanResponseNonNullableFields>;
998
1364
  }
999
- declare function querySeatingPlan$1(httpClient: HttpClient$1): QuerySeatingPlanSignature;
1365
+ declare function querySeatingPlan$1(httpClient: HttpClient): QuerySeatingPlanSignature;
1000
1366
  interface QuerySeatingPlanSignature {
1001
1367
  /**
1002
1368
  * Lists seating plans by provided query request
1003
1369
  */
1004
1370
  (options?: QuerySeatingPlanOptions | undefined): PlansQueryBuilder;
1005
1371
  }
1006
- declare function getSeatingPlan$1(httpClient: HttpClient$1): GetSeatingPlanSignature;
1372
+ declare function getSeatingPlan$1(httpClient: HttpClient): GetSeatingPlanSignature;
1007
1373
  interface GetSeatingPlanSignature {
1008
1374
  /**
1009
1375
  * Returns the seating plan. Fails of not fond.
@@ -1012,7 +1378,7 @@ interface GetSeatingPlanSignature {
1012
1378
  */
1013
1379
  (_id: string | null, options?: GetSeatingPlanOptions | undefined): Promise<SeatingPlan$1 & SeatingPlanNonNullableFields$1>;
1014
1380
  }
1015
- declare function findSeatingPlan$1(httpClient: HttpClient$1): FindSeatingPlanSignature;
1381
+ declare function findSeatingPlan$1(httpClient: HttpClient): FindSeatingPlanSignature;
1016
1382
  interface FindSeatingPlanSignature {
1017
1383
  /**
1018
1384
  * Returns the first seating plan found by filter request.
@@ -1020,7 +1386,7 @@ interface FindSeatingPlanSignature {
1020
1386
  */
1021
1387
  (filter: Record<string, any> | null, options?: FindSeatingPlanOptions | undefined): Promise<FindSeatingPlanResponse & FindSeatingPlanResponseNonNullableFields>;
1022
1388
  }
1023
- declare function deleteSeatingPlan$1(httpClient: HttpClient$1): DeleteSeatingPlanSignature;
1389
+ declare function deleteSeatingPlan$1(httpClient: HttpClient): DeleteSeatingPlanSignature;
1024
1390
  interface DeleteSeatingPlanSignature {
1025
1391
  /**
1026
1392
  * Deletes the seating plan.
@@ -1028,35 +1394,53 @@ interface DeleteSeatingPlanSignature {
1028
1394
  */
1029
1395
  (_id: string | null): Promise<DeleteSeatingPlanResponse & DeleteSeatingPlanResponseNonNullableFields>;
1030
1396
  }
1031
- declare function updateSeatingPlanThumbnail$1(httpClient: HttpClient$1): UpdateSeatingPlanThumbnailSignature;
1397
+ declare function updateSeatingPlanThumbnail$1(httpClient: HttpClient): UpdateSeatingPlanThumbnailSignature;
1032
1398
  interface UpdateSeatingPlanThumbnailSignature {
1033
1399
  /**
1034
1400
  * Updates seating plan thumbnail.
1035
1401
  */
1036
1402
  (thumbnail: SeatingPlanThumbnail): Promise<UpdateSeatingPlanThumbnailResponse>;
1037
1403
  }
1038
- declare function getSeatingPlanThumbnail$1(httpClient: HttpClient$1): GetSeatingPlanThumbnailSignature;
1404
+ declare function getSeatingPlanThumbnail$1(httpClient: HttpClient): GetSeatingPlanThumbnailSignature;
1039
1405
  interface GetSeatingPlanThumbnailSignature {
1040
1406
  /**
1041
1407
  * Get seating plan thumbnail.
1042
1408
  */
1043
1409
  (_id: string | null): Promise<GetSeatingPlanThumbnailResponse>;
1044
1410
  }
1045
- declare const onSeatingPlanCreated$1: EventDefinition$1<SeatingPlanCreatedEnvelope, "wix.seating.v1.seating_plan_created">;
1046
- declare const onSeatingPlanUpdated$1: EventDefinition$1<SeatingPlanUpdatedEnvelope, "wix.seating.v1.seating_plan_updated">;
1047
- declare const onSeatingPlanDeleted$1: EventDefinition$1<SeatingPlanDeletedEnvelope, "wix.seating.v1.seating_plan_deleted">;
1411
+ declare const onSeatingPlanCreated$1: EventDefinition$2<SeatingPlanCreatedEnvelope, "wix.seating.v1.seating_plan_created">;
1412
+ declare const onSeatingPlanUpdated$1: EventDefinition$2<SeatingPlanUpdatedEnvelope, "wix.seating.v1.seating_plan_updated">;
1413
+ declare const onSeatingPlanDeleted$1: EventDefinition$2<SeatingPlanDeletedEnvelope, "wix.seating.v1.seating_plan_deleted">;
1414
+
1415
+ type EventDefinition$1<Payload = unknown, Type extends string = string> = {
1416
+ __type: 'event-definition';
1417
+ type: Type;
1418
+ isDomainEvent?: boolean;
1419
+ transformations?: (envelope: unknown) => Payload;
1420
+ __payload: Payload;
1421
+ };
1422
+ declare function EventDefinition$1<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition$1<Payload, Type>;
1423
+ type EventHandler$1<T extends EventDefinition$1> = (payload: T['__payload']) => void | Promise<void>;
1424
+ type BuildEventDefinition$1<T extends EventDefinition$1<any, string>> = (handler: EventHandler$1<T>) => void;
1425
+
1426
+ declare global {
1427
+ // eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
1428
+ interface SymbolConstructor {
1429
+ readonly observable: symbol;
1430
+ }
1431
+ }
1048
1432
 
1049
1433
  declare function createEventModule$1<T extends EventDefinition$1<any, string>>(eventDefinition: T): BuildEventDefinition$1<T> & T;
1050
1434
 
1051
- declare const createSeatingPlan: BuildRESTFunction$1<typeof createSeatingPlan$1> & typeof createSeatingPlan$1;
1052
- declare const updateSeatingPlan: BuildRESTFunction$1<typeof updateSeatingPlan$1> & typeof updateSeatingPlan$1;
1053
- declare const copySeatingPlan: BuildRESTFunction$1<typeof copySeatingPlan$1> & typeof copySeatingPlan$1;
1054
- declare const querySeatingPlan: BuildRESTFunction$1<typeof querySeatingPlan$1> & typeof querySeatingPlan$1;
1055
- declare const getSeatingPlan: BuildRESTFunction$1<typeof getSeatingPlan$1> & typeof getSeatingPlan$1;
1056
- declare const findSeatingPlan: BuildRESTFunction$1<typeof findSeatingPlan$1> & typeof findSeatingPlan$1;
1057
- declare const deleteSeatingPlan: BuildRESTFunction$1<typeof deleteSeatingPlan$1> & typeof deleteSeatingPlan$1;
1058
- declare const updateSeatingPlanThumbnail: BuildRESTFunction$1<typeof updateSeatingPlanThumbnail$1> & typeof updateSeatingPlanThumbnail$1;
1059
- declare const getSeatingPlanThumbnail: BuildRESTFunction$1<typeof getSeatingPlanThumbnail$1> & typeof getSeatingPlanThumbnail$1;
1435
+ declare const createSeatingPlan: MaybeContext<BuildRESTFunction<typeof createSeatingPlan$1> & typeof createSeatingPlan$1>;
1436
+ declare const updateSeatingPlan: MaybeContext<BuildRESTFunction<typeof updateSeatingPlan$1> & typeof updateSeatingPlan$1>;
1437
+ declare const copySeatingPlan: MaybeContext<BuildRESTFunction<typeof copySeatingPlan$1> & typeof copySeatingPlan$1>;
1438
+ declare const querySeatingPlan: MaybeContext<BuildRESTFunction<typeof querySeatingPlan$1> & typeof querySeatingPlan$1>;
1439
+ declare const getSeatingPlan: MaybeContext<BuildRESTFunction<typeof getSeatingPlan$1> & typeof getSeatingPlan$1>;
1440
+ declare const findSeatingPlan: MaybeContext<BuildRESTFunction<typeof findSeatingPlan$1> & typeof findSeatingPlan$1>;
1441
+ declare const deleteSeatingPlan: MaybeContext<BuildRESTFunction<typeof deleteSeatingPlan$1> & typeof deleteSeatingPlan$1>;
1442
+ declare const updateSeatingPlanThumbnail: MaybeContext<BuildRESTFunction<typeof updateSeatingPlanThumbnail$1> & typeof updateSeatingPlanThumbnail$1>;
1443
+ declare const getSeatingPlanThumbnail: MaybeContext<BuildRESTFunction<typeof getSeatingPlanThumbnail$1> & typeof getSeatingPlanThumbnail$1>;
1060
1444
 
1061
1445
  type _publicOnSeatingPlanCreatedType = typeof onSeatingPlanCreated$1;
1062
1446
  /** */
@@ -1137,50 +1521,6 @@ declare namespace context$1 {
1137
1521
  export { type ActionEvent$1 as ActionEvent, type BaseEventMetadata$1 as BaseEventMetadata, type context$1_CapacityExceededViolation as CapacityExceededViolation, type Category$1 as Category, type context$1_CopySeatingPlanOptions as CopySeatingPlanOptions, type context$1_CopySeatingPlanRequest as CopySeatingPlanRequest, type context$1_CopySeatingPlanResponse as CopySeatingPlanResponse, type context$1_CopySeatingPlanResponseNonNullableFields as CopySeatingPlanResponseNonNullableFields, type context$1_CreateSeatingPlanRequest as CreateSeatingPlanRequest, type context$1_CreateSeatingPlanResponse as CreateSeatingPlanResponse, type context$1_CreateSeatingPlanResponseNonNullableFields as CreateSeatingPlanResponseNonNullableFields, type CursorPaging$1 as CursorPaging, type Cursors$1 as Cursors, type context$1_DeleteSeatingPlanRequest as DeleteSeatingPlanRequest, type context$1_DeleteSeatingPlanResponse as DeleteSeatingPlanResponse, type context$1_DeleteSeatingPlanResponseNonNullableFields as DeleteSeatingPlanResponseNonNullableFields, type context$1_DiscardSeatingPlanVersionsRequest as DiscardSeatingPlanVersionsRequest, type context$1_DiscardSeatingPlanVersionsResponse as DiscardSeatingPlanVersionsResponse, type DomainEvent$1 as DomainEvent, type DomainEventBodyOneOf$1 as DomainEventBodyOneOf, type Element$1 as Element, type ElementGroup$1 as ElementGroup, type ElementGroupUiProperties$1 as ElementGroupUiProperties, type ElementUiProperties$1 as ElementUiProperties, type EntityCreatedEvent$1 as EntityCreatedEvent, type EntityDeletedEvent$1 as EntityDeletedEvent, type EntityUpdatedEvent$1 as EntityUpdatedEvent, type EventMetadata$1 as EventMetadata, type ExtendedFields$1 as ExtendedFields, context$1_Fieldset as Fieldset, type context$1_FindSeatingPlanOptions as FindSeatingPlanOptions, type context$1_FindSeatingPlanRequest as FindSeatingPlanRequest, type context$1_FindSeatingPlanResponse as FindSeatingPlanResponse, type context$1_FindSeatingPlanResponseNonNullableFields as FindSeatingPlanResponseNonNullableFields, type context$1_GetSeatingPlanOptions as GetSeatingPlanOptions, type context$1_GetSeatingPlanRequest as GetSeatingPlanRequest, type context$1_GetSeatingPlanResponse as GetSeatingPlanResponse, type context$1_GetSeatingPlanResponseNonNullableFields as GetSeatingPlanResponseNonNullableFields, type context$1_GetSeatingPlanThumbnailRequest as GetSeatingPlanThumbnailRequest, type context$1_GetSeatingPlanThumbnailResponse as GetSeatingPlanThumbnailResponse, Icon$1 as Icon, type IdentificationData$1 as IdentificationData, type IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, type Image$1 as Image, type MessageEnvelope$1 as MessageEnvelope, type MultiRowProperties$1 as MultiRowProperties, Numbering$1 as Numbering, type Paging$1 as Paging, type PagingMetadataV2$1 as PagingMetadataV2, type Place$1 as Place, PlaceTypeEnumType$1 as PlaceTypeEnumType, type context$1_PlansQueryBuilder as PlansQueryBuilder, type context$1_PlansQueryResult as PlansQueryResult, Position$1 as Position, type context$1_QuerySeatingPlanOptions as QuerySeatingPlanOptions, type context$1_QuerySeatingPlanRequest as QuerySeatingPlanRequest, type context$1_QuerySeatingPlanResponse as QuerySeatingPlanResponse, type context$1_QuerySeatingPlanResponseNonNullableFields as QuerySeatingPlanResponseNonNullableFields, type context$1_QuerySeatingPlanVersionsRequest as QuerySeatingPlanVersionsRequest, type context$1_QuerySeatingPlanVersionsResponse as QuerySeatingPlanVersionsResponse, type QueryV2$1 as QueryV2, type QueryV2PagingMethodOneOf$1 as QueryV2PagingMethodOneOf, type ReservationOptions$1 as ReservationOptions, type RestoreInfo$1 as RestoreInfo, type context$1_RestoreSeatingPlanRequest as RestoreSeatingPlanRequest, type context$1_RestoreSeatingPlanResponse as RestoreSeatingPlanResponse, type RowElement$1 as RowElement, type RowElementUiProperties$1 as RowElementUiProperties, type context$1_SaveSeatingPlanVersionRequest as SaveSeatingPlanVersionRequest, type context$1_SaveSeatingPlanVersionResponse as SaveSeatingPlanVersionResponse, type SeatingPlan$1 as SeatingPlan, type context$1_SeatingPlanCreatedEnvelope as SeatingPlanCreatedEnvelope, type context$1_SeatingPlanDeletedEnvelope as SeatingPlanDeletedEnvelope, type context$1_SeatingPlanMask as SeatingPlanMask, type SeatingPlanNonNullableFields$1 as SeatingPlanNonNullableFields, type context$1_SeatingPlanThumbnail as SeatingPlanThumbnail, type SeatingPlanUiProperties$1 as SeatingPlanUiProperties, type context$1_SeatingPlanUpdatedEnvelope as SeatingPlanUpdatedEnvelope, type Section$1 as Section, type Sequencing$1 as Sequencing, ShapeTypeEnumType$1 as ShapeTypeEnumType, SortOrder$1 as SortOrder, type Sorting$1 as Sorting, Type$1 as Type, type context$1_UpdateSeatingPlanOptions as UpdateSeatingPlanOptions, type context$1_UpdateSeatingPlanRequest as UpdateSeatingPlanRequest, type context$1_UpdateSeatingPlanResponse as UpdateSeatingPlanResponse, type context$1_UpdateSeatingPlanResponseNonNullableFields as UpdateSeatingPlanResponseNonNullableFields, type context$1_UpdateSeatingPlanThumbnailRequest as UpdateSeatingPlanThumbnailRequest, type context$1_UpdateSeatingPlanThumbnailResponse as UpdateSeatingPlanThumbnailResponse, type VerticalSequencing$1 as VerticalSequencing, WebhookIdentityType$1 as WebhookIdentityType, type context$1__publicOnSeatingPlanCreatedType as _publicOnSeatingPlanCreatedType, type context$1__publicOnSeatingPlanDeletedType as _publicOnSeatingPlanDeletedType, type context$1__publicOnSeatingPlanUpdatedType as _publicOnSeatingPlanUpdatedType, context$1_copySeatingPlan as copySeatingPlan, context$1_createSeatingPlan as createSeatingPlan, context$1_deleteSeatingPlan as deleteSeatingPlan, context$1_findSeatingPlan as findSeatingPlan, context$1_getSeatingPlan as getSeatingPlan, context$1_getSeatingPlanThumbnail as getSeatingPlanThumbnail, context$1_onSeatingPlanCreated as onSeatingPlanCreated, context$1_onSeatingPlanDeleted as onSeatingPlanDeleted, context$1_onSeatingPlanUpdated as onSeatingPlanUpdated, onSeatingPlanCreated$1 as publicOnSeatingPlanCreated, onSeatingPlanDeleted$1 as publicOnSeatingPlanDeleted, onSeatingPlanUpdated$1 as publicOnSeatingPlanUpdated, context$1_querySeatingPlan as querySeatingPlan, context$1_updateSeatingPlan as updateSeatingPlan, context$1_updateSeatingPlanThumbnail as updateSeatingPlanThumbnail };
1138
1522
  }
1139
1523
 
1140
- type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
1141
- interface HttpClient {
1142
- request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
1143
- fetchWithAuth: typeof fetch;
1144
- wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
1145
- }
1146
- type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
1147
- type HttpResponse<T = any> = {
1148
- data: T;
1149
- status: number;
1150
- statusText: string;
1151
- headers: any;
1152
- request?: any;
1153
- };
1154
- type RequestOptions<_TResponse = any, Data = any> = {
1155
- method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
1156
- url: string;
1157
- data?: Data;
1158
- params?: URLSearchParams;
1159
- } & APIMetadata;
1160
- type APIMetadata = {
1161
- methodFqn?: string;
1162
- entityFqdn?: string;
1163
- packageName?: string;
1164
- };
1165
- type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
1166
- type EventDefinition<Payload = unknown, Type extends string = string> = {
1167
- __type: 'event-definition';
1168
- type: Type;
1169
- isDomainEvent?: boolean;
1170
- transformations?: (envelope: unknown) => Payload;
1171
- __payload: Payload;
1172
- };
1173
- declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
1174
- type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
1175
- type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
1176
-
1177
- declare global {
1178
- // eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
1179
- interface SymbolConstructor {
1180
- readonly observable: symbol;
1181
- }
1182
- }
1183
-
1184
1524
  interface SeatingReservation {
1185
1525
  /**
1186
1526
  * The id of the reservation
@@ -1297,6 +1637,7 @@ interface InvalidateCache extends InvalidateCacheGetByOneOf {
1297
1637
  reason?: string | null;
1298
1638
  /** Is local DS */
1299
1639
  localDc?: boolean;
1640
+ hardPurge?: boolean;
1300
1641
  }
1301
1642
  /** @oneof */
1302
1643
  interface InvalidateCacheGetByOneOf {
@@ -2203,17 +2544,35 @@ interface GetSeatingReservationsSummarySignature {
2203
2544
  /** @param - Filter for seating plan */
2204
2545
  (filter: Record<string, any> | null): Promise<GetSeatingReservationsSummaryResponse & GetSeatingReservationsSummaryResponseNonNullableFields>;
2205
2546
  }
2206
- declare const onSeatingReservationCreated$1: EventDefinition<SeatingReservationCreatedEnvelope, "wix.seating.v1.seating_reservation_created">;
2207
- declare const onSeatingReservationDeleted$1: EventDefinition<SeatingReservationDeletedEnvelope, "wix.seating.v1.seating_reservation_deleted">;
2547
+ declare const onSeatingReservationCreated$1: EventDefinition$2<SeatingReservationCreatedEnvelope, "wix.seating.v1.seating_reservation_created">;
2548
+ declare const onSeatingReservationDeleted$1: EventDefinition$2<SeatingReservationDeletedEnvelope, "wix.seating.v1.seating_reservation_deleted">;
2549
+
2550
+ type EventDefinition<Payload = unknown, Type extends string = string> = {
2551
+ __type: 'event-definition';
2552
+ type: Type;
2553
+ isDomainEvent?: boolean;
2554
+ transformations?: (envelope: unknown) => Payload;
2555
+ __payload: Payload;
2556
+ };
2557
+ declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
2558
+ type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
2559
+ type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
2560
+
2561
+ declare global {
2562
+ // eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
2563
+ interface SymbolConstructor {
2564
+ readonly observable: symbol;
2565
+ }
2566
+ }
2208
2567
 
2209
2568
  declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
2210
2569
 
2211
- declare const createSeatingReservation: BuildRESTFunction<typeof createSeatingReservation$1> & typeof createSeatingReservation$1;
2212
- declare const getReservation: BuildRESTFunction<typeof getReservation$1> & typeof getReservation$1;
2213
- declare const querySeatingReservation: BuildRESTFunction<typeof querySeatingReservation$1> & typeof querySeatingReservation$1;
2214
- declare const deleteSeatingReservation: BuildRESTFunction<typeof deleteSeatingReservation$1> & typeof deleteSeatingReservation$1;
2215
- declare const getSeatingCategoriesSummary: BuildRESTFunction<typeof getSeatingCategoriesSummary$1> & typeof getSeatingCategoriesSummary$1;
2216
- declare const getSeatingReservationsSummary: BuildRESTFunction<typeof getSeatingReservationsSummary$1> & typeof getSeatingReservationsSummary$1;
2570
+ declare const createSeatingReservation: MaybeContext<BuildRESTFunction<typeof createSeatingReservation$1> & typeof createSeatingReservation$1>;
2571
+ declare const getReservation: MaybeContext<BuildRESTFunction<typeof getReservation$1> & typeof getReservation$1>;
2572
+ declare const querySeatingReservation: MaybeContext<BuildRESTFunction<typeof querySeatingReservation$1> & typeof querySeatingReservation$1>;
2573
+ declare const deleteSeatingReservation: MaybeContext<BuildRESTFunction<typeof deleteSeatingReservation$1> & typeof deleteSeatingReservation$1>;
2574
+ declare const getSeatingCategoriesSummary: MaybeContext<BuildRESTFunction<typeof getSeatingCategoriesSummary$1> & typeof getSeatingCategoriesSummary$1>;
2575
+ declare const getSeatingReservationsSummary: MaybeContext<BuildRESTFunction<typeof getSeatingReservationsSummary$1> & typeof getSeatingReservationsSummary$1>;
2217
2576
 
2218
2577
  type _publicOnSeatingReservationCreatedType = typeof onSeatingReservationCreated$1;
2219
2578
  /** */