@navios/react-query 0.5.2 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,5 +1,5 @@
1
1
  import type { HttpMethod } from '@navios/builder';
2
- import type { InfiniteData, QueryClient } from '@tanstack/react-query';
2
+ import type { InfiniteData, MutationFunctionContext } from '@tanstack/react-query';
3
3
  import type { z, ZodObject, ZodType } from 'zod/v4';
4
4
  import type { ClientOptions, ProcessResponseFunction } from '../common/types.mjs';
5
5
  import type { MutationArgs } from '../mutation/types.mjs';
@@ -33,7 +33,7 @@ export type InfiniteQueryConfig<Method = HttpMethod, Url = string, QuerySchema e
33
33
  /**
34
34
  * Configuration for declaring a mutation endpoint.
35
35
  */
36
- export 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> {
36
+ export 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> {
37
37
  method: Method;
38
38
  url: Url;
39
39
  querySchema?: QuerySchema;
@@ -41,9 +41,18 @@ export interface MutationConfig<Method extends 'POST' | 'PUT' | 'PATCH' | 'DELET
41
41
  requestSchema?: RequestSchema;
42
42
  processResponse: ProcessResponseFunction<Result, ReqResult>;
43
43
  useContext?: () => Context;
44
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: MutationArgs<Url, RequestSchema, QuerySchema>, context: Context) => void | Promise<void>;
45
- onError?: (queryClient: QueryClient, error: Error, variables: MutationArgs<Url, RequestSchema, QuerySchema>, context: Context) => void | Promise<void>;
44
+ onSuccess?: (data: Result, variables: MutationArgs<Url, RequestSchema, QuerySchema>, context: Context & MutationFunctionContext & {
45
+ onMutateResult: TOnMutateResult | undefined;
46
+ }) => void | Promise<void>;
47
+ onError?: (err: unknown, variables: MutationArgs<Url, RequestSchema, QuerySchema>, context: Context & MutationFunctionContext & {
48
+ onMutateResult: TOnMutateResult | undefined;
49
+ }) => void | Promise<void>;
50
+ onMutate?: (variables: MutationArgs<Url, RequestSchema, QuerySchema>, context: Context & MutationFunctionContext) => TOnMutateResult | Promise<TOnMutateResult>;
51
+ onSettled?: (data: Result | undefined, error: Error | null, variables: MutationArgs<Url, RequestSchema, QuerySchema>, context: Context & MutationFunctionContext & {
52
+ onMutateResult: TOnMutateResult | undefined;
53
+ }) => void | Promise<void>;
46
54
  useKey?: UseKey;
55
+ meta?: Record<string, unknown>;
47
56
  }
