@navios/react-query 0.5.0 → 0.5.2

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 (26) hide show
  1. package/CHANGELOG.md +40 -0
  2. package/dist/src/client/__type-tests__/client-instance.spec-d.d.mts +2 -0
  3. package/dist/src/client/__type-tests__/client-instance.spec-d.d.mts.map +1 -0
  4. package/dist/src/client/declare-client.d.mts.map +1 -1
  5. package/dist/src/client/types.d.mts +111 -13
  6. package/dist/src/client/types.d.mts.map +1 -1
  7. package/dist/src/mutation/make-hook.d.mts +1 -1
  8. package/dist/src/mutation/make-hook.d.mts.map +1 -1
  9. package/dist/src/mutation/types.d.mts +1 -1
  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 +117 -14
  13. package/lib/_tsup-dts-rollup.d.ts +117 -14
  14. package/lib/index.d.mts +1 -0
  15. package/lib/index.d.ts +1 -0
  16. package/lib/index.js +7 -7
  17. package/lib/index.js.map +1 -1
  18. package/lib/index.mjs +7 -7
  19. package/lib/index.mjs.map +1 -1
  20. package/package.json +1 -1
  21. package/src/__tests__/make-mutation.spec.mts +67 -0
  22. package/src/client/__type-tests__/client-instance.spec-d.mts +852 -0
  23. package/src/client/declare-client.mts +12 -8
  24. package/src/client/types.mts +335 -22
  25. package/src/mutation/make-hook.mts +5 -2
  26. package/src/mutation/types.mts +1 -1
package/lib/_tsup-dts-rollup.d.mts CHANGED
@@ -1,6 +1,7 @@
1
1
  import type { AbstractEndpoint } from '@navios/builder';
2
2
  import type { AnyEndpointConfig } from '@navios/builder';
3
3
  import type { BaseEndpointConfig } from '@navios/builder';
4
+ import type { BaseStreamConfig } from '@navios/builder';
4
5
  import type { BuilderInstance } from '@navios/builder';
5
6
  import type { DataTag } from '@tanstack/react-query';
6
7
  import type { EndpointFunctionArgs } from '@navios/builder';
