@navios/react-query 0.4.0 → 0.5.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.
Files changed (78) hide show
  1. package/CHANGELOG.md +74 -0
  2. package/dist/src/client/declare-client.d.mts +70 -0
  3. package/dist/src/client/declare-client.d.mts.map +1 -0
  4. package/dist/src/client/index.d.mts +3 -0
  5. package/dist/src/client/index.d.mts.map +1 -0
  6. package/dist/src/client/types.d.mts +287 -0
  7. package/dist/src/client/types.d.mts.map +1 -0
  8. package/dist/src/common/index.d.mts +2 -0
  9. package/dist/src/common/index.d.mts.map +1 -0
  10. package/dist/src/common/types.d.mts +21 -0
  11. package/dist/src/common/types.d.mts.map +1 -0
  12. package/dist/src/index.d.mts +13 -8
  13. package/dist/src/index.d.mts.map +1 -1
  14. package/dist/src/mutation/index.d.mts +4 -0
  15. package/dist/src/mutation/index.d.mts.map +1 -0
  16. package/dist/src/mutation/key-creator.d.mts +36 -0
  17. package/dist/src/mutation/key-creator.d.mts.map +1 -0
  18. package/dist/src/mutation/make-hook.d.mts +25 -0
  19. package/dist/src/mutation/make-hook.d.mts.map +1 -0
  20. package/dist/src/mutation/types.d.mts +50 -0
  21. package/dist/src/mutation/types.d.mts.map +1 -0
  22. package/dist/src/query/index.d.mts +5 -0
  23. package/dist/src/query/index.d.mts.map +1 -0
  24. package/dist/src/query/key-creator.d.mts +17 -0
  25. package/dist/src/query/key-creator.d.mts.map +1 -0
  26. package/dist/src/query/make-infinite-options.d.mts +23 -0
  27. package/dist/src/query/make-infinite-options.d.mts.map +1 -0
  28. package/dist/src/query/make-options.d.mts +24 -0
  29. package/dist/src/query/make-options.d.mts.map +1 -0
  30. package/dist/src/query/types.d.mts +83 -0
  31. package/dist/src/query/types.d.mts.map +1 -0
  32. package/dist/tsconfig.tsbuildinfo +1 -1
  33. package/lib/_tsup-dts-rollup.d.mts +500 -250
  34. package/lib/_tsup-dts-rollup.d.ts +500 -250
  35. package/lib/index.d.mts +26 -19
  36. package/lib/index.d.ts +26 -19
  37. package/lib/index.js +92 -66
  38. package/lib/index.js.map +1 -1
  39. package/lib/index.mjs +92 -68
  40. package/lib/index.mjs.map +1 -1
  41. package/package.json +7 -7
  42. package/project.json +9 -1
  43. package/src/__tests__/client-type-check.spec.mts +1 -1
  44. package/src/__tests__/declare-client.spec.mts +1 -1
  45. package/src/__tests__/make-mutation.spec.mts +1 -1
  46. package/src/__tests__/makeDataTag.spec.mts +1 -1
  47. package/src/__tests__/makeInfiniteQueryOptions.spec.mts +1 -2
  48. package/src/__tests__/makeQueryOptions.spec.mts +1 -1
  49. package/src/{declare-client.mts → client/declare-client.mts} +93 -33
  50. package/src/client/index.mts +2 -0
  51. package/src/{types/client-instance.mts → client/types.mts} +429 -145
  52. package/src/common/index.mts +1 -0
  53. package/src/common/types.mts +31 -0
  54. package/src/index.mts +28 -8
  55. package/src/mutation/index.mts +3 -0
  56. package/src/mutation/key-creator.mts +64 -0
  57. package/src/{make-mutation.mts → mutation/make-hook.mts} +19 -8
  58. package/src/mutation/types.mts +106 -0
  59. package/src/query/index.mts +4 -0
  60. package/src/{utils/query-key-creator.mts → query/key-creator.mts} +22 -48
  61. package/src/{make-infinite-query-options.mts → query/make-infinite-options.mts} +28 -14
  62. package/src/{make-query-options.mts → query/make-options.mts} +26 -25
  63. package/src/query/types.mts +163 -0
  64. package/dist/tsdown.config.d.mts +0 -3
  65. package/dist/tsdown.config.d.mts.map +0 -1
  66. package/dist/tsup.config.d.mts +0 -3
  67. package/dist/tsup.config.d.mts.map +0 -1
  68. package/dist/vitest.config.d.mts +0 -3
  69. package/dist/vitest.config.d.mts.map +0 -1
  70. package/src/types/client-endpoint-helper.mts +0 -29
  71. package/src/types/index.mts +0 -7
  72. package/src/types/mutation-args.mts +0 -10
  73. package/src/types/mutation-helpers.mts +0 -13
  74. package/src/types/query-args.mts +0 -8
  75. package/src/types/query-helpers.mts +0 -34
  76. package/src/types/query-url-params-args.mts +0 -6
  77. package/src/types.mts +0 -118
  78. package/src/utils/mutation-key.creator.mts +0 -65
@@ -8,8 +8,9 @@ import type { HttpMethod } from '@navios/builder';
8
8
  import type { InfiniteData } from '@tanstack/react-query';
9
9
  import type { NaviosZodRequest } from '@navios/builder';
10
10
  import { NoInfer as NoInfer_2 } from '@tanstack/react-query';
11
+ import { ProcessResponseFunction as ProcessResponseFunction_2 } from '../index.mjs';
11
12
  import type { QueryClient } from '@tanstack/react-query';
12
- import { QueryKeyCreatorResult as QueryKeyCreatorResult_2 } from './utils/query-key-creator.mjs';
13
+ import { QueryKeyCreatorResult as QueryKeyCreatorResult_2 } from './types.mjs';
13
14
  import { UrlHasParams } from '@navios/builder';
14
15
  import type { UrlParams } from '@navios/builder';
15
16
  import type { UseInfiniteQueryOptions } from '@tanstack/react-query';
@@ -27,29 +28,19 @@ import type { z } from 'zod/v4';
27
28
  import type { ZodObject } from 'zod/v4';
28
29
  import type { ZodType } from 'zod/v4';
29
30
 
31
+ /** @deprecated Use NaviosZodRequest from @navios/builder instead */
30
32
  declare type BaseMutationArgs<Config extends AnyEndpointConfig> = NaviosZodRequest<Config>;
31
33
  export { BaseMutationArgs }
32
34
  export { BaseMutationArgs as BaseMutationArgs_alias_1 }
35
+ export { BaseMutationArgs as BaseMutationArgs_alias_2 }
33
36
 
34
- declare interface BaseMutationParams<Config extends AnyEndpointConfig, TData = unknown, TVariables = BaseMutationArgs<Config>, TResponse = z.output<Config['responseSchema']>, TContext = unknown, UseKey extends boolean = false> extends Omit<UseMutationOptions<TData, Error, TVariables>, 'mutationKey' | 'mutationFn' | 'onSuccess' | 'onError' | 'scope'> {
35
- processResponse: ProcessResponseFunction<TData, TResponse>;
36
- /**
37
- * React hooks that will prepare the context for the mutation onSuccess and onError
38
- * callbacks. This is useful for when you want to use the context in the callbacks
39
- */
40
- useContext?: () => TContext;
41
- onSuccess?: (queryClient: QueryClient, data: TData, variables: TVariables, context: TContext) => void | Promise<void>;
42
- onError?: (queryClient: QueryClient, err: unknown, variables: TVariables, context: TContext) => void | Promise<void>;
43
- /**
44
- * If true, we will create a mutation key that can be shared across the project.
45
- */
46
- useKey?: UseKey;
47
- keyPrefix?: UseKey extends true ? UrlHasParams<Config['url']> extends true ? string[] : never : never;
48
- keySuffix?: UseKey extends true ? UrlHasParams<Config['url']> extends true ? string[] : never : never;
49
- }
37
+ /** @deprecated Use MutationParams instead */
38
+ declare type BaseMutationParams<Config extends AnyEndpointConfig, TData = unknown, TVariables = NaviosZodRequest<Config>, TResponse = z.output<Config['responseSchema']>, TContext = unknown, UseKey extends boolean = false> = MutationParams<Config, TData, TVariables, TResponse, TContext, UseKey>;
50
39
  export { BaseMutationParams }
51
40
  export { BaseMutationParams as BaseMutationParams_alias_1 }
41
+ export { BaseMutationParams as BaseMutationParams_alias_2 }
52
42
 
