Add Custom Modules to Timetable

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

@@ -1,5 +1,44 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`addCustomModule should add the custom module defined 1`] = `
+{
+  "payload": {
+    "lessons": [
+      {
+        "classNo": "01",
+        "day": "Monday",
+        "endTime": "0900",
+        "isCustom": true,
+        "lessonType": "Lecture",
+        "moduleCode": "CS1101S",
+        "startTime": "0800",
+        "title": "Programming Methodology",
+        "venue": "COM1-0330",
+        "weeks": [
+          1,
+          2,
+          3,
+          4,
+          5,
+          6,
+          7,
+          8,
+          9,
+          10,
+          11,
+          12,
+          13,
+        ],
+      },
+    ],
+    "moduleCode": "CS1101S",
+    "semester": 2,
+    "title": "Programming Methodology",
+  },
+  "type": "ADD_CUSTOM_MODULE",
+}
+`;
+
 exports[`cancelModifyLesson should not have payload 1`] = `
 {
   "payload": null,
@@ -19,6 +58,16 @@ exports[`changeLesson should return updated information to change lesson 1`] = `
 }
 `;
 
+exports[`deleteCustomModule should modify the custom module 1`] = `
+{
+  "payload": {
+    "moduleCode": "CS1101S",
+    "semester": 2,
+  },
+  "type": "DELETE_CUSTOM_MODULE",
+}
+`;
+
 exports[`fetchTimetableModules should fetch modules 1`] = `
 [
   [
@@ -47,6 +96,46 @@ exports[`hide/show timetable modules should dispatch a module code for showing 1
 }
 `;
 
+exports[`modifyCustomModule should modify the custom module 1`] = `
+{
+  "payload": {
+    "lessons": [
+      {
+        "classNo": "01",
+        "day": "Monday",
+        "endTime": "0900",
+        "isCustom": true,
+        "lessonType": "Lecture",
+        "moduleCode": "CS2030",
+        "startTime": "0800",
+        "title": "Programming Methodology",
+        "venue": "COM1-0330",
+        "weeks": [
+          1,
+          2,
+          3,
+          4,
+          5,
+          6,
+          7,
+          8,
+          9,
+          10,
+          11,
+          12,
+          13,
+        ],
+      },
+    ],
+    "moduleCode": "CS2030",
+    "oldModuleCode": "CS1101S",
+    "semester": 2,
+    "title": "Programming Methodology",
+  },
+  "type": "MODIFY_CUSTOM_MODULE",
+}
+`;
+
 exports[`modifyLesson should return lesson payload 1`] = `
 {
   "payload": {

website/src/actions/timetables.test.ts

@@ -1,5 +1,5 @@
 import { ModuleCode, Semester } from 'types/modules';
-import { SemTimetableConfig, Lesson } from 'types/timetables';
+import { SemTimetableConfig, Lesson, CustomModuleLesson } from 'types/timetables';
 
 import lessons from '__mocks__/lessons-array.json';
 import { CS1010S, CS3216 } from '__mocks__/modules';
@@ -129,6 +129,60 @@ describe('hide/show timetable modules', () => {
   });
 });
 
+describe(actions.addCustomModule, () => {
+  const semester: Semester = 2;
+  const moduleCode: ModuleCode = 'CS1101S';
+  const lesson: CustomModuleLesson = {
+    classNo: '01',
+    day: 'Monday',
+    startTime: '0800',
+    endTime: '0900',
+    lessonType: 'Lecture',
+    venue: 'COM1-0330',
+    moduleCode,
+    title: 'Programming Methodology',
+    isCustom: true,
+    weeks: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13],
+  };
+
+  test('should add the custom module defined', () => {
+    expect(actions.addCustomModule(semester, moduleCode, lesson.title, [lesson])).toMatchSnapshot();
+  });
+});
+
+describe(actions.modifyCustomModule, () => {
+  const semester: Semester = 2;
+  const moduleCode: ModuleCode = 'CS1101S';
+  const newModuleCode: ModuleCode = 'CS2030';
+  const lesson: CustomModuleLesson = {
+    classNo: '01',
+    day: 'Monday',
+    startTime: '0800',
+    endTime: '0900',
+    lessonType: 'Lecture',
+    venue: 'COM1-0330',
+    moduleCode: newModuleCode,
+    title: 'Programming Methodology',
+    isCustom: true,
+    weeks: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13],
+  };
+
+  test('should modify the custom module', () => {
+    expect(
+      actions.modifyCustomModule(semester, moduleCode, newModuleCode, lesson.title, [lesson]),
+    ).toMatchSnapshot();
+  });
+});
+
+describe(actions.deleteCustomModule, () => {
+  const semester: Semester = 2;
+  const moduleCode: ModuleCode = 'CS1101S';
+
+  test('should modify the custom module', () => {
+    expect(actions.deleteCustomModule(semester, moduleCode)).toMatchSnapshot();
+  });
+});
+
 describe(actions.fetchTimetableModules, () => {
   const moduleCodes: any = {
     CS1010S: {},

website/src/actions/timetables.ts

@@ -8,8 +8,15 @@
   TaModulesConfig,
 } from 'types/timetables';
 import type { Dispatch, GetState } from 'types/redux';
-import type { ColorMapping } from 'types/reducers';
-import type { ClassNo, LessonType, Module, ModuleCode, Semester } from 'types/modules';
+import type { ColorMapping, CustomModuleLessonData } from 'types/reducers';
+import type {
+  ClassNo,
+  CustomLesson,
+  LessonType,
+  Module,
+  ModuleCode,
+  Semester,
+} from 'types/modules';
 
 import { fetchModule } from 'actions/moduleBank';
 import { openNotification } from 'actions/app';
@@ -24,19 +31,22 @@
 // Actions that should not be used directly outside of thunks
 export const SET_TIMETABLE = 'SET_TIMETABLE' as const;
 export const ADD_MODULE = 'ADD_MODULE' as const;
+export const SET_CUSTOM_IMPORTED = 'SET_CUSTOM_IMPORTED' as const;
 export const SET_HIDDEN_IMPORTED = 'SET_HIDDEN_IMPORTED' as const;
 export const SET_TA_IMPORTED = 'SET_TA_IMPORTED' as const;
+export const TEMP_IMPORTED_SEM = 'TEMP_IMPORTED_SEM' as const;
 export const Internal = {
   setTimetable(
     semester: Semester,
     timetable: SemTimetableConfig | undefined,
     colors?: ColorMapping,
     hiddenModules?: ModuleCode[],
+    customModules?: CustomModuleLessonData,
     taModules?: TaModulesConfig,
   ) {
     return {
       type: SET_TIMETABLE,
-      payload: { semester, timetable, colors, hiddenModules, taModules },
+      payload: { semester, timetable, colors, hiddenModules, customModules, taModules },
     };
   },
 
@@ -172,7 +182,8 @@
         semester,
         validatedTimetable,
         colors,
-        getState().timetables.hidden[semester] ?? [],
+        getState().timetables.hidden[TEMP_IMPORTED_SEM] || [],
+        getState().timetables.customModules[TEMP_IMPORTED_SEM] || [],
         getState().timetables.ta[semester] ?? {},
       ),
     );
@@ -219,6 +230,20 @@
   };
 }
 
+export function setCustomModulesFromImport(
+  semester: Semester,
+  customModules: CustomModuleLessonData,
+) {
+  return (dispatch: Dispatch) => dispatch(setCustomImported(semester, customModules));
+}
+
+export function setCustomImported(semester: Semester, customModules: CustomModuleLessonData) {
+  return {
+    type: SET_CUSTOM_IMPORTED,
+    payload: { semester, customModules },
+  };
+}
+
 export function setHiddenModulesFromImport(semester: Semester, hiddenModules: ModuleCode[]) {
   return (dispatch: Dispatch) => dispatch(setHiddenImported(semester, hiddenModules));
 }
@@ -273,6 +298,54 @@
   };
 }
 
+export const ADD_CUSTOM_MODULE = 'ADD_CUSTOM_MODULE' as const;
+export function addCustomModule(
+  semester: Semester,
+  moduleCode: ModuleCode,
+  title: string,
+  lessons: CustomLesson[],
+) {
+  return {
+    type: ADD_CUSTOM_MODULE,
+    payload: {
+      semester,
+      moduleCode,
+      title,
+      lessons,
+    },
+  };
+}
+
+export const MODIFY_CUSTOM_MODULE = 'MODIFY_CUSTOM_MODULE' as const;
+export function modifyCustomModule(
+  semester: Semester,
+  oldModuleCode: ModuleCode,
+  moduleCode: ModuleCode,
+  title: string,
+  lessons: CustomLesson[],
+) {
+  return {
+    type: MODIFY_CUSTOM_MODULE,
+    payload: {
+      semester,
+      oldModuleCode,
+      moduleCode,
+      title,
+      lessons,
+    },
+  };
+}
+
+export const DELETE_CUSTOM_MODULE = 'DELETE_CUSTOM_MODULE' as const;
+export function deleteCustomModule(semester: Semester, moduleCode: ModuleCode) {
+  return {
+    type: DELETE_CUSTOM_MODULE,
+    payload: {
+      semester,
+      moduleCode,
+    },
+  };
+}
 export const ADD_TA_LESSON_IN_TIMETABLE = 'ADD_TA_LESSON_IN_TIMETABLE' as const;
 export function addTaLessonInTimetable(
   semester: Semester,

website/src/entry/export/TimetableOnly.tsx

@@ -19,6 +19,7 @@
     semester: 1,
     timetable: {},
     colors: {},
+    custom: {},
     hidden: [],
     ta: {},
   };
@@ -27,8 +28,9 @@
     const { store } = this.props;
     const theme = store.getState().theme.id;
 
-    const { semester, timetable, colors, hidden, ta } = this.state;
-    const filledColors = fillColorMapping(timetable, colors);
+    // TODO handle exportable custom modules
+    const { semester, timetable, colors, hidden, ta, custom } = this.state;
+    const filledColors = fillColorMapping(timetable, colors, []);
 
     return (
       <MemoryRouter initialEntries={['https://nusmods.com']}>
@@ -39,6 +41,7 @@
               semester={semester}
               timetable={timetable}
               colors={filledColors}
+              customImportedModules={custom}
               hiddenImportedModules={hidden}
               taImportedModules={ta}
               readOnly

website/src/reducers/index.test.ts

@@ -69,6 +69,7 @@ test('reducers should set export data state', () => {
         },
       },
     },
+    customModules: {},
     colors: {
       [1]: {
         CS3216: 1,

website/src/reducers/index.ts

@@ -1,4 +1,4 @@
-import { REMOVE_MODULE, SET_TIMETABLE } from 'actions/timetables';
+import { DELETE_CUSTOM_MODULE, REMOVE_MODULE, SET_TIMETABLE } from 'actions/timetables';
 
 import persistReducer from 'storage/persistReducer';
 import { State } from 'types/state';
@@ -29,7 +29,7 @@ const planner = persistReducer('planner', plannerReducer, plannerPersistConfig);
 const defaultState = {} as unknown as State;
 const undoReducer = createUndoReducer<State>({
   limit: 1,
-  actionsToWatch: [REMOVE_MODULE, SET_TIMETABLE],
+  actionsToWatch: [REMOVE_MODULE, SET_TIMETABLE, DELETE_CUSTOM_MODULE],
   storedKeyPaths: ['timetables', 'theme.colors'],
 });