@@ -159,7 +160,9 @@ declare interface ClientInstance {
159
160
  useContext?: () => Context;
160
161
  onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
161
162
  onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
162
- }): ((params: UrlHasParams<Url> extends true ? UrlParams<Url> : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response>;
163
+ }): ((params: UrlHasParams<Url> extends true ? {
164
+ urlParams: UrlParams<Url>;
165
+ } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response>;
163
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: {
164
167
  method: Method;
165
168
  url: Url;
@@ -170,7 +173,9 @@ declare interface ClientInstance {
170
173
  useContext?: () => Context;
171
174
  onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
172
175
  onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
173
- }): ((params: UrlHasParams<Url> extends true ? UrlParams<Url> : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
176
+ }): ((params: UrlHasParams<Url> extends true ? {
177
+ urlParams: UrlParams<Url>;
178
+ } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
174
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: {
175
180
  method: Method;
176
181
  url: Url;
@@ -190,7 +195,9 @@ declare interface ClientInstance {
190
195
  useContext?: () => Context;
191
196
  onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
192
197
  onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
193
- }): ((params: UrlHasParams<Url> extends true ? UrlParams<Url> : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response>;
198
+ }): ((params: UrlHasParams<Url> extends true ? {
199
+ urlParams: UrlParams<Url>;
200
+ } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response>;
194
201
  mutation<Method extends 'DELETE' = 'DELETE', Url extends string = string, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown>(config: {
195
202
  method: Method;
196
203
  url: Url;
@@ -225,7 +232,9 @@ declare interface ClientInstance {
225
232
  useContext?: () => Context;
226
233
  onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
227
234
  onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
228
- }): ((params: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
235
+ }): ((params: UrlHasParams<Url> extends true ? {
236
+ urlParams: UrlParams<Url>;
237
+ } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
229
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: {
230
239
  config: BaseEndpointConfig<Method, Url, undefined, Response, RequestSchema>;
231
240
  }, mutationOptions: {
@@ -234,7 +243,9 @@ declare interface ClientInstance {
234
243
  useContext?: () => Context;
235
244
  onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
236
245
  onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
237
- }): ((params: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, undefined>;
246
+ }): ((params: UrlHasParams<Url> extends true ? {
247
+ urlParams: UrlParams<Url>;
248
+ } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, undefined>;
238
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: {
239
250
  config: BaseEndpointConfig<Method, Url, QuerySchema, Response, RequestSchema>;
240
251
  }, mutationOptions: {
@@ -242,7 +253,7 @@ declare interface ClientInstance {
242
253
  useContext?: () => Context;
243
254
  onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
244
255
  onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
245
- }): ((params: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>>) & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
256
+ }): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>>) & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
246
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: {
247
258
  config: BaseEndpointConfig<Method, Url, undefined, Response, RequestSchema>;
248
259
  }, mutationOptions: {
@@ -250,7 +261,7 @@ declare interface ClientInstance {
250
261
  useContext?: () => Context;
251
262
  onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
252
263
  onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
253
- }): ((params: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>>) & EndpointHelper<Method, Url, RequestSchema, Response, undefined>;
264
+ }): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>>) & EndpointHelper<Method, Url, RequestSchema, Response, undefined>;
254
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: {
255
266
  config: BaseEndpointConfig<Method, Url, QuerySchema, Response>;
256
267
  }, mutationOptions: {
@@ -259,7 +270,7 @@ declare interface ClientInstance {
259
270
  useContext?: () => Context;
260
271
  onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
261
272
  onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
262
- }): ((params: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
273
+ }): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
263
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: {
264
275
  config: BaseEndpointConfig<Method, Url, undefined, Response>;
265
276
  }, mutationOptions: {
@@ -268,7 +279,9 @@ declare interface ClientInstance {
268
279
  useContext?: () => Context;
269
280
  onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
270
281
  onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
271
- }): ((params: Util_FlatObject<MutationArgs<Url, undefined, undefined>>) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response, undefined>;
282
+ }): ((params: UrlHasParams<Url> extends true ? {
283
+ urlParams: UrlParams<Url>;
284
+ } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response, undefined>;
272
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: {
273
286
  config: BaseEndpointConfig<Method, Url, QuerySchema, Response>;
274
287
  }, mutationOptions: {
@@ -276,7 +289,7 @@ declare interface ClientInstance {
276
289
  useContext?: () => Context;
277
290
  onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
278
291
  onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
279
- }): ((params: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>>) & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
292
+ }): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>>) & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
280
293
  mutationFromEndpoint<Method extends 'DELETE' = 'DELETE', Url extends string = string, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown>(endpoint: {
281
294
  config: BaseEndpointConfig<Method, Url, undefined, Response>;
282
295
  }, mutationOptions: {
@@ -284,7 +297,7 @@ declare interface ClientInstance {
284
297
  useContext?: () => Context;
285
298
  onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
286
299
  onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
287
- }): ((params: Util_FlatObject<MutationArgs<Url, undefined, undefined>>) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>>) & EndpointHelper<Method, Url, undefined, Response, undefined>;
300
+ }): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>>) & EndpointHelper<Method, Url, undefined, Response, undefined>;
288
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: {
289
302
  method: Method;
290
303
  url: Url;
@@ -330,7 +343,85 @@ declare interface ClientInstance {
330
343
  useContext?: () => Context;
331
344
  onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
332
345
  onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
333
- }): ((params: UrlHasParams<Url> extends true ? UrlParams<Url> : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response>;
346
+ }): ((params: UrlHasParams<Url> extends true ? {
347
+ 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: {
350
+ config: BaseStreamConfig<Method, Url, QuerySchema, RequestSchema>;
351
+ }, mutationOptions: {
352
+ processResponse?: ProcessResponseFunction<Result, Blob>;
353
+ useKey: UseKey;
354
+ 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>;
357
+ }): ((params: UrlHasParams<Url> extends true ? {
358
+ 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: {
361
+ config: BaseStreamConfig<Method, Url, QuerySchema, RequestSchema>;
362
+ }, mutationOptions?: {
363
+ processResponse?: ProcessResponseFunction<Result, Blob>;
364
+ 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: {
369
+ config: BaseStreamConfig<Method, Url, undefined, RequestSchema>;
370
+ }, mutationOptions: {
371
+ processResponse?: ProcessResponseFunction<Result, Blob>;
372
+ useKey: UseKey;
373
+ 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>;
376
+ }): ((params: UrlHasParams<Url> extends true ? {
377
+ 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: {
380
+ config: BaseStreamConfig<Method, Url, undefined, RequestSchema>;
381
+ }, mutationOptions?: {
382
+ processResponse?: ProcessResponseFunction<Result, Blob>;
383
+ 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: {
388
+ config: BaseStreamConfig<Method, Url, QuerySchema, undefined>;
389
+ }, mutationOptions: {
390
+ processResponse?: ProcessResponseFunction<Result, Blob>;
391
+ useKey: UseKey;
392
+ 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>;
395
+ }): ((params: UrlHasParams<Url> extends true ? {
396
+ 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: {
399
+ config: BaseStreamConfig<Method, Url, QuerySchema, undefined>;
400
+ }, mutationOptions?: {
401
+ processResponse?: ProcessResponseFunction<Result, Blob>;
402
+ 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: {
407
+ config: BaseStreamConfig<Method, Url, undefined, undefined>;
408
+ }, mutationOptions: {
409
+ processResponse?: ProcessResponseFunction<Result, Blob>;
410
+ useKey: UseKey;
411
+ 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>;
414
+ }): ((params: UrlHasParams<Url> extends true ? {
415
+ 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: {
418
+ config: BaseStreamConfig<Method, Url, undefined, undefined>;
419
+ }, mutationOptions?: {
420
+ processResponse?: ProcessResponseFunction<Result, Blob>;
421
+ 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>;
334
425
  }
335
426
  export { ClientInstance }
336
427
  export { ClientInstance as ClientInstance_alias_1 }
@@ -529,7 +620,7 @@ declare function makeMutation<Config extends AnyEndpointConfig, TData = unknown,
529
620
  useIsMutating(keyParams: UseKey extends true ? UrlHasParams<Config["url"]> extends true ? UrlParams<Config["url"]> : never : never): boolean;
530
621
  mutationKey: (params: UrlHasParams<Config["url"]> extends infer T ? T extends UrlHasParams<Config["url"]> ? T extends true ? {
531
622
  urlParams: UrlParams<Config["url"]>;
532
- } : {} : never : never) => ProcessResponseFunction_2<TData, TResponse> extends (...args: unknown[]) => infer Result ? [Config["url"]] & {
623
+ } : {} : never : never) => ProcessResponseFunction_2<TData, TResponse> | ((data: z.core.output<Config["responseSchema"]>) => z.core.output<Config["responseSchema"]>) extends (...args: unknown[]) => infer Result ? [Config["url"]] & {
533
624
  [dataTagSymbol]: Result;
534
625
  [dataTagErrorSymbol]: Error;
535
626
  } : never;
@@ -618,7 +709,7 @@ export { mutationKeyCreator as mutationKeyCreator_alias_2 }
618
709
  * Base parameters for mutation configuration.
619
710
  */
620
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'> {
621
- processResponse: ProcessResponseFunction<TData, TResponse>;
712
+ processResponse?: ProcessResponseFunction<TData, TResponse>;
622
713
  /**
623
714
  * React hooks that will prepare the context for the mutation onSuccess and onError
624
715
  * callbacks. This is useful for when you want to use the context in the callbacks
@@ -749,4 +840,16 @@ export { Split }
749
840
  export { Split as Split_alias_1 }
750
841
  export { Split as Split_alias_2 }
751
842
 
843
+ /**
844
+ * Helper type that attaches a stream endpoint to mutation results.
845
+ */
846
+ declare type StreamHelper<Method extends HttpMethod = HttpMethod, Url extends string = string, RequestSchema = unknown, QuerySchema = unknown> = {
847
+ endpoint: ((params: Util_FlatObject<EndpointFunctionArgs<Url, QuerySchema, RequestSchema>>) => Promise<Blob>) & {
848
+ config: BaseStreamConfig<Method, Url, QuerySchema, RequestSchema>;
849
+ };
850
+ };
851
+ export { StreamHelper }
852
+ export { StreamHelper as StreamHelper_alias_1 }
853
+ export { StreamHelper as StreamHelper_alias_2 }
854
+
752
855
  export { }
package/lib/_tsup-dts-rollup.d.ts CHANGED
@@ -1,6 +1,7 @@
1
1
  import type { AbstractEndpoint } from '@navios/builder';
2
2
  import type { AnyEndpointConfig } from '@navios/builder';
3
3
  import type { BaseEndpointConfig } from '@navios/builder';
4
+ import type { BaseStreamConfig } from '@navios/builder';
4
5
  import type { BuilderInstance } from '@navios/builder';
5
6
  import type { DataTag } from '@tanstack/react-query';
6
7
  import type { EndpointFunctionArgs } from '@navios/builder';
@@ -159,7 +160,9 @@ declare interface ClientInstance {
159
160
  useContext?: () => Context;
160
161
  onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
161
162
  onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
162
- }): ((params: UrlHasParams<Url> extends true ? UrlParams<Url> : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response>;
163
+ }): ((params: UrlHasParams<Url> extends true ? {
164
+ urlParams: UrlParams<Url>;
165
+ } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response>;
163
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: {
164
167
  method: Method;
165
168
  url: Url;
@@ -170,7 +173,9 @@ declare interface ClientInstance {
170
173
  useContext?: () => Context;
171
174
  onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
172
175
  onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
173
- }): ((params: UrlHasParams<Url> extends true ? UrlParams<Url> : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
176
+ }): ((params: UrlHasParams<Url> extends true ? {
177
+ urlParams: UrlParams<Url>;
178
+ } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
174
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: {
175
180
  method: Method;
176
181
  url: Url;
@@ -190,7 +195,9 @@ declare interface ClientInstance {
190
195
  useContext?: () => Context;
191
196
  onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
192
197
  onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
193
- }): ((params: UrlHasParams<Url> extends true ? UrlParams<Url> : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response>;
198
+ }): ((params: UrlHasParams<Url> extends true ? {
199
+ urlParams: UrlParams<Url>;
200
+ } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response>;
194
201
  mutation<Method extends 'DELETE' = 'DELETE', Url extends string = string, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown>(config: {
195
202
  method: Method;
196
203
  url: Url;
@@ -225,7 +232,9 @@ declare interface ClientInstance {
225
232
  useContext?: () => Context;
226
233
  onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
227
234
  onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
228
- }): ((params: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
235
+ }): ((params: UrlHasParams<Url> extends true ? {
236
+ urlParams: UrlParams<Url>;
237
+ } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
229
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: {
230
239
  config: BaseEndpointConfig<Method, Url, undefined, Response, RequestSchema>;
231
240
  }, mutationOptions: {
@@ -234,7 +243,9 @@ declare interface ClientInstance {
234
243
  useContext?: () => Context;
235
244
  onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
236
245
  onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
237
- }): ((params: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, undefined>;
246
+ }): ((params: UrlHasParams<Url> extends true ? {
247
+ urlParams: UrlParams<Url>;
248
+ } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, undefined>;
238
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: {
239
250
  config: BaseEndpointConfig<Method, Url, QuerySchema, Response, RequestSchema>;
240
251
  }, mutationOptions: {
@@ -242,7 +253,7 @@ declare interface ClientInstance {
242
253
  useContext?: () => Context;
243
254
  onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
244
255
  onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
245
- }): ((params: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>>) & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
256
+ }): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>>) & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
246
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: {
247
258
  config: BaseEndpointConfig<Method, Url, undefined, Response, RequestSchema>;
248
259
  }, mutationOptions: {
@@ -250,7 +261,7 @@ declare interface ClientInstance {
250
261
  useContext?: () => Context;
251
262
  onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
252
263
  onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
253
- }): ((params: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>>) & EndpointHelper<Method, Url, RequestSchema, Response, undefined>;
264
+ }): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>>) & EndpointHelper<Method, Url, RequestSchema, Response, undefined>;
254
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: {
255
266
  config: BaseEndpointConfig<Method, Url, QuerySchema, Response>;
256
267
  }, mutationOptions: {
@@ -259,7 +270,7 @@ declare interface ClientInstance {
259
270
  useContext?: () => Context;
260
271
  onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
261
272
  onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
262
- }): ((params: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
273
+ }): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
263
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: {
264
275
  config: BaseEndpointConfig<Method, Url, undefined, Response>;
265
276
  }, mutationOptions: {
@@ -268,7 +279,9 @@ declare interface ClientInstance {
268
279
  useContext?: () => Context;
269
280
  onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
270
281
  onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
271
- }): ((params: Util_FlatObject<MutationArgs<Url, undefined, undefined>>) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response, undefined>;
282
+ }): ((params: UrlHasParams<Url> extends true ? {
283
+ urlParams: UrlParams<Url>;
284
+ } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response, undefined>;
272
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: {
273
286
  config: BaseEndpointConfig<Method, Url, QuerySchema, Response>;
274
287
  }, mutationOptions: {
@@ -276,7 +289,7 @@ declare interface ClientInstance {
276
289
  useContext?: () => Context;
277
290
  onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
278
291
  onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
279
- }): ((params: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>>) & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
292
+ }): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>>) & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
280
293
  mutationFromEndpoint<Method extends 'DELETE' = 'DELETE', Url extends string = string, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown>(endpoint: {
281
294
  config: BaseEndpointConfig<Method, Url, undefined, Response>;
282
295
  }, mutationOptions: {
@@ -284,7 +297,7 @@ declare interface ClientInstance {
284
297
  useContext?: () => Context;
285
298
  onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
286
299
  onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
287
- }): ((params: Util_FlatObject<MutationArgs<Url, undefined, undefined>>) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>>) & EndpointHelper<Method, Url, undefined, Response, undefined>;
300
+ }): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>>) & EndpointHelper<Method, Url, undefined, Response, undefined>;
288
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: {
289
302
  method: Method;
290
303
  url: Url;
@@ -330,7 +343,85 @@ declare interface ClientInstance {
330
343
  useContext?: () => Context;
331
344
  onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
332
345
  onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
333
- }): ((params: UrlHasParams<Url> extends true ? UrlParams<Url> : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response>;
346
+ }): ((params: UrlHasParams<Url> extends true ? {
347
+ 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: {
350
+ config: BaseStreamConfig<Method, Url, QuerySchema, RequestSchema>;
351
+ }, mutationOptions: {
352
+ processResponse?: ProcessResponseFunction<Result, Blob>;
353
+ useKey: UseKey;
354
+ 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>;
357
+ }): ((params: UrlHasParams<Url> extends true ? {
358
+ 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: {
361
+ config: BaseStreamConfig<Method, Url, QuerySchema, RequestSchema>;
362
+ }, mutationOptions?: {
363
+ processResponse?: ProcessResponseFunction<Result, Blob>;
364
+ 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: {
369
+ config: BaseStreamConfig<Method, Url, undefined, RequestSchema>;
370
+ }, mutationOptions: {
371
+ processResponse?: ProcessResponseFunction<Result, Blob>;
372
+ useKey: UseKey;
373
+ 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>;
376
+ }): ((params: UrlHasParams<Url> extends true ? {
377
+ 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: {
380
+ config: BaseStreamConfig<Method, Url, undefined, RequestSchema>;
381
+ }, mutationOptions?: {
382
+ processResponse?: ProcessResponseFunction<Result, Blob>;
383
+ 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: {
388
+ config: BaseStreamConfig<Method, Url, QuerySchema, undefined>;
389
+ }, mutationOptions: {
390
+ processResponse?: ProcessResponseFunction<Result, Blob>;
391
+ useKey: UseKey;
392
+ 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>;
395
+ }): ((params: UrlHasParams<Url> extends true ? {
396
+ 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: {
399
+ config: BaseStreamConfig<Method, Url, QuerySchema, undefined>;
400
+ }, mutationOptions?: {
401
+ processResponse?: ProcessResponseFunction<Result, Blob>;
402
+ 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: {
407
+ config: BaseStreamConfig<Method, Url, undefined, undefined>;
408
+ }, mutationOptions: {
409
+ processResponse?: ProcessResponseFunction<Result, Blob>;
410
+ useKey: UseKey;
411
+ 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>;
414
+ }): ((params: UrlHasParams<Url> extends true ? {
415
+ 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: {
418
+ config: BaseStreamConfig<Method, Url, undefined, undefined>;
419
+ }, mutationOptions?: {
420
+ processResponse?: ProcessResponseFunction<Result, Blob>;
421
+ 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>;
334
425
  }
335
426
  export { ClientInstance }
336
427
  export { ClientInstance as ClientInstance_alias_1 }
@@ -529,7 +620,7 @@ declare function makeMutation<Config extends AnyEndpointConfig, TData = unknown,
529
620
  useIsMutating(keyParams: UseKey extends true ? UrlHasParams<Config["url"]> extends true ? UrlParams<Config["url"]> : never : never): boolean;
530
621
  mutationKey: (params: UrlHasParams<Config["url"]> extends infer T ? T extends UrlHasParams<Config["url"]> ? T extends true ? {
531
622
  urlParams: UrlParams<Config["url"]>;
532
- } : {} : never : never) => ProcessResponseFunction_2<TData, TResponse> extends (...args: unknown[]) => infer Result ? [Config["url"]] & {
623
+ } : {} : never : never) => ProcessResponseFunction_2<TData, TResponse> | ((data: z.core.output<Config["responseSchema"]>) => z.core.output<Config["responseSchema"]>) extends (...args: unknown[]) => infer Result ? [Config["url"]] & {
533
624
  [dataTagSymbol]: Result;
534
625
  [dataTagErrorSymbol]: Error;
535
626
  } : never;
@@ -618,7 +709,7 @@ export { mutationKeyCreator as mutationKeyCreator_alias_2 }
618
709
  * Base parameters for mutation configuration.
619
710
  */
620
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'> {
621
- processResponse: ProcessResponseFunction<TData, TResponse>;
712
+ processResponse?: ProcessResponseFunction<TData, TResponse>;
622
713
  /**
623
714
  * React hooks that will prepare the context for the mutation onSuccess and onError
624
715
  * callbacks. This is useful for when you want to use the context in the callbacks
@@ -749,4 +840,16 @@ export { Split }
749
840
  export { Split as Split_alias_1 }
750
841
  export { Split as Split_alias_2 }
751
842
 
843
+ /**
844
+ * Helper type that attaches a stream endpoint to mutation results.
845
+ */
846
+ declare type StreamHelper<Method extends HttpMethod = HttpMethod, Url extends string = string, RequestSchema = unknown, QuerySchema = unknown> = {
847
+ endpoint: ((params: Util_FlatObject<EndpointFunctionArgs<Url, QuerySchema, RequestSchema>>) => Promise<Blob>) & {
848
+ config: BaseStreamConfig<Method, Url, QuerySchema, RequestSchema>;
849
+ };
850
+ };
851
+ export { StreamHelper }
852
+ export { StreamHelper as StreamHelper_alias_1 }
853
+ export { StreamHelper as StreamHelper_alias_2 }
854
+
752
855
  export { }
package/lib/index.d.mts CHANGED
@@ -26,6 +26,7 @@ export { BaseMutationParams } from './_tsup-dts-rollup.mjs';
26
26
  export { BaseMutationArgs } from './_tsup-dts-rollup.mjs';
27
27
  export { EndpointHelper } from './_tsup-dts-rollup.mjs';
28
28
  export { ClientEndpointHelper } from './_tsup-dts-rollup.mjs';
29
+ export { StreamHelper } from './_tsup-dts-rollup.mjs';
29
30
  export { ClientInstance } from './_tsup-dts-rollup.mjs';
30
31
  export { declareClient } from './_tsup-dts-rollup.mjs';
31
32
  export { QueryConfig } from './_tsup-dts-rollup.mjs';
package/lib/index.d.ts CHANGED
@@ -26,6 +26,7 @@ export { BaseMutationParams } from './_tsup-dts-rollup.js';
26
26
  export { BaseMutationArgs } from './_tsup-dts-rollup.js';
27
27
  export { EndpointHelper } from './_tsup-dts-rollup.js';
28
28
  export { ClientEndpointHelper } from './_tsup-dts-rollup.js';
29
+ export { StreamHelper } from './_tsup-dts-rollup.js';
29
30
  export { ClientInstance } from './_tsup-dts-rollup.js';
30
31
  export { declareClient } from './_tsup-dts-rollup.js';
31
32
  export { QueryConfig } from './_tsup-dts-rollup.js';
package/lib/index.js CHANGED
@@ -154,7 +154,8 @@ function createMutationKey(config, options = {
154
154
  var mutationKeyCreator = createMutationKey;
155
155
  function makeMutation(endpoint, options) {
156
156
  const config = endpoint.config;
157
- const mutationKey = createMutationKey(config, options);
157
+ const mutationKey = createMutationKey(config, {
158
+ ...options});
158
159
  const result = (keyParams) => {
159
160
  const queryClient = reactQuery.useQueryClient();
160
161
  const {
@@ -183,7 +184,7 @@ function makeMutation(endpoint, options) {
183
184
  } : void 0,
184
185
  async mutationFn(params) {
185
186
  const response = await endpoint(params);
186
- return processResponse(response);
187
+ return processResponse ? processResponse(response) : response;
187
188
  },
188
189
  onSuccess: onSuccess ? (data, variables) => {
189
190
  return onSuccess?.(queryClient, data, variables, context);
@@ -291,11 +292,10 @@ function declareClient({
291
292
  }
292
293
  function mutationFromEndpoint(endpoint, options) {
293
294
  return makeMutation(endpoint, {
294
- processResponse: options.processResponse,
295
- useContext: options.useContext,
296
- onSuccess: options.onSuccess,
297
- // @ts-expect-error simplify types here
298
- onError: options.onError,
295
+ processResponse: options?.processResponse,
296
+ useContext: options?.useContext,
297
+ onSuccess: options?.onSuccess,
298
+ onError: options?.onError,
299
299
  ...defaults
300
300
  });
301
301
  }