feat(all): Add JSON import and export support

backend/server/db/helpers/models.py

@@ -16,6 +16,9 @@ class UserDegreeStorage(BaseModel):
  programCode: str
  specs: List[str]
 
+class UserCourseMinimal(BaseModel):
+ mark: Union[Literal['SY', 'FL', 'PS', 'CR', 'DN', 'HD'], int, None]
+ ignoreFromProgression: bool
 
 class UserCourseStorage(BaseModel):
  code: str
@@ -52,6 +55,12 @@ class _BaseUserStorage(BaseModel):
  # NOTE: could also put uid here if we want
  guest: bool
 
+class UserImport(BaseModel):
+ degree: UserDegreeStorage
+ courses: dict[str, UserCourseMinimal]
+ planner: UserPlannerStorage
+ settings: UserSettingsStorage
+
 class UserStorage(_BaseUserStorage):
  setup: Literal[True] = True
  degree: UserDegreeStorage

backend/server/routers/model.py

@@ -265,12 +265,6 @@ class Storage(TypedDict):
  courses: dict[str, CourseStorage]
  settings: SettingsStorage
 
-class LocalStorage(BaseModel):
- model_config = ConfigDict(extra='forbid')
-
- degree: DegreeLocalStorage
- planner: PlannerLocalStorage
-
 class StartYear(BaseModel):
  model_config = ConfigDict(extra='forbid')
 

backend/server/routers/user.py

@@ -1,12 +1,12 @@
-from itertools import chain
 from typing import Annotated, Dict, Optional, cast
 from fastapi import APIRouter, HTTPException, Security
 
+from server.db.helpers.models import PartialUserStorage, UserCourseStorage, UserCoursesStorage, UserImport
 from data.processors.models import SpecData
 from server.routers.utility.common import get_all_specialisations, get_course_details
 from server.routers.utility.sessions.middleware import HTTPBearerToUserID
 from server.routers.utility.user import get_setup_user, set_user
-from server.routers.model import CourseMark, CourseStorage, DegreeLength, DegreeWizardInfo, HiddenYear, SettingsStorage, StartYear, CourseStorageWithExtra, DegreeLocalStorage, LocalStorage, PlannerLocalStorage, Storage, SpecType
+from server.routers.model import CourseMark, DegreeLength, DegreeWizardInfo, HiddenYear, SettingsStorage, StartYear, CourseStorageWithExtra, DegreeLocalStorage, PlannerLocalStorage, Storage, SpecType
 
 import server.db.helpers.users as udb
 
@@ -17,30 +17,83 @@
 
 require_uid = HTTPBearerToUserID()
 
