Invite Learner API

backend/middlewares/validators/authValidators.ts

@@ -44,7 +44,7 @@ export const signupRequestValidator = async (
   return next();
 };
 
-export const inviteAdminRequestValidator = async (
+export const inviteUserRequestValidator = async (
   req: Request,
   res: Response,
   next: NextFunction,

backend/models/user.mgmodel.ts

@@ -11,6 +11,14 @@ export interface User extends Document {
   status: Status;
 }
 
+export interface Learner extends User {
+  facilitator: ObjectId;
+}
+
+export interface Facilitator extends User {
+  learners: Array<ObjectId>;
+}
+
 const baseOptions = {
   discriminatorKey: "role",
   timestamps: true,
@@ -75,12 +83,15 @@ const LearnerSchema = new Schema({
   },
 });
 
-const Administrator = UserModel.discriminator(
+const AdministratorModel = UserModel.discriminator(
   "Administrator",
   AdministratorSchema,
 );
-const Facilitator = UserModel.discriminator("Facilitator", FacilitatorSchema);
-const Learner = UserModel.discriminator("Learner", LearnerSchema);
+const FacilitatorModel = UserModel.discriminator<Facilitator>(
+  "Facilitator",
+  FacilitatorSchema,
+);
+const LearnerModel = UserModel.discriminator<Learner>("Learner", LearnerSchema);
 
-export { Administrator, Facilitator, Learner };
+export { AdministratorModel, FacilitatorModel, LearnerModel };
 export default UserModel;

backend/rest/authRoutes.ts

@@ -10,7 +10,7 @@ import {
 import {
   loginRequestValidator,
   signupRequestValidator,
-  inviteAdminRequestValidator,
+  inviteUserRequestValidator,
   forgotPasswordRequestValidator,
   updateTemporaryPasswordRequestValidator,
   updateUserStatusRequestValidator,
@@ -173,7 +173,7 @@ authRouter.post("/isUserVerified/:email", async (req, res) => {
 
 authRouter.post(
   "/inviteAdmin",
-  inviteAdminRequestValidator,
+  inviteUserRequestValidator,
   isAuthorizedByRole(new Set(["Administrator"])),
   async (req, res) => {
     try {
@@ -197,6 +197,39 @@ authRouter.post(
   },
 );
 
+authRouter.post(
+  "/inviteLearner",
+  inviteUserRequestValidator,
+  isAuthorizedByRole(new Set(["Facilitator"])),
+  async (req, res) => {
+    try {
+      const temporaryPassword = generate({
+        length: 20,
+        numbers: true,
+      });
+      const invitedLearnerUser = await userService.createLearner(
+        {
+          firstName: req.body.firstName,
+          lastName: req.body.lastName,
+          email: req.body.email,
+          role: "Learner",
+          password: temporaryPassword,
+          status: "Invited",
+        },
+        req.body.facilitatorId,
+      );
+      await authService.sendLearnerInvite(
+        req.body.firstName,
+        req.body.email,
+        temporaryPassword,
+      );
+      res.status(200).json(invitedLearnerUser);
+    } catch (error: unknown) {
+      res.status(500).json({ error: getErrorMessage(error) });
+    }
+  },
+);
+
 // /* Reset password through a "Forgot Password" option */
 authRouter.post(
   "/forgotPassword",

backend/services/implementations/authService.ts

@@ -181,6 +181,45 @@ class AuthService implements IAuthService {
     }
   }
 
+  async sendLearnerInvite(
+    firstName: string,
+    email: string,
+    temporaryPassword: string,
+  ): Promise<void> {
+    if (!this.emailService) {
+      const errorMessage =
+        "Attempted to call sendLearnerInvite but this instance of AuthService does not have an EmailService instance";
+      Logger.error(errorMessage);
+      throw new Error(errorMessage);
+    }
+
+    const emailVerificationLink = await firebaseAdmin
+      .auth()
+      .generateEmailVerificationLink(email);
+
+    const emailBody = `Hello ${firstName},
+      <br><br>
+      Welcome to Smart Saving, Smart Spending!
+      <br><br>
+      Please click the link to confirm your account: <a href=${emailVerificationLink}>Confirm my account</a>
+      <br>
+      If the link has expired, ask your facilitator to invite you again.
+      <br><br>
+      To log in for the first time, use the following email and password:
+      <br><br>
+      Email: <strong>${email}</strong>
+      <br>
+      Password: <strong>${temporaryPassword}</strong>
+      <br><br>
+      Happy learning!`;
+
+    await this.emailService.sendEmail(
+      email,
+      "Welcome to Smart Saving, Smart Spending!",
+      emailBody,
+    );
+  }
+
   async isAuthorizedByRole(
     accessToken: string,
     roles: Set<Role>,

backend/services/implementations/userService.ts

@@ -1,10 +1,15 @@
 import * as firebaseAdmin from "firebase-admin";
-
 import { ObjectId } from "mongoose";
 import IUserService from "../interfaces/userService";
-import MgUser, { User } from "../../models/user.mgmodel";
+import MgUser, {
+  Learner,
+  User,
+  LearnerModel,
+  FacilitatorModel,
+} from "../../models/user.mgmodel";
 import {
   CreateUserDTO,
+  LearnerDTO,
   Role,
   Status,
   UpdateUserDTO,
@@ -184,6 +189,55 @@ class UserService implements IUserService {
     };
   }
 
+  async createLearner(
+    user: CreateUserDTO,
+    facilitatorId: string,
+  ): Promise<LearnerDTO> {
+    let newLearner: Learner;
+    let firebaseUser: firebaseAdmin.auth.UserRecord;
+    try {
+      firebaseUser = await firebaseAdmin.auth().createUser({
+        email: user.email,
+        password: user.password,
+      });
+      try {
+        newLearner = await LearnerModel.create({
+          ...user,
+          authId: firebaseUser.uid,
+          facilitator: facilitatorId,
+        });
+        await FacilitatorModel.findByIdAndUpdate(
+          facilitatorId,
+          { $push: { learners: newLearner.id } },
+          { runValidators: true },
+        );
+      } catch (mongoError) {
+        try {
+          await firebaseAdmin.auth().deleteUser(firebaseUser.uid);
+        } catch (firebaseError: unknown) {
+          const errorMessage = [
+            "Failed to rollback Firebase user creation after MongoDB user creation failure. Reason =",
+            getErrorMessage(firebaseError),
+            "Orphaned authId (Firebase uid) =",
+            firebaseUser.uid,
+          ];
+          Logger.error(errorMessage.join(" "));
+        }
+        throw mongoError;
+      }
+    } catch (err: unknown) {
+      Logger.error(
+        `Failed to create learner. Reason = ${getErrorMessage(err)}`,
+      );
+      throw err;
+    }
+
+    return {
+      ...newLearner.toObject(),
+      email: firebaseUser.email ?? "",
+    };
+  }
+
   async updateUserById(
     userId: ObjectId | string,
     user: UpdateUserDTO,

backend/services/interfaces/authService.ts

@@ -52,6 +52,18 @@ interface IAuthService {
    */
   sendAdminInvite(email: string, temporaryPassword: string): Promise<void>;
 
+  /**
+   * Sends an email invitation to an invited learner with the temporary password specified
+   * @param email email of new learner invited
+   * @param temporaryPassword the new learner's temporary password
+   * @throws Error if unable to generate link or send email
+   */
+  sendLearnerInvite(
+    firstName: string,
+    email: string,
+    temporaryPassword: string,
+  ): Promise<void>;
+
   /**
    * Changes a user's password
    * @param email the user's email address

backend/services/interfaces/userService.ts

@@ -65,6 +65,15 @@ interface IUserService {
    */
   createUser(user: CreateUserDTO, authId?: string): Promise<UserDTO>;
 
+  /**
+   * Create a learner, link them to their facilitator, and add them to their facilitator's learner list
+   * @param user the user to be created
+   * @param facilitatorId the auth ID of the facilitator to link the new learner to
+   * @returns a UserDTO with the created learner's information
+   * @throws Error if user creation fails
+   */
+  createLearner(user: CreateUserDTO, facilitatorId: string): Promise<UserDTO>;
+
   /**
    * Update a user.
    * Note: the password cannot be updated using this method, use IAuthService.resetPassword instead

frontend/src/theme/theme.ts

@@ -8,7 +8,6 @@ import { TypographyStyleOptions } from "@mui/material/styles/createTypography";
 import { error, learner, administrator, facilitator, neutral } from "./palette";
 import "@fontsource/lexend-deca";
 
-
 // adding custom attributes to palette
 declare module "@mui/material/styles" {
   // allow configuration using `createTheme`