Merge pull request #4149 from Northeastern-Electric-Racing/#4001-guest-definition-hooks

#4001 guest definition hooks

Author: wavehassman

src/backend/src/controllers/recruitment.controllers.ts

@@ -99,13 +99,14 @@ export default class RecruitmentController {
 
   static async createGuestDefinition(req: Request, res: Response, next: NextFunction) {
     try {
-      const { term, description, order, icon, buttonText, buttonLink } = req.body;
+      const { term, description, order, icon, type, buttonText, buttonLink } = req.body;
       const definition = await RecruitmentServices.createGuestDefinition(
         req.currentUser,
         req.organization,
         term,
         description,
         order,
+        type,
         icon,
         buttonText,
         buttonLink
@@ -130,7 +131,7 @@ export default class RecruitmentController {
   static async editGuestDefinition(req: Request, res: Response, next: NextFunction) {
     try {
       const { definitionId } = req.params as Record<string, string>;
-      const { term, description, order, icon, buttonText, buttonLink } = req.body;
+      const { term, description, order, type, icon, buttonText, buttonLink } = req.body;
 
       const definition = await RecruitmentServices.editGuestDefinition(
         req.currentUser,
@@ -139,6 +140,7 @@ export default class RecruitmentController {
         description,
         definitionId,
         order,
+        type,
         icon,
         buttonText,
         buttonLink

src/backend/src/prisma/migrations/20260411195905_guest_definition_type/migration.sql

@@ -0,0 +1,5 @@
+-- CreateEnum
+CREATE TYPE "Guest_Definition_Type" AS ENUM ('PROJECT_MANAGEMENT', 'INFO_PAGE');
+
+-- AlterTable
+ALTER TABLE "Guest_Definition" ADD COLUMN     "type" "Guest_Definition_Type" NOT NULL DEFAULT 'INFO_PAGE';

src/backend/src/prisma/schema.prisma

@@ -1787,21 +1787,27 @@ model Reimbursement_Request_Comment {
   @@index([reimbursementRequestId])
 }
 
+enum Guest_Definition_Type {
+  PROJECT_MANAGEMENT
+  INFO_PAGE
+}
+
 model Guest_Definition {
-  definitionId   String       @id @default(uuid())
+  definitionId   String                @id @default(uuid())
   term           String
   description    String
   order          Int
+  type           Guest_Definition_Type @default(INFO_PAGE)
   buttonText     String?
   buttonLink     String?
   icon           String?
-  dateCreated    DateTime     @default(now())
+  dateCreated    DateTime              @default(now())
   dateDeleted    DateTime?
-  userDeleted    User?        @relation(fields: [userDeletedId], references: [userId], name: "guestDefinitionDeleter")
+  userDeleted    User?                 @relation(fields: [userDeletedId], references: [userId], name: "guestDefinitionDeleter")
   userDeletedId  String?
-  userCreated    User         @relation(fields: [userCreatedId], references: [userId], name: "guestDefinitionCreator")
+  userCreated    User                  @relation(fields: [userCreatedId], references: [userId], name: "guestDefinitionCreator")
   userCreatedId  String
-  organization   Organization @relation(fields: [organizationId], references: [organizationId])
+  organization   Organization          @relation(fields: [organizationId], references: [organizationId])
   organizationId String
 
   @@index([organizationId])

src/backend/src/prisma/seed.ts

@@ -22,7 +22,15 @@ import { dbSeedAllTeams } from './seed-data/teams.seed.js';
 import { seedReimbursementRequests } from './seed-data/reimbursement-requests.seed.js';
 import ChangeRequestsService from '../services/change-requests.services.js';
 import TeamsService from '../services/teams.services.js';
-import { DayOfWeek, MaterialStatus, RoleEnum, StandardChangeRequest, WbsElementStatus, WorkPackageStage } from 'shared';
+import {
+  DayOfWeek,
+  GuestDefinitionType,
+  MaterialStatus,
+  RoleEnum,
+  StandardChangeRequest,
+  WbsElementStatus,
+  WorkPackageStage
+} from 'shared';
 import TasksService from '../services/tasks.services.js';
 import { seedProject } from './seed-data/projects.seed.js';
 import { seedWorkPackage } from './seed-data/work-packages.seed.js';
@@ -5120,6 +5128,7 @@ const performSeed: () => Promise<void> = async () => {
       term: 'NER',
       description: 'A really awesome organization!',
       order: 0,
+      type: 'INFO_PAGE',
       organizationId,
       userCreatedId: batman.userId
     }
@@ -5131,6 +5140,7 @@ const performSeed: () => Promise<void> = async () => {
     'Projects',
     'This is the definition of a project. Projects are blah blah blah',
     0,
+    GuestDefinitionType.PROJECT_MANAGEMENT,
     'bar_chart',
     'Click here to view all our projects!',
     '/projects'
@@ -5142,6 +5152,7 @@ const performSeed: () => Promise<void> = async () => {
     'Change Requests',
     'This is the definiton for a change request. Changes requests are blah blah blah',
     0,
+    GuestDefinitionType.PROJECT_MANAGEMENT,
     'bar_chart',
     'Click here to view all our change requests!',
     '/change-requests'
@@ -5153,6 +5164,7 @@ const performSeed: () => Promise<void> = async () => {
     'Gantt Chart',
     'This is the definiton for a change request. Changes requests are blah blah blah',
     0,
+    GuestDefinitionType.PROJECT_MANAGEMENT,
     'bar_chart',
     'Click here to view all our projects!',
     '/gantt'
@@ -5164,6 +5176,7 @@ const performSeed: () => Promise<void> = async () => {
     'Design Reviews',
     'This is the definiton for a design review. Design reviews are blah blah blah',
     0,
+    GuestDefinitionType.PROJECT_MANAGEMENT,
     'bar_chart',
     'Click here to view all our design reviews!',
     '/design-reviews'

src/backend/src/routes/recruitment.routes.ts

@@ -57,6 +57,7 @@ recruitmentRouter.post(
   nonEmptyString(body('term')),
   nonEmptyString(body('description')),
   body('order').isInt(),
+  nonEmptyString(body('type')),
   nonEmptyString(body('icon')).optional(),
   nonEmptyString(body('buttonText')).optional(),
   nonEmptyString(body('buttonLink')).optional(),
@@ -67,10 +68,11 @@ recruitmentRouter.post(
 recruitmentRouter.get('/guestdefinition/:definitionId', RecruitmentController.getSingleGuestDefinition);
 
 recruitmentRouter.post(
-  '/guestDefinition/:guestId/edit',
+  '/guestdefinition/:definitionId/edit',
   nonEmptyString(body('term')),
   nonEmptyString(body('description')),
   body('order').isInt(),
+  nonEmptyString(body('type')),
   nonEmptyString(body('icon')).optional(),
   nonEmptyString(body('buttonText')).optional(),
   nonEmptyString(body('buttonLink')).optional(),

src/backend/src/services/recruitment.services.ts

@@ -1,5 +1,5 @@
 import { Organization } from '@prisma/client';
-import { isAdmin, User } from 'shared';
+import { GuestDefinitionType, isAdmin, User } from 'shared';
 import prisma from '../prisma/prisma.js';
 import { AccessDeniedAdminOnlyException, DeletedException, NotFoundException } from '../utils/errors.utils.js';
 import { userHasPermission } from '../utils/users.utils.js';
@@ -221,6 +221,7 @@ export default class RecruitmentServices {
    * @param description the definition of the term
    * @param order the order the term appears on the page
    * @param icon the icon associated with the term
+   * @param type the type of the guest definition
    * @param buttonText the text displayed on the terms button
    * @param buttonLink where the terms button links to
    * @returns
@@ -231,6 +232,7 @@ export default class RecruitmentServices {
     term: string,
     description: string,
     order: number,
+    type: GuestDefinitionType,
     icon?: string,
     buttonText?: string,
     buttonLink?: string
@@ -243,6 +245,7 @@ export default class RecruitmentServices {
         term,
         description,
         order,
+        type,
         userCreatedId: creator.userId,
         organizationId: organization.organizationId,
         buttonText,
@@ -291,6 +294,7 @@ export default class RecruitmentServices {
    * @param description the definition of the term
    * @param order the order the term appears on the page
    * @param icon the icon associated with the term
+   * @param type the type of the guest definition
    * @param buttonText the text displayed on the terms button
    * @param buttonLink where the terms button links to
    * @returns
@@ -302,6 +306,7 @@ export default class RecruitmentServices {
     description: string,
     definitionId: string,
     order: number,
+    type: GuestDefinitionType,
     icon?: string,
     buttonText?: string,
     buttonLink?: string
@@ -332,6 +337,7 @@ export default class RecruitmentServices {
         description,
         order,
         icon,
+        type,
         buttonText,
         buttonLink
       }

src/backend/src/transformers/recruitment-transformer.ts

@@ -1,5 +1,5 @@
-import { Prisma } from '@prisma/client';
-import { FrequentlyAskedQuestion, GuestDefinition } from 'shared';
+import { Prisma, Guest_Definition_Type as PrismaGuestDefinitionType } from '@prisma/client';
+import { FrequentlyAskedQuestion, GuestDefinition, GuestDefinitionType } from 'shared';
 import { FaqQueryArgs } from '../prisma-query-args/faq.query-args.js';
 import { userTransformer } from './user.transformer.js';
 
@@ -12,12 +12,21 @@ export const faqTransformer = (faq: Prisma.FrequentlyAskedQuestionGetPayload<Faq
   dateDeleted: faq.dateDeleted ?? undefined
 });
 
+export const definitionTypeTransformer = (type: PrismaGuestDefinitionType): GuestDefinitionType => {
+  const mapping: Record<PrismaGuestDefinitionType, GuestDefinitionType> = {
+    PROJECT_MANAGEMENT: GuestDefinitionType.PROJECT_MANAGEMENT,
+    INFO_PAGE: GuestDefinitionType.INFO_PAGE
+  };
+  return mapping[type];
+};
+
 export const guestDefinitionTransformer = (guestDefinition: Prisma.Guest_DefinitionGetPayload<{}>): GuestDefinition => ({
   definitionId: guestDefinition.definitionId,
   term: guestDefinition.term,
   description: guestDefinition.description,
   order: guestDefinition.order,
   buttonText: guestDefinition.buttonText ?? undefined,
   buttonLink: guestDefinition.buttonLink ?? undefined,
-  icon: guestDefinition.icon ?? undefined
+  icon: guestDefinition.icon ?? undefined,
+  type: definitionTypeTransformer(guestDefinition.type)
 });

src/backend/tests/test-utils.ts

@@ -986,6 +986,7 @@ export const createTestGuestDefinition = async (user: User, organizationId: stri
       term: 'Term',
       description: 'Description',
       order: 0,
+      type: 'INFO_PAGE',
       organizationId,
       userCreatedId: user.userId
     }

src/backend/tests/unit/recruitment.test.ts

@@ -11,6 +11,7 @@ import {
   createTestUser,
   resetUsers
 } from '../test-utils.js';
+import { GuestDefinitionType } from 'shared';
 import {
   batmanAppAdmin,
   wonderwomanGuest,
@@ -351,6 +352,7 @@ describe('Recruitment Tests', () => {
         'test term',
         'test description',
         2,
+        GuestDefinitionType.INFO_PAGE,
         'iconname',
         'buttonTxt',
         'buttonLink'
@@ -372,6 +374,7 @@ describe('Recruitment Tests', () => {
             'test term',
             'test description',
             2,
+            GuestDefinitionType.INFO_PAGE,
             'iconname',
             'buttonTxt',
             'buttonLink'
@@ -414,6 +417,7 @@ describe('Recruitment Tests', () => {
             'test description',
             'test definition id',
             2,
+            GuestDefinitionType.INFO_PAGE,
             'buttonTxt',
             'buttonLink'
           )
@@ -430,6 +434,7 @@ describe('Recruitment Tests', () => {
             'description',
             'definition id',
             2,
+            GuestDefinitionType.INFO_PAGE,
             'buttonTxt',
             'buttonLink'
           )
@@ -443,6 +448,7 @@ describe('Recruitment Tests', () => {
         'test term',
         'test description',
         2,
+        GuestDefinitionType.INFO_PAGE,
         'iconname',
         'buttonTxt',
         'buttonLink'
@@ -455,6 +461,7 @@ describe('Recruitment Tests', () => {
         'new description',
         def.definitionId,
         4,
+        GuestDefinitionType.INFO_PAGE,
         'new icon',
         'new text',
         'new link'
@@ -475,6 +482,7 @@ describe('Recruitment Tests', () => {
         'test term',
         'test description',
         2,
+        GuestDefinitionType.INFO_PAGE,
         'iconname',
         'buttonTxt',
         'buttonLink'
@@ -493,6 +501,7 @@ describe('Recruitment Tests', () => {
             'description',
             def.definitionId,
             2,
+            GuestDefinitionType.INFO_PAGE,
             'buttonTxt',
             'buttonLink'
           )
@@ -579,6 +588,7 @@ describe('Recruitment Tests', () => {
         'test term',
         'test description',
         2,
+        GuestDefinitionType.INFO_PAGE,
         'iconname',
         'buttonTxt',
         'buttonLink'
@@ -590,6 +600,7 @@ describe('Recruitment Tests', () => {
         'test term',
         'test description',
         2,
+        GuestDefinitionType.INFO_PAGE,
         'iconname',
         'buttonTxt',
         'buttonLink'

src/frontend/src/apis/recruitment.api.ts

@@ -1,7 +1,7 @@
 import axios from '../utils/axios';
-import { MilestonePayload, FaqPayload } from '../hooks/recruitment.hooks';
+import { MilestonePayload, FaqPayload, GuestDefinitionPayload } from '../hooks/recruitment.hooks';
 import { apiUrls } from '../utils/urls';
-import { dateToMidnightUTC, Milestone } from 'shared';
+import { dateToMidnightUTC, GuestDefinition, Milestone } from 'shared';
 import { FrequentlyAskedQuestion } from 'shared';
 
 export const getAllMilestones = () => {
@@ -49,3 +49,25 @@ export const editFaq = (payload: FaqPayload, id: string) => {
 export const deleteFaq = (faqId: string) => {
   return axios.delete<{ message: string }>(apiUrls.faqDelete(faqId));
 };
+
+export const getAllGuestDefinitions = () => {
+  return axios.get<GuestDefinition[]>(apiUrls.allGuestDefinitions(), {
+    transformResponse: (data) => JSON.parse(data)
+  });
+};
+
+export const deleteGuestDefinition = (definitionId: string) => {
+  return axios.delete<{ message: string }>(apiUrls.guestDefinitionDelete(definitionId));
+};
+
+export const createGuestDefinition = (payload: GuestDefinitionPayload) => {
+  return axios.post(apiUrls.guestDefinitionCreate(), {
+    ...payload
+  });
+};
+
+export const editGuestDefinition = (payload: GuestDefinitionPayload, id: string) => {
+  return axios.post(apiUrls.guestDefintionEdit(id), {
+    ...payload
+  });
+};