chris/feat(#381): Implement User Role Access

api/apiFunctions.interface.ts

@@ -8,6 +8,15 @@ export interface IAccountData {
   password: string;
 }
 export interface IUser {
+  // for the appwrite auth collection
+  id: string;
+  email: string;
+  leagues: string[];
+  labels: string[];
+}
+
+export interface ICollectionuser {
+  // for the custom user collection
   id: string;
   email: string;
   leagues: string[];

api/apiFunctions.ts

@@ -8,6 +8,7 @@ import {
   ILeague,
   IGameWeek,
   IUser,
+  ICollectionuser,
   IWeeklyPicks,
   INFLTeam,
 } from './apiFunctions.interface';
@@ -74,7 +75,9 @@ export async function logoutAccount(): Promise<object | Error> {
  * @param userId - The user ID
  * @returns {Models.DocumentList<Models.Document> | Error} - The user object or an error
  */
-export async function getCurrentUser(userId: IUser['id']): Promise<IUser> {
+export async function getCurrentUser(
+  userId: IUser['id'],
+): Promise<ICollectionuser> {
   try {
     const user = await databases.listDocuments(
       appwriteConfig.databaseId,

context/AuthContextProvider.tsx

@@ -8,7 +8,7 @@ import { account } from '@/api/config';
 import { useRouter } from 'next/navigation';
 import { useDataStore } from '@/store/dataStore';
 import type { DataStore } from '@/store/dataStore';
-import { IUser } from '@/api/apiFunctions.interface';
+import { ICollectionuser, IUser } from '@/api/apiFunctions.interface';
 import { getCurrentUser } from '@/api/apiFunctions';
 import { loginAccount, logoutHandler } from './AuthHelper';
 import { usePathname } from 'next/navigation';
@@ -50,8 +50,12 @@ export const AuthContextProvider = ({
       getUser();
       return;
     }
+
     setIsSignedIn(true);
-  }, [user]);
+    if (pathname.startsWith('/admin')) {
+      !user.labels.includes('admin') && router.push('/');
+    }
+  }, [user, pathname]);
 
   /**
    * Authenticate and set session state
@@ -89,9 +93,8 @@ export const AuthContextProvider = ({
 
     try {
       const user = await account.get();
-      const userData: IUser = await getCurrentUser(user.$id);
-      updateUser(userData.id, userData.email, userData.leagues);
-      return userData;
+      const userData: ICollectionuser = await getCurrentUser(user.$id);
+      updateUser(userData.id, userData.email, userData.leagues, user.labels);
     } catch (error) {
       resetUser();
       setIsSignedIn(false);

store/dataStore.test.ts

@@ -6,6 +6,7 @@ const userData = {
   userId: '123',
   userEmail: '[email protected]',
   leagues: ['123456'],
+  labels: ['admin'],
 };
 
 const NFLTeam = [
@@ -50,11 +51,14 @@ describe('Data Store', () => {
           userData.userId,
           userData.userEmail,
           userData.leagues,
+          userData.labels,
         );
       });
 
       expect(result.current.user.id).toBe(userData.userId);
       expect(result.current.user.email).toBe(userData.userEmail);
+      expect(result.current.user.labels).toStrictEqual(userData.labels);
+      expect(result.current.user.leagues).toStrictEqual(userData.leagues);
     });
     it('Checks the reset user state matches default', () => {
       const { result } = renderHook(() => useDataStore());
@@ -64,12 +68,15 @@ describe('Data Store', () => {
           userData.userId,
           userData.userEmail,
           userData.leagues,
+          userData.labels,
         );
         result.current.resetUser();
       });
 
       expect(result.current.user.id).toBe('');
       expect(result.current.user.email).toBe('');
+      expect(result.current.user.labels).toStrictEqual([]);
+      expect(result.current.user.leagues).toStrictEqual([]);
     });
   });
 

store/dataStore.ts

@@ -30,6 +30,7 @@ interface IDataStoreAction {
     id: IUser['id'],
     email: IUser['email'],
     leagues: IUser['leagues'],
+    labels: IUser['labels'],
   ) => void;
   updateWeeklyPicks: ({
     leagueId,
@@ -56,6 +57,7 @@ const initialState: IDataStoreState = {
     id: '',
     email: '',
     leagues: [],
+    labels: [],
   },
   weeklyPicks: {
     leagueId: '',
@@ -101,12 +103,13 @@ export const useDataStore = create<DataStore>((set) => ({
    * @param leagues - The user league
    * @returns {void}
    */
-  updateUser: (id, email, leagues): void =>
+  updateUser: (id, email, leagues, labels): void =>
     set(
       produce((state: IDataStoreState) => {
         state.user.id = id;
         state.user.email = email;
         state.user.leagues = [...leagues];
+        state.user.labels = [...labels];
       }),
     ),
   /**

utils/utils.ts

@@ -144,3 +144,12 @@ export const getUserLeagues = async (
 export const getUserEntries = async (userId: IUser['id'], leagueId: ILeague['leagueId']): Promise<IEntry[]> => {
   return await getCurrentUserEntries(userId, leagueId);
 }
+
+/**
+ * Check if the route is an /admin route
+ * @param path - The path to check
+ * @returns {boolean} - Whether the route is an /admin route
+ */
+export const isAdminRoute = (path: string): boolean => {
+  return path.startsWith('/admin');
+};