AdminGuesserProps - add admin prop type

api-platform · May 22, 2024 · 678b33e · 678b33e
1 parent 0cdf153
commit 678b33e
Show file tree

Hide file tree

Showing 3 changed files with 163 additions and 1 deletion.
diff --git a/src/AdminGuesser.test.tsx b/src/AdminGuesser.test.tsx
@@ -1,7 +1,10 @@
 import React from 'react';
+import { AdminUI, AuthContext } from 'react-admin';
+import type { AdminProps, AuthProvider } from 'react-admin';
 import ReactTestRenderer from 'react-test-renderer/shallow';
-import { AdminResourcesGuesser } from './AdminGuesser.js';
+import AdminGuesser, { AdminResourcesGuesser } from './AdminGuesser.js';
 import ResourceGuesser from './ResourceGuesser.js';
+import schemaAnalyzer from './hydra/schemaAnalyzer.js';
 import resources from './__fixtures__/resources.js';
 import { API_DATA } from './__fixtures__/parsedData.js';
 import type {
@@ -83,4 +86,36 @@ describe('<AdminGuesser />', () => {
 
     expect(renderer.getRenderOutput()).toMatchSnapshot();
   });
+
+  test('renders with admin element', () => {
+    const authProvider: AuthProvider = {
+      getPermissions: () => Promise.resolve(['user']),
+      getIdentity: () =>
+        Promise.resolve({
+          id: '/users/2',
+          fullName: 'Test User',
+          avatar: undefined,
+        }),
+      login: () => Promise.resolve(),
+      logout: () => Promise.resolve(),
+      checkAuth: () => Promise.resolve(),
+      checkError: () => Promise.resolve(),
+    };
+
+    const AdminEl = (props: AdminProps) => (
+      <AuthContext.Provider value={authProvider}>
+        <AdminUI {...props} />
+      </AuthContext.Provider>
+    );
+
+    renderer.render(
+      <AdminGuesser
+        admin={AdminEl}
+        dataProvider={dataProvider}
+        schemaAnalyzer={schemaAnalyzer()}
+      />,
+    );
+
+    expect(renderer.getRenderOutput()).toMatchSnapshot();
+  });
 });
diff --git a/src/AdminGuesser.tsx b/src/AdminGuesser.tsx
@@ -30,6 +30,7 @@ import useDisplayOverrideCode from './useDisplayOverrideCode.js';
 import type { ApiPlatformAdminDataProvider, SchemaAnalyzer } from './types.js';
 
 export interface AdminGuesserProps extends AdminProps {
+  admin?: ComponentType<AdminProps>;
   dataProvider: ApiPlatformAdminDataProvider;
   schemaAnalyzer: SchemaAnalyzer;
   includeDeprecated?: boolean;
@@ -214,6 +215,7 @@ AdminGuesser.propTypes = {
   children: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
   theme: PropTypes.object,
   includeDeprecated: PropTypes.bool,
+  admin: PropTypes.elementType,
 };
 /* eslint-enable tree-shaking/no-side-effects-in-initialization */
 

diff --git a/src/__snapshots__/AdminGuesser.test.tsx.snap b/src/__snapshots__/AdminGuesser.test.tsx.snap
@@ -2,6 +2,131 @@
 
 exports[`<AdminGuesser /> renders loading 1`] = `<Loading />`;
 
+exports[`<AdminGuesser /> renders with admin element 1`] = `
+<ErrorBoundary
+  fallbackRender={[Function]}
+  onError={[Function]}
+>
+  <AdminGuesser
+    admin={[Function]}
+    dataProvider={
+      {
+        "create": [Function],
+        "delete": [Function],
+        "deleteMany": [Function],
+        "getList": [Function],
+        "getMany": [Function],
+        "getManyReference": [Function],
+        "getOne": [Function],
+        "introspect": [Function],
+        "subscribe": [Function],
+        "unsubscribe": [Function],
+        "update": [Function],
+        "updateMany": [Function],
+      }
+    }
+    i18nProvider={
+      {
+        "changeLocale": [Function],
+        "getLocale": [Function],
+        "getLocales": [Function],
+        "translate": [Function],
+      }
+    }
+    schemaAnalyzer={
+      {
+        "getFieldNameFromSchema": [Function],
+        "getFieldType": [Function],
+        "getFiltersParametersFromSchema": [Function],
+        "getOrderParametersFromSchema": [Function],
+        "getSubmissionErrors": [Function],
+      }
+    }
+    theme={
+      {
+        "components": {
+          "MuiAutocomplete": {
+            "variants": [
+              {
+                "props": {},
+                "style": [Function],
+              },
+            ],
+          },
+          "MuiFilledInput": {
+            "styleOverrides": {
+              "root": {
+                "&$disabled": {
+                  "backgroundColor": "rgba(0, 0, 0, 0.04)",
+                },
+                "backgroundColor": "rgba(0, 0, 0, 0.04)",
+              },
+            },
+          },
+          "MuiFormControl": {
+            "defaultProps": {
+              "margin": "dense",
+              "size": "small",
+              "variant": "filled",
+            },
+          },
+          "MuiTextField": {
+            "defaultProps": {
+              "margin": "dense",
+              "size": "small",
+              "variant": "filled",
+            },
+            "variants": [
+              {
+                "props": {},
+                "style": [Function],
+              },
+            ],
+          },
+          "RaMenuItemLink": {
+            "styleOverrides": {
+              "root": {
+                "&.RaMenuItemLink-active": {
+                  "borderLeft": "3px solid #38a9b4",
+                },
+                "borderLeft": "3px solid #fff",
+              },
+            },
+          },
+        },
+        "palette": {
+          "background": {
+            "default": "#fafafb",
+          },
+          "mode": "light",
+          "primary": {
+            "contrastText": "#ffffff",
+            "dark": "#006a75",
+            "light": "#74dde7",
+            "main": "#38a9b4",
+          },
+          "secondary": {
+            "contrastText": "#fff",
+            "dark": "#0069c0",
+            "light": "#6ec6ff",
+            "main": "#288690",
+          },
+        },
+        "sidebar": {
+          "closedWidth": 50,
+          "width": 240,
+        },
+        "typography": {
+          "h6": {
+            "fontWeight": 400,
+          },
+        },
+      }
+    }
+  />
+</ErrorBoundary>
+`;
+
 exports[`<AdminGuesser /> renders with custom resources 1`] = `
 <AdminUI
   dataProvider={