Derek/JOB-164 BE Company Verification System

backend/src/admin.ts

@@ -16,8 +16,10 @@ import {
   UnverifyCompanyAccountRequest,
   AdminCreateJobRequest,
   AdminApprovedJobPostsRequest,
+  AdminVerifiedCompaniesAddressesRequest,
 } from './types/request';
 import { env } from './environment';
+import AdminAccount from './entity/admin_account';
 
 const LM = new LogModule('ADMIN');
 
@@ -763,4 +765,141 @@ You job post request titled "${jobToReject.role}" has been rejected as it does n
       next,
     );
   }
+
+  public static async GetVerifiedCompaniesAddresses(
+    this: void,
+    req: GeneralAdminRequest,
+    res: Response,
+    next: NextFunction,
+  ) {
+    await Helpers.catchAndLogError(
+      res,
+      async (): Promise<IResponseWithStatus> => {
+        const { adminID } = req;
+        Helpers.requireParameters(adminID);
+
+        Logger.Info(LM, `ADMIN=${adminID} attempting to get verified companies email addresses`);
+
+        const verifiedAddresses = await Helpers.doSuccessfullyOrFail(
+          async () => AppDataSource.getRepository(AdminAccount)
+            .createQueryBuilder()
+            .select(['AdminAccount.verifiedCompaniesAddresses'])
+            .where('id = :id', { id: adminID })
+            .getOne(),
+          'Failed to retrieve verified companies email addresses',
+        );
+
+        Logger.Info(LM, `ADMIN=${adminID} successfully retrieved verified companies email addresses`);
+
+        return {
+          status: StatusCodes.OK,
+          msg: {
+            verifiedCompaniesAddresses: verifiedAddresses.verifiedCompaniesAddresses,
+            token: req.newJbToken,
+          },
+        };
+      },
+      () => ({
+        status: StatusCodes.BAD_REQUEST,
+        msg: { token: req.newJbToken },
+      }),
+      next,
+    );
+  }
+
+  public static async AddVerifiedCompaniesAddresses(
+    this: void,
+    req: AdminVerifiedCompaniesAddressesRequest,
+    res: Response,
+    next: NextFunction,
+  ) {
+    await Helpers.catchAndLogError(
+      res,
+      async (): Promise<IResponseWithStatus> => {
+        const { adminID } = req;
+        Helpers.requireParameters(adminID);
+        Logger.Info(LM, `ADMIN=${adminID} attempting to add verified companies email addresses`);
+
+        const adminAccount = await Helpers.doSuccessfullyOrFail(
+          async () => AppDataSource.getRepository(AdminAccount)
+            .createQueryBuilder()
+            .where('id = :id', { id: adminID })
+            .getOne(),
+          `Failed to request admin account ID=${adminID}`,
+        );
+
+        const addressesToAdd = req.body.verifiedCompaniesAddresses;
+        Helpers.requireParameters(addressesToAdd);
+
+        // Combine new addresses with existing ones, ensuring no duplicates
+        const allVerifiedAddresses = Array.from(
+          new Set(adminAccount.verifiedCompaniesAddresses.concat(addressesToAdd)),
+        );
+
+        // Update verifiedCompaniesAddresses column
+        adminAccount.verifiedCompaniesAddresses = allVerifiedAddresses;
+        await AppDataSource.getRepository(AdminAccount).save(adminAccount);
+
+        Logger.Info(LM, `ADMIN=${adminID} successfully added verified companies email addresses`);
+
+        return {
+          status: StatusCodes.OK,
+          msg: { token: req.newJbToken },
+        };
+      },
+      () => ({
+        status: StatusCodes.BAD_REQUEST,
+        msg: { token: req.newJbToken },
+      }),
+      next,
+    );
+  }
+
+  public static async DeleteVerifiedCompaniesAddresses(
+    this: void,
+    req: AdminVerifiedCompaniesAddressesRequest,
+    res: Response,
+    next: NextFunction,
+  ) {
+    await Helpers.catchAndLogError(
+      res,
+      async (): Promise<IResponseWithStatus> => {
+        const { adminID } = req;
+        Helpers.requireParameters(adminID);
+        Logger.Info(LM, `ADMIN=${adminID} attempting to delete verified companies email addresses`);
+
+        const adminAccount = await Helpers.doSuccessfullyOrFail(
+          async () => AppDataSource.getRepository(AdminAccount)
+            .createQueryBuilder()
+            .where('id = :id', { id: adminID })
+            .getOne(),
+          `Failed to request admin account ID=${adminID}`,
+        );
+
+        const addressesToDelete = req.body.verifiedCompaniesAddresses;
+        Helpers.requireParameters(addressesToDelete);
+
+        // Remove any addresses that appear in addressesToDelete
+        const allVerifiedAddresses = adminAccount.verifiedCompaniesAddresses.filter(
+          (address) => !addressesToDelete.includes(address),
+        );
+
+        // Update verifiedCompaniesAddresses column
+        adminAccount.verifiedCompaniesAddresses = allVerifiedAddresses;
+        await AppDataSource.getRepository(AdminAccount).save(adminAccount);
+
+        Logger.Info(LM, `ADMIN=${adminID} successfully deleted verified companies email addresses`);
+
+        return {
+          status: StatusCodes.OK,
+          msg: { token: req.newJbToken },
+        };
+      },
+      () => ({
+        status: StatusCodes.BAD_REQUEST,
+        msg: { token: req.newJbToken },
+      }),
+      next,
+    );
+  }
 }

backend/src/docs/openapi.json

@@ -994,6 +994,70 @@
             }
           }
         }
