@ventlio/tanstack-query 0.4.2 → 0.5.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/dist/index.mjs +30 -20
- package/dist/index.mjs.map +1 -1
- package/dist/model/useKeyTrackerModel.d.ts +1 -1
- package/dist/model/useQueryModel.d.ts +1 -1
- package/dist/model/useQueryModel.js +6 -6
- package/dist/model/useRefetchQuery.d.ts +1 -1
- package/dist/model/useRefetchQuery.js +1 -1
- package/dist/queries/useDeleteRequest.d.ts +6 -66
- package/dist/queries/useDeleteRequest.js +7 -3
- package/dist/queries/useDeleteRequest.js.map +1 -1
- package/dist/queries/useGetInfiniteRequest.d.ts +25 -109
- package/dist/queries/useGetInfiniteRequest.js +3 -2
- package/dist/queries/useGetInfiniteRequest.js.map +1 -1
- package/dist/queries/useGetRequest.d.ts +6 -74
- package/dist/queries/useGetRequest.js +3 -2
- package/dist/queries/useGetRequest.js.map +1 -1
- package/dist/queries/usePatchRequest.d.ts +21 -13
- package/dist/queries/usePatchRequest.js +7 -4
- package/dist/queries/usePatchRequest.js.map +1 -1
- package/dist/queries/usePostRequest.d.ts +30 -25
- package/dist/queries/usePostRequest.js +3 -2
- package/dist/queries/usePostRequest.js.map +1 -1
- package/package.json +2 -2
- package/src/model/useKeyTrackerModel.ts +2 -2
- package/src/model/useQueryModel.ts +7 -7
- package/src/model/useRefetchQuery.ts +1 -1
- package/src/queries/useDeleteRequest.ts +7 -7
- package/src/queries/useGetInfiniteRequest.ts +14 -19
- package/src/queries/useGetRequest.ts +6 -9
- package/src/queries/usePatchRequest.ts +5 -5
- package/src/queries/usePostRequest.ts +4 -2
|
@@ -19,6 +19,7 @@ export declare const useGetRequest: <TResponse extends Record<string, any>>({ pa
|
|
|
19
19
|
data: IRequestSuccess<TResponse>;
|
|
20
20
|
error: any;
|
|
21
21
|
isError: true;
|
|
22
|
+
isPending: false;
|
|
22
23
|
isLoadingError: false;
|
|
23
24
|
isRefetchError: true;
|
|
24
25
|
isSuccess: false;
|
|
@@ -34,12 +35,10 @@ export declare const useGetRequest: <TResponse extends Record<string, any>>({ pa
|
|
|
34
35
|
isInitialLoading: boolean;
|
|
35
36
|
isPaused: boolean;
|
|
36
37
|
isPlaceholderData: boolean;
|
|
37
|
-
isPreviousData: boolean;
|
|
38
38
|
isRefetching: boolean;
|
|
39
39
|
isStale: boolean;
|
|
40
|
-
refetch:
|
|
41
|
-
|
|
42
|
-
fetchStatus: import("@tanstack/react-query").FetchStatus;
|
|
40
|
+
refetch: (options?: import("@tanstack/query-core/build/legacy/queryClient-K0zFyarY").a4 | undefined) => Promise<import("@tanstack/query-core/build/legacy/queryClient-K0zFyarY").ak<IRequestSuccess<TResponse>, any>>;
|
|
41
|
+
fetchStatus: import("@tanstack/query-core/build/legacy/queryClient-K0zFyarY").ac;
|
|
43
42
|
} | {
|
|
44
43
|
isLoading: boolean;
|
|
45
44
|
setRequestPath: import("react").Dispatch<import("react").SetStateAction<string>>;
|
|
@@ -52,6 +51,7 @@ export declare const useGetRequest: <TResponse extends Record<string, any>>({ pa
|
|
|
52
51
|
data: IRequestSuccess<TResponse>;
|
|
53
52
|
error: null;
|
|
54
53
|
isError: false;
|
|
54
|
+
isPending: false;
|
|
55
55
|
isLoadingError: false;
|
|
56
56
|
isRefetchError: false;
|
|
57
57
|
isSuccess: true;
|
|
@@ -67,76 +67,8 @@ export declare const useGetRequest: <TResponse extends Record<string, any>>({ pa
|
|
|
67
67
|
isInitialLoading: boolean;
|
|
68
68
|
isPaused: boolean;
|
|
69
69
|
isPlaceholderData: boolean;
|
|
70
|
-
isPreviousData: boolean;
|
|
71
70
|
isRefetching: boolean;
|
|
72
71
|
isStale: boolean;
|
|
73
|
-
refetch:
|
|
74
|
-
|
|
75
|
-
fetchStatus: import("@tanstack/react-query").FetchStatus;
|
|
76
|
-
} | {
|
|
77
|
-
isLoading: boolean;
|
|
78
|
-
setRequestPath: import("react").Dispatch<import("react").SetStateAction<string>>;
|
|
79
|
-
nextPage: () => void;
|
|
80
|
-
prevPage: () => void;
|
|
81
|
-
get: (link: string, fetchOptions?: UseQueryOptions<IRequestSuccess<TResponse | undefined>, IRequestError, IRequestSuccess<TResponse | undefined>, any[]> | undefined) => Promise<IRequestSuccess<TResponse> | undefined>;
|
|
82
|
-
gotoPage: (pageNumber: number) => void;
|
|
83
|
-
page: number;
|
|
84
|
-
queryKey: {}[];
|
|
85
|
-
data: undefined;
|
|
86
|
-
error: any;
|
|
87
|
-
isError: true;
|
|
88
|
-
isLoadingError: true;
|
|
89
|
-
isRefetchError: false;
|
|
90
|
-
isSuccess: false;
|
|
91
|
-
status: "error";
|
|
92
|
-
dataUpdatedAt: number;
|
|
93
|
-
errorUpdatedAt: number;
|
|
94
|
-
failureCount: number;
|
|
95
|
-
failureReason: any;
|
|
96
|
-
errorUpdateCount: number;
|
|
97
|
-
isFetched: boolean;
|
|
98
|
-
isFetchedAfterMount: boolean;
|
|
99
|
-
isFetching: boolean;
|
|
100
|
-
isInitialLoading: boolean;
|
|
101
|
-
isPaused: boolean;
|
|
102
|
-
isPlaceholderData: boolean;
|
|
103
|
-
isPreviousData: boolean;
|
|
104
|
-
isRefetching: boolean;
|
|
105
|
-
isStale: boolean;
|
|
106
|
-
refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<IRequestSuccess<TResponse>, any>>;
|
|
107
|
-
remove: () => void;
|
|
108
|
-
fetchStatus: import("@tanstack/react-query").FetchStatus;
|
|
109
|
-
} | {
|
|
110
|
-
isLoading: boolean;
|
|
111
|
-
setRequestPath: import("react").Dispatch<import("react").SetStateAction<string>>;
|
|
112
|
-
nextPage: () => void;
|
|
113
|
-
prevPage: () => void;
|
|
114
|
-
get: (link: string, fetchOptions?: UseQueryOptions<IRequestSuccess<TResponse | undefined>, IRequestError, IRequestSuccess<TResponse | undefined>, any[]> | undefined) => Promise<IRequestSuccess<TResponse> | undefined>;
|
|
115
|
-
gotoPage: (pageNumber: number) => void;
|
|
116
|
-
page: number;
|
|
117
|
-
queryKey: {}[];
|
|
118
|
-
data: undefined;
|
|
119
|
-
error: null;
|
|
120
|
-
isError: false;
|
|
121
|
-
isLoadingError: false;
|
|
122
|
-
isRefetchError: false;
|
|
123
|
-
isSuccess: false;
|
|
124
|
-
status: "loading";
|
|
125
|
-
dataUpdatedAt: number;
|
|
126
|
-
errorUpdatedAt: number;
|
|
127
|
-
failureCount: number;
|
|
128
|
-
failureReason: any;
|
|
129
|
-
errorUpdateCount: number;
|
|
130
|
-
isFetched: boolean;
|
|
131
|
-
isFetchedAfterMount: boolean;
|
|
132
|
-
isFetching: boolean;
|
|
133
|
-
isInitialLoading: boolean;
|
|
134
|
-
isPaused: boolean;
|
|
135
|
-
isPlaceholderData: boolean;
|
|
136
|
-
isPreviousData: boolean;
|
|
137
|
-
isRefetching: boolean;
|
|
138
|
-
isStale: boolean;
|
|
139
|
-
refetch: <TPageData>(options?: (import("@tanstack/react-query").RefetchOptions & import("@tanstack/react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/react-query").QueryObserverResult<IRequestSuccess<TResponse>, any>>;
|
|
140
|
-
remove: () => void;
|
|
141
|
-
fetchStatus: import("@tanstack/react-query").FetchStatus;
|
|
72
|
+
refetch: (options?: import("@tanstack/query-core/build/legacy/queryClient-K0zFyarY").a4 | undefined) => Promise<import("@tanstack/query-core/build/legacy/queryClient-K0zFyarY").ak<IRequestSuccess<TResponse>, any>>;
|
|
73
|
+
fetchStatus: import("@tanstack/query-core/build/legacy/queryClient-K0zFyarY").ac;
|
|
142
74
|
};
|
|
@@ -52,7 +52,9 @@ const useGetRequest = ({ path, load = false, queryOptions, keyTracker, baseUrl,
|
|
|
52
52
|
res(null);
|
|
53
53
|
}
|
|
54
54
|
};
|
|
55
|
-
const query = useQuery(
|
|
55
|
+
const query = useQuery({
|
|
56
|
+
queryKey: [requestPath, {}],
|
|
57
|
+
queryFn: ({ queryKey }) => new Promise((res, rej) => sendRequest(res, rej, queryKey)),
|
|
56
58
|
enabled: load && !isFutureQueriesPaused,
|
|
57
59
|
...options,
|
|
58
60
|
});
|
|
@@ -65,7 +67,6 @@ const useGetRequest = ({ path, load = false, queryOptions, keyTracker, baseUrl,
|
|
|
65
67
|
if (keyTracker) {
|
|
66
68
|
// set expiration time for the tracker
|
|
67
69
|
queryClient.setQueryDefaults([keyTracker], {
|
|
68
|
-
cacheTime: Infinity,
|
|
69
70
|
staleTime: Infinity,
|
|
70
71
|
});
|
|
71
72
|
queryClient.setQueryData([keyTracker], [requestPath, {}]);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useGetRequest.js","sources":[],"sourcesContent":[],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"useGetRequest.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
|
|
@@ -6,73 +6,81 @@ export declare const usePatchRequest: <TResponse>({ path, baseUrl, headers }: {
|
|
|
6
6
|
} & DefaultRequestOptions) => {
|
|
7
7
|
isLoading: boolean;
|
|
8
8
|
data: undefined;
|
|
9
|
+
variables: undefined;
|
|
9
10
|
error: null;
|
|
10
11
|
isError: false;
|
|
11
12
|
isIdle: true;
|
|
13
|
+
isPending: false;
|
|
12
14
|
isSuccess: false;
|
|
13
15
|
status: "idle";
|
|
14
|
-
mutate: import("@tanstack/react-query").UseMutateFunction<IRequestSuccess<TResponse>, IRequestError, void, unknown>;
|
|
16
|
+
mutate: import("@tanstack/react-query/build/legacy/types").UseMutateFunction<IRequestSuccess<TResponse>, IRequestError, void, unknown>;
|
|
15
17
|
reset: () => void;
|
|
16
18
|
context: unknown;
|
|
17
19
|
failureCount: number;
|
|
18
20
|
failureReason: IRequestError | null;
|
|
19
21
|
isPaused: boolean;
|
|
20
|
-
|
|
21
|
-
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<IRequestSuccess<TResponse>, IRequestError, void, unknown>;
|
|
22
|
+
submittedAt: number;
|
|
23
|
+
mutateAsync: import("@tanstack/react-query/build/legacy/types").UseMutateAsyncFunction<IRequestSuccess<TResponse>, IRequestError, void, unknown>;
|
|
22
24
|
patch: (data: any, options?: MutateOptions<IRequestSuccess<TResponse>, IRequestError, void, unknown> | undefined) => Promise<IRequestSuccess<TResponse> | undefined>;
|
|
23
25
|
uploadProgressPercent: number;
|
|
24
26
|
} | {
|
|
25
27
|
isLoading: boolean;
|
|
26
28
|
data: undefined;
|
|
29
|
+
variables: void;
|
|
27
30
|
error: null;
|
|
28
31
|
isError: false;
|
|
29
32
|
isIdle: false;
|
|
33
|
+
isPending: true;
|
|
30
34
|
isSuccess: false;
|
|
31
|
-
status: "
|
|
32
|
-
mutate: import("@tanstack/react-query").UseMutateFunction<IRequestSuccess<TResponse>, IRequestError, void, unknown>;
|
|
35
|
+
status: "pending";
|
|
36
|
+
mutate: import("@tanstack/react-query/build/legacy/types").UseMutateFunction<IRequestSuccess<TResponse>, IRequestError, void, unknown>;
|
|
33
37
|
reset: () => void;
|
|
34
38
|
context: unknown;
|
|
35
39
|
failureCount: number;
|
|
36
40
|
failureReason: IRequestError | null;
|
|
37
41
|
isPaused: boolean;
|
|
38
|
-
|
|
39
|
-
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<IRequestSuccess<TResponse>, IRequestError, void, unknown>;
|
|
42
|
+
submittedAt: number;
|
|
43
|
+
mutateAsync: import("@tanstack/react-query/build/legacy/types").UseMutateAsyncFunction<IRequestSuccess<TResponse>, IRequestError, void, unknown>;
|
|
40
44
|
patch: (data: any, options?: MutateOptions<IRequestSuccess<TResponse>, IRequestError, void, unknown> | undefined) => Promise<IRequestSuccess<TResponse> | undefined>;
|
|
41
45
|
uploadProgressPercent: number;
|
|
42
46
|
} | {
|
|
43
47
|
isLoading: boolean;
|
|
44
48
|
data: undefined;
|
|
45
49
|
error: IRequestError;
|
|
50
|
+
variables: void;
|
|
46
51
|
isError: true;
|
|
47
52
|
isIdle: false;
|
|
53
|
+
isPending: false;
|
|
48
54
|
isSuccess: false;
|
|
49
55
|
status: "error";
|
|
50
|
-
mutate: import("@tanstack/react-query").UseMutateFunction<IRequestSuccess<TResponse>, IRequestError, void, unknown>;
|
|
56
|
+
mutate: import("@tanstack/react-query/build/legacy/types").UseMutateFunction<IRequestSuccess<TResponse>, IRequestError, void, unknown>;
|
|
51
57
|
reset: () => void;
|
|
52
58
|
context: unknown;
|
|
53
59
|
failureCount: number;
|
|
54
60
|
failureReason: IRequestError | null;
|
|
55
61
|
isPaused: boolean;
|
|
56
|
-
|
|
57
|
-
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<IRequestSuccess<TResponse>, IRequestError, void, unknown>;
|
|
62
|
+
submittedAt: number;
|
|
63
|
+
mutateAsync: import("@tanstack/react-query/build/legacy/types").UseMutateAsyncFunction<IRequestSuccess<TResponse>, IRequestError, void, unknown>;
|
|
58
64
|
patch: (data: any, options?: MutateOptions<IRequestSuccess<TResponse>, IRequestError, void, unknown> | undefined) => Promise<IRequestSuccess<TResponse> | undefined>;
|
|
59
65
|
uploadProgressPercent: number;
|
|
60
66
|
} | {
|
|
61
67
|
isLoading: boolean;
|
|
62
68
|
data: IRequestSuccess<TResponse>;
|
|
63
69
|
error: null;
|
|
70
|
+
variables: void;
|
|
64
71
|
isError: false;
|
|
65
72
|
isIdle: false;
|
|
73
|
+
isPending: false;
|
|
66
74
|
isSuccess: true;
|
|
67
75
|
status: "success";
|
|
68
|
-
mutate: import("@tanstack/react-query").UseMutateFunction<IRequestSuccess<TResponse>, IRequestError, void, unknown>;
|
|
76
|
+
mutate: import("@tanstack/react-query/build/legacy/types").UseMutateFunction<IRequestSuccess<TResponse>, IRequestError, void, unknown>;
|
|
69
77
|
reset: () => void;
|
|
70
78
|
context: unknown;
|
|
71
79
|
failureCount: number;
|
|
72
80
|
failureReason: IRequestError | null;
|
|
73
81
|
isPaused: boolean;
|
|
74
|
-
|
|
75
|
-
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<IRequestSuccess<TResponse>, IRequestError, void, unknown>;
|
|
82
|
+
submittedAt: number;
|
|
83
|
+
mutateAsync: import("@tanstack/react-query/build/legacy/types").UseMutateAsyncFunction<IRequestSuccess<TResponse>, IRequestError, void, unknown>;
|
|
76
84
|
patch: (data: any, options?: MutateOptions<IRequestSuccess<TResponse>, IRequestError, void, unknown> | undefined) => Promise<IRequestSuccess<TResponse> | undefined>;
|
|
77
85
|
uploadProgressPercent: number;
|
|
78
86
|
};
|
|
@@ -58,9 +58,12 @@ const usePatchRequest = ({ path, baseUrl, headers }) => {
|
|
|
58
58
|
}
|
|
59
59
|
};
|
|
60
60
|
// register post mutation
|
|
61
|
-
const mutation = useMutation(
|
|
62
|
-
|
|
63
|
-
|
|
61
|
+
const mutation = useMutation({
|
|
62
|
+
mutationFn: (dataData) => new Promise((res, rej) => {
|
|
63
|
+
return sendRequest(res, rej, dataData);
|
|
64
|
+
}),
|
|
65
|
+
mutationKey: [path, { type: 'mutation' }],
|
|
66
|
+
});
|
|
64
67
|
const patch = async (data, options) => {
|
|
65
68
|
if (!isFutureMutationsPaused) {
|
|
66
69
|
return mutation.mutateAsync(data, options);
|
|
@@ -77,7 +80,7 @@ const usePatchRequest = ({ path, baseUrl, headers }) => {
|
|
|
77
80
|
}
|
|
78
81
|
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
79
82
|
}, [isFutureMutationsPaused]);
|
|
80
|
-
return { patch, uploadProgressPercent, ...mutation, isLoading: mutation.
|
|
83
|
+
return { patch, uploadProgressPercent, ...mutation, isLoading: mutation.isPending || isFutureMutationsPaused };
|
|
81
84
|
};
|
|
82
85
|
|
|
83
86
|
export { usePatchRequest };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"usePatchRequest.js","sources":[],"sourcesContent":[],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"usePatchRequest.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
|
|
@@ -8,12 +8,14 @@ export declare const usePostRequest: <TResponse>({ path, isFormData, baseUrl, he
|
|
|
8
8
|
} & DefaultRequestOptions) => {
|
|
9
9
|
isLoading: boolean;
|
|
10
10
|
data: undefined;
|
|
11
|
+
variables: undefined;
|
|
11
12
|
error: null;
|
|
12
13
|
isError: false;
|
|
13
14
|
isIdle: true;
|
|
15
|
+
isPending: false;
|
|
14
16
|
isSuccess: false;
|
|
15
17
|
status: "idle";
|
|
16
|
-
mutate: import("@tanstack/react-query").UseMutateFunction<IRequestSuccess<TResponse>, IRequestError, {
|
|
18
|
+
mutate: import("@tanstack/react-query/build/legacy/types").UseMutateFunction<IRequestSuccess<TResponse>, IRequestError, {
|
|
17
19
|
data: any;
|
|
18
20
|
requestConfig?: Partial<Omit<IMakeRequest, "body">> | undefined;
|
|
19
21
|
}, unknown>;
|
|
@@ -22,11 +24,8 @@ export declare const usePostRequest: <TResponse>({ path, isFormData, baseUrl, he
|
|
|
22
24
|
failureCount: number;
|
|
23
25
|
failureReason: IRequestError | null;
|
|
24
26
|
isPaused: boolean;
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
requestConfig?: Partial<Omit<IMakeRequest, "body">> | undefined;
|
|
28
|
-
} | undefined;
|
|
29
|
-
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<IRequestSuccess<TResponse>, IRequestError, {
|
|
27
|
+
submittedAt: number;
|
|
28
|
+
mutateAsync: import("@tanstack/react-query/build/legacy/types").UseMutateAsyncFunction<IRequestSuccess<TResponse>, IRequestError, {
|
|
30
29
|
data: any;
|
|
31
30
|
requestConfig?: Partial<Omit<IMakeRequest, "body">> | undefined;
|
|
32
31
|
}, unknown>;
|
|
@@ -44,12 +43,17 @@ export declare const usePostRequest: <TResponse>({ path, isFormData, baseUrl, he
|
|
|
44
43
|
} | {
|
|
45
44
|
isLoading: boolean;
|
|
46
45
|
data: undefined;
|
|
46
|
+
variables: {
|
|
47
|
+
data: any;
|
|
48
|
+
requestConfig?: Partial<Omit<IMakeRequest, "body">> | undefined;
|
|
49
|
+
};
|
|
47
50
|
error: null;
|
|
48
51
|
isError: false;
|
|
49
52
|
isIdle: false;
|
|
53
|
+
isPending: true;
|
|
50
54
|
isSuccess: false;
|
|
51
|
-
status: "
|
|
52
|
-
mutate: import("@tanstack/react-query").UseMutateFunction<IRequestSuccess<TResponse>, IRequestError, {
|
|
55
|
+
status: "pending";
|
|
56
|
+
mutate: import("@tanstack/react-query/build/legacy/types").UseMutateFunction<IRequestSuccess<TResponse>, IRequestError, {
|
|
53
57
|
data: any;
|
|
54
58
|
requestConfig?: Partial<Omit<IMakeRequest, "body">> | undefined;
|
|
55
59
|
}, unknown>;
|
|
@@ -58,11 +62,8 @@ export declare const usePostRequest: <TResponse>({ path, isFormData, baseUrl, he
|
|
|
58
62
|
failureCount: number;
|
|
59
63
|
failureReason: IRequestError | null;
|
|
60
64
|
isPaused: boolean;
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
requestConfig?: Partial<Omit<IMakeRequest, "body">> | undefined;
|
|
64
|
-
} | undefined;
|
|
65
|
-
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<IRequestSuccess<TResponse>, IRequestError, {
|
|
65
|
+
submittedAt: number;
|
|
66
|
+
mutateAsync: import("@tanstack/react-query/build/legacy/types").UseMutateAsyncFunction<IRequestSuccess<TResponse>, IRequestError, {
|
|
66
67
|
data: any;
|
|
67
68
|
requestConfig?: Partial<Omit<IMakeRequest, "body">> | undefined;
|
|
68
69
|
}, unknown>;
|
|
@@ -81,11 +82,16 @@ export declare const usePostRequest: <TResponse>({ path, isFormData, baseUrl, he
|
|
|
81
82
|
isLoading: boolean;
|
|
82
83
|
data: undefined;
|
|
83
84
|
error: IRequestError;
|
|
85
|
+
variables: {
|
|
86
|
+
data: any;
|
|
87
|
+
requestConfig?: Partial<Omit<IMakeRequest, "body">> | undefined;
|
|
88
|
+
};
|
|
84
89
|
isError: true;
|
|
85
90
|
isIdle: false;
|
|
91
|
+
isPending: false;
|
|
86
92
|
isSuccess: false;
|
|
87
93
|
status: "error";
|
|
88
|
-
mutate: import("@tanstack/react-query").UseMutateFunction<IRequestSuccess<TResponse>, IRequestError, {
|
|
94
|
+
mutate: import("@tanstack/react-query/build/legacy/types").UseMutateFunction<IRequestSuccess<TResponse>, IRequestError, {
|
|
89
95
|
data: any;
|
|
90
96
|
requestConfig?: Partial<Omit<IMakeRequest, "body">> | undefined;
|
|
91
97
|
}, unknown>;
|
|
@@ -94,11 +100,8 @@ export declare const usePostRequest: <TResponse>({ path, isFormData, baseUrl, he
|
|
|
94
100
|
failureCount: number;
|
|
95
101
|
failureReason: IRequestError | null;
|
|
96
102
|
isPaused: boolean;
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
requestConfig?: Partial<Omit<IMakeRequest, "body">> | undefined;
|
|
100
|
-
} | undefined;
|
|
101
|
-
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<IRequestSuccess<TResponse>, IRequestError, {
|
|
103
|
+
submittedAt: number;
|
|
104
|
+
mutateAsync: import("@tanstack/react-query/build/legacy/types").UseMutateAsyncFunction<IRequestSuccess<TResponse>, IRequestError, {
|
|
102
105
|
data: any;
|
|
103
106
|
requestConfig?: Partial<Omit<IMakeRequest, "body">> | undefined;
|
|
104
107
|
}, unknown>;
|
|
@@ -117,11 +120,16 @@ export declare const usePostRequest: <TResponse>({ path, isFormData, baseUrl, he
|
|
|
117
120
|
isLoading: boolean;
|
|
118
121
|
data: IRequestSuccess<TResponse>;
|
|
119
122
|
error: null;
|
|
123
|
+
variables: {
|
|
124
|
+
data: any;
|
|
125
|
+
requestConfig?: Partial<Omit<IMakeRequest, "body">> | undefined;
|
|
126
|
+
};
|
|
120
127
|
isError: false;
|
|
121
128
|
isIdle: false;
|
|
129
|
+
isPending: false;
|
|
122
130
|
isSuccess: true;
|
|
123
131
|
status: "success";
|
|
124
|
-
mutate: import("@tanstack/react-query").UseMutateFunction<IRequestSuccess<TResponse>, IRequestError, {
|
|
132
|
+
mutate: import("@tanstack/react-query/build/legacy/types").UseMutateFunction<IRequestSuccess<TResponse>, IRequestError, {
|
|
125
133
|
data: any;
|
|
126
134
|
requestConfig?: Partial<Omit<IMakeRequest, "body">> | undefined;
|
|
127
135
|
}, unknown>;
|
|
@@ -130,11 +138,8 @@ export declare const usePostRequest: <TResponse>({ path, isFormData, baseUrl, he
|
|
|
130
138
|
failureCount: number;
|
|
131
139
|
failureReason: IRequestError | null;
|
|
132
140
|
isPaused: boolean;
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
requestConfig?: Partial<Omit<IMakeRequest, "body">> | undefined;
|
|
136
|
-
} | undefined;
|
|
137
|
-
mutateAsync: import("@tanstack/react-query").UseMutateAsyncFunction<IRequestSuccess<TResponse>, IRequestError, {
|
|
141
|
+
submittedAt: number;
|
|
142
|
+
mutateAsync: import("@tanstack/react-query/build/legacy/types").UseMutateAsyncFunction<IRequestSuccess<TResponse>, IRequestError, {
|
|
138
143
|
data: any;
|
|
139
144
|
requestConfig?: Partial<Omit<IMakeRequest, "body">> | undefined;
|
|
140
145
|
}, unknown>;
|
|
@@ -68,7 +68,8 @@ const usePostRequest = ({ path, isFormData = false, baseUrl, headers, fileSelect
|
|
|
68
68
|
}
|
|
69
69
|
};
|
|
70
70
|
// register post mutation
|
|
71
|
-
const mutation = useMutation(
|
|
71
|
+
const mutation = useMutation({
|
|
72
|
+
mutationFn: async (postData) => new Promise((res, rej) => sendRequest(res, rej, postData)),
|
|
72
73
|
mutationKey: [path, { type: 'mutation' }],
|
|
73
74
|
});
|
|
74
75
|
const post = async (data, options) => {
|
|
@@ -88,7 +89,7 @@ const usePostRequest = ({ path, isFormData = false, baseUrl, headers, fileSelect
|
|
|
88
89
|
}
|
|
89
90
|
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
90
91
|
}, [isFutureMutationsPaused]);
|
|
91
|
-
return { post, uploadProgressPercent, ...mutation, isLoading: mutation.
|
|
92
|
+
return { post, uploadProgressPercent, ...mutation, isLoading: mutation.isPending || isFutureMutationsPaused };
|
|
92
93
|
};
|
|
93
94
|
|
|
94
95
|
export { usePostRequest };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"usePostRequest.js","sources":[],"sourcesContent":[],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"usePostRequest.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ventlio/tanstack-query",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.5.1",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"contributors": [
|
|
@@ -47,7 +47,7 @@
|
|
|
47
47
|
"@rollup/plugin-json": "^6.0.0",
|
|
48
48
|
"@rollup/plugin-node-resolve": "^15.0.1",
|
|
49
49
|
"@rollup/plugin-typescript": "^11.0.0",
|
|
50
|
-
"@tanstack/react-query": "^
|
|
50
|
+
"@tanstack/react-query": "^5.29.2",
|
|
51
51
|
"@testing-library/react": "^13.1",
|
|
52
52
|
"@testing-library/react-hooks": "^8.0.1",
|
|
53
53
|
"@types/axios": "^0.14.0",
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { useQueryClient } from '@tanstack/react-query';
|
|
2
2
|
|
|
3
|
-
export const useKeyTrackerModel =
|
|
3
|
+
export const useKeyTrackerModel = (keyTracker: string) => {
|
|
4
4
|
const queryClient = useQueryClient();
|
|
5
5
|
|
|
6
6
|
const getQueryKey = (innerKeyTracker?: string) => {
|
|
@@ -12,7 +12,7 @@ export const useKeyTrackerModel = <T>(keyTracker: string) => {
|
|
|
12
12
|
const refetchQuery = async (innerKeyTracker?: string) => {
|
|
13
13
|
const queryKey: any = getQueryKey(innerKeyTracker ?? keyTracker);
|
|
14
14
|
|
|
15
|
-
await queryClient.refetchQueries
|
|
15
|
+
await queryClient.refetchQueries({
|
|
16
16
|
queryKey,
|
|
17
17
|
exact: true,
|
|
18
18
|
});
|
|
@@ -5,7 +5,7 @@ import { useQueryConfig } from '../config';
|
|
|
5
5
|
import type { QueryModelAddPosition, QueryModelBuilder } from './model.interface';
|
|
6
6
|
import { useKeyTrackerModel } from './useKeyTrackerModel';
|
|
7
7
|
|
|
8
|
-
export const useQueryModel = <T>(keyTracker: string
|
|
8
|
+
export const useQueryModel = <T>(keyTracker: string): QueryModelBuilder<T> => {
|
|
9
9
|
const queryClient = useQueryClient();
|
|
10
10
|
const { getQueryKey } = useKeyTrackerModel(keyTracker);
|
|
11
11
|
const queryKey = getQueryKey() as any[];
|
|
@@ -24,7 +24,7 @@ export const useQueryModel = <T>(keyTracker: string, exact: boolean = true): Que
|
|
|
24
24
|
if (!path) {
|
|
25
25
|
queryClient.setQueryData(queryKey, records);
|
|
26
26
|
} else {
|
|
27
|
-
const queryData = queryClient.getQueryData(queryKey
|
|
27
|
+
const queryData = queryClient.getQueryData(queryKey) ?? {};
|
|
28
28
|
queryClient.setQueryData(queryKey, lodashSet(queryData, path, records));
|
|
29
29
|
}
|
|
30
30
|
|
|
@@ -32,7 +32,7 @@ export const useQueryModel = <T>(keyTracker: string, exact: boolean = true): Que
|
|
|
32
32
|
};
|
|
33
33
|
|
|
34
34
|
const findAll = (path?: string): T[] | T | undefined => {
|
|
35
|
-
const data = queryClient.getQueryData(queryKey
|
|
35
|
+
const data = queryClient.getQueryData(queryKey);
|
|
36
36
|
|
|
37
37
|
if (!data) {
|
|
38
38
|
return [];
|
|
@@ -62,7 +62,7 @@ export const useQueryModel = <T>(keyTracker: string, exact: boolean = true): Que
|
|
|
62
62
|
};
|
|
63
63
|
|
|
64
64
|
const get = (path?: string): T | undefined => {
|
|
65
|
-
let data = queryClient.getQueryData(queryKey
|
|
65
|
+
let data = queryClient.getQueryData(queryKey);
|
|
66
66
|
if (path) {
|
|
67
67
|
data = result<T>(data, path);
|
|
68
68
|
}
|
|
@@ -75,7 +75,7 @@ export const useQueryModel = <T>(keyTracker: string, exact: boolean = true): Que
|
|
|
75
75
|
newData = lodashSet(data, path, newData);
|
|
76
76
|
}
|
|
77
77
|
|
|
78
|
-
return queryClient.setQueryData(queryKey, newData) as DataType;
|
|
78
|
+
return queryClient.setQueryData(queryKey, newData as DataType) as DataType;
|
|
79
79
|
};
|
|
80
80
|
|
|
81
81
|
const getModelConfig = () => {
|
|
@@ -108,7 +108,7 @@ export const useQueryModel = <T>(keyTracker: string, exact: boolean = true): Que
|
|
|
108
108
|
if (!path) {
|
|
109
109
|
queryClient.setQueryData(queryKey, newData);
|
|
110
110
|
} else {
|
|
111
|
-
const queryData = queryClient.getQueryData(queryKey
|
|
111
|
+
const queryData = queryClient.getQueryData(queryKey) ?? {};
|
|
112
112
|
queryClient.setQueryData(queryKey, lodashSet(queryData, path, newData));
|
|
113
113
|
}
|
|
114
114
|
return updatedRecord;
|
|
@@ -135,7 +135,7 @@ export const useQueryModel = <T>(keyTracker: string, exact: boolean = true): Que
|
|
|
135
135
|
if (!path) {
|
|
136
136
|
queryClient.setQueryData(queryKey, newData);
|
|
137
137
|
} else {
|
|
138
|
-
const queryData = queryClient.getQueryData(queryKey
|
|
138
|
+
const queryData = queryClient.getQueryData(queryKey) ?? {};
|
|
139
139
|
queryClient.setQueryData(queryKey, lodashSet(queryData, path, newData));
|
|
140
140
|
}
|
|
141
141
|
return updated;
|
|
@@ -12,7 +12,7 @@ export const useRefetchQuery = async (queryKey: any[]) => {
|
|
|
12
12
|
{ throwOnError: true, cancelRefetch: true }
|
|
13
13
|
);
|
|
14
14
|
|
|
15
|
-
return queryClient.getQueriesData<T>(innerQueryKey ?? queryKey);
|
|
15
|
+
return queryClient.getQueriesData<T>({ queryKey: innerQueryKey ?? queryKey });
|
|
16
16
|
};
|
|
17
17
|
|
|
18
18
|
return { refetchQuery };
|
|
@@ -52,12 +52,13 @@ export const useDeleteRequest = <TResponse>(deleteOptions?: DefaultRequestOption
|
|
|
52
52
|
}
|
|
53
53
|
};
|
|
54
54
|
|
|
55
|
-
const query = useQuery<any, any, IRequestSuccess<TResponse>>(
|
|
56
|
-
[requestPath, {}],
|
|
57
|
-
({ queryKey }) =>
|
|
55
|
+
const query = useQuery<any, any, IRequestSuccess<TResponse>>({
|
|
56
|
+
queryKey: [requestPath, {}],
|
|
57
|
+
queryFn: ({ queryKey }) =>
|
|
58
58
|
new Promise<IRequestSuccess<TResponse> | IRequestError>((res, rej) => sendRequest(res, rej, queryKey)),
|
|
59
|
-
|
|
60
|
-
|
|
59
|
+
enabled: false,
|
|
60
|
+
...options,
|
|
61
|
+
});
|
|
61
62
|
|
|
62
63
|
const updatedPathAsync = async (link: string) => {
|
|
63
64
|
return setRequestPath(link);
|
|
@@ -78,8 +79,7 @@ export const useDeleteRequest = <TResponse>(deleteOptions?: DefaultRequestOption
|
|
|
78
79
|
): Promise<IRequestSuccess<TResponse> | undefined> => {
|
|
79
80
|
if (!isFutureQueriesPaused) {
|
|
80
81
|
// set enabled to be true for every delete
|
|
81
|
-
internalDeleteOptions = internalDeleteOptions ?? {};
|
|
82
|
-
internalDeleteOptions.enabled = true;
|
|
82
|
+
internalDeleteOptions = internalDeleteOptions ?? { queryKey: [] };
|
|
83
83
|
|
|
84
84
|
await setOptionsAsync(internalDeleteOptions);
|
|
85
85
|
await updatedPathAsync(link);
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { QueryKey, UseQueryOptions } from '@tanstack/react-query';
|
|
2
2
|
import { useInfiniteQuery, useQueryClient } from '@tanstack/react-query';
|
|
3
3
|
import { startTransition, useEffect, useMemo, useState } from 'react';
|
|
4
4
|
import { useEnvironmentVariables, useQueryConfig } from '../config';
|
|
@@ -110,19 +110,17 @@ export const useGetInfiniteRequest = <TResponse extends Record<string, any>>({
|
|
|
110
110
|
return pathname + '?' + queryParams.toString();
|
|
111
111
|
};
|
|
112
112
|
|
|
113
|
-
const query = useInfiniteQuery<any, any, IRequestSuccess<TResponse & { pagination: Pagination }>>(
|
|
114
|
-
[requestPath, {}],
|
|
115
|
-
({ pageParam = requestPath, queryKey }) =>
|
|
113
|
+
const query = useInfiniteQuery<any, any, IRequestSuccess<TResponse & { pagination: Pagination }>>({
|
|
114
|
+
queryKey: [requestPath, {}],
|
|
115
|
+
queryFn: ({ pageParam = requestPath, queryKey }) =>
|
|
116
116
|
new Promise<IRequestSuccess<TResponse & { pagination: Pagination }> | IRequestError>((res, rej) =>
|
|
117
|
-
sendRequest(res, rej, queryKey, pageParam)
|
|
117
|
+
sendRequest(res, rej, queryKey, pageParam as string)
|
|
118
118
|
),
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
}
|
|
125
|
-
);
|
|
119
|
+
enabled: load && !isFutureQueriesPaused,
|
|
120
|
+
getNextPageParam: (lastPage) => constructPaginationLink('next_page', lastPage),
|
|
121
|
+
getPreviousPageParam: (lastPage) => constructPaginationLink('previous_page', lastPage),
|
|
122
|
+
...options,
|
|
123
|
+
});
|
|
126
124
|
|
|
127
125
|
const setOptionsAsync = async (fetchOptions: any) => {
|
|
128
126
|
startTransition(() => {
|
|
@@ -139,12 +137,10 @@ export const useGetInfiniteRequest = <TResponse extends Record<string, any>>({
|
|
|
139
137
|
Array<any>
|
|
140
138
|
>
|
|
141
139
|
): Promise<
|
|
142
|
-
|
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
}
|
|
147
|
-
>
|
|
140
|
+
| IRequestSuccess<
|
|
141
|
+
TResponse & {
|
|
142
|
+
pagination: Pagination;
|
|
143
|
+
}
|
|
148
144
|
>
|
|
149
145
|
| undefined
|
|
150
146
|
> => {
|
|
@@ -177,7 +173,6 @@ export const useGetInfiniteRequest = <TResponse extends Record<string, any>>({
|
|
|
177
173
|
if (keyTracker) {
|
|
178
174
|
// set expiration time for the tracker
|
|
179
175
|
queryClient.setQueryDefaults([keyTracker], {
|
|
180
|
-
cacheTime: Infinity,
|
|
181
176
|
staleTime: Infinity,
|
|
182
177
|
});
|
|
183
178
|
|
|
@@ -78,15 +78,13 @@ export const useGetRequest = <TResponse extends Record<string, any>>({
|
|
|
78
78
|
}
|
|
79
79
|
};
|
|
80
80
|
|
|
81
|
-
const query = useQuery<any, any, IRequestSuccess<TResponse>>(
|
|
82
|
-
[requestPath, {}],
|
|
83
|
-
({ queryKey }) =>
|
|
81
|
+
const query = useQuery<any, any, IRequestSuccess<TResponse>>({
|
|
82
|
+
queryKey: [requestPath, {}],
|
|
83
|
+
queryFn: ({ queryKey }) =>
|
|
84
84
|
new Promise<IRequestSuccess<TResponse> | IRequestError>((res, rej) => sendRequest(res, rej, queryKey)),
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
}
|
|
89
|
-
);
|
|
85
|
+
enabled: load && !isFutureQueriesPaused,
|
|
86
|
+
...options,
|
|
87
|
+
});
|
|
90
88
|
|
|
91
89
|
useEffect(() => {
|
|
92
90
|
if (path) {
|
|
@@ -98,7 +96,6 @@ export const useGetRequest = <TResponse extends Record<string, any>>({
|
|
|
98
96
|
if (keyTracker) {
|
|
99
97
|
// set expiration time for the tracker
|
|
100
98
|
queryClient.setQueryDefaults([keyTracker], {
|
|
101
|
-
cacheTime: Infinity,
|
|
102
99
|
staleTime: Infinity,
|
|
103
100
|
});
|
|
104
101
|
|