@hey-api/openapi-ts 0.96.1 → 0.97.1
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/README.md +1 -1
- package/dist/clients/angular/client.ts +30 -20
- package/dist/clients/angular/types.ts +4 -2
- package/dist/clients/angular/utils.ts +4 -2
- package/dist/clients/fetch/client.ts +111 -129
- package/dist/clients/fetch/types.ts +4 -2
- package/dist/clients/fetch/utils.ts +4 -2
- package/dist/clients/ky/client.ts +156 -121
- package/dist/clients/ky/index.ts +0 -1
- package/dist/clients/ky/types.ts +22 -34
- package/dist/clients/ky/utils.ts +4 -2
- package/dist/clients/next/client.ts +102 -100
- package/dist/clients/next/types.ts +2 -1
- package/dist/clients/next/utils.ts +2 -1
- package/dist/clients/ofetch/client.ts +68 -58
- package/dist/clients/ofetch/types.ts +4 -2
- package/dist/clients/ofetch/utils.ts +5 -3
- package/dist/index.d.mts +582 -1017
- package/dist/index.d.mts.map +1 -1
- package/dist/index.mjs +2 -2
- package/dist/{init-D4xuNKgu.mjs → init-Bi6_Uyy_.mjs} +348 -26
- package/dist/init-Bi6_Uyy_.mjs.map +1 -0
- package/dist/internal.d.mts +1 -1
- package/dist/internal.mjs +1 -1
- package/dist/run.mjs +2 -2
- package/dist/{src-DlsTSwMY.mjs → src-CSz9FXkH.mjs} +19 -10
- package/dist/src-CSz9FXkH.mjs.map +1 -0
- package/dist/{types-DAEl4_a4.d.mts → types-KzipN7UT.d.mts} +7 -2
- package/dist/types-KzipN7UT.d.mts.map +1 -0
- package/package.json +6 -5
- package/dist/init-D4xuNKgu.mjs.map +0 -1
- package/dist/src-DlsTSwMY.mjs.map +0 -1
- package/dist/types-DAEl4_a4.d.mts.map +0 -1
package/dist/index.d.mts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { n as UserConfig } from "./types-
|
|
1
|
+
import { n as UserConfig } from "./types-KzipN7UT.mjs";
|
|
2
2
|
import { AnalysisContext, BindingKind, ExportModule, File, FromRef, ImportModule, Language, Logger, Logger as Logger$1, Node, NodeName, NodeNameSanitizer, NodeRelationship, NodeScope, Ref, RenderContext, Renderer, Symbol } from "@hey-api/codegen-core";
|
|
3
3
|
import { BaseOutput, Casing, Context, DefinePlugin, DefinePlugin as DefinePlugin$1, FeatureToggle, IR, IR as IR$1, NameTransformer, NamingConfig, NamingOptions, NamingRule, OpenApi, OpenApiMetaObject, OpenApiOperationObject, OpenApiParameterObject, OpenApiRequestBodyObject, OpenApiResponseObject, OpenApiSchemaObject, OperationPath, OperationPathStrategy, OperationStrategy, OperationsStrategy, Plugin, Plugin as Plugin$1, RequestSchemaContext, ResolvedRequestValidatorLayer, SchemaVisitorContext, SchemaWithType, Walker, defaultPaginationKeywords, definePluginConfig, utils } from "@hey-api/shared";
|
|
4
4
|
import ts from "typescript";
|
|
@@ -2706,7 +2706,11 @@ type ServerSentEventsResult<TData = unknown, TReturn = void, TNext = unknown> =
|
|
|
2706
2706
|
};
|
|
2707
2707
|
//#endregion
|
|
2708
2708
|
//#region src/plugins/@hey-api/client-angular/bundle/utils.d.ts
|
|
2709
|
-
type ErrInterceptor$4<Err, Res, Req, Options> = (error: Err, response
|
|
2709
|
+
type ErrInterceptor$4<Err, Res, Req, Options> = (error: Err, /** response may be undefined due to a network error where no response object is produced */
|
|
2710
|
+
|
|
2711
|
+
response: Res | undefined, /** request may be undefined, because error may be from building the request object itself */
|
|
2712
|
+
|
|
2713
|
+
request: Req | undefined, options: Options) => Err | Promise<Err>;
|
|
2710
2714
|
type ReqInterceptor$4<Req, Options> = (request: Req, options: Options) => Req | Promise<Req>;
|
|
2711
2715
|
type ResInterceptor$4<Res, Req, Options> = (response: Res, request: Req, options: Options) => Res | Promise<Res>;
|
|
2712
2716
|
declare class Interceptors$4<Interceptor> {
|
|
@@ -2792,9 +2796,9 @@ type RequestResult$6<TData = unknown, TError = unknown, ThrowOnError extends boo
|
|
|
2792
2796
|
response: HttpResponse<TData>;
|
|
2793
2797
|
} | {
|
|
2794
2798
|
data: undefined;
|
|
2795
|
-
error: TError[keyof TError];
|
|
2796
|
-
request
|
|
2797
|
-
response
|
|
2799
|
+
error: TError[keyof TError]; /** request may be undefined, because error may be from building the request object itself */
|
|
2800
|
+
request?: HttpRequest<unknown>; /** response may be undefined, because error may be from building the request object itself or from a network error */
|
|
2801
|
+
response?: HttpErrorResponse & {
|
|
2798
2802
|
error: TError[keyof TError] | null;
|
|
2799
2803
|
};
|
|
2800
2804
|
}>;
|
|
@@ -2905,7 +2909,11 @@ type UserConfig$25 = Plugin$1.Name<'@hey-api/client-axios'> & Client.Config & {
|
|
|
2905
2909
|
type HeyApiClientAxiosPlugin = DefinePlugin$1<UserConfig$25, UserConfig$25>;
|
|
2906
2910
|
//#endregion
|
|
2907
2911
|
//#region src/plugins/@hey-api/client-fetch/bundle/utils.d.ts
|
|
2908
|
-
type ErrInterceptor$3<Err, Res, Req, Options> = (error: Err, response
|
|
2912
|
+
type ErrInterceptor$3<Err, Res, Req, Options> = (error: Err, /** response may be undefined due to a network error where no response object is produced */
|
|
2913
|
+
|
|
2914
|
+
response: Res | undefined, /** request may be undefined, because error may be from building the request object itself */
|
|
2915
|
+
|
|
2916
|
+
request: Req | undefined, options: Options) => Err | Promise<Err>;
|
|
2909
2917
|
type ReqInterceptor$3<Req, Options> = (request: Req, options: Options) => Req | Promise<Req>;
|
|
2910
2918
|
type ResInterceptor$3<Res, Req, Options> = (response: Res, request: Req, options: Options) => Res | Promise<Res>;
|
|
2911
2919
|
declare class Interceptors$3<Interceptor> {
|
|
@@ -2999,8 +3007,8 @@ type RequestResult$4<TData = unknown, TError = unknown, ThrowOnError extends boo
|
|
|
2999
3007
|
data: undefined;
|
|
3000
3008
|
error: TError extends Record<string, unknown> ? TError[keyof TError] : TError;
|
|
3001
3009
|
}) & {
|
|
3002
|
-
request
|
|
3003
|
-
response
|
|
3010
|
+
/** request may be undefined, because error may be from building the request object itself */request?: Request; /** response may be undefined, because error may be from building the request object itself or from a network error */
|
|
3011
|
+
response?: Response;
|
|
3004
3012
|
}>;
|
|
3005
3013
|
interface ClientOptions$4 {
|
|
3006
3014
|
baseUrl?: string;
|
|
@@ -3041,7 +3049,9 @@ type UserConfig$24 = Plugin$1.Name<'@hey-api/client-fetch'> & Client.Config & {
|
|
|
3041
3049
|
type HeyApiClientFetchPlugin = DefinePlugin$1<UserConfig$24, UserConfig$24>;
|
|
3042
3050
|
//#endregion
|
|
3043
3051
|
//#region src/plugins/@hey-api/client-next/bundle/utils.d.ts
|
|
3044
|
-
type ErrInterceptor$2<Err, Res, Options> = (error: Err, response
|
|
3052
|
+
type ErrInterceptor$2<Err, Res, Options> = (error: Err, /** response may be undefined due to a network error where no response object is produced */
|
|
3053
|
+
|
|
3054
|
+
response: Res | undefined, options: Options) => Err | Promise<Err>;
|
|
3045
3055
|
type ReqInterceptor$2<Options> = (options: Options) => void | Promise<void>;
|
|
3046
3056
|
type ResInterceptor$2<Res, Options> = (response: Res, options: Options) => Res | Promise<Res>;
|
|
3047
3057
|
declare class Interceptors$2<Interceptor> {
|
|
@@ -3119,7 +3129,7 @@ type RequestResult$3<TData = unknown, TError = unknown, ThrowOnError extends boo
|
|
|
3119
3129
|
data: undefined;
|
|
3120
3130
|
error: TError extends Record<string, unknown> ? TError[keyof TError] : TError;
|
|
3121
3131
|
}) & {
|
|
3122
|
-
response
|
|
3132
|
+
/** response may be undefined due to a network error where no response object is produced */response?: Response;
|
|
3123
3133
|
}>;
|
|
3124
3134
|
interface ClientOptions$3 {
|
|
3125
3135
|
baseUrl?: string;
|
|
@@ -3231,7 +3241,11 @@ type UserConfig$22 = Plugin$1.Name<'@hey-api/client-nuxt'> & Client.Config;
|
|
|
3231
3241
|
type HeyApiClientNuxtPlugin = DefinePlugin$1<UserConfig$22, UserConfig$22>;
|
|
3232
3242
|
//#endregion
|
|
3233
3243
|
//#region src/plugins/@hey-api/client-ofetch/bundle/utils.d.ts
|
|
3234
|
-
type ErrInterceptor$1<Err, Res, Req, Options> = (error: Err, response
|
|
3244
|
+
type ErrInterceptor$1<Err, Res, Req, Options> = (error: Err, /** response may be undefined due to a network error where no response object is produced */
|
|
3245
|
+
|
|
3246
|
+
response: Res | undefined, /** request may be undefined, because error may be from building the request object itself */
|
|
3247
|
+
|
|
3248
|
+
request: Req | undefined, options: Options) => Err | Promise<Err>;
|
|
3235
3249
|
type ReqInterceptor$1<Req, Options> = (request: Req, options: Options) => Req | Promise<Req>;
|
|
3236
3250
|
type ResInterceptor$1<Res, Req, Options> = (response: Res, request: Req, options: Options) => Res | Promise<Res>;
|
|
3237
3251
|
declare class Interceptors$1<Interceptor> {
|
|
@@ -3385,8 +3399,8 @@ type RequestResult$1<TData = unknown, TError = unknown, ThrowOnError extends boo
|
|
|
3385
3399
|
data: undefined;
|
|
3386
3400
|
error: TError extends Record<string, unknown> ? TError[keyof TError] : TError;
|
|
3387
3401
|
}) & {
|
|
3388
|
-
request
|
|
3389
|
-
response
|
|
3402
|
+
/** request may be undefined, because error may be from building the request object itself */request?: Request; /** response may be undefined due to a network error where no response object is produced */
|
|
3403
|
+
response?: Response;
|
|
3390
3404
|
}>;
|
|
3391
3405
|
interface ClientOptions$1 {
|
|
3392
3406
|
baseUrl?: string;
|
|
@@ -3498,7 +3512,11 @@ type UserConfig$20 = Plugin$1.Name<'@hey-api/client-angular'> & Client.Config &
|
|
|
3498
3512
|
type HeyApiClientAngularPlugin = DefinePlugin$1<UserConfig$20, UserConfig$20>;
|
|
3499
3513
|
//#endregion
|
|
3500
3514
|
//#region src/plugins/@hey-api/client-ky/bundle/utils.d.ts
|
|
3501
|
-
type ErrInterceptor<Err, Res, Req, Options> = (error: Err, response
|
|
3515
|
+
type ErrInterceptor<Err, Res, Req, Options> = (error: Err, /** response may be undefined due to a network error where no response object is produced */
|
|
3516
|
+
|
|
3517
|
+
response: Res | undefined, /** request may be undefined, because error may be from building the request object itself */
|
|
3518
|
+
|
|
3519
|
+
request: Req | undefined, options: Options) => Err | Promise<Err>;
|
|
3502
3520
|
type ReqInterceptor<Req, Options> = (request: Req, options: Options) => Req | Promise<Req>;
|
|
3503
3521
|
type ResInterceptor<Res, Req, Options> = (response: Res, request: Req, options: Options) => Res | Promise<Res>;
|
|
3504
3522
|
declare class Interceptors<Interceptor> {
|
|
@@ -3518,27 +3536,7 @@ interface Middleware<Req, Res, Err, Options> {
|
|
|
3518
3536
|
//#endregion
|
|
3519
3537
|
//#region src/plugins/@hey-api/client-ky/bundle/types.d.ts
|
|
3520
3538
|
type ResponseStyle = 'data' | 'fields';
|
|
3521
|
-
interface
|
|
3522
|
-
/**
|
|
3523
|
-
* Maximum number of retry attempts
|
|
3524
|
-
*
|
|
3525
|
-
* @default 2
|
|
3526
|
-
*/
|
|
3527
|
-
limit?: number;
|
|
3528
|
-
/**
|
|
3529
|
-
* HTTP methods to retry
|
|
3530
|
-
*
|
|
3531
|
-
* @default ['get', 'put', 'head', 'delete', 'options', 'trace']
|
|
3532
|
-
*/
|
|
3533
|
-
methods?: Array<'get' | 'post' | 'put' | 'delete' | 'patch' | 'head' | 'options' | 'trace'>;
|
|
3534
|
-
/**
|
|
3535
|
-
* HTTP status codes to retry
|
|
3536
|
-
*
|
|
3537
|
-
* @default [408, 413, 429, 500, 502, 503, 504]
|
|
3538
|
-
*/
|
|
3539
|
-
statusCodes?: number[];
|
|
3540
|
-
}
|
|
3541
|
-
interface Config$15<T extends ClientOptions = ClientOptions> extends Omit<Options, 'body' | 'headers' | 'method' | 'prefixUrl' | 'retry' | 'throwHttpErrors'>, Config$22 {
|
|
3539
|
+
interface Config$15<T extends ClientOptions = ClientOptions> extends Pick<Options, 'cache' | 'credentials' | 'retry' | 'signal' | 'integrity' | 'keepalive' | 'mode' | 'redirect' | 'referrer' | 'referrerPolicy' | 'timeout'>, Config$22 {
|
|
3542
3540
|
/**
|
|
3543
3541
|
* Base URL for all requests made by this client.
|
|
3544
3542
|
*/
|
|
@@ -3546,6 +3544,10 @@ interface Config$15<T extends ClientOptions = ClientOptions> extends Omit<Option
|
|
|
3546
3544
|
/**
|
|
3547
3545
|
* Ky instance to use. You can use this option to provide a custom
|
|
3548
3546
|
* ky instance.
|
|
3547
|
+
*
|
|
3548
|
+
* Note that the `prefixUrl` of your ky instance will be ignored, as we
|
|
3549
|
+
* will always build the full URL and pass it to your ky instance. You
|
|
3550
|
+
* should configure `baseUrl` instead.
|
|
3549
3551
|
*/
|
|
3550
3552
|
ky?: typeof ky;
|
|
3551
3553
|
/**
|
|
@@ -3568,22 +3570,12 @@ interface Config$15<T extends ClientOptions = ClientOptions> extends Omit<Option
|
|
|
3568
3570
|
* @default 'fields'
|
|
3569
3571
|
*/
|
|
3570
3572
|
responseStyle?: ResponseStyle;
|
|
3571
|
-
/**
|
|
3572
|
-
* Retry configuration
|
|
3573
|
-
*/
|
|
3574
|
-
retry?: RetryOptions;
|
|
3575
3573
|
/**
|
|
3576
3574
|
* Throw an error instead of returning it in the response?
|
|
3577
3575
|
*
|
|
3578
3576
|
* @default false
|
|
3579
3577
|
*/
|
|
3580
3578
|
throwOnError?: T['throwOnError'];
|
|
3581
|
-
/**
|
|
3582
|
-
* Request timeout in milliseconds
|
|
3583
|
-
*
|
|
3584
|
-
* @default 10000
|
|
3585
|
-
*/
|
|
3586
|
-
timeout?: number;
|
|
3587
3579
|
}
|
|
3588
3580
|
interface RequestOptions<TData = unknown, TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends Config$15<{
|
|
3589
3581
|
responseStyle: TResponseStyle;
|
|
@@ -3618,8 +3610,8 @@ type RequestResult<TData = unknown, TError = unknown, ThrowOnError extends boole
|
|
|
3618
3610
|
data: undefined;
|
|
3619
3611
|
error: TError extends Record<string, unknown> ? TError[keyof TError] : TError;
|
|
3620
3612
|
}) & {
|
|
3621
|
-
request
|
|
3622
|
-
response
|
|
3613
|
+
/** request may be undefined, because error may be from building the request object itself */request?: Request; /** response may be undefined due to a network error where no response object is produced */
|
|
3614
|
+
response?: Response;
|
|
3623
3615
|
}>;
|
|
3624
3616
|
interface ClientOptions {
|
|
3625
3617
|
baseUrl?: string;
|
|
@@ -5369,139 +5361,61 @@ type UserConfig$13 = Plugin$1.Name<'@tanstack/angular-query-experimental'> & Plu
|
|
|
5369
5361
|
*/
|
|
5370
5362
|
name?: NameTransformer;
|
|
5371
5363
|
};
|
|
5372
|
-
};
|
|
5373
|
-
type Config$10 = Plugin$1.Name<'@tanstack/angular-query-experimental'> & Plugin$1.Hooks & Plugin$1.Comments & Plugin$1.Exports & {
|
|
5374
|
-
/**
|
|
5375
|
-
* Casing convention for generated names.
|
|
5376
|
-
*/
|
|
5377
|
-
case: Casing;
|
|
5378
5364
|
/**
|
|
5379
|
-
*
|
|
5365
|
+
* Configuration for generated `setQueryData` helpers.
|
|
5380
5366
|
*
|
|
5381
|
-
*
|
|
5382
|
-
|
|
5383
|
-
|
|
5384
|
-
|
|
5385
|
-
|
|
5386
|
-
|
|
5387
|
-
|
|
5388
|
-
|
|
5389
|
-
*/
|
|
5390
|
-
tags: boolean;
|
|
5391
|
-
};
|
|
5392
|
-
/**
|
|
5393
|
-
* Resolved configuration for generated infinite query options helpers.
|
|
5367
|
+
* When enabled, generates a helper per query operation that wraps
|
|
5368
|
+
* `queryClient.setQueryData()` with the correct query key and response
|
|
5369
|
+
* type already wired up.
|
|
5370
|
+
*
|
|
5371
|
+
* Can be:
|
|
5372
|
+
* - `boolean`: Shorthand for `{ enabled: boolean }`
|
|
5373
|
+
* - `string` or `function`: Shorthand for `{ name: string | function }`
|
|
5374
|
+
* - `object`: Full configuration object
|
|
5394
5375
|
*
|
|
5395
|
-
* @
|
|
5376
|
+
* @default false
|
|
5396
5377
|
*/
|
|
5397
|
-
|
|
5378
|
+
setQueryData?: boolean | NameTransformer | {
|
|
5398
5379
|
/**
|
|
5399
|
-
*
|
|
5400
|
-
* Can return any valid meta object that will be included in the generated infinite query options.
|
|
5401
|
-
* @param operation - The operation object containing all available metadata
|
|
5402
|
-
* @returns A meta object with any properties you want to include
|
|
5403
|
-
*
|
|
5404
|
-
* @example
|
|
5405
|
-
* ```ts
|
|
5406
|
-
* meta: (operation) => ({
|
|
5407
|
-
* customField: operation.id,
|
|
5408
|
-
* isDeprecated: operation.deprecated,
|
|
5409
|
-
* tags: operation.tags,
|
|
5410
|
-
* customObject: {
|
|
5411
|
-
* method: operation.method,
|
|
5412
|
-
* path: operation.path
|
|
5413
|
-
* }
|
|
5414
|
-
* })
|
|
5415
|
-
* ```
|
|
5380
|
+
* Casing convention for generated names.
|
|
5416
5381
|
*
|
|
5417
|
-
* @default
|
|
5382
|
+
* @default 'camelCase'
|
|
5418
5383
|
*/
|
|
5419
|
-
|
|
5420
|
-
};
|
|
5421
|
-
/**
|
|
5422
|
-
* Resolved configuration for generated mutation options helpers.
|
|
5423
|
-
*
|
|
5424
|
-
* @see https://tanstack.com/query/v5/docs/framework/angular/reference/useMutation
|
|
5425
|
-
*/
|
|
5426
|
-
mutationOptions: NamingOptions & FeatureToggle & {
|
|
5384
|
+
case?: Casing;
|
|
5427
5385
|
/**
|
|
5428
|
-
* Whether
|
|
5386
|
+
* Whether this feature is enabled.
|
|
5429
5387
|
*
|
|
5430
5388
|
* @default true
|
|
5431
5389
|
*/
|
|
5432
|
-
|
|
5390
|
+
enabled?: boolean;
|
|
5433
5391
|
/**
|
|
5434
|
-
*
|
|
5435
|
-
* Can return any valid meta object that will be included in the generated mutation options.
|
|
5436
|
-
* @param operation - The operation object containing all available metadata
|
|
5437
|
-
* @returns A meta object with any properties you want to include
|
|
5438
|
-
*
|
|
5439
|
-
* @example
|
|
5440
|
-
* ```ts
|
|
5441
|
-
* meta: (operation) => ({
|
|
5442
|
-
* customField: operation.id,
|
|
5443
|
-
* isDeprecated: operation.deprecated,
|
|
5444
|
-
* tags: operation.tags,
|
|
5445
|
-
* customObject: {
|
|
5446
|
-
* method: operation.method,
|
|
5447
|
-
* path: operation.path
|
|
5448
|
-
* }
|
|
5449
|
-
* })
|
|
5450
|
-
* ```
|
|
5392
|
+
* Naming pattern for generated names.
|
|
5451
5393
|
*
|
|
5452
|
-
* @default
|
|
5394
|
+
* @default '{{name}}SetQueryData'
|
|
5453
5395
|
*/
|
|
5454
|
-
|
|
5396
|
+
name?: NameTransformer;
|
|
5455
5397
|
};
|
|
5456
|
-
|
|
5457
|
-
|
|
5458
|
-
|
|
5459
|
-
|
|
5460
|
-
|
|
5398
|
+
};
|
|
5399
|
+
type Config$10 = Plugin$1.Name<'@tanstack/angular-query-experimental'> & Plugin$1.Hooks & Plugin$1.Comments & Plugin$1.Exports & {
|
|
5400
|
+
/** Casing convention for generated names. */case: Casing; /** Resolved configuration for generated infinite query key helpers. */
|
|
5401
|
+
infiniteQueryKeys: NamingOptions & FeatureToggle & {
|
|
5402
|
+
/** Whether to include operation tags in infinite query keys. */tags: boolean;
|
|
5403
|
+
}; /** Resolved configuration for generated infinite query options helpers. */
|
|
5404
|
+
infiniteQueryOptions: NamingOptions & FeatureToggle & {
|
|
5405
|
+
/** Custom function to generate metadata for the operation. */meta: (operation: IR$1.OperationObject) => Record<string, unknown>;
|
|
5406
|
+
}; /** Resolved configuration for generated mutation options helpers. */
|
|
5407
|
+
mutationOptions: NamingOptions & FeatureToggle & {
|
|
5408
|
+
/** Whether to export generated symbols. */exported: boolean; /** Custom function to generate metadata for the operation. */
|
|
5409
|
+
meta: (operation: IR$1.OperationObject) => Record<string, unknown>;
|
|
5410
|
+
}; /** Resolved configuration for generated query keys. */
|
|
5461
5411
|
queryKeys: NamingOptions & FeatureToggle & {
|
|
5462
|
-
/**
|
|
5463
|
-
|
|
5464
|
-
* This will make query keys larger but provides better cache invalidation capabilities.
|
|
5465
|
-
*
|
|
5466
|
-
* @default false
|
|
5467
|
-
*/
|
|
5468
|
-
tags: boolean;
|
|
5469
|
-
};
|
|
5470
|
-
/**
|
|
5471
|
-
* Resolved configuration for generated query options helpers.
|
|
5472
|
-
*
|
|
5473
|
-
* @see https://tanstack.com/query/v5/docs/framework/angular/reference/queryOptions
|
|
5474
|
-
*/
|
|
5412
|
+
/** Whether to include operation tags in query keys. */tags: boolean;
|
|
5413
|
+
}; /** Resolved configuration for generated query options helpers. */
|
|
5475
5414
|
queryOptions: NamingOptions & FeatureToggle & {
|
|
5476
|
-
/**
|
|
5477
|
-
* Whether to export generated symbols.
|
|
5478
|
-
*
|
|
5479
|
-
* @default true
|
|
5480
|
-
*/
|
|
5481
|
-
exported: boolean;
|
|
5482
|
-
/**
|
|
5483
|
-
* Custom function to generate metadata for the operation.
|
|
5484
|
-
* Can return any valid meta object that will be included in the generated query options.
|
|
5485
|
-
* @param operation - The operation object containing all available metadata
|
|
5486
|
-
* @returns A meta object with any properties you want to include
|
|
5487
|
-
*
|
|
5488
|
-
* @example
|
|
5489
|
-
* ```ts
|
|
5490
|
-
* meta: (operation) => ({
|
|
5491
|
-
* customField: operation.id,
|
|
5492
|
-
* isDeprecated: operation.deprecated,
|
|
5493
|
-
* tags: operation.tags,
|
|
5494
|
-
* customObject: {
|
|
5495
|
-
* method: operation.method,
|
|
5496
|
-
* path: operation.path
|
|
5497
|
-
* }
|
|
5498
|
-
* })
|
|
5499
|
-
* ```
|
|
5500
|
-
*
|
|
5501
|
-
* @default undefined
|
|
5502
|
-
*/
|
|
5415
|
+
/** Whether to export generated symbols. */exported: boolean; /** Custom function to generate metadata for the operation. */
|
|
5503
5416
|
meta: (operation: IR$1.OperationObject) => Record<string, unknown>;
|
|
5504
|
-
};
|
|
5417
|
+
}; /** Resolved configuration for generated `setQueryData` helpers. */
|
|
5418
|
+
setQueryData: NamingOptions & FeatureToggle;
|
|
5505
5419
|
};
|
|
5506
5420
|
type TanStackAngularQueryPlugin = DefinePlugin$1<UserConfig$13, Config$10>;
|
|
5507
5421
|
//#endregion
|
|
@@ -5778,6 +5692,40 @@ type UserConfig$12 = Plugin$1.Name<'@tanstack/preact-query'> & Plugin$1.Hooks &
|
|
|
5778
5692
|
*/
|
|
5779
5693
|
name?: NameTransformer;
|
|
5780
5694
|
};
|
|
5695
|
+
/**
|
|
5696
|
+
* Configuration for generated `setQueryData` helpers.
|
|
5697
|
+
*
|
|
5698
|
+
* When enabled, generates a helper per query operation that wraps
|
|
5699
|
+
* `queryClient.setQueryData()` with the correct query key and response
|
|
5700
|
+
* type already wired up.
|
|
5701
|
+
*
|
|
5702
|
+
* Can be:
|
|
5703
|
+
* - `boolean`: Shorthand for `{ enabled: boolean }`
|
|
5704
|
+
* - `string` or `function`: Shorthand for `{ name: string | function }`
|
|
5705
|
+
* - `object`: Full configuration object
|
|
5706
|
+
*
|
|
5707
|
+
* @default false
|
|
5708
|
+
*/
|
|
5709
|
+
setQueryData?: boolean | NameTransformer | {
|
|
5710
|
+
/**
|
|
5711
|
+
* Casing convention for generated names.
|
|
5712
|
+
*
|
|
5713
|
+
* @default 'camelCase'
|
|
5714
|
+
*/
|
|
5715
|
+
case?: Casing;
|
|
5716
|
+
/**
|
|
5717
|
+
* Whether this feature is enabled.
|
|
5718
|
+
*
|
|
5719
|
+
* @default true
|
|
5720
|
+
*/
|
|
5721
|
+
enabled?: boolean;
|
|
5722
|
+
/**
|
|
5723
|
+
* Naming pattern for generated names.
|
|
5724
|
+
*
|
|
5725
|
+
* @default '{{name}}SetQueryData'
|
|
5726
|
+
*/
|
|
5727
|
+
name?: NameTransformer;
|
|
5728
|
+
};
|
|
5781
5729
|
/**
|
|
5782
5730
|
* Configuration for generated `useMutation()` function helpers.
|
|
5783
5731
|
*
|
|
@@ -5846,154 +5794,63 @@ type UserConfig$12 = Plugin$1.Name<'@tanstack/preact-query'> & Plugin$1.Hooks &
|
|
|
5846
5794
|
*/
|
|
5847
5795
|
name?: NameTransformer;
|
|
5848
5796
|
};
|
|
5849
|
-
};
|
|
5850
|
-
type Config$9 = Plugin$1.Name<'@tanstack/preact-query'> & Plugin$1.Hooks & Plugin$1.Comments & Plugin$1.Exports & {
|
|
5851
|
-
/**
|
|
5852
|
-
* Casing convention for generated names.
|
|
5853
|
-
*/
|
|
5854
|
-
case: Casing;
|
|
5855
5797
|
/**
|
|
5856
|
-
*
|
|
5798
|
+
* Configuration for generated Preact Query hook variant of `setQueryData`.
|
|
5857
5799
|
*
|
|
5858
|
-
*
|
|
5859
|
-
|
|
5860
|
-
infiniteQueryKeys: NamingOptions & FeatureToggle & {
|
|
5861
|
-
/**
|
|
5862
|
-
* Whether to include operation tags in infinite query keys.
|
|
5863
|
-
* This will make query keys larger but provides better cache invalidation capabilities.
|
|
5864
|
-
*
|
|
5865
|
-
* @default false
|
|
5866
|
-
*/
|
|
5867
|
-
tags: boolean;
|
|
5868
|
-
};
|
|
5869
|
-
/**
|
|
5870
|
-
* Resolved configuration for generated infinite query options helpers.
|
|
5800
|
+
* When enabled, generates a hook per query operation that calls
|
|
5801
|
+
* `useQueryClient()` internally and returns a typed setter function.
|
|
5871
5802
|
*
|
|
5872
|
-
*
|
|
5803
|
+
* Can be:
|
|
5804
|
+
* - `boolean`: Shorthand for `{ enabled: boolean }`
|
|
5805
|
+
* - `string` or `function`: Shorthand for `{ name: string | function }`
|
|
5806
|
+
* - `object`: Full configuration object
|
|
5807
|
+
*
|
|
5808
|
+
* @default false
|
|
5873
5809
|
*/
|
|
5874
|
-
|
|
5810
|
+
useSetQueryData?: boolean | NameTransformer | {
|
|
5875
5811
|
/**
|
|
5876
|
-
*
|
|
5877
|
-
* Can return any valid meta object that will be included in the generated infinite query options.
|
|
5878
|
-
*
|
|
5879
|
-
* @param operation - The operation object containing all available metadata
|
|
5880
|
-
* @returns A meta object with any properties you want to include
|
|
5881
|
-
*
|
|
5882
|
-
* @example
|
|
5883
|
-
* ```ts
|
|
5884
|
-
* meta: (operation) => ({
|
|
5885
|
-
* customField: operation.id,
|
|
5886
|
-
* isDeprecated: operation.deprecated,
|
|
5887
|
-
* tags: operation.tags,
|
|
5888
|
-
* customObject: {
|
|
5889
|
-
* method: operation.method,
|
|
5890
|
-
* path: operation.path
|
|
5891
|
-
* }
|
|
5892
|
-
* })
|
|
5893
|
-
* ```
|
|
5812
|
+
* Casing convention for generated names.
|
|
5894
5813
|
*
|
|
5895
|
-
* @default
|
|
5814
|
+
* @default 'camelCase'
|
|
5896
5815
|
*/
|
|
5897
|
-
|
|
5898
|
-
};
|
|
5899
|
-
/**
|
|
5900
|
-
* Resolved configuration for generated mutation options helpers.
|
|
5901
|
-
*
|
|
5902
|
-
* See {@link https://tanstack.com/query/v5/docs/framework/preact/reference/useMutation useMutation}
|
|
5903
|
-
*/
|
|
5904
|
-
mutationOptions: NamingOptions & FeatureToggle & {
|
|
5816
|
+
case?: Casing;
|
|
5905
5817
|
/**
|
|
5906
|
-
* Whether
|
|
5818
|
+
* Whether this feature is enabled.
|
|
5907
5819
|
*
|
|
5908
5820
|
* @default true
|
|
5909
5821
|
*/
|
|
5910
|
-
|
|
5822
|
+
enabled?: boolean;
|
|
5911
5823
|
/**
|
|
5912
|
-
*
|
|
5913
|
-
* Can return any valid meta object that will be included in the generated mutation options.
|
|
5914
|
-
*
|
|
5915
|
-
* @param operation - The operation object containing all available metadata
|
|
5916
|
-
* @returns A meta object with any properties you want to include
|
|
5917
|
-
*
|
|
5918
|
-
* @example
|
|
5919
|
-
* ```ts
|
|
5920
|
-
* meta: (operation) => ({
|
|
5921
|
-
* customField: operation.id,
|
|
5922
|
-
* isDeprecated: operation.deprecated,
|
|
5923
|
-
* tags: operation.tags,
|
|
5924
|
-
* customObject: {
|
|
5925
|
-
* method: operation.method,
|
|
5926
|
-
* path: operation.path
|
|
5927
|
-
* }
|
|
5928
|
-
* })
|
|
5929
|
-
* ```
|
|
5824
|
+
* Naming pattern for generated names.
|
|
5930
5825
|
*
|
|
5931
|
-
* @default
|
|
5826
|
+
* @default 'use{{name}}SetQueryData'
|
|
5932
5827
|
*/
|
|
5933
|
-
|
|
5828
|
+
name?: NameTransformer;
|
|
5934
5829
|
};
|
|
5935
|
-
|
|
5936
|
-
|
|
5937
|
-
|
|
5938
|
-
|
|
5939
|
-
|
|
5830
|
+
};
|
|
5831
|
+
type Config$9 = Plugin$1.Name<'@tanstack/preact-query'> & Plugin$1.Hooks & Plugin$1.Comments & Plugin$1.Exports & {
|
|
5832
|
+
/** Casing convention for generated names. */case: Casing; /** Resolved configuration for generated infinite query key helpers. */
|
|
5833
|
+
infiniteQueryKeys: NamingOptions & FeatureToggle & {
|
|
5834
|
+
/** Whether to include operation tags in infinite query keys. */tags: boolean;
|
|
5835
|
+
}; /** Resolved configuration for generated infinite query options helpers. */
|
|
5836
|
+
infiniteQueryOptions: NamingOptions & FeatureToggle & {
|
|
5837
|
+
/** Custom function to generate metadata for the operation. */meta: (operation: IR$1.OperationObject) => Record<string, unknown>;
|
|
5838
|
+
}; /** Resolved configuration for generated mutation options helpers. */
|
|
5839
|
+
mutationOptions: NamingOptions & FeatureToggle & {
|
|
5840
|
+
/** Whether to export generated symbols. */exported: boolean; /** Custom function to generate metadata for the operation. */
|
|
5841
|
+
meta: (operation: IR$1.OperationObject) => Record<string, unknown>;
|
|
5842
|
+
}; /** Resolved configuration for generated query keys. */
|
|
5940
5843
|
queryKeys: NamingOptions & FeatureToggle & {
|
|
5941
|
-
/**
|
|
5942
|
-
|
|
5943
|
-
* This will make query keys larger but provides better cache invalidation capabilities.
|
|
5944
|
-
*
|
|
5945
|
-
* @default false
|
|
5946
|
-
*/
|
|
5947
|
-
tags: boolean;
|
|
5948
|
-
};
|
|
5949
|
-
/**
|
|
5950
|
-
* Resolved configuration for generated query options helpers.
|
|
5951
|
-
*
|
|
5952
|
-
* See {@link https://tanstack.com/query/v5/docs/framework/preact/reference/queryOptions queryOptions}
|
|
5953
|
-
*/
|
|
5844
|
+
/** Whether to include operation tags in query keys. */tags: boolean;
|
|
5845
|
+
}; /** Resolved configuration for generated query options helpers. */
|
|
5954
5846
|
queryOptions: NamingOptions & FeatureToggle & {
|
|
5955
|
-
/**
|
|
5956
|
-
* Whether to export generated symbols.
|
|
5957
|
-
*
|
|
5958
|
-
* @default true
|
|
5959
|
-
*/
|
|
5960
|
-
exported: boolean;
|
|
5961
|
-
/**
|
|
5962
|
-
* Custom function to generate metadata for the operation.
|
|
5963
|
-
* Can return any valid meta object that will be included in the generated query options.
|
|
5964
|
-
*
|
|
5965
|
-
* @param operation - The operation object containing all available metadata
|
|
5966
|
-
* @returns A meta object with any properties you want to include
|
|
5967
|
-
*
|
|
5968
|
-
* @example
|
|
5969
|
-
* ```ts
|
|
5970
|
-
* meta: (operation) => ({
|
|
5971
|
-
* customField: operation.id,
|
|
5972
|
-
* isDeprecated: operation.deprecated,
|
|
5973
|
-
* tags: operation.tags,
|
|
5974
|
-
* customObject: {
|
|
5975
|
-
* method: operation.method,
|
|
5976
|
-
* path: operation.path
|
|
5977
|
-
* }
|
|
5978
|
-
* })
|
|
5979
|
-
* ```
|
|
5980
|
-
*
|
|
5981
|
-
* @default undefined
|
|
5982
|
-
*/
|
|
5847
|
+
/** Whether to export generated symbols. */exported: boolean; /** Custom function to generate metadata for the operation. */
|
|
5983
5848
|
meta: (operation: IR$1.OperationObject) => Record<string, unknown>;
|
|
5984
|
-
};
|
|
5985
|
-
/**
|
|
5986
|
-
|
|
5987
|
-
|
|
5988
|
-
|
|
5989
|
-
*/
|
|
5990
|
-
useMutation: NamingOptions & FeatureToggle;
|
|
5991
|
-
/**
|
|
5992
|
-
* Configuration for generated `useQuery()` function helpers.
|
|
5993
|
-
*
|
|
5994
|
-
* See {@link https://tanstack.com/query/v5/docs/framework/preact/reference/useQuery useQuery}
|
|
5995
|
-
*/
|
|
5996
|
-
useQuery: NamingOptions & FeatureToggle;
|
|
5849
|
+
}; /** Resolved configuration for generated `setQueryData` helpers. */
|
|
5850
|
+
setQueryData: NamingOptions & FeatureToggle; /** Configuration for generated `useMutation()` function helpers. */
|
|
5851
|
+
useMutation: NamingOptions & FeatureToggle; /** Configuration for generated `useQuery()` function helpers. */
|
|
5852
|
+
useQuery: NamingOptions & FeatureToggle; /** Configuration for generated Preact Query hook variant of `setQueryData`. */
|
|
5853
|
+
useSetQueryData: NamingOptions & FeatureToggle;
|
|
5997
5854
|
};
|
|
5998
5855
|
type TanStackPreactQueryPlugin = DefinePlugin$1<UserConfig$12, Config$9>;
|
|
5999
5856
|
//#endregion
|
|
@@ -6270,6 +6127,40 @@ type UserConfig$11 = Plugin$1.Name<'@tanstack/react-query'> & Plugin$1.Hooks & P
|
|
|
6270
6127
|
*/
|
|
6271
6128
|
name?: NameTransformer;
|
|
6272
6129
|
};
|
|
6130
|
+
/**
|
|
6131
|
+
* Configuration for generated `setQueryData` helpers.
|
|
6132
|
+
*
|
|
6133
|
+
* When enabled, generates a helper per query operation that wraps
|
|
6134
|
+
* `queryClient.setQueryData()` with the correct query key and response
|
|
6135
|
+
* type already wired up.
|
|
6136
|
+
*
|
|
6137
|
+
* Can be:
|
|
6138
|
+
* - `boolean`: Shorthand for `{ enabled: boolean }`
|
|
6139
|
+
* - `string` or `function`: Shorthand for `{ name: string | function }`
|
|
6140
|
+
* - `object`: Full configuration object
|
|
6141
|
+
*
|
|
6142
|
+
* @default false
|
|
6143
|
+
*/
|
|
6144
|
+
setQueryData?: boolean | NameTransformer | {
|
|
6145
|
+
/**
|
|
6146
|
+
* Casing convention for generated names.
|
|
6147
|
+
*
|
|
6148
|
+
* @default 'camelCase'
|
|
6149
|
+
*/
|
|
6150
|
+
case?: Casing;
|
|
6151
|
+
/**
|
|
6152
|
+
* Whether this feature is enabled.
|
|
6153
|
+
*
|
|
6154
|
+
* @default true
|
|
6155
|
+
*/
|
|
6156
|
+
enabled?: boolean;
|
|
6157
|
+
/**
|
|
6158
|
+
* Naming pattern for generated names.
|
|
6159
|
+
*
|
|
6160
|
+
* @default '{{name}}SetQueryData'
|
|
6161
|
+
*/
|
|
6162
|
+
name?: NameTransformer;
|
|
6163
|
+
};
|
|
6273
6164
|
/**
|
|
6274
6165
|
* Configuration for generated `useMutation()` function helpers.
|
|
6275
6166
|
*
|
|
@@ -6338,32 +6229,139 @@ type UserConfig$11 = Plugin$1.Name<'@tanstack/react-query'> & Plugin$1.Hooks & P
|
|
|
6338
6229
|
*/
|
|
6339
6230
|
name?: NameTransformer;
|
|
6340
6231
|
};
|
|
6232
|
+
/**
|
|
6233
|
+
* Configuration for generated React Query hook variant of `setQueryData`.
|
|
6234
|
+
*
|
|
6235
|
+
* When enabled, generates a hook per query operation that calls
|
|
6236
|
+
* `useQueryClient()` internally and returns a typed setter function.
|
|
6237
|
+
*
|
|
6238
|
+
* Can be:
|
|
6239
|
+
* - `boolean`: Shorthand for `{ enabled: boolean }`
|
|
6240
|
+
* - `string` or `function`: Shorthand for `{ name: string | function }`
|
|
6241
|
+
* - `object`: Full configuration object
|
|
6242
|
+
*
|
|
6243
|
+
* @default false
|
|
6244
|
+
*/
|
|
6245
|
+
useSetQueryData?: boolean | NameTransformer | {
|
|
6246
|
+
/**
|
|
6247
|
+
* Casing convention for generated names.
|
|
6248
|
+
*
|
|
6249
|
+
* @default 'camelCase'
|
|
6250
|
+
*/
|
|
6251
|
+
case?: Casing;
|
|
6252
|
+
/**
|
|
6253
|
+
* Whether this feature is enabled.
|
|
6254
|
+
*
|
|
6255
|
+
* @default true
|
|
6256
|
+
*/
|
|
6257
|
+
enabled?: boolean;
|
|
6258
|
+
/**
|
|
6259
|
+
* Naming pattern for generated names.
|
|
6260
|
+
*
|
|
6261
|
+
* @default 'use{{name}}SetQueryData'
|
|
6262
|
+
*/
|
|
6263
|
+
name?: NameTransformer;
|
|
6264
|
+
};
|
|
6341
6265
|
};
|
|
6342
6266
|
type Config$8 = Plugin$1.Name<'@tanstack/react-query'> & Plugin$1.Hooks & Plugin$1.Comments & Plugin$1.Exports & {
|
|
6267
|
+
/** Casing convention for generated names. */case: Casing; /** Resolved configuration for generated infinite query key helpers. */
|
|
6268
|
+
infiniteQueryKeys: NamingOptions & FeatureToggle & {
|
|
6269
|
+
/** Whether to include operation tags in infinite query keys. */tags: boolean;
|
|
6270
|
+
}; /** Resolved configuration for generated infinite query options helpers. */
|
|
6271
|
+
infiniteQueryOptions: NamingOptions & FeatureToggle & {
|
|
6272
|
+
/** Custom function to generate metadata for the operation. */meta: (operation: IR$1.OperationObject) => Record<string, unknown>;
|
|
6273
|
+
}; /** Resolved configuration for generated mutation options helpers. */
|
|
6274
|
+
mutationOptions: NamingOptions & FeatureToggle & {
|
|
6275
|
+
/** Whether to export generated symbols. */exported: boolean; /** Custom function to generate metadata for the operation. */
|
|
6276
|
+
meta: (operation: IR$1.OperationObject) => Record<string, unknown>;
|
|
6277
|
+
}; /** Resolved configuration for generated query keys. */
|
|
6278
|
+
queryKeys: NamingOptions & FeatureToggle & {
|
|
6279
|
+
/** Whether to include operation tags in query keys. */tags: boolean;
|
|
6280
|
+
}; /** Resolved configuration for generated query options helpers. */
|
|
6281
|
+
queryOptions: NamingOptions & FeatureToggle & {
|
|
6282
|
+
/** Whether to export generated symbols. */exported: boolean; /** Custom function to generate metadata for the operation. */
|
|
6283
|
+
meta: (operation: IR$1.OperationObject) => Record<string, unknown>;
|
|
6284
|
+
}; /** Resolved configuration for generated `setQueryData` helpers. */
|
|
6285
|
+
setQueryData: NamingOptions & FeatureToggle; /** Configuration for generated `useMutation()` function helpers. */
|
|
6286
|
+
useMutation: NamingOptions & FeatureToggle; /** Configuration for generated `useQuery()` function helpers. */
|
|
6287
|
+
useQuery: NamingOptions & FeatureToggle; /** Configuration for generated React Query hook variant of `setQueryData`. */
|
|
6288
|
+
useSetQueryData: NamingOptions & FeatureToggle;
|
|
6289
|
+
};
|
|
6290
|
+
type TanStackReactQueryPlugin = DefinePlugin$1<UserConfig$11, Config$8>;
|
|
6291
|
+
//#endregion
|
|
6292
|
+
//#region src/plugins/@tanstack/solid-query/types.d.ts
|
|
6293
|
+
type UserConfig$10 = Plugin$1.Name<'@tanstack/solid-query'> & Plugin$1.Hooks & Plugin$1.UserComments & Plugin$1.UserExports & {
|
|
6343
6294
|
/**
|
|
6344
6295
|
* Casing convention for generated names.
|
|
6296
|
+
*
|
|
6297
|
+
* @default 'camelCase'
|
|
6345
6298
|
*/
|
|
6346
|
-
case
|
|
6299
|
+
case?: Casing;
|
|
6347
6300
|
/**
|
|
6348
|
-
*
|
|
6301
|
+
* Configuration for generated infinite query key helpers.
|
|
6349
6302
|
*
|
|
6350
|
-
* See {@link https://tanstack.com/query/v5/docs/framework/
|
|
6303
|
+
* See {@link https://tanstack.com/query/v5/docs/framework/solid/reference/createInfiniteQuery}
|
|
6304
|
+
*
|
|
6305
|
+
* Can be:
|
|
6306
|
+
* - `boolean`: Shorthand for `{ enabled: boolean }`
|
|
6307
|
+
* - `string` or `function`: Shorthand for `{ name: string | function }`
|
|
6308
|
+
* - `object`: Full configuration object
|
|
6309
|
+
*
|
|
6310
|
+
* @default true
|
|
6351
6311
|
*/
|
|
6352
|
-
infiniteQueryKeys
|
|
6312
|
+
infiniteQueryKeys?: boolean | NameTransformer | {
|
|
6313
|
+
/**
|
|
6314
|
+
* Casing convention for generated names.
|
|
6315
|
+
*
|
|
6316
|
+
* @default 'camelCase'
|
|
6317
|
+
*/
|
|
6318
|
+
case?: Casing;
|
|
6319
|
+
/**
|
|
6320
|
+
* Whether this feature is enabled.
|
|
6321
|
+
*
|
|
6322
|
+
* @default true
|
|
6323
|
+
*/
|
|
6324
|
+
enabled?: boolean;
|
|
6325
|
+
/**
|
|
6326
|
+
* Naming pattern for generated names.
|
|
6327
|
+
*
|
|
6328
|
+
* @default '{{name}}InfiniteQueryKey'
|
|
6329
|
+
* @see https://tanstack.com/query/v5/docs/framework/solid/reference/createInfiniteQuery
|
|
6330
|
+
*/
|
|
6331
|
+
name?: NameTransformer;
|
|
6353
6332
|
/**
|
|
6354
6333
|
* Whether to include operation tags in infinite query keys.
|
|
6355
6334
|
* This will make query keys larger but provides better cache invalidation capabilities.
|
|
6356
6335
|
*
|
|
6357
6336
|
* @default false
|
|
6358
6337
|
*/
|
|
6359
|
-
tags
|
|
6338
|
+
tags?: boolean;
|
|
6360
6339
|
};
|
|
6361
6340
|
/**
|
|
6362
|
-
*
|
|
6341
|
+
* Configuration for generated infinite query options helpers.
|
|
6363
6342
|
*
|
|
6364
|
-
* See {@link https://tanstack.com/query/v5/docs/framework/
|
|
6343
|
+
* See {@link https://tanstack.com/query/v5/docs/framework/solid/reference/createInfiniteQuery}
|
|
6344
|
+
*
|
|
6345
|
+
* Can be:
|
|
6346
|
+
* - `boolean`: Shorthand for `{ enabled: boolean }`
|
|
6347
|
+
* - `string` or `function`: Shorthand for `{ name: string | function }`
|
|
6348
|
+
* - `object`: Full configuration object
|
|
6349
|
+
*
|
|
6350
|
+
* @default true
|
|
6365
6351
|
*/
|
|
6366
|
-
infiniteQueryOptions
|
|
6352
|
+
infiniteQueryOptions?: boolean | NameTransformer | {
|
|
6353
|
+
/**
|
|
6354
|
+
* Casing convention for generated names.
|
|
6355
|
+
*
|
|
6356
|
+
* @default 'camelCase'
|
|
6357
|
+
*/
|
|
6358
|
+
case?: Casing;
|
|
6359
|
+
/**
|
|
6360
|
+
* Whether this feature is enabled.
|
|
6361
|
+
*
|
|
6362
|
+
* @default true
|
|
6363
|
+
*/
|
|
6364
|
+
enabled?: boolean;
|
|
6367
6365
|
/**
|
|
6368
6366
|
* Custom function to generate metadata for the operation.
|
|
6369
6367
|
* Can return any valid meta object that will be included in the generated infinite query options.
|
|
@@ -6386,24 +6384,49 @@ type Config$8 = Plugin$1.Name<'@tanstack/react-query'> & Plugin$1.Hooks & Plugin
|
|
|
6386
6384
|
*
|
|
6387
6385
|
* @default undefined
|
|
6388
6386
|
*/
|
|
6389
|
-
meta
|
|
6387
|
+
meta?: (operation: IR$1.OperationObject) => Record<string, unknown>;
|
|
6388
|
+
/**
|
|
6389
|
+
* Naming pattern for generated names.
|
|
6390
|
+
*
|
|
6391
|
+
* @default '{{name}}InfiniteOptions'
|
|
6392
|
+
* @see https://tanstack.com/query/v5/docs/framework/solid/reference/createInfiniteQuery
|
|
6393
|
+
*/
|
|
6394
|
+
name?: NameTransformer;
|
|
6390
6395
|
};
|
|
6391
6396
|
/**
|
|
6392
|
-
*
|
|
6397
|
+
* Configuration for generated mutation options helpers.
|
|
6393
6398
|
*
|
|
6394
|
-
* See {@link https://tanstack.com/query/v5/docs/framework/
|
|
6399
|
+
* See {@link https://tanstack.com/query/v5/docs/framework/solid/reference/createMutation}
|
|
6400
|
+
*
|
|
6401
|
+
* Can be:
|
|
6402
|
+
* - `boolean`: Shorthand for `{ enabled: boolean }`
|
|
6403
|
+
* - `string` or `function`: Shorthand for `{ name: string | function }`
|
|
6404
|
+
* - `object`: Full configuration object
|
|
6405
|
+
*
|
|
6406
|
+
* @default true
|
|
6395
6407
|
*/
|
|
6396
|
-
mutationOptions
|
|
6408
|
+
mutationOptions?: boolean | NameTransformer | {
|
|
6409
|
+
/**
|
|
6410
|
+
* Casing convention for generated names.
|
|
6411
|
+
*
|
|
6412
|
+
* @default 'camelCase'
|
|
6413
|
+
*/
|
|
6414
|
+
case?: Casing;
|
|
6415
|
+
/**
|
|
6416
|
+
* Whether this feature is enabled.
|
|
6417
|
+
*
|
|
6418
|
+
* @default true
|
|
6419
|
+
*/
|
|
6420
|
+
enabled?: boolean;
|
|
6397
6421
|
/**
|
|
6398
6422
|
* Whether to export generated symbols.
|
|
6399
6423
|
*
|
|
6400
6424
|
* @default true
|
|
6401
6425
|
*/
|
|
6402
|
-
exported
|
|
6426
|
+
exported?: boolean;
|
|
6403
6427
|
/**
|
|
6404
6428
|
* Custom function to generate metadata for the operation.
|
|
6405
6429
|
* Can return any valid meta object that will be included in the generated mutation options.
|
|
6406
|
-
*
|
|
6407
6430
|
* @param operation - The operation object containing all available metadata
|
|
6408
6431
|
* @returns A meta object with any properties you want to include
|
|
6409
6432
|
*
|
|
@@ -6422,85 +6445,19 @@ type Config$8 = Plugin$1.Name<'@tanstack/react-query'> & Plugin$1.Hooks & Plugin
|
|
|
6422
6445
|
*
|
|
6423
6446
|
* @default undefined
|
|
6424
6447
|
*/
|
|
6425
|
-
meta
|
|
6426
|
-
};
|
|
6427
|
-
/**
|
|
6428
|
-
* Resolved configuration for generated query keys.
|
|
6429
|
-
*
|
|
6430
|
-
* See {@link https://tanstack.com/query/v5/docs/framework/react/guides/query-keys Query Keys}
|
|
6431
|
-
*/
|
|
6432
|
-
queryKeys: NamingOptions & FeatureToggle & {
|
|
6433
|
-
/**
|
|
6434
|
-
* Whether to include operation tags in query keys.
|
|
6435
|
-
* This will make query keys larger but provides better cache invalidation capabilities.
|
|
6436
|
-
*
|
|
6437
|
-
* @default false
|
|
6438
|
-
*/
|
|
6439
|
-
tags: boolean;
|
|
6440
|
-
};
|
|
6441
|
-
/**
|
|
6442
|
-
* Resolved configuration for generated query options helpers.
|
|
6443
|
-
*
|
|
6444
|
-
* See {@link https://tanstack.com/query/v5/docs/framework/react/reference/queryOptions queryOptions}
|
|
6445
|
-
*/
|
|
6446
|
-
queryOptions: NamingOptions & FeatureToggle & {
|
|
6447
|
-
/**
|
|
6448
|
-
* Whether to export generated symbols.
|
|
6449
|
-
*
|
|
6450
|
-
* @default true
|
|
6451
|
-
*/
|
|
6452
|
-
exported: boolean;
|
|
6448
|
+
meta?: (operation: IR$1.OperationObject) => Record<string, unknown>;
|
|
6453
6449
|
/**
|
|
6454
|
-
*
|
|
6455
|
-
* Can return any valid meta object that will be included in the generated query options.
|
|
6456
|
-
*
|
|
6457
|
-
* @param operation - The operation object containing all available metadata
|
|
6458
|
-
* @returns A meta object with any properties you want to include
|
|
6459
|
-
*
|
|
6460
|
-
* @example
|
|
6461
|
-
* ```ts
|
|
6462
|
-
* meta: (operation) => ({
|
|
6463
|
-
* customField: operation.id,
|
|
6464
|
-
* isDeprecated: operation.deprecated,
|
|
6465
|
-
* tags: operation.tags,
|
|
6466
|
-
* customObject: {
|
|
6467
|
-
* method: operation.method,
|
|
6468
|
-
* path: operation.path
|
|
6469
|
-
* }
|
|
6470
|
-
* })
|
|
6471
|
-
* ```
|
|
6450
|
+
* Naming pattern for generated names.
|
|
6472
6451
|
*
|
|
6473
|
-
* @default
|
|
6452
|
+
* @default '{{name}}Mutation'
|
|
6453
|
+
* @see https://tanstack.com/query/v5/docs/framework/solid/reference/createMutation
|
|
6474
6454
|
*/
|
|
6475
|
-
|
|
6455
|
+
name?: NameTransformer;
|
|
6476
6456
|
};
|
|
6477
6457
|
/**
|
|
6478
|
-
* Configuration for generated
|
|
6479
|
-
*
|
|
6480
|
-
* See {@link https://tanstack.com/query/v5/docs/framework/react/reference/useMutation useMutation}
|
|
6481
|
-
*/
|
|
6482
|
-
useMutation: NamingOptions & FeatureToggle;
|
|
6483
|
-
/**
|
|
6484
|
-
* Configuration for generated `useQuery()` function helpers.
|
|
6485
|
-
*
|
|
6486
|
-
* See {@link https://tanstack.com/query/v5/docs/framework/react/reference/useQuery useQuery}
|
|
6487
|
-
*/
|
|
6488
|
-
useQuery: NamingOptions & FeatureToggle;
|
|
6489
|
-
};
|
|
6490
|
-
type TanStackReactQueryPlugin = DefinePlugin$1<UserConfig$11, Config$8>;
|
|
6491
|
-
//#endregion
|
|
6492
|
-
//#region src/plugins/@tanstack/solid-query/types.d.ts
|
|
6493
|
-
type UserConfig$10 = Plugin$1.Name<'@tanstack/solid-query'> & Plugin$1.Hooks & Plugin$1.UserComments & Plugin$1.UserExports & {
|
|
6494
|
-
/**
|
|
6495
|
-
* Casing convention for generated names.
|
|
6496
|
-
*
|
|
6497
|
-
* @default 'camelCase'
|
|
6498
|
-
*/
|
|
6499
|
-
case?: Casing;
|
|
6500
|
-
/**
|
|
6501
|
-
* Configuration for generated infinite query key helpers.
|
|
6458
|
+
* Configuration for generated query keys.
|
|
6502
6459
|
*
|
|
6503
|
-
* See {@link https://tanstack.com/query/v5/docs/framework/solid/reference/
|
|
6460
|
+
* See {@link https://tanstack.com/query/v5/docs/framework/solid/reference/queryKey}
|
|
6504
6461
|
*
|
|
6505
6462
|
* Can be:
|
|
6506
6463
|
* - `boolean`: Shorthand for `{ enabled: boolean }`
|
|
@@ -6509,7 +6466,7 @@ type UserConfig$10 = Plugin$1.Name<'@tanstack/solid-query'> & Plugin$1.Hooks & P
|
|
|
6509
6466
|
*
|
|
6510
6467
|
* @default true
|
|
6511
6468
|
*/
|
|
6512
|
-
|
|
6469
|
+
queryKeys?: boolean | NameTransformer | {
|
|
6513
6470
|
/**
|
|
6514
6471
|
* Casing convention for generated names.
|
|
6515
6472
|
*
|
|
@@ -6525,12 +6482,12 @@ type UserConfig$10 = Plugin$1.Name<'@tanstack/solid-query'> & Plugin$1.Hooks & P
|
|
|
6525
6482
|
/**
|
|
6526
6483
|
* Naming pattern for generated names.
|
|
6527
6484
|
*
|
|
6528
|
-
* @default '{{name}}
|
|
6529
|
-
* @see https://tanstack.com/query/v5/docs/framework/solid/reference/
|
|
6485
|
+
* @default '{{name}}QueryKey'
|
|
6486
|
+
* @see https://tanstack.com/query/v5/docs/framework/solid/reference/queryKey
|
|
6530
6487
|
*/
|
|
6531
6488
|
name?: NameTransformer;
|
|
6532
6489
|
/**
|
|
6533
|
-
* Whether to include operation tags in
|
|
6490
|
+
* Whether to include operation tags in query keys.
|
|
6534
6491
|
* This will make query keys larger but provides better cache invalidation capabilities.
|
|
6535
6492
|
*
|
|
6536
6493
|
* @default false
|
|
@@ -6538,9 +6495,9 @@ type UserConfig$10 = Plugin$1.Name<'@tanstack/solid-query'> & Plugin$1.Hooks & P
|
|
|
6538
6495
|
tags?: boolean;
|
|
6539
6496
|
};
|
|
6540
6497
|
/**
|
|
6541
|
-
* Configuration for generated
|
|
6498
|
+
* Configuration for generated query options helpers.
|
|
6542
6499
|
*
|
|
6543
|
-
* See {@link https://tanstack.com/query/v5/docs/framework/solid/reference/
|
|
6500
|
+
* See {@link https://tanstack.com/query/v5/docs/framework/solid/reference/createQuery}
|
|
6544
6501
|
*
|
|
6545
6502
|
* Can be:
|
|
6546
6503
|
* - `boolean`: Shorthand for `{ enabled: boolean }`
|
|
@@ -6549,7 +6506,7 @@ type UserConfig$10 = Plugin$1.Name<'@tanstack/solid-query'> & Plugin$1.Hooks & P
|
|
|
6549
6506
|
*
|
|
6550
6507
|
* @default true
|
|
6551
6508
|
*/
|
|
6552
|
-
|
|
6509
|
+
queryOptions?: boolean | NameTransformer | {
|
|
6553
6510
|
/**
|
|
6554
6511
|
* Casing convention for generated names.
|
|
6555
6512
|
*
|
|
@@ -6563,9 +6520,14 @@ type UserConfig$10 = Plugin$1.Name<'@tanstack/solid-query'> & Plugin$1.Hooks & P
|
|
|
6563
6520
|
*/
|
|
6564
6521
|
enabled?: boolean;
|
|
6565
6522
|
/**
|
|
6566
|
-
*
|
|
6567
|
-
* Can return any valid meta object that will be included in the generated infinite query options.
|
|
6523
|
+
* Whether to export generated symbols.
|
|
6568
6524
|
*
|
|
6525
|
+
* @default true
|
|
6526
|
+
*/
|
|
6527
|
+
exported?: boolean;
|
|
6528
|
+
/**
|
|
6529
|
+
* Custom function to generate metadata for the operation.
|
|
6530
|
+
* Can return any valid meta object that will be included in the generated query options.
|
|
6569
6531
|
* @param operation - The operation object containing all available metadata
|
|
6570
6532
|
* @returns A meta object with any properties you want to include
|
|
6571
6533
|
*
|
|
@@ -6588,24 +6550,26 @@ type UserConfig$10 = Plugin$1.Name<'@tanstack/solid-query'> & Plugin$1.Hooks & P
|
|
|
6588
6550
|
/**
|
|
6589
6551
|
* Naming pattern for generated names.
|
|
6590
6552
|
*
|
|
6591
|
-
* @default '{{name}}
|
|
6592
|
-
* @see https://tanstack.com/query/v5/docs/framework/solid/reference/
|
|
6553
|
+
* @default '{{name}}Options'
|
|
6554
|
+
* @see https://tanstack.com/query/v5/docs/framework/solid/reference/createQuery
|
|
6593
6555
|
*/
|
|
6594
6556
|
name?: NameTransformer;
|
|
6595
6557
|
};
|
|
6596
6558
|
/**
|
|
6597
|
-
* Configuration for generated
|
|
6559
|
+
* Configuration for generated `setQueryData` helpers.
|
|
6598
6560
|
*
|
|
6599
|
-
*
|
|
6561
|
+
* When enabled, generates a helper per query operation that wraps
|
|
6562
|
+
* `queryClient.setQueryData()` with the correct query key and response
|
|
6563
|
+
* type already wired up.
|
|
6600
6564
|
*
|
|
6601
6565
|
* Can be:
|
|
6602
6566
|
* - `boolean`: Shorthand for `{ enabled: boolean }`
|
|
6603
6567
|
* - `string` or `function`: Shorthand for `{ name: string | function }`
|
|
6604
6568
|
* - `object`: Full configuration object
|
|
6605
6569
|
*
|
|
6606
|
-
* @default
|
|
6570
|
+
* @default false
|
|
6607
6571
|
*/
|
|
6608
|
-
|
|
6572
|
+
setQueryData?: boolean | NameTransformer | {
|
|
6609
6573
|
/**
|
|
6610
6574
|
* Casing convention for generated names.
|
|
6611
6575
|
*
|
|
@@ -6618,46 +6582,49 @@ type UserConfig$10 = Plugin$1.Name<'@tanstack/solid-query'> & Plugin$1.Hooks & P
|
|
|
6618
6582
|
* @default true
|
|
6619
6583
|
*/
|
|
6620
6584
|
enabled?: boolean;
|
|
6621
|
-
/**
|
|
6622
|
-
* Whether to export generated symbols.
|
|
6623
|
-
*
|
|
6624
|
-
* @default true
|
|
6625
|
-
*/
|
|
6626
|
-
exported?: boolean;
|
|
6627
|
-
/**
|
|
6628
|
-
* Custom function to generate metadata for the operation.
|
|
6629
|
-
* Can return any valid meta object that will be included in the generated mutation options.
|
|
6630
|
-
* @param operation - The operation object containing all available metadata
|
|
6631
|
-
* @returns A meta object with any properties you want to include
|
|
6632
|
-
*
|
|
6633
|
-
* @example
|
|
6634
|
-
* ```ts
|
|
6635
|
-
* meta: (operation) => ({
|
|
6636
|
-
* customField: operation.id,
|
|
6637
|
-
* isDeprecated: operation.deprecated,
|
|
6638
|
-
* tags: operation.tags,
|
|
6639
|
-
* customObject: {
|
|
6640
|
-
* method: operation.method,
|
|
6641
|
-
* path: operation.path
|
|
6642
|
-
* }
|
|
6643
|
-
* })
|
|
6644
|
-
* ```
|
|
6645
|
-
*
|
|
6646
|
-
* @default undefined
|
|
6647
|
-
*/
|
|
6648
|
-
meta?: (operation: IR$1.OperationObject) => Record<string, unknown>;
|
|
6649
6585
|
/**
|
|
6650
6586
|
* Naming pattern for generated names.
|
|
6651
6587
|
*
|
|
6652
|
-
* @default '{{name}}
|
|
6653
|
-
* @see https://tanstack.com/query/v5/docs/framework/solid/reference/createMutation
|
|
6588
|
+
* @default '{{name}}SetQueryData'
|
|
6654
6589
|
*/
|
|
6655
6590
|
name?: NameTransformer;
|
|
6656
6591
|
};
|
|
6592
|
+
};
|
|
6593
|
+
type Config$7 = Plugin$1.Name<'@tanstack/solid-query'> & Plugin$1.Hooks & Plugin$1.Comments & Plugin$1.Exports & {
|
|
6594
|
+
/** Casing convention for generated names. */case: Casing; /** Resolved configuration for generated infinite query key helpers. */
|
|
6595
|
+
infiniteQueryKeys: NamingOptions & FeatureToggle & {
|
|
6596
|
+
/** Whether to include operation tags in infinite query keys. */tags: boolean;
|
|
6597
|
+
}; /** Resolved configuration for generated infinite query options helpers. */
|
|
6598
|
+
infiniteQueryOptions: NamingOptions & FeatureToggle & {
|
|
6599
|
+
/** Custom function to generate metadata for the operation. */meta: (operation: IR$1.OperationObject) => Record<string, unknown>;
|
|
6600
|
+
}; /** Resolved configuration for generated mutation options helpers. */
|
|
6601
|
+
mutationOptions: NamingOptions & FeatureToggle & {
|
|
6602
|
+
/** Whether to export generated symbols. */exported: boolean; /** Custom function to generate metadata for the operation. */
|
|
6603
|
+
meta: (operation: IR$1.OperationObject) => Record<string, unknown>;
|
|
6604
|
+
}; /** Resolved configuration for generated query keys. */
|
|
6605
|
+
queryKeys: NamingOptions & FeatureToggle & {
|
|
6606
|
+
/** Whether to include operation tags in query keys. */tags: boolean;
|
|
6607
|
+
}; /** Resolved configuration for generated query options helpers. */
|
|
6608
|
+
queryOptions: NamingOptions & FeatureToggle & {
|
|
6609
|
+
/** Whether to export generated symbols. */exported: boolean; /** Custom function to generate metadata for the operation. */
|
|
6610
|
+
meta: (operation: IR$1.OperationObject) => Record<string, unknown>;
|
|
6611
|
+
}; /** Resolved configuration for generated `setQueryData` helpers. */
|
|
6612
|
+
setQueryData: NamingOptions & FeatureToggle;
|
|
6613
|
+
};
|
|
6614
|
+
type TanStackSolidQueryPlugin = DefinePlugin$1<UserConfig$10, Config$7>;
|
|
6615
|
+
//#endregion
|
|
6616
|
+
//#region src/plugins/@tanstack/svelte-query/types.d.ts
|
|
6617
|
+
type UserConfig$9 = Plugin$1.Name<'@tanstack/svelte-query'> & Plugin$1.Hooks & Plugin$1.UserComments & Plugin$1.UserExports & {
|
|
6657
6618
|
/**
|
|
6658
|
-
*
|
|
6619
|
+
* Casing convention for generated names.
|
|
6659
6620
|
*
|
|
6660
|
-
*
|
|
6621
|
+
* @default 'camelCase'
|
|
6622
|
+
*/
|
|
6623
|
+
case?: Casing;
|
|
6624
|
+
/**
|
|
6625
|
+
* Configuration for generated infinite query key helpers.
|
|
6626
|
+
*
|
|
6627
|
+
* See {@link https://tanstack.com/query/v5/docs/framework/svelte/reference/functions/createinfinitequery}
|
|
6661
6628
|
*
|
|
6662
6629
|
* Can be:
|
|
6663
6630
|
* - `boolean`: Shorthand for `{ enabled: boolean }`
|
|
@@ -6666,7 +6633,7 @@ type UserConfig$10 = Plugin$1.Name<'@tanstack/solid-query'> & Plugin$1.Hooks & P
|
|
|
6666
6633
|
*
|
|
6667
6634
|
* @default true
|
|
6668
6635
|
*/
|
|
6669
|
-
|
|
6636
|
+
infiniteQueryKeys?: boolean | NameTransformer | {
|
|
6670
6637
|
/**
|
|
6671
6638
|
* Casing convention for generated names.
|
|
6672
6639
|
*
|
|
@@ -6682,12 +6649,12 @@ type UserConfig$10 = Plugin$1.Name<'@tanstack/solid-query'> & Plugin$1.Hooks & P
|
|
|
6682
6649
|
/**
|
|
6683
6650
|
* Naming pattern for generated names.
|
|
6684
6651
|
*
|
|
6685
|
-
* @default '{{name}}
|
|
6686
|
-
* @see https://tanstack.com/query/v5/docs/framework/
|
|
6652
|
+
* @default '{{name}}InfiniteQueryKey'
|
|
6653
|
+
* @see https://tanstack.com/query/v5/docs/framework/svelte/reference/functions/createinfinitequery
|
|
6687
6654
|
*/
|
|
6688
6655
|
name?: NameTransformer;
|
|
6689
6656
|
/**
|
|
6690
|
-
* Whether to include operation tags in query keys.
|
|
6657
|
+
* Whether to include operation tags in infinite query keys.
|
|
6691
6658
|
* This will make query keys larger but provides better cache invalidation capabilities.
|
|
6692
6659
|
*
|
|
6693
6660
|
* @default false
|
|
@@ -6695,9 +6662,9 @@ type UserConfig$10 = Plugin$1.Name<'@tanstack/solid-query'> & Plugin$1.Hooks & P
|
|
|
6695
6662
|
tags?: boolean;
|
|
6696
6663
|
};
|
|
6697
6664
|
/**
|
|
6698
|
-
* Configuration for generated query options helpers.
|
|
6665
|
+
* Configuration for generated infinite query options helpers.
|
|
6699
6666
|
*
|
|
6700
|
-
* See {@link https://tanstack.com/query/v5/docs/framework/
|
|
6667
|
+
* See {@link https://tanstack.com/query/v5/docs/framework/svelte/reference/functions/createinfinitequery}
|
|
6701
6668
|
*
|
|
6702
6669
|
* Can be:
|
|
6703
6670
|
* - `boolean`: Shorthand for `{ enabled: boolean }`
|
|
@@ -6706,7 +6673,7 @@ type UserConfig$10 = Plugin$1.Name<'@tanstack/solid-query'> & Plugin$1.Hooks & P
|
|
|
6706
6673
|
*
|
|
6707
6674
|
* @default true
|
|
6708
6675
|
*/
|
|
6709
|
-
|
|
6676
|
+
infiniteQueryOptions?: boolean | NameTransformer | {
|
|
6710
6677
|
/**
|
|
6711
6678
|
* Casing convention for generated names.
|
|
6712
6679
|
*
|
|
@@ -6719,15 +6686,9 @@ type UserConfig$10 = Plugin$1.Name<'@tanstack/solid-query'> & Plugin$1.Hooks & P
|
|
|
6719
6686
|
* @default true
|
|
6720
6687
|
*/
|
|
6721
6688
|
enabled?: boolean;
|
|
6722
|
-
/**
|
|
6723
|
-
* Whether to export generated symbols.
|
|
6724
|
-
*
|
|
6725
|
-
* @default true
|
|
6726
|
-
*/
|
|
6727
|
-
exported?: boolean;
|
|
6728
6689
|
/**
|
|
6729
6690
|
* Custom function to generate metadata for the operation.
|
|
6730
|
-
* Can return any valid meta object that will be included in the generated query options.
|
|
6691
|
+
* Can return any valid meta object that will be included in the generated infinite query options.
|
|
6731
6692
|
* @param operation - The operation object containing all available metadata
|
|
6732
6693
|
* @returns A meta object with any properties you want to include
|
|
6733
6694
|
*
|
|
@@ -6750,473 +6711,42 @@ type UserConfig$10 = Plugin$1.Name<'@tanstack/solid-query'> & Plugin$1.Hooks & P
|
|
|
6750
6711
|
/**
|
|
6751
6712
|
* Naming pattern for generated names.
|
|
6752
6713
|
*
|
|
6753
|
-
* @default '{{name}}
|
|
6754
|
-
* @see https://tanstack.com/query/v5/docs/framework/
|
|
6714
|
+
* @default '{{name}}InfiniteOptions'
|
|
6715
|
+
* @see https://tanstack.com/query/v5/docs/framework/svelte/reference/functions/createinfinitequery
|
|
6755
6716
|
*/
|
|
6756
6717
|
name?: NameTransformer;
|
|
6757
6718
|
};
|
|
6758
|
-
};
|
|
6759
|
-
type Config$7 = Plugin$1.Name<'@tanstack/solid-query'> & Plugin$1.Hooks & Plugin$1.Comments & Plugin$1.Exports & {
|
|
6760
|
-
/**
|
|
6761
|
-
* Casing convention for generated names.
|
|
6762
|
-
*/
|
|
6763
|
-
case: Casing;
|
|
6764
6719
|
/**
|
|
6765
|
-
*
|
|
6720
|
+
* Configuration for generated mutation options helpers.
|
|
6766
6721
|
*
|
|
6767
|
-
* @
|
|
6768
|
-
*/
|
|
6769
|
-
infiniteQueryKeys: NamingOptions & FeatureToggle & {
|
|
6770
|
-
/**
|
|
6771
|
-
* Whether to include operation tags in infinite query keys.
|
|
6772
|
-
* This will make query keys larger but provides better cache invalidation capabilities.
|
|
6773
|
-
*
|
|
6774
|
-
* @default false
|
|
6775
|
-
*/
|
|
6776
|
-
tags: boolean;
|
|
6777
|
-
};
|
|
6778
|
-
/**
|
|
6779
|
-
* Resolved configuration for generated infinite query options helpers.
|
|
6722
|
+
* See {@link https://tanstack.com/query/v5/docs/framework/svelte/reference/functions/createmutation}
|
|
6780
6723
|
*
|
|
6781
|
-
*
|
|
6782
|
-
|
|
6783
|
-
|
|
6784
|
-
|
|
6785
|
-
* Custom function to generate metadata for the operation.
|
|
6786
|
-
* Can return any valid meta object that will be included in the generated infinite query options.
|
|
6787
|
-
* @param operation - The operation object containing all available metadata
|
|
6788
|
-
* @returns A meta object with any properties you want to include
|
|
6789
|
-
*
|
|
6790
|
-
* @example
|
|
6791
|
-
* ```ts
|
|
6792
|
-
* meta: (operation) => ({
|
|
6793
|
-
* customField: operation.id,
|
|
6794
|
-
* isDeprecated: operation.deprecated,
|
|
6795
|
-
* tags: operation.tags,
|
|
6796
|
-
* customObject: {
|
|
6797
|
-
* method: operation.method,
|
|
6798
|
-
* path: operation.path
|
|
6799
|
-
* }
|
|
6800
|
-
* })
|
|
6801
|
-
* ```
|
|
6802
|
-
*
|
|
6803
|
-
* @default undefined
|
|
6804
|
-
*/
|
|
6805
|
-
meta: (operation: IR$1.OperationObject) => Record<string, unknown>;
|
|
6806
|
-
};
|
|
6807
|
-
/**
|
|
6808
|
-
* Resolved configuration for generated mutation options helpers.
|
|
6724
|
+
* Can be:
|
|
6725
|
+
* - `boolean`: Shorthand for `{ enabled: boolean }`
|
|
6726
|
+
* - `string` or `function`: Shorthand for `{ name: string | function }`
|
|
6727
|
+
* - `object`: Full configuration object
|
|
6809
6728
|
*
|
|
6810
|
-
* @
|
|
6729
|
+
* @default true
|
|
6811
6730
|
*/
|
|
6812
|
-
mutationOptions
|
|
6731
|
+
mutationOptions?: boolean | NameTransformer | {
|
|
6813
6732
|
/**
|
|
6814
|
-
*
|
|
6733
|
+
* Casing convention for generated names.
|
|
6815
6734
|
*
|
|
6816
|
-
* @default
|
|
6735
|
+
* @default 'camelCase'
|
|
6817
6736
|
*/
|
|
6818
|
-
|
|
6737
|
+
case?: Casing;
|
|
6819
6738
|
/**
|
|
6820
|
-
*
|
|
6821
|
-
* Can return any valid meta object that will be included in the generated mutation options.
|
|
6822
|
-
* @param operation - The operation object containing all available metadata
|
|
6823
|
-
* @returns A meta object with any properties you want to include
|
|
6824
|
-
*
|
|
6825
|
-
* @example
|
|
6826
|
-
* ```ts
|
|
6827
|
-
* meta: (operation) => ({
|
|
6828
|
-
* customField: operation.id,
|
|
6829
|
-
* isDeprecated: operation.deprecated,
|
|
6830
|
-
* tags: operation.tags,
|
|
6831
|
-
* customObject: {
|
|
6832
|
-
* method: operation.method,
|
|
6833
|
-
* path: operation.path
|
|
6834
|
-
* }
|
|
6835
|
-
* })
|
|
6836
|
-
* ```
|
|
6837
|
-
*
|
|
6838
|
-
* @default undefined
|
|
6839
|
-
*/
|
|
6840
|
-
meta: (operation: IR$1.OperationObject) => Record<string, unknown>;
|
|
6841
|
-
};
|
|
6842
|
-
/**
|
|
6843
|
-
* Resolved configuration for generated query keys.
|
|
6844
|
-
*
|
|
6845
|
-
* @see https://tanstack.com/query/v5/docs/framework/solid/reference/queryKey
|
|
6846
|
-
*/
|
|
6847
|
-
queryKeys: NamingOptions & FeatureToggle & {
|
|
6848
|
-
/**
|
|
6849
|
-
* Whether to include operation tags in query keys.
|
|
6850
|
-
* This will make query keys larger but provides better cache invalidation capabilities.
|
|
6851
|
-
*
|
|
6852
|
-
* @default false
|
|
6853
|
-
*/
|
|
6854
|
-
tags: boolean;
|
|
6855
|
-
};
|
|
6856
|
-
/**
|
|
6857
|
-
* Resolved configuration for generated query options helpers.
|
|
6858
|
-
*
|
|
6859
|
-
* @see https://tanstack.com/query/v5/docs/framework/solid/reference/createQuery
|
|
6860
|
-
*/
|
|
6861
|
-
queryOptions: NamingOptions & FeatureToggle & {
|
|
6862
|
-
/**
|
|
6863
|
-
* Whether to export generated symbols.
|
|
6739
|
+
* Whether this feature is enabled.
|
|
6864
6740
|
*
|
|
6865
6741
|
* @default true
|
|
6866
6742
|
*/
|
|
6867
|
-
|
|
6868
|
-
/**
|
|
6869
|
-
* Custom function to generate metadata for the operation.
|
|
6870
|
-
* Can return any valid meta object that will be included in the generated query options.
|
|
6871
|
-
* @param operation - The operation object containing all available metadata
|
|
6872
|
-
* @returns A meta object with any properties you want to include
|
|
6873
|
-
*
|
|
6874
|
-
* @example
|
|
6875
|
-
* ```ts
|
|
6876
|
-
* meta: (operation) => ({
|
|
6877
|
-
* customField: operation.id,
|
|
6878
|
-
* isDeprecated: operation.deprecated,
|
|
6879
|
-
* tags: operation.tags,
|
|
6880
|
-
* customObject: {
|
|
6881
|
-
* method: operation.method,
|
|
6882
|
-
* path: operation.path
|
|
6883
|
-
* }
|
|
6884
|
-
* })
|
|
6885
|
-
* ```
|
|
6886
|
-
*
|
|
6887
|
-
* @default undefined
|
|
6888
|
-
*/
|
|
6889
|
-
meta: (operation: IR$1.OperationObject) => Record<string, unknown>;
|
|
6890
|
-
};
|
|
6891
|
-
};
|
|
6892
|
-
type TanStackSolidQueryPlugin = DefinePlugin$1<UserConfig$10, Config$7>;
|
|
6893
|
-
//#endregion
|
|
6894
|
-
//#region src/plugins/@tanstack/svelte-query/types.d.ts
|
|
6895
|
-
type UserConfig$9 = Plugin$1.Name<'@tanstack/svelte-query'> & Plugin$1.Hooks & Plugin$1.UserComments & Plugin$1.UserExports & {
|
|
6896
|
-
/**
|
|
6897
|
-
* Casing convention for generated names.
|
|
6898
|
-
*
|
|
6899
|
-
* @default 'camelCase'
|
|
6900
|
-
*/
|
|
6901
|
-
case?: Casing;
|
|
6902
|
-
/**
|
|
6903
|
-
* Configuration for generated infinite query key helpers.
|
|
6904
|
-
*
|
|
6905
|
-
* See {@link https://tanstack.com/query/v5/docs/framework/svelte/reference/functions/createinfinitequery}
|
|
6906
|
-
*
|
|
6907
|
-
* Can be:
|
|
6908
|
-
* - `boolean`: Shorthand for `{ enabled: boolean }`
|
|
6909
|
-
* - `string` or `function`: Shorthand for `{ name: string | function }`
|
|
6910
|
-
* - `object`: Full configuration object
|
|
6911
|
-
*
|
|
6912
|
-
* @default true
|
|
6913
|
-
*/
|
|
6914
|
-
infiniteQueryKeys?: boolean | NameTransformer | {
|
|
6915
|
-
/**
|
|
6916
|
-
* Casing convention for generated names.
|
|
6917
|
-
*
|
|
6918
|
-
* @default 'camelCase'
|
|
6919
|
-
*/
|
|
6920
|
-
case?: Casing;
|
|
6921
|
-
/**
|
|
6922
|
-
* Whether this feature is enabled.
|
|
6923
|
-
*
|
|
6924
|
-
* @default true
|
|
6925
|
-
*/
|
|
6926
|
-
enabled?: boolean;
|
|
6927
|
-
/**
|
|
6928
|
-
* Naming pattern for generated names.
|
|
6929
|
-
*
|
|
6930
|
-
* @default '{{name}}InfiniteQueryKey'
|
|
6931
|
-
* @see https://tanstack.com/query/v5/docs/framework/svelte/reference/functions/createinfinitequery
|
|
6932
|
-
*/
|
|
6933
|
-
name?: NameTransformer;
|
|
6934
|
-
/**
|
|
6935
|
-
* Whether to include operation tags in infinite query keys.
|
|
6936
|
-
* This will make query keys larger but provides better cache invalidation capabilities.
|
|
6937
|
-
*
|
|
6938
|
-
* @default false
|
|
6939
|
-
*/
|
|
6940
|
-
tags?: boolean;
|
|
6941
|
-
};
|
|
6942
|
-
/**
|
|
6943
|
-
* Configuration for generated infinite query options helpers.
|
|
6944
|
-
*
|
|
6945
|
-
* See {@link https://tanstack.com/query/v5/docs/framework/svelte/reference/functions/createinfinitequery}
|
|
6946
|
-
*
|
|
6947
|
-
* Can be:
|
|
6948
|
-
* - `boolean`: Shorthand for `{ enabled: boolean }`
|
|
6949
|
-
* - `string` or `function`: Shorthand for `{ name: string | function }`
|
|
6950
|
-
* - `object`: Full configuration object
|
|
6951
|
-
*
|
|
6952
|
-
* @default true
|
|
6953
|
-
*/
|
|
6954
|
-
infiniteQueryOptions?: boolean | NameTransformer | {
|
|
6955
|
-
/**
|
|
6956
|
-
* Casing convention for generated names.
|
|
6957
|
-
*
|
|
6958
|
-
* @default 'camelCase'
|
|
6959
|
-
*/
|
|
6960
|
-
case?: Casing;
|
|
6961
|
-
/**
|
|
6962
|
-
* Whether this feature is enabled.
|
|
6963
|
-
*
|
|
6964
|
-
* @default true
|
|
6965
|
-
*/
|
|
6966
|
-
enabled?: boolean;
|
|
6967
|
-
/**
|
|
6968
|
-
* Custom function to generate metadata for the operation.
|
|
6969
|
-
* Can return any valid meta object that will be included in the generated infinite query options.
|
|
6970
|
-
* @param operation - The operation object containing all available metadata
|
|
6971
|
-
* @returns A meta object with any properties you want to include
|
|
6972
|
-
*
|
|
6973
|
-
* @example
|
|
6974
|
-
* ```ts
|
|
6975
|
-
* meta: (operation) => ({
|
|
6976
|
-
* customField: operation.id,
|
|
6977
|
-
* isDeprecated: operation.deprecated,
|
|
6978
|
-
* tags: operation.tags,
|
|
6979
|
-
* customObject: {
|
|
6980
|
-
* method: operation.method,
|
|
6981
|
-
* path: operation.path
|
|
6982
|
-
* }
|
|
6983
|
-
* })
|
|
6984
|
-
* ```
|
|
6985
|
-
*
|
|
6986
|
-
* @default undefined
|
|
6987
|
-
*/
|
|
6988
|
-
meta?: (operation: IR$1.OperationObject) => Record<string, unknown>;
|
|
6989
|
-
/**
|
|
6990
|
-
* Naming pattern for generated names.
|
|
6991
|
-
*
|
|
6992
|
-
* @default '{{name}}InfiniteOptions'
|
|
6993
|
-
* @see https://tanstack.com/query/v5/docs/framework/svelte/reference/functions/createinfinitequery
|
|
6994
|
-
*/
|
|
6995
|
-
name?: NameTransformer;
|
|
6996
|
-
};
|
|
6997
|
-
/**
|
|
6998
|
-
* Configuration for generated mutation options helpers.
|
|
6999
|
-
*
|
|
7000
|
-
* See {@link https://tanstack.com/query/v5/docs/framework/svelte/reference/functions/createmutation}
|
|
7001
|
-
*
|
|
7002
|
-
* Can be:
|
|
7003
|
-
* - `boolean`: Shorthand for `{ enabled: boolean }`
|
|
7004
|
-
* - `string` or `function`: Shorthand for `{ name: string | function }`
|
|
7005
|
-
* - `object`: Full configuration object
|
|
7006
|
-
*
|
|
7007
|
-
* @default true
|
|
7008
|
-
*/
|
|
7009
|
-
mutationOptions?: boolean | NameTransformer | {
|
|
7010
|
-
/**
|
|
7011
|
-
* Casing convention for generated names.
|
|
7012
|
-
*
|
|
7013
|
-
* @default 'camelCase'
|
|
7014
|
-
*/
|
|
7015
|
-
case?: Casing;
|
|
7016
|
-
/**
|
|
7017
|
-
* Whether this feature is enabled.
|
|
7018
|
-
*
|
|
7019
|
-
* @default true
|
|
7020
|
-
*/
|
|
7021
|
-
enabled?: boolean;
|
|
7022
|
-
/**
|
|
7023
|
-
* Whether to export generated symbols.
|
|
7024
|
-
*
|
|
7025
|
-
* @default true
|
|
7026
|
-
*/
|
|
7027
|
-
exported?: boolean;
|
|
7028
|
-
/**
|
|
7029
|
-
* Custom function to generate metadata for the operation.
|
|
7030
|
-
* Can return any valid meta object that will be included in the generated mutation options.
|
|
7031
|
-
* @param operation - The operation object containing all available metadata
|
|
7032
|
-
* @returns A meta object with any properties you want to include
|
|
7033
|
-
*
|
|
7034
|
-
* @example
|
|
7035
|
-
* ```ts
|
|
7036
|
-
* meta: (operation) => ({
|
|
7037
|
-
* customField: operation.id,
|
|
7038
|
-
* isDeprecated: operation.deprecated,
|
|
7039
|
-
* tags: operation.tags,
|
|
7040
|
-
* customObject: {
|
|
7041
|
-
* method: operation.method,
|
|
7042
|
-
* path: operation.path
|
|
7043
|
-
* }
|
|
7044
|
-
* })
|
|
7045
|
-
* ```
|
|
7046
|
-
*
|
|
7047
|
-
* @default undefined
|
|
7048
|
-
*/
|
|
7049
|
-
meta?: (operation: IR$1.OperationObject) => Record<string, unknown>;
|
|
7050
|
-
/**
|
|
7051
|
-
* Naming pattern for generated names.
|
|
7052
|
-
*
|
|
7053
|
-
* @default '{{name}}Mutation'
|
|
7054
|
-
* @see https://tanstack.com/query/v5/docs/framework/svelte/reference/functions/createmutation
|
|
7055
|
-
*/
|
|
7056
|
-
name?: NameTransformer;
|
|
7057
|
-
};
|
|
7058
|
-
/**
|
|
7059
|
-
* Configuration for generated query keys.
|
|
7060
|
-
*
|
|
7061
|
-
* See {@link https://tanstack.com/query/v5/docs/framework/react/guides/query-keys}
|
|
7062
|
-
*
|
|
7063
|
-
* Can be:
|
|
7064
|
-
* - `boolean`: Shorthand for `{ enabled: boolean }`
|
|
7065
|
-
* - `string` or `function`: Shorthand for `{ name: string | function }`
|
|
7066
|
-
* - `object`: Full configuration object
|
|
7067
|
-
*
|
|
7068
|
-
* @default true
|
|
7069
|
-
*/
|
|
7070
|
-
queryKeys?: boolean | NameTransformer | {
|
|
7071
|
-
/**
|
|
7072
|
-
* Casing convention for generated names.
|
|
7073
|
-
*
|
|
7074
|
-
* @default 'camelCase'
|
|
7075
|
-
*/
|
|
7076
|
-
case?: Casing;
|
|
7077
|
-
/**
|
|
7078
|
-
* Whether this feature is enabled.
|
|
7079
|
-
*
|
|
7080
|
-
* @default true
|
|
7081
|
-
*/
|
|
7082
|
-
enabled?: boolean;
|
|
7083
|
-
/**
|
|
7084
|
-
* Naming pattern for generated names.
|
|
7085
|
-
*
|
|
7086
|
-
* @default '{{name}}QueryKey'
|
|
7087
|
-
* @see https://tanstack.com/query/v5/docs/framework/react/guides/query-keys
|
|
7088
|
-
*/
|
|
7089
|
-
name?: NameTransformer;
|
|
7090
|
-
/**
|
|
7091
|
-
* Whether to include operation tags in query keys.
|
|
7092
|
-
* This will make query keys larger but provides better cache invalidation capabilities.
|
|
7093
|
-
*
|
|
7094
|
-
* @default false
|
|
7095
|
-
*/
|
|
7096
|
-
tags?: boolean;
|
|
7097
|
-
};
|
|
7098
|
-
/**
|
|
7099
|
-
* Configuration for generated query options helpers.
|
|
7100
|
-
*
|
|
7101
|
-
* See {@link https://tanstack.com/query/v5/docs/framework/svelte/reference/functions/createquery}
|
|
7102
|
-
*
|
|
7103
|
-
* Can be:
|
|
7104
|
-
* - `boolean`: Shorthand for `{ enabled: boolean }`
|
|
7105
|
-
* - `string` or `function`: Shorthand for `{ name: string | function }`
|
|
7106
|
-
* - `object`: Full configuration object
|
|
7107
|
-
*
|
|
7108
|
-
* @default true
|
|
7109
|
-
*/
|
|
7110
|
-
queryOptions?: boolean | NameTransformer | {
|
|
7111
|
-
/**
|
|
7112
|
-
* Casing convention for generated names.
|
|
7113
|
-
*
|
|
7114
|
-
* @default 'camelCase'
|
|
7115
|
-
*/
|
|
7116
|
-
case?: Casing;
|
|
7117
|
-
/**
|
|
7118
|
-
* Whether this feature is enabled.
|
|
7119
|
-
*
|
|
7120
|
-
* @default true
|
|
7121
|
-
*/
|
|
7122
|
-
enabled?: boolean;
|
|
7123
|
-
/**
|
|
7124
|
-
* Whether to export generated symbols.
|
|
7125
|
-
*
|
|
7126
|
-
* @default true
|
|
7127
|
-
*/
|
|
7128
|
-
exported?: boolean;
|
|
7129
|
-
/**
|
|
7130
|
-
* Custom function to generate metadata for the operation.
|
|
7131
|
-
* Can return any valid meta object that will be included in the generated query options.
|
|
7132
|
-
* @param operation - The operation object containing all available metadata
|
|
7133
|
-
* @returns A meta object with any properties you want to include
|
|
7134
|
-
*
|
|
7135
|
-
* @example
|
|
7136
|
-
* ```ts
|
|
7137
|
-
* meta: (operation) => ({
|
|
7138
|
-
* customField: operation.id,
|
|
7139
|
-
* isDeprecated: operation.deprecated,
|
|
7140
|
-
* tags: operation.tags,
|
|
7141
|
-
* customObject: {
|
|
7142
|
-
* method: operation.method,
|
|
7143
|
-
* path: operation.path
|
|
7144
|
-
* }
|
|
7145
|
-
* })
|
|
7146
|
-
* ```
|
|
7147
|
-
*
|
|
7148
|
-
* @default undefined
|
|
7149
|
-
*/
|
|
7150
|
-
meta?: (operation: IR$1.OperationObject) => Record<string, unknown>;
|
|
7151
|
-
/**
|
|
7152
|
-
* Naming pattern for generated names.
|
|
7153
|
-
*
|
|
7154
|
-
* @default '{{name}}Options'
|
|
7155
|
-
* @see https://tanstack.com/query/v5/docs/framework/svelte/reference/functions/createquery
|
|
7156
|
-
*/
|
|
7157
|
-
name?: NameTransformer;
|
|
7158
|
-
};
|
|
7159
|
-
};
|
|
7160
|
-
type Config$6 = Plugin$1.Name<'@tanstack/svelte-query'> & Plugin$1.Hooks & Plugin$1.Comments & Plugin$1.Exports & {
|
|
7161
|
-
/**
|
|
7162
|
-
* Casing convention for generated names.
|
|
7163
|
-
*/
|
|
7164
|
-
case: Casing;
|
|
7165
|
-
/**
|
|
7166
|
-
* Resolved configuration for generated infinite query key helpers.
|
|
7167
|
-
*
|
|
7168
|
-
* @see https://tanstack.com/query/v5/docs/framework/svelte/reference/functions/createinfinitequery
|
|
7169
|
-
*/
|
|
7170
|
-
infiniteQueryKeys: NamingOptions & FeatureToggle & {
|
|
7171
|
-
/**
|
|
7172
|
-
* Whether to include operation tags in infinite query keys.
|
|
7173
|
-
* This will make query keys larger but provides better cache invalidation capabilities.
|
|
7174
|
-
*
|
|
7175
|
-
* @default false
|
|
7176
|
-
*/
|
|
7177
|
-
tags: boolean;
|
|
7178
|
-
};
|
|
7179
|
-
/**
|
|
7180
|
-
* Resolved configuration for generated infinite query options helpers.
|
|
7181
|
-
*
|
|
7182
|
-
* @see https://tanstack.com/query/v5/docs/framework/svelte/reference/functions/createinfinitequery
|
|
7183
|
-
*/
|
|
7184
|
-
infiniteQueryOptions: NamingOptions & FeatureToggle & {
|
|
7185
|
-
/**
|
|
7186
|
-
* Custom function to generate metadata for the operation.
|
|
7187
|
-
* Can return any valid meta object that will be included in the generated infinite query options.
|
|
7188
|
-
* @param operation - The operation object containing all available metadata
|
|
7189
|
-
* @returns A meta object with any properties you want to include
|
|
7190
|
-
*
|
|
7191
|
-
* @example
|
|
7192
|
-
* ```ts
|
|
7193
|
-
* meta: (operation) => ({
|
|
7194
|
-
* customField: operation.id,
|
|
7195
|
-
* isDeprecated: operation.deprecated,
|
|
7196
|
-
* tags: operation.tags,
|
|
7197
|
-
* customObject: {
|
|
7198
|
-
* method: operation.method,
|
|
7199
|
-
* path: operation.path
|
|
7200
|
-
* }
|
|
7201
|
-
* })
|
|
7202
|
-
* ```
|
|
7203
|
-
*
|
|
7204
|
-
* @default undefined
|
|
7205
|
-
*/
|
|
7206
|
-
meta: (operation: IR$1.OperationObject) => Record<string, unknown>;
|
|
7207
|
-
};
|
|
7208
|
-
/**
|
|
7209
|
-
* Resolved configuration for generated mutation options helpers.
|
|
7210
|
-
*
|
|
7211
|
-
* @see https://tanstack.com/query/v5/docs/framework/svelte/reference/functions/createmutation
|
|
7212
|
-
*/
|
|
7213
|
-
mutationOptions: NamingOptions & FeatureToggle & {
|
|
6743
|
+
enabled?: boolean;
|
|
7214
6744
|
/**
|
|
7215
6745
|
* Whether to export generated symbols.
|
|
7216
6746
|
*
|
|
7217
6747
|
* @default true
|
|
7218
6748
|
*/
|
|
7219
|
-
exported
|
|
6749
|
+
exported?: boolean;
|
|
7220
6750
|
/**
|
|
7221
6751
|
* Custom function to generate metadata for the operation.
|
|
7222
6752
|
* Can return any valid meta object that will be included in the generated mutation options.
|
|
@@ -7238,34 +6768,86 @@ type Config$6 = Plugin$1.Name<'@tanstack/svelte-query'> & Plugin$1.Hooks & Plugi
|
|
|
7238
6768
|
*
|
|
7239
6769
|
* @default undefined
|
|
7240
6770
|
*/
|
|
7241
|
-
meta
|
|
6771
|
+
meta?: (operation: IR$1.OperationObject) => Record<string, unknown>;
|
|
6772
|
+
/**
|
|
6773
|
+
* Naming pattern for generated names.
|
|
6774
|
+
*
|
|
6775
|
+
* @default '{{name}}Mutation'
|
|
6776
|
+
* @see https://tanstack.com/query/v5/docs/framework/svelte/reference/functions/createmutation
|
|
6777
|
+
*/
|
|
6778
|
+
name?: NameTransformer;
|
|
7242
6779
|
};
|
|
7243
6780
|
/**
|
|
7244
|
-
*
|
|
6781
|
+
* Configuration for generated query keys.
|
|
6782
|
+
*
|
|
6783
|
+
* See {@link https://tanstack.com/query/v5/docs/framework/react/guides/query-keys}
|
|
6784
|
+
*
|
|
6785
|
+
* Can be:
|
|
6786
|
+
* - `boolean`: Shorthand for `{ enabled: boolean }`
|
|
6787
|
+
* - `string` or `function`: Shorthand for `{ name: string | function }`
|
|
6788
|
+
* - `object`: Full configuration object
|
|
7245
6789
|
*
|
|
7246
|
-
* @
|
|
6790
|
+
* @default true
|
|
7247
6791
|
*/
|
|
7248
|
-
queryKeys
|
|
6792
|
+
queryKeys?: boolean | NameTransformer | {
|
|
6793
|
+
/**
|
|
6794
|
+
* Casing convention for generated names.
|
|
6795
|
+
*
|
|
6796
|
+
* @default 'camelCase'
|
|
6797
|
+
*/
|
|
6798
|
+
case?: Casing;
|
|
6799
|
+
/**
|
|
6800
|
+
* Whether this feature is enabled.
|
|
6801
|
+
*
|
|
6802
|
+
* @default true
|
|
6803
|
+
*/
|
|
6804
|
+
enabled?: boolean;
|
|
6805
|
+
/**
|
|
6806
|
+
* Naming pattern for generated names.
|
|
6807
|
+
*
|
|
6808
|
+
* @default '{{name}}QueryKey'
|
|
6809
|
+
* @see https://tanstack.com/query/v5/docs/framework/react/guides/query-keys
|
|
6810
|
+
*/
|
|
6811
|
+
name?: NameTransformer;
|
|
7249
6812
|
/**
|
|
7250
6813
|
* Whether to include operation tags in query keys.
|
|
7251
6814
|
* This will make query keys larger but provides better cache invalidation capabilities.
|
|
7252
6815
|
*
|
|
7253
6816
|
* @default false
|
|
7254
6817
|
*/
|
|
7255
|
-
tags
|
|
6818
|
+
tags?: boolean;
|
|
7256
6819
|
};
|
|
7257
6820
|
/**
|
|
7258
|
-
*
|
|
6821
|
+
* Configuration for generated query options helpers.
|
|
6822
|
+
*
|
|
6823
|
+
* See {@link https://tanstack.com/query/v5/docs/framework/svelte/reference/functions/createquery}
|
|
7259
6824
|
*
|
|
7260
|
-
*
|
|
6825
|
+
* Can be:
|
|
6826
|
+
* - `boolean`: Shorthand for `{ enabled: boolean }`
|
|
6827
|
+
* - `string` or `function`: Shorthand for `{ name: string | function }`
|
|
6828
|
+
* - `object`: Full configuration object
|
|
6829
|
+
*
|
|
6830
|
+
* @default true
|
|
7261
6831
|
*/
|
|
7262
|
-
queryOptions
|
|
6832
|
+
queryOptions?: boolean | NameTransformer | {
|
|
6833
|
+
/**
|
|
6834
|
+
* Casing convention for generated names.
|
|
6835
|
+
*
|
|
6836
|
+
* @default 'camelCase'
|
|
6837
|
+
*/
|
|
6838
|
+
case?: Casing;
|
|
6839
|
+
/**
|
|
6840
|
+
* Whether this feature is enabled.
|
|
6841
|
+
*
|
|
6842
|
+
* @default true
|
|
6843
|
+
*/
|
|
6844
|
+
enabled?: boolean;
|
|
7263
6845
|
/**
|
|
7264
6846
|
* Whether to export generated symbols.
|
|
7265
6847
|
*
|
|
7266
6848
|
* @default true
|
|
7267
6849
|
*/
|
|
7268
|
-
exported
|
|
6850
|
+
exported?: boolean;
|
|
7269
6851
|
/**
|
|
7270
6852
|
* Custom function to generate metadata for the operation.
|
|
7271
6853
|
* Can return any valid meta object that will be included in the generated query options.
|
|
@@ -7287,9 +6869,71 @@ type Config$6 = Plugin$1.Name<'@tanstack/svelte-query'> & Plugin$1.Hooks & Plugi
|
|
|
7287
6869
|
*
|
|
7288
6870
|
* @default undefined
|
|
7289
6871
|
*/
|
|
7290
|
-
meta
|
|
6872
|
+
meta?: (operation: IR$1.OperationObject) => Record<string, unknown>;
|
|
6873
|
+
/**
|
|
6874
|
+
* Naming pattern for generated names.
|
|
6875
|
+
*
|
|
6876
|
+
* @default '{{name}}Options'
|
|
6877
|
+
* @see https://tanstack.com/query/v5/docs/framework/svelte/reference/functions/createquery
|
|
6878
|
+
*/
|
|
6879
|
+
name?: NameTransformer;
|
|
6880
|
+
};
|
|
6881
|
+
/**
|
|
6882
|
+
* Configuration for generated `setQueryData` helpers.
|
|
6883
|
+
*
|
|
6884
|
+
* When enabled, generates a helper per query operation that wraps
|
|
6885
|
+
* `queryClient.setQueryData()` with the correct query key and response
|
|
6886
|
+
* type already wired up.
|
|
6887
|
+
*
|
|
6888
|
+
* Can be:
|
|
6889
|
+
* - `boolean`: Shorthand for `{ enabled: boolean }`
|
|
6890
|
+
* - `string` or `function`: Shorthand for `{ name: string | function }`
|
|
6891
|
+
* - `object`: Full configuration object
|
|
6892
|
+
*
|
|
6893
|
+
* @default false
|
|
6894
|
+
*/
|
|
6895
|
+
setQueryData?: boolean | NameTransformer | {
|
|
6896
|
+
/**
|
|
6897
|
+
* Casing convention for generated names.
|
|
6898
|
+
*
|
|
6899
|
+
* @default 'camelCase'
|
|
6900
|
+
*/
|
|
6901
|
+
case?: Casing;
|
|
6902
|
+
/**
|
|
6903
|
+
* Whether this feature is enabled.
|
|
6904
|
+
*
|
|
6905
|
+
* @default true
|
|
6906
|
+
*/
|
|
6907
|
+
enabled?: boolean;
|
|
6908
|
+
/**
|
|
6909
|
+
* Naming pattern for generated names.
|
|
6910
|
+
*
|
|
6911
|
+
* @default '{{name}}SetQueryData'
|
|
6912
|
+
*/
|
|
6913
|
+
name?: NameTransformer;
|
|
7291
6914
|
};
|
|
7292
6915
|
};
|
|
6916
|
+
type Config$6 = Plugin$1.Name<'@tanstack/svelte-query'> & Plugin$1.Hooks & Plugin$1.Comments & Plugin$1.Exports & {
|
|
6917
|
+
/** Casing convention for generated names. */case: Casing; /** Resolved configuration for generated infinite query key helpers. */
|
|
6918
|
+
infiniteQueryKeys: NamingOptions & FeatureToggle & {
|
|
6919
|
+
/** Whether to include operation tags in infinite query keys. */tags: boolean;
|
|
6920
|
+
}; /** Resolved configuration for generated infinite query options helpers. */
|
|
6921
|
+
infiniteQueryOptions: NamingOptions & FeatureToggle & {
|
|
6922
|
+
/** Custom function to generate metadata for the operation. */meta: (operation: IR$1.OperationObject) => Record<string, unknown>;
|
|
6923
|
+
}; /** Resolved configuration for generated mutation options helpers. */
|
|
6924
|
+
mutationOptions: NamingOptions & FeatureToggle & {
|
|
6925
|
+
/** Whether to export generated symbols. */exported: boolean; /** Custom function to generate metadata for the operation. */
|
|
6926
|
+
meta: (operation: IR$1.OperationObject) => Record<string, unknown>;
|
|
6927
|
+
}; /** Resolved configuration for generated query keys. */
|
|
6928
|
+
queryKeys: NamingOptions & FeatureToggle & {
|
|
6929
|
+
/** Whether to include operation tags in query keys. */tags: boolean;
|
|
6930
|
+
}; /** Resolved configuration for generated query options helpers. */
|
|
6931
|
+
queryOptions: NamingOptions & FeatureToggle & {
|
|
6932
|
+
/** Whether to export generated symbols. */exported: boolean; /** Custom function to generate metadata for the operation. */
|
|
6933
|
+
meta: (operation: IR$1.OperationObject) => Record<string, unknown>;
|
|
6934
|
+
}; /** Resolved configuration for generated `setQueryData` helpers. */
|
|
6935
|
+
setQueryData: NamingOptions & FeatureToggle;
|
|
6936
|
+
};
|
|
7293
6937
|
type TanStackSvelteQueryPlugin = DefinePlugin$1<UserConfig$9, Config$6>;
|
|
7294
6938
|
//#endregion
|
|
7295
6939
|
//#region src/plugins/@tanstack/vue-query/types.d.ts
|
|
@@ -7560,142 +7204,61 @@ type UserConfig$8 = Plugin$1.Name<'@tanstack/vue-query'> & Plugin$1.Hooks & Plug
|
|
|
7560
7204
|
*/
|
|
7561
7205
|
name?: NameTransformer;
|
|
7562
7206
|
};
|
|
7563
|
-
};
|
|
7564
|
-
type Config$5 = Plugin$1.Name<'@tanstack/vue-query'> & Plugin$1.Hooks & Plugin$1.Comments & Plugin$1.Exports & {
|
|
7565
|
-
/**
|
|
7566
|
-
* Casing convention for generated names.
|
|
7567
|
-
*/
|
|
7568
|
-
case: Casing;
|
|
7569
7207
|
/**
|
|
7570
|
-
*
|
|
7208
|
+
* Configuration for generated `setQueryData` helpers.
|
|
7571
7209
|
*
|
|
7572
|
-
*
|
|
7573
|
-
|
|
7574
|
-
|
|
7575
|
-
|
|
7576
|
-
|
|
7577
|
-
|
|
7578
|
-
|
|
7579
|
-
|
|
7580
|
-
*/
|
|
7581
|
-
tags: boolean;
|
|
7582
|
-
};
|
|
7583
|
-
/**
|
|
7584
|
-
* Resolved configuration for generated infinite query options helpers.
|
|
7210
|
+
* When enabled, generates a helper per query operation that wraps
|
|
7211
|
+
* `queryClient.setQueryData()` with the correct query key and response
|
|
7212
|
+
* type already wired up.
|
|
7213
|
+
*
|
|
7214
|
+
* Can be:
|
|
7215
|
+
* - `boolean`: Shorthand for `{ enabled: boolean }`
|
|
7216
|
+
* - `string` or `function`: Shorthand for `{ name: string | function }`
|
|
7217
|
+
* - `object`: Full configuration object
|
|
7585
7218
|
*
|
|
7586
|
-
* @
|
|
7219
|
+
* @default false
|
|
7587
7220
|
*/
|
|
7588
|
-
|
|
7221
|
+
setQueryData?: boolean | NameTransformer | {
|
|
7589
7222
|
/**
|
|
7590
|
-
*
|
|
7591
|
-
* Can return any valid meta object that will be included in the generated infinite query options.
|
|
7592
|
-
*
|
|
7593
|
-
* @param operation - The operation object containing all available metadata
|
|
7594
|
-
* @returns A meta object with any properties you want to include
|
|
7595
|
-
*
|
|
7596
|
-
* @example
|
|
7597
|
-
* ```ts
|
|
7598
|
-
* meta: (operation) => ({
|
|
7599
|
-
* customField: operation.id,
|
|
7600
|
-
* isDeprecated: operation.deprecated,
|
|
7601
|
-
* tags: operation.tags,
|
|
7602
|
-
* customObject: {
|
|
7603
|
-
* method: operation.method,
|
|
7604
|
-
* path: operation.path
|
|
7605
|
-
* }
|
|
7606
|
-
* })
|
|
7607
|
-
* ```
|
|
7223
|
+
* Casing convention for generated names.
|
|
7608
7224
|
*
|
|
7609
|
-
* @default
|
|
7225
|
+
* @default 'camelCase'
|
|
7610
7226
|
*/
|
|
7611
|
-
|
|
7612
|
-
};
|
|
7613
|
-
/**
|
|
7614
|
-
* Resolved configuration for generated mutation options helpers.
|
|
7615
|
-
*
|
|
7616
|
-
* @see https://tanstack.com/query/v5/docs/framework/vue/reference/useMutation
|
|
7617
|
-
*/
|
|
7618
|
-
mutationOptions: NamingOptions & FeatureToggle & {
|
|
7227
|
+
case?: Casing;
|
|
7619
7228
|
/**
|
|
7620
|
-
* Whether
|
|
7229
|
+
* Whether this feature is enabled.
|
|
7621
7230
|
*
|
|
7622
7231
|
* @default true
|
|
7623
7232
|
*/
|
|
7624
|
-
|
|
7233
|
+
enabled?: boolean;
|
|
7625
7234
|
/**
|
|
7626
|
-
*
|
|
7627
|
-
* Can return any valid meta object that will be included in the generated mutation options.
|
|
7628
|
-
*
|
|
7629
|
-
* @param operation - The operation object containing all available metadata
|
|
7630
|
-
* @returns A meta object with any properties you want to include
|
|
7631
|
-
*
|
|
7632
|
-
* @example
|
|
7633
|
-
* ```ts
|
|
7634
|
-
* meta: (operation) => ({
|
|
7635
|
-
* customField: operation.id,
|
|
7636
|
-
* isDeprecated: operation.deprecated,
|
|
7637
|
-
* tags: operation.tags,
|
|
7638
|
-
* customObject: {
|
|
7639
|
-
* method: operation.method,
|
|
7640
|
-
* path: operation.path
|
|
7641
|
-
* }
|
|
7642
|
-
* })
|
|
7643
|
-
* ```
|
|
7235
|
+
* Naming pattern for generated names.
|
|
7644
7236
|
*
|
|
7645
|
-
* @default
|
|
7237
|
+
* @default '{{name}}SetQueryData'
|
|
7646
7238
|
*/
|
|
7647
|
-
|
|
7239
|
+
name?: NameTransformer;
|
|
7648
7240
|
};
|
|
7649
|
-
|
|
7650
|
-
|
|
7651
|
-
|
|
7652
|
-
|
|
7653
|
-
|
|
7241
|
+
};
|
|
7242
|
+
type Config$5 = Plugin$1.Name<'@tanstack/vue-query'> & Plugin$1.Hooks & Plugin$1.Comments & Plugin$1.Exports & {
|
|
7243
|
+
/** Casing convention for generated names. */case: Casing; /** Resolved configuration for generated infinite query key helpers. */
|
|
7244
|
+
infiniteQueryKeys: NamingOptions & FeatureToggle & {
|
|
7245
|
+
/** Whether to include operation tags in infinite query keys. */tags: boolean;
|
|
7246
|
+
}; /** Resolved configuration for generated infinite query options helpers. */
|
|
7247
|
+
infiniteQueryOptions: NamingOptions & FeatureToggle & {
|
|
7248
|
+
/** Custom function to generate metadata for the operation. */meta: (operation: IR$1.OperationObject) => Record<string, unknown>;
|
|
7249
|
+
}; /** Resolved configuration for generated mutation options helpers. */
|
|
7250
|
+
mutationOptions: NamingOptions & FeatureToggle & {
|
|
7251
|
+
/** Whether to export generated symbols. */exported: boolean; /** Custom function to generate metadata for the operation. */
|
|
7252
|
+
meta: (operation: IR$1.OperationObject) => Record<string, unknown>;
|
|
7253
|
+
}; /** Resolved configuration for generated query keys. */
|
|
7654
7254
|
queryKeys: NamingOptions & FeatureToggle & {
|
|
7655
|
-
/**
|
|
7656
|
-
|
|
7657
|
-
* This will make query keys larger but provides better cache invalidation capabilities.
|
|
7658
|
-
*
|
|
7659
|
-
* @default false
|
|
7660
|
-
*/
|
|
7661
|
-
tags: boolean;
|
|
7662
|
-
};
|
|
7663
|
-
/**
|
|
7664
|
-
* Resolved configuration for generated query options helpers.
|
|
7665
|
-
*
|
|
7666
|
-
* @see https://tanstack.com/query/v5/docs/framework/vue/reference/queryOptions
|
|
7667
|
-
*/
|
|
7255
|
+
/** Whether to include operation tags in query keys. */tags: boolean;
|
|
7256
|
+
}; /** Resolved configuration for generated query options helpers. */
|
|
7668
7257
|
queryOptions: NamingOptions & FeatureToggle & {
|
|
7669
|
-
/**
|
|
7670
|
-
* Whether to export generated symbols.
|
|
7671
|
-
*
|
|
7672
|
-
* @default true
|
|
7673
|
-
*/
|
|
7674
|
-
exported: boolean;
|
|
7675
|
-
/**
|
|
7676
|
-
* Custom function to generate metadata for the operation.
|
|
7677
|
-
* Can return any valid meta object that will be included in the generated query options.
|
|
7678
|
-
*
|
|
7679
|
-
* @param operation - The operation object containing all available metadata
|
|
7680
|
-
* @returns A meta object with any properties you want to include
|
|
7681
|
-
*
|
|
7682
|
-
* @example
|
|
7683
|
-
* ```ts
|
|
7684
|
-
* meta: (operation) => ({
|
|
7685
|
-
* customField: operation.id,
|
|
7686
|
-
* isDeprecated: operation.deprecated,
|
|
7687
|
-
* tags: operation.tags,
|
|
7688
|
-
* customObject: {
|
|
7689
|
-
* method: operation.method,
|
|
7690
|
-
* path: operation.path
|
|
7691
|
-
* }
|
|
7692
|
-
* })
|
|
7693
|
-
* ```
|
|
7694
|
-
*
|
|
7695
|
-
* @default undefined
|
|
7696
|
-
*/
|
|
7258
|
+
/** Whether to export generated symbols. */exported: boolean; /** Custom function to generate metadata for the operation. */
|
|
7697
7259
|
meta: (operation: IR$1.OperationObject) => Record<string, unknown>;
|
|
7698
|
-
};
|
|
7260
|
+
}; /** Resolved configuration for generated `setQueryData` helpers. */
|
|
7261
|
+
setQueryData: NamingOptions & FeatureToggle;
|
|
7699
7262
|
};
|
|
7700
7263
|
type TanStackVueQueryPlugin = DefinePlugin$1<UserConfig$8, Config$5>;
|
|
7701
7264
|
//#endregion
|
|
@@ -9580,6 +9143,8 @@ interface ZodMeta {
|
|
|
9580
9143
|
format?: string;
|
|
9581
9144
|
/** Whether this or any child contains a lazy reference. */
|
|
9582
9145
|
hasLazy: boolean;
|
|
9146
|
+
/** Whether this schema generates a ZodIntersection (e.g. via allOf). */
|
|
9147
|
+
isIntersection: boolean;
|
|
9583
9148
|
/** Whether this schema itself is emitted as lazy. */
|
|
9584
9149
|
isLazy: boolean;
|
|
9585
9150
|
/** Whether this schema resolves to an object shape. */
|
|
@@ -11379,9 +10944,9 @@ declare const clientDefaultMeta: {
|
|
|
11379
10944
|
};
|
|
11380
10945
|
//#endregion
|
|
11381
10946
|
//#region src/plugins/@hey-api/client-core/plugin.d.ts
|
|
11382
|
-
declare
|
|
10947
|
+
declare function clientPluginHandler({
|
|
11383
10948
|
plugin
|
|
11384
|
-
}: Parameters<PluginHandler>[0])
|
|
10949
|
+
}: Parameters<PluginHandler>[0]): void;
|
|
11385
10950
|
//#endregion
|
|
11386
10951
|
//#region src/index.d.ts
|
|
11387
10952
|
declare module '@hey-api/codegen-core' {
|