@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/dist/src/client/types.d.mts CHANGED
@@ -1,5 +1,5 @@
1
1
  import type { BaseEndpointConfig, BaseStreamConfig, EndpointFunctionArgs, HttpMethod, UrlHasParams, UrlParams, Util_FlatObject } from '@navios/builder';
2
- import type { DataTag, InfiniteData, QueryClient, UseMutationResult, UseSuspenseInfiniteQueryOptions, UseSuspenseQueryOptions } from '@tanstack/react-query';
2
+ import type { DataTag, InfiniteData, MutationFunctionContext, UseMutationResult, UseSuspenseInfiniteQueryOptions, UseSuspenseQueryOptions } from '@tanstack/react-query';
3
3
  import type { z, ZodObject, ZodType } from 'zod/v4';
4
4
  import type { ProcessResponseFunction, Split } from '../common/types.mjs';
5
5
  import type { MutationArgs, MutationHelpers } from '../mutation/types.mjs';
@@ -74,7 +74,7 @@ export interface ClientInstance {
74
74
  getNextPageParam: (lastPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema> | undefined;
75
75
  getPreviousPageParam?: (firstPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema>;
76
76
  }): ((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>;
77
- 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: {
77
+ 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: {
78
78
  method: Method;
79
79
  url: Url;
80
80
  useKey: UseKey;
@@ -83,12 +83,20 @@ export interface ClientInstance {
83
83
  responseSchema: Response;
84
84
  processResponse: ProcessResponseFunction<Result, ReqResult>;
85
85
  useContext?: () => Context;
86
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
87
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
86
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
87
+ onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
88
+ onMutateResult: OnMutateResult | undefined;
89
+ }) => void | Promise<void>;
90
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
91
+ onMutateResult: OnMutateResult | undefined;
92
+ }) => void | Promise<void>;
93
+ onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
94
+ onMutateResult: OnMutateResult | undefined;
95
+ }) => void | Promise<void>;
88
96
  }): ((params: UrlHasParams<Url> extends true ? {
89
97
  urlParams: UrlParams<Url>;
90
- } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
91
- 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: {
98
+ } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
99
+ 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: {
92
100
  method: Method;
93
101
  url: Url;
94
102
  requestSchema: RequestSchema;
@@ -96,20 +104,36 @@ export interface ClientInstance {
96
104
  responseSchema: Response;
97
105
  processResponse: ProcessResponseFunction<Result, ReqResult>;
98
106
  useContext?: () => Context;
99
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
100
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
101
- }): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
102
- 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: {
107
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
108
+ onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
109
+ onMutateResult: OnMutateResult | undefined;
110
+ }) => void | Promise<void>;
111
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
112
+ onMutateResult: OnMutateResult | undefined;
113
+ }) => void | Promise<void>;
114
+ onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
115
+ onMutateResult: OnMutateResult | undefined;
116
+ }) => void | Promise<void>;
117
+ }): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
118
+ 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: {
103
119
  method: Method;
104
120
  url: Url;
105
121
  requestSchema: RequestSchema;
106
122
  responseSchema: Response;
107
123
  processResponse: ProcessResponseFunction<Result, ReqResult>;
108
124
  useContext?: () => Context;
109
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
110
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
111
- }): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response>;
112
- 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: {
125
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
126
+ onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
127
+ onMutateResult: OnMutateResult | undefined;
128
+ }) => void | Promise<void>;
129
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
130
+ onMutateResult: OnMutateResult | undefined;
131
+ }) => void | Promise<void>;
132
+ onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
133
+ onMutateResult: OnMutateResult | undefined;
134
+ }) => void | Promise<void>;
135
+ }): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response>;
136
+ 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: {
113
137
  method: Method;
114
138
  url: Url;
115
139
  useKey: UseKey;
@@ -117,12 +141,20 @@ export interface ClientInstance {
117
141
  responseSchema: Response;
118
142
  processResponse: ProcessResponseFunction<Result, ReqResult>;
119
143
  useContext?: () => Context;
120
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
121
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
144
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
145
+ onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
146
+ onMutateResult: OnMutateResult | undefined;
147
+ }) => void | Promise<void>;
148
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
149
+ onMutateResult: OnMutateResult | undefined;
150
+ }) => void | Promise<void>;
151
+ onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
152
+ onMutateResult: OnMutateResult | undefined;
153
+ }) => void | Promise<void>;
122
154
  }): ((params: UrlHasParams<Url> extends true ? {
123
155
  urlParams: UrlParams<Url>;
124
- } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response>;
125
- 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: {
156
+ } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response>;
157
+ 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: {
126
158
  method: Method;
127
159
  url: Url;
128
160
  useKey: UseKey;
@@ -130,42 +162,74 @@ export interface ClientInstance {
130
162
  responseSchema: Response;
131
163
  processResponse: ProcessResponseFunction<Result, ReqResult>;
132
164
  useContext?: () => Context;
133
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
134
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
165
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
166
+ onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
167
+ onMutateResult: OnMutateResult | undefined;
168
+ }) => void | Promise<void>;
169
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
170
+ onMutateResult: OnMutateResult | undefined;
171
+ }) => void | Promise<void>;
172
+ onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
173
+ onMutateResult: OnMutateResult | undefined;
174
+ }) => void | Promise<void>;
135
175
  }): ((params: UrlHasParams<Url> extends true ? {
136
176
  urlParams: UrlParams<Url>;
137
- } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
138
- 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: {
177
+ } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
178
+ 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: {
139
179
  method: Method;
140
180
  url: Url;
141
181
  querySchema: QuerySchema;
142
182
  responseSchema: Response;
143
183
  processResponse: ProcessResponseFunction<Result, ReqResult>;
144
184
  useContext?: () => Context;
145
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
146
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
147
- }): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
148
- 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: {
185
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
186
+ onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
187
+ onMutateResult: OnMutateResult | undefined;
188
+ }) => void | Promise<void>;
189
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
190
+ onMutateResult: OnMutateResult | undefined;
191
+ }) => void | Promise<void>;
192
+ onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
193
+ onMutateResult: OnMutateResult | undefined;
194
+ }) => void | Promise<void>;
195
+ }): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
196
+ 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: {
149
197
  method: Method;
150
198
  url: Url;
151
199
  useKey: UseKey;
152
200
  responseSchema: Response;
153
201
  processResponse: ProcessResponseFunction<Result, ReqResult>;
154
202
  useContext?: () => Context;
155
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
156
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
203
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
204
+ onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
205
+ onMutateResult: OnMutateResult | undefined;
206
+ }) => void | Promise<void>;
207
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
208
+ onMutateResult: OnMutateResult | undefined;
209
+ }) => void | Promise<void>;
210
+ onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
211
+ onMutateResult: OnMutateResult | undefined;
212
+ }) => void | Promise<void>;
157
213
  }): ((params: UrlHasParams<Url> extends true ? {
158
214
  urlParams: UrlParams<Url>;
159
- } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response>;
160
- mutation<Method extends 'DELETE' = 'DELETE', Url extends string = string, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown>(config: {
215
+ } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response>;
216
+ mutation<Method extends 'DELETE' = 'DELETE', Url extends string = string, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown>(config: {
161
217
  method: Method;
162
218
  url: Url;
163
219
  responseSchema: Response;
164
220
  processResponse: ProcessResponseFunction<Result, ReqResult>;
165
221
  useContext?: () => Context;
166
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
167
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
168
- }): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response>;
222
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
223
+ onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
224
+ onMutateResult: OnMutateResult | undefined;
225
+ }) => void | Promise<void>;
226
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
227
+ onMutateResult: OnMutateResult | undefined;
228
+ }) => void | Promise<void>;
229
+ onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
230
+ onMutateResult: OnMutateResult | undefined;
231
+ }) => void | Promise<void>;
232
+ }): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response>;
169
233
  queryFromEndpoint<Method extends 'GET' | 'HEAD' | 'OPTIONS' = 'GET', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, Result = z.output<Response>>(endpoint: {
170
234
  config: BaseEndpointConfig<Method, Url, QuerySchema, Response>;
171
235
  }, options?: {
@@ -183,81 +247,145 @@ export interface ClientInstance {
183
247
  getNextPageParam: (lastPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema> | undefined;
184
248
  getPreviousPageParam?: (firstPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema>;
185
249
  }): ((params: Util_FlatObject<QueryArgs<Url, QuerySchema>>) => UseSuspenseInfiniteQueryOptions<PageResult, Error, Result, DataTag<Split<Url, '/'>, PageResult, Error>, z.output<QuerySchema>>) & QueryHelpers<Url, QuerySchema, PageResult, true>;
186
- 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: {
250
+ 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: {
187
251
  config: BaseEndpointConfig<Method, Url, QuerySchema, Response, RequestSchema>;
188
252
  }, mutationOptions: {
189
253
  processResponse: ProcessResponseFunction<Result, ReqResult>;
190
254
  useKey: UseKey;
191
255
  useContext?: () => Context;
192
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
193
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
256
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
257
+ onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
258
+ onMutateResult: OnMutateResult | undefined;
259
+ }) => void | Promise<void>;
260
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
261
+ onMutateResult: OnMutateResult | undefined;
262
+ }) => void | Promise<void>;
263
+ onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
264
+ onMutateResult: OnMutateResult | undefined;
265
+ }) => void | Promise<void>;
194
266
  }): ((params: UrlHasParams<Url> extends true ? {
195
267
  urlParams: UrlParams<Url>;
196
- } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
197
- 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: {
268
+ } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
269
+ 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: {
198
270
  config: BaseEndpointConfig<Method, Url, undefined, Response, RequestSchema>;
199
271
  }, mutationOptions: {
200
272
  processResponse: ProcessResponseFunction<Result, ReqResult>;
201
273
  useKey: UseKey;
202
274
  useContext?: () => Context;
203
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
204
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
275
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
276
+ onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
277
+ onMutateResult: OnMutateResult | undefined;
278
+ }) => void | Promise<void>;
279
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
280
+ onMutateResult: OnMutateResult | undefined;
281
+ }) => void | Promise<void>;
282
+ onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
283
+ onMutateResult: OnMutateResult | undefined;
284
+ }) => void | Promise<void>;
205
285
  }): ((params: UrlHasParams<Url> extends true ? {
206
286
  urlParams: UrlParams<Url>;
207
- } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, undefined>;
208
- 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: {
287
+ } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, undefined>;
288
+ 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: {
209
289
  config: BaseEndpointConfig<Method, Url, QuerySchema, Response, RequestSchema>;
210
290
  }, mutationOptions: {
211
291
  processResponse: ProcessResponseFunction<Result, ReqResult>;
212
292
  useContext?: () => Context;
213
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
214
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
215
- }): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>>) & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
216
- 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: {
293
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
294
+ onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
295
+ onMutateResult: OnMutateResult | undefined;
296
+ }) => void | Promise<void>;
297
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
298
+ onMutateResult: OnMutateResult | undefined;
299
+ }) => void | Promise<void>;
300
+ onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
301
+ onMutateResult: OnMutateResult | undefined;
302
+ }) => void | Promise<void>;
303
+ }): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>, OnMutateResult>) & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
304
+ 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: {
217
305
  config: BaseEndpointConfig<Method, Url, undefined, Response, RequestSchema>;
218
306
  }, mutationOptions: {
219
307
  processResponse: ProcessResponseFunction<Result, ReqResult>;
220
308
  useContext?: () => Context;
221
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
222
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
223
- }): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>>) & EndpointHelper<Method, Url, RequestSchema, Response, undefined>;
224
- 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: {
309
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
310
+ onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
311
+ onMutateResult: OnMutateResult | undefined;
312
+ }) => void | Promise<void>;
313
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
314
+ onMutateResult: OnMutateResult | undefined;
315
+ }) => void | Promise<void>;
316
+ onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
317
+ onMutateResult: OnMutateResult | undefined;
318
+ }) => void | Promise<void>;
319
+ }): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>, OnMutateResult>) & EndpointHelper<Method, Url, RequestSchema, Response, undefined>;
320
+ 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: {
225
321
  config: BaseEndpointConfig<Method, Url, QuerySchema, Response>;
226
322
  }, mutationOptions: {
227
323
  processResponse: ProcessResponseFunction<Result, ReqResult>;
228
324
  useKey: UseKey;
229
325
  useContext?: () => Context;
230
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
231
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
232
- }): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
233
- 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: {
326
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
327
+ onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
328
+ onMutateResult: OnMutateResult | undefined;
329
+ }) => void | Promise<void>;
330
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
331
+ onMutateResult: OnMutateResult | undefined;
332
+ }) => void | Promise<void>;
333
+ onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
334
+ onMutateResult: OnMutateResult | undefined;
335
+ }) => void | Promise<void>;
336
+ }): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
337
+ 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: {
234
338
  config: BaseEndpointConfig<Method, Url, undefined, Response>;
235
339
  }, mutationOptions: {
236
340
  processResponse: ProcessResponseFunction<Result, ReqResult>;
237
341
  useKey: UseKey;
238
342
  useContext?: () => Context;
239
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
240
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
343
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
344
+ onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
345
+ onMutateResult: OnMutateResult | undefined;
346
+ }) => void | Promise<void>;
347
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
348
+ onMutateResult: OnMutateResult | undefined;
349
+ }) => void | Promise<void>;
350
+ onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
351
+ onMutateResult: OnMutateResult | undefined;
352
+ }) => void | Promise<void>;
241
353
  }): ((params: UrlHasParams<Url> extends true ? {
242
354
  urlParams: UrlParams<Url>;
243
- } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response, undefined>;
244
- 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: {
355
+ } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response, undefined>;
356
+ 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: {
245
357
  config: BaseEndpointConfig<Method, Url, QuerySchema, Response>;
246
358
  }, mutationOptions: {
247
359
  processResponse: ProcessResponseFunction<Result, ReqResult>;
248
360
  useContext?: () => Context;
249
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
250
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
251
- }): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>>) & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
252
- mutationFromEndpoint<Method extends 'DELETE' = 'DELETE', Url extends string = string, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown>(endpoint: {
361
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
362
+ onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
363
+ onMutateResult: OnMutateResult | undefined;
364
+ }) => void | Promise<void>;
365
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
366
+ onMutateResult: OnMutateResult | undefined;
367
+ }) => void | Promise<void>;
368
+ onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
369
+ onMutateResult: OnMutateResult | undefined;
370
+ }) => void | Promise<void>;
371
+ }): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>, OnMutateResult>) & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
372
+ mutationFromEndpoint<Method extends 'DELETE' = 'DELETE', Url extends string = string, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, OnMutateResult = unknown, Context = unknown>(endpoint: {
253
373
  config: BaseEndpointConfig<Method, Url, undefined, Response>;
254
374
  }, mutationOptions: {
255
375
  processResponse: ProcessResponseFunction<Result, ReqResult>;
256
376
  useContext?: () => Context;
257
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
258
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
259
- }): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>>) & EndpointHelper<Method, Url, undefined, Response, undefined>;
260
- 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: {
377
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
378
+ onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
379
+ onMutateResult: OnMutateResult | undefined;
380
+ }) => void | Promise<void>;
381
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
382
+ onMutateResult: OnMutateResult | undefined;
383
+ }) => void | Promise<void>;
384
+ onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
385
+ onMutateResult: OnMutateResult | undefined;
386
+ }) => void | Promise<void>;
387
+ }): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>, OnMutateResult>) & EndpointHelper<Method, Url, undefined, Response, undefined>;
388
+ 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: {
261
389
  method: Method;
262
390
  url: Url;
263
391
  useKey: UseKey;
@@ -266,12 +394,20 @@ export interface ClientInstance {
266
394
  responseSchema: Response;
267
395
  processResponse: ProcessResponseFunction<Result, ReqResult>;
268
396
  useContext?: () => Context;
269
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
270
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
397
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
398
+ onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
399
+ onMutateResult: OnMutateResult | undefined;
400
+ }) => void | Promise<void>;
401
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
402
+ onMutateResult: OnMutateResult | undefined;
403
+ }) => void | Promise<void>;
404
+ onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
405
+ onMutateResult: OnMutateResult | undefined;
406
+ }) => void | Promise<void>;
271
407
  }): ((params: UrlHasParams<Url> extends true ? {
272
408
  urlParams: UrlParams<Url>;
273
- } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
274
- 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: {
409
+ } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
410
+ 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: {
275
411
  method: Method;
276
412
  url: Url;
277
413
  requestSchema: RequestSchema;
@@ -279,20 +415,36 @@ export interface ClientInstance {
279
415
  responseSchema: Response;
280
416
  processResponse: ProcessResponseFunction<Result, ReqResult>;
281
417
  useContext?: () => Context;
282
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
283
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
284
- }): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
285
- 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: {
418
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
419
+ onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
420
+ onMutateResult: OnMutateResult | undefined;
421
+ }) => void | Promise<void>;
422
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
423
+ onMutateResult: OnMutateResult | undefined;
424
+ }) => void | Promise<void>;
425
+ onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
426
+ onMutateResult: OnMutateResult | undefined;
427
+ }) => void | Promise<void>;
428
+ }): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
429
+ 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: {
286
430
  method: Method;
287
431
  url: Url;
288
432
  requestSchema: RequestSchema;
289
433
  responseSchema: Response;
290
434
  processResponse: ProcessResponseFunction<Result, ReqResult>;
291
435
  useContext?: () => Context;
292
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
293
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
294
- }): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response>;
295
- 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: {
436
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
437
+ onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
438
+ onMutateResult: OnMutateResult | undefined;
439
+ }) => void | Promise<void>;
440
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
441
+ onMutateResult: OnMutateResult | undefined;
442
+ }) => void | Promise<void>;
443
+ onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
444
+ onMutateResult: OnMutateResult | undefined;
445
+ }) => void | Promise<void>;
446
+ }): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response>;
447
+ 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: {
296
448
  method: Method;
297
449
  url: Url;
298
450
  useKey: UseKey;
@@ -300,86 +452,158 @@ export interface ClientInstance {
300
452
  responseSchema: Response;
301
453
  processResponse: ProcessResponseFunction<Result, ReqResult>;
302
454
  useContext?: () => Context;
303
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
304
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
455
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
456
+ onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
457
+ onMutateResult: OnMutateResult | undefined;
458
+ }) => void | Promise<void>;
459
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
460
+ onMutateResult: OnMutateResult | undefined;
461
+ }) => void | Promise<void>;
462
+ onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
463
+ onMutateResult: OnMutateResult | undefined;
464
+ }) => void | Promise<void>;
305
465
  }): ((params: UrlHasParams<Url> extends true ? {
306
466
  urlParams: UrlParams<Url>;
307
- } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response>;
308
- 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: {
467
+ } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>, OnMutateResult>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response>;
468
+ 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: {
309
469
  config: BaseStreamConfig<Method, Url, QuerySchema, RequestSchema>;
310
470
  }, mutationOptions: {
311
471
  processResponse?: ProcessResponseFunction<Result, Blob>;
312
472
  useKey: UseKey;
313
473
  useContext?: () => Context;
314
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
315
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
474
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
475
+ onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
476
+ onMutateResult: OnMutateResult | undefined;
477
+ }) => void | Promise<void>;
478
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
479
+ onMutateResult: OnMutateResult | undefined;
480
+ }) => void | Promise<void>;
481
+ onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
482
+ onMutateResult: OnMutateResult | undefined;
483
+ }) => void | Promise<void>;
316
484
  }): ((params: UrlHasParams<Url> extends true ? {
317
485
  urlParams: UrlParams<Url>;
318
- } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>>) & MutationHelpers<Url, Result> & StreamHelper<Method, Url, RequestSchema, QuerySchema>;
319
- 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: {
486
+ } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result> & StreamHelper<Method, Url, RequestSchema, QuerySchema>;
487
+ 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: {
320
488
  config: BaseStreamConfig<Method, Url, QuerySchema, RequestSchema>;
321
489
  }, mutationOptions?: {
322
490
  processResponse?: ProcessResponseFunction<Result, Blob>;
323
491
  useContext?: () => Context;
324
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
325
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
326
- }): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>>) & StreamHelper<Method, Url, RequestSchema, QuerySchema>;
327
- 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: {
492
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
493
+ onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
494
+ onMutateResult: OnMutateResult | undefined;
495
+ }) => void | Promise<void>;
496
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
497
+ onMutateResult: OnMutateResult | undefined;
498
+ }) => void | Promise<void>;
499
+ onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
500
+ onMutateResult: OnMutateResult | undefined;
501
+ }) => void | Promise<void>;
502
+ }): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>, OnMutateResult>) & StreamHelper<Method, Url, RequestSchema, QuerySchema>;
503
+ 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: {
328
504
  config: BaseStreamConfig<Method, Url, undefined, RequestSchema>;
329
505
  }, mutationOptions: {
330
506
  processResponse?: ProcessResponseFunction<Result, Blob>;
331
507
  useKey: UseKey;
332
508
  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>;
509
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
510
+ onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
511
+ onMutateResult: OnMutateResult | undefined;
512
+ }) => void | Promise<void>;
513
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
514
+ onMutateResult: OnMutateResult | undefined;
515
+ }) => void | Promise<void>;
516
+ onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
517
+ onMutateResult: OnMutateResult | undefined;
518
+ }) => void | Promise<void>;
335
519
  }): ((params: UrlHasParams<Url> extends true ? {
336
520
  urlParams: UrlParams<Url>;
337
- } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>>) & MutationHelpers<Url, Result> & StreamHelper<Method, Url, RequestSchema, undefined>;
338
- mutationFromEndpoint<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, Result = Blob, Context = unknown>(endpoint: {
521
+ } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>, OnMutateResult>) & MutationHelpers<Url, Result> & StreamHelper<Method, Url, RequestSchema, undefined>;
522
+ mutationFromEndpoint<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, Result = Blob, OnMutateResult = unknown, Context = unknown>(endpoint: {
339
523
  config: BaseStreamConfig<Method, Url, undefined, RequestSchema>;
340
524
  }, mutationOptions?: {
341
525
  processResponse?: ProcessResponseFunction<Result, Blob>;
342
526
  useContext?: () => Context;
343
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
344
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
345
- }): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>>) & StreamHelper<Method, Url, RequestSchema, undefined>;
346
- 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: {
527
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
528
+ onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
529
+ onMutateResult: OnMutateResult | undefined;
530
+ }) => void | Promise<void>;
531
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
532
+ onMutateResult: OnMutateResult | undefined;
533
+ }) => void | Promise<void>;
534
+ onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
535
+ onMutateResult: OnMutateResult | undefined;
536
+ }) => void | Promise<void>;
537
+ }): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>, OnMutateResult>) & StreamHelper<Method, Url, RequestSchema, undefined>;
538
+ 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: {
347
539
  config: BaseStreamConfig<Method, Url, QuerySchema, undefined>;
348
540
  }, mutationOptions: {
349
541
  processResponse?: ProcessResponseFunction<Result, Blob>;
350
542
  useKey: UseKey;
351
543
  useContext?: () => Context;
352
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
353
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
544
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
545
+ onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
546
+ onMutateResult: OnMutateResult | undefined;
547
+ }) => void | Promise<void>;
548
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
549
+ onMutateResult: OnMutateResult | undefined;
550
+ }) => void | Promise<void>;
551
+ onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
552
+ onMutateResult: OnMutateResult | undefined;
553
+ }) => void | Promise<void>;
354
554
  }): ((params: UrlHasParams<Url> extends true ? {
355
555
  urlParams: UrlParams<Url>;
356
- } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>>) & MutationHelpers<Url, Result> & StreamHelper<Method, Url, undefined, QuerySchema>;
357
- mutationFromEndpoint<Method extends 'GET' | 'DELETE' | 'OPTIONS' | 'HEAD' = 'GET', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Result = Blob, Context = unknown>(endpoint: {
556
+ } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result> & StreamHelper<Method, Url, undefined, QuerySchema>;
557
+ mutationFromEndpoint<Method extends 'GET' | 'DELETE' | 'OPTIONS' | 'HEAD' = 'GET', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Result = Blob, OnMutateResult = unknown, Context = unknown>(endpoint: {
358
558
  config: BaseStreamConfig<Method, Url, QuerySchema, undefined>;
359
559
  }, mutationOptions?: {
360
560
  processResponse?: ProcessResponseFunction<Result, Blob>;
361
561
  useContext?: () => Context;
362
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
363
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
364
- }): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>>) & StreamHelper<Method, Url, undefined, QuerySchema>;
365
- mutationFromEndpoint<Method extends 'GET' | 'DELETE' | 'OPTIONS' | 'HEAD' = 'GET', Url extends string = string, Result = Blob, Context = unknown, UseKey extends true = true>(endpoint: {
562
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
563
+ onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
564
+ onMutateResult: OnMutateResult | undefined;
565
+ }) => void | Promise<void>;
566
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
567
+ onMutateResult: OnMutateResult | undefined;
568
+ }) => void | Promise<void>;
569
+ onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
570
+ onMutateResult: OnMutateResult | undefined;
571
+ }) => void | Promise<void>;
572
+ }): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>, OnMutateResult>) & StreamHelper<Method, Url, undefined, QuerySchema>;
573
+ mutationFromEndpoint<Method extends 'GET' | 'DELETE' | 'OPTIONS' | 'HEAD' = 'GET', Url extends string = string, Result = Blob, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(endpoint: {
366
574
  config: BaseStreamConfig<Method, Url, undefined, undefined>;
367
575
  }, mutationOptions: {
368
576
  processResponse?: ProcessResponseFunction<Result, Blob>;
369
577
  useKey: UseKey;
370
578
  useContext?: () => Context;
371
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
372
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
579
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
580
+ onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
581
+ onMutateResult: OnMutateResult | undefined;
582
+ }) => void | Promise<void>;
583
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
584
+ onMutateResult: OnMutateResult | undefined;
585
+ }) => void | Promise<void>;
586
+ onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
587
+ onMutateResult: OnMutateResult | undefined;
588
+ }) => void | Promise<void>;
373
589
  }): ((params: UrlHasParams<Url> extends true ? {
374
590
  urlParams: UrlParams<Url>;
375
- } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>>) & MutationHelpers<Url, Result> & StreamHelper<Method, Url, undefined, undefined>;
376
- mutationFromEndpoint<Method extends 'GET' | 'DELETE' | 'OPTIONS' | 'HEAD' = 'GET', Url extends string = string, Result = Blob, Context = unknown>(endpoint: {
591
+ } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>, OnMutateResult>) & MutationHelpers<Url, Result> & StreamHelper<Method, Url, undefined, undefined>;
592
+ mutationFromEndpoint<Method extends 'GET' | 'DELETE' | 'OPTIONS' | 'HEAD' = 'GET', Url extends string = string, Result = Blob, OnMutateResult = unknown, Context = unknown>(endpoint: {
377
593
  config: BaseStreamConfig<Method, Url, undefined, undefined>;
378
594
  }, mutationOptions?: {
379
595
  processResponse?: ProcessResponseFunction<Result, Blob>;
380
596
  useContext?: () => Context;
381
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
382
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
383
- }): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>>) & StreamHelper<Method, Url, undefined, undefined>;
597
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
598
+ onSuccess?: (data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
599
+ onMutateResult: OnMutateResult | undefined;
600
+ }) => void | Promise<void>;
601
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
602
+ onMutateResult: OnMutateResult | undefined;
603
+ }) => void | Promise<void>;
604
+ onSettled?: (data: NoInfer<Result> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
605
+ onMutateResult: OnMutateResult | undefined;
606
+ }) => void | Promise<void>;
607
+ }): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>, OnMutateResult>) & StreamHelper<Method, Url, undefined, undefined>;
384
608
  }
385
609
  //# sourceMappingURL=types.d.mts.map