refactor: convert Grade to enum

src/api/config/index.ts

@@ -1,4 +1,4 @@
-import type { Grade } from "../types";
+import type { Grade } from "../services/common/types";
 import type { Config } from "./types";
 
 export const CONFIG: Config = {

src/api/config/types.ts

@@ -1,4 +1,4 @@
-import type { Grade } from "../types";
+import type { Grade } from "../services/common/types";
 
 export type StudyConfig = {
   organization: string;

src/api/index.ts

@@ -1,3 +1,2 @@
-export type { Submission } from "./services/common/types";
+export type { Grade, Submission } from "./services/common/types";
 export { getMembers } from "./services/store/storeService";
-export type { Grade } from "./types";

src/api/services/common/fixtures.ts

@@ -1,11 +1,10 @@
 import type { StudyConfig } from "../../config/types";
 import type {
-  GitHubTeam,
   GitHubMember,
+  GitHubTeam,
   GitHubTree,
 } from "../../infra/gitHub/types";
-import { Grades, type Grade } from "../../types";
-import type { Submission } from "./types";
+import { Grade, Submission } from "./types";
 
 export const mockStudyConfig: StudyConfig = {
   organization: "test-org",
@@ -158,7 +157,7 @@ export const mockMembers = mockGitHubMembers.map((member) => ({
     { memberId: member.login, problemTitle: "problem2", language: "ts" },
   ],
   progress: 50,
-  grade: member.login === "algo" ? Grades.BIG_TREE : Grades.SPROUT,
+  grade: member.login === "algo" ? Grade.BIG_TREE : Grade.SPROUT,
 }));
 
 export const mockSubmissions: Submission[] = [

src/api/services/common/types.ts

@@ -1,5 +1,12 @@
 export type Cohort = number;
 
+export enum Grade {
+  SEED = "SEED",
+  SPROUT = "SPROUT",
+  SMALL_TREE = "SMALL_TREE",
+  BIG_TREE = "BIG_TREE",
+}
+
 export type MemberIdentity = {
   id: string; // lowercase
   name: string;
@@ -22,7 +29,7 @@ export interface Member {
   profileUrl?: string;
   /** Unit: % */
   progress: number;
-  grade: "SEED" | "SPROUT" | "SMALL_TREE" | "BIG_TREE";
+  grade: Grade;
   /** Example: ["best-time-to-buy-and-sell-stock", "3sum", "climbing-stairs", ...] */
   solvedProblems: string[];
 }

src/api/services/process/processService.test.ts

@@ -1,6 +1,6 @@
 import { expect, test } from "vitest";
-import { Grades } from "../../types";
 import { mockConfig, mockMembers, mockSubmissions } from "../common/fixtures";
+import { Grade } from "../common/types";
 import { createProcessService } from "./processService";
 
 const processService = createProcessService(mockConfig);
@@ -16,7 +16,7 @@ test("initialize members", () => {
       ...mockMembers.find((m) => m.id === member.id),
       solvedProblems: [],
       progress: 0,
-      grade: Grades.SEED,
+      grade: Grade.SEED,
     });
   });
 });
@@ -76,8 +76,8 @@ test("assign correct grades based on submissions", () => {
   const daleInfo = result.find((m) => m.id === "dale")!;
 
   // mockConfig gradeThresholds: BIG_TREE(3), SMALL_TREE(2), SPROUT(1), SEED(0)
-  expect(algoInfo.grade).toBe(Grades.BIG_TREE); // large or equal to 3
-  expect(daleInfo.grade).toBe(Grades.SPROUT); // large or equal to 1
+  expect(algoInfo.grade).toBe(Grade.BIG_TREE); // large or equal to 3
+  expect(daleInfo.grade).toBe(Grade.SPROUT); // large or equal to 1
 });
 
 test("calculate correct progress percentages", () => {
@@ -94,5 +94,5 @@ test("calculate correct progress percentages", () => {
   // Assert
   const algoInfo = result.find((m) => m.id === "algo")!;
   expect(algoInfo.progress).toBe(100); // 4/4 * 100
-  expect(algoInfo.grade).toBe(Grades.BIG_TREE);
+  expect(algoInfo.grade).toBe(Grade.BIG_TREE);
 });

src/api/services/process/processService.ts

@@ -1,6 +1,10 @@
 import type { Config } from "../../config/types";
-import { type Grade, Grades } from "../../types";
-import type { Member, MemberIdentity, Submission } from "../common/types";
+import {
+  Grade,
+  type Member,
+  type MemberIdentity,
+  type Submission,
+} from "../common/types";
 
 export function createProcessService(config: Config) {
   return {
@@ -26,7 +30,7 @@ const initializeMemberMap = (
       ...member,
       solvedProblems: [],
       progress: 0,
-      grade: Grades.SEED,
+      grade: Grade.SEED,
     };
   });
 
@@ -81,5 +85,5 @@ const determineGrade = (
     ([, threshold]) => totalSubmissions >= threshold,
   );
 
-  return grade ? grade[0] : Grades.SEED;
+  return grade ? grade[0] : Grade.SEED;
 };

src/hooks/useMembers.test.ts

@@ -2,7 +2,7 @@ import { faker } from "@faker-js/faker";
 import { renderHook, waitFor } from "@testing-library/react";
 import { expect, test, vi } from "vitest";
 
-import type { Member } from "../api/services/common/types";
+import { Grade, type Member } from "../api/services/common/types";
 import useMembers from "./useMembers";
 
 test("fetch member info successfully and update state", async () => {
@@ -12,12 +12,7 @@ test("fetch member info successfully and update state", async () => {
     cohort: faker.number.int({ min: 1, max: 10 }),
     profileUrl: faker.internet.url(),
     progress: faker.number.int({ min: 0, max: 100 }),
-    grade: faker.helpers.arrayElement([
-      "SEED",
-      "SPROUT",
-      "SMALL_TREE",
-      "BIG_TREE",
-    ]),
+    grade: faker.helpers.arrayElement(Object.values(Grade)),
     solvedProblems: Array.from({ length: 5 }, () =>
       faker.lorem.words(3).replaceAll(" ", "-"),
     ),