-# Ideally not used often.
-@router.post("/saveLocalStorage")
-def save_local_storage(localStorage: LocalStorage, uid: Annotated[str, Security(require_uid)]):
- planned: list[str] = sum((sum(year.values(), [])
- for year in localStorage.planner['years']), [])
- unplanned: list[str] = localStorage.planner['unplanned']
- courses: dict[str, CourseStorage] = {
- course: {
- 'code': course,
- 'mark': None, # wtf we nuking marks?
- 'uoc': get_course_details(course)['UOC'],
- 'ignoreFromProgression': False
- }
- for course in chain(planned, unplanned)
- }
- # cancer, but the FE inspired this cancer
- real_planner = localStorage.planner.copy()
- item: Storage = {
- 'degree': localStorage.degree,
- 'planner': real_planner,
- 'courses': courses,
- 'settings': SettingsStorage(showMarks=False, hiddenYears=set()),
- }
- set_user(uid, item)
+@router.put("/import")
+def import_user(data: UserImport, uid: Annotated[str, Security(require_uid)]):
+ assert udb.reset_user(uid)
+
+ if data.planner.startYear < 2019:
+ raise HTTPException(status_code=400, detail="Invalid start year")
+ if len(data.planner.years) > 10:
+ raise HTTPException(status_code=400, detail="Too many years")
+ if len(data.planner.years) < 1:
+ raise HTTPException(status_code=400, detail="Not enough years")
+
+ possible_specs = get_all_specialisations(data.degree.programCode)
+ if possible_specs is None:
+ raise HTTPException(status_code=400, detail="Invalid program code")
+
+ flattened_containers: list[tuple[bool, list[str]]] = [
+ (
+ program_sub_container["is_optional"],
+ list(program_sub_container["specs"].keys())
+ )
+ for spec_type_container in cast(dict[SpecType, dict[str, SpecData]], possible_specs).values()
+ for program_sub_container in spec_type_container.values()
+ ]
+
+ invalid_lhs_specs = set(data.degree.specs).difference(
+ spec_code
+ for (_, spec_codes) in flattened_containers
+ for spec_code in spec_codes
+ )
+
+ spec_reqs_not_met = any(
+ (
+ not is_optional
+ and not set(spec_codes).intersection(data.degree.specs)
+ )
+ for (is_optional, spec_codes) in flattened_containers
+ )
+
+ if invalid_lhs_specs or spec_reqs_not_met:
+ raise HTTPException(status_code=400, detail="Invalid specialisations")
+
+ for term in data.planner.lockedTerms.keys():
+ year, termIndex = term.split("T")
+ if int(year) < data.planner.startYear or int(year) >= data.planner.startYear + len(data.planner.years):
+ raise HTTPException(status_code=400, detail="Invalid locked term")
+ if termIndex not in ["0", "1", "2", "3"]:
+ raise HTTPException(status_code=400, detail="Invalid locked term")
+ for year in data.settings.hiddenYears:
+ if year < 0 or year >= len(data.planner.years):
+ raise HTTPException(status_code=400, detail="Invalid hidden year")
+
+ courses = []
+ for course in data.planner.unplanned:
+ if course not in data.courses.keys():
+ raise HTTPException(status_code=400, detail="Unplanned course not in courses")
+ courses.append(course)
+ for year in data.planner.years:
+ for term in [year.T0, year.T1, year.T2, year.T3]:
+ for course in term:
+ if course not in data.courses.keys():
+ raise HTTPException(status_code=400, detail="Planned course not in courses")
+ courses.append(course)
+ for course in data.courses.keys():
+ if course not in courses:
+ raise HTTPException(status_code=400, detail="Course in courses not in planner")
+ mark = data.courses[course].mark
+ if isinstance(mark, int) and (mark < 0 or mark > 100):
+ raise HTTPException(status_code=400, detail="Invalid mark")
+ userCourses: UserCoursesStorage = {}
+ for course in courses:
+ # This raises an exception
+ uoc = get_course_details(course)["UOC"]
+ userCourses[course] = UserCourseStorage(code=course, mark=data.courses[course].mark, uoc=uoc, ignoreFromProgression=data.courses[course].ignoreFromProgression)
+
+ user = PartialUserStorage(degree=data.degree, courses=userCourses, planner=data.planner, settings=data.settings)
+ udb.reset_user(uid)
+ udb.update_user(uid, user)
 
 
 @router.get("/data/all")

frontend/package.json

@@ -15,7 +15,7 @@
  "@tanstack/react-query": "5.29.2",
  "@tippyjs/react": "4.2.6",
  "antd": "5.18.1",
- "axios": "1.6.8",
+ "axios": "1.7.7",
  "dayjs": "1.11.11",
  "fast-fuzzy": "1.12.0",
  "framer-motion": "11.0.20",
@@ -37,7 +37,7 @@
  "redux-thunk": "3.1.0",
  "styled-components": "6.1.11",
  "use-debounce": "10.0.1",
