-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
/
useGetMatching.ts
158 lines (149 loc) · 4.88 KB
/
useGetMatching.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
import { useSelector } from 'react-redux';
import get from 'lodash/get';
import { CRUD_GET_MATCHING } from '../actions/dataActions/crudGetMatching';
import {
Identifier,
PaginationPayload,
SortPayload,
Record,
ReduxState,
} from '../types';
import useQueryWithStore from './useQueryWithStore';
import {
getReferenceResource,
getPossibleReferenceValues,
getPossibleReferences,
} from '../reducer';
interface UseGetMatchingOptions {
onSuccess?: (args?: any) => void;
onFailure?: (error: any) => void;
enabled?: boolean;
[key: string]: any;
}
const referenceSource = (resource, source) => `${resource}@${source}`;
/**
* Call the dataProvider.getList() method return the resolved result
* as well as the loading state.
*
* React-admin uses a different store location for the result of this query
* than for useGetList(). Therefore, calling useGetMatching() does not modify
* the ids and total for the resource.
*
* The return value updates according to the request state:
*
* - start: { loading: true, loaded: false }
* - success: { data: [data from store], ids: [ids from response], total: [total from response], loading: false, loaded: true }
* - error: { error: [error from response], loading: false, loaded: true }
*
* This hook will return the cached result when called a second time
* with the same parameters, until the response arrives.
*
* @param {string} resource The referenced resource name, e.g. 'tags'
* @param {Object} pagination The request pagination { page, perPage }, e.g. { page: 1, perPage: 10 }
* @param {Object} sort The request sort { field, order }, e.g. { field: 'id', order: 'DESC' }
* @param {Object} filter The request filters, e.g. { title: 'hello, world' }
* @param {string} source The field in resource containing the ids of the referenced records, e.g. 'tag_ids'
* @param {string} referencingResource The resource name, e.g. 'posts'. Used to build a cache key
* @param {Object} options Options object to pass to the dataProvider.
* @param {boolean} options.enabled Flag to conditionally run the query. If it's false, the query will not run
* @param {Function} options.onSuccess Side effect function to be executed upon success, e.g. { onSuccess: { refresh: true } }
* @param {Function} options.onFailure Side effect function to be executed upon failure, e.g. { onFailure: error => notify(error.message) }
*
* @returns The current request state. Destructure as { data, total, ids, error, loading, loaded }.
*
* @example
*
* import { useGetMatching } from 'react-admin';
*
* const PostTags = () => {
* // call dataProvider.getList('tags', { pagination: { page: 1, perPage: 10 }, sort: { { field: 'published_at', order: 'DESC' } } })
* const { data, loading, error } = useGetMatching(
* 'tags',
* { page: 1, perPage: 10 },
* { field: 'published_at', order: 'DESC' },
* {},
* 'tag_ids',
* 'posts',
* );
* if (loading) { return <Loading />; }
* if (error) { return <p>ERROR</p>; }
* return <ul>{data.map(tag =>
* <li key={tag.id}>{tag.name}</li>
* )}</ul>;
* };
*/
const useGetMatching = (
resource: string,
pagination: PaginationPayload,
sort: SortPayload,
filter: object,
source: string,
referencingResource: string,
options?: UseGetMatchingOptions
): UseGetMatchingResult => {
const relatedTo = referenceSource(referencingResource, source);
const payload = { pagination, sort, filter };
const {
data: possibleValues,
total,
error,
loading,
loaded,
} = useQueryWithStore(
{
type: 'getList',
resource,
payload,
},
{
...options,
relatedTo,
action: CRUD_GET_MATCHING,
},
(state: ReduxState) =>
getPossibleReferenceValues(state, {
referenceSource,
resource: referencingResource,
source,
}),
(state: ReduxState) =>
get(
state.admin.resources,
[
resource,
'list',
'cachedRequests',
JSON.stringify(payload),
'total',
],
null
)
);
const referenceState = useSelector(state =>
getReferenceResource(state, {
reference: resource,
})
);
const possibleReferences = getPossibleReferences(
referenceState,
possibleValues,
[]
);
return {
data: possibleReferences,
ids: possibleValues,
total,
error,
loading,
loaded,
};
};
interface UseGetMatchingResult {
data: Record[];
ids: Identifier[];
total: number;
error?: any;
loading: boolean;
loaded: boolean;
}
export default useGetMatching;