48
57
  /**
49
58
  * Creates a client instance for making type-safe queries and mutations.
@@ -1 +1 @@
1
- {"version":3,"file":"declare-client.d.mts","sourceRoot":"","sources":["../../../src/client/declare-client.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAKV,UAAU,EACX,MAAM,iBAAiB,CAAA;AACxB,OAAO,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACtE,OAAO,KAAK,EAAE,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAA;AAEnD,OAAO,KAAK,EAAE,aAAa,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAA;AACjF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AACzD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAMjD;;GAEG;AACH,MAAM,WAAW,WAAW,CAC1B,MAAM,GAAG,UAAU,EACnB,GAAG,GAAG,MAAM,EACZ,WAAW,GAAG,SAAS,EACvB,QAAQ,SAAS,OAAO,GAAG,OAAO,EAClC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,EAC3B,aAAa,GAAG,OAAO;IAEvB,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,GAAG,CAAA;IACR,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,cAAc,EAAE,QAAQ,CAAA;IACxB,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B,eAAe,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,MAAM,CAAA;CACvD;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,CAC7B,MAAM,GAAG,UAAU,EACnB,GAAG,GAAG,MAAM,EACZ,WAAW,SAAS,SAAS,GAAG,SAAS,EACzC,QAAQ,SAAS,OAAO,GAAG,OAAO,EAClC,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,EAC/B,MAAM,GAAG,YAAY,CAAC,UAAU,CAAC,EACjC,aAAa,GAAG,OAAO,IACrB;IACF,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,GAAG,CAAA;IACR,WAAW,EAAE,WAAW,CAAA;IACxB,cAAc,EAAE,QAAQ,CAAA;IACxB,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B,eAAe,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,UAAU,CAAA;IAC1D,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,YAAY,CAAC,UAAU,CAAC,KAAK,MAAM,CAAA;IACnD,gBAAgB,EAAE,CAChB,QAAQ,EAAE,UAAU,EACpB,QAAQ,EAAE,UAAU,EAAE,EACtB,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,SAAS,EAC/C,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,GAAG,SAAS,KAC9C,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,SAAS,CAAA;IACrC,oBAAoB,CAAC,EAAE,CACrB,SAAS,EAAE,UAAU,EACrB,QAAQ,EAAE,UAAU,EAAE,EACtB,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,SAAS,EAC/C,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,GAAG,SAAS,KAC9C,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAA;IACzB,gBAAgB,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAA;CACxC,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,cAAc,CAC7B,MAAM,SAAS,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,GAC9C,MAAM,GACN,KAAK,GACL,OAAO,GACP,QAAQ,EACZ,GAAG,SAAS,MAAM,GAAG,MAAM,EAC3B,aAAa,GAAG,MAAM,SAAS,QAAQ,GAAG,KAAK,GAAG,SAAS,EAC3D,WAAW,GAAG,OAAO,EACrB,QAAQ,SAAS,OAAO,GAAG,OAAO,EAClC,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,EAC9B,MAAM,GAAG,OAAO,EAChB,OAAO,GAAG,OAAO,EACjB,MAAM,SAAS,OAAO,GAAG,KAAK;IAE9B,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,GAAG,CAAA;IACR,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,cAAc,EAAE,QAAQ,CAAA;IACxB,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B,eAAe,EAAE,uBAAuB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;IAC3D,UAAU,CAAC,EAAE,MAAM,OAAO,CAAA;IAC1B,SAAS,CAAC,EAAE,CACV,WAAW,EAAE,WAAW,EACxB,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,EACrB,SAAS,EAAE,YAAY,CAAC,GAAG,EAAE,aAAa,EAAE,WAAW,CAAC,EACxD,OAAO,EAAE,OAAO,KACb,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACzB,OAAO,CAAC,EAAE,CACR,WAAW,EAAE,WAAW,EACxB,KAAK,EAAE,KAAK,EACZ,SAAS,EAAE,YAAY,CAAC,GAAG,EAAE,aAAa,EAAE,WAAW,CAAC,EACxD,OAAO,EAAE,OAAO,KACb,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACzB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,aAAa,CAAC,OAAO,SAAS,aAAa,EAAE,EAC3D,GAAG,EACH,QAAa,GACd,EAAE,OAAO,GAAG,cAAc,CAyL1B"}
1
+ {"version":3,"file":"declare-client.d.mts","sourceRoot":"","sources":["../../../src/client/declare-client.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAKV,UAAU,EACX,MAAM,iBAAiB,CAAA;AACxB,OAAO,KAAK,EACV,YAAY,EACZ,uBAAuB,EAExB,MAAM,uBAAuB,CAAA;AAC9B,OAAO,KAAK,EAAE,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAA;AAEnD,OAAO,KAAK,EACV,aAAa,EACb,uBAAuB,EACxB,MAAM,qBAAqB,CAAA;AAC5B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AACzD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAMjD;;GAEG;AACH,MAAM,WAAW,WAAW,CAC1B,MAAM,GAAG,UAAU,EACnB,GAAG,GAAG,MAAM,EACZ,WAAW,GAAG,SAAS,EACvB,QAAQ,SAAS,OAAO,GAAG,OAAO,EAClC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,EAC3B,aAAa,GAAG,OAAO;IAEvB,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,GAAG,CAAA;IACR,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,cAAc,EAAE,QAAQ,CAAA;IACxB,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B,eAAe,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,MAAM,CAAA;CACvD;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,CAC7B,MAAM,GAAG,UAAU,EACnB,GAAG,GAAG,MAAM,EACZ,WAAW,SAAS,SAAS,GAAG,SAAS,EACzC,QAAQ,SAAS,OAAO,GAAG,OAAO,EAClC,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,EAC/B,MAAM,GAAG,YAAY,CAAC,UAAU,CAAC,EACjC,aAAa,GAAG,OAAO,IACrB;IACF,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,GAAG,CAAA;IACR,WAAW,EAAE,WAAW,CAAA;IACxB,cAAc,EAAE,QAAQ,CAAA;IACxB,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B,eAAe,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,UAAU,CAAA;IAC1D,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,YAAY,CAAC,UAAU,CAAC,KAAK,MAAM,CAAA;IACnD,gBAAgB,EAAE,CAChB,QAAQ,EAAE,UAAU,EACpB,QAAQ,EAAE,UAAU,EAAE,EACtB,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,SAAS,EAC/C,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,GAAG,SAAS,KAC9C,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,SAAS,CAAA;IACrC,oBAAoB,CAAC,EAAE,CACrB,SAAS,EAAE,UAAU,EACrB,QAAQ,EAAE,UAAU,EAAE,EACtB,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,SAAS,EAC/C,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,GAAG,SAAS,KAC9C,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAA;IACzB,gBAAgB,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAA;CACxC,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,cAAc,CAC7B,MAAM,SAAS,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,GAC9C,MAAM,GACN,KAAK,GACL,OAAO,GACP,QAAQ,EACZ,GAAG,SAAS,MAAM,GAAG,MAAM,EAC3B,aAAa,GAAG,MAAM,SAAS,QAAQ,GAAG,KAAK,GAAG,SAAS,EAC3D,WAAW,GAAG,OAAO,EACrB,QAAQ,SAAS,OAAO,GAAG,OAAO,EAClC,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,EAC9B,MAAM,GAAG,OAAO,EAChB,eAAe,GAAG,OAAO,EACzB,OAAO,GAAG,OAAO,EACjB,MAAM,SAAS,OAAO,GAAG,KAAK;IAE9B,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,GAAG,CAAA;IACR,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,cAAc,EAAE,QAAQ,CAAA;IACxB,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B,eAAe,EAAE,uBAAuB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;IAC3D,UAAU,CAAC,EAAE,MAAM,OAAO,CAAA;IAC1B,SAAS,CAAC,EAAE,CACV,IAAI,EAAE,MAAM,EACZ,SAAS,EAAE,YAAY,CAAC,GAAG,EAAE,aAAa,EAAE,WAAW,CAAC,EACxD,OAAO,EAAE,OAAO,GACd,uBAAuB,GAAG;QAAE,cAAc,EAAE,eAAe,GAAG,SAAS,CAAA;KAAE,KACxE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACzB,OAAO,CAAC,EAAE,CACR,GAAG,EAAE,OAAO,EACZ,SAAS,EAAE,YAAY,CAAC,GAAG,EAAE,aAAa,EAAE,WAAW,CAAC,EACxD,OAAO,EAAE,OAAO,GACd,uBAAuB,GAAG;QAAE,cAAc,EAAE,eAAe,GAAG,SAAS,CAAA;KAAE,KACxE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACzB,QAAQ,CAAC,EAAE,CACT,SAAS,EAAE,YAAY,CAAC,GAAG,EAAE,aAAa,EAAE,WAAW,CAAC,EACxD,OAAO,EAAE,OAAO,GAAG,uBAAuB,KACvC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC,CAAA;IAC/C,SAAS,CAAC,EAAE,CACV,IAAI,EAAE,MAAM,GAAG,SAAS,EACxB,KAAK,EAAE,KAAK,GAAG,IAAI,EACnB,SAAS,EAAE,YAAY,CAAC,GAAG,EAAE,aAAa,EAAE,WAAW,CAAC,EACxD,OAAO,EAAE,OAAO,GACd,uBAAuB,GAAG;QAAE,cAAc,EAAE,eAAe,GAAG,SAAS,CAAA;KAAE,KACxE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACzB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC/B;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,aAAa,CAAC,OAAO,SAAS,aAAa,EAAE,EAC3D,GAAG,EACH,QAAa,GACd,EAAE,OAAO,GAAG,cAAc,CA8L1B"}
@@ -12,8 +12,8 @@ import type { MutationParams } from './types.mjs';
12
12
  * @param options - Mutation configuration including processResponse and callbacks
13
13
  * @returns A hook function that returns mutation result with attached helpers
14
14
  */
