@navios/react-query 0.6.1 → 0.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (56) hide show
  1. package/CHANGELOG.md +47 -0
  2. package/README.md +142 -41
  3. package/dist/src/client/declare-client.d.mts.map +1 -1
  4. package/dist/src/mutation/make-hook.d.mts +3 -1
  5. package/dist/src/mutation/make-hook.d.mts.map +1 -1
  6. package/dist/tsconfig.tsbuildinfo +1 -1
  7. package/lib/index.cjs +412 -0
  8. package/lib/index.cjs.map +1 -0
  9. package/lib/index.d.cts +961 -0
  10. package/lib/index.d.cts.map +1 -0
  11. package/lib/index.d.mts +961 -34
  12. package/lib/index.d.mts.map +1 -0
  13. package/lib/index.mjs +389 -350
  14. package/lib/index.mjs.map +1 -1
  15. package/package.json +8 -8
  16. package/project.json +2 -2
  17. package/src/__tests__/declare-client.spec.mts +2 -2
  18. package/src/__tests__/make-mutation.spec.mts +10 -9
  19. package/src/client/declare-client.mts +28 -6
  20. package/src/mutation/make-hook.mts +3 -11
  21. package/{tsup.config.mts → tsdown.config.mts} +4 -3
  22. package/dist/src/declare-client.d.mts +0 -31
  23. package/dist/src/declare-client.d.mts.map +0 -1
  24. package/dist/src/make-infinite-query-options.d.mts +0 -13
  25. package/dist/src/make-infinite-query-options.d.mts.map +0 -1
  26. package/dist/src/make-mutation.d.mts +0 -15
  27. package/dist/src/make-mutation.d.mts.map +0 -1
  28. package/dist/src/make-query-options.d.mts +0 -15
  29. package/dist/src/make-query-options.d.mts.map +0 -1
  30. package/dist/src/types/client-endpoint-helper.d.mts +0 -8
  31. package/dist/src/types/client-endpoint-helper.d.mts.map +0 -1
  32. package/dist/src/types/client-instance.d.mts +0 -211
  33. package/dist/src/types/client-instance.d.mts.map +0 -1
  34. package/dist/src/types/index.d.mts +0 -8
  35. package/dist/src/types/index.d.mts.map +0 -1
  36. package/dist/src/types/mutation-args.d.mts +0 -10
  37. package/dist/src/types/mutation-args.d.mts.map +0 -1
  38. package/dist/src/types/mutation-helpers.d.mts +0 -10
  39. package/dist/src/types/mutation-helpers.d.mts.map +0 -1
  40. package/dist/src/types/query-args.d.mts +0 -8
  41. package/dist/src/types/query-args.d.mts.map +0 -1
  42. package/dist/src/types/query-helpers.d.mts +0 -14
  43. package/dist/src/types/query-helpers.d.mts.map +0 -1
  44. package/dist/src/types/query-url-params-args.d.mts +0 -5
  45. package/dist/src/types/query-url-params-args.d.mts.map +0 -1
  46. package/dist/src/types.d.mts +0 -49
  47. package/dist/src/types.d.mts.map +0 -1
  48. package/dist/src/utils/mutation-key.creator.d.mts +0 -39
  49. package/dist/src/utils/mutation-key.creator.d.mts.map +0 -1
  50. package/dist/src/utils/query-key-creator.d.mts +0 -24
  51. package/dist/src/utils/query-key-creator.d.mts.map +0 -1
  52. package/lib/_tsup-dts-rollup.d.mts +0 -1097
  53. package/lib/_tsup-dts-rollup.d.ts +0 -1097
  54. package/lib/index.d.ts +0 -34
  55. package/lib/index.js +0 -375
  56. package/lib/index.js.map +0 -1
