feat(timetable): restore customizable timetables

website/src/actions/__snapshots__/timetables.test.ts.snap

@@ -10,6 +10,7 @@ exports[`cancelModifyLesson should not have payload 1`] = `
 exports[`changeLesson should return updated information to change lesson 1`] = `
 {
   "payload": {
+    "activeLesson": "1",
     "classNo": "1",
     "lessonType": "Recitation",
     "moduleCode": "CS1010S",

website/src/actions/timetables.test.ts

@@ -36,7 +36,7 @@ test('modifyLesson should return lesson payload', () => {
 test('changeLesson should return updated information to change lesson', () => {
   const semester: Semester = 1;
   const lesson: Lesson = lessons[1];
-  expect(actions.changeLesson(semester, lesson)).toMatchSnapshot();
+  expect(actions.changeLesson(semester, lesson, lesson.classNo)).toMatchSnapshot();
 });
 
 test('cancelModifyLesson should not have payload', () => {
@@ -53,19 +53,21 @@ describe('fillTimetableBlanks', () => {
   const moduleBank = { modules: { CS1010S, CS3216 } };
   const timetablesState = (semester: Semester, timetable: SemTimetableConfig) => ({
     lessons: { [semester]: timetable },
+    customisedModules: { [semester]: [] },
   });
   const semester = 1;
   const action = actions.validateTimetable(semester);
 
   test('do nothing if timetable is already full', () => {
-    const timetable = {
+    const timetable: SemTimetableConfig = {
       CS1010S: {
-        Lecture: '1',
-        Tutorial: '1',
-        Recitation: '1',
+        Lecture: ['1'],
+        Tutorial: ['1'],
+        Recitation: ['1'],
       },
     };
 
+    // TODO(zwliew): Correctly type all the `state: any` declarations in this function and the rest of the codebase.
     const state: any = { timetables: timetablesState(semester, timetable), moduleBank };
     const dispatch = jest.fn();
     action(dispatch, () => state);
@@ -74,10 +76,10 @@ describe('fillTimetableBlanks', () => {
   });
 
   test('fill missing lessons with randomly generated modules', () => {
-    const timetable = {
+    const timetable: SemTimetableConfig = {
       CS1010S: {
-        Lecture: '1',
-        Tutorial: '1',
+        Lecture: ['1'],
+        Tutorial: ['1'],
       },
       CS3216: {},
     };
@@ -95,9 +97,9 @@ describe('fillTimetableBlanks', () => {
         semester,
         moduleCode: 'CS1010S',
         lessonConfig: {
-          Lecture: '1',
-          Tutorial: '1',
-          Recitation: expect.any(String),
+          Lecture: ['1'],
+          Tutorial: ['1'],
+          Recitation: expect.any(Array),
         },
       },
     });
@@ -108,7 +110,7 @@ describe('fillTimetableBlanks', () => {
         semester,
         moduleCode: 'CS3216',
         lessonConfig: {
-          Lecture: '1',
+          Lecture: ['1'],
         },
       },
     });

website/src/actions/timetables.ts

@@ -90,15 +90,86 @@ export function modifyLesson(activeLesson: Lesson) {
   };
 }
 
+export const CUSTOMISE_MODULE = 'CUSTOMISE_LESSON' as const;
+export function customiseLesson(semester: Semester, moduleCode: ModuleCode) {
+  return {
+    type: CUSTOMISE_MODULE,
+    payload: {
+      semester,
+      moduleCode,
+    },
+  };
+}
+
 export const CHANGE_LESSON = 'CHANGE_LESSON' as const;
 export function setLesson(
   semester: Semester,
   moduleCode: ModuleCode,
   lessonType: LessonType,
   classNo: ClassNo,
+  activeLesson: ClassNo,
 ) {
   return {
     type: CHANGE_LESSON,
+    payload: {
+      semester,
+      moduleCode,
+      lessonType,
+      classNo,
+      activeLesson,
+    },
+  };
+}
+
+export const ADD_CUSTOM_MODULE = 'ADD_CUSTOM_MODULE' as const;
+export function addCustomModule(semester: Semester, moduleCode: ModuleCode) {
+  return {
+    type: ADD_CUSTOM_MODULE,
+    payload: {
+      semester,
+      moduleCode,
+    },
+  };
+}
+
+export const REMOVE_CUSTOM_MODULE = 'REMOVE_CUSTOM_MODULE' as const;
+export function removeCustomModule(semester: Semester, moduleCode: ModuleCode) {
+  return {
+    type: REMOVE_CUSTOM_MODULE,
+    payload: {
+      semester,
+      moduleCode,
+    },
+  };
+}
+
+export const ADD_LESSON = 'ADD_LESSON' as const;
+export function addLesson(
+  semester: Semester,
+  moduleCode: ModuleCode,
+  lessonType: LessonType,
+  classNo: ClassNo,
+) {
+  return {
+    type: ADD_LESSON,
+    payload: {
+      semester,
+      moduleCode,
+      lessonType,
+      classNo,
+    },
+  };
+}
+
+export const REMOVE_LESSON = 'REMOVE_LESSON' as const;
+export function removeLesson(
+  semester: Semester,
+  moduleCode: ModuleCode,
+  lessonType: LessonType,
+  classNo: ClassNo,
+) {
+  return {
+    type: REMOVE_LESSON,
     payload: {
       semester,
       moduleCode,
@@ -108,8 +179,8 @@ export function setLesson(
   };
 }
 
-export function changeLesson(semester: Semester, lesson: Lesson) {
-  return setLesson(semester, lesson.moduleCode, lesson.lessonType, lesson.classNo);
+export function changeLesson(semester: Semester, lesson: Lesson, activeLesson: ClassNo) {
+  return setLesson(semester, lesson.moduleCode, lesson.lessonType, lesson.classNo, activeLesson);
 }
 
 export const SET_LESSON_CONFIG = 'SET_LESSON_CONFIG' as const;
@@ -165,6 +236,9 @@ export function validateTimetable(semester: Semester) {
       const module = moduleBank.modules[moduleCode];
       if (!module) return;
 
+      // Do not validate customised modules.
+      if (timetables.customisedModules[semester]?.includes(moduleCode)) return;
+
       const [validatedLessonConfig, changedLessonTypes] = validateModuleLessons(
         semester,
         lessonConfig,

website/src/reducers/app.test.ts

@@ -20,6 +20,7 @@ const appInitialState: AppState = {
   isFeedbackModalOpen: false,
   promptRefresh: false,
   notifications: [],
+  customiseModule: '',
 };
 const appHasSemesterTwoState: AppState = { ...appInitialState, activeSemester: anotherSemester };
 const appHasActiveLessonState: AppState = { ...appInitialState, activeLesson: lesson };
@@ -55,7 +56,7 @@ test('app should set active lesson', () => {
 });
 
 test('app should accept lesson change and unset active lesson', () => {
-  const action = changeLesson(semester, lesson);
+  const action = changeLesson(semester, lesson, lesson.classNo);
   const nextState: AppState = reducer(appInitialState, action);
 
   expect(nextState).toEqual(appInitialState);

website/src/reducers/app.ts

@@ -3,7 +3,12 @@ import { Actions } from 'types/actions';
 import config from 'config';
 
 import { forceRefreshPrompt } from 'utils/debug';
-import { MODIFY_LESSON, CHANGE_LESSON, CANCEL_MODIFY_LESSON } from 'actions/timetables';
+import {
+  MODIFY_LESSON,
+  CHANGE_LESSON,
+  CANCEL_MODIFY_LESSON,
+  CUSTOMISE_MODULE,
+} from 'actions/timetables';
 import { SELECT_SEMESTER } from 'actions/settings';
 import {
   OPEN_NOTIFICATION,
@@ -18,6 +23,7 @@ const defaultAppState = (): AppState => ({
   activeSemester: config.semester,
   // The lesson being modified on the timetable.
   activeLesson: null,
+  customiseModule: '',
   isOnline: navigator.onLine,
   isFeedbackModalOpen: false,
   promptRefresh: forceRefreshPrompt(),
@@ -37,6 +43,11 @@ function app(state: AppState = defaultAppState(), action: Actions): AppState {
         ...state,
         activeLesson: action.payload.activeLesson,
       };
+    case CUSTOMISE_MODULE:
+      return {
+        ...state,
+        customiseModule: action.payload.moduleCode,
+      };
     case CANCEL_MODIFY_LESSON:
     case CHANGE_LESSON:
       return {

website/src/reducers/index.test.ts

@@ -10,16 +10,16 @@ const exportData: ExportData = {
   semester: 1,
   timetable: {
     CS3216: {
-      Lecture: '1',
+      Lecture: ['1'],
     },
     CS1010S: {
-      Lecture: '1',
-      Tutorial: '3',
-      Recitation: '2',
+      Lecture: ['1'],
+      Tutorial: ['3'],
+      Recitation: ['2'],
     },
     PC1222: {
-      Lecture: '1',
-      Tutorial: '3',
+      Lecture: ['1'],
+      Tutorial: ['3'],
     },
   },
   colors: {
@@ -52,16 +52,16 @@ test('reducers should set export data state', () => {
     lessons: {
       [1]: {
         CS3216: {
-          Lecture: '1',
+          Lecture: ['1'],
         },
         CS1010S: {
-          Lecture: '1',
-          Tutorial: '3',
-          Recitation: '2',
+          Lecture: ['1'],
+          Tutorial: ['3'],
+          Recitation: ['2'],
         },
         PC1222: {
-          Lecture: '1',
-          Tutorial: '3',
+          Lecture: ['1'],
+          Tutorial: ['3'],
         },
       },
     },
@@ -72,6 +72,7 @@ test('reducers should set export data state', () => {
         PC1222: 2,
       },
     },
+    customisedModules: {},
     hidden: { [1]: ['PC1222'] },
     academicYear: expect.any(String),
     archive: {},