@navios/react-query 0.5.1 → 0.6.0

package/lib/_tsup-dts-rollup.d.mts

@@ -1,11 +1,13 @@
 import type { AbstractEndpoint } from '@navios/builder';
 import type { AnyEndpointConfig } from '@navios/builder';
 import type { BaseEndpointConfig } from '@navios/builder';
+import type { BaseStreamConfig } from '@navios/builder';
 import type { BuilderInstance } from '@navios/builder';
 import type { DataTag } from '@tanstack/react-query';
 import type { EndpointFunctionArgs } from '@navios/builder';
 import type { HttpMethod } from '@navios/builder';
 import type { InfiniteData } from '@tanstack/react-query';
+import type { MutationFunctionContext } from '@tanstack/react-query';
 import type { NaviosZodRequest } from '@navios/builder';
 import { NoInfer as NoInfer_2 } from '@tanstack/react-query';
 import { ProcessResponseFunction as ProcessResponseFunction_2 } from '../index.mjs';
@@ -345,6 +347,82 @@ declare interface ClientInstance {
     }): ((params: UrlHasParams<Url> extends true ? {
         urlParams: UrlParams<Url>;
     } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response>;
+    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: {
+        config: BaseStreamConfig<Method, Url, QuerySchema, RequestSchema>;
+    }, mutationOptions: {
+        processResponse?: ProcessResponseFunction<Result, Blob>;
+        useKey: UseKey;
+        useContext?: () => Context;
+        onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
+        onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
+    }): ((params: UrlHasParams<Url> extends true ? {
+        urlParams: UrlParams<Url>;
+    } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>>) & MutationHelpers<Url, Result> & StreamHelper<Method, Url, RequestSchema, QuerySchema>;
+    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: {
+        config: BaseStreamConfig<Method, Url, QuerySchema, RequestSchema>;
+    }, mutationOptions?: {
+        processResponse?: ProcessResponseFunction<Result, Blob>;
+        useContext?: () => Context;
+        onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
+        onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
+    }): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>>) & StreamHelper<Method, Url, RequestSchema, QuerySchema>;
+    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: {
+        config: BaseStreamConfig<Method, Url, undefined, RequestSchema>;
+    }, mutationOptions: {
+        processResponse?: ProcessResponseFunction<Result, Blob>;
+        useKey: UseKey;
+        useContext?: () => Context;
+        onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
+        onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
+    }): ((params: UrlHasParams<Url> extends true ? {
+        urlParams: UrlParams<Url>;
+    } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>>) & MutationHelpers<Url, Result> & StreamHelper<Method, Url, RequestSchema, undefined>;
+    mutationFromEndpoint<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, Result = Blob, Context = unknown>(endpoint: {
+        config: BaseStreamConfig<Method, Url, undefined, RequestSchema>;
+    }, mutationOptions?: {
+        processResponse?: ProcessResponseFunction<Result, Blob>;
+        useContext?: () => Context;
+        onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
+        onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
+    }): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>>) & StreamHelper<Method, Url, RequestSchema, undefined>;
+    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: {
+        config: BaseStreamConfig<Method, Url, QuerySchema, undefined>;
+    }, mutationOptions: {
+        processResponse?: ProcessResponseFunction<Result, Blob>;
+        useKey: UseKey;
+        useContext?: () => Context;
+        onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
+        onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
+    }): ((params: UrlHasParams<Url> extends true ? {
+        urlParams: UrlParams<Url>;
+    } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>>) & MutationHelpers<Url, Result> & StreamHelper<Method, Url, undefined, QuerySchema>;
+    mutationFromEndpoint<Method extends 'GET' | 'DELETE' | 'OPTIONS' | 'HEAD' = 'GET', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Result = Blob, Context = unknown>(endpoint: {
+        config: BaseStreamConfig<Method, Url, QuerySchema, undefined>;
+    }, mutationOptions?: {
+        processResponse?: ProcessResponseFunction<Result, Blob>;
+        useContext?: () => Context;
+        onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
+        onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
+    }): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>>) & StreamHelper<Method, Url, undefined, QuerySchema>;
+    mutationFromEndpoint<Method extends 'GET' | 'DELETE' | 'OPTIONS' | 'HEAD' = 'GET', Url extends string = string, Result = Blob, Context = unknown, UseKey extends true = true>(endpoint: {
+        config: BaseStreamConfig<Method, Url, undefined, undefined>;
+    }, mutationOptions: {
+        processResponse?: ProcessResponseFunction<Result, Blob>;
+        useKey: UseKey;
+        useContext?: () => Context;
+        onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
+        onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
+    }): ((params: UrlHasParams<Url> extends true ? {
+        urlParams: UrlParams<Url>;
+    } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>>) & MutationHelpers<Url, Result> & StreamHelper<Method, Url, undefined, undefined>;
+    mutationFromEndpoint<Method extends 'GET' | 'DELETE' | 'OPTIONS' | 'HEAD' = 'GET', Url extends string = string, Result = Blob, Context = unknown>(endpoint: {
+        config: BaseStreamConfig<Method, Url, undefined, undefined>;
+    }, mutationOptions?: {
+        processResponse?: ProcessResponseFunction<Result, Blob>;
+        useContext?: () => Context;
+        onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
+        onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
+    }): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>>) & StreamHelper<Method, Url, undefined, undefined>;
 }
 export { ClientInstance }
 export { ClientInstance as ClientInstance_alias_1 }
