@navios/react-query 0.5.2 → 0.6.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.
- package/CHANGELOG.md +51 -10
- package/README.md +405 -273
- package/dist/src/client/declare-client.d.mts +13 -4
- package/dist/src/client/declare-client.d.mts.map +1 -1
- package/dist/src/client/types.d.mts +337 -113
- package/dist/src/client/types.d.mts.map +1 -1
- package/dist/src/mutation/make-hook.d.mts +2 -2
- package/dist/src/mutation/make-hook.d.mts.map +1 -1
- package/dist/src/mutation/types.d.mts +12 -4
- package/dist/src/mutation/types.d.mts.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/lib/_tsup-dts-rollup.d.mts +362 -120
- package/lib/_tsup-dts-rollup.d.ts +362 -120
- package/lib/index.js +51 -27
- package/lib/index.js.map +1 -1
- package/lib/index.mjs +52 -28
- package/lib/index.mjs.map +1 -1
- package/package.json +1 -1
- package/src/__tests__/declare-client.spec.mts +24 -5
- package/src/__tests__/make-mutation.spec.mts +150 -8
- package/src/client/__type-tests__/client-instance.spec-d.mts +2 -2
- package/src/client/declare-client.mts +33 -8
- package/src/client/types.mts +617 -141
- package/src/mutation/make-hook.mts +96 -42
- package/src/mutation/types.mts +28 -6
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { HttpMethod } from '@navios/builder';
|
|
2
|
-
import type { InfiniteData,
|
|
2
|
+
import type { InfiniteData, MutationFunctionContext } from '@tanstack/react-query';
|
|
3
3
|
import type { z, ZodObject, ZodType } from 'zod/v4';
|
|
4
4
|
import type { ClientOptions, ProcessResponseFunction } from '../common/types.mjs';
|
|
5
5
|
import type { MutationArgs } from '../mutation/types.mjs';
|
|
@@ -33,7 +33,7 @@ export type InfiniteQueryConfig<Method = HttpMethod, Url = string, QuerySchema e
|
|
|
33
33
|
/**
|
|
34
34
|
* Configuration for declaring a mutation endpoint.
|
|
35
35
|
*/
|
|
36
|
-
export interface MutationConfig<Method extends 'POST' | 'PUT' | 'PATCH' | 'DELETE' = 'POST' | 'PUT' | 'PATCH' | 'DELETE', Url extends string = string, RequestSchema = Method extends 'DELETE' ? never : ZodObject, QuerySchema = unknown, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, Context = unknown, UseKey extends boolean = false> {
|
|
36
|
+
export interface MutationConfig<Method extends 'POST' | 'PUT' | 'PATCH' | 'DELETE' = 'POST' | 'PUT' | 'PATCH' | 'DELETE', Url extends string = string, RequestSchema = Method extends 'DELETE' ? never : ZodObject, QuerySchema = unknown, Response extends ZodType = ZodType, ReqResult = z.output<Response>, Result = unknown, TOnMutateResult = unknown, Context = unknown, UseKey extends boolean = false> {
|
|
37
37
|
method: Method;
|
|
38
38
|
url: Url;
|
|
39
39
|
querySchema?: QuerySchema;
|
|
@@ -41,9 +41,18 @@ export interface MutationConfig<Method extends 'POST' | 'PUT' | 'PATCH' | 'DELET
|
|
|
41
41
|
requestSchema?: RequestSchema;
|
|
42
42
|
processResponse: ProcessResponseFunction<Result, ReqResult>;
|
|
43
43
|
useContext?: () => Context;
|
|
44
|
-
onSuccess?: (
|
|
45
|
-
|
|
44
|
+
onSuccess?: (data: Result, variables: MutationArgs<Url, RequestSchema, QuerySchema>, context: Context & MutationFunctionContext & {
|
|
45
|
+
onMutateResult: TOnMutateResult | undefined;
|
|
46
|
+
}) => void | Promise<void>;
|
|
47
|
+
onError?: (err: unknown, variables: MutationArgs<Url, RequestSchema, QuerySchema>, context: Context & MutationFunctionContext & {
|
|
48
|
+
onMutateResult: TOnMutateResult | undefined;
|
|
49
|
+
}) => void | Promise<void>;
|
|
50
|
+
onMutate?: (variables: MutationArgs<Url, RequestSchema, QuerySchema>, context: Context & MutationFunctionContext) => TOnMutateResult | Promise<TOnMutateResult>;
|
|
51
|
+
onSettled?: (data: Result | undefined, error: Error | null, variables: MutationArgs<Url, RequestSchema, QuerySchema>, context: Context & MutationFunctionContext & {
|
|
52
|
+
onMutateResult: TOnMutateResult | undefined;
|
|
53
|
+
}) => void | Promise<void>;
|
|
46
54
|
useKey?: UseKey;
|
|
55
|
+
meta?: Record<string, unknown>;
|
|
47
56
|
}
|
|
48
57
|
/**
|
|
49
58
|
* Creates a client instance for making type-safe queries and mutations.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"declare-client.d.mts","sourceRoot":"","sources":["../../../src/client/declare-client.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAKV,UAAU,EACX,MAAM,iBAAiB,CAAA;AACxB,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"declare-client.d.mts","sourceRoot":"","sources":["../../../src/client/declare-client.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAKV,UAAU,EACX,MAAM,iBAAiB,CAAA;AACxB,OAAO,KAAK,EACV,YAAY,EACZ,uBAAuB,EAExB,MAAM,uBAAuB,CAAA;AAC9B,OAAO,KAAK,EAAE,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAA;AAEnD,OAAO,KAAK,EACV,aAAa,EACb,uBAAuB,EACxB,MAAM,qBAAqB,CAAA;AAC5B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AACzD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAMjD;;GAEG;AACH,MAAM,WAAW,WAAW,CAC1B,MAAM,GAAG,UAAU,EACnB,GAAG,GAAG,MAAM,EACZ,WAAW,GAAG,SAAS,EACvB,QAAQ,SAAS,OAAO,GAAG,OAAO,EAClC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,EAC3B,aAAa,GAAG,OAAO;IAEvB,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,GAAG,CAAA;IACR,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,cAAc,EAAE,QAAQ,CAAA;IACxB,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B,eAAe,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,MAAM,CAAA;CACvD;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,CAC7B,MAAM,GAAG,UAAU,EACnB,GAAG,GAAG,MAAM,EACZ,WAAW,SAAS,SAAS,GAAG,SAAS,EACzC,QAAQ,SAAS,OAAO,GAAG,OAAO,EAClC,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,EAC/B,MAAM,GAAG,YAAY,CAAC,UAAU,CAAC,EACjC,aAAa,GAAG,OAAO,IACrB;IACF,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,GAAG,CAAA;IACR,WAAW,EAAE,WAAW,CAAA;IACxB,cAAc,EAAE,QAAQ,CAAA;IACxB,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B,eAAe,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,UAAU,CAAA;IAC1D,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,YAAY,CAAC,UAAU,CAAC,KAAK,MAAM,CAAA;IACnD,gBAAgB,EAAE,CAChB,QAAQ,EAAE,UAAU,EACpB,QAAQ,EAAE,UAAU,EAAE,EACtB,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,SAAS,EAC/C,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,GAAG,SAAS,KAC9C,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,SAAS,CAAA;IACrC,oBAAoB,CAAC,EAAE,CACrB,SAAS,EAAE,UAAU,EACrB,QAAQ,EAAE,UAAU,EAAE,EACtB,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,SAAS,EAC/C,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,GAAG,SAAS,KAC9C,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAA;IACzB,gBAAgB,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAA;CACxC,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,cAAc,CAC7B,MAAM,SAAS,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,GAC9C,MAAM,GACN,KAAK,GACL,OAAO,GACP,QAAQ,EACZ,GAAG,SAAS,MAAM,GAAG,MAAM,EAC3B,aAAa,GAAG,MAAM,SAAS,QAAQ,GAAG,KAAK,GAAG,SAAS,EAC3D,WAAW,GAAG,OAAO,EACrB,QAAQ,SAAS,OAAO,GAAG,OAAO,EAClC,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,EAC9B,MAAM,GAAG,OAAO,EAChB,eAAe,GAAG,OAAO,EACzB,OAAO,GAAG,OAAO,EACjB,MAAM,SAAS,OAAO,GAAG,KAAK;IAE9B,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,GAAG,CAAA;IACR,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,cAAc,EAAE,QAAQ,CAAA;IACxB,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B,eAAe,EAAE,uBAAuB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;IAC3D,UAAU,CAAC,EAAE,MAAM,OAAO,CAAA;IAC1B,SAAS,CAAC,EAAE,CACV,IAAI,EAAE,MAAM,EACZ,SAAS,EAAE,YAAY,CAAC,GAAG,EAAE,aAAa,EAAE,WAAW,CAAC,EACxD,OAAO,EAAE,OAAO,GACd,uBAAuB,GAAG;QAAE,cAAc,EAAE,eAAe,GAAG,SAAS,CAAA;KAAE,KACxE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACzB,OAAO,CAAC,EAAE,CACR,GAAG,EAAE,OAAO,EACZ,SAAS,EAAE,YAAY,CAAC,GAAG,EAAE,aAAa,EAAE,WAAW,CAAC,EACxD,OAAO,EAAE,OAAO,GACd,uBAAuB,GAAG;QAAE,cAAc,EAAE,eAAe,GAAG,SAAS,CAAA;KAAE,KACxE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACzB,QAAQ,CAAC,EAAE,CACT,SAAS,EAAE,YAAY,CAAC,GAAG,EAAE,aAAa,EAAE,WAAW,CAAC,EACxD,OAAO,EAAE,OAAO,GAAG,uBAAuB,KACvC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC,CAAA;IAC/C,SAAS,CAAC,EAAE,CACV,IAAI,EAAE,MAAM,GAAG,SAAS,EACxB,KAAK,EAAE,KAAK,GAAG,IAAI,EACnB,SAAS,EAAE,YAAY,CAAC,GAAG,EAAE,aAAa,EAAE,WAAW,CAAC,EACxD,OAAO,EAAE,OAAO,GACd,uBAAuB,GAAG;QAAE,cAAc,EAAE,eAAe,GAAG,SAAS,CAAA;KAAE,KACxE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACzB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC/B;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,aAAa,CAAC,OAAO,SAAS,aAAa,EAAE,EAC3D,GAAG,EACH,QAAa,GACd,EAAE,OAAO,GAAG,cAAc,CA8L1B"}
|