refactor type of searchAPIResult helper, fix course page console error

Author: js0mmer

site/src/helpers/planner.ts

@@ -90,7 +90,7 @@ export const expandPlanner = async (savedPlanner: SavedPlannerYearData[]): Promi
   let courseLookup: BatchCourseData = {};
   // only send request if there are courses
   if (courses.length > 0) {
-    courseLookup = (await searchAPIResults('courses', courses)) as BatchCourseData;
+    courseLookup = await searchAPIResults('courses', courses);
   }
 
   return new Promise((resolve) => {

site/src/helpers/util.tsx

@@ -34,30 +34,23 @@ export function getCourseTags(course: CourseGQLData) {
 }
 
 // helper function to search 1 result from course/professor page
-export function searchAPIResult(type: SearchType, name: string) {
-  return new Promise<CourseGQLData | ProfessorGQLData | undefined>((res) => {
-    let index: SearchIndex;
-    if (type === 'course') {
-      index = 'courses';
-    } else {
-      index = 'professors';
-    }
-    searchAPIResults(index, [name]).then((results) => {
-      if (Object.keys(results).length > 0) {
-        const key = Object.keys(results)[0];
-        res(results[key]);
-      } else {
-        res(undefined);
-      }
-    });
-  });
+export async function searchAPIResult<T extends SearchType>(
+  type: T,
+  name: string,
+): Promise<(T extends 'course' ? CourseGQLData : ProfessorGQLData) | undefined> {
+  const results = await searchAPIResults(`${type}s`, [name]);
+  if (Object.keys(results).length > 0) {
+    return Object.values(results)[0];
+  } else {
+    return undefined;
+  }
 }
 
 // helper function to query from API and transform to data used in redux
-export async function searchAPIResults(
-  index: SearchIndex,
+export async function searchAPIResults<T extends SearchIndex>(
+  index: T,
   names: string[],
-): Promise<BatchCourseData | BatchProfessorData> {
+): Promise<T extends 'courses' ? BatchCourseData : BatchProfessorData> {
   const data =
     index === 'courses'
       ? await trpc.courses.batch.mutate({ courses: names })
@@ -77,7 +70,7 @@ export async function searchAPIResults(
       transformed[key] = transformGQLData(index, data[id]);
     }
   }
-  return transformed;
+  return transformed as T extends 'courses' ? BatchCourseData : BatchProfessorData;
 }
 
 export const hourMinuteTo12HourString = ({ hour, minute }: { hour: number; minute: number }) =>

site/src/pages/CoursePage/index.tsx

@@ -13,7 +13,6 @@ import Error from '../../component/Error/Error';
 
 import { useAppSelector, useAppDispatch } from '../../store/hooks';
 import { setCourse } from '../../store/slices/popupSlice';
-import { CourseGQLData } from '../../types/types';
 import { getCourseTags, searchAPIResult, sortTerms } from '../../helpers/util';
 import './CoursePage.scss';
 
@@ -27,9 +26,9 @@ const CoursePage: FC = () => {
     if (id !== undefined) {
       searchAPIResult('course', id).then((course) => {
         if (course) {
-          dispatch(setCourse(course as CourseGQLData));
+          dispatch(setCourse(course));
           setError('');
-          document.title = `${courseGQLData.department + ' ' + courseGQLData.courseNumber} | PeterPortal`;
+          document.title = `${course.department + ' ' + course.courseNumber} | PeterPortal`;
         } else {
           setError(`Course ${id} does not exist!`);
         }

site/src/pages/ProfessorPage/index.tsx

@@ -12,7 +12,6 @@ import Error from '../../component/Error/Error';
 
 import { setProfessor } from '../../store/slices/popupSlice';
 import { useAppSelector, useAppDispatch } from '../../store/hooks';
-import { ProfessorGQLData } from '../../types/types';
 import { searchAPIResult, unionTerms } from '../../helpers/util';
 
 const ProfessorPage: FC = () => {
@@ -25,9 +24,9 @@ const ProfessorPage: FC = () => {
     if (id !== undefined) {
       searchAPIResult('professor', id).then((professor) => {
         if (professor) {
-          dispatch(setProfessor(professor as ProfessorGQLData));
+          dispatch(setProfessor(professor));
           setError('');
-          document.title = `${(professor as ProfessorGQLData).name} | PeterPortal`;
+          document.title = `${professor.name} | PeterPortal`;
         } else {
           setError(`Professor ${id} does not exist!`);
         }

site/src/pages/RoadmapPage/ImportTranscriptPopup.tsx

@@ -78,7 +78,7 @@ async function htmlFromFile(file: Blob): Promise<HTMLElement> {
 
 async function transcriptCourseDetails(quarters: TranscriptQuarter[]): Promise<BatchCourseData> {
   const courseIDs = quarters.flatMap((q) => q.courses).map(toCourseID);
-  const results = (await searchAPIResults('courses', courseIDs)) as BatchCourseData;
+  const results = await searchAPIResults('courses', courseIDs);
   return results;
 }