refactor: extract types to .types.ts

laurelin60 · Dec 5, 2024 · b84b215 · b84b215
1 parent 5029213
commit b84b215
Show file tree

Hide file tree

Showing 10 changed files with 61 additions and 56 deletions.
diff --git a/src/app/search/page.tsx b/src/app/search/page.tsx
@@ -1,5 +1,5 @@
 import { Suspense } from "react";
-import { Search } from "@/components/search/Search";
+import { Search } from "@/components/search/search";
 import { UNIVERSITY_GE } from "@/lib/constants";
 import { queryDatabase } from "@/lib/utils/query-db";
 

diff --git a/src/components/search/Search.tsx b/src/components/search/Search.tsx
@@ -5,49 +5,17 @@ import { SearchFilterDialog } from "@/components/search/filter/search-filter-dia
 import { SearchFilterSortDropdown } from "@/components/search/filter/search-filter-sort-dropdown";
 import { SearchBlurb } from "@/components/search/search-blurb";
 import { SearchResults } from "@/components/search/search-results";
+import type {
+    CourseObject,
+    FilterValues,
+} from "@/components/search/search.types";
 import { UNIVERSITY_GE } from "@/lib/constants";
 import { useQueryState } from "nuqs";
 
 import { filterData } from "../../lib/utils/filter";
 import { SearchFilter } from "./filter/search-filter";
 import { SearchSelect } from "./SearchSelect";
 
