User Roles & Permissions

🔐 User Roles & Permissions

User roles are assigned upon account creation or by an admin through the user management system.
Roles determine access to features such as viewing, editing, adding, or deleting records.
Permissions are enforced on both the frontend (for hiding UI elements) and backend (for API protection).

---

👥 Defined Roles

🟣 Main Admin

• Full access to all features and settings
• Can manage users and assign roles
• Can perform all Admin and Editor actions

🔵 Admin

• Can add, edit, and delete donors, donations, and grants
• Can view and manage user invitations
• Cannot assign roles to other users

🟢 Editor

• Can add and edit records (donors, donations, grants)
• Cannot delete records or manage users

🟡 Viewer

• Read-only access to donor and grant data
• Cannot add, edit, or delete anything
• Best for auditing or observation

---

🛡️ Role Enforcement in the Application

• User object includes role data after login
• UI elements (e.g., "Add" buttons, "Edit" modals) are conditionally shown based on role
• API endpoints verify roles before executing sensitive actions
• Some role checks are still in progress — tracked as GitHub issues

---

📄 Pages Involved

• server/api/users/ — role assignment and updates
• middleware/auth.ts — route protection
• Pages with restricted actions:
  • /donors
  • /donations
  • /grants
  • /users

---

📝 Notes

• Roles are currently static, defined per user record
• Consider abstracting role checks into a reusable composable or helper function
• Future improvement: define roles as enums/constants in a shared roles.config.ts
• A full role-permission matrix could be implemented for flexibility