Merge pull request #4148 from Northeastern-Electric-Racing/#4076-created-getGuestDefinition-endpoint

#4076: created getGuestDefinition endpoint

Author: wavehassman

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

@@ -116,6 +116,17 @@ export default class RecruitmentController {
     }
   }
 
+  static async getSingleGuestDefinition(req: Request, res: Response, next: NextFunction) {
+    try {
+      const { definitionId } = req.params as Record<string, string>;
+
+      const definition = await RecruitmentServices.getSingleGuestDefinition(req.organization, definitionId);
+      res.status(200).json(definition);
+    } catch (error: unknown) {
+      next(error);
+    }
+  }
+
   static async editGuestDefinition(req: Request, res: Response, next: NextFunction) {
     try {
       const { definitionId } = req.params as Record<string, string>;

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

@@ -64,6 +64,8 @@ recruitmentRouter.post(
   RecruitmentController.createGuestDefinition
 );
 
+recruitmentRouter.get('/guestdefinition/:definitionId', RecruitmentController.getSingleGuestDefinition);
+
 recruitmentRouter.post(
   '/guestDefinition/:guestId/edit',
   nonEmptyString(body('term')),

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

@@ -338,4 +338,23 @@ export default class RecruitmentServices {
     });
     return guestDefinitionTransformer(updatedGuest);
   }
+
+  /**
+   * Gets a single guest definition with the given user, organization, and definition ids
+   * @param organization the organization the user is currently in
+   * @param definitionId the id of the specific definition being found
+   * @returns a definition
+   * @throws if the definition is not found in the db
+   */
+  static async getSingleGuestDefinition(organization: Organization, definitionId: string) {
+    const guest = await prisma.guest_Definition.findUnique({
+      where: { organization, definitionId }
+    });
+
+    if (!guest) {
+      throw new NotFoundException('Guest Definition', definitionId);
+    }
+
+    return guestDefinitionTransformer(guest);
+  }
 }

src/backend/src/utils/errors.utils.ts

@@ -214,4 +214,5 @@ export type ExceptionObjectNames =
   | 'Guest Definition'
   | 'ProspectiveSponsor'
   | 'SponsorTier'
+  | 'Guest Definition'
   | 'Meeting Attendance';

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

@@ -379,6 +379,30 @@ describe('Recruitment Tests', () => {
       ).rejects.toThrow(new AccessDeniedAdminOnlyException('create a guest definition'));
     });
   });
+
+  describe('Get a single guest definition', () => {
+    it('Get a single guest definition works', async () => {
+      const guestDefinition = await RecruitmentServices.createGuestDefinition(
+        superman,
+        organization,
+        'test term',
+        'test description',
+        2,
+        'iconname',
+        'buttonTxt',
+        'buttonLink'
+      );
+      const result = await RecruitmentServices.getSingleGuestDefinition(organization, guestDefinition.definitionId);
+      expect(result).toStrictEqual(guestDefinition);
+    });
+
+    it('Get a single guest definition fails', async () => {
+      const nonExistingDefinitionId = 'nonExistingDefinition';
+      await expect(async () =>
+        RecruitmentServices.getSingleGuestDefinition(organization, nonExistingDefinitionId)
+      ).rejects.toThrow(new NotFoundException('Guest Definition', nonExistingDefinitionId));
+    });
+  });
   describe('Edit Guest Definition', () => {
     it('Fails if user is not an admin', async () => {
       await expect(