@firecms/user_management 3.0.0-canary.8 → 3.0.0-canary.80

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@firecms/user_management",
   "type": "module",
-  "version": "3.0.0-canary.8",
+  "version": "3.0.0-canary.80",
   "publishConfig": {
     "access": "public"
   },
@@ -22,39 +22,29 @@
       "require": "./dist/index.umd.js",
       "types": "./dist/index.d.ts"
     },
-    "./package.json": "./package.json",
-    "./tailwind.config.js": "./tailwind.config.js"
+    "./package.json": "./package.json"
   },
-  "packageManager": "yarn@4.1.0",
   "main": "./dist/index.umd.js",
   "module": "./dist/index.es.js",
   "types": "dist/index.d.ts",
   "source": "src/index.ts",
   "dependencies": {
-    "@firecms/core": "^3.0.0-canary.8",
-    "@firecms/formex": "^3.0.0-canary.8",
-    "@firecms/ui": "^3.0.0-canary.8",
+    "@firecms/core": "^3.0.0-canary.80",
+    "@firecms/formex": "^3.0.0-canary.80",
+    "@firecms/ui": "^3.0.0-canary.80",
     "date-fns": "^3.6.0"
   },
   "peerDependencies": {
-    "firebase": "^10.7.1",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0"
+    "firebase": "^10.12.2",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1"
   },
   "devDependencies": {
-    "@types/node": "^20.11.30",
-    "@types/react": "^18.2.67",
-    "@types/react-dom": "^18.2.22",
-    "@typescript-eslint/parser": "^7.3.1",
-    "eslint": "^8.57.0",
-    "eslint-config-standard": "^17.1.0",
-    "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-n": "^16.6.2",
-    "eslint-plugin-promise": "^6.1.1",
-    "eslint-plugin-react": "^7.34.1",
-    "eslint-plugin-react-hooks": "^4.6.0",
-    "typescript": "^5.4.2",
-    "vite": "^5.1.6"
+    "@types/node": "^20.14.9",
+    "@types/react": "^18.3.3",
+    "@types/react-dom": "^18.3.0",
+    "typescript": "^5.5.3",
+    "vite": "^5.3.2"
   },
   "scripts": {
     "dev": "vite",
@@ -64,14 +54,7 @@
   "files": [
     "dist",
     "src",
-    "tailwind.config.js",
     "bin"
   ],
-  "eslintConfig": {
-    "extends": [
-      "react-app",
-      "react-app/jest"
-    ]
-  },
-  "gitHead": "6d3cbe74b9d5ac0fbd7ee9110a92d0188a252f02"
+  "gitHead": "e41e7401fda1929c44300ada0b993e5b0703b7a1"
 }

package/src/UserManagementProvider.tsx

@@ -1,13 +1,14 @@
 import React, { PropsWithChildren } from "react";
-import { UserManagement, UserWithRoles } from "./types";
+import { UserManagement } from "./types";
+import { User } from "@firecms/core";
 
 export const UserManagementContext = React.createContext<UserManagement<any>>({} as any);
 
