backend onboarding

Author: gavxue

backend/typescript/graphql/index.ts

@@ -18,6 +18,8 @@ import userType from "./types/userType";
 import dashboardType from "./types/dashboardType";
 import dashboardResolvers from "./resolvers/dashboardResolvers";
 import reviewType from "./types/reviewType";
+import teamMemberType from "./types/teamMemberType";
+import teamMemberResolvers from "./resolvers/teamMemberResolvers";
 
 const query = gql`
   type Query {
@@ -41,13 +43,15 @@ const executableSchema = makeExecutableSchema({
     simpleEntityType,
     userType,
     dashboardType,
+    teamMemberType,
   ],
   resolvers: merge(
     authResolvers,
     entityResolvers,
     simpleEntityResolvers,
     userResolvers,
     dashboardResolvers,
+    teamMemberResolvers,
   ),
 });
 

backend/typescript/graphql/resolvers/teamMemberResolvers.ts

@@ -0,0 +1,31 @@
+import TeamMemberService from "../../services/implementations/teamMemberService";
+import { CreateTeamMemberDTO, TeamMemberDTO } from "../../types";
+import { getErrorMessage } from "../../utilities/errorUtils";
+
+const teamMemberService = new TeamMemberService();
+
+const teamMemberResolvers = {
+  Query: {
+    teamMembers: async (): Promise<TeamMemberDTO[]> => {
+      try {
+        return await teamMemberService.getTeamMembers();
+      } catch (error) {
+        throw new Error(getErrorMessage(error));
+      }
+    },
+  },
+  Mutation: {
+    createTeamMember: async (
+      _: unknown,
+      { input }: { input: CreateTeamMemberDTO },
+    ): Promise<TeamMemberDTO> => {
+      try {
+        return await teamMemberService.createTeamMember(input);
+      } catch (error) {
+        throw new Error(getErrorMessage(error));
+      }
+    },
+  },
+};
+
+export default teamMemberResolvers;

backend/typescript/graphql/types/teamMemberType.ts

@@ -0,0 +1,33 @@
+import { gql } from "apollo-server-express";
+
+const teamMemberType = gql`
+  enum TeamRole {
+    PM
+    DESIGNER
+    PL
+    DEVELOPER
+  }
+
+  type TeamMemberDTO {
+    id: ID!
+    firstName: String!
+    lastName: String!
+    teamRole: TeamRole!
+  }
+
+  input CreateTeamMemberDTO {
+    firstName: String!
+    lastName: String!
+    teamRole: TeamRole!
+  }
+
+  extend type Query {
+    teamMembers: [TeamMemberDTO!]!
+  }
+
+  extend type Mutation {
+    createTeamMember(input: CreateTeamMemberDTO!): TeamMemberDTO!
+  }
+`;
+
+export default teamMemberType;

backend/typescript/services/implementations/teamMemberService.ts

@@ -0,0 +1,46 @@
+import { TeamMemberDTO, CreateTeamMemberDTO } from "../../types";
+import logger from "../../utilities/logger";
+import { ITeamMemberService } from "../interfaces/ITeamMemberService";
+import PgTeamMembers from "../../models/teamMember.model";
+
+const Logger = logger(__filename);
+
+class TeamMemberService implements ITeamMemberService {
+  // eslint-disable-next-line class-methods-use-this
+  async getTeamMembers(): Promise<TeamMemberDTO[]> {
+    try {
+      const teamMembers: Array<PgTeamMembers> = await PgTeamMembers.findAll({
+        raw: true,
+      });
+      return teamMembers.map((member) => ({
+        id: member.id,
+        firstName: member.firstName,
+        lastName: member.lastName,
+        teamRole: member.teamRole,
+      }));
+    } catch (error: unknown) {
+      Logger.error(`Failed to get team members ${error}`);
+      throw error;
+    }
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  async createTeamMember(
+    teamMember: CreateTeamMemberDTO,
+  ): Promise<TeamMemberDTO> {
+    try {
+      const member = await PgTeamMembers.create(teamMember);
+      return {
+        id: member.id,
+        firstName: member.firstName,
+        lastName: member.lastName,
+        teamRole: member.teamRole,
+      };
+    } catch (error: unknown) {
+      Logger.error(`Failed to create team member: ${error}`);
+      throw error;
+    }
+  }
+}
+
+export default TeamMemberService;

backend/typescript/services/interfaces/ITeamMemberService.ts

@@ -0,0 +1,19 @@
+import { TeamMemberDTO, CreateTeamMemberDTO } from "../../types";
+
+export interface ITeamMemberService {
+  /**
+   * retrieve the Team Member with the given id
+   * @param id team member id
+   * @returns requested Team Member
+   * @throws Error if retrieval fails
+   */
+  getTeamMembers(): Promise<TeamMemberDTO[]>;
+
+  /**
+   * create a Team Member with the fields given in the DTO, return created Team Member
+   * @param teamMember new Team Member
+   * @returns the created Team Member
+   * @throws Error if creation fails
+   */
+  createTeamMember(teamMember: CreateTeamMemberDTO): Promise<TeamMemberDTO>;
+}

backend/typescript/types.ts

@@ -1,7 +1,7 @@
 export type Role = "User" | "Admin";
 
 export const teamRoleValues = ["PM", "Designer", "PL", "Developer"] as const;
-export type TeamRole = typeof teamRoleValues[number];
+export type TeamRole = (typeof teamRoleValues)[number];
 
 export enum StatusType {
   ACCEPTED = "accepted",
@@ -239,3 +239,12 @@ export type ReviewedApplicantRecordDTO = {
   review: Review;
   status: ReviewStatus;
 };
+
+export type TeamMemberDTO = {
+  id: string;
+  firstName: string;
+  lastName: string;
+  teamRole: TeamRole;
+};
+
+export type CreateTeamMemberDTO = Omit<TeamMemberDTO, "id">;