@navios/react-query 0.5.2 → 0.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (25) hide show
  1. package/CHANGELOG.md +51 -10
  2. package/README.md +405 -273
  3. package/dist/src/client/declare-client.d.mts +13 -4
  4. package/dist/src/client/declare-client.d.mts.map +1 -1
  5. package/dist/src/client/types.d.mts +337 -113
  6. package/dist/src/client/types.d.mts.map +1 -1
  7. package/dist/src/mutation/make-hook.d.mts +2 -2
  8. package/dist/src/mutation/make-hook.d.mts.map +1 -1
  9. package/dist/src/mutation/types.d.mts +12 -4
  10. package/dist/src/mutation/types.d.mts.map +1 -1
  11. package/dist/tsconfig.tsbuildinfo +1 -1
  12. package/lib/_tsup-dts-rollup.d.mts +362 -120
  13. package/lib/_tsup-dts-rollup.d.ts +362 -120
  14. package/lib/index.js +51 -27
  15. package/lib/index.js.map +1 -1
  16. package/lib/index.mjs +52 -28
  17. package/lib/index.mjs.map +1 -1
  18. package/package.json +1 -1
  19. package/src/__tests__/declare-client.spec.mts +24 -5
  20. package/src/__tests__/make-mutation.spec.mts +150 -8
  21. package/src/client/__type-tests__/client-instance.spec-d.mts +2 -2
  22. package/src/client/declare-client.mts +33 -8
  23. package/src/client/types.mts +617 -141
  24. package/src/mutation/make-hook.mts +96 -42
  25. package/src/mutation/types.mts +28 -6
package/lib/_tsup-dts-rollup.d.mts CHANGED
@@ -7,6 +7,7 @@ import type { DataTag } from '@tanstack/react-query';
7
7
  import type { EndpointFunctionArgs } from '@navios/builder';
8
8
  import type { HttpMethod } from '@navios/builder';
9
9
  import type { InfiniteData } from '@tanstack/react-query';
10
+ import type { MutationFunctionContext } from '@tanstack/react-query';
10
11
  import type { NaviosZodRequest } from '@navios/builder';
11
12
  import { NoInfer as NoInfer_2 } from '@tanstack/react-query';
12
13
  import { ProcessResponseFunction as ProcessResponseFunction_2 } from '../index.mjs';
