@wix/categories 1.0.49 → 1.0.51

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/categories",
3
- "version": "1.0.49",
3
+ "version": "1.0.51",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -18,7 +18,7 @@
18
18
  "type-bundles"
19
19
  ],
20
20
  "dependencies": {
21
- "@wix/categories_categories": "1.0.26"
21
+ "@wix/categories_categories": "1.0.28"
22
22
  },
23
23
  "devDependencies": {
24
24
  "glob": "^10.4.1",
@@ -43,5 +43,5 @@
43
43
  "fqdn": ""
44
44
  }
45
45
  },
46
- "falconPackageHash": "fafb60217d27880d1845f939730befc05bc049829717caeb591ad741"
46
+ "falconPackageHash": "2bb2c86bfa8e5489b0d2052183dbd6fd5324954ed645b1eec403e7f0"
47
47
  }
@@ -1,8 +1,47 @@
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
+
1
39
  type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
2
40
  interface HttpClient {
3
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
46
  type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
8
47
  type HttpResponse<T = any> = {
@@ -24,16 +63,65 @@ type APIMetadata = {
24
63
  packageName?: string;
25
64
  };
26
65
  type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
27
- type EventDefinition<Payload = unknown, Type extends string = string> = {
66
+ type EventDefinition$1<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<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
35
- type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
36
- type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
73
+ declare function EventDefinition$1<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition$1<Payload, Type>;
74
+ type EventHandler$1<T extends EventDefinition$1> = (payload: T['__payload']) => void | Promise<void>;
75
+ type BuildEventDefinition$1<T extends EventDefinition$1<any, string>> = (handler: EventHandler$1<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$1<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$1<any> ? BuildEventDefinition$1<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 Category {
46
412
  /** Category ID. */
47
413
  _id?: string | null;
@@ -1665,8 +2031,9 @@ interface QueryCategoriesRequest {
1665
2031
  /** Category tree reference details. */
1666
2032
  treeReference: TreeReference;
1667
2033
  /**
1668
- * Whether to return categories with `visible:false`. Default: false so only visible categories will be in response.
1669
- * Used only in the first request. Following requests use the cursor token.
2034
+ * Whether to return non-visible categories.
2035
+ *
2036
+ * Default: `false` (only visible categories are returned)
1670
2037
  */
1671
2038
  returnNonVisibleCategories?: boolean;
1672
2039
  /** Fields to include in the response. */
@@ -1722,7 +2089,7 @@ declare enum RequestedFields {
1722
2089
  BREADCRUMBS_INFO = "BREADCRUMBS_INFO"
1723
2090
  }
1724
2091
  interface QueryCategoriesResponse {
1725
- /** Categories which satisfy the provided query. */
2092
+ /** List of categories. */
1726
2093
  categories?: Category[];
1727
2094
  /** Paging metadata. */
1728
2095
  pagingMetadata?: CursorPagingMetadata;
@@ -3431,8 +3798,9 @@ interface QueryCategoriesOptions {
3431
3798
  /** Category tree reference details. */
3432
3799
  treeReference: TreeReference;
3433
3800
  /**
3434
- * Whether to return categories with `visible:false`. Default: false so only visible categories will be in response.
3435
- * Used only in the first request. Following requests use the cursor token.
3801
+ * Whether to return non-visible categories.
3802
+ *
3803
+ * Default: `false` (only visible categories are returned)
3436
3804
  */
3437
3805
  returnNonVisibleCategories?: boolean | undefined;
3438
3806
  /** Fields to include in the response. */
@@ -3691,7 +4059,15 @@ interface DeleteCategorySignature {
3691
4059
  declare function queryCategories$1(httpClient: HttpClient): QueryCategoriesSignature;
3692
4060
  interface QueryCategoriesSignature {
3693
4061
  /**
3694
- * Query Categories using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language). Use instead of Search when eventually consistent data is not acceptable
4062
+ * Retrieves a list of up to 1,000 categories, given the provided filtering, sorting, and cursor paging.
4063
+ * Pass supported values to the `fields` array in the request to include those fields in the response.
4064
+ *
4065
+ * For field support for filters and sorting,
4066
+ * see [Categories: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-management/categories/supported-filters-and-sorting).
4067
+ *
4068
+ * To learn about working with _Query_ endpoints, see
4069
+ * [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),
4070
+ * and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
3695
4071
  */
3696
4072
  (options: QueryCategoriesOptions): CategoriesQueryBuilder;
3697
4073
  }
@@ -3842,35 +4218,53 @@ interface GetArrangedItemsSignature {
3842
4218
  */
3843
4219
  (categoryId: string, treeReference: TreeReference): Promise<GetArrangedItemsResponse & GetArrangedItemsResponseNonNullableFields>;
3844
4220
  }
3845
- declare const onCategoryCreated$1: EventDefinition<CategoryCreatedEnvelope, "wix.categories.v1.category_created">;
3846
- declare const onCategoryUpdated$1: EventDefinition<CategoryUpdatedEnvelope, "wix.categories.v1.category_updated">;
3847
- declare const onCategoryDeleted$1: EventDefinition<CategoryDeletedEnvelope, "wix.categories.v1.category_deleted">;
3848
- declare const onCategoryMoved$1: EventDefinition<CategoryMovedEnvelope, "wix.categories.v1.category_category_moved">;
3849
- declare const onCategoryItemAddedToCategory$1: EventDefinition<CategoryItemAddedToCategoryEnvelope, "wix.categories.v1.category_item_added_to_category">;
3850
- declare const onCategoryItemRemovedFromCategory$1: EventDefinition<CategoryItemRemovedFromCategoryEnvelope, "wix.categories.v1.category_item_removed_from_category">;
3851
- declare const onCategoryItemsArrangedInCategory$1: EventDefinition<CategoryItemsArrangedInCategoryEnvelope, "wix.categories.v1.category_items_arranged_in_category">;
4221
+ declare const onCategoryCreated$1: EventDefinition$1<CategoryCreatedEnvelope, "wix.categories.v1.category_created">;
4222
+ declare const onCategoryUpdated$1: EventDefinition$1<CategoryUpdatedEnvelope, "wix.categories.v1.category_updated">;
4223
+ declare const onCategoryDeleted$1: EventDefinition$1<CategoryDeletedEnvelope, "wix.categories.v1.category_deleted">;
4224
+ declare const onCategoryMoved$1: EventDefinition$1<CategoryMovedEnvelope, "wix.categories.v1.category_category_moved">;
4225
+ declare const onCategoryItemAddedToCategory$1: EventDefinition$1<CategoryItemAddedToCategoryEnvelope, "wix.categories.v1.category_item_added_to_category">;
4226
+ declare const onCategoryItemRemovedFromCategory$1: EventDefinition$1<CategoryItemRemovedFromCategoryEnvelope, "wix.categories.v1.category_item_removed_from_category">;
4227
+ declare const onCategoryItemsArrangedInCategory$1: EventDefinition$1<CategoryItemsArrangedInCategoryEnvelope, "wix.categories.v1.category_items_arranged_in_category">;
4228
+
4229
+ type EventDefinition<Payload = unknown, Type extends string = string> = {
4230
+ __type: 'event-definition';
4231
+ type: Type;
4232
+ isDomainEvent?: boolean;
4233
+ transformations?: (envelope: unknown) => Payload;
4234
+ __payload: Payload;
4235
+ };
4236
+ declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
4237
+ type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
4238
+ type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
4239
+
4240
+ declare global {
4241
+ // eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
4242
+ interface SymbolConstructor {
4243
+ readonly observable: symbol;
4244
+ }
4245
+ }
3852
4246
 
3853
4247
  declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
3854
4248
 
3855
- declare const createCategory: BuildRESTFunction<typeof createCategory$1> & typeof createCategory$1;
3856
- declare const getCategory: BuildRESTFunction<typeof getCategory$1> & typeof getCategory$1;
3857
- declare const updateCategory: BuildRESTFunction<typeof updateCategory$1> & typeof updateCategory$1;
3858
- declare const deleteCategory: BuildRESTFunction<typeof deleteCategory$1> & typeof deleteCategory$1;
3859
- declare const queryCategories: BuildRESTFunction<typeof queryCategories$1> & typeof queryCategories$1;
3860
- declare const searchCategories: BuildRESTFunction<typeof searchCategories$1> & typeof searchCategories$1;
3861
- declare const countCategories: BuildRESTFunction<typeof countCategories$1> & typeof countCategories$1;
3862
- declare const moveCategory: BuildRESTFunction<typeof moveCategory$1> & typeof moveCategory$1;
3863
- declare const bulkUpdateCategories: BuildRESTFunction<typeof bulkUpdateCategories$1> & typeof bulkUpdateCategories$1;
3864
- declare const updateCategoryVisibility: BuildRESTFunction<typeof updateCategoryVisibility$1> & typeof updateCategoryVisibility$1;
3865
- declare const bulkAddItemsToCategory: BuildRESTFunction<typeof bulkAddItemsToCategory$1> & typeof bulkAddItemsToCategory$1;
3866
- declare const bulkAddItemToCategories: BuildRESTFunction<typeof bulkAddItemToCategories$1> & typeof bulkAddItemToCategories$1;
3867
- declare const bulkRemoveItemsFromCategory: BuildRESTFunction<typeof bulkRemoveItemsFromCategory$1> & typeof bulkRemoveItemsFromCategory$1;
3868
- declare const bulkRemoveItemFromCategories: BuildRESTFunction<typeof bulkRemoveItemFromCategories$1> & typeof bulkRemoveItemFromCategories$1;
3869
- declare const listItemsInCategory: BuildRESTFunction<typeof listItemsInCategory$1> & typeof listItemsInCategory$1;
3870
- declare const listCategoriesForItem: BuildRESTFunction<typeof listCategoriesForItem$1> & typeof listCategoriesForItem$1;
3871
- declare const listTrees: BuildRESTFunction<typeof listTrees$1> & typeof listTrees$1;
3872
- declare const setArrangedItems: BuildRESTFunction<typeof setArrangedItems$1> & typeof setArrangedItems$1;
3873
- declare const getArrangedItems: BuildRESTFunction<typeof getArrangedItems$1> & typeof getArrangedItems$1;
4249
+ declare const createCategory: MaybeContext<BuildRESTFunction<typeof createCategory$1> & typeof createCategory$1>;
4250
+ declare const getCategory: MaybeContext<BuildRESTFunction<typeof getCategory$1> & typeof getCategory$1>;
4251
+ declare const updateCategory: MaybeContext<BuildRESTFunction<typeof updateCategory$1> & typeof updateCategory$1>;
4252
+ declare const deleteCategory: MaybeContext<BuildRESTFunction<typeof deleteCategory$1> & typeof deleteCategory$1>;
4253
+ declare const queryCategories: MaybeContext<BuildRESTFunction<typeof queryCategories$1> & typeof queryCategories$1>;
4254
+ declare const searchCategories: MaybeContext<BuildRESTFunction<typeof searchCategories$1> & typeof searchCategories$1>;
4255
+ declare const countCategories: MaybeContext<BuildRESTFunction<typeof countCategories$1> & typeof countCategories$1>;
4256
+ declare const moveCategory: MaybeContext<BuildRESTFunction<typeof moveCategory$1> & typeof moveCategory$1>;
4257
+ declare const bulkUpdateCategories: MaybeContext<BuildRESTFunction<typeof bulkUpdateCategories$1> & typeof bulkUpdateCategories$1>;
4258
+ declare const updateCategoryVisibility: MaybeContext<BuildRESTFunction<typeof updateCategoryVisibility$1> & typeof updateCategoryVisibility$1>;
4259
+ declare const bulkAddItemsToCategory: MaybeContext<BuildRESTFunction<typeof bulkAddItemsToCategory$1> & typeof bulkAddItemsToCategory$1>;
4260
+ declare const bulkAddItemToCategories: MaybeContext<BuildRESTFunction<typeof bulkAddItemToCategories$1> & typeof bulkAddItemToCategories$1>;
4261
+ declare const bulkRemoveItemsFromCategory: MaybeContext<BuildRESTFunction<typeof bulkRemoveItemsFromCategory$1> & typeof bulkRemoveItemsFromCategory$1>;
4262
+ declare const bulkRemoveItemFromCategories: MaybeContext<BuildRESTFunction<typeof bulkRemoveItemFromCategories$1> & typeof bulkRemoveItemFromCategories$1>;
4263
+ declare const listItemsInCategory: MaybeContext<BuildRESTFunction<typeof listItemsInCategory$1> & typeof listItemsInCategory$1>;
4264
+ declare const listCategoriesForItem: MaybeContext<BuildRESTFunction<typeof listCategoriesForItem$1> & typeof listCategoriesForItem$1>;
4265
+ declare const listTrees: MaybeContext<BuildRESTFunction<typeof listTrees$1> & typeof listTrees$1>;
4266
+ declare const setArrangedItems: MaybeContext<BuildRESTFunction<typeof setArrangedItems$1> & typeof setArrangedItems$1>;
4267
+ declare const getArrangedItems: MaybeContext<BuildRESTFunction<typeof getArrangedItems$1> & typeof getArrangedItems$1>;
3874
4268
 
3875
4269
  type _publicOnCategoryCreatedType = typeof onCategoryCreated$1;
3876
4270
  /** */
@@ -1,8 +1,47 @@
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
+
1
39
  type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
2
40
  interface HttpClient {
3
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
46
  type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
8
47
  type HttpResponse<T = any> = {
@@ -24,16 +63,65 @@ type APIMetadata = {
24
63
  packageName?: string;
25
64
  };
26
65
  type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
27
- type EventDefinition<Payload = unknown, Type extends string = string> = {
66
+ type EventDefinition$1<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<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
35
- type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
36
- type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
73
+ declare function EventDefinition$1<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition$1<Payload, Type>;
74
+ type EventHandler$1<T extends EventDefinition$1> = (payload: T['__payload']) => void | Promise<void>;
75
+ type BuildEventDefinition$1<T extends EventDefinition$1<any, string>> = (handler: EventHandler$1<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$1<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$1<any> ? BuildEventDefinition$1<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 Category {
46
412
  /** Category ID. */
47
413
  _id?: string | null;
@@ -1665,8 +2031,9 @@ interface QueryCategoriesRequest {
1665
2031
  /** Category tree reference details. */
1666
2032
  treeReference: TreeReference;
1667
2033
  /**
1668
- * Whether to return categories with `visible:false`. Default: false so only visible categories will be in response.
1669
- * Used only in the first request. Following requests use the cursor token.
2034
+ * Whether to return non-visible categories.
2035
+ *
2036
+ * Default: `false` (only visible categories are returned)
1670
2037
  */
1671
2038
  returnNonVisibleCategories?: boolean;
1672
2039
  /** Fields to include in the response. */
@@ -1722,7 +2089,7 @@ declare enum RequestedFields {
1722
2089
  BREADCRUMBS_INFO = "BREADCRUMBS_INFO"
1723
2090
  }
1724
2091
  interface QueryCategoriesResponse {
1725
- /** Categories which satisfy the provided query. */
2092
+ /** List of categories. */
1726
2093
  categories?: Category[];
1727
2094
  /** Paging metadata. */
1728
2095
  pagingMetadata?: CursorPagingMetadata;
@@ -3431,8 +3798,9 @@ interface QueryCategoriesOptions {
3431
3798
  /** Category tree reference details. */
3432
3799
  treeReference: TreeReference;
3433
3800
  /**
3434
- * Whether to return categories with `visible:false`. Default: false so only visible categories will be in response.
3435
- * Used only in the first request. Following requests use the cursor token.
3801
+ * Whether to return non-visible categories.
3802
+ *
3803
+ * Default: `false` (only visible categories are returned)
3436
3804
  */
3437
3805
  returnNonVisibleCategories?: boolean | undefined;
3438
3806
  /** Fields to include in the response. */
@@ -3691,7 +4059,15 @@ interface DeleteCategorySignature {
3691
4059
  declare function queryCategories$1(httpClient: HttpClient): QueryCategoriesSignature;
3692
4060
  interface QueryCategoriesSignature {
3693
4061
  /**
3694
- * Query Categories using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language). Use instead of Search when eventually consistent data is not acceptable
4062
+ * Retrieves a list of up to 1,000 categories, given the provided filtering, sorting, and cursor paging.
4063
+ * Pass supported values to the `fields` array in the request to include those fields in the response.
4064
+ *
4065
+ * For field support for filters and sorting,
4066
+ * see [Categories: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-management/categories/supported-filters-and-sorting).
4067
+ *
4068
+ * To learn about working with _Query_ endpoints, see
4069
+ * [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),
4070
+ * and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
3695
4071
  */
3696
4072
  (options: QueryCategoriesOptions): CategoriesQueryBuilder;
3697
4073
  }
@@ -3842,35 +4218,53 @@ interface GetArrangedItemsSignature {
3842
4218
  */
3843
4219
  (categoryId: string, treeReference: TreeReference): Promise<GetArrangedItemsResponse & GetArrangedItemsResponseNonNullableFields>;
3844
4220
  }
3845
- declare const onCategoryCreated$1: EventDefinition<CategoryCreatedEnvelope, "wix.categories.v1.category_created">;
3846
- declare const onCategoryUpdated$1: EventDefinition<CategoryUpdatedEnvelope, "wix.categories.v1.category_updated">;
3847
- declare const onCategoryDeleted$1: EventDefinition<CategoryDeletedEnvelope, "wix.categories.v1.category_deleted">;
3848
- declare const onCategoryMoved$1: EventDefinition<CategoryMovedEnvelope, "wix.categories.v1.category_category_moved">;
3849
- declare const onCategoryItemAddedToCategory$1: EventDefinition<CategoryItemAddedToCategoryEnvelope, "wix.categories.v1.category_item_added_to_category">;
3850
- declare const onCategoryItemRemovedFromCategory$1: EventDefinition<CategoryItemRemovedFromCategoryEnvelope, "wix.categories.v1.category_item_removed_from_category">;
3851
- declare const onCategoryItemsArrangedInCategory$1: EventDefinition<CategoryItemsArrangedInCategoryEnvelope, "wix.categories.v1.category_items_arranged_in_category">;
4221
+ declare const onCategoryCreated$1: EventDefinition$1<CategoryCreatedEnvelope, "wix.categories.v1.category_created">;
4222
+ declare const onCategoryUpdated$1: EventDefinition$1<CategoryUpdatedEnvelope, "wix.categories.v1.category_updated">;
4223
+ declare const onCategoryDeleted$1: EventDefinition$1<CategoryDeletedEnvelope, "wix.categories.v1.category_deleted">;
4224
+ declare const onCategoryMoved$1: EventDefinition$1<CategoryMovedEnvelope, "wix.categories.v1.category_category_moved">;
4225
+ declare const onCategoryItemAddedToCategory$1: EventDefinition$1<CategoryItemAddedToCategoryEnvelope, "wix.categories.v1.category_item_added_to_category">;
4226
+ declare const onCategoryItemRemovedFromCategory$1: EventDefinition$1<CategoryItemRemovedFromCategoryEnvelope, "wix.categories.v1.category_item_removed_from_category">;
4227
+ declare const onCategoryItemsArrangedInCategory$1: EventDefinition$1<CategoryItemsArrangedInCategoryEnvelope, "wix.categories.v1.category_items_arranged_in_category">;
4228
+
4229
+ type EventDefinition<Payload = unknown, Type extends string = string> = {
4230
+ __type: 'event-definition';
4231
+ type: Type;
4232
+ isDomainEvent?: boolean;
4233
+ transformations?: (envelope: unknown) => Payload;
4234
+ __payload: Payload;
4235
+ };
4236
+ declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
4237
+ type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
4238
+ type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
4239
+
4240
+ declare global {
4241
+ // eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
4242
+ interface SymbolConstructor {
4243
+ readonly observable: symbol;
4244
+ }
4245
+ }
3852
4246
 
3853
4247
  declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
3854
4248
 
3855
- declare const createCategory: BuildRESTFunction<typeof createCategory$1> & typeof createCategory$1;
3856
- declare const getCategory: BuildRESTFunction<typeof getCategory$1> & typeof getCategory$1;
3857
- declare const updateCategory: BuildRESTFunction<typeof updateCategory$1> & typeof updateCategory$1;
3858
- declare const deleteCategory: BuildRESTFunction<typeof deleteCategory$1> & typeof deleteCategory$1;
3859
- declare const queryCategories: BuildRESTFunction<typeof queryCategories$1> & typeof queryCategories$1;
3860
- declare const searchCategories: BuildRESTFunction<typeof searchCategories$1> & typeof searchCategories$1;
3861
- declare const countCategories: BuildRESTFunction<typeof countCategories$1> & typeof countCategories$1;
3862
- declare const moveCategory: BuildRESTFunction<typeof moveCategory$1> & typeof moveCategory$1;
3863
- declare const bulkUpdateCategories: BuildRESTFunction<typeof bulkUpdateCategories$1> & typeof bulkUpdateCategories$1;
3864
- declare const updateCategoryVisibility: BuildRESTFunction<typeof updateCategoryVisibility$1> & typeof updateCategoryVisibility$1;
3865
- declare const bulkAddItemsToCategory: BuildRESTFunction<typeof bulkAddItemsToCategory$1> & typeof bulkAddItemsToCategory$1;
3866
- declare const bulkAddItemToCategories: BuildRESTFunction<typeof bulkAddItemToCategories$1> & typeof bulkAddItemToCategories$1;
3867
- declare const bulkRemoveItemsFromCategory: BuildRESTFunction<typeof bulkRemoveItemsFromCategory$1> & typeof bulkRemoveItemsFromCategory$1;
3868
- declare const bulkRemoveItemFromCategories: BuildRESTFunction<typeof bulkRemoveItemFromCategories$1> & typeof bulkRemoveItemFromCategories$1;
3869
- declare const listItemsInCategory: BuildRESTFunction<typeof listItemsInCategory$1> & typeof listItemsInCategory$1;
3870
- declare const listCategoriesForItem: BuildRESTFunction<typeof listCategoriesForItem$1> & typeof listCategoriesForItem$1;
3871
- declare const listTrees: BuildRESTFunction<typeof listTrees$1> & typeof listTrees$1;
3872
- declare const setArrangedItems: BuildRESTFunction<typeof setArrangedItems$1> & typeof setArrangedItems$1;
3873
- declare const getArrangedItems: BuildRESTFunction<typeof getArrangedItems$1> & typeof getArrangedItems$1;
4249
+ declare const createCategory: MaybeContext<BuildRESTFunction<typeof createCategory$1> & typeof createCategory$1>;
4250
+ declare const getCategory: MaybeContext<BuildRESTFunction<typeof getCategory$1> & typeof getCategory$1>;
4251
+ declare const updateCategory: MaybeContext<BuildRESTFunction<typeof updateCategory$1> & typeof updateCategory$1>;
4252
+ declare const deleteCategory: MaybeContext<BuildRESTFunction<typeof deleteCategory$1> & typeof deleteCategory$1>;
4253
+ declare const queryCategories: MaybeContext<BuildRESTFunction<typeof queryCategories$1> & typeof queryCategories$1>;
4254
+ declare const searchCategories: MaybeContext<BuildRESTFunction<typeof searchCategories$1> & typeof searchCategories$1>;
4255
+ declare const countCategories: MaybeContext<BuildRESTFunction<typeof countCategories$1> & typeof countCategories$1>;
4256
+ declare const moveCategory: MaybeContext<BuildRESTFunction<typeof moveCategory$1> & typeof moveCategory$1>;
4257
+ declare const bulkUpdateCategories: MaybeContext<BuildRESTFunction<typeof bulkUpdateCategories$1> & typeof bulkUpdateCategories$1>;
4258
+ declare const updateCategoryVisibility: MaybeContext<BuildRESTFunction<typeof updateCategoryVisibility$1> & typeof updateCategoryVisibility$1>;
4259
+ declare const bulkAddItemsToCategory: MaybeContext<BuildRESTFunction<typeof bulkAddItemsToCategory$1> & typeof bulkAddItemsToCategory$1>;
4260
+ declare const bulkAddItemToCategories: MaybeContext<BuildRESTFunction<typeof bulkAddItemToCategories$1> & typeof bulkAddItemToCategories$1>;
4261
+ declare const bulkRemoveItemsFromCategory: MaybeContext<BuildRESTFunction<typeof bulkRemoveItemsFromCategory$1> & typeof bulkRemoveItemsFromCategory$1>;
4262
+ declare const bulkRemoveItemFromCategories: MaybeContext<BuildRESTFunction<typeof bulkRemoveItemFromCategories$1> & typeof bulkRemoveItemFromCategories$1>;
4263
+ declare const listItemsInCategory: MaybeContext<BuildRESTFunction<typeof listItemsInCategory$1> & typeof listItemsInCategory$1>;
4264
+ declare const listCategoriesForItem: MaybeContext<BuildRESTFunction<typeof listCategoriesForItem$1> & typeof listCategoriesForItem$1>;
4265
+ declare const listTrees: MaybeContext<BuildRESTFunction<typeof listTrees$1> & typeof listTrees$1>;
4266
+ declare const setArrangedItems: MaybeContext<BuildRESTFunction<typeof setArrangedItems$1> & typeof setArrangedItems$1>;
4267
+ declare const getArrangedItems: MaybeContext<BuildRESTFunction<typeof getArrangedItems$1> & typeof getArrangedItems$1>;
3874
4268
 
3875
4269
  type _publicOnCategoryCreatedType = typeof onCategoryCreated$1;
3876
4270
  /** */
@@ -1470,8 +1470,9 @@ interface QueryCategoriesRequest$1 {
1470
1470
  /** Category tree reference details. */
1471
1471
  treeReference: TreeReference$1;
1472
1472
  /**
1473
- * Whether to return categories with `visible:false`. Default: false so only visible categories will be in response.
1474
- * Used only in the first request. Following requests use the cursor token.
1473
+ * Whether to return non-visible categories.
1474
+ *
1475
+ * Default: `false` (only visible categories are returned)
1475
1476
  */
1476
1477
  returnNonVisibleCategories?: boolean;
1477
1478
  /** Fields to include in the response. */
@@ -1527,7 +1528,7 @@ declare enum RequestedFields$1 {
1527
1528
  BREADCRUMBS_INFO = "BREADCRUMBS_INFO"
1528
1529
  }
1529
1530
  interface QueryCategoriesResponse$1 {
1530
- /** Categories which satisfy the provided query. */
1531
+ /** List of categories. */
1531
1532
  categories?: Category$1[];
1532
1533
  /** Paging metadata. */
1533
1534
  pagingMetadata?: CursorPagingMetadata$1;
@@ -4169,8 +4170,9 @@ interface QueryCategoriesRequest {
4169
4170
  /** Category tree reference details. */
4170
4171
  treeReference: TreeReference;
4171
4172
  /**
4172
- * Whether to return categories with `visible:false`. Default: false so only visible categories will be in response.
4173
- * Used only in the first request. Following requests use the cursor token.
4173
+ * Whether to return non-visible categories.
4174
+ *
4175
+ * Default: `false` (only visible categories are returned)
4174
4176
  */
4175
4177
  returnNonVisibleCategories?: boolean;
4176
4178
  /** Fields to include in the response. */
@@ -4226,7 +4228,7 @@ declare enum RequestedFields {
4226
4228
  BREADCRUMBS_INFO = "BREADCRUMBS_INFO"
4227
4229
  }
4228
4230
  interface QueryCategoriesResponse {
4229
- /** Categories which satisfy the provided query. */
4231
+ /** List of categories. */
4230
4232
  categories?: Category[];
4231
4233
  /** Paging metadata. */
4232
4234
  pagingMetadata?: CursorPagingMetadata;