15
- export 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>): {
16
- (keyParams: UseKey extends true ? UrlHasParams<Config["url"]> extends true ? UrlParams<Config["url"]> : never : never): UseMutationResult<TData, Error, NaviosZodRequest<Config>>;
15
+ export 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>): {
16
+ (keyParams: UseKey extends true ? UrlHasParams<Config["url"]> extends true ? UrlParams<Config["url"]> : never : never): UseMutationResult<TData, Error, NaviosZodRequest<Config>, TOnMutateResult>;
17
17
  useIsMutating(keyParams: UseKey extends true ? UrlHasParams<Config["url"]> extends true ? UrlParams<Config["url"]> : never : never): boolean;
18
18
  mutationKey: (params: UrlHasParams<Config["url"]> extends infer T ? T extends UrlHasParams<Config["url"]> ? T extends true ? {
19
19
  urlParams: UrlParams<Config["url"]>;
@@ -1 +1 @@
1
- {"version":3,"file":"make-hook.d.mts","sourceRoot":"","sources":["../../../src/mutation/make-hook.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,YAAY,EACZ,SAAS,EACV,MAAM,iBAAiB,CAAA;AACxB,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAA;AAC9D,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAQ/B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAIjD;;;;;;;;;GASG;AACH,wBAAgB,YAAY,CAC1B,MAAM,SAAS,iBAAiB,EAChC,KAAK,GAAG,OAAO,EACf,UAAU,SAAS,gBAAgB,CAAC,MAAM,CAAC,GAAG,gBAAgB,CAAC,MAAM,CAAC,EACtE,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,EAC9C,QAAQ,GAAG,OAAO,EAClB,MAAM,SAAS,OAAO,GAAG,KAAK,EAE9B,QAAQ,EAAE,gBAAgB,CAAC,MAAM,CAAC,EAClC,OAAO,EAAE,cAAc,CACrB,MAAM,EACN,KAAK,EACL,UAAU,EACV,SAAS,EACT,QAAQ,EACR,MAAM,CACP;gBASY,MAAM,SAAS,IAAI,GAC1B,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,IAAI,GACtC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,GACxB,KAAK,GACP,KAAK,GACR,iBAAiB,CAAC,KAAK,EAAE,KAAK,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAC;6BAqD/C,MAAM,SAAS,IAAI,GAC1B,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,IAAI,GACtC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,GACxB,KAAK,GACP,KAAK,GACR,OAAO;;;;;;;EAgBX"}
1
+ {"version":3,"file":"make-hook.d.mts","sourceRoot":"","sources":["../../../src/mutation/make-hook.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,YAAY,EACZ,SAAS,EACV,MAAM,iBAAiB,CAAA;AACxB,OAAO,KAAK,EAEV,iBAAiB,EAClB,MAAM,uBAAuB,CAAA;AAC9B,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAI/B,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAIjD;;;;;;;;;GASG;AACH,wBAAgB,YAAY,CAC1B,MAAM,SAAS,iBAAiB,EAChC,KAAK,GAAG,OAAO,EACf,UAAU,SAAS,gBAAgB,CAAC,MAAM,CAAC,GAAG,gBAAgB,CAAC,MAAM,CAAC,EACtE,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,EAC9C,eAAe,GAAG,OAAO,EACzB,QAAQ,GAAG,OAAO,EAClB,MAAM,SAAS,OAAO,GAAG,KAAK,EAE9B,QAAQ,EAAE,gBAAgB,CAAC,MAAM,CAAC,EAClC,OAAO,EAAE,cAAc,CACrB,MAAM,EACN,KAAK,EACL,UAAU,EACV,SAAS,EACT,eAAe,EACf,QAAQ,EACR,MAAM,CACP;gBASY,MAAM,SAAS,IAAI,GAC1B,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,IAAI,GACtC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,GACxB,KAAK,GACP,KAAK,GACR,iBAAiB,CAClB,KAAK,EACL,KAAK,EACL,gBAAgB,CAAC,MAAM,CAAC,EACxB,eAAe,CAChB;6BAqGY,MAAM,SAAS,IAAI,GAC1B,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,IAAI,GACtC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,GACxB,KAAK,GACP,KAAK,GACR,OAAO;;;;;;;EAgBX"}
@@ -1,5 +1,5 @@
1
1
  import type { AnyEndpointConfig, NaviosZodRequest, UrlHasParams, UrlParams } from '@navios/builder';
2
- import type { DataTag, QueryClient, UseMutationOptions } from '@tanstack/react-query';
2
+ import type { DataTag, MutationFunctionContext, UseMutationOptions } from '@tanstack/react-query';
3
3
  import type { z, ZodObject } from 'zod/v4';
4
4
  import type { ProcessResponseFunction } from '../common/types.mjs';
5
5
  /**
@@ -25,15 +25,23 @@ export type MutationHelpers<Url extends string, Result = unknown> = UrlHasParams
25
25
  /**
26
26
  * Base parameters for mutation configuration.
27
27
  */
28
- export 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'> {
28
+ export 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'> {
29
29
  processResponse?: ProcessResponseFunction<TData, TResponse>;
30
30
  /**
31
31
  * React hooks that will prepare the context for the mutation onSuccess and onError
32
32
  * callbacks. This is useful for when you want to use the context in the callbacks
33
33
  */
34
34
  useContext?: () => TContext;
35
- onSuccess?: (queryClient: QueryClient, data: TData, variables: TVariables, context: TContext) => void | Promise<void>;
36
- onError?: (queryClient: QueryClient, err: unknown, variables: TVariables, context: TContext) => void | Promise<void>;
35
+ onSuccess?: (data: TData, variables: TVariables, context: TContext & MutationFunctionContext & {
36
+ onMutateResult: TOnMutateResult | undefined;
37
+ }) => void | Promise<void>;
38
+ onError?: (err: unknown, variables: TVariables, context: TContext & MutationFunctionContext & {
39
+ onMutateResult: TOnMutateResult | undefined;
40
+ }) => void | Promise<void>;
41
+ onMutate?: (variables: TVariables, context: TContext & MutationFunctionContext) => TOnMutateResult | Promise<TOnMutateResult>;
42
+ onSettled?: (data: TData | undefined, error: Error | null, variables: TVariables, context: TContext & MutationFunctionContext & {
43
+ onMutateResult: TOnMutateResult | undefined;
44
+ }) => void | Promise<void>;
37
45
  /**
38
46
  * If true, we will create a mutation key that can be shared across the project.
39
47
  */
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../../../src/mutation/types.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,iBAAiB,EACjB,gBAAgB,EAChB,YAAY,EACZ,SAAS,EACV,MAAM,iBAAiB,CAAA;AACxB,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AACrF,OAAO,KAAK,EAAE,CAAC,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAA;AAE1C,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAA;AAElE;;GAEG;AACH,MAAM,MAAM,YAAY,CACtB,GAAG,SAAS,MAAM,GAAG,MAAM,EAC3B,aAAa,GAAG,OAAO,EACvB,WAAW,GAAG,OAAO,IACnB,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,IAAI,GAAG;IAAE,SAAS,EAAE,SAAS,CAAC,GAAG,CAAC,CAAA;CAAE,GAAG,EAAE,CAAC,GACvE,CAAC,aAAa,SAAS,SAAS,GAAG;IAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAA;CAAE,GAAG,EAAE,CAAC,GACzE,CAAC,WAAW,SAAS,SAAS,GAAG;IAAE,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAA;CAAE,GAAG,EAAE,CAAC,CAAA;AAEzE;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,GAAG,SAAS,MAAM,EAAE,MAAM,GAAG,OAAO,IAC9D,YAAY,CAAC,GAAG,CAAC,SAAS,IAAI,GAC1B;IACE,WAAW,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC,KAAK,OAAO,CAAC,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,CAAA;IACtE,aAAa,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC,GAAG,CAAC,KAAK,OAAO,CAAA;CACtD,GACD;IACE,WAAW,EAAE,MAAM,OAAO,CAAC,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,CAAA;IAChD,aAAa,EAAE,MAAM,OAAO,CAAA;CAC7B,CAAA;AAEP;;GAEG;AACH,MAAM,WAAW,cAAc,CAC7B,MAAM,SAAS,iBAAiB,EAChC,KAAK,GAAG,OAAO,EACf,UAAU,GAAG,gBAAgB,CAAC,MAAM,CAAC,EACrC,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,EAC9C,QAAQ,GAAG,OAAO,EAClB,MAAM,SAAS,OAAO,GAAG,KAAK,CAC9B,SAAQ,IAAI,CACV,kBAAkB,CAAC,KAAK,EAAE,KAAK,EAAE,UAAU,CAAC,EAC5C,aAAa,GAAG,YAAY,GAAG,WAAW,GAAG,SAAS,GAAG,OAAO,CACjE;IACD,eAAe,CAAC,EAAE,uBAAuB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAA;IAC3D;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,QAAQ,CAAA;IAC3B,SAAS,CAAC,EAAE,CACV,WAAW,EAAE,WAAW,EACxB,IAAI,EAAE,KAAK,EACX,SAAS,EAAE,UAAU,EACrB,OAAO,EAAE,QAAQ,KACd,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACzB,OAAO,CAAC,EAAE,CACR,WAAW,EAAE,WAAW,EACxB,GAAG,EAAE,OAAO,EACZ,SAAS,EAAE,UAAU,EACrB,OAAO,EAAE,QAAQ,KACd,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,SAAS,IAAI,GAC3B,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,IAAI,GACtC,MAAM,EAAE,GACR,KAAK,GACP,KAAK,CAAA;IACT,SAAS,CAAC,EAAE,MAAM,SAAS,IAAI,GAC3B,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,IAAI,GACtC,MAAM,EAAE,GACR,KAAK,GACP,KAAK,CAAA;CACV;AAGD,2CAA2C;AAC3C,MAAM,MAAM,kBAAkB,CAC5B,GAAG,SAAS,MAAM,GAAG,MAAM,EAC3B,aAAa,GAAG,OAAO,EACvB,WAAW,GAAG,OAAO,IACnB,YAAY,CAAC,GAAG,EAAE,aAAa,EAAE,WAAW,CAAC,CAAA;AAEjD,6CAA6C;AAC7C,MAAM,MAAM,kBAAkB,CAC5B,MAAM,SAAS,iBAAiB,EAChC,KAAK,GAAG,OAAO,EACf,UAAU,GAAG,gBAAgB,CAAC,MAAM,CAAC,EACrC,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,EAC9C,QAAQ,GAAG,OAAO,EAClB,MAAM,SAAS,OAAO,GAAG,KAAK,IAC5B,cAAc,CAAC,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAA;AAE1E,oEAAoE;AACpE,MAAM,MAAM,gBAAgB,CAAC,MAAM,SAAS,iBAAiB,IAC3D,gBAAgB,CAAC,MAAM,CAAC,CAAA"}
1
+ {"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../../../src/mutation/types.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,iBAAiB,EACjB,gBAAgB,EAChB,YAAY,EACZ,SAAS,EACV,MAAM,iBAAiB,CAAA;AACxB,OAAO,KAAK,EACV,OAAO,EACP,uBAAuB,EACvB,kBAAkB,EACnB,MAAM,uBAAuB,CAAA;AAC9B,OAAO,KAAK,EAAE,CAAC,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAA;AAE1C,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAA;AAElE;;GAEG;AACH,MAAM,MAAM,YAAY,CACtB,GAAG,SAAS,MAAM,GAAG,MAAM,EAC3B,aAAa,GAAG,OAAO,EACvB,WAAW,GAAG,OAAO,IACnB,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,IAAI,GAAG;IAAE,SAAS,EAAE,SAAS,CAAC,GAAG,CAAC,CAAA;CAAE,GAAG,EAAE,CAAC,GACvE,CAAC,aAAa,SAAS,SAAS,GAAG;IAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAA;CAAE,GAAG,EAAE,CAAC,GACzE,CAAC,WAAW,SAAS,SAAS,GAAG;IAAE,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAA;CAAE,GAAG,EAAE,CAAC,CAAA;AAEzE;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,GAAG,SAAS,MAAM,EAAE,MAAM,GAAG,OAAO,IAC9D,YAAY,CAAC,GAAG,CAAC,SAAS,IAAI,GAC1B;IACE,WAAW,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC,KAAK,OAAO,CAAC,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,CAAA;IACtE,aAAa,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC,GAAG,CAAC,KAAK,OAAO,CAAA;CACtD,GACD;IACE,WAAW,EAAE,MAAM,OAAO,CAAC,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,CAAA;IAChD,aAAa,EAAE,MAAM,OAAO,CAAA;CAC7B,CAAA;AAEP;;GAEG;AACH,MAAM,WAAW,cAAc,CAC7B,MAAM,SAAS,iBAAiB,EAChC,KAAK,GAAG,OAAO,EACf,UAAU,GAAG,gBAAgB,CAAC,MAAM,CAAC,EACrC,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,EAC9C,eAAe,GAAG,OAAO,EACzB,QAAQ,GAAG,OAAO,EAClB,MAAM,SAAS,OAAO,GAAG,KAAK,CAC9B,SAAQ,IAAI,CACV,kBAAkB,CAAC,KAAK,EAAE,KAAK,EAAE,UAAU,CAAC,EAC1C,aAAa,GACb,YAAY,GACZ,UAAU,GACV,WAAW,GACX,SAAS,GACT,WAAW,GACX,OAAO,CACV;IACD,eAAe,CAAC,EAAE,uBAAuB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAA;IAC3D;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,QAAQ,CAAA;IAC3B,SAAS,CAAC,EAAE,CACV,IAAI,EAAE,KAAK,EACX,SAAS,EAAE,UAAU,EACrB,OAAO,EAAE,QAAQ,GACf,uBAAuB,GAAG;QAAE,cAAc,EAAE,eAAe,GAAG,SAAS,CAAA;KAAE,KACxE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACzB,OAAO,CAAC,EAAE,CACR,GAAG,EAAE,OAAO,EACZ,SAAS,EAAE,UAAU,EACrB,OAAO,EAAE,QAAQ,GACf,uBAAuB,GAAG;QAAE,cAAc,EAAE,eAAe,GAAG,SAAS,CAAA;KAAE,KACxE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACzB,QAAQ,CAAC,EAAE,CACT,SAAS,EAAE,UAAU,EACrB,OAAO,EAAE,QAAQ,GAAG,uBAAuB,KACxC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC,CAAA;IAC/C,SAAS,CAAC,EAAE,CACV,IAAI,EAAE,KAAK,GAAG,SAAS,EACvB,KAAK,EAAE,KAAK,GAAG,IAAI,EACnB,SAAS,EAAE,UAAU,EACrB,OAAO,EAAE,QAAQ,GACf,uBAAuB,GAAG;QAAE,cAAc,EAAE,eAAe,GAAG,SAAS,CAAA;KAAE,KACxE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,SAAS,IAAI,GAC3B,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,IAAI,GACtC,MAAM,EAAE,GACR,KAAK,GACP,KAAK,CAAA;IACT,SAAS,CAAC,EAAE,MAAM,SAAS,IAAI,GAC3B,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,IAAI,GACtC,MAAM,EAAE,GACR,KAAK,GACP,KAAK,CAAA;CACV;AAGD,2CAA2C;AAC3C,MAAM,MAAM,kBAAkB,CAC5B,GAAG,SAAS,MAAM,GAAG,MAAM,EAC3B,aAAa,GAAG,OAAO,EACvB,WAAW,GAAG,OAAO,IACnB,YAAY,CAAC,GAAG,EAAE,aAAa,EAAE,WAAW,CAAC,CAAA;AAEjD,6CAA6C;AAC7C,MAAM,MAAM,kBAAkB,CAC5B,MAAM,SAAS,iBAAiB,EAChC,KAAK,GAAG,OAAO,EACf,UAAU,GAAG,gBAAgB,CAAC,MAAM,CAAC,EACrC,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,EAC9C,QAAQ,GAAG,OAAO,EAClB,MAAM,SAAS,OAAO,GAAG,KAAK,IAC5B,cAAc,CAAC,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAA;AAE1E,oEAAoE;AACpE,MAAM,MAAM,gBAAgB,CAAC,MAAM,SAAS,iBAAiB,IAC3D,gBAAgB,CAAC,MAAM,CAAC,CAAA"}