- "uuid": "9.0.1"
+ "zod": "3.23.8"
  },
  "scripts": {
  "start": "vite --port 3000 --host",
@@ -83,7 +83,6 @@
  "@types/react-helmet": "6.1.11",
  "@types/react-scroll": "1.8.10",
  "@types/styled-components": "5.1.34",
- "@types/uuid": "9.0.8",
  "@typescript-eslint/eslint-plugin": "7.3.1",
  "@typescript-eslint/parser": "7.3.1",
  "@vitejs/plugin-react": "4.2.1",

frontend/src/components/EditMarkModal/EditMarkModal.tsx

@@ -56,7 +56,7 @@ const EditMarkModal = ({ code, open, onCancel }: Props) => {
  // mark is a letter grade
  updateMarkMutation.mutate({ course: code, mark: markValue as Grade });
  } else if (markValue === '' || markValue === undefined) {
- updateMarkMutation.mutate({ course: code, mark: undefined });
+ updateMarkMutation.mutate({ course: code, mark: null });
  } else {
  message.error('Could not update mark. Please enter a valid mark or letter grade');
  }

frontend/src/hooks/useSettings.ts

@@ -1,5 +1,6 @@
 import { useCallback } from 'react';
 import { QueryClient, useMutation, useQuery, useQueryClient } from '@tanstack/react-query';
+import { SettingsResponse } from 'types/userResponse';
 import {
  getUserSettings,
  hideYear as hideYearApi,
@@ -16,12 +17,13 @@ import useToken from './useToken';
 
 type Theme = 'light' | 'dark';
 
-interface Settings {
+export interface LocalSettings {
  theme: Theme;
- showMarks: boolean;
  showLockedCourses: boolean;
  showPastWarnings: boolean;
- hiddenYears: number[];
+}
+
+export interface Settings extends LocalSettings, SettingsResponse {
  mutateTheme: (theme: Theme) => void;
  toggleShowMarks: () => void;
  hideYear: (yearIndex: number) => void;
@@ -103,8 +105,12 @@ function useSettings(queryClient?: QueryClient): Settings {
  const showYears = showYearsMutation.mutate;
 
  return {
- ...userSettings,
- ...localSettings,
+ // Do not use the spread operator here, as it doesn't update after the mutation
+ theme: localSettings.theme,
+ showLockedCourses: localSettings.showLockedCourses,
+ showPastWarnings: localSettings.showPastWarnings,
+ showMarks: userSettings.showMarks,
+ hiddenYears: userSettings.hiddenYears,
  mutateTheme,
  toggleShowMarks,
  hideYear,

frontend/src/pages/LandingPage/Hero/HeroContent/HeroContent.tsx

@@ -23,7 +23,7 @@ const HeroContent = ({ startLocation }: Props) => {
  transition={{ type: 'spring', stiffness: 400, damping: 10 }}
  whileHover={{ scale: 1.1 }}
  >
- START WITH CSESOC <Space size="large" />
+ GET STARTED <Space size="large" />
  <ArrowRightOutlined style={{ strokeWidth: '5rem', stroke: '#9453e6' }} />
  </S.HeroCTA>
  </Link>

frontend/src/pages/TermPlanner/ExportPlannerMenu/ExportPlannerMenu.tsx

@@ -1,13 +1,20 @@
 import React, { useState } from 'react';
 import { Radio } from 'antd';
+import { getUser } from 'utils/api/userApi';
+import { exportUser } from 'utils/export';
+import useToken from 'hooks/useToken';
 import CS from '../common/styles';
 import S from './styles';
 
-type Props = {
- plannerRef: React.RefObject<HTMLDivElement>;
-};
+// type Props = {
+// plannerRef: React.RefObject<HTMLDivElement>;
+// };
+
+// const ExportPlannerMenu = ({ plannerRef }: Props) => {
+const ExportPlannerMenu = () => {
+ const token = useToken();
 
-const ExportPlannerMenu = ({ plannerRef }: Props) => {
+ const plannerRef = React.createRef<HTMLDivElement>();
  const exportFormats = ['png', 'jpg', 'json'];
  const exportFields = { fileName: 'Term Planner' };
 
@@ -21,6 +28,21 @@
  exportComponentAsPNG(plannerRef, exportFields);
  } else if (format === 'jpg') {
  exportComponentAsJPEG(plannerRef, exportFields);
+ } else if (format === 'json') {
+ getUser(token)
+ .then((user) => {
+ const exported = exportUser(user);
+ const blob = new Blob([JSON.stringify(exported)], { type: 'application/json' });
+ const jsonObjectUrl = URL.createObjectURL(blob);
+ const a = document.createElement('a');
+ a.href = jsonObjectUrl;
+ const date = new Date();
+ a.download = `circles-planner-export-${date.toISOString()}.json`;
+ a.click();
+ })
+ .catch((err) => {
+ console.error('Error at exportPlannerMenu: ', err);
+ });
  }
  };