Merge remote-tracking branch 'origin' into #4025-guest-change-request-page

Author: staysgt

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

@@ -115,4 +115,13 @@ export default class RecruitmentController {
       next(error);
     }
   }
+
+  static async getAllGuestDefintions(req: Request, res: Response, next: NextFunction) {
+    try {
+      const allDefinitons = await RecruitmentServices.getAllGuestDefinitions(req.organization);
+      res.status(200).json(allDefinitons);
+    } catch (error: unknown) {
+      next(error);
+    }
+  }
 }

src/backend/src/prisma/seed.ts

@@ -41,6 +41,7 @@ import OnboardingServices from '../services/onboarding.services.js';
 import { dbSeedAllParts, dbSeedAllPartTags } from './seed-data/parts.seed.js';
 import FinanceServices from '../services/finance.services.js';
 import CalendarService from '../services/calendar.services.js';
+import { allChangeRequestsReviewed } from '../utils/change-requests.utils.js';
 
 const prisma = new PrismaClient();
 
@@ -3890,6 +3891,50 @@ const performSeed: () => Promise<void> = async () => {
     undefined,
     undefined
   );
+
+  await RecruitmentServices.createGuestDefinition(
+    thomasEmrax,
+    ner,
+    'Projects',
+    'This is the definition of a project. Projects are blah blah blah',
+    0,
+    'bar_chart',
+    'Click here to view all our projects!',
+    '/projects'
+  );
+
+  await RecruitmentServices.createGuestDefinition(
+    thomasEmrax,
+    ner,
+    'Change Requests',
+    'This is the definiton for a change request. Changes requests are blah blah blah',
+    0,
+    'bar_chart',
+    'Click here to view all our change requests!',
+    '/change-requests'
+  );
+
+  await RecruitmentServices.createGuestDefinition(
+    thomasEmrax,
+    ner,
+    'Gantt Chart',
+    'This is the definiton for a change request. Changes requests are blah blah blah',
+    0,
+    'bar_chart',
+    'Click here to view all our projects!',
+    '/gantt'
+  );
+
+  await RecruitmentServices.createGuestDefinition(
+    thomasEmrax,
+    ner,
+    'Design Reviews',
+    'This is the definiton for a design review. Design reviews are blah blah blah',
+    0,
+    'bar_chart',
+    'Click here to view all our design reviews!',
+    '/design-reviews'
+  );
 };
 
 performSeed()

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

@@ -62,4 +62,6 @@ recruitmentRouter.post(
   RecruitmentController.createGuestDefinition
 );
 
+recruitmentRouter.get('/guestDefinitions', RecruitmentController.getAllGuestDefintions);
+
 export default recruitmentRouter;

src/backend/src/services/part-review.services.ts

@@ -31,7 +31,7 @@ import {
   getPartReviewRequestQueryArgs,
   getPartSubmissionQueryArgs
 } from '../prisma-query-args/part-review.query-args.js';
-import { faqTransformer } from '../transformers/faq.transformer.js';
+import { faqTransformer } from '../transformers/recruitment-transformer.js';
 import {
   partReviewRequestTransformer,
   partsReviewCommonMistakeTransformer,

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

@@ -3,7 +3,7 @@ import { 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';
-import { faqTransformer } from '../transformers/faq.transformer.js';
+import { faqTransformer, guestDefinitionTransformer } from '../transformers/recruitment-transformer.js';
 import { getFaqQueryArgs } from '../prisma-query-args/faq.query-args.js';
 
 export default class RecruitmentServices {
@@ -251,6 +251,14 @@ export default class RecruitmentServices {
       }
     });
 
-    return definition;
+    return guestDefinitionTransformer(definition);
+  }
+
+  static async getAllGuestDefinitions(organization: Organization) {
+    const allGuestDefintions = await prisma.guest_Definition.findMany({
+      where: { organizationId: organization.organizationId, dateDeleted: null }
+    });
+
+    return allGuestDefintions.map(guestDefinitionTransformer);
   }
 }

src/backend/src/transformers/faq.transformer.ts

@@ -0,0 +1,23 @@
+import { Prisma } from '@prisma/client';
+import { FrequentlyAskedQuestion, GuestDefinition } from 'shared';
+import { FaqQueryArgs } from '../prisma-query-args/faq.query-args.js';
+import { userTransformer } from './user.transformer.js';
+
+export const faqTransformer = (faq: Prisma.FrequentlyAskedQuestionGetPayload<FaqQueryArgs>): FrequentlyAskedQuestion => ({
+  faqId: faq.faqId,
+  question: faq.question,
+  answer: faq.answer,
+  userCreated: userTransformer(faq.userCreated),
+  dateCreated: faq.dateCreated,
+  dateDeleted: faq.dateDeleted ?? undefined
+});
+
+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
+});

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

@@ -377,4 +377,33 @@ describe('Recruitment Tests', () => {
       ).rejects.toThrow(new AccessDeniedAdminOnlyException('create a guest definition'));
     });
   });
+
+  describe('Get All Guest Definitions', () => {
+    it('Succeeds and gets all the guest definitions', async () => {
+      const def = await RecruitmentServices.createGuestDefinition(
+        superman,
+        organization,
+        'test term',
+        'test description',
+        2,
+        'iconname',
+        'buttonTxt',
+        'buttonLink'
+      );
+
+      const def2 = await RecruitmentServices.createGuestDefinition(
+        superman,
+        organization,
+        'test term',
+        'test description',
+        2,
+        'iconname',
+        'buttonTxt',
+        'buttonLink'
+      );
+
+      const result = await RecruitmentServices.getAllGuestDefinitions(organization);
+      expect(result).toStrictEqual([def, def2]);
+    });
+  });
 });

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

@@ -256,6 +256,7 @@ const CreditsPage: React.FC = () => {
     { name: 'Amber Friar', color: '#F5A9B8' },
     { name: 'Kaung Mo', color: '#9a1115' },
     { name: 'Mae Balesterri', color: '#7fb2bc' },
+    { name: 'Nigel Purvis', color: '#E2725B' },
     {
       name: 'Joshua Goldberg',
       color: 'transparent',

src/frontend/src/pages/CreditsPage/CreditsPage.tsx

@@ -11,7 +11,7 @@ export * from './src/types/team-types.js';
 export * from './src/types/task-types.js';
 export * from './src/types/finance-types.js';
 export * from './src/types/reimbursement-requests-types.js';
-export * from './src/types/frequently-asked-questions-types.js';
+export * from './src/types/recruitment-types.js';
 export * from './src/types/milestone-types.js';
 export * from './src/types/checklist-types.js';
 export * from './src/types/pop-up-types.js';