#4001 guest definition hooks

staysgt · staysgt · commit 273ce76722a6 · 2026-04-11T16:18:28.000-04:00
diff --git a/src/backend/src/controllers/recruitment.controllers.ts b/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
@@ -119,7 +120,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,
@@ -128,6 +129,7 @@ export default class RecruitmentController {
         description,
         definitionId,
         order,
+        type,
         icon,
         buttonText,
         buttonLink
diff --git a/src/backend/src/prisma/migrations/20260411195905_guest_definition_type/migration.sql b/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';
diff --git a/src/backend/src/prisma/schema.prisma b/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])
diff --git a/src/backend/src/routes/recruitment.routes.ts b/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')).optional(),
   nonEmptyString(body('icon')).optional(),
   nonEmptyString(body('buttonText')).optional(),
   nonEmptyString(body('buttonLink')).optional(),
@@ -65,10 +66,11 @@ recruitmentRouter.post(
 );
 
 recruitmentRouter.post(
-  '/guestDefinition/:guestId/edit',
+  '/guestdefinition/:definitionId/edit',
   nonEmptyString(body('term')),
   nonEmptyString(body('description')),
   body('order').isInt(),
+  nonEmptyString(body('type')).optional(),
   nonEmptyString(body('icon')).optional(),
   nonEmptyString(body('buttonText')).optional(),
   nonEmptyString(body('buttonLink')).optional(),
diff --git a/src/backend/src/services/recruitment.services.ts b/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
       }
diff --git a/src/backend/src/transformers/recruitment-transformer.ts b/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) ?? GuestDefinitionType.INFO_PAGE
 });
diff --git a/src/frontend/src/apis/recruitment.api.ts b/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
+  });
+};
diff --git a/src/frontend/src/hooks/recruitment.hooks.ts b/src/frontend/src/hooks/recruitment.hooks.ts
@@ -1,13 +1,17 @@
 import { useMutation, useQuery, useQueryClient } from 'react-query';
-import { Milestone, FrequentlyAskedQuestion } from 'shared';
+import { Milestone, FrequentlyAskedQuestion, GuestDefinition, GuestDefinitionType } from 'shared';
 import {
   createFaq,
+  createGuestDefinition,
   createMilestone,
   deleteFaq,
+  deleteGuestDefinition,
   deleteMilestone,
   editFaq,
+  editGuestDefinition,
   editMilestone,
   getAllFaqs,
+  getAllGuestDefinitions,
   getAllMilestones
 } from '../apis/recruitment.api';
 
@@ -22,6 +26,16 @@ export interface FaqPayload {
   answer: string;
 }
 
+export interface GuestDefinitionPayload {
+  term: string;
+  description: string;
+  order: number;
+  type: GuestDefinitionType;
+  icon?: string;
+  buttonText?: string;
+  buttonLink?: string;
+}
+
 export const useAllMilestones = () => {
   return useQuery<Milestone[], Error>(['milestones'], async () => {
     const { data } = await getAllMilestones();
@@ -131,3 +145,58 @@ export const useDeleteFAQ = () => {
     }
   );
 };
+
+export const useAllGuestDefinitions = () => {
+  return useQuery<GuestDefinition[], Error>(['guestdefinitions'], async () => {
+    const { data } = await getAllGuestDefinitions();
+    return data;
+  });
+};
+
+export const useDeleteGuestDefinition = () => {
+  const queryClient = useQueryClient();
+  return useMutation<{ message: string }, Error, any>(
+    ['guestdefinitions', 'delete'],
+    async (definitionId: string) => {
+      const { data } = await deleteGuestDefinition(definitionId);
+      return data;
+    },
+    {
+      onSuccess: () => {
+        queryClient.invalidateQueries(['guestdefinitions']);
+      }
+    }
+  );
+};
+
+export const useCreateGuestDefinition = () => {
+  const queryClient = useQueryClient();
+  return useMutation<GuestDefinition, Error, GuestDefinitionPayload>(
+    ['guestdefinitions', 'create'],
+    async (payload) => {
+      const { data } = await createGuestDefinition(payload);
+      return data;
+    },
+    {
+      onSuccess: () => {
+        queryClient.invalidateQueries(['guestdefinitions']);
+      }
+    }
+  );
+};
+
+export const useEditGuestDefinitions = (id: string) => {
+  const queryClient = useQueryClient();
+  return useMutation<GuestDefinition, Error, GuestDefinitionPayload>(
+    ['guestdefinitions', 'edit'],
+    async (payload) => {
+      const { data } = await editGuestDefinition(payload, id);
+      return data;
+    },
+    {
+      onSuccess: () => {
+        queryClient.invalidateQueries(['guestdefinitions']);
+      }
+    }
+  );
+};
diff --git a/src/frontend/src/utils/urls.ts b/src/frontend/src/utils/urls.ts
@@ -395,6 +395,10 @@ const allFaqs = () => `${recruitment()}/faqs`;
 const faqCreate = () => `${recruitment()}/faq/create`;
 const faqEdit = (id: string) => `${recruitment()}/faq/${id}/edit`;
 const faqDelete = (id: string) => `${recruitment()}/faq/${id}/delete`;
+const allGuestDefinitions = () => `${recruitment()}/guestdefinitions`;
+const guestDefinitionDelete = (id: string) => `${recruitment()}/guestdefinition/${id}/delete`;
+const guestDefinitionCreate = () => `${recruitment()}/guestdefinition/create`;
+const guestDefintionEdit = (id: string) => `${recruitment()}/guestdefinition/${id}/edit`;
 
 /************** Onboarding Endpoints ***************/
 const onboarding = () => `${API_URL}/onboarding`;
@@ -782,6 +786,10 @@ export const apiUrls = {
   imageById,
   reorderTasks,
   reorderChecklistItems,
+  allGuestDefinitions,
+  guestDefinitionDelete,
+  guestDefinitionCreate,
+  guestDefintionEdit,
 
   popUps,
   popUpsCurrentUser,
diff --git a/src/shared/src/types/recruitment-types.ts b/src/shared/src/types/recruitment-types.ts
@@ -15,11 +15,17 @@ export interface FrequentlyAskedQuestion {
   dateDeleted?: Date;
 }
 
+export enum GuestDefinitionType {
+  PROJECT_MANAGEMENT = 'PROJECT_MANAGEMENT',
+  INFO_PAGE = 'INFO_PAGE'
+}
+
 export interface GuestDefinition {
   definitionId: string;
   term: string;
   description: string;
   order: number;
+  type: GuestDefinitionType;
   buttonText?: string;
   buttonLink?: string;
   icon?: string;