+      },
+      "/admin/verified-companies-addresses": {
+        "get": {
+          "summary": "Returns a list of verified companies addresses",
+          "description": "Query the database to get a list of email addresses belonging to verified companies submitted by admin",
+          "tags": [
+            "admin"
+          ],
+          "responses": {
+            "200": {
+              "description": "Successfully retrieved verified companies addresses",
+              "content": {
+                "application/json": {
+                  "schema": {
+                    "$ref": "#/components/schemas/VerifiedCompaniesAddresses"
+                  }
+                }
+              }
+            },
+            "400": {
+              "description": "Failed to query the database and retrieve verified companies addresses"
+            }
+          }
+        }
+      },
+      "/admin/verified-companies-addresses/add": {
+        "post": {
+          "summary": "Adds email addresses to list of known verified companies addresses",
+          "description": "Inserts specified email addresses into list of addresses belonging to verified companies in database",
+          "tags": [
+            "admin"
+          ],
+          "requestBody": {
+            "$ref": "#/components/requestBodies/VerifiedCompaniesAddressesBody"
+          },
+          "responses": {
+            "200": {
+              "description": "Successfully added verified companies addresses"
+            },
+            "400": {
+              "description": "Failed to add verified companies addresses"
+            }
+          }
+        }
+      },
+      "/admin/verified-companies-addresses/delete": {
+        "post": {
+          "summary": "Deletes email addresses from list of known verified companies addresses",
+          "description": "Deletes specified email addresses from list of addresses belonging to verified companies in database",
+          "tags": [
+            "admin"
+          ],
+          "requestBody": {
+            "$ref": "#/components/requestBodies/VerifiedCompaniesAddressesBody"
+          },
+          "responses": {
+            "200": {
+              "description": "Successfully added verified companies addresses"
+            },
+            "400": {
+              "description": "Failed to add verified companies addresses"
+            }
+          }
+        }
       }
     },
     "components": {
@@ -1241,6 +1305,28 @@
               }
             }
           }
+        },
+        "VerifiedCompaniesAddressesBody": {
+          "description": "JSON object containing list of email addresses of verified companies",
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "verifiedCompaniesAddresses": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    }
+                  }
+                }
+              },
+              "example": {
+                "verifiedCompaniesAddresses": ["[email protected]", "[email protected]"]
+              }
+            }
+          }
         }
       },
       "schemas": {
@@ -1567,6 +1653,20 @@
             "wam": "HD",
             "workingRights": "no_wr"
           }
+        },
+        "VerifiedCompaniesAddresses": {
+          "type": "object",
+          "properties": {
+            "verifiedCompaniesAddresses": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          },
+          "example": {
+            "verifiedCompaniesAddresses": ["[email protected]", "[email protected]"]
+          }
         }
       }
     }

backend/src/entity/admin_account.ts

@@ -20,6 +20,9 @@ export default class AdminAccount {
   @Column({ type: 'text', default: 'no token set' })
   public latestValidToken: string;
 
+  @Column('text', { array: true, default: '{}' })
+  public verifiedCompaniesAddresses: string[];
+
   @CreateDateColumn()
     createdAt: Date;
 

backend/src/index.ts

@@ -41,6 +41,7 @@ import {
   StudentGetJobRequest,
   StudentPaginatedJobsRequest,
   UpdateCompanyDetailsRequest,
+  AdminVerifiedCompaniesAddressesRequest,
   VerifyCompanyAccountRequest,
   UnverifyCompanyAccountRequest,
   SearchJobRequest,
@@ -518,6 +519,42 @@ app.put(
   Middleware.genericLoggingMiddleware,
 );
 
+app.get(
+  '/admin/verified-companies-addresses',
+  cors(corsOptions),
+  Middleware.authoriseAdminMiddleware,
+  (req: GeneralAdminRequest, res, next) => {
+    (async () => {
+      await AdminFunctions.GetVerifiedCompaniesAddresses(req, res, next);
+    })();
+  },
+  Middleware.genericLoggingMiddleware,
+);
+
+app.post(
+  '/admin/verified-companies-addresses/add',
+  cors(corsOptions),
+  Middleware.authoriseAdminMiddleware,
+  (req: AdminVerifiedCompaniesAddressesRequest, res, next) => {
+    (async () => {
+      await AdminFunctions.AddVerifiedCompaniesAddresses(req, res, next);
+    })();
+  },
+  Middleware.genericLoggingMiddleware,
+);
+
+app.post(
+  '/admin/verified-companies-addresses/delete',
+  cors(corsOptions),
+  Middleware.authoriseAdminMiddleware,
+  (req: AdminVerifiedCompaniesAddressesRequest, res, next) => {
+    (async () => {
+      await AdminFunctions.DeleteVerifiedCompaniesAddresses(req, res, next);
+    })();
+  },
+  Middleware.genericLoggingMiddleware,
+);
+
 if (env.NODE_ENV === 'development') {
   app.post('/email', (req, res) => {
     (async () => {

backend/src/types/request.ts

@@ -15,6 +15,7 @@ import {
   Offset,
   StudentZID,
   StudentProfileInfo,
+  VerifiedCompaniesAddresses,
   Year,
 } from './shared';
 
@@ -53,6 +54,9 @@ export interface AdminCreateJobRequest
 
 export interface AdminApprovedJobPostsRequest extends Request<YearParams>, AdminRequestBase {}
 
+export interface AdminVerifiedCompaniesAddressesRequest
+  extends Request<never, never, VerifiedCompaniesAddresses>, AdminRequestBase {}
+
 // * Student
 export interface StudentPaginatedJobsRequest
   extends Request<PaginatedJobsParams>,

backend/src/types/shared.ts

@@ -84,3 +84,7 @@ export interface AuthBody {
 export interface Year {
   year: string;
 }
+
+export interface VerifiedCompaniesAddresses {
+  verifiedCompaniesAddresses: string[];
+}