@navios/react-query 0.6.1 → 0.7.0
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/CHANGELOG.md +41 -0
- package/README.md +142 -41
- package/dist/src/client/declare-client.d.mts.map +1 -1
- package/dist/src/mutation/make-hook.d.mts +3 -1
- package/dist/src/mutation/make-hook.d.mts.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/lib/index.cjs +412 -0
- package/lib/index.cjs.map +1 -0
- package/lib/index.d.cts +961 -0
- package/lib/index.d.cts.map +1 -0
- package/lib/index.d.mts +961 -34
- package/lib/index.d.mts.map +1 -0
- package/lib/index.mjs +389 -350
- package/lib/index.mjs.map +1 -1
- package/package.json +4 -4
- package/project.json +2 -2
- package/src/__tests__/declare-client.spec.mts +2 -2
- package/src/__tests__/make-mutation.spec.mts +10 -9
- package/src/client/declare-client.mts +28 -6
- package/src/mutation/make-hook.mts +3 -11
- package/{tsup.config.mts → tsdown.config.mts} +4 -3
- package/lib/_tsup-dts-rollup.d.mts +0 -1097
- package/lib/_tsup-dts-rollup.d.ts +0 -1097
- package/lib/index.d.ts +0 -34
- package/lib/index.js +0 -375
- package/lib/index.js.map +0 -1
|
@@ -1,1097 +0,0 @@
|
|
|
1
|
-
import type { AbstractEndpoint } from '@navios/builder';
|
|
2
|
-
import type { AnyEndpointConfig } from '@navios/builder';
|
|
3
|
-
import type { BaseEndpointConfig } from '@navios/builder';
|
|
4
|
-
import type { BaseStreamConfig } from '@navios/builder';
|
|
5
|
-
import type { BuilderInstance } from '@navios/builder';
|
|
6
|
-
import type { DataTag } from '@tanstack/react-query';
|
|
7
|
-
import type { EndpointFunctionArgs } from '@navios/builder';
|
|
8
|
-
import type { HttpMethod } from '@navios/builder';
|
|
9
|
-
import type { InfiniteData } from '@tanstack/react-query';
|
|
10
|
-
import type { MutationFunctionContext } from '@tanstack/react-query';
|
|
11
|
-
import type { NaviosZodRequest } from '@navios/builder';
|
|
12
|
-
import { NoInfer as NoInfer_2 } from '@tanstack/react-query';
|
|
13
|
-
import { ProcessResponseFunction as ProcessResponseFunction_2 } from '../index.mjs';
|
|
14
|
-
import type { QueryClient } from '@tanstack/react-query';
|
|
15
|
-
import { QueryKeyCreatorResult as QueryKeyCreatorResult_2 } from './types.mjs';
|
|
16
|
-
import { UrlHasParams } from '@navios/builder';
|
|
17
|
-
import type { UrlParams } from '@navios/builder';
|
|
18
|
-
import type { UseInfiniteQueryOptions } from '@tanstack/react-query';
|
|
19
|
-
import { UseInfiniteQueryResult } from '@tanstack/react-query';
|
|
20
|
-
import type { UseMutationOptions } from '@tanstack/react-query';
|
|
21
|
-
import type { UseMutationResult } from '@tanstack/react-query';
|
|
22
|
-
import type { UseQueryOptions } from '@tanstack/react-query';
|
|
23
|
-
import { UseQueryResult } from '@tanstack/react-query';
|
|
24
|
-
import type { UseSuspenseInfiniteQueryOptions } from '@tanstack/react-query';
|
|
25
|
-
import { UseSuspenseInfiniteQueryResult } from '@tanstack/react-query';
|
|
26
|
-
import type { UseSuspenseQueryOptions } from '@tanstack/react-query';
|
|
27
|
-
import { UseSuspenseQueryResult } from '@tanstack/react-query';
|
|
28
|
-
import type { Util_FlatObject } from '@navios/builder';
|
|
29
|
-
import type { z } from 'zod/v4';
|
|
30
|
-
import type { ZodObject } from 'zod/v4';
|
|
31
|
-
import type { ZodType } from 'zod/v4';
|
|
32
|
-
|
|
33
|
-
/** @deprecated Use NaviosZodRequest from @navios/builder instead */
|
|
34
|
-
declare type BaseMutationArgs<Config extends AnyEndpointConfig> = NaviosZodRequest<Config>;
|
|
35
|
-
export { BaseMutationArgs }
|
|
36
|
-
export { BaseMutationArgs as BaseMutationArgs_alias_1 }
|
|
37
|
-
export { BaseMutationArgs as BaseMutationArgs_alias_2 }
|
|
38
|
-
|
|
39
|
-
/** @deprecated Use MutationParams instead */
|
|
40
|
-
declare type BaseMutationParams<Config extends AnyEndpointConfig, TData = unknown, TVariables = NaviosZodRequest<Config>, TResponse = z.output<Config['responseSchema']>, TContext = unknown, UseKey extends boolean = false> = MutationParams<Config, TData, TVariables, TResponse, TContext, UseKey>;
|
|
41
|
-
export { BaseMutationParams }
|
|
42
|
-
export { BaseMutationParams as BaseMutationParams_alias_1 }
|
|
43
|
-
export { BaseMutationParams as BaseMutationParams_alias_2 }
|
|
44
|
-
|
|
45
|
-
/** @deprecated Use QueryArgs instead */
|
|
46
|
-
declare type BaseQueryArgs<Config extends AnyEndpointConfig> = (UrlHasParams<Config['url']> extends true ? {
|
|
47
|
-
urlParams: UrlParams<Config['url']>;
|
|
48
|
-
} : {}) & (Config['querySchema'] extends ZodObject ? {
|
|
49
|
-
params: z.input<Config['querySchema']>;
|
|
50
|
-
} : {});
|
|
51
|
-
export { BaseQueryArgs }
|
|
52
|
-
export { BaseQueryArgs as BaseQueryArgs_alias_1 }
|
|
53
|
-
export { BaseQueryArgs as BaseQueryArgs_alias_2 }
|
|
54
|
-
|
|
55
|
-
/** @deprecated Use QueryParams instead */
|
|
56
|
-
declare type BaseQueryParams<Config extends AnyEndpointConfig, Res = unknown> = QueryParams<Config, Res>;
|
|
57
|
-
export { BaseQueryParams }
|
|
58
|
-
export { BaseQueryParams as BaseQueryParams_alias_1 }
|
|
59
|
-
export { BaseQueryParams as BaseQueryParams_alias_2 }
|
|
60
|
-
|
|
61
|
-
/** @deprecated Use EndpointHelper instead */
|
|
62
|
-
declare type ClientEndpointHelper<Method extends HttpMethod = HttpMethod, Url extends string = string, RequestSchema = unknown, ResponseSchema extends z.ZodType = z.ZodType, QuerySchema = unknown> = EndpointHelper<Method, Url, RequestSchema, ResponseSchema, QuerySchema>;
|
|
63
|
-
export { ClientEndpointHelper }
|
|
64
|
-
export { ClientEndpointHelper as ClientEndpointHelper_alias_1 }
|
|
65
|
-
export { ClientEndpointHelper as ClientEndpointHelper_alias_2 }
|
|
66
|
-
|
|
67
|
-
/**
|
|
68
|
-
* The main client instance interface.
|
|
69
|
-
* Provides methods for creating queries, infinite queries, and mutations.
|
|
70
|
-
*/
|
|
71
|
-
declare interface ClientInstance {
|
|
72
|
-
query<Method extends 'GET' | 'HEAD' | 'OPTIONS' = 'GET', Url extends string = string, Response extends ZodType = ZodType, Result = z.output<Response>>(config: {
|
|
73
|
-
method: Method;
|
|
74
|
-
url: Url;
|
|
75
|
-
responseSchema: Response;
|
|
76
|
-
processResponse?: (data: z.output<Response>) => Result;
|
|
77
|
-
}): ((params: Util_FlatObject<QueryArgs<Url, undefined>>) => UseSuspenseQueryOptions<Result, Error, Result, DataTag<Split<Url, '/'>, Result, Error>>) & QueryHelpers<Url, undefined, Result> & EndpointHelper<Method, Url, undefined, Response>;
|
|
78
|
-
query<Method extends 'GET' | 'HEAD' | 'OPTIONS' = 'GET', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, Result = z.output<Response>>(config: {
|
|
79
|
-
method: Method;
|
|
80
|
-
url: Url;
|
|
81
|
-
querySchema: QuerySchema;
|
|
82
|
-
responseSchema: Response;
|
|
83
|
-
processResponse?: (data: z.output<Response>) => Result;
|
|
84
|
-
}): ((params: Util_FlatObject<QueryArgs<Url, QuerySchema>>) => UseSuspenseQueryOptions<Result, Error, Result, DataTag<Split<Url, '/'>, Result, Error>>) & QueryHelpers<Url, QuerySchema, Result> & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
|
|
85
|
-
query<Method extends 'POST' = 'POST', Url extends string = string, RequestSchema extends ZodType = ZodType, Response extends ZodType = ZodType, Result = z.output<Response>>(config: {
|
|
86
|
-
method: Method;
|
|
87
|
-
url: Url;
|
|
88
|
-
requestSchema: RequestSchema;
|
|
89
|
-
responseSchema: Response;
|
|
90
|
-
processResponse?: (data: z.output<Response>) => Result;
|
|
91
|
-
}): ((params: Util_FlatObject<QueryArgs<Url, undefined, RequestSchema>>) => UseSuspenseQueryOptions<Result, Error, Result, DataTag<Split<Url, '/'>, Result, Error>>) & QueryHelpers<Url, undefined, Result, false, RequestSchema> & EndpointHelper<Method, Url, RequestSchema, Response>;
|
|
92
|
-
query<Method extends 'POST' = 'POST', Url extends string = string, QuerySchema extends ZodObject = ZodObject, RequestSchema extends ZodType = ZodType, Response extends ZodType = ZodType, Result = z.output<Response>>(config: {
|
|
93
|
-
method: Method;
|
|
94
|
-
url: Url;
|
|
95
|
-
querySchema: QuerySchema;
|
|
96
|
-
requestSchema: RequestSchema;
|
|
97
|
-
responseSchema: Response;
|
|
98
|
-
processResponse?: (data: z.output<Response>) => Result;
|
|
99
|
-
}): ((params: Util_FlatObject<QueryArgs<Url, QuerySchema, RequestSchema>>) => UseSuspenseQueryOptions<Result, Error, Result, DataTag<Split<Url, '/'>, Result, Error>>) & QueryHelpers<Url, QuerySchema, Result, false, RequestSchema> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
|
|
100
|
-
infiniteQuery<Method extends 'GET' | 'HEAD' | 'OPTIONS' = 'GET', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, PageResult = z.output<Response>, Result = InfiniteData<PageResult>>(config: {
|
|
101
|
-
method: Method;
|
|
102
|
-
url: Url;
|
|
103
|
-
querySchema: QuerySchema;
|
|
104
|
-
responseSchema: Response;
|
|
105
|
-
processResponse?: (data: z.output<Response>) => PageResult;
|
|
106
|
-
getNextPageParam: (lastPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema> | undefined;
|
|
107
|
-
getPreviousPageParam?: (firstPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema>;
|
|
108
|
-
}): ((params: Util_FlatObject<QueryArgs<Url, QuerySchema>>) => UseSuspenseInfiniteQueryOptions<PageResult, Error, Result, DataTag<Split<Url, '/'>, PageResult, Error>, z.output<QuerySchema>>) & QueryHelpers<Url, QuerySchema, PageResult, true> & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
|
|
109
|
-
infiniteQuery<Method extends 'POST' = 'POST', Url extends string = string, QuerySchema extends ZodObject = ZodObject, RequestSchema extends ZodType = ZodType, Response extends ZodType = ZodType, PageResult = z.output<Response>, Result = InfiniteData<PageResult>>(config: {
|
|
110
|
-
method: Method;
|
|
111
|
-
url: Url;
|
|
112
|
-
querySchema: QuerySchema;
|
|
113
|
-
requestSchema: RequestSchema;
|
|
114
|
-
responseSchema: Response;
|
|
115
|
-
processResponse?: (data: z.output<Response>) => PageResult;
|
|
116
|
-
getNextPageParam: (lastPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema> | undefined;
|
|
117
|
-
getPreviousPageParam?: (firstPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema>;
|
|
118
|
-
}): ((params: Util_FlatObject<QueryArgs<Url, QuerySchema, RequestSchema>>) => UseSuspenseInfiniteQueryOptions<PageResult, Error, Result, DataTag<Split<Url, '/'>, PageResult, Error>, z.output<QuerySchema>>) & QueryHelpers<Url, QuerySchema, PageResult, true, RequestSchema> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
|
|
119
|
-
mutation<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(config: {
|
|
120
|
-
method: Method;
|
|
121
|
-
url: Url;
|
|
122
|
-
useKey: UseKey;
|
|
123
|
-
requestSchema: RequestSchema;
|
|
124
|
-
querySchema: QuerySchema;
|
|
125
|
-
responseSchema: Response;
|
|
126
|
-
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
127
|
-
useContext?: () => Context;
|
|
128
|
-
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
129
|
-
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
130
|
-
onMutateResult: OnMutateResult | undefined;
|
|
131
|
-
}) => void | Promise<void>;
|
|
132
|
-
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
133
|
-
onMutateResult: OnMutateResult | undefined;
|
|
134
|
-
}) => void | Promise<void>;
|
|
135
|
-
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
136
|
-
onMutateResult: OnMutateResult | undefined;
|
|
137
|
-
}) => void | Promise<void>;
|
|
138
|
-
}): ((params: UrlHasParams<Url> extends true ? {
|
|
139
|
-
urlParams: UrlParams<Url>;
|
|
140
|
-
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
|
|
141
|
-
mutation<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown>(config: {
|
|
142
|
-
method: Method;
|
|
143
|
-
url: Url;
|
|
144
|
-
requestSchema: RequestSchema;
|
|
145
|
-
querySchema: QuerySchema;
|
|
146
|
-
responseSchema: Response;
|
|
147
|
-
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
148
|
-
useContext?: () => Context;
|
|
149
|
-
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
150
|
-
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
151
|
-
onMutateResult: OnMutateResult | undefined;
|
|
152
|
-
}) => void | Promise<void>;
|
|
153
|
-
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
154
|
-
onMutateResult: OnMutateResult | undefined;
|
|
155
|
-
}) => void | Promise<void>;
|
|
156
|
-
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
157
|
-
onMutateResult: OnMutateResult | undefined;
|
|
158
|
-
}) => void | Promise<void>;
|
|
159
|
-
}): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
|
|
160
|
-
mutation<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown>(config: {
|
|
161
|
-
method: Method;
|
|
162
|
-
url: Url;
|
|
163
|
-
requestSchema: RequestSchema;
|
|
164
|
-
responseSchema: Response;
|
|
165
|
-
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
166
|
-
useContext?: () => Context;
|
|
167
|
-
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
168
|
-
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
169
|
-
onMutateResult: OnMutateResult | undefined;
|
|
170
|
-
}) => void | Promise<void>;
|
|
171
|
-
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
172
|
-
onMutateResult: OnMutateResult | undefined;
|
|
173
|
-
}) => void | Promise<void>;
|
|
174
|
-
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
175
|
-
onMutateResult: OnMutateResult | undefined;
|
|
176
|
-
}) => void | Promise<void>;
|
|
177
|
-
}): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response>;
|
|
178
|
-
mutation<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(config: {
|
|
179
|
-
method: Method;
|
|
180
|
-
url: Url;
|
|
181
|
-
useKey: UseKey;
|
|
182
|
-
requestSchema: RequestSchema;
|
|
183
|
-
responseSchema: Response;
|
|
184
|
-
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
185
|
-
useContext?: () => Context;
|
|
186
|
-
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
187
|
-
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
188
|
-
onMutateResult: OnMutateResult | undefined;
|
|
189
|
-
}) => void | Promise<void>;
|
|
190
|
-
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
191
|
-
onMutateResult: OnMutateResult | undefined;
|
|
192
|
-
}) => void | Promise<void>;
|
|
193
|
-
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
194
|
-
onMutateResult: OnMutateResult | undefined;
|
|
195
|
-
}) => void | Promise<void>;
|
|
196
|
-
}): ((params: UrlHasParams<Url> extends true ? {
|
|
197
|
-
urlParams: UrlParams<Url>;
|
|
198
|
-
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response>;
|
|
199
|
-
mutation<Method extends 'DELETE' = 'DELETE', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(config: {
|
|
200
|
-
method: Method;
|
|
201
|
-
url: Url;
|
|
202
|
-
useKey: UseKey;
|
|
203
|
-
querySchema: QuerySchema;
|
|
204
|
-
responseSchema: Response;
|
|
205
|
-
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
206
|
-
useContext?: () => Context;
|
|
207
|
-
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
208
|
-
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
209
|
-
onMutateResult: OnMutateResult | undefined;
|
|
210
|
-
}) => void | Promise<void>;
|
|
211
|
-
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
212
|
-
onMutateResult: OnMutateResult | undefined;
|
|
213
|
-
}) => void | Promise<void>;
|
|
214
|
-
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
215
|
-
onMutateResult: OnMutateResult | undefined;
|
|
216
|
-
}) => void | Promise<void>;
|
|
217
|
-
}): ((params: UrlHasParams<Url> extends true ? {
|
|
218
|
-
urlParams: UrlParams<Url>;
|
|
219
|
-
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
|
|
220
|
-
mutation<Method extends 'DELETE' = 'DELETE', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown>(config: {
|
|
221
|
-
method: Method;
|
|
222
|
-
url: Url;
|
|
223
|
-
querySchema: QuerySchema;
|
|
224
|
-
responseSchema: Response;
|
|
225
|
-
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
226
|
-
useContext?: () => Context;
|
|
227
|
-
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
228
|
-
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
229
|
-
onMutateResult: OnMutateResult | undefined;
|
|
230
|
-
}) => void | Promise<void>;
|
|
231
|
-
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
232
|
-
onMutateResult: OnMutateResult | undefined;
|
|
233
|
-
}) => void | Promise<void>;
|
|
234
|
-
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
235
|
-
onMutateResult: OnMutateResult | undefined;
|
|
236
|
-
}) => void | Promise<void>;
|
|
237
|
-
}): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
|
|
238
|
-
mutation<Method extends 'DELETE' = 'DELETE', Url extends string = string, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(config: {
|
|
239
|
-
method: Method;
|
|
240
|
-
url: Url;
|
|
241
|
-
useKey: UseKey;
|
|
242
|
-
responseSchema: Response;
|
|
243
|
-
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
244
|
-
useContext?: () => Context;
|
|
245
|
-
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
246
|
-
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
|
|
247
|
-
onMutateResult: OnMutateResult | undefined;
|
|
248
|
-
}) => void | Promise<void>;
|
|
249
|
-
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
|
|
250
|
-
onMutateResult: OnMutateResult | undefined;
|
|
251
|
-
}) => void | Promise<void>;
|
|
252
|
-
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
|
|
253
|
-
onMutateResult: OnMutateResult | undefined;
|
|
254
|
-
}) => void | Promise<void>;
|
|
255
|
-
}): ((params: UrlHasParams<Url> extends true ? {
|
|
256
|
-
urlParams: UrlParams<Url>;
|
|
257
|
-
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response>;
|
|
258
|
-
mutation<Method extends 'DELETE' = 'DELETE', Url extends string = string, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown>(config: {
|
|
259
|
-
method: Method;
|
|
260
|
-
url: Url;
|
|
261
|
-
responseSchema: Response;
|
|
262
|
-
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
263
|
-
useContext?: () => Context;
|
|
264
|
-
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
265
|
-
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
|
|
266
|
-
onMutateResult: OnMutateResult | undefined;
|
|
267
|
-
}) => void | Promise<void>;
|
|
268
|
-
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
|
|
269
|
-
onMutateResult: OnMutateResult | undefined;
|
|
270
|
-
}) => void | Promise<void>;
|
|
271
|
-
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
|
|
272
|
-
onMutateResult: OnMutateResult | undefined;
|
|
273
|
-
}) => void | Promise<void>;
|
|
274
|
-
}): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response>;
|
|
275
|
-
queryFromEndpoint<Method extends 'GET' | 'HEAD' | 'OPTIONS' = 'GET', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, Result = z.output<Response>>(endpoint: {
|
|
276
|
-
config: BaseEndpointConfig<Method, Url, QuerySchema, Response>;
|
|
277
|
-
}, options?: {
|
|
278
|
-
processResponse?: (data: z.output<Response>) => Result;
|
|
279
|
-
}): (params: Util_FlatObject<QueryArgs<Url, QuerySchema>>) => UseSuspenseQueryOptions<Result, Error, Result, DataTag<Split<Url, '/'>, Result, Error>> & QueryHelpers<Url, QuerySchema, Result>;
|
|
280
|
-
queryFromEndpoint<Method extends 'GET' | 'HEAD' | 'OPTIONS' = 'GET', Url extends string = string, Response extends ZodType = ZodType, Result = z.output<Response>>(endpoint: {
|
|
281
|
-
config: BaseEndpointConfig<Method, Url, undefined, Response>;
|
|
282
|
-
}, options?: {
|
|
283
|
-
processResponse?: (data: z.output<Response>) => Result;
|
|
284
|
-
}): ((params: Util_FlatObject<QueryArgs<Url, undefined>>) => UseSuspenseQueryOptions<Result, Error, Result, DataTag<Split<Url, '/'>, Result, Error>>) & QueryHelpers<Url, undefined, Result>;
|
|
285
|
-
infiniteQueryFromEndpoint<Method extends 'GET' | 'HEAD' | 'OPTIONS' = 'GET', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, PageResult = z.output<Response>, Result = InfiniteData<PageResult>>(endpoint: {
|
|
286
|
-
config: BaseEndpointConfig<Method, Url, QuerySchema, Response>;
|
|
287
|
-
}, options: {
|
|
288
|
-
processResponse?: (data: z.output<Response>) => PageResult;
|
|
289
|
-
getNextPageParam: (lastPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema> | undefined;
|
|
290
|
-
getPreviousPageParam?: (firstPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema>;
|
|
291
|
-
}): ((params: Util_FlatObject<QueryArgs<Url, QuerySchema>>) => UseSuspenseInfiniteQueryOptions<PageResult, Error, Result, DataTag<Split<Url, '/'>, PageResult, Error>, z.output<QuerySchema>>) & QueryHelpers<Url, QuerySchema, PageResult, true>;
|
|
292
|
-
mutationFromEndpoint<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(endpoint: {
|
|
293
|
-
config: BaseEndpointConfig<Method, Url, QuerySchema, Response, RequestSchema>;
|
|
294
|
-
}, mutationOptions: {
|
|
295
|
-
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
296
|
-
useKey: UseKey;
|
|
297
|
-
useContext?: () => Context;
|
|
298
|
-
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
299
|
-
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
300
|
-
onMutateResult: OnMutateResult | undefined;
|
|
301
|
-
}) => void | Promise<void>;
|
|
302
|
-
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
303
|
-
onMutateResult: OnMutateResult | undefined;
|
|
304
|
-
}) => void | Promise<void>;
|
|
305
|
-
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
306
|
-
onMutateResult: OnMutateResult | undefined;
|
|
307
|
-
}) => void | Promise<void>;
|
|
308
|
-
}): ((params: UrlHasParams<Url> extends true ? {
|
|
309
|
-
urlParams: UrlParams<Url>;
|
|
310
|
-
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
|
|
311
|
-
mutationFromEndpoint<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(endpoint: {
|
|
312
|
-
config: BaseEndpointConfig<Method, Url, undefined, Response, RequestSchema>;
|
|
313
|
-
}, mutationOptions: {
|
|
314
|
-
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
315
|
-
useKey: UseKey;
|
|
316
|
-
useContext?: () => Context;
|
|
317
|
-
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
318
|
-
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
319
|
-
onMutateResult: OnMutateResult | undefined;
|
|
320
|
-
}) => void | Promise<void>;
|
|
321
|
-
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
322
|
-
onMutateResult: OnMutateResult | undefined;
|
|
323
|
-
}) => void | Promise<void>;
|
|
324
|
-
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
325
|
-
onMutateResult: OnMutateResult | undefined;
|
|
326
|
-
}) => void | Promise<void>;
|
|
327
|
-
}): ((params: UrlHasParams<Url> extends true ? {
|
|
328
|
-
urlParams: UrlParams<Url>;
|
|
329
|
-
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, undefined>;
|
|
330
|
-
mutationFromEndpoint<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown>(endpoint: {
|
|
331
|
-
config: BaseEndpointConfig<Method, Url, QuerySchema, Response, RequestSchema>;
|
|
332
|
-
}, mutationOptions: {
|
|
333
|
-
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
334
|
-
useContext?: () => Context;
|
|
335
|
-
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
336
|
-
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
337
|
-
onMutateResult: OnMutateResult | undefined;
|
|
338
|
-
}) => void | Promise<void>;
|
|
339
|
-
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
340
|
-
onMutateResult: OnMutateResult | undefined;
|
|
341
|
-
}) => void | Promise<void>;
|
|
342
|
-
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
343
|
-
onMutateResult: OnMutateResult | undefined;
|
|
344
|
-
}) => void | Promise<void>;
|
|
345
|
-
}): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>, OnMutateResult>) & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
|
|
346
|
-
mutationFromEndpoint<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown>(endpoint: {
|
|
347
|
-
config: BaseEndpointConfig<Method, Url, undefined, Response, RequestSchema>;
|
|
348
|
-
}, mutationOptions: {
|
|
349
|
-
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
350
|
-
useContext?: () => Context;
|
|
351
|
-
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
352
|
-
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
353
|
-
onMutateResult: OnMutateResult | undefined;
|
|
354
|
-
}) => void | Promise<void>;
|
|
355
|
-
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
356
|
-
onMutateResult: OnMutateResult | undefined;
|
|
357
|
-
}) => void | Promise<void>;
|
|
358
|
-
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
359
|
-
onMutateResult: OnMutateResult | undefined;
|
|
360
|
-
}) => void | Promise<void>;
|
|
361
|
-
}): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>, OnMutateResult>) & EndpointHelper<Method, Url, RequestSchema, Response, undefined>;
|
|
362
|
-
mutationFromEndpoint<Method extends 'DELETE' = 'DELETE', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(endpoint: {
|
|
363
|
-
config: BaseEndpointConfig<Method, Url, QuerySchema, Response>;
|
|
364
|
-
}, mutationOptions: {
|
|
365
|
-
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
366
|
-
useKey: UseKey;
|
|
367
|
-
useContext?: () => Context;
|
|
368
|
-
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
369
|
-
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
370
|
-
onMutateResult: OnMutateResult | undefined;
|
|
371
|
-
}) => void | Promise<void>;
|
|
372
|
-
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
373
|
-
onMutateResult: OnMutateResult | undefined;
|
|
374
|
-
}) => void | Promise<void>;
|
|
375
|
-
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
376
|
-
onMutateResult: OnMutateResult | undefined;
|
|
377
|
-
}) => void | Promise<void>;
|
|
378
|
-
}): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
|
|
379
|
-
mutationFromEndpoint<Method extends 'DELETE' = 'DELETE', Url extends string = string, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(endpoint: {
|
|
380
|
-
config: BaseEndpointConfig<Method, Url, undefined, Response>;
|
|
381
|
-
}, mutationOptions: {
|
|
382
|
-
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
383
|
-
useKey: UseKey;
|
|
384
|
-
useContext?: () => Context;
|
|
385
|
-
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
386
|
-
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
|
|
387
|
-
onMutateResult: OnMutateResult | undefined;
|
|
388
|
-
}) => void | Promise<void>;
|
|
389
|
-
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
|
|
390
|
-
onMutateResult: OnMutateResult | undefined;
|
|
391
|
-
}) => void | Promise<void>;
|
|
392
|
-
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
|
|
393
|
-
onMutateResult: OnMutateResult | undefined;
|
|
394
|
-
}) => void | Promise<void>;
|
|
395
|
-
}): ((params: UrlHasParams<Url> extends true ? {
|
|
396
|
-
urlParams: UrlParams<Url>;
|
|
397
|
-
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response, undefined>;
|
|
398
|
-
mutationFromEndpoint<Method extends 'DELETE' = 'DELETE', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown>(endpoint: {
|
|
399
|
-
config: BaseEndpointConfig<Method, Url, QuerySchema, Response>;
|
|
400
|
-
}, mutationOptions: {
|
|
401
|
-
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
402
|
-
useContext?: () => Context;
|
|
403
|
-
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
404
|
-
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
405
|
-
onMutateResult: OnMutateResult | undefined;
|
|
406
|
-
}) => void | Promise<void>;
|
|
407
|
-
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
408
|
-
onMutateResult: OnMutateResult | undefined;
|
|
409
|
-
}) => void | Promise<void>;
|
|
410
|
-
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
411
|
-
onMutateResult: OnMutateResult | undefined;
|
|
412
|
-
}) => void | Promise<void>;
|
|
413
|
-
}): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>, OnMutateResult>) & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
|
|
414
|
-
mutationFromEndpoint<Method extends 'DELETE' = 'DELETE', Url extends string = string, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown>(endpoint: {
|
|
415
|
-
config: BaseEndpointConfig<Method, Url, undefined, Response>;
|
|
416
|
-
}, mutationOptions: {
|
|
417
|
-
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
418
|
-
useContext?: () => Context;
|
|
419
|
-
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
420
|
-
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
|
|
421
|
-
onMutateResult: OnMutateResult | undefined;
|
|
422
|
-
}) => void | Promise<void>;
|
|
423
|
-
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
|
|
424
|
-
onMutateResult: OnMutateResult | undefined;
|
|
425
|
-
}) => void | Promise<void>;
|
|
426
|
-
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
|
|
427
|
-
onMutateResult: OnMutateResult | undefined;
|
|
428
|
-
}) => void | Promise<void>;
|
|
429
|
-
}): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>, OnMutateResult>) & EndpointHelper<Method, Url, undefined, Response, undefined>;
|
|
430
|
-
multipartMutation<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(config: {
|
|
431
|
-
method: Method;
|
|
432
|
-
url: Url;
|
|
433
|
-
useKey: UseKey;
|
|
434
|
-
requestSchema: RequestSchema;
|
|
435
|
-
querySchema: QuerySchema;
|
|
436
|
-
responseSchema: Response;
|
|
437
|
-
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
438
|
-
useContext?: () => Context;
|
|
439
|
-
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
440
|
-
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
441
|
-
onMutateResult: OnMutateResult | undefined;
|
|
442
|
-
}) => void | Promise<void>;
|
|
443
|
-
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
444
|
-
onMutateResult: OnMutateResult | undefined;
|
|
445
|
-
}) => void | Promise<void>;
|
|
446
|
-
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
447
|
-
onMutateResult: OnMutateResult | undefined;
|
|
448
|
-
}) => void | Promise<void>;
|
|
449
|
-
}): ((params: UrlHasParams<Url> extends true ? {
|
|
450
|
-
urlParams: UrlParams<Url>;
|
|
451
|
-
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
|
|
452
|
-
multipartMutation<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown>(config: {
|
|
453
|
-
method: Method;
|
|
454
|
-
url: Url;
|
|
455
|
-
requestSchema: RequestSchema;
|
|
456
|
-
querySchema: QuerySchema;
|
|
457
|
-
responseSchema: Response;
|
|
458
|
-
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
459
|
-
useContext?: () => Context;
|
|
460
|
-
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
461
|
-
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
462
|
-
onMutateResult: OnMutateResult | undefined;
|
|
463
|
-
}) => void | Promise<void>;
|
|
464
|
-
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
465
|
-
onMutateResult: OnMutateResult | undefined;
|
|
466
|
-
}) => void | Promise<void>;
|
|
467
|
-
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
468
|
-
onMutateResult: OnMutateResult | undefined;
|
|
469
|
-
}) => void | Promise<void>;
|
|
470
|
-
}): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
|
|
471
|
-
multipartMutation<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown>(config: {
|
|
472
|
-
method: Method;
|
|
473
|
-
url: Url;
|
|
474
|
-
requestSchema: RequestSchema;
|
|
475
|
-
responseSchema: Response;
|
|
476
|
-
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
477
|
-
useContext?: () => Context;
|
|
478
|
-
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
479
|
-
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
480
|
-
onMutateResult: OnMutateResult | undefined;
|
|
481
|
-
}) => void | Promise<void>;
|
|
482
|
-
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
483
|
-
onMutateResult: OnMutateResult | undefined;
|
|
484
|
-
}) => void | Promise<void>;
|
|
485
|
-
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
486
|
-
onMutateResult: OnMutateResult | undefined;
|
|
487
|
-
}) => void | Promise<void>;
|
|
488
|
-
}): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response>;
|
|
489
|
-
multipartMutation<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(config: {
|
|
490
|
-
method: Method;
|
|
491
|
-
url: Url;
|
|
492
|
-
useKey: UseKey;
|
|
493
|
-
requestSchema: RequestSchema;
|
|
494
|
-
responseSchema: Response;
|
|
495
|
-
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
496
|
-
useContext?: () => Context;
|
|
497
|
-
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
498
|
-
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
499
|
-
onMutateResult: OnMutateResult | undefined;
|
|
500
|
-
}) => void | Promise<void>;
|
|
501
|
-
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
502
|
-
onMutateResult: OnMutateResult | undefined;
|
|
503
|
-
}) => void | Promise<void>;
|
|
504
|
-
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
505
|
-
onMutateResult: OnMutateResult | undefined;
|
|
506
|
-
}) => void | Promise<void>;
|
|
507
|
-
}): ((params: UrlHasParams<Url> extends true ? {
|
|
508
|
-
urlParams: UrlParams<Url>;
|
|
509
|
-
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response>;
|
|
510
|
-
mutationFromEndpoint<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, QuerySchema extends ZodObject = ZodObject, Result = Blob, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(endpoint: {
|
|
511
|
-
config: BaseStreamConfig<Method, Url, QuerySchema, RequestSchema>;
|
|
512
|
-
}, mutationOptions: {
|
|
513
|
-
processResponse?: ProcessResponseFunction<Result, Blob>;
|
|
514
|
-
useKey: UseKey;
|
|
515
|
-
useContext?: () => Context;
|
|
516
|
-
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
517
|
-
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
518
|
-
onMutateResult: OnMutateResult | undefined;
|
|
519
|
-
}) => void | Promise<void>;
|
|
520
|
-
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
521
|
-
onMutateResult: OnMutateResult | undefined;
|
|
522
|
-
}) => void | Promise<void>;
|
|
523
|
-
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
524
|
-
onMutateResult: OnMutateResult | undefined;
|
|
525
|
-
}) => void | Promise<void>;
|
|
526
|
-
}): ((params: UrlHasParams<Url> extends true ? {
|
|
527
|
-
urlParams: UrlParams<Url>;
|
|
528
|
-
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result> & StreamHelper<Method, Url, RequestSchema, QuerySchema>;
|
|
529
|
-
mutationFromEndpoint<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, QuerySchema extends ZodObject = ZodObject, Result = Blob, OnMutateResult = unknown, Context = unknown>(endpoint: {
|
|
530
|
-
config: BaseStreamConfig<Method, Url, QuerySchema, RequestSchema>;
|
|
531
|
-
}, mutationOptions?: {
|
|
532
|
-
processResponse?: ProcessResponseFunction<Result, Blob>;
|
|
533
|
-
useContext?: () => Context;
|
|
534
|
-
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
535
|
-
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
536
|
-
onMutateResult: OnMutateResult | undefined;
|
|
537
|
-
}) => void | Promise<void>;
|
|
538
|
-
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
539
|
-
onMutateResult: OnMutateResult | undefined;
|
|
540
|
-
}) => void | Promise<void>;
|
|
541
|
-
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
542
|
-
onMutateResult: OnMutateResult | undefined;
|
|
543
|
-
}) => void | Promise<void>;
|
|
544
|
-
}): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>, OnMutateResult>) & StreamHelper<Method, Url, RequestSchema, QuerySchema>;
|
|
545
|
-
mutationFromEndpoint<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, Result = Blob, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(endpoint: {
|
|
546
|
-
config: BaseStreamConfig<Method, Url, undefined, RequestSchema>;
|
|
547
|
-
}, mutationOptions: {
|
|
548
|
-
processResponse?: ProcessResponseFunction<Result, Blob>;
|
|
549
|
-
useKey: UseKey;
|
|
550
|
-
useContext?: () => Context;
|
|
551
|
-
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
552
|
-
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
553
|
-
onMutateResult: OnMutateResult | undefined;
|
|
554
|
-
}) => void | Promise<void>;
|
|
555
|
-
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
556
|
-
onMutateResult: OnMutateResult | undefined;
|
|
557
|
-
}) => void | Promise<void>;
|
|
558
|
-
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
559
|
-
onMutateResult: OnMutateResult | undefined;
|
|
560
|
-
}) => void | Promise<void>;
|
|
561
|
-
}): ((params: UrlHasParams<Url> extends true ? {
|
|
562
|
-
urlParams: UrlParams<Url>;
|
|
563
|
-
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>, OnMutateResult>) & MutationHelpers<Url, Result> & StreamHelper<Method, Url, RequestSchema, undefined>;
|
|
564
|
-
mutationFromEndpoint<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, Result = Blob, OnMutateResult = unknown, Context = unknown>(endpoint: {
|
|
565
|
-
config: BaseStreamConfig<Method, Url, undefined, RequestSchema>;
|
|
566
|
-
}, mutationOptions?: {
|
|
567
|
-
processResponse?: ProcessResponseFunction<Result, Blob>;
|
|
568
|
-
useContext?: () => Context;
|
|
569
|
-
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
570
|
-
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
571
|
-
onMutateResult: OnMutateResult | undefined;
|
|
572
|
-
}) => void | Promise<void>;
|
|
573
|
-
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
574
|
-
onMutateResult: OnMutateResult | undefined;
|
|
575
|
-
}) => void | Promise<void>;
|
|
576
|
-
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
|
|
577
|
-
onMutateResult: OnMutateResult | undefined;
|
|
578
|
-
}) => void | Promise<void>;
|
|
579
|
-
}): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>, OnMutateResult>) & StreamHelper<Method, Url, RequestSchema, undefined>;
|
|
580
|
-
mutationFromEndpoint<Method extends 'GET' | 'DELETE' | 'OPTIONS' | 'HEAD' = 'GET', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Result = Blob, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(endpoint: {
|
|
581
|
-
config: BaseStreamConfig<Method, Url, QuerySchema, undefined>;
|
|
582
|
-
}, mutationOptions: {
|
|
583
|
-
processResponse?: ProcessResponseFunction<Result, Blob>;
|
|
584
|
-
useKey: UseKey;
|
|
585
|
-
useContext?: () => Context;
|
|
586
|
-
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
587
|
-
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
588
|
-
onMutateResult: OnMutateResult | undefined;
|
|
589
|
-
}) => void | Promise<void>;
|
|
590
|
-
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
591
|
-
onMutateResult: OnMutateResult | undefined;
|
|
592
|
-
}) => void | Promise<void>;
|
|
593
|
-
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
594
|
-
onMutateResult: OnMutateResult | undefined;
|
|
595
|
-
}) => void | Promise<void>;
|
|
596
|
-
}): ((params: UrlHasParams<Url> extends true ? {
|
|
597
|
-
urlParams: UrlParams<Url>;
|
|
598
|
-
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result> & StreamHelper<Method, Url, undefined, QuerySchema>;
|
|
599
|
-
mutationFromEndpoint<Method extends 'GET' | 'DELETE' | 'OPTIONS' | 'HEAD' = 'GET', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Result = Blob, OnMutateResult = unknown, Context = unknown>(endpoint: {
|
|
600
|
-
config: BaseStreamConfig<Method, Url, QuerySchema, undefined>;
|
|
601
|
-
}, mutationOptions?: {
|
|
602
|
-
processResponse?: ProcessResponseFunction<Result, Blob>;
|
|
603
|
-
useContext?: () => Context;
|
|
604
|
-
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
605
|
-
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
606
|
-
onMutateResult: OnMutateResult | undefined;
|
|
607
|
-
}) => void | Promise<void>;
|
|
608
|
-
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
609
|
-
onMutateResult: OnMutateResult | undefined;
|
|
610
|
-
}) => void | Promise<void>;
|
|
611
|
-
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
|
|
612
|
-
onMutateResult: OnMutateResult | undefined;
|
|
613
|
-
}) => void | Promise<void>;
|
|
614
|
-
}): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>, OnMutateResult>) & StreamHelper<Method, Url, undefined, QuerySchema>;
|
|
615
|
-
mutationFromEndpoint<Method extends 'GET' | 'DELETE' | 'OPTIONS' | 'HEAD' = 'GET', Url extends string = string, Result = Blob, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(endpoint: {
|
|
616
|
-
config: BaseStreamConfig<Method, Url, undefined, undefined>;
|
|
617
|
-
}, mutationOptions: {
|
|
618
|
-
processResponse?: ProcessResponseFunction<Result, Blob>;
|
|
619
|
-
useKey: UseKey;
|
|
620
|
-
useContext?: () => Context;
|
|
621
|
-
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
622
|
-
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
|
|
623
|
-
onMutateResult: OnMutateResult | undefined;
|
|
624
|
-
}) => void | Promise<void>;
|
|
625
|
-
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
|
|
626
|
-
onMutateResult: OnMutateResult | undefined;
|
|
627
|
-
}) => void | Promise<void>;
|
|
628
|
-
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
|
|
629
|
-
onMutateResult: OnMutateResult | undefined;
|
|
630
|
-
}) => void | Promise<void>;
|
|
631
|
-
}): ((params: UrlHasParams<Url> extends true ? {
|
|
632
|
-
urlParams: UrlParams<Url>;
|
|
633
|
-
} : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>, OnMutateResult>) & MutationHelpers<Url, Result> & StreamHelper<Method, Url, undefined, undefined>;
|
|
634
|
-
mutationFromEndpoint<Method extends 'GET' | 'DELETE' | 'OPTIONS' | 'HEAD' = 'GET', Url extends string = string, Result = Blob, OnMutateResult = unknown, Context = unknown>(endpoint: {
|
|
635
|
-
config: BaseStreamConfig<Method, Url, undefined, undefined>;
|
|
636
|
-
}, mutationOptions?: {
|
|
637
|
-
processResponse?: ProcessResponseFunction<Result, Blob>;
|
|
638
|
-
useContext?: () => Context;
|
|
639
|
-
onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
|
|
640
|
-
onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
|
|
641
|
-
onMutateResult: OnMutateResult | undefined;
|
|
642
|
-
}) => void | Promise<void>;
|
|
643
|
-
onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
|
|
644
|
-
onMutateResult: OnMutateResult | undefined;
|
|
645
|
-
}) => void | Promise<void>;
|
|
646
|
-
onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
|
|
647
|
-
onMutateResult: OnMutateResult | undefined;
|
|
648
|
-
}) => void | Promise<void>;
|
|
649
|
-
}): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>, OnMutateResult>) & StreamHelper<Method, Url, undefined, undefined>;
|
|
650
|
-
}
|
|
651
|
-
export { ClientInstance }
|
|
652
|
-
export { ClientInstance as ClientInstance_alias_1 }
|
|
653
|
-
export { ClientInstance as ClientInstance_alias_2 }
|
|
654
|
-
|
|
655
|
-
/** @deprecated Use MutationArgs instead */
|
|
656
|
-
declare type ClientMutationArgs<Url extends string = string, RequestSchema = unknown, QuerySchema = unknown> = MutationArgs<Url, RequestSchema, QuerySchema>;
|
|
657
|
-
export { ClientMutationArgs }
|
|
658
|
-
export { ClientMutationArgs as ClientMutationArgs_alias_1 }
|
|
659
|
-
export { ClientMutationArgs as ClientMutationArgs_alias_2 }
|
|
660
|
-
|
|
661
|
-
/**
|
|
662
|
-
* Options for creating a client instance.
|
|
663
|
-
*/
|
|
664
|
-
declare type ClientOptions = {
|
|
665
|
-
api: BuilderInstance;
|
|
666
|
-
defaults?: {
|
|
667
|
-
keyPrefix?: string[];
|
|
668
|
-
keySuffix?: string[];
|
|
669
|
-
};
|
|
670
|
-
};
|
|
671
|
-
export { ClientOptions }
|
|
672
|
-
export { ClientOptions as ClientOptions_alias_1 }
|
|
673
|
-
export { ClientOptions as ClientOptions_alias_2 }
|
|
674
|
-
|
|
675
|
-
/** @deprecated Use QueryArgs instead */
|
|
676
|
-
declare type ClientQueryArgs<Url extends string = string, QuerySchema = ZodObject, RequestSchema = undefined> = QueryArgs<Url, QuerySchema, RequestSchema>;
|
|
677
|
-
export { ClientQueryArgs }
|
|
678
|
-
export { ClientQueryArgs as ClientQueryArgs_alias_1 }
|
|
679
|
-
export { ClientQueryArgs as ClientQueryArgs_alias_2 }
|
|
680
|
-
|
|
681
|
-
/** @deprecated Use QueryUrlParamsArgs instead */
|
|
682
|
-
declare type ClientQueryUrlParamsArgs<Url extends string = string> = QueryUrlParamsArgs<Url>;
|
|
683
|
-
export { ClientQueryUrlParamsArgs }
|
|
684
|
-
export { ClientQueryUrlParamsArgs as ClientQueryUrlParamsArgs_alias_1 }
|
|
685
|
-
export { ClientQueryUrlParamsArgs as ClientQueryUrlParamsArgs_alias_2 }
|
|
686
|
-
|
|
687
|
-
/**
|
|
688
|
-
* Creates a mutation key generator for a given endpoint configuration.
|
|
689
|
-
*
|
|
690
|
-
* @param config - The endpoint configuration
|
|
691
|
-
* @param options - Optional query parameters with a default `processResponse` function
|
|
692
|
-
* @returns A function that generates mutation keys
|
|
693
|
-
*
|
|
694
|
-
* @example Basic usage:
|
|
695
|
-
* ```typescript
|
|
696
|
-
* const createMutationKey = createMutationKey(endpoint.config);
|
|
697
|
-
* const mutationKey = createMutationKey({ urlParams: { id: 123 } });
|
|
698
|
-
* ```
|
|
699
|
-
*
|
|
700
|
-
* @example Advanced usage with processResponse:
|
|
701
|
-
* ```ts
|
|
702
|
-
* const createMutationKey = createMutationKey(endpoint.config, {
|
|
703
|
-
* processResponse: (data) => {
|
|
704
|
-
* if (!data.success) {
|
|
705
|
-
* throw new Error(data.message);
|
|
706
|
-
* }
|
|
707
|
-
* return data.data;
|
|
708
|
-
* },
|
|
709
|
-
* });
|
|
710
|
-
* // We create a mutation that will be shared across the project for all passed userId
|
|
711
|
-
* const mutationKey = createMutationKey({ urlParams: { projectId: 123, userId: 'wildcard' } });
|
|
712
|
-
* ```
|
|
713
|
-
*/
|
|
714
|
-
declare function createMutationKey<Config extends AnyEndpointConfig, Options extends QueryParams<Config>, Url extends Config['url'] = Config['url'], HasParams extends UrlHasParams<Url> = UrlHasParams<Url>>(config: Config, options?: Options): (params: HasParams extends true ? {
|
|
715
|
-
urlParams: UrlParams<Url>;
|
|
716
|
-
} : {}) => Options['processResponse'] extends (...args: unknown[]) => infer Result ? DataTag<[Config['url']], Result, Error> : never;
|
|
717
|
-
export { createMutationKey }
|
|
718
|
-
export { createMutationKey as createMutationKey_alias_1 }
|
|
719
|
-
export { createMutationKey as createMutationKey_alias_2 }
|
|
720
|
-
|
|
721
|
-
/**
|
|
722
|
-
* Creates a query key generator for a given endpoint configuration.
|
|
723
|
-
*
|
|
724
|
-
* The returned object provides methods to generate query keys that can be used
|
|
725
|
-
* with TanStack Query for caching, invalidation, and data tagging.
|
|
726
|
-
*
|
|
727
|
-
* @param config - The endpoint configuration
|
|
728
|
-
* @param options - Query parameters including processResponse and key prefix/suffix
|
|
729
|
-
* @param isInfinite - Whether this is for an infinite query
|
|
730
|
-
* @returns An object with methods to generate query keys
|
|
731
|
-
*/
|
|
732
|
-
declare function createQueryKey<Config extends AnyEndpointConfig, Options extends QueryParams<Config>, IsInfinite extends boolean, Url extends Config['url'] = Config['url'], HasParams extends UrlHasParams<Url> = UrlHasParams<Url>>(config: Config, options: Options, _isInfinite: IsInfinite): QueryKeyCreatorResult<Config['querySchema'], Url, Options['processResponse'] extends (...args: any[]) => infer Result ? Result : never, IsInfinite, HasParams>;
|
|
733
|
-
export { createQueryKey }
|
|
734
|
-
export { createQueryKey as createQueryKey_alias_1 }
|
|
735
|
-
export { createQueryKey as createQueryKey_alias_2 }
|
|
736
|
-
|
|
737
|
-
/**
|
|
738
|
-
* Creates a client instance for making type-safe queries and mutations.
|
|
739
|
-
*
|
|
740
|
-
* @param options - Client configuration including the API builder and defaults
|
|
741
|
-
* @returns A client instance with query, infiniteQuery, and mutation methods
|
|
742
|
-
*
|
|
743
|
-
* @example
|
|
744
|
-
* ```typescript
|
|
745
|
-
* const api = createBuilder({ baseUrl: '/api' });
|
|
746
|
-
* const client = declareClient({ api });
|
|
747
|
-
*
|
|
748
|
-
* const getUser = client.query({
|
|
749
|
-
* method: 'GET',
|
|
750
|
-
* url: '/users/$id',
|
|
751
|
-
* responseSchema: UserSchema,
|
|
752
|
-
* });
|
|
753
|
-
*
|
|
754
|
-
* // In a component
|
|
755
|
-
* const { data } = useSuspenseQuery(getUser({ urlParams: { id: '123' } }));
|
|
756
|
-
* ```
|
|
757
|
-
*/
|
|
758
|
-
declare function declareClient<Options extends ClientOptions>({ api, defaults, }: Options): ClientInstance;
|
|
759
|
-
export { declareClient }
|
|
760
|
-
export { declareClient as declareClient_alias_1 }
|
|
761
|
-
export { declareClient as declareClient_alias_2 }
|
|
762
|
-
|
|
763
|
-
/**
|
|
764
|
-
* Helper type that attaches the endpoint to query/mutation results.
|
|
765
|
-
*/
|
|
766
|
-
declare type EndpointHelper<Method extends HttpMethod = HttpMethod, Url extends string = string, RequestSchema = unknown, ResponseSchema extends z.ZodType = z.ZodType, QuerySchema = unknown> = {
|
|
767
|
-
endpoint: ((params: Util_FlatObject<EndpointFunctionArgs<Url, QuerySchema, RequestSchema>>) => Promise<z.output<ResponseSchema>>) & {
|
|
768
|
-
config: BaseEndpointConfig<Method, Url, QuerySchema, ResponseSchema, RequestSchema>;
|
|
769
|
-
};
|
|
770
|
-
};
|
|
771
|
-
export { EndpointHelper }
|
|
772
|
-
export { EndpointHelper as EndpointHelper_alias_1 }
|
|
773
|
-
export { EndpointHelper as EndpointHelper_alias_2 }
|
|
774
|
-
|
|
775
|
-
/**
|
|
776
|
-
* Configuration for declaring an infinite query endpoint.
|
|
777
|
-
*/
|
|
778
|
-
declare type InfiniteQueryConfig<Method = HttpMethod, Url = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, PageResult = z.output<Response>, Result = InfiniteData<PageResult>, RequestSchema = unknown> = {
|
|
779
|
-
method: Method;
|
|
780
|
-
url: Url;
|
|
781
|
-
querySchema: QuerySchema;
|
|
782
|
-
responseSchema: Response;
|
|
783
|
-
requestSchema?: RequestSchema;
|
|
784
|
-
processResponse?: (data: z.output<Response>) => PageResult;
|
|
785
|
-
select?: (data: InfiniteData<PageResult>) => Result;
|
|
786
|
-
getNextPageParam: (lastPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema> | undefined;
|
|
787
|
-
getPreviousPageParam?: (firstPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema>;
|
|
788
|
-
initialPageParam?: z.input<QuerySchema>;
|
|
789
|
-
};
|
|
790
|
-
export { InfiniteQueryConfig }
|
|
791
|
-
export { InfiniteQueryConfig as InfiniteQueryConfig_alias_1 }
|
|
792
|
-
export { InfiniteQueryConfig as InfiniteQueryConfig_alias_2 }
|
|
793
|
-
|
|
794
|
-
/**
|
|
795
|
-
* Options for infinite query configuration.
|
|
796
|
-
*/
|
|
797
|
-
declare type InfiniteQueryOptions<Config extends BaseEndpointConfig<HttpMethod, string, ZodObject>, Res = any> = {
|
|
798
|
-
keyPrefix?: string[];
|
|
799
|
-
keySuffix?: string[];
|
|
800
|
-
processResponse: (data: z.infer<Config['responseSchema']>) => Res;
|
|
801
|
-
onFail?: (err: unknown) => void;
|
|
802
|
-
getNextPageParam: (lastPage: Res, allPages: Res[], lastPageParam: z.infer<Config['querySchema']> | undefined, allPageParams: z.infer<Config['querySchema']>[] | undefined) => z.input<Config['querySchema']> | z.infer<Config['querySchema']> | undefined;
|
|
803
|
-
getPreviousPageParam?: (firstPage: Res, allPages: Res[], lastPageParam: z.infer<Config['querySchema']> | undefined, allPageParams: z.infer<Config['querySchema']>[] | undefined) => z.input<Config['querySchema']>;
|
|
804
|
-
initialPageParam?: z.input<Config['querySchema']> | z.infer<Config['querySchema']>;
|
|
805
|
-
};
|
|
806
|
-
export { InfiniteQueryOptions }
|
|
807
|
-
export { InfiniteQueryOptions as InfiniteQueryOptions_alias_1 }
|
|
808
|
-
export { InfiniteQueryOptions as InfiniteQueryOptions_alias_2 }
|
|
809
|
-
|
|
810
|
-
/**
|
|
811
|
-
* Creates infinite query options for a given endpoint.
|
|
812
|
-
*
|
|
813
|
-
* Returns a function that generates TanStack Query infinite options when called with params.
|
|
814
|
-
* The returned function also has helper methods attached (use, useSuspense, invalidate, etc.)
|
|
815
|
-
*
|
|
816
|
-
* @param endpoint - The navios endpoint to create infinite query options for
|
|
817
|
-
* @param options - Infinite query configuration including processResponse and pagination params
|
|
818
|
-
* @param baseQuery - Optional base query options to merge
|
|
819
|
-
* @returns A function that generates infinite query options with attached helpers
|
|
820
|
-
*/
|
|
821
|
-
declare function makeInfiniteQueryOptions<Config extends AnyEndpointConfig, Options extends InfiniteQueryOptions<Config>, BaseQuery extends Omit<UseInfiniteQueryOptions<ReturnType<Options['processResponse']>, Error, any>, 'queryKey' | 'queryFn' | 'getNextPageParam' | 'initialPageParam' | 'placeholderData' | 'throwOnError'>>(endpoint: AbstractEndpoint<Config>, options: Options, baseQuery?: BaseQuery): {
|
|
822
|
-
(params: QueryArgs<Config["url"], Config["querySchema"]>): Options["processResponse"] extends (...args: any[]) => infer Result ? UseSuspenseInfiniteQueryOptions<Result, Error, BaseQuery["select"] extends (...args: any[]) => infer T ? T : InfiniteData<Result>> : never;
|
|
823
|
-
queryKey: QueryKeyCreatorResult_2<Config["querySchema"], Config["url"], Options["processResponse"] extends (...args: any[]) => infer Result ? Result : never, true, UrlHasParams<Config["url"]>>;
|
|
824
|
-
use(params: QueryArgs<Config["url"], Config["querySchema"]>): UseInfiniteQueryResult<BaseQuery["select"] extends (...args: any[]) => infer T ? T : InfiniteData<unknown, unknown>, Error>;
|
|
825
|
-
useSuspense(params: QueryArgs<Config["url"], Config["querySchema"]>): UseSuspenseInfiniteQueryResult<BaseQuery["select"] extends (...args: any[]) => infer T ? T : InfiniteData<unknown, unknown>, Error>;
|
|
826
|
-
invalidate(queryClient: QueryClient, params: QueryArgs<Config["url"], Config["querySchema"]>): Promise<void>;
|
|
827
|
-
invalidateAll(queryClient: QueryClient, params: QueryArgs<Config["url"], Config["querySchema"]>): Promise<void>;
|
|
828
|
-
};
|
|
829
|
-
export { makeInfiniteQueryOptions }
|
|
830
|
-
export { makeInfiniteQueryOptions as makeInfiniteQueryOptions_alias_1 }
|
|
831
|
-
export { makeInfiniteQueryOptions as makeInfiniteQueryOptions_alias_2 }
|
|
832
|
-
|
|
833
|
-
/**
|
|
834
|
-
* Creates a mutation hook for a given endpoint.
|
|
835
|
-
*
|
|
836
|
-
* Returns a function that when called returns a TanStack Query mutation result.
|
|
837
|
-
* The returned function also has helper methods attached (mutationKey, useIsMutating).
|
|
838
|
-
*
|
|
839
|
-
* @param endpoint - The navios endpoint to create a mutation hook for
|
|
840
|
-
* @param options - Mutation configuration including processResponse and callbacks
|
|
841
|
-
* @returns A hook function that returns mutation result with attached helpers
|
|
842
|
-
*/
|
|
843
|
-
declare function makeMutation<Config extends AnyEndpointConfig, TData = unknown, TVariables extends NaviosZodRequest<Config> = NaviosZodRequest<Config>, TResponse = z.output<Config['responseSchema']>, TOnMutateResult = unknown, TContext = unknown, UseKey extends boolean = false>(endpoint: AbstractEndpoint<Config>, options: MutationParams<Config, TData, TVariables, TResponse, TOnMutateResult, TContext, UseKey>): {
|
|
844
|
-
(keyParams: UseKey extends true ? UrlHasParams<Config["url"]> extends true ? UrlParams<Config["url"]> : never : never): UseMutationResult<TData, Error, NaviosZodRequest<Config>, TOnMutateResult>;
|
|
845
|
-
useIsMutating(keyParams: UseKey extends true ? UrlHasParams<Config["url"]> extends true ? UrlParams<Config["url"]> : never : never): boolean;
|
|
846
|
-
mutationKey: (params: UrlHasParams<Config["url"]> extends infer T ? T extends UrlHasParams<Config["url"]> ? T extends true ? {
|
|
847
|
-
urlParams: UrlParams<Config["url"]>;
|
|
848
|
-
} : {} : never : never) => ProcessResponseFunction_2<TData, TResponse> | ((data: z.core.output<Config["responseSchema"]>) => z.core.output<Config["responseSchema"]>) extends (...args: unknown[]) => infer Result ? [Config["url"]] & {
|
|
849
|
-
[dataTagSymbol]: Result;
|
|
850
|
-
[dataTagErrorSymbol]: Error;
|
|
851
|
-
} : never;
|
|
852
|
-
};
|
|
853
|
-
export { makeMutation }
|
|
854
|
-
export { makeMutation as makeMutation_alias_1 }
|
|
855
|
-
export { makeMutation as makeMutation_alias_2 }
|
|
856
|
-
|
|
857
|
-
/**
|
|
858
|
-
* Creates query options for a given endpoint.
|
|
859
|
-
*
|
|
860
|
-
* Returns a function that generates TanStack Query options when called with params.
|
|
861
|
-
* The returned function also has helper methods attached (use, useSuspense, invalidate, etc.)
|
|
862
|
-
*
|
|
863
|
-
* @param endpoint - The navios endpoint to create query options for
|
|
864
|
-
* @param options - Query configuration including processResponse
|
|
865
|
-
* @param baseQuery - Optional base query options to merge
|
|
866
|
-
* @returns A function that generates query options with attached helpers
|
|
867
|
-
*/
|
|
868
|
-
declare function makeQueryOptions<Config extends AnyEndpointConfig, Options extends QueryParams<Config>, BaseQuery extends Omit<UseQueryOptions<ReturnType<Options['processResponse']>, Error, any>, 'queryKey' | 'queryFn' | 'getNextPageParam' | 'initialPageParam' | 'enabled' | 'throwOnError' | 'placeholderData'>>(endpoint: AbstractEndpoint<Config>, options: Options, baseQuery?: BaseQuery): {
|
|
869
|
-
(params: QueryArgs<Config["url"], Config["querySchema"]>): Options["processResponse"] extends (...args: any[]) => infer Result ? UseSuspenseQueryOptions<Result, Error, BaseQuery["select"] extends (...args: any[]) => infer T ? T : Result, DataTag<Split<Config["url"], "/">, Result, Error>> : never;
|
|
870
|
-
queryKey: QueryKeyCreatorResult_2<Config["querySchema"], Config["url"], Options["processResponse"] extends (...args: any[]) => infer Result ? Result : never, false, UrlHasParams<Config["url"]>>;
|
|
871
|
-
use(params: QueryArgs<Config["url"], Config["querySchema"]>): UseQueryResult<NoInfer_2<BaseQuery["select"] extends (...args: any[]) => infer T ? T : unknown>, Error>;
|
|
872
|
-
useSuspense(params: QueryArgs<Config["url"], Config["querySchema"]>): UseSuspenseQueryResult<BaseQuery["select"] extends (...args: any[]) => infer T ? T : unknown, Error>;
|
|
873
|
-
invalidate(queryClient: QueryClient, params: QueryArgs<Config["url"], Config["querySchema"]>): Promise<void>;
|
|
874
|
-
invalidateAll(queryClient: QueryClient, params: QueryArgs<Config["url"], Config["querySchema"]>): Promise<void>;
|
|
875
|
-
};
|
|
876
|
-
export { makeQueryOptions }
|
|
877
|
-
export { makeQueryOptions as makeQueryOptions_alias_1 }
|
|
878
|
-
export { makeQueryOptions as makeQueryOptions_alias_2 }
|
|
879
|
-
|
|
880
|
-
/**
|
|
881
|
-
* Arguments for mutation functions based on URL params, request schema, and query schema.
|
|
882
|
-
*/
|
|
883
|
-
declare type MutationArgs<Url extends string = string, RequestSchema = unknown, QuerySchema = unknown> = (UrlHasParams<Url> extends true ? {
|
|
884
|
-
urlParams: UrlParams<Url>;
|
|
885
|
-
} : {}) & (RequestSchema extends ZodObject ? {
|
|
886
|
-
data: z.input<RequestSchema>;
|
|
887
|
-
} : {}) & (QuerySchema extends ZodObject ? {
|
|
888
|
-
params: z.input<QuerySchema>;
|
|
889
|
-
} : {});
|
|
890
|
-
export { MutationArgs }
|
|
891
|
-
export { MutationArgs as MutationArgs_alias_1 }
|
|
892
|
-
export { MutationArgs as MutationArgs_alias_2 }
|
|
893
|
-
|
|
894
|
-
/**
|
|
895
|
-
* Configuration for declaring a mutation endpoint.
|
|
896
|
-
*/
|
|
897
|
-
declare interface MutationConfig<Method extends 'POST' | 'PUT' | 'PATCH' | 'DELETE' = 'POST' | 'PUT' | 'PATCH' | 'DELETE', Url extends string = string, RequestSchema = Method extends 'DELETE' ? never : ZodObject, QuerySchema = unknown, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, TOnMutateResult = unknown, Context = unknown, UseKey extends boolean = false> {
|
|
898
|
-
method: Method;
|
|
899
|
-
url: Url;
|
|
900
|
-
querySchema?: QuerySchema;
|
|
901
|
-
responseSchema: Response;
|
|
902
|
-
requestSchema?: RequestSchema;
|
|
903
|
-
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
904
|
-
useContext?: () => Context;
|
|
905
|
-
onSuccess?: (data: Result, variables: MutationArgs<Url, RequestSchema, QuerySchema>, context: Context & MutationFunctionContext & {
|
|
906
|
-
onMutateResult: TOnMutateResult | undefined;
|
|
907
|
-
}) => void | Promise<void>;
|
|
908
|
-
onError?: (err: unknown, variables: MutationArgs<Url, RequestSchema, QuerySchema>, context: Context & MutationFunctionContext & {
|
|
909
|
-
onMutateResult: TOnMutateResult | undefined;
|
|
910
|
-
}) => void | Promise<void>;
|
|
911
|
-
onMutate?: (variables: MutationArgs<Url, RequestSchema, QuerySchema>, context: Context & MutationFunctionContext) => TOnMutateResult | Promise<TOnMutateResult>;
|
|
912
|
-
onSettled?: (data: Result | undefined, error: Error | null, variables: MutationArgs<Url, RequestSchema, QuerySchema>, context: Context & MutationFunctionContext & {
|
|
913
|
-
onMutateResult: TOnMutateResult | undefined;
|
|
914
|
-
}) => void | Promise<void>;
|
|
915
|
-
useKey?: UseKey;
|
|
916
|
-
meta?: Record<string, unknown>;
|
|
917
|
-
}
|
|
918
|
-
export { MutationConfig }
|
|
919
|
-
export { MutationConfig as MutationConfig_alias_1 }
|
|
920
|
-
export { MutationConfig as MutationConfig_alias_2 }
|
|
921
|
-
|
|
922
|
-
/**
|
|
923
|
-
* Helper methods attached to mutation hooks.
|
|
924
|
-
*/
|
|
925
|
-
declare type MutationHelpers<Url extends string, Result = unknown> = UrlHasParams<Url> extends true ? {
|
|
926
|
-
mutationKey: (params: UrlParams<Url>) => DataTag<[Url], Result, Error>;
|
|
927
|
-
useIsMutating: (keyParams: UrlParams<Url>) => boolean;
|
|
928
|
-
} : {
|
|
929
|
-
mutationKey: () => DataTag<[Url], Result, Error>;
|
|
930
|
-
useIsMutating: () => boolean;
|
|
931
|
-
};
|
|
932
|
-
export { MutationHelpers }
|
|
933
|
-
export { MutationHelpers as MutationHelpers_alias_1 }
|
|
934
|
-
export { MutationHelpers as MutationHelpers_alias_2 }
|
|
935
|
-
|
|
936
|
-
/** @deprecated Use createMutationKey instead */
|
|
937
|
-
declare const mutationKeyCreator: typeof createMutationKey;
|
|
938
|
-
export { mutationKeyCreator }
|
|
939
|
-
export { mutationKeyCreator as mutationKeyCreator_alias_1 }
|
|
940
|
-
export { mutationKeyCreator as mutationKeyCreator_alias_2 }
|
|
941
|
-
|
|
942
|
-
/**
|
|
943
|
-
* Base parameters for mutation configuration.
|
|
944
|
-
*/
|
|
945
|
-
declare interface MutationParams<Config extends AnyEndpointConfig, TData = unknown, TVariables = NaviosZodRequest<Config>, TResponse = z.output<Config['responseSchema']>, TOnMutateResult = unknown, TContext = unknown, UseKey extends boolean = false> extends Omit<UseMutationOptions<TData, Error, TVariables>, 'mutationKey' | 'mutationFn' | 'onMutate' | 'onSuccess' | 'onError' | 'onSettled' | 'scope'> {
|
|
946
|
-
processResponse?: ProcessResponseFunction<TData, TResponse>;
|
|
947
|
-
/**
|
|
948
|
-
* React hooks that will prepare the context for the mutation onSuccess and onError
|
|
949
|
-
* callbacks. This is useful for when you want to use the context in the callbacks
|
|
950
|
-
*/
|
|
951
|
-
useContext?: () => TContext;
|
|
952
|
-
onSuccess?: (data: TData, variables: TVariables, context: TContext & MutationFunctionContext & {
|
|
953
|
-
onMutateResult: TOnMutateResult | undefined;
|
|
954
|
-
}) => void | Promise<void>;
|
|
955
|
-
onError?: (err: unknown, variables: TVariables, context: TContext & MutationFunctionContext & {
|
|
956
|
-
onMutateResult: TOnMutateResult | undefined;
|
|
957
|
-
}) => void | Promise<void>;
|
|
958
|
-
onMutate?: (variables: TVariables, context: TContext & MutationFunctionContext) => TOnMutateResult | Promise<TOnMutateResult>;
|
|
959
|
-
onSettled?: (data: TData | undefined, error: Error | null, variables: TVariables, context: TContext & MutationFunctionContext & {
|
|
960
|
-
onMutateResult: TOnMutateResult | undefined;
|
|
961
|
-
}) => void | Promise<void>;
|
|
962
|
-
/**
|
|
963
|
-
* If true, we will create a mutation key that can be shared across the project.
|
|
964
|
-
*/
|
|
965
|
-
useKey?: UseKey;
|
|
966
|
-
keyPrefix?: UseKey extends true ? UrlHasParams<Config['url']> extends true ? string[] : never : never;
|
|
967
|
-
keySuffix?: UseKey extends true ? UrlHasParams<Config['url']> extends true ? string[] : never : never;
|
|
968
|
-
}
|
|
969
|
-
export { MutationParams }
|
|
970
|
-
export { MutationParams as MutationParams_alias_1 }
|
|
971
|
-
export { MutationParams as MutationParams_alias_2 }
|
|
972
|
-
|
|
973
|
-
/**
|
|
974
|
-
* Function type for processing API responses before returning to the caller.
|
|
975
|
-
*/
|
|
976
|
-
declare type ProcessResponseFunction<TData = unknown, TVariables = unknown> = (variables: TVariables) => Promise<TData> | TData;
|
|
977
|
-
export { ProcessResponseFunction }
|
|
978
|
-
export { ProcessResponseFunction as ProcessResponseFunction_alias_1 }
|
|
979
|
-
export { ProcessResponseFunction as ProcessResponseFunction_alias_2 }
|
|
980
|
-
|
|
981
|
-
/**
|
|
982
|
-
* Arguments for query functions based on URL params and query schema.
|
|
983
|
-
*/
|
|
984
|
-
declare type QueryArgs<Url extends string = string, QuerySchema = ZodObject, RequestSchema = undefined> = (UrlHasParams<Url> extends true ? {
|
|
985
|
-
urlParams: UrlParams<Url>;
|
|
986
|
-
} : {}) & (QuerySchema extends ZodObject ? {
|
|
987
|
-
params: z.input<QuerySchema>;
|
|
988
|
-
} : {}) & (RequestSchema extends ZodType ? {
|
|
989
|
-
data: z.input<RequestSchema>;
|
|
990
|
-
} : {});
|
|
991
|
-
export { QueryArgs }
|
|
992
|
-
export { QueryArgs as QueryArgs_alias_1 }
|
|
993
|
-
export { QueryArgs as QueryArgs_alias_2 }
|
|
994
|
-
|
|
995
|
-
/**
|
|
996
|
-
* Configuration for declaring a query endpoint.
|
|
997
|
-
*/
|
|
998
|
-
declare interface QueryConfig<Method = HttpMethod, Url = string, QuerySchema = ZodObject, Response extends ZodType = ZodType, Result = z.output<Response>, RequestSchema = unknown> {
|
|
999
|
-
method: Method;
|
|
1000
|
-
url: Url;
|
|
1001
|
-
querySchema?: QuerySchema;
|
|
1002
|
-
responseSchema: Response;
|
|
1003
|
-
requestSchema?: RequestSchema;
|
|
1004
|
-
processResponse?: (data: z.output<Response>) => Result;
|
|
1005
|
-
}
|
|
1006
|
-
export { QueryConfig }
|
|
1007
|
-
export { QueryConfig as QueryConfig_alias_1 }
|
|
1008
|
-
export { QueryConfig as QueryConfig_alias_2 }
|
|
1009
|
-
|
|
1010
|
-
/**
|
|
1011
|
-
* Helper methods attached to query options.
|
|
1012
|
-
*/
|
|
1013
|
-
declare type QueryHelpers<Url extends string, QuerySchema extends ZodObject | undefined = undefined, Result = undefined, IsInfinite extends boolean = false, RequestSchema extends ZodType | undefined = undefined> = {
|
|
1014
|
-
queryKey: QueryKeyCreatorResult<QuerySchema, Url, Result, IsInfinite>;
|
|
1015
|
-
use: (params: Util_FlatObject<QueryArgs<Url, QuerySchema, RequestSchema>>) => UseQueryResult<Result, Error>;
|
|
1016
|
-
useSuspense: (params: Util_FlatObject<QueryArgs<Url, QuerySchema, RequestSchema>>) => UseSuspenseQueryResult<Result, Error>;
|
|
1017
|
-
invalidate: (queryClient: QueryClient, params: Util_FlatObject<QueryArgs<Url, QuerySchema, RequestSchema>>) => () => Promise<void>;
|
|
1018
|
-
invalidateAll: (queryClient: QueryClient, params: Util_FlatObject<QueryUrlParamsArgs<Url>>) => () => Promise<void>;
|
|
1019
|
-
};
|
|
1020
|
-
export { QueryHelpers }
|
|
1021
|
-
export { QueryHelpers as QueryHelpers_alias_1 }
|
|
1022
|
-
export { QueryHelpers as QueryHelpers_alias_2 }
|
|
1023
|
-
|
|
1024
|
-
/** @deprecated Use createQueryKey instead */
|
|
1025
|
-
declare const queryKeyCreator: typeof createQueryKey;
|
|
1026
|
-
export { queryKeyCreator }
|
|
1027
|
-
export { queryKeyCreator as queryKeyCreator_alias_1 }
|
|
1028
|
-
export { queryKeyCreator as queryKeyCreator_alias_2 }
|
|
1029
|
-
|
|
1030
|
-
/**
|
|
1031
|
-
* Result type from the query key creator function.
|
|
1032
|
-
*/
|
|
1033
|
-
declare type QueryKeyCreatorResult<QuerySchema = undefined, Url extends string = string, Result = unknown, IsInfinite extends boolean = false, HasParams extends UrlHasParams<Url> = UrlHasParams<Url>> = {
|
|
1034
|
-
template: Split<Url, '/'>;
|
|
1035
|
-
dataTag: (params: (HasParams extends true ? {
|
|
1036
|
-
urlParams: UrlParams<Url>;
|
|
1037
|
-
} : {}) & (QuerySchema extends ZodObject ? {
|
|
1038
|
-
params: z.input<QuerySchema>;
|
|
1039
|
-
} : {})) => DataTag<Split<Url, '/'>, IsInfinite extends true ? InfiniteData<Result> : Result, Error>;
|
|
1040
|
-
filterKey: (params: HasParams extends true ? {
|
|
1041
|
-
urlParams: UrlParams<Url>;
|
|
1042
|
-
} : {}) => DataTag<Split<Url, '/'>, IsInfinite extends true ? InfiniteData<Result> : Result, Error>;
|
|
1043
|
-
bindToUrl: (params: (HasParams extends true ? {
|
|
1044
|
-
urlParams: UrlParams<Url>;
|
|
1045
|
-
} : {}) & (QuerySchema extends ZodObject ? {
|
|
1046
|
-
params: z.infer<QuerySchema>;
|
|
1047
|
-
} : {})) => string;
|
|
1048
|
-
};
|
|
1049
|
-
export { QueryKeyCreatorResult }
|
|
1050
|
-
export { QueryKeyCreatorResult as QueryKeyCreatorResult_alias_1 }
|
|
1051
|
-
export { QueryKeyCreatorResult as QueryKeyCreatorResult_alias_2 }
|
|
1052
|
-
|
|
1053
|
-
/**
|
|
1054
|
-
* Base parameters for query configuration.
|
|
1055
|
-
*/
|
|
1056
|
-
declare type QueryParams<Config extends AnyEndpointConfig, Res = any> = {
|
|
1057
|
-
keyPrefix?: string[];
|
|
1058
|
-
keySuffix?: string[];
|
|
1059
|
-
onFail?: (err: unknown) => void;
|
|
1060
|
-
processResponse: (data: z.output<Config['responseSchema']>) => Res;
|
|
1061
|
-
};
|
|
1062
|
-
export { QueryParams }
|
|
1063
|
-
export { QueryParams as QueryParams_alias_1 }
|
|
1064
|
-
export { QueryParams as QueryParams_alias_2 }
|
|
1065
|
-
|
|
1066
|
-
/**
|
|
1067
|
-
* Arguments containing only URL params (for invalidateAll operations).
|
|
1068
|
-
*/
|
|
1069
|
-
declare type QueryUrlParamsArgs<Url extends string = string> = UrlHasParams<Url> extends true ? {
|
|
1070
|
-
urlParams: UrlParams<Url>;
|
|
1071
|
-
} : {} | undefined;
|
|
1072
|
-
export { QueryUrlParamsArgs }
|
|
1073
|
-
export { QueryUrlParamsArgs as QueryUrlParamsArgs_alias_1 }
|
|
1074
|
-
export { QueryUrlParamsArgs as QueryUrlParamsArgs_alias_2 }
|
|
1075
|
-
|
|
1076
|
-
/**
|
|
1077
|
-
* Splits a string by a delimiter into a tuple type.
|
|
1078
|
-
* Used for parsing URL paths into segments for query keys.
|
|
1079
|
-
*/
|
|
1080
|
-
declare type Split<S extends string, D extends string> = string extends S ? string[] : S extends '' ? [] : S extends `${infer T}${D}${infer U}` ? [T, ...Split<U, D>] : [S];
|
|
1081
|
-
export { Split }
|
|
1082
|
-
export { Split as Split_alias_1 }
|
|
1083
|
-
export { Split as Split_alias_2 }
|
|
1084
|
-
|
|
1085
|
-
/**
|
|
1086
|
-
* Helper type that attaches a stream endpoint to mutation results.
|
|
1087
|
-
*/
|
|
1088
|
-
declare type StreamHelper<Method extends HttpMethod = HttpMethod, Url extends string = string, RequestSchema = unknown, QuerySchema = unknown> = {
|
|
1089
|
-
endpoint: ((params: Util_FlatObject<EndpointFunctionArgs<Url, QuerySchema, RequestSchema>>) => Promise<Blob>) & {
|
|
1090
|
-
config: BaseStreamConfig<Method, Url, QuerySchema, RequestSchema>;
|
|
1091
|
-
};
|
|
1092
|
-
};
|
|
1093
|
-
export { StreamHelper }
|
|
1094
|
-
export { StreamHelper as StreamHelper_alias_1 }
|
|
1095
|
-
export { StreamHelper as StreamHelper_alias_2 }
|
|
1096
|
-
|
|
1097
|
-
export { }
|