@@ -0,0 +1,961 @@
1
+ import * as _navios_builder0 from "@navios/builder";
2
+ import { AbstractEndpoint, AnyEndpointConfig, BaseEndpointConfig, BaseStreamConfig, BuilderInstance, EndpointFunctionArgs, HttpMethod, NaviosZodRequest, UrlHasParams, UrlParams, Util_FlatObject } from "@navios/builder";
3
+ import * as _tanstack_react_query1 from "@tanstack/react-query";
4
+ import { DataTag, InfiniteData, MutationFunctionContext, QueryClient, UseInfiniteQueryOptions, UseMutationOptions, UseMutationResult, UseQueryOptions, UseQueryResult, UseSuspenseInfiniteQueryOptions, UseSuspenseQueryOptions, UseSuspenseQueryResult } from "@tanstack/react-query";
5
+ import { ZodObject, ZodType, z } from "zod/v4";
6
+
7
+ //#region src/common/types.d.mts
8
+ /**
9
+ * Splits a string by a delimiter into a tuple type.
10
+ * Used for parsing URL paths into segments for query keys.
11
+ */
12
+ 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];
13
+ /**
14
+ * Function type for processing API responses before returning to the caller.
15
+ */
16
+ type ProcessResponseFunction<TData = unknown, TVariables = unknown> = (variables: TVariables) => Promise<TData> | TData;
17
+ /**
18
+ * Options for creating a client instance.
19
+ */
20
+ type ClientOptions = {
21
+ api: BuilderInstance;
22
+ defaults?: {
23
+ keyPrefix?: string[];
24
+ keySuffix?: string[];
25
+ };
26
+ };
27
+ //#endregion
28
+ //#region src/query/types.d.mts
29
+ /**
30
+ * Arguments for query functions based on URL params and query schema.
31
+ */
32
+ type QueryArgs<Url extends string = string, QuerySchema = ZodObject, RequestSchema = undefined> = (UrlHasParams<Url> extends true ? {
33
+ urlParams: UrlParams<Url>;
34
+ } : {}) & (QuerySchema extends ZodObject ? {
35
+ params: z.input<QuerySchema>;
36
+ } : {}) & (RequestSchema extends ZodType ? {
37
+ data: z.input<RequestSchema>;
38
+ } : {});
39
+ /**
40
+ * Arguments containing only URL params (for invalidateAll operations).
41
+ */
42
+ type QueryUrlParamsArgs<Url extends string = string> = UrlHasParams<Url> extends true ? {
43
+ urlParams: UrlParams<Url>;
44
+ } : {} | undefined;
45
+ /**
46
+ * Base parameters for query configuration.
47
+ */
48
+ type QueryParams<Config extends AnyEndpointConfig, Res = any> = {
49
+ keyPrefix?: string[];
50
+ keySuffix?: string[];
51
+ onFail?: (err: unknown) => void;
52
+ processResponse: (data: z.output<Config['responseSchema']>) => Res;
53
+ };
54
+ /**
55
+ * Result type from the query key creator function.
56
+ */
57
+ type QueryKeyCreatorResult<QuerySchema = undefined, Url extends string = string, Result$1 = unknown, IsInfinite extends boolean = false, HasParams extends UrlHasParams<Url> = UrlHasParams<Url>> = {
58
+ template: Split<Url, '/'>;
59
+ dataTag: (params: (HasParams extends true ? {
60
+ urlParams: UrlParams<Url>;
61
+ } : {}) & (QuerySchema extends ZodObject ? {
62
+ params: z.input<QuerySchema>;
63
+ } : {})) => DataTag<Split<Url, '/'>, IsInfinite extends true ? InfiniteData<Result$1> : Result$1, Error>;
64
+ filterKey: (params: HasParams extends true ? {
65
+ urlParams: UrlParams<Url>;
66
+ } : {}) => DataTag<Split<Url, '/'>, IsInfinite extends true ? InfiniteData<Result$1> : Result$1, Error>;
67
+ bindToUrl: (params: (HasParams extends true ? {
68
+ urlParams: UrlParams<Url>;
69
+ } : {}) & (QuerySchema extends ZodObject ? {
70
+ params: z.infer<QuerySchema>;
71
+ } : {})) => string;
72
+ };
73
+ /**
74
+ * Helper methods attached to query options.
75
+ */
76
+ type QueryHelpers<Url extends string, QuerySchema extends ZodObject | undefined = undefined, Result$1 = undefined, IsInfinite extends boolean = false, RequestSchema extends ZodType | undefined = undefined> = {
77
+ queryKey: QueryKeyCreatorResult<QuerySchema, Url, Result$1, IsInfinite>;
78
+ use: (params: Util_FlatObject<QueryArgs<Url, QuerySchema, RequestSchema>>) => UseQueryResult<Result$1, Error>;
79
+ useSuspense: (params: Util_FlatObject<QueryArgs<Url, QuerySchema, RequestSchema>>) => UseSuspenseQueryResult<Result$1, Error>;
80
+ invalidate: (queryClient: QueryClient, params: Util_FlatObject<QueryArgs<Url, QuerySchema, RequestSchema>>) => () => Promise<void>;
81
+ invalidateAll: (queryClient: QueryClient, params: Util_FlatObject<QueryUrlParamsArgs<Url>>) => () => Promise<void>;
82
+ };
83
+ /**
84
+ * Options for infinite query configuration.
85
+ */
86
+ type InfiniteQueryOptions<Config extends BaseEndpointConfig<HttpMethod, string, ZodObject>, Res = any> = {
87
+ keyPrefix?: string[];
88
+ keySuffix?: string[];
89
+ processResponse: (data: z.infer<Config['responseSchema']>) => Res;
90
+ onFail?: (err: unknown) => void;
91
+ 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;
92
+ getPreviousPageParam?: (firstPage: Res, allPages: Res[], lastPageParam: z.infer<Config['querySchema']> | undefined, allPageParams: z.infer<Config['querySchema']>[] | undefined) => z.input<Config['querySchema']>;
93
+ initialPageParam?: z.input<Config['querySchema']> | z.infer<Config['querySchema']>;
94
+ };
95
+ /** @deprecated Use QueryArgs instead */
96
+ type ClientQueryArgs<Url extends string = string, QuerySchema = ZodObject, RequestSchema = undefined> = QueryArgs<Url, QuerySchema, RequestSchema>;
97
+ /** @deprecated Use QueryUrlParamsArgs instead */
98
+ type ClientQueryUrlParamsArgs<Url extends string = string> = QueryUrlParamsArgs<Url>;
99
+ /** @deprecated Use QueryParams instead */
100
+ type BaseQueryParams<Config extends AnyEndpointConfig, Res = unknown> = QueryParams<Config, Res>;
101
+ /** @deprecated Use QueryArgs instead */
102
+ type BaseQueryArgs<Config extends AnyEndpointConfig> = (UrlHasParams<Config['url']> extends true ? {
103
+ urlParams: UrlParams<Config['url']>;
104
+ } : {}) & (Config['querySchema'] extends ZodObject ? {
105
+ params: z.input<Config['querySchema']>;
106
+ } : {});
107
+ //#endregion
108
+ //#region src/query/key-creator.d.mts
109
+ /**
110
+ * Creates a query key generator for a given endpoint configuration.
111
+ *
112
+ * The returned object provides methods to generate query keys that can be used
113
+ * with TanStack Query for caching, invalidation, and data tagging.
114
+ *
115
+ * @param config - The endpoint configuration
116
+ * @param options - Query parameters including processResponse and key prefix/suffix
117
+ * @param isInfinite - Whether this is for an infinite query
118
+ * @returns An object with methods to generate query keys
119
+ */
120
+ 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>;
121
+ /** @deprecated Use createQueryKey instead */
122
+ declare const queryKeyCreator: typeof createQueryKey;
123
+ //#endregion
124
+ //#region src/query/make-options.d.mts
125
+ /**
126
+ * Creates query options for a given endpoint.
127
+ *
128
+ * Returns a function that generates TanStack Query options when called with params.
129
+ * The returned function also has helper methods attached (use, useSuspense, invalidate, etc.)
130
+ *
131
+ * @param endpoint - The navios endpoint to create query options for
132
+ * @param options - Query configuration including processResponse
133
+ * @param baseQuery - Optional base query options to merge
134
+ * @returns A function that generates query options with attached helpers
135
+ */
136
+ 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): {
137
+ (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;
138
+ queryKey: QueryKeyCreatorResult<Config["querySchema"], Config["url"], Options["processResponse"] extends ((...args: any[]) => infer Result) ? Result : never, false, _navios_builder0.UrlHasParams<Config["url"]>>;
139
+ use(params: QueryArgs<Config["url"], Config["querySchema"]>): _tanstack_react_query1.UseQueryResult<_tanstack_react_query1.NoInfer<BaseQuery["select"] extends ((...args: any[]) => infer T) ? T : unknown>, Error>;
140
+ useSuspense(params: QueryArgs<Config["url"], Config["querySchema"]>): _tanstack_react_query1.UseSuspenseQueryResult<BaseQuery["select"] extends ((...args: any[]) => infer T) ? T : unknown, Error>;
141
+ invalidate(queryClient: QueryClient, params: QueryArgs<Config["url"], Config["querySchema"]>): Promise<void>;
142
+ invalidateAll(queryClient: QueryClient, params: QueryArgs<Config["url"], Config["querySchema"]>): Promise<void>;
143
+ };
144
+ //#endregion
145
+ //#region src/query/make-infinite-options.d.mts
146
+ /**
147
+ * Creates infinite query options for a given endpoint.
148
+ *
149
+ * Returns a function that generates TanStack Query infinite options when called with params.
150
+ * The returned function also has helper methods attached (use, useSuspense, invalidate, etc.)
151
+ *
152
+ * @param endpoint - The navios endpoint to create infinite query options for
153
+ * @param options - Infinite query configuration including processResponse and pagination params
154
+ * @param baseQuery - Optional base query options to merge
155
+ * @returns A function that generates infinite query options with attached helpers
156
+ */
157
+ 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): {
158
+ (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;
159
+ queryKey: QueryKeyCreatorResult<Config["querySchema"], Config["url"], Options["processResponse"] extends ((...args: any[]) => infer Result) ? Result : never, true, _navios_builder0.UrlHasParams<Config["url"]>>;
160
+ use(params: QueryArgs<Config["url"], Config["querySchema"]>): _tanstack_react_query1.UseInfiniteQueryResult<BaseQuery["select"] extends ((...args: any[]) => infer T) ? T : InfiniteData<unknown, unknown>, Error>;
161
+ useSuspense(params: QueryArgs<Config["url"], Config["querySchema"]>): _tanstack_react_query1.UseSuspenseInfiniteQueryResult<BaseQuery["select"] extends ((...args: any[]) => infer T) ? T : InfiniteData<unknown, unknown>, Error>;
162
+ invalidate(queryClient: QueryClient, params: QueryArgs<Config["url"], Config["querySchema"]>): Promise<void>;
163
+ invalidateAll(queryClient: QueryClient, params: QueryArgs<Config["url"], Config["querySchema"]>): Promise<void>;
164
+ };
165
+ //#endregion
166
+ //#region src/mutation/types.d.mts
167
+ /**
168
+ * Arguments for mutation functions based on URL params, request schema, and query schema.
169
+ */
170
+ type MutationArgs<Url extends string = string, RequestSchema = unknown, QuerySchema = unknown> = (UrlHasParams<Url> extends true ? {
171
+ urlParams: UrlParams<Url>;
172
+ } : {}) & (RequestSchema extends ZodObject ? {
173
+ data: z.input<RequestSchema>;
174
+ } : {}) & (QuerySchema extends ZodObject ? {
175
+ params: z.input<QuerySchema>;
176
+ } : {});
177
+ /**
178
+ * Helper methods attached to mutation hooks.
179
+ */
180
+ type MutationHelpers<Url extends string, Result$1 = unknown> = UrlHasParams<Url> extends true ? {
181
+ mutationKey: (params: UrlParams<Url>) => DataTag<[Url], Result$1, Error>;
182
+ useIsMutating: (keyParams: UrlParams<Url>) => boolean;
183
+ } : {
184
+ mutationKey: () => DataTag<[Url], Result$1, Error>;
185
+ useIsMutating: () => boolean;
186
+ };
187
+ /**
188
+ * Base parameters for mutation configuration.
189
+ */
190
+ 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'> {
191
+ processResponse?: ProcessResponseFunction<TData, TResponse>;
192
+ /**
193
+ * React hooks that will prepare the context for the mutation onSuccess and onError
194
+ * callbacks. This is useful for when you want to use the context in the callbacks
195
+ */
196
+ useContext?: () => TContext;
197
+ onSuccess?: (data: TData, variables: TVariables, context: TContext & MutationFunctionContext & {
198
+ onMutateResult: TOnMutateResult | undefined;
199
+ }) => void | Promise<void>;
200
+ onError?: (err: unknown, variables: TVariables, context: TContext & MutationFunctionContext & {
201
+ onMutateResult: TOnMutateResult | undefined;
202
+ }) => void | Promise<void>;
203
+ onMutate?: (variables: TVariables, context: TContext & MutationFunctionContext) => TOnMutateResult | Promise<TOnMutateResult>;
204
+ onSettled?: (data: TData | undefined, error: Error | null, variables: TVariables, context: TContext & MutationFunctionContext & {
205
+ onMutateResult: TOnMutateResult | undefined;
206
+ }) => void | Promise<void>;
207
+ /**
208
+ * If true, we will create a mutation key that can be shared across the project.
209
+ */
210
+ useKey?: UseKey;
211
+ keyPrefix?: UseKey extends true ? UrlHasParams<Config['url']> extends true ? string[] : never : never;
212
+ keySuffix?: UseKey extends true ? UrlHasParams<Config['url']> extends true ? string[] : never : never;
213
+ }
214
+ /** @deprecated Use MutationArgs instead */
215
+ type ClientMutationArgs<Url extends string = string, RequestSchema = unknown, QuerySchema = unknown> = MutationArgs<Url, RequestSchema, QuerySchema>;
216
+ /** @deprecated Use MutationParams instead */
217
+ 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>;
218
+ /** @deprecated Use NaviosZodRequest from @navios/builder instead */
219
+ type BaseMutationArgs<Config extends AnyEndpointConfig> = NaviosZodRequest<Config>;
220
+ //#endregion
221
+ //#region src/mutation/key-creator.d.mts
222
+ /**
223
+ * Creates a mutation key generator for a given endpoint configuration.
224
+ *
225
+ * @param config - The endpoint configuration
226
+ * @param options - Optional query parameters with a default `processResponse` function
227
+ * @returns A function that generates mutation keys
228
+ *
229
+ * @example Basic usage:
230
+ * ```typescript
231
+ * const createMutationKey = createMutationKey(endpoint.config);
232
+ * const mutationKey = createMutationKey({ urlParams: { id: 123 } });
233
+ * ```
234
+ *
235
+ * @example Advanced usage with processResponse:
236
+ * ```ts
237
+ * const createMutationKey = createMutationKey(endpoint.config, {
238
+ * processResponse: (data) => {
239
+ * if (!data.success) {
240
+ * throw new Error(data.message);
241
+ * }
242
+ * return data.data;
243
+ * },
244
+ * });
245
+ * // We create a mutation that will be shared across the project for all passed userId
246
+ * const mutationKey = createMutationKey({ urlParams: { projectId: 123, userId: 'wildcard' } });
247
+ * ```
248
+ */
249
+ 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 ? {
250
+ urlParams: UrlParams<Url>;
251
+ } : {}) => Options['processResponse'] extends ((...args: unknown[]) => infer Result) ? DataTag<[Config['url']], Result, Error> : never;
252
+ /** @deprecated Use createMutationKey instead */
253
+ declare const mutationKeyCreator: typeof createMutationKey;
254
+ //#endregion
255
+ //#region src/mutation/make-hook.d.mts
256
+ /**
257
+ * Creates a mutation hook for a given endpoint.
258
+ *
259
+ * Returns a function that when called returns a TanStack Query mutation result.
260
+ * The returned function also has helper methods attached (mutationKey, useIsMutating).
261
+ *
262
+ * @param endpoint - The navios endpoint to create a mutation hook for
263
+ * @param options - Mutation configuration including processResponse and callbacks
264
+ * @returns A hook function that returns mutation result with attached helpers
265
+ */
266
+ 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>): {
267
+ (keyParams: UseKey extends true ? UrlHasParams<Config["url"]> extends true ? {
268
+ urlParams: UrlParams<Config["url"]>;
269
+ } : never : never): UseMutationResult<TData, Error, NaviosZodRequest<Config>, TOnMutateResult>;
270
+ useIsMutating(keyParams: UseKey extends true ? UrlHasParams<Config["url"]> extends true ? UrlParams<Config["url"]> : never : never): boolean;
271
+ mutationKey: (params: UrlHasParams<Config["url"]> extends infer T ? T extends UrlHasParams<Config["url"]> ? T extends true ? {
272
+ urlParams: UrlParams<Config["url"]>;
273
+ } : {} : never : never) => ProcessResponseFunction<TData, TResponse> | ((data: z.core.output<Config["responseSchema"]>) => z.core.output<Config["responseSchema"]>) extends ((...args: unknown[]) => infer Result) ? [Config["url"]] & {
274
+ [dataTagSymbol]: Result;
275
+ [dataTagErrorSymbol]: Error;
276
+ } : never;
277
+ };
278
+ //#endregion
279
+ //#region src/client/types.d.mts
280
+ /**
281
+ * Helper type that attaches the endpoint to query/mutation results.
282
+ */
283
+ type EndpointHelper<Method extends HttpMethod = HttpMethod, Url extends string = string, RequestSchema = unknown, ResponseSchema extends z.ZodType = z.ZodType, QuerySchema = unknown> = {
284
+ endpoint: ((params: Util_FlatObject<EndpointFunctionArgs<Url, QuerySchema, RequestSchema>>) => Promise<z.output<ResponseSchema>>) & {
285
+ config: BaseEndpointConfig<Method, Url, QuerySchema, ResponseSchema, RequestSchema>;
286
+ };
287
+ };
288
+ /** @deprecated Use EndpointHelper instead */
289
+ 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>;
290
+ /**
291
+ * Helper type that attaches a stream endpoint to mutation results.
292
+ */
293
+ type StreamHelper<Method extends HttpMethod = HttpMethod, Url extends string = string, RequestSchema = unknown, QuerySchema = unknown> = {
294
+ endpoint: ((params: Util_FlatObject<EndpointFunctionArgs<Url, QuerySchema, RequestSchema>>) => Promise<Blob>) & {
295
+ config: BaseStreamConfig<Method, Url, QuerySchema, RequestSchema>;
296
+ };
297
+ };
298
+ /**
299
+ * The main client instance interface.
300
+ * Provides methods for creating queries, infinite queries, and mutations.
301
+ */
302
+ interface ClientInstance {
303
+ query<Method extends 'GET' | 'HEAD' | 'OPTIONS' = 'GET', Url extends string = string, Response extends ZodType = ZodType, Result$1 = z.output<Response>>(config: {
304
+ method: Method;
305
+ url: Url;
306
+ responseSchema: Response;
307
+ processResponse?: (data: z.output<Response>) => Result$1;
308
+ }): ((params: Util_FlatObject<QueryArgs<Url, undefined>>) => UseSuspenseQueryOptions<Result$1, Error, Result$1, DataTag<Split<Url, '/'>, Result$1, Error>>) & QueryHelpers<Url, undefined, Result$1> & EndpointHelper<Method, Url, undefined, Response>;
309
+ query<Method extends 'GET' | 'HEAD' | 'OPTIONS' = 'GET', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, Result$1 = z.output<Response>>(config: {
310
+ method: Method;
311
+ url: Url;
312
+ querySchema: QuerySchema;
313
+ responseSchema: Response;
314
+ processResponse?: (data: z.output<Response>) => Result$1;
315
+ }): ((params: Util_FlatObject<QueryArgs<Url, QuerySchema>>) => UseSuspenseQueryOptions<Result$1, Error, Result$1, DataTag<Split<Url, '/'>, Result$1, Error>>) & QueryHelpers<Url, QuerySchema, Result$1> & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
316
+ query<Method extends 'POST' = 'POST', Url extends string = string, RequestSchema extends ZodType = ZodType, Response extends ZodType = ZodType, Result$1 = z.output<Response>>(config: {
317
+ method: Method;
318
+ url: Url;
319
+ requestSchema: RequestSchema;
320
+ responseSchema: Response;
321
+ processResponse?: (data: z.output<Response>) => Result$1;
322
+ }): ((params: Util_FlatObject<QueryArgs<Url, undefined, RequestSchema>>) => UseSuspenseQueryOptions<Result$1, Error, Result$1, DataTag<Split<Url, '/'>, Result$1, Error>>) & QueryHelpers<Url, undefined, Result$1, false, RequestSchema> & EndpointHelper<Method, Url, RequestSchema, Response>;
323
+ query<Method extends 'POST' = 'POST', Url extends string = string, QuerySchema extends ZodObject = ZodObject, RequestSchema extends ZodType = ZodType, Response extends ZodType = ZodType, Result$1 = z.output<Response>>(config: {
324
+ method: Method;
325
+ url: Url;
326
+ querySchema: QuerySchema;
327
+ requestSchema: RequestSchema;
328
+ responseSchema: Response;
329
+ processResponse?: (data: z.output<Response>) => Result$1;
330
+ }): ((params: Util_FlatObject<QueryArgs<Url, QuerySchema, RequestSchema>>) => UseSuspenseQueryOptions<Result$1, Error, Result$1, DataTag<Split<Url, '/'>, Result$1, Error>>) & QueryHelpers<Url, QuerySchema, Result$1, false, RequestSchema> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
331
+ infiniteQuery<Method extends 'GET' | 'HEAD' | 'OPTIONS' = 'GET', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, PageResult = z.output<Response>, Result$1 = InfiniteData<PageResult>>(config: {
332
+ method: Method;
333
+ url: Url;
334
+ querySchema: QuerySchema;
335
+ responseSchema: Response;
336
+ processResponse?: (data: z.output<Response>) => PageResult;
337
+ getNextPageParam: (lastPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema> | undefined;
338
+ getPreviousPageParam?: (firstPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema>;
339
+ }): ((params: Util_FlatObject<QueryArgs<Url, QuerySchema>>) => UseSuspenseInfiniteQueryOptions<PageResult, Error, Result$1, DataTag<Split<Url, '/'>, PageResult, Error>, z.output<QuerySchema>>) & QueryHelpers<Url, QuerySchema, PageResult, true> & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
340
+ 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$1 = InfiniteData<PageResult>>(config: {
341
+ method: Method;
342
+ url: Url;
343
+ querySchema: QuerySchema;
344
+ requestSchema: RequestSchema;
345
+ responseSchema: Response;
346
+ processResponse?: (data: z.output<Response>) => PageResult;
347
+ getNextPageParam: (lastPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema> | undefined;
348
+ getPreviousPageParam?: (firstPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema>;
349
+ }): ((params: Util_FlatObject<QueryArgs<Url, QuerySchema, RequestSchema>>) => UseSuspenseInfiniteQueryOptions<PageResult, Error, Result$1, DataTag<Split<Url, '/'>, PageResult, Error>, z.output<QuerySchema>>) & QueryHelpers<Url, QuerySchema, PageResult, true, RequestSchema> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
350
+ 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$1 = unknown, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(config: {
351
+ method: Method;
352
+ url: Url;
353
+ useKey: UseKey;
354
+ requestSchema: RequestSchema;
355
+ querySchema: QuerySchema;
356
+ responseSchema: Response;
357
+ processResponse: ProcessResponseFunction<Result$1, ReqResult>;
358
+ useContext?: () => Context;
359
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
360
+ onSuccess?: (data: NoInfer<Result$1>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
361
+ onMutateResult: OnMutateResult | undefined;
362
+ }) => void | Promise<void>;
363
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
364
+ onMutateResult: OnMutateResult | undefined;
365
+ }) => void | Promise<void>;
366
+ onSettled?: (data: NoInfer<Result$1> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
367
+ onMutateResult: OnMutateResult | undefined;
368
+ }) => void | Promise<void>;
369
+ }): ((params: UrlHasParams<Url> extends true ? {
370
+ urlParams: UrlParams<Url>;
371
+ } : {}) => UseMutationResult<Result$1, Error, MutationArgs<Url, RequestSchema, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result$1> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
372
+ 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$1 = unknown, OnMutateResult = unknown, Context = unknown>(config: {
373
+ method: Method;
374
+ url: Url;
375
+ requestSchema: RequestSchema;
376
+ querySchema: QuerySchema;
377
+ responseSchema: Response;
378
+ processResponse: ProcessResponseFunction<Result$1, ReqResult>;
379
+ useContext?: () => Context;
380
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
381
+ onSuccess?: (data: NoInfer<Result$1>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
382
+ onMutateResult: OnMutateResult | undefined;
383
+ }) => void | Promise<void>;
384
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
385
+ onMutateResult: OnMutateResult | undefined;
386
+ }) => void | Promise<void>;
387
+ onSettled?: (data: NoInfer<Result$1> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
388
+ onMutateResult: OnMutateResult | undefined;
389
+ }) => void | Promise<void>;
390
+ }): (() => UseMutationResult<Result$1, Error, MutationArgs<Url, RequestSchema, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result$1> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
391
+ 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$1 = unknown, OnMutateResult = unknown, Context = unknown>(config: {
392
+ method: Method;
393
+ url: Url;
394
+ requestSchema: RequestSchema;
395
+ responseSchema: Response;
396
+ processResponse: ProcessResponseFunction<Result$1, ReqResult>;
397
+ useContext?: () => Context;
398
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
399
+ onSuccess?: (data: NoInfer<Result$1>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
400
+ onMutateResult: OnMutateResult | undefined;
401
+ }) => void | Promise<void>;
402
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
403
+ onMutateResult: OnMutateResult | undefined;
404
+ }) => void | Promise<void>;
405
+ onSettled?: (data: NoInfer<Result$1> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
406
+ onMutateResult: OnMutateResult | undefined;
407
+ }) => void | Promise<void>;
408
+ }): (() => UseMutationResult<Result$1, Error, MutationArgs<Url, RequestSchema, undefined>, OnMutateResult>) & MutationHelpers<Url, Result$1> & EndpointHelper<Method, Url, RequestSchema, Response>;
409
+ 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$1 = unknown, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(config: {
410
+ method: Method;
411
+ url: Url;
412
+ useKey: UseKey;
413
+ requestSchema: RequestSchema;
414
+ responseSchema: Response;
415
+ processResponse: ProcessResponseFunction<Result$1, ReqResult>;
416
+ useContext?: () => Context;
417
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
418
+ onSuccess?: (data: NoInfer<Result$1>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
419
+ onMutateResult: OnMutateResult | undefined;
420
+ }) => void | Promise<void>;
421
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
422
+ onMutateResult: OnMutateResult | undefined;
423
+ }) => void | Promise<void>;
424
+ onSettled?: (data: NoInfer<Result$1> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
425
+ onMutateResult: OnMutateResult | undefined;
426
+ }) => void | Promise<void>;
427
+ }): ((params: UrlHasParams<Url> extends true ? {
428
+ urlParams: UrlParams<Url>;
429
+ } : {}) => UseMutationResult<Result$1, Error, MutationArgs<Url, RequestSchema, undefined>, OnMutateResult>) & MutationHelpers<Url, Result$1> & EndpointHelper<Method, Url, RequestSchema, Response>;
430
+ mutation<Method extends 'DELETE' = 'DELETE', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result$1 = unknown, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(config: {
431
+ method: Method;
432
+ url: Url;
433
+ useKey: UseKey;
434
+ querySchema: QuerySchema;
435
+ responseSchema: Response;
436
+ processResponse: ProcessResponseFunction<Result$1, ReqResult>;
437
+ useContext?: () => Context;
438
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
439
+ onSuccess?: (data: NoInfer<Result$1>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
440
+ onMutateResult: OnMutateResult | undefined;
441
+ }) => void | Promise<void>;
442
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
443
+ onMutateResult: OnMutateResult | undefined;
444
+ }) => void | Promise<void>;
445
+ onSettled?: (data: NoInfer<Result$1> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
446
+ onMutateResult: OnMutateResult | undefined;
447
+ }) => void | Promise<void>;
448
+ }): ((params: UrlHasParams<Url> extends true ? {
449
+ urlParams: UrlParams<Url>;
450
+ } : {}) => UseMutationResult<Result$1, Error, MutationArgs<Url, undefined, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result$1> & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
451
+ mutation<Method extends 'DELETE' = 'DELETE', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result$1 = unknown, OnMutateResult = unknown, Context = unknown>(config: {
452
+ method: Method;
453
+ url: Url;
454
+ querySchema: QuerySchema;
455
+ responseSchema: Response;
456
+ processResponse: ProcessResponseFunction<Result$1, ReqResult>;
457
+ useContext?: () => Context;
458
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
459
+ onSuccess?: (data: NoInfer<Result$1>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
460
+ onMutateResult: OnMutateResult | undefined;
461
+ }) => void | Promise<void>;
462
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
463
+ onMutateResult: OnMutateResult | undefined;
464
+ }) => void | Promise<void>;
465
+ onSettled?: (data: NoInfer<Result$1> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
466
+ onMutateResult: OnMutateResult | undefined;
467
+ }) => void | Promise<void>;
468
+ }): (() => UseMutationResult<Result$1, Error, MutationArgs<Url, undefined, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result$1> & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
469
+ mutation<Method extends 'DELETE' = 'DELETE', Url extends string = string, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result$1 = unknown, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(config: {
470
+ method: Method;
471
+ url: Url;
472
+ useKey: UseKey;
473
+ responseSchema: Response;
474
+ processResponse: ProcessResponseFunction<Result$1, ReqResult>;
475
+ useContext?: () => Context;
476
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
477
+ onSuccess?: (data: NoInfer<Result$1>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
478
+ onMutateResult: OnMutateResult | undefined;
479
+ }) => void | Promise<void>;
480
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
481
+ onMutateResult: OnMutateResult | undefined;
482
+ }) => void | Promise<void>;
483
+ onSettled?: (data: NoInfer<Result$1> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
484
+ onMutateResult: OnMutateResult | undefined;
485
+ }) => void | Promise<void>;
486
+ }): ((params: UrlHasParams<Url> extends true ? {
487
+ urlParams: UrlParams<Url>;
488
+ } : {}) => UseMutationResult<Result$1, Error, MutationArgs<Url, undefined, undefined>, OnMutateResult>) & MutationHelpers<Url, Result$1> & EndpointHelper<Method, Url, undefined, Response>;
489
+ mutation<Method extends 'DELETE' = 'DELETE', Url extends string = string, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result$1 = unknown, OnMutateResult = unknown, Context = unknown>(config: {
490
+ method: Method;
491
+ url: Url;
492
+ responseSchema: Response;
493
+ processResponse: ProcessResponseFunction<Result$1, ReqResult>;
494
+ useContext?: () => Context;
495
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
496
+ onSuccess?: (data: NoInfer<Result$1>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
497
+ onMutateResult: OnMutateResult | undefined;
498
+ }) => void | Promise<void>;
499
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
500
+ onMutateResult: OnMutateResult | undefined;
501
+ }) => void | Promise<void>;
502
+ onSettled?: (data: NoInfer<Result$1> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
503
+ onMutateResult: OnMutateResult | undefined;
504
+ }) => void | Promise<void>;
505
+ }): (() => UseMutationResult<Result$1, Error, MutationArgs<Url, undefined, undefined>, OnMutateResult>) & MutationHelpers<Url, Result$1> & EndpointHelper<Method, Url, undefined, Response>;
506
+ queryFromEndpoint<Method extends 'GET' | 'HEAD' | 'OPTIONS' = 'GET', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, Result$1 = z.output<Response>>(endpoint: {
507
+ config: BaseEndpointConfig<Method, Url, QuerySchema, Response>;
508
+ }, options?: {
509
+ processResponse?: (data: z.output<Response>) => Result$1;
510
+ }): (params: Util_FlatObject<QueryArgs<Url, QuerySchema>>) => UseSuspenseQueryOptions<Result$1, Error, Result$1, DataTag<Split<Url, '/'>, Result$1, Error>> & QueryHelpers<Url, QuerySchema, Result$1>;
511
+ queryFromEndpoint<Method extends 'GET' | 'HEAD' | 'OPTIONS' = 'GET', Url extends string = string, Response extends ZodType = ZodType, Result$1 = z.output<Response>>(endpoint: {
512
+ config: BaseEndpointConfig<Method, Url, undefined, Response>;
513
+ }, options?: {
514
+ processResponse?: (data: z.output<Response>) => Result$1;
515
+ }): ((params: Util_FlatObject<QueryArgs<Url, undefined>>) => UseSuspenseQueryOptions<Result$1, Error, Result$1, DataTag<Split<Url, '/'>, Result$1, Error>>) & QueryHelpers<Url, undefined, Result$1>;
516
+ infiniteQueryFromEndpoint<Method extends 'GET' | 'HEAD' | 'OPTIONS' = 'GET', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, PageResult = z.output<Response>, Result$1 = InfiniteData<PageResult>>(endpoint: {
517
+ config: BaseEndpointConfig<Method, Url, QuerySchema, Response>;
518
+ }, options: {
519
+ processResponse?: (data: z.output<Response>) => PageResult;
520
+ getNextPageParam: (lastPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema> | undefined;
521
+ getPreviousPageParam?: (firstPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema>;
522
+ }): ((params: Util_FlatObject<QueryArgs<Url, QuerySchema>>) => UseSuspenseInfiniteQueryOptions<PageResult, Error, Result$1, DataTag<Split<Url, '/'>, PageResult, Error>, z.output<QuerySchema>>) & QueryHelpers<Url, QuerySchema, PageResult, true>;
523
+ 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$1 = unknown, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(endpoint: {
524
+ config: BaseEndpointConfig<Method, Url, QuerySchema, Response, RequestSchema>;
525
+ }, mutationOptions: {
526
+ processResponse: ProcessResponseFunction<Result$1, ReqResult>;
527
+ useKey: UseKey;
528
+ useContext?: () => Context;
529
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
530
+ onSuccess?: (data: NoInfer<Result$1>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
531
+ onMutateResult: OnMutateResult | undefined;
532
+ }) => void | Promise<void>;
533
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
534
+ onMutateResult: OnMutateResult | undefined;
535
+ }) => void | Promise<void>;
536
+ onSettled?: (data: NoInfer<Result$1> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
537
+ onMutateResult: OnMutateResult | undefined;
538
+ }) => void | Promise<void>;
539
+ }): ((params: UrlHasParams<Url> extends true ? {
540
+ urlParams: UrlParams<Url>;
541
+ } : {}) => UseMutationResult<Result$1, Error, MutationArgs<Url, RequestSchema, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result$1> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
542
+ 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$1 = unknown, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(endpoint: {
543
+ config: BaseEndpointConfig<Method, Url, undefined, Response, RequestSchema>;
544
+ }, mutationOptions: {
545
+ processResponse: ProcessResponseFunction<Result$1, ReqResult>;
546
+ useKey: UseKey;
547
+ useContext?: () => Context;
548
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
549
+ onSuccess?: (data: NoInfer<Result$1>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
550
+ onMutateResult: OnMutateResult | undefined;
551
+ }) => void | Promise<void>;
552
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
553
+ onMutateResult: OnMutateResult | undefined;
554
+ }) => void | Promise<void>;
555
+ onSettled?: (data: NoInfer<Result$1> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
556
+ onMutateResult: OnMutateResult | undefined;
557
+ }) => void | Promise<void>;
558
+ }): ((params: UrlHasParams<Url> extends true ? {
559
+ urlParams: UrlParams<Url>;
560
+ } : {}) => UseMutationResult<Result$1, Error, MutationArgs<Url, RequestSchema, undefined>, OnMutateResult>) & MutationHelpers<Url, Result$1> & EndpointHelper<Method, Url, RequestSchema, Response, undefined>;
561
+ 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$1 = unknown, OnMutateResult = unknown, Context = unknown>(endpoint: {
562
+ config: BaseEndpointConfig<Method, Url, QuerySchema, Response, RequestSchema>;
563
+ }, mutationOptions: {
564
+ processResponse: ProcessResponseFunction<Result$1, ReqResult>;
565
+ useContext?: () => Context;
566
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
567
+ onSuccess?: (data: NoInfer<Result$1>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
568
+ onMutateResult: OnMutateResult | undefined;
569
+ }) => void | Promise<void>;
570
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
571
+ onMutateResult: OnMutateResult | undefined;
572
+ }) => void | Promise<void>;
573
+ onSettled?: (data: NoInfer<Result$1> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
574
+ onMutateResult: OnMutateResult | undefined;
575
+ }) => void | Promise<void>;
576
+ }): (() => UseMutationResult<Result$1, Error, MutationArgs<Url, RequestSchema, QuerySchema>, OnMutateResult>) & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
577
+ 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$1 = unknown, OnMutateResult = unknown, Context = unknown>(endpoint: {
578
+ config: BaseEndpointConfig<Method, Url, undefined, Response, RequestSchema>;
579
+ }, mutationOptions: {
580
+ processResponse: ProcessResponseFunction<Result$1, ReqResult>;
581
+ useContext?: () => Context;
582
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
583
+ onSuccess?: (data: NoInfer<Result$1>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
584
+ onMutateResult: OnMutateResult | undefined;
585
+ }) => void | Promise<void>;
586
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
587
+ onMutateResult: OnMutateResult | undefined;
588
+ }) => void | Promise<void>;
589
+ onSettled?: (data: NoInfer<Result$1> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
590
+ onMutateResult: OnMutateResult | undefined;
591
+ }) => void | Promise<void>;
592
+ }): (() => UseMutationResult<Result$1, Error, MutationArgs<Url, RequestSchema, undefined>, OnMutateResult>) & EndpointHelper<Method, Url, RequestSchema, Response, undefined>;
593
+ mutationFromEndpoint<Method extends 'DELETE' = 'DELETE', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result$1 = unknown, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(endpoint: {
594
+ config: BaseEndpointConfig<Method, Url, QuerySchema, Response>;
595
+ }, mutationOptions: {
596
+ processResponse: ProcessResponseFunction<Result$1, ReqResult>;
597
+ useKey: UseKey;
598
+ useContext?: () => Context;
599
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
600
+ onSuccess?: (data: NoInfer<Result$1>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
601
+ onMutateResult: OnMutateResult | undefined;
602
+ }) => void | Promise<void>;
603
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
604
+ onMutateResult: OnMutateResult | undefined;
605
+ }) => void | Promise<void>;
606
+ onSettled?: (data: NoInfer<Result$1> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
607
+ onMutateResult: OnMutateResult | undefined;
608
+ }) => void | Promise<void>;
609
+ }): (() => UseMutationResult<Result$1, Error, MutationArgs<Url, undefined, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result$1> & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
610
+ mutationFromEndpoint<Method extends 'DELETE' = 'DELETE', Url extends string = string, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result$1 = unknown, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(endpoint: {
611
+ config: BaseEndpointConfig<Method, Url, undefined, Response>;
612
+ }, mutationOptions: {
613
+ processResponse: ProcessResponseFunction<Result$1, ReqResult>;
614
+ useKey: UseKey;
615
+ useContext?: () => Context;
616
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
617
+ onSuccess?: (data: NoInfer<Result$1>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
618
+ onMutateResult: OnMutateResult | undefined;
619
+ }) => void | Promise<void>;
620
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
621
+ onMutateResult: OnMutateResult | undefined;
622
+ }) => void | Promise<void>;
623
+ onSettled?: (data: NoInfer<Result$1> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
624
+ onMutateResult: OnMutateResult | undefined;
625
+ }) => void | Promise<void>;
626
+ }): ((params: UrlHasParams<Url> extends true ? {
627
+ urlParams: UrlParams<Url>;
628
+ } : {}) => UseMutationResult<Result$1, Error, MutationArgs<Url, undefined, undefined>, OnMutateResult>) & MutationHelpers<Url, Result$1> & EndpointHelper<Method, Url, undefined, Response, undefined>;
629
+ mutationFromEndpoint<Method extends 'DELETE' = 'DELETE', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result$1 = unknown, OnMutateResult = unknown, Context = unknown>(endpoint: {
630
+ config: BaseEndpointConfig<Method, Url, QuerySchema, Response>;
631
+ }, mutationOptions: {
632
+ processResponse: ProcessResponseFunction<Result$1, ReqResult>;
633
+ useContext?: () => Context;
634
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
635
+ onSuccess?: (data: NoInfer<Result$1>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
636
+ onMutateResult: OnMutateResult | undefined;
637
+ }) => void | Promise<void>;
638
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
639
+ onMutateResult: OnMutateResult | undefined;
640
+ }) => void | Promise<void>;
641
+ onSettled?: (data: NoInfer<Result$1> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
642
+ onMutateResult: OnMutateResult | undefined;
643
+ }) => void | Promise<void>;
644
+ }): (() => UseMutationResult<Result$1, Error, MutationArgs<Url, undefined, QuerySchema>, OnMutateResult>) & EndpointHelper<Method, Url, undefined, Response, QuerySchema>;
645
+ mutationFromEndpoint<Method extends 'DELETE' = 'DELETE', Url extends string = string, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result$1 = unknown, OnMutateResult = unknown, Context = unknown>(endpoint: {
646
+ config: BaseEndpointConfig<Method, Url, undefined, Response>;
647
+ }, mutationOptions: {
648
+ processResponse: ProcessResponseFunction<Result$1, ReqResult>;
649
+ useContext?: () => Context;
650
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
651
+ onSuccess?: (data: NoInfer<Result$1>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
652
+ onMutateResult: OnMutateResult | undefined;
653
+ }) => void | Promise<void>;
654
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
655
+ onMutateResult: OnMutateResult | undefined;
656
+ }) => void | Promise<void>;
657
+ onSettled?: (data: NoInfer<Result$1> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
658
+ onMutateResult: OnMutateResult | undefined;
659
+ }) => void | Promise<void>;
660
+ }): (() => UseMutationResult<Result$1, Error, MutationArgs<Url, undefined, undefined>, OnMutateResult>) & EndpointHelper<Method, Url, undefined, Response, undefined>;
661
+ 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$1 = unknown, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(config: {
662
+ method: Method;
663
+ url: Url;
664
+ useKey: UseKey;
665
+ requestSchema: RequestSchema;
666
+ querySchema: QuerySchema;
667
+ responseSchema: Response;
668
+ processResponse: ProcessResponseFunction<Result$1, ReqResult>;
669
+ useContext?: () => Context;
670
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
671
+ onSuccess?: (data: NoInfer<Result$1>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
672
+ onMutateResult: OnMutateResult | undefined;
673
+ }) => void | Promise<void>;
674
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
675
+ onMutateResult: OnMutateResult | undefined;
676
+ }) => void | Promise<void>;
677
+ onSettled?: (data: NoInfer<Result$1> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
678
+ onMutateResult: OnMutateResult | undefined;
679
+ }) => void | Promise<void>;
680
+ }): ((params: UrlHasParams<Url> extends true ? {
681
+ urlParams: UrlParams<Url>;
682
+ } : {}) => UseMutationResult<Result$1, Error, MutationArgs<Url, RequestSchema, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result$1> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
683
+ 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$1 = unknown, OnMutateResult = unknown, Context = unknown>(config: {
684
+ method: Method;
685
+ url: Url;
686
+ requestSchema: RequestSchema;
687
+ querySchema: QuerySchema;
688
+ responseSchema: Response;
689
+ processResponse: ProcessResponseFunction<Result$1, ReqResult>;
690
+ useContext?: () => Context;
691
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
692
+ onSuccess?: (data: NoInfer<Result$1>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
693
+ onMutateResult: OnMutateResult | undefined;
694
+ }) => void | Promise<void>;
695
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
696
+ onMutateResult: OnMutateResult | undefined;
697
+ }) => void | Promise<void>;
698
+ onSettled?: (data: NoInfer<Result$1> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
699
+ onMutateResult: OnMutateResult | undefined;
700
+ }) => void | Promise<void>;
701
+ }): (() => UseMutationResult<Result$1, Error, MutationArgs<Url, RequestSchema, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result$1> & EndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
702
+ 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$1 = unknown, OnMutateResult = unknown, Context = unknown>(config: {
703
+ method: Method;
704
+ url: Url;
705
+ requestSchema: RequestSchema;
706
+ responseSchema: Response;
707
+ processResponse: ProcessResponseFunction<Result$1, ReqResult>;
708
+ useContext?: () => Context;
709
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
710
+ onSuccess?: (data: NoInfer<Result$1>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
711
+ onMutateResult: OnMutateResult | undefined;
712
+ }) => void | Promise<void>;
713
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
714
+ onMutateResult: OnMutateResult | undefined;
715
+ }) => void | Promise<void>;
716
+ onSettled?: (data: NoInfer<Result$1> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
717
+ onMutateResult: OnMutateResult | undefined;
718
+ }) => void | Promise<void>;
719
+ }): (() => UseMutationResult<Result$1, Error, MutationArgs<Url, RequestSchema, undefined>, OnMutateResult>) & MutationHelpers<Url, Result$1> & EndpointHelper<Method, Url, RequestSchema, Response>;
720
+ 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$1 = unknown, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(config: {
721
+ method: Method;
722
+ url: Url;
723
+ useKey: UseKey;
724
+ requestSchema: RequestSchema;
725
+ responseSchema: Response;
726
+ processResponse: ProcessResponseFunction<Result$1, ReqResult>;
727
+ useContext?: () => Context;
728
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
729
+ onSuccess?: (data: NoInfer<Result$1>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
730
+ onMutateResult: OnMutateResult | undefined;
731
+ }) => void | Promise<void>;
732
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
733
+ onMutateResult: OnMutateResult | undefined;
734
+ }) => void | Promise<void>;
735
+ onSettled?: (data: NoInfer<Result$1> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
736
+ onMutateResult: OnMutateResult | undefined;
737
+ }) => void | Promise<void>;
738
+ }): ((params: UrlHasParams<Url> extends true ? {
739
+ urlParams: UrlParams<Url>;
740
+ } : {}) => UseMutationResult<Result$1, Error, MutationArgs<Url, RequestSchema, undefined>, OnMutateResult>) & MutationHelpers<Url, Result$1> & EndpointHelper<Method, Url, RequestSchema, Response>;
741
+ mutationFromEndpoint<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, QuerySchema extends ZodObject = ZodObject, Result$1 = Blob, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(endpoint: {
742
+ config: BaseStreamConfig<Method, Url, QuerySchema, RequestSchema>;
743
+ }, mutationOptions: {
744
+ processResponse?: ProcessResponseFunction<Result$1, Blob>;
745
+ useKey: UseKey;
746
+ useContext?: () => Context;
747
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
748
+ onSuccess?: (data: NoInfer<Result$1>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
749
+ onMutateResult: OnMutateResult | undefined;
750
+ }) => void | Promise<void>;
751
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
752
+ onMutateResult: OnMutateResult | undefined;
753
+ }) => void | Promise<void>;
754
+ onSettled?: (data: NoInfer<Result$1> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
755
+ onMutateResult: OnMutateResult | undefined;
756
+ }) => void | Promise<void>;
757
+ }): ((params: UrlHasParams<Url> extends true ? {
758
+ urlParams: UrlParams<Url>;
759
+ } : {}) => UseMutationResult<Result$1, Error, MutationArgs<Url, RequestSchema, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result$1> & StreamHelper<Method, Url, RequestSchema, QuerySchema>;
760
+ mutationFromEndpoint<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, QuerySchema extends ZodObject = ZodObject, Result$1 = Blob, OnMutateResult = unknown, Context = unknown>(endpoint: {
761
+ config: BaseStreamConfig<Method, Url, QuerySchema, RequestSchema>;
762
+ }, mutationOptions?: {
763
+ processResponse?: ProcessResponseFunction<Result$1, Blob>;
764
+ useContext?: () => Context;
765
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
766
+ onSuccess?: (data: NoInfer<Result$1>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
767
+ onMutateResult: OnMutateResult | undefined;
768
+ }) => void | Promise<void>;
769
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
770
+ onMutateResult: OnMutateResult | undefined;
771
+ }) => void | Promise<void>;
772
+ onSettled?: (data: NoInfer<Result$1> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, QuerySchema>>, context: Context & MutationFunctionContext & {
773
+ onMutateResult: OnMutateResult | undefined;
774
+ }) => void | Promise<void>;
775
+ }): (() => UseMutationResult<Result$1, Error, MutationArgs<Url, RequestSchema, QuerySchema>, OnMutateResult>) & StreamHelper<Method, Url, RequestSchema, QuerySchema>;
776
+ mutationFromEndpoint<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, Result$1 = Blob, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(endpoint: {
777
+ config: BaseStreamConfig<Method, Url, undefined, RequestSchema>;
778
+ }, mutationOptions: {
779
+ processResponse?: ProcessResponseFunction<Result$1, Blob>;
780
+ useKey: UseKey;
781
+ useContext?: () => Context;
782
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
783
+ onSuccess?: (data: NoInfer<Result$1>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
784
+ onMutateResult: OnMutateResult | undefined;
785
+ }) => void | Promise<void>;
786
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
787
+ onMutateResult: OnMutateResult | undefined;
788
+ }) => void | Promise<void>;
789
+ onSettled?: (data: NoInfer<Result$1> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
790
+ onMutateResult: OnMutateResult | undefined;
791
+ }) => void | Promise<void>;
792
+ }): ((params: UrlHasParams<Url> extends true ? {
793
+ urlParams: UrlParams<Url>;
794
+ } : {}) => UseMutationResult<Result$1, Error, MutationArgs<Url, RequestSchema, undefined>, OnMutateResult>) & MutationHelpers<Url, Result$1> & StreamHelper<Method, Url, RequestSchema, undefined>;
795
+ mutationFromEndpoint<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, Result$1 = Blob, OnMutateResult = unknown, Context = unknown>(endpoint: {
796
+ config: BaseStreamConfig<Method, Url, undefined, RequestSchema>;
797
+ }, mutationOptions?: {
798
+ processResponse?: ProcessResponseFunction<Result$1, Blob>;
799
+ useContext?: () => Context;
800
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
801
+ onSuccess?: (data: NoInfer<Result$1>, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
802
+ onMutateResult: OnMutateResult | undefined;
803
+ }) => void | Promise<void>;
804
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
805
+ onMutateResult: OnMutateResult | undefined;
806
+ }) => void | Promise<void>;
807
+ onSettled?: (data: NoInfer<Result$1> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, RequestSchema, undefined>>, context: Context & MutationFunctionContext & {
808
+ onMutateResult: OnMutateResult | undefined;
809
+ }) => void | Promise<void>;
810
+ }): (() => UseMutationResult<Result$1, Error, MutationArgs<Url, RequestSchema, undefined>, OnMutateResult>) & StreamHelper<Method, Url, RequestSchema, undefined>;
811
+ mutationFromEndpoint<Method extends 'GET' | 'DELETE' | 'OPTIONS' | 'HEAD' = 'GET', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Result$1 = Blob, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(endpoint: {
812
+ config: BaseStreamConfig<Method, Url, QuerySchema, undefined>;
813
+ }, mutationOptions: {
814
+ processResponse?: ProcessResponseFunction<Result$1, Blob>;
815
+ useKey: UseKey;
816
+ useContext?: () => Context;
817
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
818
+ onSuccess?: (data: NoInfer<Result$1>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
819
+ onMutateResult: OnMutateResult | undefined;
820
+ }) => void | Promise<void>;
821
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
822
+ onMutateResult: OnMutateResult | undefined;
823
+ }) => void | Promise<void>;
824
+ onSettled?: (data: NoInfer<Result$1> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
825
+ onMutateResult: OnMutateResult | undefined;
826
+ }) => void | Promise<void>;
827
+ }): ((params: UrlHasParams<Url> extends true ? {
828
+ urlParams: UrlParams<Url>;
829
+ } : {}) => UseMutationResult<Result$1, Error, MutationArgs<Url, undefined, QuerySchema>, OnMutateResult>) & MutationHelpers<Url, Result$1> & StreamHelper<Method, Url, undefined, QuerySchema>;
830
+ mutationFromEndpoint<Method extends 'GET' | 'DELETE' | 'OPTIONS' | 'HEAD' = 'GET', Url extends string = string, QuerySchema extends ZodObject = ZodObject, Result$1 = Blob, OnMutateResult = unknown, Context = unknown>(endpoint: {
831
+ config: BaseStreamConfig<Method, Url, QuerySchema, undefined>;
832
+ }, mutationOptions?: {
833
+ processResponse?: ProcessResponseFunction<Result$1, Blob>;
834
+ useContext?: () => Context;
835
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
836
+ onSuccess?: (data: NoInfer<Result$1>, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
837
+ onMutateResult: OnMutateResult | undefined;
838
+ }) => void | Promise<void>;
839
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
840
+ onMutateResult: OnMutateResult | undefined;
841
+ }) => void | Promise<void>;
842
+ onSettled?: (data: NoInfer<Result$1> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, QuerySchema>>, context: Context & MutationFunctionContext & {
843
+ onMutateResult: OnMutateResult | undefined;
844
+ }) => void | Promise<void>;
845
+ }): (() => UseMutationResult<Result$1, Error, MutationArgs<Url, undefined, QuerySchema>, OnMutateResult>) & StreamHelper<Method, Url, undefined, QuerySchema>;
846
+ mutationFromEndpoint<Method extends 'GET' | 'DELETE' | 'OPTIONS' | 'HEAD' = 'GET', Url extends string = string, Result$1 = Blob, OnMutateResult = unknown, Context = unknown, UseKey extends true = true>(endpoint: {
847
+ config: BaseStreamConfig<Method, Url, undefined, undefined>;
848
+ }, mutationOptions: {
849
+ processResponse?: ProcessResponseFunction<Result$1, Blob>;
850
+ useKey: UseKey;
851
+ useContext?: () => Context;
852
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
853
+ onSuccess?: (data: NoInfer<Result$1>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
854
+ onMutateResult: OnMutateResult | undefined;
855
+ }) => void | Promise<void>;
856
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
857
+ onMutateResult: OnMutateResult | undefined;
858
+ }) => void | Promise<void>;
859
+ onSettled?: (data: NoInfer<Result$1> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
860
+ onMutateResult: OnMutateResult | undefined;
861
+ }) => void | Promise<void>;
862
+ }): ((params: UrlHasParams<Url> extends true ? {
863
+ urlParams: UrlParams<Url>;
864
+ } : {}) => UseMutationResult<Result$1, Error, MutationArgs<Url, undefined, undefined>, OnMutateResult>) & MutationHelpers<Url, Result$1> & StreamHelper<Method, Url, undefined, undefined>;
865
+ mutationFromEndpoint<Method extends 'GET' | 'DELETE' | 'OPTIONS' | 'HEAD' = 'GET', Url extends string = string, Result$1 = Blob, OnMutateResult = unknown, Context = unknown>(endpoint: {
866
+ config: BaseStreamConfig<Method, Url, undefined, undefined>;
867
+ }, mutationOptions?: {
868
+ processResponse?: ProcessResponseFunction<Result$1, Blob>;
869
+ useContext?: () => Context;
870
+ onMutate?: (variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext) => OnMutateResult | Promise<OnMutateResult>;
871
+ onSuccess?: (data: NoInfer<Result$1>, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
872
+ onMutateResult: OnMutateResult | undefined;
873
+ }) => void | Promise<void>;
874
+ onError?: (error: Error, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
875
+ onMutateResult: OnMutateResult | undefined;
876
+ }) => void | Promise<void>;
877
+ onSettled?: (data: NoInfer<Result$1> | undefined, error: Error | null, variables: Util_FlatObject<MutationArgs<Url, undefined, undefined>>, context: Context & MutationFunctionContext & {
878
+ onMutateResult: OnMutateResult | undefined;
879
+ }) => void | Promise<void>;
880
+ }): (() => UseMutationResult<Result$1, Error, MutationArgs<Url, undefined, undefined>, OnMutateResult>) & StreamHelper<Method, Url, undefined, undefined>;
881
+ }
882
+ //#endregion
883
+ //#region src/client/declare-client.d.mts
884
+ /**
885
+ * Configuration for declaring a query endpoint.
886
+ */
887
+ interface QueryConfig<Method = HttpMethod, Url = string, QuerySchema = ZodObject, Response extends ZodType = ZodType, Result$1 = z.output<Response>, RequestSchema = unknown> {
888
+ method: Method;
889
+ url: Url;
890
+ querySchema?: QuerySchema;
891
+ responseSchema: Response;
892
+ requestSchema?: RequestSchema;
893
+ processResponse?: (data: z.output<Response>) => Result$1;
894
+ }
895
+ /**
896
+ * Configuration for declaring an infinite query endpoint.
897
+ */
898
+ type InfiniteQueryConfig<Method = HttpMethod, Url = string, QuerySchema extends ZodObject = ZodObject, Response extends ZodType = ZodType, PageResult = z.output<Response>, Result$1 = InfiniteData<PageResult>, RequestSchema = unknown> = {
899
+ method: Method;
900
+ url: Url;
901
+ querySchema: QuerySchema;
902
+ responseSchema: Response;
903
+ requestSchema?: RequestSchema;
904
+ processResponse?: (data: z.output<Response>) => PageResult;
905
+ select?: (data: InfiniteData<PageResult>) => Result$1;
906
+ getNextPageParam: (lastPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema> | undefined;
907
+ getPreviousPageParam?: (firstPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema>;
908
+ initialPageParam?: z.input<QuerySchema>;
909
+ };
910
+ /**
911
+ * Configuration for declaring a mutation endpoint.
912
+ */
913
+ 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$1 = unknown, TOnMutateResult = unknown, Context = unknown, UseKey extends boolean = false> {
914
+ method: Method;
915
+ url: Url;
916
+ querySchema?: QuerySchema;
917
+ responseSchema: Response;
918
+ requestSchema?: RequestSchema;
919
+ processResponse: ProcessResponseFunction<Result$1, ReqResult>;
920
+ useContext?: () => Context;
921
+ onSuccess?: (data: Result$1, variables: MutationArgs<Url, RequestSchema, QuerySchema>, context: Context & MutationFunctionContext & {
922
+ onMutateResult: TOnMutateResult | undefined;
923
+ }) => void | Promise<void>;
924
+ onError?: (err: unknown, variables: MutationArgs<Url, RequestSchema, QuerySchema>, context: Context & MutationFunctionContext & {
925
+ onMutateResult: TOnMutateResult | undefined;
926
+ }) => void | Promise<void>;
927
+ onMutate?: (variables: MutationArgs<Url, RequestSchema, QuerySchema>, context: Context & MutationFunctionContext) => TOnMutateResult | Promise<TOnMutateResult>;
928
+ onSettled?: (data: Result$1 | undefined, error: Error | null, variables: MutationArgs<Url, RequestSchema, QuerySchema>, context: Context & MutationFunctionContext & {
929
+ onMutateResult: TOnMutateResult | undefined;
930
+ }) => void | Promise<void>;
931
+ useKey?: UseKey;
932
+ meta?: Record<string, unknown>;
933
+ }
934
+ /**
935
+ * Creates a client instance for making type-safe queries and mutations.
936
+ *
937
+ * @param options - Client configuration including the API builder and defaults
938
+ * @returns A client instance with query, infiniteQuery, and mutation methods
939
+ *
940
+ * @example
941
+ * ```typescript
942
+ * const api = createBuilder({ baseUrl: '/api' });
943
+ * const client = declareClient({ api });
944
+ *
945
+ * const getUser = client.query({
946
+ * method: 'GET',
947
+ * url: '/users/$id',
948
+ * responseSchema: UserSchema,
949
+ * });
950
+ *
951
+ * // In a component
952
+ * const { data } = useSuspenseQuery(getUser({ urlParams: { id: '123' } }));
953
+ * ```
954
+ */
955
+ declare function declareClient<Options extends ClientOptions>({
956
+ api,
957
+ defaults
958
+ }: Options): ClientInstance;
959
+ //#endregion
960
+ export { BaseMutationArgs, BaseMutationParams, BaseQueryArgs, BaseQueryParams, ClientEndpointHelper, ClientInstance, ClientMutationArgs, ClientOptions, ClientQueryArgs, ClientQueryUrlParamsArgs, EndpointHelper, InfiniteQueryConfig, InfiniteQueryOptions, MutationArgs, MutationConfig, MutationHelpers, MutationParams, ProcessResponseFunction, QueryArgs, QueryConfig, QueryHelpers, QueryKeyCreatorResult, QueryParams, QueryUrlParamsArgs, Split, StreamHelper, createMutationKey, createQueryKey, declareClient, makeInfiniteQueryOptions, makeMutation, makeQueryOptions, mutationKeyCreator, queryKeyCreator };
961
+ //# sourceMappingURL=index.d.cts.map