-
-
Notifications
You must be signed in to change notification settings - Fork 130
/
AdminGuesser.tsx
247 lines (222 loc) · 7.17 KB
/
AdminGuesser.tsx
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
import React, { useCallback, useEffect, useMemo, useState } from 'react';
import PropTypes from 'prop-types';
import {
Admin,
ComponentPropType,
I18nContextProvider,
Loading,
ThemeProvider,
defaultI18nProvider,
} from 'react-admin';
import { createHashHistory, createMemoryHistory } from 'history';
import { ErrorBoundary } from 'react-error-boundary';
import type { FallbackProps } from 'react-error-boundary';
import type { ComponentType, ErrorInfo } from 'react';
import type { AdminProps, ErrorProps } from 'react-admin';
import type { Resource } from '@api-platform/api-doc-parser';
import IntrospectionContext from './IntrospectionContext.js';
import ResourceGuesser from './ResourceGuesser.js';
import SchemaAnalyzerContext from './SchemaAnalyzerContext.js';
import {
Error as DefaultError,
Layout,
LoginPage,
lightTheme,
} from './layout/index.js';
import getRoutesAndResourcesFromNodes, {
isSingleChildFunction,
} from './getRoutesAndResourcesFromNodes.js';
import useDisplayOverrideCode from './useDisplayOverrideCode.js';
import type { ApiPlatformAdminDataProvider, SchemaAnalyzer } from './types.js';
export interface AdminGuesserProps extends AdminProps {
dataProvider: ApiPlatformAdminDataProvider;
schemaAnalyzer: SchemaAnalyzer;
includeDeprecated?: boolean;
}
interface AdminGuesserWithErrorProps extends AdminGuesserProps {
error?: ComponentType<ErrorProps>;
}
interface AdminResourcesGuesserProps extends Omit<AdminProps, 'loading'> {
admin?: ComponentType<AdminProps>;
includeDeprecated: boolean;
loading: boolean;
loadingPage?: ComponentType;
resources: Resource[];
}
const getOverrideCode = (resources: Resource[]) => {
let code =
'If you want to override at least one resource, paste this content in the <AdminGuesser> component of your app:\n\n';
resources.forEach((r) => {
code += `<ResourceGuesser name={"${r.name}"} />\n`;
});
return code;
};
/**
* AdminResourcesGuesser automatically renders an `<AdminUI>` component for resources exposed by a web API documented with Hydra, OpenAPI or any other format supported by `@api-platform/api-doc-parser`.
* If child components are passed (usually `<ResourceGuesser>` or `<Resource>` components, but it can be any other React component), they are rendered in the given order.
* If no children are passed, a `<ResourceGuesser>` component is created for each resource type exposed by the API, in the order they are specified in the API documentation.
*/
export const AdminResourcesGuesser = ({
// Admin props
loadingPage: LoadingPage = Loading,
admin: AdminEl = Admin,
// Props
children,
includeDeprecated,
resources,
loading,
...rest
}: AdminResourcesGuesserProps) => {
const displayOverrideCode = useDisplayOverrideCode();
if (loading) {
return <LoadingPage />;
}
let adminChildren = children;
const { resources: resourceChildren, customRoutes } =
getRoutesAndResourcesFromNodes(children);
if (
!isSingleChildFunction(adminChildren) &&
resourceChildren.length === 0 &&
resources
) {
const guessResources = includeDeprecated
? resources
: resources.filter((r) => !r.deprecated);
adminChildren = [
...customRoutes,
...guessResources.map((r) => (
<ResourceGuesser name={r.name} key={r.name} />
)),
];
displayOverrideCode(getOverrideCode(guessResources));
}
return (
<AdminEl loading={LoadingPage} {...rest}>
{adminChildren}
</AdminEl>
);
};
const AdminGuesser = ({
// Props for SchemaAnalyzerContext
schemaAnalyzer,
// Props for AdminResourcesGuesser
includeDeprecated = false,
// Admin props
dataProvider,
history,
layout = Layout,
loginPage = LoginPage,
loading: loadingPage,
theme = lightTheme,
// Other props
children,
...rest
}: AdminGuesserProps) => {
const [resources, setResources] = useState<Resource[]>([]);
const [loading, setLoading] = useState(true);
const [, setError] = useState();
const [introspect, setIntrospect] = useState(true);
let adminHistory = history;
if (!adminHistory) {
adminHistory =
typeof window === 'undefined'
? createMemoryHistory()
: createHashHistory();
}
useEffect(() => {
if (typeof dataProvider.introspect !== 'function') {
throw new Error(
'The given dataProvider needs to expose an "introspect" function returning a parsed API documentation from api-doc-parser',
);
}
if (!introspect) {
return;
}
dataProvider
.introspect()
.then(({ data }) => {
setResources(data.resources ?? []);
setIntrospect(false);
setLoading(false);
})
.catch((error) => {
// Allow error to be caught by the error boundary
setError(() => {
throw error;
});
});
}, [introspect, dataProvider]);
const introspectionContext = useMemo(
() => ({
introspect: () => {
setLoading(true);
setIntrospect(true);
},
}),
[setLoading, setIntrospect],
);
return (
<IntrospectionContext.Provider value={introspectionContext}>
<SchemaAnalyzerContext.Provider value={schemaAnalyzer}>
<AdminResourcesGuesser
includeDeprecated={includeDeprecated}
resources={resources}
loading={loading}
dataProvider={dataProvider}
history={adminHistory}
layout={layout}
loginPage={loginPage}
loadingPage={loadingPage}
theme={theme}
{...rest}>
{children}
</AdminResourcesGuesser>
</SchemaAnalyzerContext.Provider>
</IntrospectionContext.Provider>
);
};
/* eslint-disable tree-shaking/no-side-effects-in-initialization */
AdminGuesser.propTypes = {
dataProvider: PropTypes.oneOfType([PropTypes.object, PropTypes.func])
.isRequired,
authProvider: PropTypes.oneOfType([PropTypes.object, PropTypes.func]),
i18nProvider: PropTypes.oneOfType([PropTypes.object, PropTypes.func]),
history: PropTypes.object,
customSagas: PropTypes.array,
initialState: PropTypes.object,
schemaAnalyzer: PropTypes.object.isRequired,
children: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
theme: PropTypes.object,
includeDeprecated: PropTypes.bool,
};
/* eslint-enable tree-shaking/no-side-effects-in-initialization */
const AdminGuesserWithError = ({
error: ErrorComponent = DefaultError,
i18nProvider = defaultI18nProvider,
theme = lightTheme,
...props
}: AdminGuesserWithErrorProps) => {
const [errorInfo, setErrorInfo] = useState<ErrorInfo>();
const handleError = (_error: Error, info: ErrorInfo) => {
setErrorInfo(info);
};
const renderError = useCallback(
(fallbackRenderProps: FallbackProps) => (
<ErrorComponent {...fallbackRenderProps} errorInfo={errorInfo} />
),
[ErrorComponent, errorInfo],
);
return (
<I18nContextProvider value={i18nProvider}>
<ThemeProvider theme={theme}>
<ErrorBoundary onError={handleError} fallbackRender={renderError}>
<AdminGuesser {...props} i18nProvider={i18nProvider} theme={theme} />
</ErrorBoundary>
</ThemeProvider>
</I18nContextProvider>
);
};
AdminGuesserWithError.propTypes = {
error: ComponentPropType,
};
export default AdminGuesserWithError;