@navios/react-query 0.3.0 → 0.4.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.
- package/README.md +13 -7
- package/dist/src/declare-client.d.mts +4 -4
- package/dist/src/declare-client.d.mts.map +1 -1
- package/dist/src/make-mutation.d.mts +1 -1
- package/dist/src/make-mutation.d.mts.map +1 -1
- package/dist/src/types/client-endpoint-helper.d.mts +1 -1
- package/dist/src/types/client-endpoint-helper.d.mts.map +1 -1
- package/dist/src/types/client-instance.d.mts +15 -15
- package/dist/src/types/client-instance.d.mts.map +1 -1
- package/dist/src/types/mutation-args.d.mts +3 -3
- package/dist/src/types/mutation-args.d.mts.map +1 -1
- package/dist/src/types/query-args.d.mts +3 -3
- package/dist/src/types/query-args.d.mts.map +1 -1
- package/dist/src/types/query-helpers.d.mts +2 -2
- package/dist/src/types/query-helpers.d.mts.map +1 -1
- package/dist/src/types.d.mts +4 -4
- package/dist/src/types.d.mts.map +1 -1
- package/dist/src/utils/query-key-creator.d.mts +3 -3
- package/dist/src/utils/query-key-creator.d.mts.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/lib/_tsup-dts-rollup.d.mts +30 -30
- package/lib/_tsup-dts-rollup.d.ts +30 -30
- package/lib/index.js.map +1 -1
- package/lib/index.mjs.map +1 -1
- package/package.json +8 -8
- package/src/__tests__/client-type-check.spec.mts +1 -1
- package/src/__tests__/declare-client.spec.mts +1 -1
- package/src/__tests__/make-mutation.spec.mts +1 -1
- package/src/__tests__/makeDataTag.spec.mts +1 -1
- package/src/__tests__/makeInfiniteQueryOptions.spec.mts +1 -1
- package/src/__tests__/makeQueryOptions.spec.mts +1 -1
- package/src/declare-client.mts +4 -4
- package/src/make-infinite-query-options.mts +1 -1
- package/src/make-mutation.mts +1 -1
- package/src/types/client-endpoint-helper.mts +1 -1
- package/src/types/client-instance.mts +13 -15
- package/src/types/mutation-args.mts +3 -3
- package/src/types/query-args.mts +3 -3
- package/src/types/query-helpers.mts +2 -2
- package/src/types.mts +5 -5
- package/src/utils/query-key-creator.mts +3 -7
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import type { AbstractEndpoint } from '@navios/builder';
|
|
2
2
|
import type { AnyEndpointConfig } from '@navios/builder';
|
|
3
|
-
import type { AnyZodObject } from 'zod';
|
|
4
3
|
import type { BaseEndpointConfig } from '@navios/builder';
|
|
5
4
|
import type { BuilderInstance } from '@navios/builder';
|
|
6
5
|
import type { DataTag } from '@tanstack/react-query';
|
|
@@ -24,8 +23,9 @@ import { UseSuspenseInfiniteQueryResult } from '@tanstack/react-query';
|
|
|
24
23
|
import type { UseSuspenseQueryOptions } from '@tanstack/react-query';
|
|
25
24
|
import { UseSuspenseQueryResult } from '@tanstack/react-query';
|
|
26
25
|
import type { Util_FlatObject } from '@navios/builder';
|
|
27
|
-
import type { z } from 'zod';
|
|
28
|
-
import type {
|
|
26
|
+
import type { z } from 'zod/v4';
|
|
27
|
+
import type { ZodObject } from 'zod/v4';
|
|
28
|
+
import type { ZodType } from 'zod/v4';
|
|
29
29
|
|
|
30
30
|
declare type BaseMutationArgs<Config extends AnyEndpointConfig> = NaviosZodRequest<Config>;
|
|
31
31
|
export { BaseMutationArgs }
|
|
@@ -52,7 +52,7 @@ export { BaseMutationParams as BaseMutationParams_alias_1 }
|
|
|
52
52
|
|
|
53
53
|
declare type BaseQueryArgs<Config extends AnyEndpointConfig> = (UrlHasParams<Config['url']> extends true ? {
|
|
54
54
|
urlParams: UrlParams<Config['url']>;
|
|
55
|
-
} : {}) & (Config['querySchema'] extends
|
|
55
|
+
} : {}) & (Config['querySchema'] extends ZodObject ? {
|
|
56
56
|
params: z.input<Config['querySchema']>;
|
|
57
57
|
} : {});
|
|
58
58
|
export { BaseQueryArgs }
|
|
@@ -85,7 +85,7 @@ export { ClientEndpointHelper }
|
|
|
85
85
|
export { ClientEndpointHelper as ClientEndpointHelper_alias_1 }
|
|
86
86
|
export { ClientEndpointHelper as ClientEndpointHelper_alias_2 }
|
|
87
87
|
|
|
88
|
-
declare type ClientInfiniteQueryConfig<Method = HttpMethod, Url = string, QuerySchema extends
|
|
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
89
|
processResponse?: (data: z.output<Response>) => PageResult;
|
|
90
90
|
select?: (data: InfiniteData<PageResult>) => Result;
|
|
91
91
|
getNextPageParam: (lastPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema> | undefined;
|
|
@@ -102,14 +102,14 @@ declare interface ClientInstance {
|
|
|
102
102
|
responseSchema: Response;
|
|
103
103
|
processResponse?: (data: z.output<Response>) => Result;
|
|
104
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>;
|
|
105
|
-
query<Method extends 'GET' | 'HEAD' | 'OPTIONS' = 'GET', Url extends string = string, QuerySchema extends
|
|
105
|
+
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
106
|
method: Method;
|
|
107
107
|
url: Url;
|
|
108
108
|
querySchema: QuerySchema;
|
|
109
109
|
responseSchema: Response;
|
|
110
110
|
processResponse?: (data: z.output<Response>) => Result;
|
|
111
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>;
|
|
112
|
-
infiniteQuery<Method extends 'GET' | 'HEAD' | 'OPTIONS' = 'GET', Url extends string = string, QuerySchema extends
|
|
112
|
+
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
113
|
method: Method;
|
|
114
114
|
url: Url;
|
|
115
115
|
querySchema: QuerySchema;
|
|
@@ -117,8 +117,8 @@ declare interface ClientInstance {
|
|
|
117
117
|
processResponse?: (data: z.output<Response>) => PageResult;
|
|
118
118
|
getNextPageParam: (lastPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema> | undefined;
|
|
119
119
|
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,
|
|
121
|
-
mutation<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, QuerySchema extends
|
|
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>;
|
|
121
|
+
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
122
|
method: Method;
|
|
123
123
|
url: Url;
|
|
124
124
|
useKey: UseKey;
|
|
@@ -132,7 +132,7 @@ declare interface ClientInstance {
|
|
|
132
132
|
}): ((params: UrlHasParams<Url> extends true ? {
|
|
133
133
|
urlParams: UrlParams<Url>;
|
|
134
134
|
} : {}) => UseMutationResult<Result, Error, ClientMutationArgs<Url, RequestSchema, QuerySchema>>) & MutationHelpers<Url, Result> & ClientEndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
|
|
135
|
-
mutation<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, QuerySchema extends
|
|
135
|
+
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
136
|
method: Method;
|
|
137
137
|
url: Url;
|
|
138
138
|
requestSchema: RequestSchema;
|
|
@@ -164,7 +164,7 @@ declare interface ClientInstance {
|
|
|
164
164
|
onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<ClientMutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
|
|
165
165
|
onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<ClientMutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
|
|
166
166
|
}): ((params: UrlHasParams<Url> extends true ? UrlParams<Url> : {}) => UseMutationResult<Result, Error, ClientMutationArgs<Url, RequestSchema, undefined>>) & MutationHelpers<Url, Result> & ClientEndpointHelper<Method, Url, RequestSchema, Response>;
|
|
167
|
-
mutation<Method extends 'DELETE' = 'DELETE', Url extends string = string, QuerySchema extends
|
|
167
|
+
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
168
|
method: Method;
|
|
169
169
|
url: Url;
|
|
170
170
|
useKey: UseKey;
|
|
@@ -175,7 +175,7 @@ declare interface ClientInstance {
|
|
|
175
175
|
onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<ClientMutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
|
|
176
176
|
onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<ClientMutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
|
|
177
177
|
}): ((params: UrlHasParams<Url> extends true ? UrlParams<Url> : {}) => UseMutationResult<Result, Error, ClientMutationArgs<Url, undefined, QuerySchema>>) & MutationHelpers<Url, Result> & ClientEndpointHelper<Method, Url, undefined, Response, QuerySchema>;
|
|
178
|
-
mutation<Method extends 'DELETE' = 'DELETE', Url extends string = string, QuerySchema extends
|
|
178
|
+
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
179
|
method: Method;
|
|
180
180
|
url: Url;
|
|
181
181
|
querySchema: QuerySchema;
|
|
@@ -204,7 +204,7 @@ declare interface ClientInstance {
|
|
|
204
204
|
onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<ClientMutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
|
|
205
205
|
onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<ClientMutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
|
|
206
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
|
|
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 & {
|
|
208
208
|
config: BaseEndpointConfig<Method, Url, QuerySchema, Response>;
|
|
209
209
|
}, options?: {
|
|
210
210
|
processResponse?: (data: z.output<Response>) => Result;
|
|
@@ -218,7 +218,7 @@ declare interface ClientInstance {
|
|
|
218
218
|
}): ((params: UrlHasParams<Url> extends true ? {
|
|
219
219
|
urlParams: UrlParams<Url>;
|
|
220
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
|
|
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 & {
|
|
222
222
|
config: BaseEndpointConfig<Method, Url, QuerySchema, Response>;
|
|
223
223
|
}, options: {
|
|
224
224
|
processResponse?: (data: z.output<Response>) => PageResult;
|
|
@@ -226,8 +226,8 @@ declare interface ClientInstance {
|
|
|
226
226
|
getPreviousPageParam?: (firstPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema>;
|
|
227
227
|
}): ((params: UrlHasParams<Url> extends true ? {
|
|
228
228
|
urlParams: UrlParams<Url>;
|
|
229
|
-
} : {}) => UseSuspenseInfiniteQueryOptions<PageResult, Error, Result,
|
|
230
|
-
mutationFromEndpoint<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, QuerySchema extends
|
|
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 & {
|
|
231
231
|
config: BaseEndpointConfig<Method, Url, QuerySchema, Response, RequestSchema>;
|
|
232
232
|
}, mutationOptions: {
|
|
233
233
|
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
@@ -245,7 +245,7 @@ declare interface ClientInstance {
|
|
|
245
245
|
onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<ClientMutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
|
|
246
246
|
onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<ClientMutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
|
|
247
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
|
|
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 & {
|
|
249
249
|
config: BaseEndpointConfig<Method, Url, QuerySchema, Response, RequestSchema>;
|
|
250
250
|
}, mutationOptions: {
|
|
251
251
|
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
@@ -261,7 +261,7 @@ declare interface ClientInstance {
|
|
|
261
261
|
onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<ClientMutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
|
|
262
262
|
onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<ClientMutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
|
|
263
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
|
|
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 & {
|
|
265
265
|
config: BaseEndpointConfig<Method, Url, QuerySchema, Response>;
|
|
266
266
|
}, mutationOptions: {
|
|
267
267
|
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
@@ -279,7 +279,7 @@ declare interface ClientInstance {
|
|
|
279
279
|
onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<ClientMutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
|
|
280
280
|
onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<ClientMutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
|
|
281
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
|
|
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 & {
|
|
283
283
|
config: BaseEndpointConfig<Method, Url, QuerySchema, Response>;
|
|
284
284
|
}, mutationOptions: {
|
|
285
285
|
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
@@ -302,16 +302,16 @@ export { ClientInstance as ClientInstance_alias_2 }
|
|
|
302
302
|
|
|
303
303
|
declare type ClientMutationArgs<Url extends string = string, RequestSchema = unknown, QuerySchema = unknown> = (UrlHasParams<Url> extends true ? {
|
|
304
304
|
urlParams: UrlParams<Url>;
|
|
305
|
-
} : {}) & (RequestSchema extends
|
|
305
|
+
} : {}) & (RequestSchema extends ZodObject ? {
|
|
306
306
|
data: z.input<RequestSchema>;
|
|
307
|
-
} : {}) & (QuerySchema extends
|
|
307
|
+
} : {}) & (QuerySchema extends ZodObject ? {
|
|
308
308
|
params: z.input<QuerySchema>;
|
|
309
309
|
} : {});
|
|
310
310
|
export { ClientMutationArgs }
|
|
311
311
|
export { ClientMutationArgs as ClientMutationArgs_alias_1 }
|
|
312
312
|
export { ClientMutationArgs as ClientMutationArgs_alias_2 }
|
|
313
313
|
|
|
314
|
-
declare interface ClientMutationDataConfig<Method extends 'POST' | 'PUT' | 'PATCH' | 'DELETE' = 'POST' | 'PUT' | 'PATCH' | 'DELETE', Url extends string = string, RequestSchema = Method extends 'DELETE' ? never :
|
|
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
315
|
requestSchema?: RequestSchema;
|
|
316
316
|
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
317
317
|
useContext?: () => Context;
|
|
@@ -332,16 +332,16 @@ declare type ClientOptions<ProcessResponse = unknown> = {
|
|
|
332
332
|
export { ClientOptions }
|
|
333
333
|
export { ClientOptions as ClientOptions_alias_1 }
|
|
334
334
|
|
|
335
|
-
declare type ClientQueryArgs<Url extends string = string, QuerySchema =
|
|
335
|
+
declare type ClientQueryArgs<Url extends string = string, QuerySchema = ZodObject> = (UrlHasParams<Url> extends true ? {
|
|
336
336
|
urlParams: UrlParams<Url>;
|
|
337
|
-
} : {}) & (QuerySchema extends
|
|
337
|
+
} : {}) & (QuerySchema extends ZodObject ? {
|
|
338
338
|
params: z.input<QuerySchema>;
|
|
339
339
|
} : {});
|
|
340
340
|
export { ClientQueryArgs }
|
|
341
341
|
export { ClientQueryArgs as ClientQueryArgs_alias_1 }
|
|
342
342
|
export { ClientQueryArgs as ClientQueryArgs_alias_2 }
|
|
343
343
|
|
|
344
|
-
declare interface ClientQueryConfig<Method = HttpMethod, Url = string, QuerySchema =
|
|
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
345
|
processResponse?: (data: z.output<Response>) => Result;
|
|
346
346
|
}
|
|
347
347
|
export { ClientQueryConfig }
|
|
@@ -358,12 +358,12 @@ declare function declareClient<Options extends ClientOptions>({ api, defaults, }
|
|
|
358
358
|
export { declareClient }
|
|
359
359
|
export { declareClient as declareClient_alias_1 }
|
|
360
360
|
|
|
361
|
-
declare type InfiniteQueryOptions<Config extends BaseEndpointConfig<HttpMethod, string,
|
|
361
|
+
declare type InfiniteQueryOptions<Config extends BaseEndpointConfig<HttpMethod, string, ZodObject>, Res = any> = {
|
|
362
362
|
keyPrefix?: string[];
|
|
363
363
|
keySuffix?: string[];
|
|
364
364
|
processResponse: (data: z.infer<Config['responseSchema']>) => Res;
|
|
365
365
|
onFail?: (err: unknown) => void;
|
|
366
|
-
getNextPageParam: (lastPage:
|
|
366
|
+
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;
|
|
367
367
|
initialPageParam?: z.input<Config['querySchema']> | z.infer<Config['querySchema']>;
|
|
368
368
|
};
|
|
369
369
|
export { InfiniteQueryOptions }
|
|
@@ -457,7 +457,7 @@ export { MutationHelpers as MutationHelpers_alias_2 }
|
|
|
457
457
|
export { ProcessResponseFunction }
|
|
458
458
|
export { ProcessResponseFunction as ProcessResponseFunction_alias_1 }
|
|
459
459
|
|
|
460
|
-
declare type QueryHelpers<Url extends string, QuerySchema extends
|
|
460
|
+
declare type QueryHelpers<Url extends string, QuerySchema extends ZodObject | undefined = undefined, Result = undefined, IsInfinite extends boolean = false> = {
|
|
461
461
|
queryKey: QueryKeyCreatorResult<QuerySchema, Url, Result, IsInfinite>;
|
|
462
462
|
use: (params: Util_FlatObject<ClientQueryArgs<Url, QuerySchema>>) => UseQueryResult<Result, Error>;
|
|
463
463
|
useSuspense: (params: Util_FlatObject<ClientQueryArgs<Url, QuerySchema>>) => UseSuspenseQueryResult<Result, Error>;
|
|
@@ -476,7 +476,7 @@ export { MutationHelpers as MutationHelpers_alias_2 }
|
|
|
476
476
|
template: Split_2<Url, '/'>;
|
|
477
477
|
dataTag: (params: (HasParams extends true ? {
|
|
478
478
|
urlParams: UrlParams<Url>;
|
|
479
|
-
} : {}) & (QuerySchema extends
|
|
479
|
+
} : {}) & (QuerySchema extends ZodObject ? {
|
|
480
480
|
params: z.input<QuerySchema>;
|
|
481
481
|
} : {})) => DataTag<Split_2<Url, '/'>, IsInfinite extends true ? InfiniteData<Result> : Result, Error>;
|
|
482
482
|
filterKey: (params: HasParams extends true ? {
|
|
@@ -484,7 +484,7 @@ export { MutationHelpers as MutationHelpers_alias_2 }
|
|
|
484
484
|
} : {}) => DataTag<Split_2<Url, '/'>, IsInfinite extends true ? InfiniteData<Result> : Result, Error>;
|
|
485
485
|
bindToUrl: (params: (HasParams extends true ? {
|
|
486
486
|
urlParams: UrlParams<Url>;
|
|
487
|
-
} : {}) & (QuerySchema extends
|
|
487
|
+
} : {}) & (QuerySchema extends ZodObject ? {
|
|
488
488
|
params: z.infer<QuerySchema>;
|
|
489
489
|
} : {})) => string;
|
|
490
490
|
};
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import type { AbstractEndpoint } from '@navios/builder';
|
|
2
2
|
import type { AnyEndpointConfig } from '@navios/builder';
|
|
3
|
-
import type { AnyZodObject } from 'zod';
|
|
4
3
|
import type { BaseEndpointConfig } from '@navios/builder';
|
|
5
4
|
import type { BuilderInstance } from '@navios/builder';
|
|
6
5
|
import type { DataTag } from '@tanstack/react-query';
|
|
@@ -24,8 +23,9 @@ import { UseSuspenseInfiniteQueryResult } from '@tanstack/react-query';
|
|
|
24
23
|
import type { UseSuspenseQueryOptions } from '@tanstack/react-query';
|
|
25
24
|
import { UseSuspenseQueryResult } from '@tanstack/react-query';
|
|
26
25
|
import type { Util_FlatObject } from '@navios/builder';
|
|
27
|
-
import type { z } from 'zod';
|
|
28
|
-
import type {
|
|
26
|
+
import type { z } from 'zod/v4';
|
|
27
|
+
import type { ZodObject } from 'zod/v4';
|
|
28
|
+
import type { ZodType } from 'zod/v4';
|
|
29
29
|
|
|
30
30
|
declare type BaseMutationArgs<Config extends AnyEndpointConfig> = NaviosZodRequest<Config>;
|
|
31
31
|
export { BaseMutationArgs }
|
|
@@ -52,7 +52,7 @@ export { BaseMutationParams as BaseMutationParams_alias_1 }
|
|
|
52
52
|
|
|
53
53
|
declare type BaseQueryArgs<Config extends AnyEndpointConfig> = (UrlHasParams<Config['url']> extends true ? {
|
|
54
54
|
urlParams: UrlParams<Config['url']>;
|
|
55
|
-
} : {}) & (Config['querySchema'] extends
|
|
55
|
+
} : {}) & (Config['querySchema'] extends ZodObject ? {
|
|
56
56
|
params: z.input<Config['querySchema']>;
|
|
57
57
|
} : {});
|
|
58
58
|
export { BaseQueryArgs }
|
|
@@ -85,7 +85,7 @@ export { ClientEndpointHelper }
|
|
|
85
85
|
export { ClientEndpointHelper as ClientEndpointHelper_alias_1 }
|
|
86
86
|
export { ClientEndpointHelper as ClientEndpointHelper_alias_2 }
|
|
87
87
|
|
|
88
|
-
declare type ClientInfiniteQueryConfig<Method = HttpMethod, Url = string, QuerySchema extends
|
|
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
89
|
processResponse?: (data: z.output<Response>) => PageResult;
|
|
90
90
|
select?: (data: InfiniteData<PageResult>) => Result;
|
|
91
91
|
getNextPageParam: (lastPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema> | undefined;
|
|
@@ -102,14 +102,14 @@ declare interface ClientInstance {
|
|
|
102
102
|
responseSchema: Response;
|
|
103
103
|
processResponse?: (data: z.output<Response>) => Result;
|
|
104
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>;
|
|
105
|
-
query<Method extends 'GET' | 'HEAD' | 'OPTIONS' = 'GET', Url extends string = string, QuerySchema extends
|
|
105
|
+
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
106
|
method: Method;
|
|
107
107
|
url: Url;
|
|
108
108
|
querySchema: QuerySchema;
|
|
109
109
|
responseSchema: Response;
|
|
110
110
|
processResponse?: (data: z.output<Response>) => Result;
|
|
111
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>;
|
|
112
|
-
infiniteQuery<Method extends 'GET' | 'HEAD' | 'OPTIONS' = 'GET', Url extends string = string, QuerySchema extends
|
|
112
|
+
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
113
|
method: Method;
|
|
114
114
|
url: Url;
|
|
115
115
|
querySchema: QuerySchema;
|
|
@@ -117,8 +117,8 @@ declare interface ClientInstance {
|
|
|
117
117
|
processResponse?: (data: z.output<Response>) => PageResult;
|
|
118
118
|
getNextPageParam: (lastPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema> | undefined;
|
|
119
119
|
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,
|
|
121
|
-
mutation<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, QuerySchema extends
|
|
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>;
|
|
121
|
+
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
122
|
method: Method;
|
|
123
123
|
url: Url;
|
|
124
124
|
useKey: UseKey;
|
|
@@ -132,7 +132,7 @@ declare interface ClientInstance {
|
|
|
132
132
|
}): ((params: UrlHasParams<Url> extends true ? {
|
|
133
133
|
urlParams: UrlParams<Url>;
|
|
134
134
|
} : {}) => UseMutationResult<Result, Error, ClientMutationArgs<Url, RequestSchema, QuerySchema>>) & MutationHelpers<Url, Result> & ClientEndpointHelper<Method, Url, RequestSchema, Response, QuerySchema>;
|
|
135
|
-
mutation<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, QuerySchema extends
|
|
135
|
+
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
136
|
method: Method;
|
|
137
137
|
url: Url;
|
|
138
138
|
requestSchema: RequestSchema;
|
|
@@ -164,7 +164,7 @@ declare interface ClientInstance {
|
|
|
164
164
|
onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<ClientMutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
|
|
165
165
|
onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<ClientMutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
|
|
166
166
|
}): ((params: UrlHasParams<Url> extends true ? UrlParams<Url> : {}) => UseMutationResult<Result, Error, ClientMutationArgs<Url, RequestSchema, undefined>>) & MutationHelpers<Url, Result> & ClientEndpointHelper<Method, Url, RequestSchema, Response>;
|
|
167
|
-
mutation<Method extends 'DELETE' = 'DELETE', Url extends string = string, QuerySchema extends
|
|
167
|
+
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
168
|
method: Method;
|
|
169
169
|
url: Url;
|
|
170
170
|
useKey: UseKey;
|
|
@@ -175,7 +175,7 @@ declare interface ClientInstance {
|
|
|
175
175
|
onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<ClientMutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
|
|
176
176
|
onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<ClientMutationArgs<Url, undefined, QuerySchema>>, context: Context) => void | Promise<void>;
|
|
177
177
|
}): ((params: UrlHasParams<Url> extends true ? UrlParams<Url> : {}) => UseMutationResult<Result, Error, ClientMutationArgs<Url, undefined, QuerySchema>>) & MutationHelpers<Url, Result> & ClientEndpointHelper<Method, Url, undefined, Response, QuerySchema>;
|
|
178
|
-
mutation<Method extends 'DELETE' = 'DELETE', Url extends string = string, QuerySchema extends
|
|
178
|
+
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
179
|
method: Method;
|
|
180
180
|
url: Url;
|
|
181
181
|
querySchema: QuerySchema;
|
|
@@ -204,7 +204,7 @@ declare interface ClientInstance {
|
|
|
204
204
|
onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<ClientMutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
|
|
205
205
|
onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<ClientMutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
|
|
206
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
|
|
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 & {
|
|
208
208
|
config: BaseEndpointConfig<Method, Url, QuerySchema, Response>;
|
|
209
209
|
}, options?: {
|
|
210
210
|
processResponse?: (data: z.output<Response>) => Result;
|
|
@@ -218,7 +218,7 @@ declare interface ClientInstance {
|
|
|
218
218
|
}): ((params: UrlHasParams<Url> extends true ? {
|
|
219
219
|
urlParams: UrlParams<Url>;
|
|
220
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
|
|
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 & {
|
|
222
222
|
config: BaseEndpointConfig<Method, Url, QuerySchema, Response>;
|
|
223
223
|
}, options: {
|
|
224
224
|
processResponse?: (data: z.output<Response>) => PageResult;
|
|
@@ -226,8 +226,8 @@ declare interface ClientInstance {
|
|
|
226
226
|
getPreviousPageParam?: (firstPage: PageResult, allPages: PageResult[], lastPageParam: z.infer<QuerySchema> | undefined, allPageParams: z.infer<QuerySchema>[] | undefined) => z.input<QuerySchema>;
|
|
227
227
|
}): ((params: UrlHasParams<Url> extends true ? {
|
|
228
228
|
urlParams: UrlParams<Url>;
|
|
229
|
-
} : {}) => UseSuspenseInfiniteQueryOptions<PageResult, Error, Result,
|
|
230
|
-
mutationFromEndpoint<Method extends 'POST' | 'PUT' | 'PATCH' = 'POST' | 'PUT' | 'PATCH', Url extends string = string, RequestSchema extends ZodType = ZodType, QuerySchema extends
|
|
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 & {
|
|
231
231
|
config: BaseEndpointConfig<Method, Url, QuerySchema, Response, RequestSchema>;
|
|
232
232
|
}, mutationOptions: {
|
|
233
233
|
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
@@ -245,7 +245,7 @@ declare interface ClientInstance {
|
|
|
245
245
|
onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<ClientMutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
|
|
246
246
|
onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<ClientMutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
|
|
247
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
|
|
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 & {
|
|
249
249
|
config: BaseEndpointConfig<Method, Url, QuerySchema, Response, RequestSchema>;
|
|
250
250
|
}, mutationOptions: {
|
|
251
251
|
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
@@ -261,7 +261,7 @@ declare interface ClientInstance {
|
|
|
261
261
|
onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<ClientMutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
|
|
262
262
|
onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<ClientMutationArgs<Url, RequestSchema, undefined>>, context: Context) => void | Promise<void>;
|
|
263
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
|
|
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 & {
|
|
265
265
|
config: BaseEndpointConfig<Method, Url, QuerySchema, Response>;
|
|
266
266
|
}, mutationOptions: {
|
|
267
267
|
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
@@ -279,7 +279,7 @@ declare interface ClientInstance {
|
|
|
279
279
|
onSuccess?: (queryClient: QueryClient, data: NoInfer<Result>, variables: Util_FlatObject<ClientMutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
|
|
280
280
|
onError?: (queryClient: QueryClient, error: Error, variables: Util_FlatObject<ClientMutationArgs<Url, undefined, undefined>>, context: Context) => void | Promise<void>;
|
|
281
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
|
|
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 & {
|
|
283
283
|
config: BaseEndpointConfig<Method, Url, QuerySchema, Response>;
|
|
284
284
|
}, mutationOptions: {
|
|
285
285
|
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
@@ -302,16 +302,16 @@ export { ClientInstance as ClientInstance_alias_2 }
|
|
|
302
302
|
|
|
303
303
|
declare type ClientMutationArgs<Url extends string = string, RequestSchema = unknown, QuerySchema = unknown> = (UrlHasParams<Url> extends true ? {
|
|
304
304
|
urlParams: UrlParams<Url>;
|
|
305
|
-
} : {}) & (RequestSchema extends
|
|
305
|
+
} : {}) & (RequestSchema extends ZodObject ? {
|
|
306
306
|
data: z.input<RequestSchema>;
|
|
307
|
-
} : {}) & (QuerySchema extends
|
|
307
|
+
} : {}) & (QuerySchema extends ZodObject ? {
|
|
308
308
|
params: z.input<QuerySchema>;
|
|
309
309
|
} : {});
|
|
310
310
|
export { ClientMutationArgs }
|
|
311
311
|
export { ClientMutationArgs as ClientMutationArgs_alias_1 }
|
|
312
312
|
export { ClientMutationArgs as ClientMutationArgs_alias_2 }
|
|
313
313
|
|
|
314
|
-
declare interface ClientMutationDataConfig<Method extends 'POST' | 'PUT' | 'PATCH' | 'DELETE' = 'POST' | 'PUT' | 'PATCH' | 'DELETE', Url extends string = string, RequestSchema = Method extends 'DELETE' ? never :
|
|
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
315
|
requestSchema?: RequestSchema;
|
|
316
316
|
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
317
317
|
useContext?: () => Context;
|
|
@@ -332,16 +332,16 @@ declare type ClientOptions<ProcessResponse = unknown> = {
|
|
|
332
332
|
export { ClientOptions }
|
|
333
333
|
export { ClientOptions as ClientOptions_alias_1 }
|
|
334
334
|
|
|
335
|
-
declare type ClientQueryArgs<Url extends string = string, QuerySchema =
|
|
335
|
+
declare type ClientQueryArgs<Url extends string = string, QuerySchema = ZodObject> = (UrlHasParams<Url> extends true ? {
|
|
336
336
|
urlParams: UrlParams<Url>;
|
|
337
|
-
} : {}) & (QuerySchema extends
|
|
337
|
+
} : {}) & (QuerySchema extends ZodObject ? {
|
|
338
338
|
params: z.input<QuerySchema>;
|
|
339
339
|
} : {});
|
|
340
340
|
export { ClientQueryArgs }
|
|
341
341
|
export { ClientQueryArgs as ClientQueryArgs_alias_1 }
|
|
342
342
|
export { ClientQueryArgs as ClientQueryArgs_alias_2 }
|
|
343
343
|
|
|
344
|
-
declare interface ClientQueryConfig<Method = HttpMethod, Url = string, QuerySchema =
|
|
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
345
|
processResponse?: (data: z.output<Response>) => Result;
|
|
346
346
|
}
|
|
347
347
|
export { ClientQueryConfig }
|
|
@@ -358,12 +358,12 @@ declare function declareClient<Options extends ClientOptions>({ api, defaults, }
|
|
|
358
358
|
export { declareClient }
|
|
359
359
|
export { declareClient as declareClient_alias_1 }
|
|
360
360
|
|
|
361
|
-
declare type InfiniteQueryOptions<Config extends BaseEndpointConfig<HttpMethod, string,
|
|
361
|
+
declare type InfiniteQueryOptions<Config extends BaseEndpointConfig<HttpMethod, string, ZodObject>, Res = any> = {
|
|
362
362
|
keyPrefix?: string[];
|
|
363
363
|
keySuffix?: string[];
|
|
364
364
|
processResponse: (data: z.infer<Config['responseSchema']>) => Res;
|
|
365
365
|
onFail?: (err: unknown) => void;
|
|
366
|
-
getNextPageParam: (lastPage:
|
|
366
|
+
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;
|
|
367
367
|
initialPageParam?: z.input<Config['querySchema']> | z.infer<Config['querySchema']>;
|
|
368
368
|
};
|
|
369
369
|
export { InfiniteQueryOptions }
|
|
@@ -457,7 +457,7 @@ export { MutationHelpers as MutationHelpers_alias_2 }
|
|
|
457
457
|
export { ProcessResponseFunction }
|
|
458
458
|
export { ProcessResponseFunction as ProcessResponseFunction_alias_1 }
|
|
459
459
|
|
|
460
|
-
declare type QueryHelpers<Url extends string, QuerySchema extends
|
|
460
|
+
declare type QueryHelpers<Url extends string, QuerySchema extends ZodObject | undefined = undefined, Result = undefined, IsInfinite extends boolean = false> = {
|
|
461
461
|
queryKey: QueryKeyCreatorResult<QuerySchema, Url, Result, IsInfinite>;
|
|
462
462
|
use: (params: Util_FlatObject<ClientQueryArgs<Url, QuerySchema>>) => UseQueryResult<Result, Error>;
|
|
463
463
|
useSuspense: (params: Util_FlatObject<ClientQueryArgs<Url, QuerySchema>>) => UseSuspenseQueryResult<Result, Error>;
|
|
@@ -476,7 +476,7 @@ export { MutationHelpers as MutationHelpers_alias_2 }
|
|
|
476
476
|
template: Split_2<Url, '/'>;
|
|
477
477
|
dataTag: (params: (HasParams extends true ? {
|
|
478
478
|
urlParams: UrlParams<Url>;
|
|
479
|
-
} : {}) & (QuerySchema extends
|
|
479
|
+
} : {}) & (QuerySchema extends ZodObject ? {
|
|
480
480
|
params: z.input<QuerySchema>;
|
|
481
481
|
} : {})) => DataTag<Split_2<Url, '/'>, IsInfinite extends true ? InfiniteData<Result> : Result, Error>;
|
|
482
482
|
filterKey: (params: HasParams extends true ? {
|
|
@@ -484,7 +484,7 @@ export { MutationHelpers as MutationHelpers_alias_2 }
|
|
|
484
484
|
} : {}) => DataTag<Split_2<Url, '/'>, IsInfinite extends true ? InfiniteData<Result> : Result, Error>;
|
|
485
485
|
bindToUrl: (params: (HasParams extends true ? {
|
|
486
486
|
urlParams: UrlParams<Url>;
|
|
487
|
-
} : {}) & (QuerySchema extends
|
|
487
|
+
} : {}) & (QuerySchema extends ZodObject ? {
|
|
488
488
|
params: z.infer<QuerySchema>;
|
|
489
489
|
} : {})) => string;
|
|
490
490
|
};
|