-export interface CourseObject {
-    sendingInstitution: string;
-    courseCode: string;
-    courseName: string;
-    cvcId: string;
-    assistPath: string;
-    niceToHaves: string[];
-    units: number;
-    tuition: number;
-    startDate: number;
-    endDate: number;
-    async: boolean;
-    hasOpenSeats: boolean;
-    hasPrereqs: boolean;
-    instantEnrollment: boolean;
-    fulfillsGEs: FullFillsGE[];
-    articulatesTo: string[];
-}
-
-type FullFillsGE = {
-    category: string;
-    count: number;
-};
-
-export type FilterValues = {
-    format: boolean[];
-    enrollment: boolean[];
-    available: boolean[];
-    start: Date | undefined;
-    end: Date | undefined;
-    institution: string;
-    min: number;
-    max: number;
-    sort: string;
-};
-
 export function Search({
     university: _university,
     ge: _ge,

diff --git a/src/components/search/filter/search-filter-institution-dropdown.tsx b/src/components/search/filter/search-filter-institution-dropdown.tsx
@@ -1,4 +1,4 @@
-import { CourseObject } from "@/components/search/Search";
+import type { CourseObject } from "@/components/search/search.types";
 import {
     Select,
     SelectContent,

diff --git a/src/components/search/filter/search-filter.tsx b/src/components/search/filter/search-filter.tsx
@@ -1,9 +1,8 @@
 import { Dispatch, SetStateAction } from "react";
+import { SearchFilterCheckbox } from "@/components/search/filter/search-filter-checkbox";
 import { SearchFilterDateSelect } from "@/components/search/filter/search-filter-date-select";
 import { SearchFilterInstitutionDropdown } from "@/components/search/filter/search-filter-institution-dropdown";
-
-import { CourseObject, FilterValues } from "../Search";
-import { SearchFilterCheckbox } from "./search-filter-checkbox";
+import { CourseObject, FilterValues } from "@/components/search/search.types";
 
 interface SearchFilterProps {
     setFormat: Dispatch<SetStateAction<boolean[]>>;

diff --git a/src/components/search/search-blurb.tsx b/src/components/search/search-blurb.tsx
@@ -1,6 +1,8 @@
-import React, { useCallback, useEffect, useState } from "react";
-
-import { CourseObject, FilterValues } from "./Search";
+import { useCallback, useEffect, useState } from "react";
+import type {
+    CourseObject,
+    FilterValues,
+} from "@/components/search/search.types";
 
 interface SearchBlurbProps {
     filterData: (

diff --git a/src/components/search/search-results.tsx b/src/components/search/search-results.tsx
@@ -1,8 +1,8 @@
+import type { CourseObject } from "@/components/search/search.types";
 import { format } from "date-fns";
 import { ExternalLinkIcon } from "lucide-react";
 import LazyLoad from "react-lazy-load";
 
-import { CourseObject } from "./Search";
 import Tags from "./Tags";
 
 const formatTime = (date: number) => {

diff --git a/src/components/search/search.types.ts b/src/components/search/search.types.ts
@@ -0,0 +1,35 @@
+export interface CourseObject {
+    sendingInstitution: string;
+    courseCode: string;
+    courseName: string;
+    cvcId: string;
+    assistPath: string;
+    niceToHaves: string[];
+    units: number;
+    tuition: number;
+    startDate: number;
+    endDate: number;
+    async: boolean;
+    hasOpenSeats: boolean;
+    hasPrereqs: boolean;
+    instantEnrollment: boolean;
+    fulfillsGEs: FullFillsGE[];
+    articulatesTo: string[];
+}
+
+type FullFillsGE = {
+    category: string;
+    count: number;
+};
+
+export type FilterValues = {
+    format: boolean[];
+    enrollment: boolean[];
+    available: boolean[];
+    start: Date | undefined;
+    end: Date | undefined;
+    institution: string;
+    min: number;
+    max: number;
+    sort: string;
+};
diff --git a/src/lib/utils/filter.ts b/src/lib/utils/filter.ts
@@ -1,4 +1,4 @@
-import { CourseObject, FilterValues } from "../../components/search/Search";
+import { CourseObject, FilterValues } from "@/components/search/search.types";
 
 export const startsAfter = (start: Date | undefined, result: CourseObject) => {
     if (start === undefined) {

diff --git a/src/lib/utils/query-db.ts b/src/lib/utils/query-db.ts
@@ -1,4 +1,4 @@
-import { CourseObject } from "../../components/search/Search";
+import { CourseObject } from "@/components/search/search.types";
 
 export type DatabaseReturn = {
     data: CourseObject[];

diff --git a/tests/search-filters.test.ts b/tests/search-filters.test.ts
@@ -1,5 +1,6 @@
-import { CourseObject, FilterValues } from "@/components/search/Search";
+import { CourseObject, FilterValues } from "@/components/search/search.types";
 import { endsBefore, filterData, startsAfter } from "@/lib/utils/filter";
+
 import "@testing-library/jest-dom";
 
 interface CourseData {
@@ -88,7 +89,7 @@ describe("Search Filters", () => {
 
     test("default filter values do not throw error", async () => {
         expect(() => filterData(data.data, defaultFilterValues)).not.toThrow(
-            Error,
+            Error
         );
     });
 
@@ -154,7 +155,7 @@ describe("Search Filters", () => {
             institution: "placeholder sending institution 1",
         });
         expect(result[0].sendingInstitution).toEqual(
-            "placeholder sending institution 1",
+            "placeholder sending institution 1"
         );
     });
 });
@@ -191,7 +192,7 @@ describe("Filter Utils' Time Utilities", () => {
             sort: "Tuition",
         });
         expect(result[0].sendingInstitution).toEqual(
-            "placeholder sending institution 2",
+            "placeholder sending institution 2"
         );
     });
 });
@@ -203,7 +204,7 @@ describe("Search Sorting", () => {
             sort: "Alphabetical",
         });
         expect(result[0].sendingInstitution).toEqual(
-            "placeholder sending institution 1",
+            "placeholder sending institution 1"
         );
     });
 
@@ -213,7 +214,7 @@ describe("Search Sorting", () => {
             sort: "Alphabetical",
         });
         expect(result[0].sendingInstitution).toEqual(
-            "placeholder sending institution 1",
+            "placeholder sending institution 1"
         );
     });
 
@@ -223,7 +224,7 @@ describe("Search Sorting", () => {
             sort: "Tuition",
         });
         expect(result[0].sendingInstitution).toEqual(
-            "placeholder sending institution 2",
+            "placeholder sending institution 2"
         );
     });
 
@@ -233,7 +234,7 @@ describe("Search Sorting", () => {
             sort: "Shortest Term",
         });
         expect(result[0].sendingInstitution).toEqual(
-            "placeholder sending institution 1",
+            "placeholder sending institution 1"
         );
     });
 
@@ -246,7 +247,7 @@ describe("Search Sorting", () => {
         console.log(result);
 
         expect(result[0].sendingInstitution).toEqual(
-            "placeholder sending institution 3",
+            "placeholder sending institution 3"
         );
     });
 });