-export interface UserManagementProviderProps<U extends UserWithRoles = UserWithRoles> {
+export interface UserManagementProviderProps<U extends User = User> {
     userManagement: UserManagement<U>
 }
 
-export function UserManagementProvider<U extends UserWithRoles = UserWithRoles>({
+export function UserManagementProvider<U extends User = User>({
                                            children,
                                            userManagement
                                        }: PropsWithChildren<UserManagementProviderProps<U>>) {

package/src/components/roles/RoleChip.tsx

@@ -1,5 +1,5 @@
 import { Chip, getColorSchemeForSeed } from "@firecms/ui";
-import { Role } from "../../types";
+import { Role } from "@firecms/core";
 
 export type RoleChipProps = {
     role: Role;

package/src/components/roles/RolesDetailsForm.tsx

@@ -1,7 +1,7 @@
 import React, { useCallback, useState } from "react";
 import * as Yup from "yup";
 
-import { EntityCollection, FieldCaption, toSnakeCase, } from "@firecms/core";
+import { EntityCollection, FieldCaption, Role, toSnakeCase, } from "@firecms/core";
 import {
     Button,
     Checkbox,
@@ -24,7 +24,6 @@ import {
 } from "@firecms/ui";
 import { useUserManagement } from "../../hooks";
 import { Formex, getIn, useCreateFormex } from "@firecms/formex";
-import { Role } from "../../types";
 
 export const RoleYupSchema = Yup.object().shape({
     id: Yup.string().required("Required"),

package/src/components/roles/RolesTable.tsx

@@ -13,9 +13,8 @@ import {
     Tooltip,
     Typography
 } from "@firecms/ui";
-import { DeleteConfirmationDialog } from "@firecms/core";
+import { DeleteConfirmationDialog, Role } from "@firecms/core";
 import { useUserManagement } from "../../hooks";
-import { Role } from "../../types";
 import { RoleChip } from "./RoleChip";
 import { DEFAULT_ROLES } from "./default_roles";
 

package/src/components/roles/RolesView.tsx

@@ -1,11 +1,10 @@
 import React, { useCallback, useState } from "react";
 
-import { useNavigationController } from "@firecms/core";
+import { Role, useNavigationController } from "@firecms/core";
 import { AddIcon, Button, Container, Tooltip, Typography } from "@firecms/ui";
 import { RolesTable } from "./RolesTable";
 import { RolesDetailsForm } from "./RolesDetailsForm";
 import { useUserManagement } from "../../hooks";
-import { Role } from "../../types";
 
 export const RolesView = React.memo(
     function RolesView({ children }: { children?: React.ReactNode }) {

package/src/components/roles/default_roles.tsx

@@ -1,4 +1,4 @@
-import { Role } from "../../types";
+import { Role } from "@firecms/core";
 
 export const DEFAULT_ROLES: Role[] = [
     {

package/src/components/users/UserDetailsForm.tsx

@@ -12,10 +12,9 @@ import {
     TextField,
     Typography,
 } from "@firecms/ui";
-import { FieldCaption, useSnackbarController } from "@firecms/core";
+import { FieldCaption, Role, useAuthController, User, useSnackbarController } from "@firecms/core";
 import { Formex, useCreateFormex } from "@firecms/formex";
 
-import { Role, UserWithRoles } from "../../types";
 import { areRolesEqual } from "../../utils";
 import { useUserManagement } from "../../hooks";
 import { RoleChip } from "../roles";
@@ -26,17 +25,17 @@ export const UserYupSchema = Yup.object().shape({
     roles: Yup.array().min(1)
 });
 
-function canUserBeEdited(loggedUser: UserWithRoles, user: UserWithRoles, users: UserWithRoles[], roles: Role[], prevUser?: UserWithRoles) {
-    const admins = users.filter(u => u.roles.map(r => r.id).includes("admin"));
-    const loggedUserIsAdmin = loggedUser.roles.map(r => r.id).includes("admin");
-    const didRolesChange = !prevUser || !areRolesEqual(prevUser.roles, user.roles);
+function canUserBeEdited(loggedUser: User, user: User, users: User[], roles: Role[], prevUser?: User) {
+    const admins = users.filter(u => u.roles?.map(r => r.id).includes("admin"));
+    const loggedUserIsAdmin = loggedUser.roles?.map(r => r.id).includes("admin");
+    const didRolesChange = !prevUser || !areRolesEqual(prevUser.roles ?? [], user.roles ?? []);
 
     if (didRolesChange && !loggedUserIsAdmin) {
         throw new Error("Only admins can change roles");
     }
 
     // was the admin role removed
-    const adminRoleRemoved = prevUser && prevUser.roles.map(r => r.id).includes("admin") && !user.roles.map(r => r.id).includes("admin");
+    const adminRoleRemoved = prevUser && prevUser.roles?.map(r => r.id).includes("admin") && !user.roles?.map(r => r.id).includes("admin");
 
     // avoid removing the last admin
     if (adminRoleRemoved && admins.length === 1) {
@@ -51,20 +50,22 @@ export function UserDetailsForm({
                                     handleClose
                                 }: {
     open: boolean,
-    user?: UserWithRoles,
+    user?: User,
     handleClose: () => void
 }) {
 
     const snackbarController = useSnackbarController();
     const {
-        loggedInUser,
+        user: loggedInUser
+    } = useAuthController();
+    const {
         saveUser,
         users,
         roles,
     } = useUserManagement();
     const isNewUser = !userProp;
 
-    const onUserUpdated = useCallback((savedUser: UserWithRoles): Promise<UserWithRoles> => {
+    const onUserUpdated = useCallback((savedUser: User): Promise<User> => {
         if (!loggedInUser) {
             throw new Error("Logged user not found");
         }
@@ -81,7 +82,7 @@ export function UserDetailsForm({
             displayName: "",
             email: "",
             roles: roles.filter(r => r.id === "editor")
-        } as UserWithRoles,
+        } as User,
         validation: (values) => {
             return UserYupSchema.validate(values, { abortEarly: false })
                 .then(() => {
@@ -93,7 +94,7 @@ export function UserDetailsForm({
                     }, {});
                 });
         },
-        onSubmit: (user: UserWithRoles, formexController) => {
+        onSubmit: (user: User, formexController) => {
 
             return onUserUpdated(user)
                 .then(() => {
@@ -181,7 +182,7 @@ export function UserDetailsForm({
                             <div className={"col-span-12"}>
                                 <MultiSelect
                                     label="Roles"
-                                    value={values.roles.map(r => r.id) ?? []}
+                                    value={values.roles?.map(r => r.id) ?? []}
                                     onMultiValueChange={(value: string[]) => setFieldValue("roles", value.map(id => roles.find(r => r.id === id) as Role))}
                                     renderValue={(value: string) => {
                                         const userRole = roles

package/src/components/users/UsersTable.tsx

@@ -5,9 +5,9 @@ import * as locales from "date-fns/locale";
 
 import {
     defaultDateFormat,
-    DeleteConfirmationDialog,
+    DeleteConfirmationDialog, Role,
     useAuthController,
-    useCustomizationController,
+    useCustomizationController, User,
     useSnackbarController
 } from "@firecms/core";
 import {
@@ -23,19 +23,19 @@ import {
     Tooltip,
     Typography,
 } from "@firecms/ui";
-import { Role, UserWithRoles } from "../../types";
 import { useUserManagement } from "../../hooks";
 import { RoleChip } from "../roles";
+import { PersistedUser } from "../../types";
 
 export function UsersTable({ onUserClicked }: {
-    onUserClicked: (user: UserWithRoles) => void;
+    onUserClicked: (user: User) => void;
 }) {
 
     const {
         users,
         saveUser,
         deleteUser
-    } = useUserManagement();
+    } = useUserManagement<PersistedUser>();
 
     const authController = useAuthController();
     const snackbarController = useSnackbarController();
@@ -44,7 +44,7 @@ export function UsersTable({ onUserClicked }: {
     const dateUtilsLocale = customizationController?.locale ? locales[customizationController?.locale as keyof typeof locales] : undefined;
     const dateFormat: string = customizationController?.dateTimeFormat ?? defaultDateFormat;
 
-    const [userToBeDeleted, setUserToBeDeleted] = useState<UserWithRoles | undefined>(undefined);
+    const [userToBeDeleted, setUserToBeDeleted] = useState<User | undefined>(undefined);
     const [deleteInProgress, setDeleteInProgress] = useState<boolean>(false);
 
     return (

package/src/components/users/UsersView.tsx

@@ -3,19 +3,19 @@ import { AddIcon, Button, Container, Typography } from "@firecms/ui";
 import { UsersTable } from "./UsersTable";
 import { UserDetailsForm } from "./UserDetailsForm";
 import React, { useCallback, useState } from "react";
-import { UserWithRoles } from "../../types";
 import { useUserManagement } from "../../hooks/useUserManagement";
+import { User } from "@firecms/core";
 
 export const UsersView = function UsersView({ children }: { children?: React.ReactNode }) {
 
     const [dialogOpen, setDialogOpen] = useState<boolean>();
-    const [selectedUser, setSelectedUser] = useState<UserWithRoles | undefined>();
+    const [selectedUser, setSelectedUser] = useState<User | undefined>();
 
     const { users, usersLimit } = useUserManagement();
 
     const reachedUsersLimit = usersLimit !== undefined && (users && users.length >= usersLimit);
 
-    const onUserClicked = useCallback((user: UserWithRoles) => {
+    const onUserClicked = useCallback((user: User) => {
         setSelectedUser(user);
         setDialogOpen(true);
     }, []);

package/src/hooks/index.ts

@@ -1,2 +1,2 @@
-export * from "./useBuildFirestoreUserManagement";
+export * from "./useFirestoreUserManagement";
 export * from "./useUserManagement";

package/src/hooks/{useBuildFirestoreUserManagement.tsx → useFirestoreUserManagement.tsx}

@@ -1,17 +1,17 @@
-import React, { useCallback, useEffect, useRef } from "react";
+import React, { useCallback, useEffect } from "react";
 import {
+    addDoc,
     collection,
     deleteDoc,
     doc,
     DocumentSnapshot,
-    Firestore,
     getFirestore,
     onSnapshot,
     setDoc
-} from "firebase/firestore";
-import { FirebaseApp } from "firebase/app";
-import { Role, UserManagement, UserWithRoles } from "../types";
-import { AuthController, PermissionsBuilder, User } from "@firecms/core";
+} from "@firebase/firestore";
+import { FirebaseApp } from "@firebase/app";
+import { UserManagement } from "../types";
+import { Authenticator, PermissionsBuilder, Role, User } from "@firecms/core";
 import { resolveUserRolePermissions } from "../utils";
 
 type UserWithRoleIds = User & { roles: string[] };
@@ -37,12 +37,16 @@ export interface UserManagementParams {
      */
     rolesPath?: string;
 
+    /**
+     * Maximum number of users that can be created.
+     */
     usersLimit?: number;
 
+    /**
+     * Can the logged user edit roles
+     */
     canEditRoles?: boolean;
 
-    authController: AuthController;
-
     /**
      * If there are no roles in the database, provide a button to create the default roles.
      */
@@ -64,18 +68,15 @@ export interface UserManagementParams {
  * @param usersLimit
  * @param canEditRoles
  */
-export function useBuildFirestoreUserManagement({
-                                                    firebaseApp,
-                                                    usersPath = "__FIRECMS/config/users",
-                                                    rolesPath = "__FIRECMS/config/roles",
-                                                    usersLimit,
-                                                    canEditRoles = true,
-                                                    authController,
-                                                    allowDefaultRolesCreation,
-                                                    includeCollectionConfigPermissions
-                                                }: UserManagementParams): UserManagement {
-
-    const firestoreRef = useRef<Firestore>();
+export function useFirestoreUserManagement({
+                                               firebaseApp,
+                                               usersPath = "__FIRECMS/config/users",
+                                               rolesPath = "__FIRECMS/config/roles",
+                                               usersLimit,
+                                               canEditRoles = true,
+                                               allowDefaultRolesCreation,
+                                               includeCollectionConfigPermissions
+                                           }: UserManagementParams): UserManagement {
 
     const [rolesLoading, setRolesLoading] = React.useState<boolean>(true);
     const [usersLoading, setUsersLoading] = React.useState<boolean>(true);
@@ -85,27 +86,13 @@ export function useBuildFirestoreUserManagement({
     const users = usersWithRoleIds.map(u => ({
         ...u,
         roles: roles.filter(r => u.roles?.includes(r.id))
-    }) as UserWithRoles);
+    }) as User);
 
     const [rolesError, setRolesError] = React.useState<Error | undefined>();
     const [usersError, setUsersError] = React.useState<Error | undefined>();
 
     const loading = rolesLoading || usersLoading;
 
-    const loggedInUser: UserWithRoles | undefined = users.find(u => u.email?.toLowerCase() === authController.user?.email?.toLowerCase());
-    // console.log("authController", authController);
-    // if (!loading && !authController.authLoading) {
-    //     const user = authController.user;
-    //     if (user) {
-    //         loggedInUser = users.find(u => u.email?.toLowerCase() === user.email?.toLowerCase());
-    //     }
-    // }
-
-    useEffect(() => {
-        if (!firebaseApp) return;
-        firestoreRef.current = getFirestore(firebaseApp);
-    }, [firebaseApp]);
-
     useEffect(() => {
         if (!firebaseApp || !rolesPath) return;
         const firestore = getFirestore(firebaseApp);
@@ -118,12 +105,13 @@ export function useBuildFirestoreUserManagement({
                         const newRoles = docsToRoles(snapshot.docs);
                         setRoles(newRoles);
                     } catch (e) {
-                        // console.error(e);
+                        console.error("Error loading roles", e);
                         setRolesError(e as Error);
                     }
                     setRolesLoading(false);
                 },
                 error: (e) => {
+                    console.error("Error loading roles", e);
                     setRolesError(e);
                     setRolesLoading(false);
                 }
@@ -143,11 +131,13 @@ export function useBuildFirestoreUserManagement({
                         const newUsers = docsToUsers(snapshot.docs);
                         setUsersWithRoleIds(newUsers);
                     } catch (e) {
+                        console.error("Error loading users", e);
                         setUsersError(e as Error);
                     }
                     setUsersLoading(false);
                 },
                 error: (e) => {
+                    console.error("Error loading users", e);
                     setUsersError(e);
                     setUsersLoading(false);
                 }
@@ -155,21 +145,31 @@ export function useBuildFirestoreUserManagement({
         );
     }, [firebaseApp, usersPath]);
 
-    const saveUser = useCallback(async (user: UserWithRoles): Promise<UserWithRoles> => {
-        const firestore = firestoreRef.current;
-        if (!firestore || !usersPath) throw Error("useFirestoreConfigurationPersistence Firestore not initialised");
+    const saveUser = useCallback(async (user: User): Promise<User> => {
+        if (!firebaseApp) throw Error("useFirestoreUserManagement Firebase not initialised");
+        const firestore = getFirestore(firebaseApp);
+        if (!firestore || !usersPath) throw Error("useFirestoreUserManagement Firestore not initialised");
         console.debug("Persisting user", user);
-        const roleIds = user.roles.map(r => r.id);
+        const roleIds = user.roles?.map(r => r.id);
         const {
             uid,
             ...userData
         } = user;
-        return setDoc(doc(firestore, usersPath, uid), { ...userData, roles: roleIds }, { merge: true }).then(() => user);
-    }, [usersPath]);
+        const data = {
+            ...userData,
+            roles: roleIds
+        };
+        if (uid) {
+            return setDoc(doc(firestore, usersPath, uid), data, { merge: true }).then(() => user);
+        } else {
+            return addDoc(collection(firestore, usersPath), data).then(() => user);
+        }
+    }, [usersPath, firebaseApp]);
 
     const saveRole = useCallback((role: Role): Promise<void> => {
-        const firestore = firestoreRef.current;
-        if (!firestore || !rolesPath) throw Error("useFirestoreConfigurationPersistence Firestore not initialised");
+        if (!firebaseApp) throw Error("useFirestoreUserManagement Firebase not initialised");
+        const firestore = getFirestore(firebaseApp);
+        if (!firestore || !rolesPath) throw Error("useFirestoreUserManagement Firestore not initialised");
         console.debug("Persisting role", role);
         const {
             id,
@@ -177,46 +177,82 @@ export function useBuildFirestoreUserManagement({
         } = role;
         const ref = doc(firestore, rolesPath, id);
         return setDoc(ref, roleData, { merge: true });
-    }, [rolesPath]);
+    }, [rolesPath, firebaseApp]);
 
-    const deleteUser = useCallback(async (user: UserWithRoles): Promise<void> => {
-        const firestore = firestoreRef.current;
-        if (!firestore || !usersPath) throw Error("useFirestoreConfigurationPersistence Firestore not initialised");
+    const deleteUser = useCallback(async (user: User): Promise<void> => {
+        if (!firebaseApp) throw Error("useFirestoreUserManagement Firebase not initialised");
+        const firestore = getFirestore(firebaseApp);
+        if (!firestore || !usersPath) throw Error("useFirestoreUserManagement Firestore not initialised");
         console.debug("Deleting", user);
         const { uid } = user;
         return deleteDoc(doc(firestore, usersPath, uid));
-    }, [usersPath]);
+    }, [usersPath, firebaseApp]);
 
     const deleteRole = useCallback((role: Role): Promise<void> => {
-        const firestore = firestoreRef.current;
-        if (!firestore || !rolesPath) throw Error("useFirestoreConfigurationPersistence Firestore not initialised");
+        if (!firebaseApp) throw Error("useFirestoreUserManagement Firebase not initialised");
+        const firestore = getFirestore(firebaseApp);
+        if (!firestore || !rolesPath) throw Error("useFirestoreUserManagement Firestore not initialised");
         console.debug("Deleting", role);
         const { id } = role;
         const ref = doc(firestore, rolesPath, id);
         return deleteDoc(ref);
-    }, [rolesPath]);
+    }, [rolesPath, firebaseApp]);
 
     const collectionPermissions: PermissionsBuilder = useCallback(({
                                                                        collection,
+                                                                       user
                                                                    }) => resolveUserRolePermissions({
         collection,
-        user: loggedInUser ?? null
-    }), [loggedInUser?.uid]);
+        user
+    }), []);
+
+    const defineRolesFor: ((user: User) => Role[] | undefined) = useCallback((user) => {
+        if (!users) throw Error("Users not loaded");
+        const mgmtUser = users.find(u => u.email?.toLowerCase() === user?.email?.toLowerCase());
+        return mgmtUser?.roles;
+    }, [users]);
+
+    const authenticator: Authenticator = useCallback(({ user }) => {
+        console.debug("Authenticating user", user);
+
+        if (loading) {
+            console.warn("User management is still loading");
+            return false;
+        }
+
+        // This is an example of how you can link the access system to the user management plugin
+        if (users.length === 0) {
+            return true; // If there are no users created yet, we allow access to every user
+        }
+
+        const mgmtUser = users.find(u => u.email?.toLowerCase() === user?.email?.toLowerCase());
+        if (mgmtUser) {
+            return true;
+        }
+
+        throw Error("Could not find a user with the provided email in the user management system.");
+    }, [loading, users]);
+
+    const isAdmin = roles.some(r => r.id === "admin");
 
     return {
         loading,
-        loggedInUser,
         roles,
         users,
         saveUser,
         saveRole,
+        rolesError,
         deleteUser,
         deleteRole,
         usersLimit,
+        usersError,
+        isAdmin,
         canEditRoles: canEditRoles === undefined ? true : canEditRoles,
         allowDefaultRolesCreation: allowDefaultRolesCreation === undefined ? true : allowDefaultRolesCreation,
         includeCollectionConfigPermissions: Boolean(includeCollectionConfigPermissions),
-        collectionPermissions
+        collectionPermissions,
+        defineRolesFor,
+        authenticator
     }
 }
 

package/src/hooks/useUserManagement.tsx

@@ -1,5 +1,5 @@
 import { useContext } from "react";
-import { UserManagement } from "../types/user_management";
+import { UserManagement } from "../types";
 import { UserManagementContext } from "../UserManagementProvider";
-
-export const useUserManagement = () => useContext<UserManagement>(UserManagementContext);
+import { User } from "@firecms/core";
+export const useUserManagement = <USER extends User>() => useContext<UserManagement<USER>>(UserManagementContext);

package/src/types/index.ts

@@ -1,3 +1,2 @@
-export * from "./firecms_user";
-export * from "./roles";
 export * from "./user_management";
+export * from "./persisted_user";

package/src/types/persisted_user.ts

@@ -0,0 +1,6 @@
+import { User } from "@firecms/core";
+
+export type PersistedUser = User & {
+    updated_on?: Date;
+    created_on?: Date;
+}

package/src/types/user_management.tsx

@@ -1,18 +1,9 @@
-import { UserWithRoles } from "./firecms_user";
-import { Role } from "./roles";
-import { PermissionsBuilder } from "@firecms/core";
+import { Authenticator, PermissionsBuilder, Role, User } from "@firecms/core";
 
-export type UserManagement<USER extends UserWithRoles = UserWithRoles> = {
+export type UserManagement<USER extends User = User> = {
 
     loading: boolean;
 
-    /**
-     * The user currently logged in, in the user management system.
-     * This is the same user that is logged in the Authenticator, but with the roles
-     * and permissions loaded.
-     */
-    loggedInUser: USER | undefined;
-
     users: USER[];
     saveUser: (user: USER) => Promise<USER>;
     deleteUser: (user: USER) => Promise<void>;
@@ -31,6 +22,11 @@ export type UserManagement<USER extends UserWithRoles = UserWithRoles> = {
      */
     canEditRoles?: boolean;
 
+    /**
+     * Is the logged user Admin?
+     */
+    isAdmin?: boolean;
+
     /**
      * Include a button to create default roles, in case there are no roles in the system.
      */
@@ -47,4 +43,19 @@ export type UserManagement<USER extends UserWithRoles = UserWithRoles> = {
      */
     collectionPermissions: PermissionsBuilder;
 
+    /**
+     * Define the roles for a given user. You will typically want to plug this into your auth controller.
+     * @param user
+     */
+    defineRolesFor: (user: User) => Promise<Role[] | undefined> | Role[] | undefined;
+
+    /**
+     * You can build an authenticator callback from the current configuration of the user management.
+     * It will only allow access to users with the required roles.
+     */
+    authenticator?: Authenticator;
+
+    rolesError?: Error;
+    usersError?: Error;
+
 };