43
+ /** @deprecated Use QueryArgs instead */
53
44
  declare type BaseQueryArgs<Config extends AnyEndpointConfig> = (UrlHasParams<Config['url']> extends true ? {
54
45
  urlParams: UrlParams<Config['url']>;
55
46
  } : {}) & (Config['querySchema'] extends ZodObject ? {
@@ -57,58 +48,53 @@ declare type BaseQueryArgs<Config extends AnyEndpointConfig> = (UrlHasParams<Con
57
48
  } : {});
58
49
  export { BaseQueryArgs }
59
50
  export { BaseQueryArgs as BaseQueryArgs_alias_1 }
51
+ export { BaseQueryArgs as BaseQueryArgs_alias_2 }
60
52
 
61
- declare type BaseQueryParams<Config extends AnyEndpointConfig, Res = any> = {
62
- keyPrefix?: string[];
63
- keySuffix?: string[];
64
- onFail?: (err: unknown) => void;
65
- processResponse: (data: z.output<Config['responseSchema']>) => Res;
66
- };
53
+ /** @deprecated Use QueryParams instead */
54
+ declare type BaseQueryParams<Config extends AnyEndpointConfig, Res = unknown> = QueryParams<Config, Res>;
67
55
  export { BaseQueryParams }
68
56
  export { BaseQueryParams as BaseQueryParams_alias_1 }
57
+ export { BaseQueryParams as BaseQueryParams_alias_2 }
69
58
 
70
- declare interface ClientEndpointDefinition<Method = HttpMethod, Url = string, QuerySchema = unknown, Response = ZodType> {
71
- method: Method;
72
- url: Url;
73
- querySchema?: QuerySchema;
74
- responseSchema: Response;
75
- }
76
- export { ClientEndpointDefinition }
77
- export { ClientEndpointDefinition as ClientEndpointDefinition_alias_1 }
78
-
79
- declare type ClientEndpointHelper<Method extends HttpMethod = HttpMethod, Url extends string = string, RequestSchema = unknown, ResponseSchema extends z.ZodType = z.ZodType, QuerySchema = unknown> = {
80
- endpoint: ((params: Util_FlatObject<EndpointFunctionArgs<Url, QuerySchema, RequestSchema>>) => Promise<z.output<ResponseSchema>>) & {
81
- config: BaseEndpointConfig<Method, Url, QuerySchema, ResponseSchema, RequestSchema>;
82
- };
83
- };
59
+ /** @deprecated Use EndpointHelper instead */
60
+ declare type ClientEndpointHelper<Method extends HttpMethod = HttpMethod, Url extends string = string, RequestSchema = unknown, ResponseSchema extends z.ZodType = z.ZodType, QuerySchema = unknown> = EndpointHelper<Method, Url, RequestSchema, ResponseSchema, QuerySchema>;
84
61
  export { ClientEndpointHelper }
85
62
  export { ClientEndpointHelper as ClientEndpointHelper_alias_1 }
86
63
  export { ClientEndpointHelper as ClientEndpointHelper_alias_2 }
87
64
 
88
- declare type ClientInfiniteQueryConfig<Method = HttpMethod, Url = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, PageResult = z.output<Response>, Result = InfiniteData<PageResult>> = Required<ClientEndpointDefinition<Method, Url, QuerySchema, Response>> & {
89
- processResponse?: (data: z.output<Response>) => PageResult;
90
- select?: (data: InfiniteData<PageResult>) => Result;
91
- getNextPageParam: (lastPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema> | undefined;
92
- getPreviousPageParam?: (firstPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema>;
93
- initialPageParam?: z.input<QuerySchema>;
94
- };
95
- export { ClientInfiniteQueryConfig }
96
- export { ClientInfiniteQueryConfig as ClientInfiniteQueryConfig_alias_1 }
97
-
65
+ /**
66
+ * The main client instance interface.
67
+ * Provides methods for creating queries, infinite queries, and mutations.
68
+ */
98
69
  declare interface ClientInstance {
99
70
  query<Method extends 'GET' | 'HEAD' | 'OPTIONS' = 'GET', Url extends string = string, Response extends ZodType = ZodType, Result = z.output<Response>>(config: {
100
71
  method: Method;
101
72
  url: Url;
102
73
  responseSchema: Response;
103
74
  processResponse?: (data: z.output<Response>) => Result;
104
- }): ((params: Util_FlatObject<ClientQueryArgs<Url, undefined>>) => UseSuspenseQueryOptions<Result, Error, Result, DataTag<Split<Url, '/'>, Result, Error>>) & QueryHelpers<Url, undefined, Result> & ClientEndpointHelper<Method, Url, undefined, Response>;
75
+ }): ((params: Util_FlatObject<QueryArgs<Url, undefined>>) => UseSuspenseQueryOptions<Result, Error, Result, DataTag<Split<Url, '/'>, Result, Error>>) & QueryHelpers<Url, undefined, Result> & EndpointHelper<Method, Url, undefined, Response>;
105
76
  query<Method extends 'GET' | 'HEAD' | 'OPTIONS' = 'GET', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, Result = z.output<Response>>(config: {
106
77
  method: Method;
107
78
  url: Url;
108
79
  querySchema: QuerySchema;
109
80
  responseSchema: Response;
110
81
  processResponse?: (data: z.output<Response>) => Result;
111
- }): ((params: Util_FlatObject<ClientQueryArgs<Url, QuerySchema>>) => UseSuspenseQueryOptions<Result, Error, Result, DataTag<Split<Url, '/'>, Result, Error>>) & QueryHelpers<Url, QuerySchema, Result> & ClientEndpointHelper<Method, Url, undefined, Response, QuerySchema>;
82
+ }): ((params: Util_FlatObject<QueryArgs<Url, QuerySchema>>) => UseSuspenseQueryOptions<Result, Error, Result, DataTag<Split<Url, '/'>, Result, Error>>) & QueryHelpers<Url, QuerySchema, Result> & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
83
+ query<Method extends 'POST' = 'POST', Url extends string = string, RequestSchema extends ZodType = ZodType, Response extends ZodType = ZodType, Result = z.output<Response>>(config: {
84
+ method: Method;
85
+ url: Url;
86
+ requestSchema: RequestSchema;
87
+ responseSchema: Response;
88
+ processResponse?: (data: z.output<Response>) => Result;
89
+ }): ((params: Util_FlatObject<QueryArgs<Url, undefined, RequestSchema>>) => UseSuspenseQueryOptions<Result, Error, Result, DataTag<Split<Url, '/'>, Result, Error>>) & QueryHelpers<Url, undefined, Result, false, RequestSchema> & EndpointHelper<Method, Url, RequestSchema, Response>;
90
+ query<Method extends 'POST' = 'POST', Url extends string = string, QuerySchema extends ZodObject = ZodObject, RequestSchema extends ZodType = ZodType, Response extends ZodType = ZodType, Result = z.output<Response>>(config: {
91
+ method: Method;
92
+ url: Url;
93
+ querySchema: QuerySchema;
94
+ requestSchema: RequestSchema;
95
+ responseSchema: Response;
96
+ processResponse?: (data: z.output<Response>) => Result;
97
+ }): ((params: Util_FlatObject<QueryArgs<Url, QuerySchema, RequestSchema>>) => UseSuspenseQueryOptions<Result, Error, Result, DataTag<Split<Url, '/'>, Result, Error>>) & QueryHelpers<Url, QuerySchema, Result, false, RequestSchema> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
112
98
  infiniteQuery<Method extends 'GET' | 'HEAD' | 'OPTIONS' = 'GET', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, PageResult = z.output<Response>, Result = InfiniteData<PageResult>>(config: {
113
99
  method: Method;
114
100
  url: Url;
@@ -117,7 +103,17 @@ declare interface ClientInstance {
117
103
  processResponse?: (data: z.output<Response>) => PageResult;
118
104
  getNextPageParam: (lastPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema> | undefined;
119
105
  getPreviousPageParam?: (firstPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema>;
120
- }): ((params: Util_FlatObject<ClientQueryArgs<Url, QuerySchema>>) => UseSuspenseInfiniteQueryOptions<PageResult, Error, Result, DataTag<Split<Url, '/'>, PageResult, Error>, z.output<QuerySchema>>) & QueryHelpers<Url, QuerySchema, PageResult, true> & ClientEndpointHelper<Method, Url, undefined, Response, QuerySchema>;
106
+ }): ((params: Util_FlatObject<QueryArgs<Url, QuerySchema>>) => UseSuspenseInfiniteQueryOptions<PageResult, Error, Result, DataTag<Split<Url, '/'>, PageResult, Error>, z.output<QuerySchema>>) & QueryHelpers<Url, QuerySchema, PageResult, true> & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
107
+ infiniteQuery<Method extends 'POST' = 'POST', Url extends string = string, QuerySchema extends ZodObject = ZodObject, RequestSchema extends ZodType = ZodType, Response extends ZodType = ZodType, PageResult = z.output<Response>, Result = InfiniteData<PageResult>>(config: {
108
+ method: Method;
109
+ url: Url;
110
+ querySchema: QuerySchema;
111
+ requestSchema: RequestSchema;
112
+ responseSchema: Response;
113
+ processResponse?: (data: z.output<Response>) => PageResult;
114
+ getNextPageParam: (lastPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema> | undefined;
115
+ getPreviousPageParam?: (firstPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema>;
116
+ }): ((params: Util_FlatObject<QueryArgs<Url, QuerySchema, RequestSchema>>) => UseSuspenseInfiniteQueryOptions<PageResult, Error, Result, DataTag<Split<Url, '/'>, PageResult, Error>, z.output<QuerySchema>>) & QueryHelpers<Url, QuerySchema, PageResult, true, RequestSchema> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
121
117
  mutation<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown, UseKey extends true = true>(config: {
122
118
  method: Method;
123
119
  url: Url;
@@ -127,11 +123,11 @@ declare interface ClientInstance {
127
123
  responseSchema: Response;
128
124
  processResponse: ProcessResponseFunction<Result, ReqResult>;
129
125
  useContext?: () => Context;
130
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<ClientMutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
131
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<ClientMutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
126
+ onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
127
+ onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
132
128
  }): ((params: UrlHasParams<Url> extends true ? {
133
129
  urlParams: UrlParams<Url>;
134
- } : {}) => UseMutationResult<Result, Error, ClientMutationArgs<Url, RequestSchema, QuerySchema>>) & MutationHelpers<Url, Result> & ClientEndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
130
+ } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
135
131
  mutation<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown>(config: {
136
132
  method: Method;
137
133
  url: Url;
@@ -140,9 +136,9 @@ declare interface ClientInstance {
140
136
  responseSchema: Response;
141
137
  processResponse: ProcessResponseFunction<Result, ReqResult>;
142
138
  useContext?: () => Context;
143
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<ClientMutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
144
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<ClientMutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
145
- }): (() => UseMutationResult<Result, Error, ClientMutationArgs<Url, RequestSchema, QuerySchema>>) & ClientEndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
139
+ onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
140
+ onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
141
+ }): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
146
142
  mutation<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown>(config: {
147
143
  method: Method;
148
144
  url: Url;
@@ -150,9 +146,9 @@ declare interface ClientInstance {
150
146
  responseSchema: Response;
151
147
  processResponse: ProcessResponseFunction<Result, ReqResult>;
152
148
  useContext?: () => Context;
153
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<ClientMutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
154
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<ClientMutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
155
- }): (() => UseMutationResult<Result, Error, ClientMutationArgs<Url, RequestSchema, undefined>>) & MutationHelpers<Url, Result> & ClientEndpointHelper<Method, Url, RequestSchema, Response>;
149
+ onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
150
+ onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
151
+ }): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response>;
156
152
  mutation<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown, UseKey extends true = true>(config: {
157
153
  method: Method;
158
154
  url: Url;
@@ -161,9 +157,9 @@ declare interface ClientInstance {
161
157
  responseSchema: Response;
162
158
  processResponse: ProcessResponseFunction<Result, ReqResult>;
163
159
  useContext?: () => Context;
164
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<ClientMutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
165
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<ClientMutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
166
- }): ((params: UrlHasParams<Url> extends true ? UrlParams<Url> : {}) => UseMutationResult<Result, Error, ClientMutationArgs<Url, RequestSchema, undefined>>) & MutationHelpers<Url, Result> & ClientEndpointHelper<Method, Url, RequestSchema, Response>;
160
+ onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
161
+ 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>;
167
163
  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: {
168
164
  method: Method;
169
165
  url: Url;
@@ -172,9 +168,9 @@ declare interface ClientInstance {
172
168
  responseSchema: Response;
173
169
  processResponse: ProcessResponseFunction<Result, ReqResult>;
174
170
  useContext?: () => Context;
175
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<ClientMutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
176
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<ClientMutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
177
- }): ((params: UrlHasParams<Url> extends true ? UrlParams<Url> : {}) => UseMutationResult<Result, Error, ClientMutationArgs<Url, undefined, QuerySchema>>) & MutationHelpers<Url, Result> & ClientEndpointHelper<Method, Url, undefined, Response, QuerySchema>;
171
+ onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
172
+ 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>;
178
174
  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: {
179
175
  method: Method;
180
176
  url: Url;
@@ -182,9 +178,9 @@ declare interface ClientInstance {
182
178
  responseSchema: Response;
183
179
  processResponse: ProcessResponseFunction<Result, ReqResult>;
184
180
  useContext?: () => Context;
185
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<ClientMutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
186
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<ClientMutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
187
- }): (() => UseMutationResult<Result, Error, ClientMutationArgs<Url, undefined, QuerySchema>>) & ClientEndpointHelper<Method, Url, undefined, Response, QuerySchema>;
181
+ onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
182
+ onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
183
+ }): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, QuerySchema>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
188
184
  mutation<Method extends 'DELETE' = 'DELETE', Url extends string = string, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown, UseKey extends true = true>(config: {
189
185
  method: Method;
190
186
  url: Url;
@@ -192,137 +188,164 @@ declare interface ClientInstance {
192
188
  responseSchema: Response;
193
189
  processResponse: ProcessResponseFunction<Result, ReqResult>;
194
190
  useContext?: () => Context;
195
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<ClientMutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
196
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<ClientMutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
197
- }): ((params: UrlHasParams<Url> extends true ? UrlParams<Url> : {}) => UseMutationResult<Result, Error, ClientMutationArgs<Url, undefined, undefined>>) & MutationHelpers<Url, Result> & ClientEndpointHelper<Method, Url, undefined, Response>;
191
+ onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
192
+ 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
194
  mutation<Method extends 'DELETE' = 'DELETE', Url extends string = string, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown>(config: {
199
195
  method: Method;
200
196
  url: Url;
201
197
  responseSchema: Response;
202
198
  processResponse: ProcessResponseFunction<Result, ReqResult>;
203
199
  useContext?: () => Context;
204
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<ClientMutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
205
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<ClientMutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
206
- }): (() => UseMutationResult<Result, Error, ClientMutationArgs<Url, undefined, undefined>>) & ClientEndpointHelper<Method, Url, undefined, Response>;
207
- queryFromEndpoint<Method extends 'GET' | 'HEAD' | 'OPTIONS' = 'GET', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, Result = z.output<Response>>(endpoint: any & {
200
+ onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
201
+ onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
202
+ }): (() => UseMutationResult<Result, Error, MutationArgs<Url, undefined, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, undefined, Response>;
203
+ queryFromEndpoint<Method extends 'GET' | 'HEAD' | 'OPTIONS' = 'GET', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, Result = z.output<Response>>(endpoint: {
208
204
  config: BaseEndpointConfig<Method, Url, QuerySchema, Response>;
209
205
  }, options?: {
210
206
  processResponse?: (data: z.output<Response>) => Result;
211
- }): (params: UrlHasParams<Url> extends true ? {
212
- urlParams: UrlParams<Url>;
213
- } : {}) => UseSuspenseQueryOptions<Result, Error, Result, DataTag<Split<Url, '/'>, Result, Error>> & QueryHelpers<Url, QuerySchema, Result>;
214
- queryFromEndpoint<Method extends 'GET' | 'HEAD' | 'OPTIONS' = 'GET', Url extends string = string, Response extends ZodType = ZodType, Result = z.output<Response>>(endpoint: any & {
207
+ }): (params: Util_FlatObject<QueryArgs<Url, QuerySchema>>) => UseSuspenseQueryOptions<Result, Error, Result, DataTag<Split<Url, '/'>, Result, Error>> & QueryHelpers<Url, QuerySchema, Result>;
208
+ queryFromEndpoint<Method extends 'GET' | 'HEAD' | 'OPTIONS' = 'GET', Url extends string = string, Response extends ZodType = ZodType, Result = z.output<Response>>(endpoint: {
215
209
  config: BaseEndpointConfig<Method, Url, undefined, Response>;
216
210
  }, options?: {
217
211
  processResponse?: (data: z.output<Response>) => Result;
218
- }): ((params: UrlHasParams<Url> extends true ? {
219
- urlParams: UrlParams<Url>;
220
- } : {}) => UseSuspenseQueryOptions<Result, Error, Result, DataTag<Split<Url, '/'>, Result, Error>>) & QueryHelpers<Url, undefined, Result>;
221
- infiniteQueryFromEndpoint<Method extends 'GET' | 'HEAD' | 'OPTIONS' = 'GET', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, PageResult = z.output<Response>, Result = InfiniteData<PageResult>>(endpoint: any & {
212
+ }): ((params: Util_FlatObject<QueryArgs<Url, undefined>>) => UseSuspenseQueryOptions<Result, Error, Result, DataTag<Split<Url, '/'>, Result, Error>>) & QueryHelpers<Url, undefined, Result>;
213
+ infiniteQueryFromEndpoint<Method extends 'GET' | 'HEAD' | 'OPTIONS' = 'GET', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, PageResult = z.output<Response>, Result = InfiniteData<PageResult>>(endpoint: {
222
214
  config: BaseEndpointConfig<Method, Url, QuerySchema, Response>;
223
215
  }, options: {
224
216
  processResponse?: (data: z.output<Response>) => PageResult;
225
217
  getNextPageParam: (lastPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema> | undefined;
226
218
  getPreviousPageParam?: (firstPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema>;
227
- }): ((params: UrlHasParams<Url> extends true ? {
228
- urlParams: UrlParams<Url>;
229
- } : {}) => UseSuspenseInfiniteQueryOptions<PageResult, Error, Result, DataTag<Split<Url, '/'>, PageResult, Error>, z.output<QuerySchema>>) & QueryHelpers<Url, QuerySchema, PageResult, true>;
230
- mutationFromEndpoint<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown, UseKey extends true = true>(endpoint: any & {
219
+ }): ((params: Util_FlatObject<QueryArgs<Url, QuerySchema>>) => UseSuspenseInfiniteQueryOptions<PageResult, Error, Result, DataTag<Split<Url, '/'>, PageResult, Error>, z.output<QuerySchema>>) & QueryHelpers<Url, QuerySchema, PageResult, true>;
220
+ mutationFromEndpoint<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown, UseKey extends true = true>(endpoint: {
231
221
  config: BaseEndpointConfig<Method, Url, QuerySchema, Response, RequestSchema>;
232
222
  }, mutationOptions: {
233
223
  processResponse: ProcessResponseFunction<Result, ReqResult>;
234
224
  useKey: UseKey;
235
225
  useContext?: () => Context;
236
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<ClientMutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
237
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<ClientMutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
238
- }): ((params: UrlHasParams<Url> extends true ? UrlParams<Url> : {}) => UseMutationResult<Result, Error, ClientMutationArgs<Url, RequestSchema, QuerySchema>>) & MutationHelpers<Url, Result> & ClientEndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
239
- 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: any & {
226
+ onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
227
+ 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>;
229
+ 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: {
240
230
  config: BaseEndpointConfig<Method, Url, undefined, Response, RequestSchema>;
241
231
  }, mutationOptions: {
242
232
  processResponse: ProcessResponseFunction<Result, ReqResult>;
243
233
  useKey: UseKey;
244
234
  useContext?: () => Context;
245
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<ClientMutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
246
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<ClientMutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
247
- }): ((params: UrlHasParams<Url> extends true ? UrlParams<Url> : {}) => UseMutationResult<Result, Error, ClientMutationArgs<Url, RequestSchema, undefined>>) & MutationHelpers<Url, Result> & ClientEndpointHelper<Method, Url, RequestSchema, Response, undefined>;
248
- 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: any & {
235
+ onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
236
+ 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>;
238
+ 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: {
249
239
  config: BaseEndpointConfig<Method, Url, QuerySchema, Response, RequestSchema>;
250
240
  }, mutationOptions: {
251
241
  processResponse: ProcessResponseFunction<Result, ReqResult>;
252
242
  useContext?: () => Context;
253
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<ClientMutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
254
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<ClientMutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
255
- }): (() => UseMutationResult<Result, Error, ClientMutationArgs<Url, RequestSchema, QuerySchema>>) & ClientEndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
256
- 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: any & {
243
+ onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
244
+ 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>;
246
+ 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: {
257
247
  config: BaseEndpointConfig<Method, Url, undefined, Response, RequestSchema>;
258
248
  }, mutationOptions: {
259
249
  processResponse: ProcessResponseFunction<Result, ReqResult>;
260
250
  useContext?: () => Context;
261
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<ClientMutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
262
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<ClientMutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
263
- }): (() => UseMutationResult<Result, Error, ClientMutationArgs<Url, RequestSchema, undefined>>) & ClientEndpointHelper<Method, Url, RequestSchema, Response, undefined>;
264
- 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: any & {
251
+ onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
252
+ 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>;
254
+ 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: {
265
255
  config: BaseEndpointConfig<Method, Url, QuerySchema, Response>;
266
256
  }, mutationOptions: {
267
257
  processResponse: ProcessResponseFunction<Result, ReqResult>;
268
258
  useKey: UseKey;
269
259
  useContext?: () => Context;
270
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<ClientMutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
271
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<ClientMutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
272
- }): ((params: UrlHasParams<Url> extends true ? UrlParams<Url> : {}) => UseMutationResult<Result, Error, ClientMutationArgs<Url, undefined, QuerySchema>>) & MutationHelpers<Url, Result> & ClientEndpointHelper<Method, Url, undefined, Response, QuerySchema>;
273
- 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: any & {
260
+ onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
261
+ 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>;
263
+ 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: {
274
264
  config: BaseEndpointConfig<Method, Url, undefined, Response>;
275
265
  }, mutationOptions: {
276
266
  processResponse: ProcessResponseFunction<Result, ReqResult>;
277
267
  useKey: UseKey;
278
268
  useContext?: () => Context;
279
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<ClientMutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
280
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<ClientMutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
281
- }): ((params: UrlHasParams<Url> extends true ? UrlParams<Url> : {}) => UseMutationResult<Result, Error, ClientMutationArgs<Url, undefined, undefined>>) & MutationHelpers<Url, Result> & ClientEndpointHelper<Method, Url, undefined, Response, undefined>;
282
- 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: any & {
269
+ onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
270
+ 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>;
272
+ 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: {
283
273
  config: BaseEndpointConfig<Method, Url, QuerySchema, Response>;
284
274
  }, mutationOptions: {
285
275
  processResponse: ProcessResponseFunction<Result, ReqResult>;
286
276
  useContext?: () => Context;
287
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<ClientMutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
288
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<ClientMutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
289
- }): (() => UseMutationResult<Result, Error, ClientMutationArgs<Url, undefined, QuerySchema>>) & ClientEndpointHelper<Method, Url, undefined, Response, QuerySchema>;
290
- mutationFromEndpoint<Method extends 'DELETE' = 'DELETE', Url extends string = string, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown>(endpoint: any & {
277
+ onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
278
+ 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>;
280
+ mutationFromEndpoint<Method extends 'DELETE' = 'DELETE', Url extends string = string, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown>(endpoint: {
291
281
  config: BaseEndpointConfig<Method, Url, undefined, Response>;
292
282
  }, mutationOptions: {
293
283
  processResponse: ProcessResponseFunction<Result, ReqResult>;
294
284
  useContext?: () => Context;
295
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<ClientMutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
296
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<ClientMutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
297
- }): ((params: UrlHasParams<Url> extends true ? UrlParams<Url> : {}) => UseMutationResult<Result, Error, ClientMutationArgs<Url, undefined, undefined>>) & ClientEndpointHelper<Method, Url, undefined, Response, undefined>;
285
+ onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
286
+ 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>;
288
+ 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
+ method: Method;
290
+ url: Url;
291
+ useKey: UseKey;
292
+ requestSchema: RequestSchema;
293
+ querySchema: QuerySchema;
294
+ responseSchema: Response;
295
+ processResponse: ProcessResponseFunction<Result, ReqResult>;
296
+ useContext?: () => Context;
297
+ onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
298
+ onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
299
+ }): ((params: UrlHasParams<Url> extends true ? {
300
+ urlParams: UrlParams<Url>;
301
+ } : {}) => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
302
+ multipartMutation<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown>(config: {
303
+ method: Method;
304
+ url: Url;
305
+ requestSchema: RequestSchema;
306
+ querySchema: QuerySchema;
307
+ responseSchema: Response;
308
+ processResponse: ProcessResponseFunction<Result, ReqResult>;
309
+ useContext?: () => Context;
310
+ onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
311
+ onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
312
+ }): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, QuerySchema>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
313
+ multipartMutation<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown>(config: {
314
+ method: Method;
315
+ url: Url;
316
+ requestSchema: RequestSchema;
317
+ responseSchema: Response;
318
+ processResponse: ProcessResponseFunction<Result, ReqResult>;
319
+ useContext?: () => Context;
320
+ onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
321
+ onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
322
+ }): (() => UseMutationResult<Result, Error, MutationArgs<Url, RequestSchema, undefined>>) & MutationHelpers<Url, Result> & EndpointHelper<Method, Url, RequestSchema, Response>;
323
+ multipartMutation<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown, UseKey extends true = true>(config: {
324
+ method: Method;
325
+ url: Url;
326
+ useKey: UseKey;
327
+ requestSchema: RequestSchema;
328
+ responseSchema: Response;
329
+ processResponse: ProcessResponseFunction<Result, ReqResult>;
330
+ useContext?: () => Context;
331
+ onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
332
+ 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>;
298
334
  }
299
335
  export { ClientInstance }
300
336
  export { ClientInstance as ClientInstance_alias_1 }
301
337
  export { ClientInstance as ClientInstance_alias_2 }
302
338
 
303
- declare type ClientMutationArgs<Url extends string = string, RequestSchema = unknown, QuerySchema = unknown> = (UrlHasParams<Url> extends true ? {
304
- urlParams: UrlParams<Url>;
305
- } : {}) & (RequestSchema extends ZodObject ? {
306
- data: z.input<RequestSchema>;
307
- } : {}) & (QuerySchema extends ZodObject ? {
308
- params: z.input<QuerySchema>;
309
- } : {});
339
+ /** @deprecated Use MutationArgs instead */
340
+ declare type ClientMutationArgs<Url extends string = string, RequestSchema = unknown, QuerySchema = unknown> = MutationArgs<Url, RequestSchema, QuerySchema>;
310
341
  export { ClientMutationArgs }
311
342
  export { ClientMutationArgs as ClientMutationArgs_alias_1 }
312
343
  export { ClientMutationArgs as ClientMutationArgs_alias_2 }
313
344
 
314
- declare interface ClientMutationDataConfig<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> extends ClientEndpointDefinition<Method, Url, QuerySchema, Response> {
315
- requestSchema?: RequestSchema;
316
- processResponse: ProcessResponseFunction<Result, ReqResult>;
317
- useContext?: () => Context;
318
- onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<ClientMutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
319
- onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<ClientMutationArgs<Url, RequestSchema, QuerySchema>>, context: Context) => void | Promise<void>;
320
- useKey?: UseKey;
321
- }
322
- export { ClientMutationDataConfig }
323
- export { ClientMutationDataConfig as ClientMutationDataConfig_alias_1 }
324
-
325
- declare type ClientOptions<ProcessResponse = unknown> = {
345
+ /**
346
+ * Options for creating a client instance.
347
+ */
348
+ declare type ClientOptions = {
326
349
  api: BuilderInstance;
327
350
  defaults?: {
328
351
  keyPrefix?: string[];
@@ -331,79 +354,249 @@ declare type ClientOptions<ProcessResponse = unknown> = {
331
354
  };
332
355
  export { ClientOptions }
333
356
  export { ClientOptions as ClientOptions_alias_1 }
357
+ export { ClientOptions as ClientOptions_alias_2 }
334
358
 
335
- declare type ClientQueryArgs<Url extends string = string, QuerySchema = ZodObject> = (UrlHasParams<Url> extends true ? {
336
- urlParams: UrlParams<Url>;
337
- } : {}) & (QuerySchema extends ZodObject ? {
338
- params: z.input<QuerySchema>;
339
- } : {});
359
+ /** @deprecated Use QueryArgs instead */
360
+ declare type ClientQueryArgs<Url extends string = string, QuerySchema = ZodObject, RequestSchema = undefined> = QueryArgs<Url, QuerySchema, RequestSchema>;
340
361
  export { ClientQueryArgs }
341
362
  export { ClientQueryArgs as ClientQueryArgs_alias_1 }
342
363
  export { ClientQueryArgs as ClientQueryArgs_alias_2 }
343
364
 
344
- declare interface ClientQueryConfig<Method = HttpMethod, Url = string, QuerySchema = ZodObject, Response extends ZodType = ZodType, Result = z.output<Response>> extends ClientEndpointDefinition<Method, Url, QuerySchema, Response> {
345
- processResponse?: (data: z.output<Response>) => Result;
346
- }
347
- export { ClientQueryConfig }
348
- export { ClientQueryConfig as ClientQueryConfig_alias_1 }
349
-
350
- declare type ClientQueryUrlParamsArgs<Url extends string = string> = UrlHasParams<Url> extends true ? {
351
- urlParams: UrlParams<Url>;
352
- } : {} | undefined;
365
+ /** @deprecated Use QueryUrlParamsArgs instead */
366
+ declare type ClientQueryUrlParamsArgs<Url extends string = string> = QueryUrlParamsArgs<Url>;
353
367
  export { ClientQueryUrlParamsArgs }
354
368
  export { ClientQueryUrlParamsArgs as ClientQueryUrlParamsArgs_alias_1 }
355
369
  export { ClientQueryUrlParamsArgs as ClientQueryUrlParamsArgs_alias_2 }
356
370
 
371
+ /**
372
+ * Creates a mutation key generator for a given endpoint configuration.
373
+ *
374
+ * @param config - The endpoint configuration
375
+ * @param options - Optional query parameters with a default `processResponse` function
376
+ * @returns A function that generates mutation keys
377
+ *
378
+ * @example Basic usage:
379
+ * ```typescript
380
+ * const createMutationKey = createMutationKey(endpoint.config);
381
+ * const mutationKey = createMutationKey({ urlParams: { id: 123 } });
382
+ * ```
383
+ *
384
+ * @example Advanced usage with processResponse:
385
+ * ```ts
386
+ * const createMutationKey = createMutationKey(endpoint.config, {
387
+ * processResponse: (data) => {
388
+ * if (!data.success) {
389
+ * throw new Error(data.message);
390
+ * }
391
+ * return data.data;
392
+ * },
393
+ * });
394
+ * // We create a mutation that will be shared across the project for all passed userId
395
+ * const mutationKey = createMutationKey({ urlParams: { projectId: 123, userId: 'wildcard' } });
396
+ * ```
397
+ */
398
+ declare function createMutationKey<Config extends AnyEndpointConfig, Options extends QueryParams<Config>, Url extends Config['url'] = Config['url'], HasParams extends UrlHasParams<Url> = UrlHasParams<Url>>(config: Config, options?: Options): (params: HasParams extends true ? {
399
+ urlParams: UrlParams<Url>;
400
+ } : {}) => Options['processResponse'] extends (...args: unknown[]) => infer Result ? DataTag<[Config['url']], Result, Error> : never;
401
+ export { createMutationKey }
402
+ export { createMutationKey as createMutationKey_alias_1 }
403
+ export { createMutationKey as createMutationKey_alias_2 }
404
+
405
+ /**
406
+ * Creates a query key generator for a given endpoint configuration.
407
+ *
408
+ * The returned object provides methods to generate query keys that can be used
409
+ * with TanStack Query for caching, invalidation, and data tagging.
410
+ *
411
+ * @param config - The endpoint configuration
412
+ * @param options - Query parameters including processResponse and key prefix/suffix
413
+ * @param isInfinite - Whether this is for an infinite query
414
+ * @returns An object with methods to generate query keys
415
+ */
416
+ declare function createQueryKey<Config extends AnyEndpointConfig, Options extends QueryParams<Config>, IsInfinite extends boolean, Url extends Config['url'] = Config['url'], HasParams extends UrlHasParams<Url> = UrlHasParams<Url>>(config: Config, options: Options, _isInfinite: IsInfinite): QueryKeyCreatorResult<Config['querySchema'], Url, Options['processResponse'] extends (...args: any[]) => infer Result ? Result : never, IsInfinite, HasParams>;
417
+ export { createQueryKey }
418
+ export { createQueryKey as createQueryKey_alias_1 }
419
+ export { createQueryKey as createQueryKey_alias_2 }
420
+
421
+ /**
422
+ * Creates a client instance for making type-safe queries and mutations.
423
+ *
424
+ * @param options - Client configuration including the API builder and defaults
425
+ * @returns A client instance with query, infiniteQuery, and mutation methods
426
+ *
427
+ * @example
428
+ * ```typescript
429
+ * const api = createBuilder({ baseUrl: '/api' });
430
+ * const client = declareClient({ api });
431
+ *
432
+ * const getUser = client.query({
433
+ * method: 'GET',
434
+ * url: '/users/$id',
435
+ * responseSchema: UserSchema,
436
+ * });
437
+ *
438
+ * // In a component
439
+ * const { data } = useSuspenseQuery(getUser({ urlParams: { id: '123' } }));
440
+ * ```
441
+ */
357
442
  declare function declareClient<Options extends ClientOptions>({ api, defaults, }: Options): ClientInstance;
358
443
  export { declareClient }
359
444
  export { declareClient as declareClient_alias_1 }
445
+ export { declareClient as declareClient_alias_2 }
446
+
447
+ /**
448
+ * Helper type that attaches the endpoint to query/mutation results.
449
+ */
450
+ declare type EndpointHelper<Method extends HttpMethod = HttpMethod, Url extends string = string, RequestSchema = unknown, ResponseSchema extends z.ZodType = z.ZodType, QuerySchema = unknown> = {
451
+ endpoint: ((params: Util_FlatObject<EndpointFunctionArgs<Url, QuerySchema, RequestSchema>>) => Promise<z.output<ResponseSchema>>) & {
452
+ config: BaseEndpointConfig<Method, Url, QuerySchema, ResponseSchema, RequestSchema>;
453
+ };
454
+ };
455
+ export { EndpointHelper }
456
+ export { EndpointHelper as EndpointHelper_alias_1 }
457
+ export { EndpointHelper as EndpointHelper_alias_2 }
360
458
 
459
+ /**
460
+ * Configuration for declaring an infinite query endpoint.
461
+ */
462
+ declare type InfiniteQueryConfig<Method = HttpMethod, Url = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, PageResult = z.output<Response>, Result = InfiniteData<PageResult>, RequestSchema = unknown> = {
463
+ method: Method;
464
+ url: Url;
465
+ querySchema: QuerySchema;
466
+ responseSchema: Response;
467
+ requestSchema?: RequestSchema;
468
+ processResponse?: (data: z.output<Response>) => PageResult;
469
+ select?: (data: InfiniteData<PageResult>) => Result;
470
+ getNextPageParam: (lastPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema> | undefined;
471
+ getPreviousPageParam?: (firstPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema>;
472
+ initialPageParam?: z.input<QuerySchema>;
473
+ };
474
+ export { InfiniteQueryConfig }
475
+ export { InfiniteQueryConfig as InfiniteQueryConfig_alias_1 }
476
+ export { InfiniteQueryConfig as InfiniteQueryConfig_alias_2 }
477
+
478
+ /**
479
+ * Options for infinite query configuration.
480
+ */
361
481
  declare type InfiniteQueryOptions<Config extends BaseEndpointConfig<HttpMethod, string, ZodObject>, Res = any> = {
362
482
  keyPrefix?: string[];
363
483
  keySuffix?: string[];
364
484
  processResponse: (data: z.infer<Config['responseSchema']>) => Res;
365
485
  onFail?: (err: unknown) => void;
366
486
  getNextPageParam: (lastPage: Res, allPages: Res[], lastPageParam: z.infer<Config['querySchema']> | undefined, allPageParams: z.infer<Config['querySchema']>[] | undefined) => z.input<Config['querySchema']> | z.infer<Config['querySchema']> | undefined;
487
+ getPreviousPageParam?: (firstPage: Res, allPages: Res[], lastPageParam: z.infer<Config['querySchema']> | undefined, allPageParams: z.infer<Config['querySchema']>[] | undefined) => z.input<Config['querySchema']>;
367
488
  initialPageParam?: z.input<Config['querySchema']> | z.infer<Config['querySchema']>;
368
489
  };
369
490
  export { InfiniteQueryOptions }
370
491
  export { InfiniteQueryOptions as InfiniteQueryOptions_alias_1 }
492
+ export { InfiniteQueryOptions as InfiniteQueryOptions_alias_2 }
371
493
 
494
+ /**
495
+ * Creates infinite query options for a given endpoint.
496
+ *
497
+ * Returns a function that generates TanStack Query infinite options when called with params.
498
+ * The returned function also has helper methods attached (use, useSuspense, invalidate, etc.)
499
+ *
500
+ * @param endpoint - The navios endpoint to create infinite query options for
501
+ * @param options - Infinite query configuration including processResponse and pagination params
502
+ * @param baseQuery - Optional base query options to merge
503
+ * @returns A function that generates infinite query options with attached helpers
504
+ */
372
505
  declare function makeInfiniteQueryOptions<Config extends AnyEndpointConfig, Options extends InfiniteQueryOptions<Config>, BaseQuery extends Omit<UseInfiniteQueryOptions<ReturnType<Options['processResponse']>, Error, any>, 'queryKey' | 'queryFn' | 'getNextPageParam' | 'initialPageParam' | 'placeholderData' | 'throwOnError'>>(endpoint: AbstractEndpoint<Config>, options: Options, baseQuery?: BaseQuery): {
373
- (params: ClientQueryArgs): Options["processResponse"] extends (...args: any[]) => infer Result ? UseSuspenseInfiniteQueryOptions<Result, Error, BaseQuery["select"] extends (...args: any[]) => infer T ? T : InfiniteData<Result>> : never;
506
+ (params: QueryArgs<Config["url"], Config["querySchema"]>): Options["processResponse"] extends (...args: any[]) => infer Result ? UseSuspenseInfiniteQueryOptions<Result, Error, BaseQuery["select"] extends (...args: any[]) => infer T ? T : InfiniteData<Result>> : never;
374
507
  queryKey: QueryKeyCreatorResult_2<Config["querySchema"], Config["url"], Options["processResponse"] extends (...args: any[]) => infer Result ? Result : never, true, UrlHasParams<Config["url"]>>;
375
- use(params: ClientQueryArgs): UseInfiniteQueryResult<BaseQuery["select"] extends (...args: any[]) => infer T ? T : InfiniteData<unknown, unknown>, Error>;
376
- useSuspense(params: ClientQueryArgs): UseSuspenseInfiniteQueryResult<BaseQuery["select"] extends (...args: any[]) => infer T ? T : InfiniteData<unknown, unknown>, Error>;
377
- invalidate(queryClient: QueryClient, params: ClientQueryArgs): Promise<void>;
378
- invalidateAll(queryClient: QueryClient, params: ClientQueryArgs): Promise<void>;
508
+ use(params: QueryArgs<Config["url"], Config["querySchema"]>): UseInfiniteQueryResult<BaseQuery["select"] extends (...args: any[]) => infer T ? T : InfiniteData<unknown, unknown>, Error>;
509
+ useSuspense(params: QueryArgs<Config["url"], Config["querySchema"]>): UseSuspenseInfiniteQueryResult<BaseQuery["select"] extends (...args: any[]) => infer T ? T : InfiniteData<unknown, unknown>, Error>;
510
+ invalidate(queryClient: QueryClient, params: QueryArgs<Config["url"], Config["querySchema"]>): Promise<void>;
511
+ invalidateAll(queryClient: QueryClient, params: QueryArgs<Config["url"], Config["querySchema"]>): Promise<void>;
379
512
  };
380
513
  export { makeInfiniteQueryOptions }
381
514
  export { makeInfiniteQueryOptions as makeInfiniteQueryOptions_alias_1 }
515
+ export { makeInfiniteQueryOptions as makeInfiniteQueryOptions_alias_2 }
382
516
 
383
- declare function makeMutation<Config extends AnyEndpointConfig, TData = unknown, TVariables extends BaseMutationArgs<Config> = BaseMutationArgs<Config>, TResponse = z.output<Config['responseSchema']>, TContext = unknown, UseKey extends boolean = false>(endpoint: AbstractEndpoint<Config>, options: BaseMutationParams<Config, TData, TVariables, TResponse, TContext, UseKey>): {
384
- (keyParams: UseKey extends true ? UrlHasParams<Config["url"]> extends true ? UrlParams<Config["url"]> : never : never): UseMutationResult<TData, Error, BaseMutationArgs<Config>>;
517
+ /**
518
+ * Creates a mutation hook for a given endpoint.
519
+ *
520
+ * Returns a function that when called returns a TanStack Query mutation result.
521
+ * The returned function also has helper methods attached (mutationKey, useIsMutating).
522
+ *
523
+ * @param endpoint - The navios endpoint to create a mutation hook for
524
+ * @param options - Mutation configuration including processResponse and callbacks
525
+ * @returns A hook function that returns mutation result with attached helpers
526
+ */
527
+ 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>): {
528
+ (keyParams: UseKey extends true ? UrlHasParams<Config["url"]> extends true ? UrlParams<Config["url"]> : never : never): UseMutationResult<TData, Error, NaviosZodRequest<Config>>;
385
529
  useIsMutating(keyParams: UseKey extends true ? UrlHasParams<Config["url"]> extends true ? UrlParams<Config["url"]> : never : never): boolean;
386
530
  mutationKey: (params: UrlHasParams<Config["url"]> extends infer T ? T extends UrlHasParams<Config["url"]> ? T extends true ? {
387
531
  urlParams: UrlParams<Config["url"]>;
388
- } : {} : never : never) => [Config["url"]] & {
389
- [dataTagSymbol]: TData | Promise<TData>;
532
+ } : {} : never : never) => ProcessResponseFunction_2<TData, TResponse> extends (...args: unknown[]) => infer Result ? [Config["url"]] & {
533
+ [dataTagSymbol]: Result;
390
534
  [dataTagErrorSymbol]: Error;
391
- };
535
+ } : never;
392
536
  };
393
537
  export { makeMutation }
394
538
  export { makeMutation as makeMutation_alias_1 }
539
+ export { makeMutation as makeMutation_alias_2 }
395
540
 
396
- declare function makeQueryOptions<Config extends AnyEndpointConfig, Options extends BaseQueryParams<Config>, BaseQuery extends Omit<UseQueryOptions<ReturnType<Options['processResponse']>, Error, any>, 'queryKey' | 'queryFn' | 'getNextPageParam' | 'initialPageParam' | 'enabled' | 'throwOnError' | 'placeholderData'>>(endpoint: AbstractEndpoint<Config>, options: Options, baseQuery?: BaseQuery): {
397
- (params: BaseQueryArgs<Config>): Options["processResponse"] extends (...args: any[]) => infer Result ? UseSuspenseQueryOptions<Result, Error, BaseQuery["select"] extends (...args: any[]) => infer T ? T : Result, DataTag<Split_3<Config["url"], "/">, Result, Error>> : never;
541
+ /**
542
+ * Creates query options for a given endpoint.
543
+ *
544
+ * Returns a function that generates TanStack Query options when called with params.
545
+ * The returned function also has helper methods attached (use, useSuspense, invalidate, etc.)
546
+ *
547
+ * @param endpoint - The navios endpoint to create query options for
548
+ * @param options - Query configuration including processResponse
549
+ * @param baseQuery - Optional base query options to merge
550
+ * @returns A function that generates query options with attached helpers
551
+ */
552
+ declare function makeQueryOptions<Config extends AnyEndpointConfig, Options extends QueryParams<Config>, BaseQuery extends Omit<UseQueryOptions<ReturnType<Options['processResponse']>, Error, any>, 'queryKey' | 'queryFn' | 'getNextPageParam' | 'initialPageParam' | 'enabled' | 'throwOnError' | 'placeholderData'>>(endpoint: AbstractEndpoint<Config>, options: Options, baseQuery?: BaseQuery): {
553
+ (params: QueryArgs<Config["url"], Config["querySchema"]>): Options["processResponse"] extends (...args: any[]) => infer Result ? UseSuspenseQueryOptions<Result, Error, BaseQuery["select"] extends (...args: any[]) => infer T ? T : Result, DataTag<Split<Config["url"], "/">, Result, Error>> : never;
398
554
  queryKey: QueryKeyCreatorResult_2<Config["querySchema"], Config["url"], Options["processResponse"] extends (...args: any[]) => infer Result ? Result : never, false, UrlHasParams<Config["url"]>>;
399
- use(params: ClientQueryArgs): UseQueryResult<NoInfer_2<BaseQuery["select"] extends (...args: any[]) => infer T ? T : unknown>, Error>;
400
- useSuspense(params: ClientQueryArgs): UseSuspenseQueryResult<BaseQuery["select"] extends (...args: any[]) => infer T ? T : unknown, Error>;
401
- invalidate(queryClient: QueryClient, params: ClientQueryArgs): Promise<void>;
402
- invalidateAll(queryClient: QueryClient, params: ClientQueryArgs): Promise<void>;
555
+ use(params: QueryArgs<Config["url"], Config["querySchema"]>): UseQueryResult<NoInfer_2<BaseQuery["select"] extends (...args: any[]) => infer T ? T : unknown>, Error>;
556
+ useSuspense(params: QueryArgs<Config["url"], Config["querySchema"]>): UseSuspenseQueryResult<BaseQuery["select"] extends (...args: any[]) => infer T ? T : unknown, Error>;
557
+ invalidate(queryClient: QueryClient, params: QueryArgs<Config["url"], Config["querySchema"]>): Promise<void>;
558
+ invalidateAll(queryClient: QueryClient, params: QueryArgs<Config["url"], Config["querySchema"]>): Promise<void>;
403
559
  };
404
560
  export { makeQueryOptions }
405
561
  export { makeQueryOptions as makeQueryOptions_alias_1 }
562
+ export { makeQueryOptions as makeQueryOptions_alias_2 }
563
+
564
+ /**
565
+ * Arguments for mutation functions based on URL params, request schema, and query schema.
566
+ */
567
+ declare type MutationArgs<Url extends string = string, RequestSchema = unknown, QuerySchema = unknown> = (UrlHasParams<Url> extends true ? {
568
+ urlParams: UrlParams<Url>;
569
+ } : {}) & (RequestSchema extends ZodObject ? {
570
+ data: z.input<RequestSchema>;
571
+ } : {}) & (QuerySchema extends ZodObject ? {
572
+ params: z.input<QuerySchema>;
573
+ } : {});
574
+ export { MutationArgs }
575
+ export { MutationArgs as MutationArgs_alias_1 }
576
+ export { MutationArgs as MutationArgs_alias_2 }
577
+
578
+ /**
579
+ * Configuration for declaring a mutation endpoint.
580
+ */
581
+ 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> {
582
+ method: Method;
583
+ url: Url;
584
+ querySchema?: QuerySchema;
585
+ responseSchema: Response;
586
+ requestSchema?: RequestSchema;
587
+ processResponse: ProcessResponseFunction<Result, ReqResult>;
588
+ useContext?: () => Context;
589
+ onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: MutationArgs<Url, RequestSchema, QuerySchema>, context: Context) => void | Promise<void>;
590
+ onError?: (queryClient: QueryClient, error: Error, variables: MutationArgs<Url, RequestSchema, QuerySchema>, context: Context) => void | Promise<void>;
591
+ useKey?: UseKey;
592
+ }
593
+ export { MutationConfig }
594
+ export { MutationConfig as MutationConfig_alias_1 }
595
+ export { MutationConfig as MutationConfig_alias_2 }
406
596
 
597
+ /**
598
+ * Helper methods attached to mutation hooks.
599
+ */
407
600
  declare type MutationHelpers<Url extends string, Result = unknown> = UrlHasParams<Url> extends true ? {
408
601
  mutationKey: (params: UrlParams<Url>) => DataTag<[Url], Result, Error>;
409
602
  useIsMutating: (keyParams: UrlParams<Url>) => boolean;
@@ -415,88 +608,145 @@ export { MutationHelpers }
415
608
  export { MutationHelpers as MutationHelpers_alias_1 }
416
609
  export { MutationHelpers as MutationHelpers_alias_2 }
417
610
 
611
+ /** @deprecated Use createMutationKey instead */
612
+ declare const mutationKeyCreator: typeof createMutationKey;
613
+ export { mutationKeyCreator }
614
+ export { mutationKeyCreator as mutationKeyCreator_alias_1 }
615
+ export { mutationKeyCreator as mutationKeyCreator_alias_2 }
616
+
418
617
  /**
419
- * Creates a mutation key for a given endpoint configuration and options.
420
- *
421
- * @param {config: Config } config - The endpoint object containing the configuration.
422
- * @param {Options} [options] - Optional query parameters with a default `processResponse` function that processes the response data.
423
- *
424
- * @returns {Object} An object containing the `mutationKey` function.
425
- *
426
- * The `mutationKey` function generates a mutation key based on the provided parameters:
427
- * - If the URL has parameters (`HasParams` is `true`), it expects an object with `urlParams`.
428
- * - The return type of the `mutationKey` function depends on the `processResponse` function in `options`.
429
- * If `processResponse` is defined, the return type is a `DataTag` containing the processed result and an error type.
430
- *
431
- * @example Example usage:
432
- * ```typescript
433
- * const createMutationKey = mutationKeyCreator(endpoint.config);
434
- * const mutationKey = createMutationKey({ urlParams: { id: 123 } });
435
- * ```
436
- *
437
- * @example Advanced usage:
438
- * ```ts
439
- * const createMutationKey = mutationKeyCreator(endpoint.config, {
440
- * processResponse: (data) => {
441
- * if (!data.success) {
442
- * throw new Error(data.message);
443
- * }
444
- * return data.data;
445
- * },
446
- * });
447
- * // We create a mutation that will be shared across the project for all passed userId
448
- * const mutationKey = createMutationKey({ urlParams: { projectId: 123, userId: 'wildcard' } });
618
+ * Base parameters for mutation configuration.
619
+ */
620
+ 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>;
622
+ /**
623
+ * React hooks that will prepare the context for the mutation onSuccess and onError
624
+ * callbacks. This is useful for when you want to use the context in the callbacks
449
625
  */
450
- declare function mutationKeyCreator<Config extends AnyEndpointConfig, Options extends BaseQueryParams<Config>, Url extends Config['url'] = Config['url'], HasParams extends UrlHasParams<Url> = UrlHasParams<Url>>(config: Config, options?: Options): (params: HasParams extends true ? {
451
- urlParams: UrlParams<Url>;
452
- } : {}) => Options['processResponse'] extends (...args: any[]) => infer Result ? DataTag<[Config['url']], Result, Error> : never;
453
- export { mutationKeyCreator }
454
- export { mutationKeyCreator as mutationKeyCreator_alias_1 }
455
-
456
- declare type ProcessResponseFunction<TData = unknown, TVariables = unknown> = (variables: TVariables) => Promise<TData> | TData;
457
- export { ProcessResponseFunction }
458
- export { ProcessResponseFunction as ProcessResponseFunction_alias_1 }
459
-
460
- declare type QueryHelpers<Url extends string, QuerySchema extends ZodObject | undefined = undefined, Result = undefined, IsInfinite extends boolean = false> = {
461
- queryKey: QueryKeyCreatorResult<QuerySchema, Url, Result, IsInfinite>;
462
- use: (params: Util_FlatObject<ClientQueryArgs<Url, QuerySchema>>) => UseQueryResult<Result, Error>;
463
- useSuspense: (params: Util_FlatObject<ClientQueryArgs<Url, QuerySchema>>) => UseSuspenseQueryResult<Result, Error>;
464
- invalidate: (queryClient: QueryClient, params: Util_FlatObject<ClientQueryArgs<Url, QuerySchema>>) => () => Promise<void>;
465
- invalidateAll: (queryClient: QueryClient, params: Util_FlatObject<ClientQueryUrlParamsArgs<Url>>) => () => Promise<void>;
466
- };
467
- export { QueryHelpers }
468
- export { QueryHelpers as QueryHelpers_alias_1 }
469
- export { QueryHelpers as QueryHelpers_alias_2 }
470
-
471
- declare function queryKeyCreator<Config extends AnyEndpointConfig, Options extends BaseQueryParams<Config>, IsInfinite extends boolean, Url extends Config['url'] = Config['url'], HasParams extends UrlHasParams<Url> = UrlHasParams<Url>>(config: Config, options: Options, isInfinite: IsInfinite): QueryKeyCreatorResult<Config['querySchema'], Url, Options['processResponse'] extends (...args: any[]) => infer Result ? Result : never, IsInfinite, HasParams>;
472
- export { queryKeyCreator }
473
- export { queryKeyCreator as queryKeyCreator_alias_1 }
474
-
475
- declare type QueryKeyCreatorResult<QuerySchema = undefined, Url extends string = string, Result = unknown, IsInfinite extends boolean = false, HasParams extends UrlHasParams<Url> = UrlHasParams<Url>> = {
476
- template: Split_2<Url, '/'>;
477
- dataTag: (params: (HasParams extends true ? {
478
- urlParams: UrlParams<Url>;
479
- } : {}) & (QuerySchema extends ZodObject ? {
480
- params: z.input<QuerySchema>;
481
- } : {})) => DataTag<Split_2<Url, '/'>, IsInfinite extends true ? InfiniteData<Result> : Result, Error>;
482
- filterKey: (params: HasParams extends true ? {
483
- urlParams: UrlParams<Url>;
484
- } : {}) => DataTag<Split_2<Url, '/'>, IsInfinite extends true ? InfiniteData<Result> : Result, Error>;
485
- bindToUrl: (params: (HasParams extends true ? {
486
- urlParams: UrlParams<Url>;
487
- } : {}) & (QuerySchema extends ZodObject ? {
488
- params: z.infer<QuerySchema>;
489
- } : {})) => string;
490
- };
491
- export { QueryKeyCreatorResult }
492
- export { QueryKeyCreatorResult as QueryKeyCreatorResult_alias_1 }
493
-
494
- declare type Split<S extends string, D extends string> = string extends S ? string[] : S extends '' ? [] : S extends `${infer T}${D}${infer U}` ? [T, ...Split<U, D>] : [S];
495
- export { Split }
496
- export { Split as Split_alias_1 }
497
-
498
- declare type Split_2<S extends string, D extends string> = string extends S ? string[] : S extends '' ? [] : S extends `${infer T}${D}${infer U}` ? [T, ...Split_2<U, D>] : [S];
499
-
500
- declare type Split_3<S extends string, D extends string> = string extends S ? string[] : S extends '' ? [] : S extends `${infer T}${D}${infer U}` ? [T, ...Split_3<U, D>] : [S];
501
-
502
- export { }
626
+ useContext?: () => TContext;
627
+ onSuccess?: (queryClient: QueryClient, data: TData, variables: TVariables, context: TContext) => void | Promise<void>;
628
+ onError?: (queryClient: QueryClient, err: unknown, variables: TVariables, context: TContext) => void | Promise<void>;
629
+ /**
630
+ * If true, we will create a mutation key that can be shared across the project.
631
+ */
632
+ useKey?: UseKey;
633
+ keyPrefix?: UseKey extends true ? UrlHasParams<Config['url']> extends true ? string[] : never : never;
634
+ keySuffix?: UseKey extends true ? UrlHasParams<Config['url']> extends true ? string[] : never : never;
635
+ }
636
+ export { MutationParams }
637
+ export { MutationParams as MutationParams_alias_1 }
638
+ export { MutationParams as MutationParams_alias_2 }
639
+
640
+ /**
641
+ * Function type for processing API responses before returning to the caller.
642
+ */
643
+ declare type ProcessResponseFunction<TData = unknown, TVariables = unknown> = (variables: TVariables) => Promise<TData> | TData;
644
+ export { ProcessResponseFunction }
645
+ export { ProcessResponseFunction as ProcessResponseFunction_alias_1 }
646
+ export { ProcessResponseFunction as ProcessResponseFunction_alias_2 }
647
+
648
+ /**
649
+ * Arguments for query functions based on URL params and query schema.
650
+ */
651
+ declare type QueryArgs<Url extends string = string, QuerySchema = ZodObject, RequestSchema = undefined> = (UrlHasParams<Url> extends true ? {
652
+ urlParams: UrlParams<Url>;
653
+ } : {}) & (QuerySchema extends ZodObject ? {
654
+ params: z.input<QuerySchema>;
655
+ } : {}) & (RequestSchema extends ZodType ? {
656
+ data: z.input<RequestSchema>;
657
+ } : {});
658
+ export { QueryArgs }
659
+ export { QueryArgs as QueryArgs_alias_1 }
660
+ export { QueryArgs as QueryArgs_alias_2 }
661
+
662
+ /**
663
+ * Configuration for declaring a query endpoint.
664
+ */
665
+ declare interface QueryConfig<Method = HttpMethod, Url = string, QuerySchema = ZodObject, Response extends ZodType = ZodType, Result = z.output<Response>, RequestSchema = unknown> {
666
+ method: Method;
667
+ url: Url;
668
+ querySchema?: QuerySchema;
669
+ responseSchema: Response;
670
+ requestSchema?: RequestSchema;
671
+ processResponse?: (data: z.output<Response>) => Result;
672
+ }
673
+ export { QueryConfig }
674
+ export { QueryConfig as QueryConfig_alias_1 }
675
+ export { QueryConfig as QueryConfig_alias_2 }
676
+
677
+ /**
678
+ * Helper methods attached to query options.
679
+ */
680
+ declare type QueryHelpers<Url extends string, QuerySchema extends ZodObject | undefined = undefined, Result = undefined, IsInfinite extends boolean = false, RequestSchema extends ZodType | undefined = undefined> = {
681
+ queryKey: QueryKeyCreatorResult<QuerySchema, Url, Result, IsInfinite>;
682
+ use: (params: Util_FlatObject<QueryArgs<Url, QuerySchema, RequestSchema>>) => UseQueryResult<Result, Error>;
683
+ useSuspense: (params: Util_FlatObject<QueryArgs<Url, QuerySchema, RequestSchema>>) => UseSuspenseQueryResult<Result, Error>;
684
+ invalidate: (queryClient: QueryClient, params: Util_FlatObject<QueryArgs<Url, QuerySchema, RequestSchema>>) => () => Promise<void>;
685
+ invalidateAll: (queryClient: QueryClient, params: Util_FlatObject<QueryUrlParamsArgs<Url>>) => () => Promise<void>;
686
+ };
687
+ export { QueryHelpers }
688
+ export { QueryHelpers as QueryHelpers_alias_1 }
689
+ export { QueryHelpers as QueryHelpers_alias_2 }
690
+
691
+ /** @deprecated Use createQueryKey instead */
692
+ declare const queryKeyCreator: typeof createQueryKey;
693
+ export { queryKeyCreator }
694
+ export { queryKeyCreator as queryKeyCreator_alias_1 }
695
+ export { queryKeyCreator as queryKeyCreator_alias_2 }
696
+
697
+ /**
698
+ * Result type from the query key creator function.
699
+ */
700
+ declare type QueryKeyCreatorResult<QuerySchema = undefined, Url extends string = string, Result = unknown, IsInfinite extends boolean = false, HasParams extends UrlHasParams<Url> = UrlHasParams<Url>> = {
701
+ template: Split<Url, '/'>;
702
+ dataTag: (params: (HasParams extends true ? {
703
+ urlParams: UrlParams<Url>;
704
+ } : {}) & (QuerySchema extends ZodObject ? {
705
+ params: z.input<QuerySchema>;
706
+ } : {})) => DataTag<Split<Url, '/'>, IsInfinite extends true ? InfiniteData<Result> : Result, Error>;
707
+ filterKey: (params: HasParams extends true ? {
708
+ urlParams: UrlParams<Url>;
709
+ } : {}) => DataTag<Split<Url, '/'>, IsInfinite extends true ? InfiniteData<Result> : Result, Error>;
710
+ bindToUrl: (params: (HasParams extends true ? {
711
+ urlParams: UrlParams<Url>;
712
+ } : {}) & (QuerySchema extends ZodObject ? {
713
+ params: z.infer<QuerySchema>;
714
+ } : {})) => string;
715
+ };
716
+ export { QueryKeyCreatorResult }
717
+ export { QueryKeyCreatorResult as QueryKeyCreatorResult_alias_1 }
718
+ export { QueryKeyCreatorResult as QueryKeyCreatorResult_alias_2 }
719
+
720
+ /**
721
+ * Base parameters for query configuration.
722
+ */
723
+ declare type QueryParams<Config extends AnyEndpointConfig, Res = any> = {
724
+ keyPrefix?: string[];
725
+ keySuffix?: string[];
726
+ onFail?: (err: unknown) => void;
727
+ processResponse: (data: z.output<Config['responseSchema']>) => Res;
728
+ };
729
+ export { QueryParams }
730
+ export { QueryParams as QueryParams_alias_1 }
731
+ export { QueryParams as QueryParams_alias_2 }
732
+
733
+ /**
734
+ * Arguments containing only URL params (for invalidateAll operations).
735
+ */
736
+ declare type QueryUrlParamsArgs<Url extends string = string> = UrlHasParams<Url> extends true ? {
737
+ urlParams: UrlParams<Url>;
738
+ } : {} | undefined;
739
+ export { QueryUrlParamsArgs }
740
+ export { QueryUrlParamsArgs as QueryUrlParamsArgs_alias_1 }
741
+ export { QueryUrlParamsArgs as QueryUrlParamsArgs_alias_2 }
742
+
743
+ /**
744
+ * Splits a string by a delimiter into a tuple type.
745
+ * Used for parsing URL paths into segments for query keys.
746
+ */
747
+ declare type Split<S extends string, D extends string> = string extends S ? string[] : S extends '' ? [] : S extends `${infer T}${D}${infer U}` ? [T, ...Split<U, D>] : [S];
748
+ export { Split }
749
+ export { Split as Split_alias_1 }
750
+ export { Split as Split_alias_2 }
751
+
752
+ export { }