@@ -538,12 +616,12 @@ export { makeInfiniteQueryOptions as makeInfiniteQueryOptions_alias_2 }
  * @param options - Mutation configuration including processResponse and callbacks
  * @returns A hook function that returns mutation result with attached helpers
  */
-declare function makeMutation<Config extends AnyEndpointConfig, TData = unknown, TVariables extends NaviosZodRequest<Config> = NaviosZodRequest<Config>, TResponse = z.output<Config['responseSchema']>, TContext = unknown, UseKey extends boolean = false>(endpoint: AbstractEndpoint<Config>, options: MutationParams<Config, TData, TVariables, TResponse, TContext, UseKey>): {
-    (keyParams: UseKey extends true ? UrlHasParams<Config["url"]> extends true ? UrlParams<Config["url"]> : never : never): UseMutationResult<TData, Error, NaviosZodRequest<Config>>;
+declare function makeMutation<Config extends AnyEndpointConfig, TData = unknown, TVariables extends NaviosZodRequest<Config> = NaviosZodRequest<Config>, TResponse = z.output<Config['responseSchema']>, TOnMutateResult = unknown, TContext = unknown, UseKey extends boolean = false>(endpoint: AbstractEndpoint<Config>, options: MutationParams<Config, TData, TVariables, TResponse, TOnMutateResult, TContext, UseKey>): {
+    (keyParams: UseKey extends true ? UrlHasParams<Config["url"]> extends true ? UrlParams<Config["url"]> : never : never): UseMutationResult<TData, Error, NaviosZodRequest<Config>, TOnMutateResult>;
     useIsMutating(keyParams: UseKey extends true ? UrlHasParams<Config["url"]> extends true ? UrlParams<Config["url"]> : never : never): boolean;
     mutationKey: (params: UrlHasParams<Config["url"]> extends infer T ? T extends UrlHasParams<Config["url"]> ? T extends true ? {
         urlParams: UrlParams<Config["url"]>;
-    } : {} : never : never) => ProcessResponseFunction_2<TData, TResponse> extends (...args: unknown[]) => infer Result ? [Config["url"]] & {
+    } : {} : never : never) => ProcessResponseFunction_2<TData, TResponse> | ((data: z.core.output<Config["responseSchema"]>) => z.core.output<Config["responseSchema"]>) extends (...args: unknown[]) => infer Result ? [Config["url"]] & {
         [dataTagSymbol]: Result;
         [dataTagErrorSymbol]: Error;
     } : never;
@@ -592,7 +670,7 @@ export { MutationArgs as MutationArgs_alias_2 }
 /**
  * Configuration for declaring a mutation endpoint.
  */
-declare interface MutationConfig<Method extends 'POST' | 'PUT' | 'PATCH' | 'DELETE' = 'POST' | 'PUT' | 'PATCH' | 'DELETE', Url extends string = string, RequestSchema = Method extends 'DELETE' ? never : ZodObject, QuerySchema = unknown, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown, UseKey extends boolean = false> {
+declare interface MutationConfig<Method extends 'POST' | 'PUT' | 'PATCH' | 'DELETE' = 'POST' | 'PUT' | 'PATCH' | 'DELETE', Url extends string = string, RequestSchema = Method extends 'DELETE' ? never : ZodObject, QuerySchema = unknown, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, TOnMutateResult = unknown, Context = unknown, UseKey extends boolean = false> {
     method: Method;
     url: Url;
     querySchema?: QuerySchema;
@@ -600,9 +678,18 @@ declare interface MutationConfig<Method extends 'POST' | 'PUT' | 'PATCH' | 'DELE
     requestSchema?: RequestSchema;
     processResponse: ProcessResponseFunction<Result, ReqResult>;
     useContext?: () => Context;
-    onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: MutationArgs<Url, RequestSchema, QuerySchema>, context: Context) => void | Promise<void>;
-    onError?: (queryClient: QueryClient, error: Error, variables: MutationArgs<Url, RequestSchema, QuerySchema>, context: Context) => void | Promise<void>;
+    onSuccess?: (data: Result, variables: MutationArgs<Url, RequestSchema, QuerySchema>, context: Context & MutationFunctionContext & {
+        onMutateResult: TOnMutateResult | undefined;
+    }) => void | Promise<void>;
+    onError?: (err: unknown, variables: MutationArgs<Url, RequestSchema, QuerySchema>, context: Context & MutationFunctionContext & {
+        onMutateResult: TOnMutateResult | undefined;
+    }) => void | Promise<void>;
+    onMutate?: (variables: MutationArgs<Url, RequestSchema, QuerySchema>, context: Context & MutationFunctionContext) => TOnMutateResult | Promise<TOnMutateResult>;
+    onSettled?: (data: Result | undefined, error: Error | null, variables: MutationArgs<Url, RequestSchema, QuerySchema>, context: Context & MutationFunctionContext & {
+        onMutateResult: TOnMutateResult | undefined;
+    }) => void | Promise<void>;
     useKey?: UseKey;
+    meta?: Record<string, unknown>;
 }
 export { MutationConfig }
 export { MutationConfig as MutationConfig_alias_1 }
@@ -631,15 +718,23 @@ export { mutationKeyCreator as mutationKeyCreator_alias_2 }
 /**
  * Base parameters for mutation configuration.
  */
-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'> {
-    processResponse: ProcessResponseFunction<TData, TResponse>;
+declare interface MutationParams<Config extends AnyEndpointConfig, TData = unknown, TVariables = NaviosZodRequest<Config>, TResponse = z.output<Config['responseSchema']>, TOnMutateResult = unknown, TContext = unknown, UseKey extends boolean = false> extends Omit<UseMutationOptions<TData, Error, TVariables>, 'mutationKey' | 'mutationFn' | 'onMutate' | 'onSuccess' | 'onError' | 'onSettled' | 'scope'> {
+    processResponse?: ProcessResponseFunction<TData, TResponse>;
     /**
      * React hooks that will prepare the context for the mutation onSuccess and onError
      * callbacks. This is useful for when you want to use the context in the callbacks
      */
     useContext?: () => TContext;
-    onSuccess?: (queryClient: QueryClient, data: TData, variables: TVariables, context: TContext) => void | Promise<void>;
-    onError?: (queryClient: QueryClient, err: unknown, variables: TVariables, context: TContext) => void | Promise<void>;
+    onSuccess?: (data: TData, variables: TVariables, context: TContext & MutationFunctionContext & {
+        onMutateResult: TOnMutateResult | undefined;
+    }) => void | Promise<void>;
+    onError?: (err: unknown, variables: TVariables, context: TContext & MutationFunctionContext & {
+        onMutateResult: TOnMutateResult | undefined;
+    }) => void | Promise<void>;
+    onMutate?: (variables: TVariables, context: TContext & MutationFunctionContext) => TOnMutateResult | Promise<TOnMutateResult>;
+    onSettled?: (data: TData | undefined, error: Error | null, variables: TVariables, context: TContext & MutationFunctionContext & {
+        onMutateResult: TOnMutateResult | undefined;
+    }) => void | Promise<void>;
     /**
      * If true, we will create a mutation key that can be shared across the project.
      */
@@ -763,4 +858,16 @@ export { Split }
 export { Split as Split_alias_1 }
 export { Split as Split_alias_2 }
 
+/**
+ * Helper type that attaches a stream endpoint to mutation results.
+ */
+declare type StreamHelper<Method extends HttpMethod = HttpMethod, Url extends string = string, RequestSchema = unknown, QuerySchema = unknown> = {
+    endpoint: ((params: Util_FlatObject<EndpointFunctionArgs<Url, QuerySchema, RequestSchema>>) => Promise<Blob>) & {
+        config: BaseStreamConfig<Method, Url, QuerySchema, RequestSchema>;
+    };
+};
+export { StreamHelper }
+export { StreamHelper as StreamHelper_alias_1 }
+export { StreamHelper as StreamHelper_alias_2 }
+
 export { }

package/lib/_tsup-dts-rollup.d.ts

@@ -1,11 +1,13 @@
 import type { AbstractEndpoint } from '@navios/builder';
 import type { AnyEndpointConfig } from '@navios/builder';
 import type { BaseEndpointConfig } from '@navios/builder';
+import type { BaseStreamConfig } from '@navios/builder';
 import type { BuilderInstance } from '@navios/builder';
 import type { DataTag } from '@tanstack/react-query';
 import type { EndpointFunctionArgs } from '@navios/builder';
 import type { HttpMethod } from '@navios/builder';
 import type { InfiniteData } from '@tanstack/react-query';
+import type { MutationFunctionContext } from '@tanstack/react-query';
 import type { NaviosZodRequest } from '@navios/builder';
 import { NoInfer as NoInfer_2 } from '@tanstack/react-query';
 import { ProcessResponseFunction as ProcessResponseFunction_2 } from '../index.mjs';
@@ -345,6 +347,82 @@ declare interface ClientInstance {
     }): ((params: UrlHasParams<Url> extends true ? {
         urlParams: UrlParams<Url>;
     } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response>;
+    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: {
+        config: BaseStreamConfig<Method, Url, QuerySchema, RequestSchema>;
+    }, mutationOptions: {
+        processResponse?: ProcessResponseFunction<Result, Blob>;
+        useKey: UseKey;
+        useContext?: () => Context;
+        onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
+        onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
+    }): ((params: UrlHasParams<Url> extends true ? {
+        urlParams: UrlParams<Url>;
+    } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>>) & MutationHelpers<Url, Result> & StreamHelper<Method, Url, RequestSchema, QuerySchema>;
+    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: {
+        config: BaseStreamConfig<Method, Url, QuerySchema, RequestSchema>;
+    }, mutationOptions?: {
+        processResponse?: ProcessResponseFunction<Result, Blob>;
+        useContext?: () => Context;
+        onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
+        onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
+    }): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>>) & StreamHelper<Method, Url, RequestSchema, QuerySchema>;
+    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: {
+        config: BaseStreamConfig<Method, Url, undefined, RequestSchema>;
+    }, mutationOptions: {
+        processResponse?: ProcessResponseFunction<Result, Blob>;
+        useKey: UseKey;
+        useContext?: () => Context;
+        onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
+        onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
+    }): ((params: UrlHasParams<Url> extends true ? {
+        urlParams: UrlParams<Url>;
+    } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>>) & MutationHelpers<Url, Result> & StreamHelper<Method, Url, RequestSchema, undefined>;
+    mutationFromEndpoint<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, Result = Blob, Context = unknown>(endpoint: {
+        config: BaseStreamConfig<Method, Url, undefined, RequestSchema>;
+    }, mutationOptions?: {
+        processResponse?: ProcessResponseFunction<Result, Blob>;
+        useContext?: () => Context;
+        onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
+        onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
+    }): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>>) & StreamHelper<Method, Url, RequestSchema, undefined>;
+    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: {
+        config: BaseStreamConfig<Method, Url, QuerySchema, undefined>;
+    }, mutationOptions: {
+        processResponse?: ProcessResponseFunction<Result, Blob>;
+        useKey: UseKey;
+        useContext?: () => Context;
+        onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
+        onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
+    }): ((params: UrlHasParams<Url> extends true ? {
+        urlParams: UrlParams<Url>;
+    } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>>) & MutationHelpers<Url, Result> & StreamHelper<Method, Url, undefined, QuerySchema>;
+    mutationFromEndpoint<Method extends 'GET' | 'DELETE' | 'OPTIONS' | 'HEAD' = 'GET', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Result = Blob, Context = unknown>(endpoint: {
+        config: BaseStreamConfig<Method, Url, QuerySchema, undefined>;
+    }, mutationOptions?: {
+        processResponse?: ProcessResponseFunction<Result, Blob>;
+        useContext?: () => Context;
+        onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
+        onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
+    }): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>>) & StreamHelper<Method, Url, undefined, QuerySchema>;
+    mutationFromEndpoint<Method extends 'GET' | 'DELETE' | 'OPTIONS' | 'HEAD' = 'GET', Url extends string = string, Result = Blob, Context = unknown, UseKey extends true = true>(endpoint: {
+        config: BaseStreamConfig<Method, Url, undefined, undefined>;
+    }, mutationOptions: {
+        processResponse?: ProcessResponseFunction<Result, Blob>;
+        useKey: UseKey;
+        useContext?: () => Context;
+        onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
+        onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
+    }): ((params: UrlHasParams<Url> extends true ? {
+        urlParams: UrlParams<Url>;
+    } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>>) & MutationHelpers<Url, Result> & StreamHelper<Method, Url, undefined, undefined>;
+    mutationFromEndpoint<Method extends 'GET' | 'DELETE' | 'OPTIONS' | 'HEAD' = 'GET', Url extends string = string, Result = Blob, Context = unknown>(endpoint: {
+        config: BaseStreamConfig<Method, Url, undefined, undefined>;
+    }, mutationOptions?: {
+        processResponse?: ProcessResponseFunction<Result, Blob>;
+        useContext?: () => Context;
+        onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
+        onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
+    }): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>>) & StreamHelper<Method, Url, undefined, undefined>;
 }
 export { ClientInstance }
 export { ClientInstance as ClientInstance_alias_1 }
