feat: Type identifiers

asuc-octo · Nov 7, 2024 · 722d3b0 · 722d3b0
1 parent e915063
commit 722d3b0
Show file tree

Hide file tree

Showing 15 changed files with 159 additions and 62 deletions.
diff --git a/apps/backend/src/modules/class/resolver.ts b/apps/backend/src/modules/class/resolver.ts
@@ -1,3 +1,5 @@
+import { GraphQLError, GraphQLScalarType, Kind } from "graphql";
+
 import { getCourse } from "../course/controller";
 import { CourseModule } from "../course/generated-types/module-types";
 import { getGradeDistributionByClass } from "../grade-distribution/controller";
@@ -13,6 +15,51 @@ import { IntermediateClass, IntermediateSection } from "./formatter";
 import { ClassModule } from "./generated-types/module-types";
 
 const resolvers: ClassModule.Resolvers = {
+  ClassNumber: new GraphQLScalarType({
+    name: "ClassNumber",
+    parseValue: (value) => value,
+    serialize: (value) => value,
+    description:
+      "Unique class number (primary section number), such as 001 or 003",
+    parseLiteral(ast) {
+      if (ast.kind === Kind.STRING) return ast.value;
+
+      throw new GraphQLError("Provided value is not a class number", {
+        extensions: { code: "BAD_USER_INPUT" },
+      });
+    },
+  }),
+
+  SectionNumber: new GraphQLScalarType({
+    name: "SectionNumber",
+    parseValue: (value) => value,
+    serialize: (value) => value,
+    description: "Unique section number, such as 101, 105L, or 999",
+    parseLiteral(ast) {
+      if (ast.kind === Kind.STRING) return ast.value;
+
+      throw new GraphQLError("Provided value is not a section number", {
+        extensions: { code: "BAD_USER_INPUT" },
+      });
+    },
+  }),
+
+  SectionIdentifier: new GraphQLScalarType({
+    name: "SectionIdentifier",
+    parseValue: (value) => value,
+    serialize: (value) => value,
+    description:
+      "Unique 5-digit section identifier (CCN), such as 28082 or 67231",
+    parseLiteral(ast) {
+      if (ast.kind === Kind.INT && ast.value.length === 5)
+        return parseInt(ast.value);
+
+      throw new GraphQLError("Provided value is not a section identifier", {
+        extensions: { code: "BAD_USER_INPUT" },
+      });
+    },
+  }),
+
   Query: {
     class: async (_, { subject, courseNumber, number, year, semester }) => {
       const _class = await getClass(

diff --git a/apps/backend/src/modules/class/typedefs/class.ts b/apps/backend/src/modules/class/typedefs/class.ts
@@ -1,29 +1,31 @@
 import { gql } from "graphql-tag";
 
 export default gql`
+  scalar ClassNumber
+
   type Query {
     class(
       year: Int!
       semester: Semester!
       subject: String!
-      courseNumber: String!
-      number: String!
+      courseNumber: CourseNumber!
+      number: ClassNumber!
     ): Class
     section(
       year: Int!
       semester: Semester!
       subject: String!
-      courseNumber: String!
-      classNumber: String!
-      number: String!
+      courseNumber: CourseNumber!
+      classNumber: ClassNumber!
+      number: SectionNumber!
     ): Section
   }
 
   type Class {
     "Identifiers"
     subject: String!
-    courseNumber: String!
-    number: String!
+    courseNumber: CourseNumber!
+    number: ClassNumber!
     year: Int!
     semester: Semester!
     session: String!
@@ -84,15 +86,18 @@ export default gql`
     IOP
   }
 
+  scalar SectionNumber
+  scalar SectionIdentifier
+
   type Section {
     "Identifiers"
     subject: String!
-    courseNumber: String!
-    classNumber: String!
-    number: String!
+    courseNumber: CourseNumber!
+    classNumber: ClassNumber!
+    number: SectionNumber!
     year: Int!
     semester: Semester!
-    ccn: Int!
+    ccn: SectionIdentifier!
 
     "Relationships"
     class: Class!

diff --git a/apps/backend/src/modules/course/resolver.ts b/apps/backend/src/modules/course/resolver.ts
@@ -1,3 +1,5 @@
+import { GraphQLError, GraphQLScalarType, Kind } from "graphql";
+
 import { getGradeDistributionByCourse } from "../grade-distribution/controller";
 import {
   getAssociatedCourses,
@@ -9,6 +11,20 @@ import { IntermediateCourse } from "./formatter";
 import { CourseModule } from "./generated-types/module-types";
 
 const resolvers: CourseModule.Resolvers = {
+  CourseNumber: new GraphQLScalarType({
+    name: "CourseNumber",
+    parseValue: (value) => value,
+    serialize: (value) => value,
+    description: "Unique course number, such as 61A or C54",
+    parseLiteral(ast) {
+      if (ast.kind === Kind.STRING) return ast.value;
+
+      throw new GraphQLError("Provided value is not a course number", {
+        extensions: { code: "BAD_USER_INPUT" },
+      });
+    },
+  }),
+
   Query: {
     course: async (_, { subject, number }, _context, _info) => {
       const course = await getCourse(subject, number);

diff --git a/apps/backend/src/modules/course/typedefs/course.ts b/apps/backend/src/modules/course/typedefs/course.ts
@@ -1,15 +1,17 @@
 import { gql } from "graphql-tag";
 
 export default gql`
+  scalar CourseNumber
+
   type Query {
-    course(subject: String!, number: String!): Course
+    course(subject: String!, number: CourseNumber!): Course
     courses: [Course!]!
   }
 
   type Course {
     "Identifiers"
     subject: String!
-    number: String!
+    number: CourseNumber!
 
     "Relationships"
     classes: [Class!]!

diff --git a/apps/backend/src/modules/enrollment/typedefs/enrollment.ts b/apps/backend/src/modules/enrollment/typedefs/enrollment.ts
@@ -6,8 +6,8 @@ export default gql`
       year: Int!
       semester: Semester!
       subject: String!
-      courseNumber: String!
-      number: String!
+      courseNumber: CourseNumber!
+      number: SectionNumber!
     ): Section!
   }
 `;
diff --git a/apps/backend/src/modules/grade-distribution/typedefs/grade-distribution.ts b/apps/backend/src/modules/grade-distribution/typedefs/grade-distribution.ts
@@ -14,8 +14,8 @@ export default gql`
   type Query {
     grade(
       subject: String!
-      courseNumber: String!
-      classNumber: String
+      courseNumber: CourseNumber!
+      classNumber: ClassNumber
       year: Int
       semester: Semester
       givenName: String

diff --git a/apps/backend/src/modules/schedule/typedefs/schedule.ts b/apps/backend/src/modules/schedule/typedefs/schedule.ts
@@ -3,7 +3,7 @@ import { gql } from "graphql-tag";
 const typedef = gql`
   type SelectedClass {
     class: Class!
-    selectedSections: [Int!]
+    selectedSections: [SectionIdentifier!]
   }
 
   type Event {
@@ -20,7 +20,7 @@ const typedef = gql`
     name: String!
     createdBy: String!
     year: Int!
-    semester: String!
+    semester: Semester!
     term: Term!
     public: Boolean!
     classes: [SelectedClass!]!
@@ -43,9 +43,9 @@ const typedef = gql`
 
   input SelectedClassInput {
     subject: String!
-    courseNumber: String!
-    number: String!
-    sections: [Int!]!
+    courseNumber: CourseNumber!
+    number: ClassNumber!
+    sections: [SectionIdentifier!]!
   }
 
   input UpdateScheduleInput {
@@ -58,7 +58,7 @@ const typedef = gql`
   input CreateScheduleInput {
     name: String!
     year: Int!
-    semester: String!
+    semester: Semester!
     events: [EventInput!]
     classes: [SelectedClassInput!]
     public: Boolean

diff --git a/apps/backend/src/modules/user/typedefs/user.ts b/apps/backend/src/modules/user/typedefs/user.ts
@@ -14,15 +14,15 @@ const typedef = gql`
 
   input BookmarkedCourseInput {
     subject: String!
-    number: String!
+    number: CourseNumber!
   }
 
   input BookmarkedClassInput {
     year: Int!
     semester: Semester!
     subject: String!
-    courseNumber: String!
-    number: String!
+    courseNumber: CourseNumber!
+    number: ClassNumber!
   }
 
   input UpdateUserInput {