@@ -115,7 +116,7 @@ declare interface ClientInstance {
115
116
  getNextPageParam: (lastPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema> | undefined;
116
117
  getPreviousPageParam?: (firstPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema>;
117
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>;
118
- 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, Context = unknown, UseKey extends true = true>(config: {
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: {
119
120
  method: Method;
120
121
  url: Url;
121
122
  useKey: UseKey;
@@ -124,12 +125,20 @@ declare interface ClientInstance {
124
125
  responseSchema: Response;
125
126
  processResponse: ProcessResponseFunction<Result, ReqResult>;
126
127
  useContext?: () => Context;
127
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
128
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
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>;
129
138
  }): ((params: UrlHasParams<Url> extends true ? {
130
139
  urlParams: UrlParams<Url>;
131
- } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
132
- 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, Context = unknown>(config: {
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: {
133
142
  method: Method;
134
143
  url: Url;
135
144
  requestSchema: RequestSchema;
@@ -137,20 +146,36 @@ declare interface ClientInstance {
137
146
  responseSchema: Response;
138
147
  processResponse: ProcessResponseFunction<Result, ReqResult>;
139
148
  useContext?: () => Context;
140
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
141
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
142
- }): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
143
- 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, Context = unknown>(config: {
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: {
144
161
  method: Method;
145
162
  url: Url;
146
163
  requestSchema: RequestSchema;
147
164
  responseSchema: Response;
148
165
  processResponse: ProcessResponseFunction<Result, ReqResult>;
149
166
  useContext?: () => Context;
150
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
151
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
152
- }): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response>;
153
- 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, Context = unknown, UseKey extends true = true>(config: {
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: {
154
179
  method: Method;
155
180
  url: Url;
156
181
  useKey: UseKey;
@@ -158,12 +183,20 @@ declare interface ClientInstance {
158
183
  responseSchema: Response;
159
184
  processResponse: ProcessResponseFunction<Result, ReqResult>;
160
185
  useContext?: () => Context;
161
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
162
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
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>;
163
196
  }): ((params: UrlHasParams<Url> extends true ? {
164
197
  urlParams: UrlParams<Url>;
165
- } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response>;
166
- mutation<Method extends 'DELETE' = 'DELETE', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown, UseKey extends true = true>(config: {
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: {
167
200
  method: Method;
168
201
  url: Url;
169
202
  useKey: UseKey;
@@ -171,42 +204,74 @@ declare interface ClientInstance {
171
204
  responseSchema: Response;
172
205
  processResponse: ProcessResponseFunction<Result, ReqResult>;
173
206
  useContext?: () => Context;
174
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
175
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
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>;
176
217
  }): ((params: UrlHasParams<Url> extends true ? {
177
218
  urlParams: UrlParams<Url>;
178
- } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
179
- mutation<Method extends 'DELETE' = 'DELETE', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown>(config: {
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: {
180
221
  method: Method;
181
222
  url: Url;
182
223
  querySchema: QuerySchema;
183
224
  responseSchema: Response;
184
225
  processResponse: ProcessResponseFunction<Result, ReqResult>;
185
226
  useContext?: () => Context;
186
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
187
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
188
- }): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
189
- mutation<Method extends 'DELETE' = 'DELETE', Url extends string = string, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown, UseKey extends true = true>(config: {
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: {
190
239
  method: Method;
191
240
  url: Url;
192
241
  useKey: UseKey;
193
242
  responseSchema: Response;
194
243
  processResponse: ProcessResponseFunction<Result, ReqResult>;
195
244
  useContext?: () => Context;
196
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
197
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
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>;
198
255
  }): ((params: UrlHasParams<Url> extends true ? {
199
256
  urlParams: UrlParams<Url>;
200
- } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response>;
201
- mutation<Method extends 'DELETE' = 'DELETE', Url extends string = string, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown>(config: {
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: {
202
259
  method: Method;
203
260
  url: Url;
204
261
  responseSchema: Response;
205
262
  processResponse: ProcessResponseFunction<Result, ReqResult>;
206
263
  useContext?: () => Context;
207
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
208
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
209
- }): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response>;
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>;
210
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: {
211
276
  config: BaseEndpointConfig<Method, Url, QuerySchema, Response>;
212
277
  }, options?: {
@@ -224,81 +289,145 @@ declare interface ClientInstance {
224
289
  getNextPageParam: (lastPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema> | undefined;
225
290
  getPreviousPageParam?: (firstPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema>;
226
291
  }): ((params: Util_FlatObject<QueryArgs<Url, QuerySchema>>) => UseSuspenseInfiniteQueryOptions<PageResult, Error, Result, DataTag<Split<Url, '/'>, PageResult, Error>, z.output<QuerySchema>>) & QueryHelpers<Url, QuerySchema, PageResult, true>;
227
- 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, Context = unknown, UseKey extends true = true>(endpoint: {
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: {
228
293
  config: BaseEndpointConfig<Method, Url, QuerySchema, Response, RequestSchema>;
229
294
  }, mutationOptions: {
230
295
  processResponse: ProcessResponseFunction<Result, ReqResult>;
231
296
  useKey: UseKey;
232
297
  useContext?: () => Context;
233
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
234
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
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>;
235
308
  }): ((params: UrlHasParams<Url> extends true ? {
236
309
  urlParams: UrlParams<Url>;
237
- } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
238
- 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, Context = unknown, UseKey extends true = true>(endpoint: {
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: {
239
312
  config: BaseEndpointConfig<Method, Url, undefined, Response, RequestSchema>;
240
313
  }, mutationOptions: {
241
314
  processResponse: ProcessResponseFunction<Result, ReqResult>;
242
315
  useKey: UseKey;
243
316
  useContext?: () => Context;
244
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
245
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
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>;
246
327
  }): ((params: UrlHasParams<Url> extends true ? {
247
328
  urlParams: UrlParams<Url>;
248
- } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, undefined>;
249
- 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, Context = unknown>(endpoint: {
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: {
250
331
  config: BaseEndpointConfig<Method, Url, QuerySchema, Response, RequestSchema>;
251
332
  }, mutationOptions: {
252
333
  processResponse: ProcessResponseFunction<Result, ReqResult>;
253
334
  useContext?: () => Context;
254
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
255
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
256
- }): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>>) & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
257
- 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, Context = unknown>(endpoint: {
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: {
258
347
  config: BaseEndpointConfig<Method, Url, undefined, Response, RequestSchema>;
259
348
  }, mutationOptions: {
260
349
  processResponse: ProcessResponseFunction<Result, ReqResult>;
261
350
  useContext?: () => Context;
262
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
263
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
264
- }): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>>) & EndpointHelper<Method, Url, RequestSchema, Response, undefined>;
265
- mutationFromEndpoint<Method extends 'DELETE' = 'DELETE', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown, UseKey extends true = true>(endpoint: {
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: {
266
363
  config: BaseEndpointConfig<Method, Url, QuerySchema, Response>;
267
364
  }, mutationOptions: {
268
365
  processResponse: ProcessResponseFunction<Result, ReqResult>;
269
366
  useKey: UseKey;
270
367
  useContext?: () => Context;
271
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
272
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
273
- }): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
274
- mutationFromEndpoint<Method extends 'DELETE' = 'DELETE', Url extends string = string, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown, UseKey extends true = true>(endpoint: {
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: {
275
380
  config: BaseEndpointConfig<Method, Url, undefined, Response>;
276
381
  }, mutationOptions: {
277
382
  processResponse: ProcessResponseFunction<Result, ReqResult>;
278
383
  useKey: UseKey;
279
384
  useContext?: () => Context;
280
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
281
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
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>;
282
395
  }): ((params: UrlHasParams<Url> extends true ? {
283
396
  urlParams: UrlParams<Url>;
284
- } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response, undefined>;
285
- mutationFromEndpoint<Method extends 'DELETE' = 'DELETE', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown>(endpoint: {
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: {
286
399
  config: BaseEndpointConfig<Method, Url, QuerySchema, Response>;
287
400
  }, mutationOptions: {
288
401
  processResponse: ProcessResponseFunction<Result, ReqResult>;
289
402
  useContext?: () => Context;
290
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
291
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
292
- }): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>>) & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
293
- mutationFromEndpoint<Method extends 'DELETE' = 'DELETE', Url extends string = string, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown>(endpoint: {
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: {
294
415
  config: BaseEndpointConfig<Method, Url, undefined, Response>;
295
416
  }, mutationOptions: {
296
417
  processResponse: ProcessResponseFunction<Result, ReqResult>;
297
418
  useContext?: () => Context;
298
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
299
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
300
- }): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>>) & EndpointHelper<Method, Url, undefined, Response, undefined>;
301
- 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, Context = unknown, UseKey extends true = true>(config: {
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: {
302
431
  method: Method;
303
432
  url: Url;
304
433
  useKey: UseKey;
@@ -307,12 +436,20 @@ declare interface ClientInstance {
307
436
  responseSchema: Response;
308
437
  processResponse: ProcessResponseFunction<Result, ReqResult>;
309
438
  useContext?: () => Context;
310
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
311
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
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>;
312
449
  }): ((params: UrlHasParams<Url> extends true ? {
313
450
  urlParams: UrlParams<Url>;
314
- } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
315
- 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, Context = unknown>(config: {
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: {
316
453
  method: Method;
317
454
  url: Url;
318
455
  requestSchema: RequestSchema;
@@ -320,20 +457,36 @@ declare interface ClientInstance {
320
457
  responseSchema: Response;
321
458
  processResponse: ProcessResponseFunction<Result, ReqResult>;
322
459
  useContext?: () => Context;
323
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
324
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
325
- }): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
326
- 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, Context = unknown>(config: {
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: {
327
472
  method: Method;
328
473
  url: Url;
329
474
  requestSchema: RequestSchema;
330
475
  responseSchema: Response;
331
476
  processResponse: ProcessResponseFunction<Result, ReqResult>;
332
477
  useContext?: () => Context;
333
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
334
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
335
- }): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response>;
336
- 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, Context = unknown, UseKey extends true = true>(config: {
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: {
337
490
  method: Method;
338
491
  url: Url;
339
492
  useKey: UseKey;
@@ -341,87 +494,159 @@ declare interface ClientInstance {
341
494
  responseSchema: Response;
342
495
  processResponse: ProcessResponseFunction<Result, ReqResult>;
343
496
  useContext?: () => Context;
344
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
345
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
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>;
346
507
  }): ((params: UrlHasParams<Url> extends true ? {
347
508
  urlParams: UrlParams<Url>;
348
- } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response>;
349
- mutationFromEndpoint<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, QuerySchema extends ZodObject = ZodObject, Result = Blob, Context = unknown, UseKey extends true = true>(endpoint: {
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: {
350
511
  config: BaseStreamConfig<Method, Url, QuerySchema, RequestSchema>;
351
512
  }, mutationOptions: {
352
513
  processResponse?: ProcessResponseFunction<Result, Blob>;
353
514
  useKey: UseKey;
354
515
  useContext?: () => Context;
355
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
356
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
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>;
357
526
  }): ((params: UrlHasParams<Url> extends true ? {
358
527
  urlParams: UrlParams<Url>;
359
- } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>>) & MutationHelpers<Url, Result> & StreamHelper<Method, Url, RequestSchema, QuerySchema>;
360
- mutationFromEndpoint<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, QuerySchema extends ZodObject = ZodObject, Result = Blob, Context = unknown>(endpoint: {
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: {
361
530
  config: BaseStreamConfig<Method, Url, QuerySchema, RequestSchema>;
362
531
  }, mutationOptions?: {
363
532
  processResponse?: ProcessResponseFunction<Result, Blob>;
364
533
  useContext?: () => Context;
365
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
366
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
367
- }): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>>) & StreamHelper<Method, Url, RequestSchema, QuerySchema>;
368
- mutationFromEndpoint<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, Result = Blob, Context = unknown, UseKey extends true = true>(endpoint: {
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: {
369
546
  config: BaseStreamConfig<Method, Url, undefined, RequestSchema>;
370
547
  }, mutationOptions: {
371
548
  processResponse?: ProcessResponseFunction<Result, Blob>;
372
549
  useKey: UseKey;
373
550
  useContext?: () => Context;
374
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
375
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
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>;
376
561
  }): ((params: UrlHasParams<Url> extends true ? {
377
562
  urlParams: UrlParams<Url>;
378
- } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>>) & MutationHelpers<Url, Result> & StreamHelper<Method, Url, RequestSchema, undefined>;
379
- mutationFromEndpoint<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, Result = Blob, Context = unknown>(endpoint: {
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: {
380
565
  config: BaseStreamConfig<Method, Url, undefined, RequestSchema>;
381
566
  }, mutationOptions?: {
382
567
  processResponse?: ProcessResponseFunction<Result, Blob>;
383
568
  useContext?: () => Context;
384
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
385
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
386
- }): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>>) & StreamHelper<Method, Url, RequestSchema, undefined>;
387
- mutationFromEndpoint<Method extends 'GET' | 'DELETE' | 'OPTIONS' | 'HEAD' = 'GET', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Result = Blob, Context = unknown, UseKey extends true = true>(endpoint: {
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: {
388
581
  config: BaseStreamConfig<Method, Url, QuerySchema, undefined>;
389
582
  }, mutationOptions: {
390
583
  processResponse?: ProcessResponseFunction<Result, Blob>;
391
584
  useKey: UseKey;
392
585
  useContext?: () => Context;
393
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
394
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
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>;
395
596
  }): ((params: UrlHasParams<Url> extends true ? {
396
597
  urlParams: UrlParams<Url>;
397
- } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>>) & MutationHelpers<Url, Result> & StreamHelper<Method, Url, undefined, QuerySchema>;
398
- mutationFromEndpoint<Method extends 'GET' | 'DELETE' | 'OPTIONS' | 'HEAD' = 'GET', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Result = Blob, Context = unknown>(endpoint: {
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: {
399
600
  config: BaseStreamConfig<Method, Url, QuerySchema, undefined>;
400
601
  }, mutationOptions?: {
401
602
  processResponse?: ProcessResponseFunction<Result, Blob>;
402
603
  useContext?: () => Context;
403
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
404
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
405
- }): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>>) & StreamHelper<Method, Url, undefined, QuerySchema>;
406
- mutationFromEndpoint<Method extends 'GET' | 'DELETE' | 'OPTIONS' | 'HEAD' = 'GET', Url extends string = string, Result = Blob, Context = unknown, UseKey extends true = true>(endpoint: {
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: {
407
616
  config: BaseStreamConfig<Method, Url, undefined, undefined>;
408
617
  }, mutationOptions: {
409
618
  processResponse?: ProcessResponseFunction<Result, Blob>;
410
619
  useKey: UseKey;
411
620
  useContext?: () => Context;
412
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
413
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
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>;
414
631
  }): ((params: UrlHasParams<Url> extends true ? {
415
632
  urlParams: UrlParams<Url>;
416
- } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>>) & MutationHelpers<Url, Result> & StreamHelper<Method, Url, undefined, undefined>;
417
- mutationFromEndpoint<Method extends 'GET' | 'DELETE' | 'OPTIONS' | 'HEAD' = 'GET', Url extends string = string, Result = Blob, Context = unknown>(endpoint: {
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: {
418
635
  config: BaseStreamConfig<Method, Url, undefined, undefined>;
419
636
  }, mutationOptions?: {
420
637
  processResponse?: ProcessResponseFunction<Result, Blob>;
421
638
  useContext?: () => Context;
422
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
423
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
424
- }): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>>) & StreamHelper<Method, Url, undefined, undefined>;
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>;
425
650
  }
426
651
  export { ClientInstance }
427
652
  export { ClientInstance as ClientInstance_alias_1 }
@@ -615,8 +840,8 @@ export { makeInfiniteQueryOptions as makeInfiniteQueryOptions_alias_2 }
615
840
  * @param options - Mutation configuration including processResponse and callbacks
616
841
  * @returns A hook function that returns mutation result with attached helpers
617
842
  */
618
- declare function makeMutation<Config extends AnyEndpointConfig, TData = unknown, TVariables extends NaviosZodRequest<Config> = NaviosZodRequest<Config>, TResponse = z.output<Config['responseSchema']>, TContext = unknown, UseKey extends boolean = false>(endpoint: AbstractEndpoint<Config>, options: MutationParams<Config, TData, TVariables, TResponse, TContext, UseKey>): {
619
- (keyParams: UseKey extends true ? UrlHasParams<Config["url"]> extends true ? UrlParams<Config["url"]> : never : never): UseMutationResult<TData, Error, NaviosZodRequest<Config>>;
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>;
620
845
  useIsMutating(keyParams: UseKey extends true ? UrlHasParams<Config["url"]> extends true ? UrlParams<Config["url"]> : never : never): boolean;
621
846
  mutationKey: (params: UrlHasParams<Config["url"]> extends infer T ? T extends UrlHasParams<Config["url"]> ? T extends true ? {
622
847
  urlParams: UrlParams<Config["url"]>;
@@ -669,7 +894,7 @@ export { MutationArgs as MutationArgs_alias_2 }
669
894
  /**
670
895
  * Configuration for declaring a mutation endpoint.
671
896
  */
672
- 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, Context = unknown, UseKey extends boolean = false> {
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> {
673
898
  method: Method;
674
899
  url: Url;
675
900
  querySchema?: QuerySchema;
@@ -677,9 +902,18 @@ declare interface MutationConfig<Method extends 'POST' | 'PUT' | 'PATCH' | 'DELE
677
902
  requestSchema?: RequestSchema;
678
903
  processResponse: ProcessResponseFunction<Result, ReqResult>;
679
904
  useContext?: () => Context;
680
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: MutationArgs<Url, RequestSchema, QuerySchema>, context: Context) => void | Promise<void>;
681
- onError?: (queryClient: QueryClient, error: Error, variables: MutationArgs<Url, RequestSchema, QuerySchema>, context: Context) => void | Promise<void>;
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>;
682
915
  useKey?: UseKey;
916
+ meta?: Record<string, unknown>;
683
917
  }
684
918
  export { MutationConfig }
685
919
  export { MutationConfig as MutationConfig_alias_1 }
@@ -708,15 +942,23 @@ export { mutationKeyCreator as mutationKeyCreator_alias_2 }
708
942
  /**
709
943
  * Base parameters for mutation configuration.
710
944
  */
711
- declare interface MutationParams<Config extends AnyEndpointConfig, TData = unknown, TVariables = NaviosZodRequest<Config>, TResponse = z.output<Config['responseSchema']>, TContext = unknown, UseKey extends boolean = false> extends Omit<UseMutationOptions<TData, Error, TVariables>, 'mutationKey' | 'mutationFn' | 'onSuccess' | 'onError' | 'scope'> {
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'> {
712
946
  processResponse?: ProcessResponseFunction<TData, TResponse>;
713
947
  /**
714
948
  * React hooks that will prepare the context for the mutation onSuccess and onError
715
949
  * callbacks. This is useful for when you want to use the context in the callbacks
716
950
  */
717
951
  useContext?: () => TContext;
718
- onSuccess?: (queryClient: QueryClient, data: TData, variables: TVariables, context: TContext) => void | Promise<void>;
719
- onError?: (queryClient: QueryClient, err: unknown, variables: TVariables, context: TContext) => void | Promise<void>;
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>;
720
962
  /**
721
963
  * If true, we will create a mutation key that can be shared across the project.
722
964
  */