@@ -538,12 +616,12 @@ export { makeInfiniteQueryOptions as makeInfiniteQueryOptions_alias_2 }
  * @param options - Mutation configuration including processResponse and callbacks
  * @returns A hook function that returns mutation result with attached helpers
  */
-declare function makeMutation<Config extends AnyEndpointConfig, TData = unknown, TVariables extends NaviosZodRequest<Config> = NaviosZodRequest<Config>, TResponse = z.output<Config['responseSchema']>, TContext = unknown, UseKey extends boolean = false>(endpoint: AbstractEndpoint<Config>, options: MutationParams<Config, TData, TVariables, TResponse, TContext, UseKey>): {
-    (keyParams: UseKey extends true ? UrlHasParams<Config["url"]> extends true ? UrlParams<Config["url"]> : never : never): UseMutationResult<TData, Error, NaviosZodRequest<Config>>;
+declare function makeMutation<Config extends AnyEndpointConfig, TData = unknown, TVariables extends NaviosZodRequest<Config> = NaviosZodRequest<Config>, TResponse = z.output<Config['responseSchema']>, TOnMutateResult = unknown, TContext = unknown, UseKey extends boolean = false>(endpoint: AbstractEndpoint<Config>, options: MutationParams<Config, TData, TVariables, TResponse, TOnMutateResult, TContext, UseKey>): {
+    (keyParams: UseKey extends true ? UrlHasParams<Config["url"]> extends true ? UrlParams<Config["url"]> : never : never): UseMutationResult<TData, Error, NaviosZodRequest<Config>, TOnMutateResult>;
     useIsMutating(keyParams: UseKey extends true ? UrlHasParams<Config["url"]> extends true ? UrlParams<Config["url"]> : never : never): boolean;
     mutationKey: (params: UrlHasParams<Config["url"]> extends infer T ? T extends UrlHasParams<Config["url"]> ? T extends true ? {
         urlParams: UrlParams<Config["url"]>;
-    } : {} : never : never) => ProcessResponseFunction_2<TData, TResponse> extends (...args: unknown[]) => infer Result ? [Config["url"]] & {
+    } : {} : never : never) => ProcessResponseFunction_2<TData, TResponse> | ((data: z.core.output<Config["responseSchema"]>) => z.core.output<Config["responseSchema"]>) extends (...args: unknown[]) => infer Result ? [Config["url"]] & {
         [dataTagSymbol]: Result;
         [dataTagErrorSymbol]: Error;
     } : never;
@@ -592,7 +670,7 @@ export { MutationArgs as MutationArgs_alias_2 }
 /**
  * Configuration for declaring a mutation endpoint.
  */
-declare interface MutationConfig<Method extends 'POST' | 'PUT' | 'PATCH' | 'DELETE' = 'POST' | 'PUT' | 'PATCH' | 'DELETE', Url extends string = string, RequestSchema = Method extends 'DELETE' ? never : ZodObject, QuerySchema = unknown, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown, UseKey extends boolean = false> {
+declare interface MutationConfig<Method extends 'POST' | 'PUT' | 'PATCH' | 'DELETE' = 'POST' | 'PUT' | 'PATCH' | 'DELETE', Url extends string = string, RequestSchema = Method extends 'DELETE' ? never : ZodObject, QuerySchema = unknown, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, TOnMutateResult = unknown, Context = unknown, UseKey extends boolean = false> {
     method: Method;
     url: Url;
     querySchema?: QuerySchema;
@@ -600,9 +678,18 @@ declare interface MutationConfig<Method extends 'POST' | 'PUT' | 'PATCH' | 'DELE
     requestSchema?: RequestSchema;
     processResponse: ProcessResponseFunction<Result, ReqResult>;
     useContext?: () => Context;
-    onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: MutationArgs<Url, RequestSchema, QuerySchema>, context: Context) => void | Promise<void>;
-    onError?: (queryClient: QueryClient, error: Error, variables: MutationArgs<Url, RequestSchema, QuerySchema>, context: Context) => void | Promise<void>;
+    onSuccess?: (data: Result, variables: MutationArgs<Url, RequestSchema, QuerySchema>, context: Context & MutationFunctionContext & {
+        onMutateResult: TOnMutateResult | undefined;
+    }) => void | Promise<void>;
+    onError?: (err: unknown, variables: MutationArgs<Url, RequestSchema, QuerySchema>, context: Context & MutationFunctionContext & {
+        onMutateResult: TOnMutateResult | undefined;
+    }) => void | Promise<void>;
+    onMutate?: (variables: MutationArgs<Url, RequestSchema, QuerySchema>, context: Context & MutationFunctionContext) => TOnMutateResult | Promise<TOnMutateResult>;
+    onSettled?: (data: Result | undefined, error: Error | null, variables: MutationArgs<Url, RequestSchema, QuerySchema>, context: Context & MutationFunctionContext & {
+        onMutateResult: TOnMutateResult | undefined;
+    }) => void | Promise<void>;
     useKey?: UseKey;
+    meta?: Record<string, unknown>;
 }
 export { MutationConfig }
 export { MutationConfig as MutationConfig_alias_1 }
@@ -631,15 +718,23 @@ export { mutationKeyCreator as mutationKeyCreator_alias_2 }
 /**
  * Base parameters for mutation configuration.
  */
-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'> {
-    processResponse: ProcessResponseFunction<TData, TResponse>;
+declare interface MutationParams<Config extends AnyEndpointConfig, TData = unknown, TVariables = NaviosZodRequest<Config>, TResponse = z.output<Config['responseSchema']>, TOnMutateResult = unknown, TContext = unknown, UseKey extends boolean = false> extends Omit<UseMutationOptions<TData, Error, TVariables>, 'mutationKey' | 'mutationFn' | 'onMutate' | 'onSuccess' | 'onError' | 'onSettled' | 'scope'> {
+    processResponse?: ProcessResponseFunction<TData, TResponse>;
     /**
      * React hooks that will prepare the context for the mutation onSuccess and onError
      * callbacks. This is useful for when you want to use the context in the callbacks
      */
     useContext?: () => TContext;
-    onSuccess?: (queryClient: QueryClient, data: TData, variables: TVariables, context: TContext) => void | Promise<void>;
-    onError?: (queryClient: QueryClient, err: unknown, variables: TVariables, context: TContext) => void | Promise<void>;
+    onSuccess?: (data: TData, variables: TVariables, context: TContext & MutationFunctionContext & {
+        onMutateResult: TOnMutateResult | undefined;
+    }) => void | Promise<void>;
+    onError?: (err: unknown, variables: TVariables, context: TContext & MutationFunctionContext & {
+        onMutateResult: TOnMutateResult | undefined;
+    }) => void | Promise<void>;
+    onMutate?: (variables: TVariables, context: TContext & MutationFunctionContext) => TOnMutateResult | Promise<TOnMutateResult>;
+    onSettled?: (data: TData | undefined, error: Error | null, variables: TVariables, context: TContext & MutationFunctionContext & {
+        onMutateResult: TOnMutateResult | undefined;
+    }) => void | Promise<void>;
     /**
      * If true, we will create a mutation key that can be shared across the project.
      */
@@ -763,4 +858,16 @@ export { Split }
 export { Split as Split_alias_1 }
 export { Split as Split_alias_2 }
 
+/**
+ * Helper type that attaches a stream endpoint to mutation results.
+ */
+declare type StreamHelper<Method extends HttpMethod = HttpMethod, Url extends string = string, RequestSchema = unknown, QuerySchema = unknown> = {
+    endpoint: ((params: Util_FlatObject<EndpointFunctionArgs<Url, QuerySchema, RequestSchema>>) => Promise<Blob>) & {
+        config: BaseStreamConfig<Method, Url, QuerySchema, RequestSchema>;
+    };
+};
+export { StreamHelper }
+export { StreamHelper as StreamHelper_alias_1 }
+export { StreamHelper as StreamHelper_alias_2 }
+
 export { }

package/lib/index.d.mts

@@ -26,6 +26,7 @@ export { BaseMutationParams } from './_tsup-dts-rollup.mjs';
 export { BaseMutationArgs } from './_tsup-dts-rollup.mjs';
 export { EndpointHelper } from './_tsup-dts-rollup.mjs';
 export { ClientEndpointHelper } from './_tsup-dts-rollup.mjs';
+export { StreamHelper } from './_tsup-dts-rollup.mjs';
 export { ClientInstance } from './_tsup-dts-rollup.mjs';
 export { declareClient } from './_tsup-dts-rollup.mjs';
 export { QueryConfig } from './_tsup-dts-rollup.mjs';

package/lib/index.d.ts

@@ -26,6 +26,7 @@ export { BaseMutationParams } from './_tsup-dts-rollup.js';
 export { BaseMutationArgs } from './_tsup-dts-rollup.js';
 export { EndpointHelper } from './_tsup-dts-rollup.js';
 export { ClientEndpointHelper } from './_tsup-dts-rollup.js';
+export { StreamHelper } from './_tsup-dts-rollup.js';
 export { ClientInstance } from './_tsup-dts-rollup.js';
 export { declareClient } from './_tsup-dts-rollup.js';
 export { QueryConfig } from './_tsup-dts-rollup.js';

package/lib/index.js

@@ -154,46 +154,66 @@ function createMutationKey(config, options = {
 var mutationKeyCreator = createMutationKey;
 function makeMutation(endpoint, options) {
   const config = endpoint.config;
-  const mutationKey = createMutationKey(config, options);
+  const mutationKey = createMutationKey(config, {
+    ...options});
   const result = (keyParams) => {
-    const queryClient = reactQuery.useQueryClient();
     const {
       useKey,
       useContext,
+      onMutate,
       onError,
       onSuccess,
+      onSettled,
       keyPrefix: _keyPrefix,
       keySuffix: _keySuffix,
       processResponse,
       ...rest
     } = options;
-    const context = useContext?.();
-    return reactQuery.useMutation(
-      {
-        ...rest,
-        mutationKey: useKey ? mutationKey({
-          urlParams: keyParams
-        }) : void 0,
-        scope: useKey ? {
-          id: JSON.stringify(
-            mutationKey({
-              urlParams: keyParams
-            })
-          )
-        } : void 0,
-        async mutationFn(params) {
-          const response = await endpoint(params);
-          return processResponse(response);
-        },
-        onSuccess: onSuccess ? (data, variables) => {
-          return onSuccess?.(queryClient, data, variables, context);
-        } : void 0,
-        onError: onError ? (err, variables) => {
-          return onError?.(queryClient, err, variables, context);
-        } : void 0
+    const ownContext = useContext?.() ?? {};
+    return reactQuery.useMutation({
+      ...rest,
+      mutationKey: useKey ? mutationKey({
+        urlParams: keyParams
+      }) : void 0,
+      scope: useKey ? {
+        id: JSON.stringify(
+          mutationKey({
+            urlParams: keyParams
+          })
+        )
+      } : void 0,
+      async mutationFn(params) {
+        const response = await endpoint(params);
+        return processResponse ? processResponse(response) : response;
       },
-      queryClient
-    );
+      onSuccess: onSuccess ? (data, variables, onMutateResult, context) => {
+        return onSuccess?.(data, variables, {
+          ...ownContext,
+          ...context,
+          onMutateResult
+        });
+      } : void 0,
+      onError: onError ? (err, variables, onMutateResult, context) => {
+        return onError?.(err, variables, {
+          onMutateResult,
+          ...ownContext,
+          ...context
+        });
+      } : void 0,
+      onMutate: onMutate ? (variables, context) => {
+        return onMutate(variables, {
+          ...ownContext,
+          ...context
+        });
+      } : void 0,
+      onSettled: onSettled ? (data, error, variables, onMutateResult, context) => {
+        return onSettled(data, error, variables, {
+          ...ownContext,
+          ...context,
+          onMutateResult
+        });
+      } : void 0
+    });
   };
   result.useIsMutating = (keyParams) => {
     if (!options.useKey) {
@@ -284,6 +304,7 @@ function declareClient({
       // @ts-expect-error We forgot about the DELETE method in original makeMutation
       onError: config.onError,
       useKey: config.useKey,
+      meta: config.meta,
       ...defaults
     });
     useMutation2.endpoint = endpoint;
@@ -291,11 +312,10 @@ function declareClient({
   }
   function mutationFromEndpoint(endpoint, options) {
     return makeMutation(endpoint, {
-      processResponse: options.processResponse,
-      useContext: options.useContext,
-      onSuccess: options.onSuccess,
-      // @ts-expect-error simplify types here
-      onError: options.onError,
+      processResponse: options?.processResponse,
+      useContext: options?.useContext,
+      onSuccess: options?.onSuccess,
+      onError: options?.onError,
       ...defaults
     });
   }
@@ -315,6 +335,10 @@ function declareClient({
       onSuccess: config.onSuccess,
       // @ts-expect-error We forgot about the DELETE method in original makeMutation
       onError: config.onError,
+      // @ts-expect-error We forgot about the DELETE method in original makeMutation
+      onMutate: config.onMutate,
+      // @ts-expect-error We forgot about the DELETE method in original makeMutation
+      onSettled: config.onSettled,
       useKey: config.useKey,
       ...defaults
     });