Merge pull request #418 from tcet-opensource/414-filldbwithplaceholderdata

Filled DB with placeholder data

Author: kskarthik05

.eslintrc.cjs

@@ -22,14 +22,16 @@ module.exports = {
       "alias": {
         "map": [
           ["#app", "./app.js"],
-          ["#util", "./util.js"],
-          ["#constant", "./constant.js"],
+          ["#util", "./misc/util.js"],
+          ["#constant", "./misc/constant.js"],
           ["#routes", "./routes"],
           ["#models", "./models"],
           ["#middleware", "./middleware"],
           ["#controller", "./controller"],
           ["#services", "./services"],
-          ["#error", "./error"]
+          ["#error", "./error"],
+          ["#misc", "./misc"],          
+          ["#mockDB", "./misc/mockDB"]
         ],
         "extensions": [".js"]
       }

_apidoc.js

@@ -172,6 +172,7 @@
  * @apiBody {String} wing The wing where the infrastructure is located.
  * @apiBody {Number} floor The floor where the infrastructure is located.
  * @apiBody {Number} capacity The capacity of the infrastructure.
+ * @apiBody {connector.Schema.Types.ObjectId} organization The organization which is associated.
  *
  * @apiSuccess {String} res Success message with the ID of the added infrastructure.
  *
@@ -198,6 +199,7 @@
  * @apiSuccess {String} infrastructure.wing Wing of Infrastructure. One of possible A,B,C.
  * @apiSuccess {Number} infrastructure.floor Floor of Infrastructure.
  * @apiSuccess {Number} infrastructure.capacity Capacity of Infrastructure.
+ * @apiSuccess {connector.Schema.Types.ObjectId} department.organization associated Organization.
  */
 
 /**
@@ -226,6 +228,7 @@
  * @apiBody {String} [wing] The wing where the infrastructure is located.
  * @apiBody {Number} [floor] The floor where the infrastructure is located.
  * @apiBody {Number} [capacity] The capacity of the infrastructure.
+ * @apiSuccess {connector.Schema.Types.ObjectId} department.organization associated Organization.
  *
  * @apiSuccess {String} res infrastructure updated.
  * @apiError (Error 500) err Error in updating database
@@ -432,6 +435,7 @@
  * @apiBody {Date} yearOfStarting The year of establishment of the Department.
  * @apiBody {connector.Schema.Types.ObjectId} accreditations The accreditation which is associated.
  * @apiBody {connector.Schema.Types.ObjectId} infrastructure The infrastructure which is associated.
+ * @apiBody {connector.Schema.Types.ObjectId} organization The organization which is associated.
  *
  * @apiSuccess {String} res added Department successfully.
  *
@@ -450,6 +454,7 @@
  * @apiBody {Date} [yearOfStarting] The year of establishment of the Department.
  * @apiBody {connector.Schema.Types.ObjectId} [accreditations]  Accreditation which is associated.
  * @apiBody {connector.Schema.Types.ObjectId} [infrastructure] Infrastructure which is associated.
+ * @apiBody {connector.Schema.Types.ObjectId} organization The organization which is associated.
  *
  * @apiSuccess {Department[]} res Array of Filtered Department Doc .
  * @apiSuccess {String} department._id ID of document given by database.
@@ -458,6 +463,7 @@
  * @apiSuccess {Date} department.yearOfStarting The year of establishment of the Department.
  * @apiSuccess {connector.Schema.Types.ObjectId} department.accreditations associated Accreditation.
  * @apiSuccess {connector.Schema.Types.ObjectId} department.infrastructure associatedInfrastructure.
+ * @apiSuccess {connector.Schema.Types.ObjectId} department.organization associated Organization.
  * @apiError (Error 500) err Error while fetching the data.
  */
 
@@ -488,6 +494,7 @@
  * @apiSuccess {Date} department.yearOfStarting The year of establishment of the Department.
  * @apiSuccess {connector.Schema.Types.ObjectId} department.accreditations associated Accreditation.
  * @apiSuccess {connector.Schema.Types.ObjectId} department.infrastructure associatedInfrastructure.
+ * @apiSuccess {connector.Schema.Types.ObjectId} department.organization associated Organization.
  *
  * @apiSuccess {String} res updated infrastructure with id.
  * @apiError (Error 500) err Error while inserting in DB
@@ -655,8 +662,8 @@
  *
  * @apiQuery {Number} [no] Module number.
  * @apiQuery {String} [name] Name of the module.
- * @apiQuery {String} [outcome] Module outcome.
  * @apiQuery {String[]} [contents] Array of contents of the module.
+ * @apiQuery {ObjectId} content ID of the Topics (ObjectId).
  * @apiQuery {Number} [hrsPerModule] Number of hours required per module.
  * @apiQuery {String[]} [cognitiveLevels] Array of cognitive levels
  * of attainment as per Bloom's Taxanomy (L1-L6).
@@ -665,7 +672,6 @@
  * @apiSuccess {String} module._id ID of document given by database.
  * @apiSuccess {String} module.no Module number.
  * @apiSuccess {String} module.name Name of the module.
- * @apiSuccess {String} module.outcome Module outcome.
  * @apiSuccess {String[]} module.contents Array of contents of the module.
  * @apiSuccess {Number} module.hrsPerModule Number of hours required per module.
  * @apiSuccess {String[]} module.cognitiveLevels Array of cognitive levels of
@@ -741,8 +747,8 @@
  *
  * @apiBody {Number} [no] Module number.
  * @apiBody {String} [name] Name of the module.
- * @apiBody {String} [outcome] Module outcome.
  * @apiBody {String[]} [contents] Array of contents of the module.
+ * @apiBody {ObjectId} content ID of the Topics (ObjectId).
  * @apiBody {Number} [hrsPerModule] Number of hours required per module.
  * @apiBody {String[]} [cognitiveLevels] Array of cognitive levels
  * of attainment as per Bloom's Taxanomy (L1-L6).
@@ -772,8 +778,8 @@
  * @apiParam {String} moduleId The ID of the Module document to update.
  * @apiBody {Number} [no] Module number.
  * @apiBody {String} [name] Name of the module.
- * @apiBody {String} [outcome] Module outcome.
  * @apiBody {String[]} [contents] Array of contents of the module.
+ * @apiBody {ObjectId} content ID of the Topics (ObjectId).
  * @apiBody {Number} [hrsPerModule] Number of hours required per module.
  * @apiBody {String[]} [cognitiveLevels] Array of cognitive levels
  * of attainment as per Bloom's Taxanomy (L1-L6).
@@ -1875,3 +1881,5 @@
  * @apiError (Error 500) err Error in updating database
  *
  */
+
+// TODO ADD COURSE ENDPOINT APIDOCS

app.js

@@ -30,6 +30,7 @@ import groupRouter from "#routes/group";
 import performarouter from "#routes/performance";
 import notificationRouter from "#routes/notification";
 import topicRouter from "#routes/topic";
+import courseRouter from "#routes/course";
 
 const app = express();
 const currDirName = dirname(fileURLToPath(import.meta.url));
@@ -40,10 +41,12 @@ app.use(cors());
 app.use(express.json());
 app.use(express.urlencoded({ extended: false }));
 app.use(cookieParser());
-app.use(morgan(
-  ":remote-addr - :remote-user \":method :url HTTP/:http-version\" :status \":referrer\" \":user-agent\"",
-  { stream: logger.stream },
-));
+app.use(
+  morgan(
+    ":remote-addr - :remote-user \":method :url HTTP/:http-version\" :status \":referrer\" \":user-agent\"",
+    { stream: logger.stream },
+  ),
+);
 
 app.use(express.static(path.join(currDirName, "public")));
 
@@ -71,6 +74,7 @@ app.use("/semester", semesterRouter);
 app.use("/faculty", facultyRouter);
 app.use("/performance", performarouter);
 app.use("/notification", notificationRouter);
-app.use("/topic",topicRouter);
+app.use("/topic", topicRouter);
+app.use("/course", courseRouter);
 
 export default app;

controller/course.js

@@ -0,0 +1,107 @@
+import {
+  createCourse,
+  courseList,
+  deleteCourseById,
+  updateCourseById,
+} from "#services/course";
+import { logger } from "#util";
+
+async function addCourse(req, res) {
+  const {
+    name,
+    code,
+    theoryHours,
+    department,
+    tutorialHours,
+    practicalHours,
+    ISAMarks,
+    ESEMarks,
+    tutorialMarks,
+    practicalMarks,
+    semester,
+    subType,
+    prerequisites,
+    objective,
+    outcomes,
+    modules,
+    practicals,
+    tutorials,
+    assignments,
+    reccTextbooks,
+    refBooks,
+  } = req.body;
+  try {
+    const newCourse = await createCourse(
+      name,
+      code,
+      theoryHours,
+      department,
+      tutorialHours,
+      practicalHours,
+      ISAMarks,
+      ESEMarks,
+      tutorialMarks,
+      practicalMarks,
+      semester,
+      subType,
+      prerequisites,
+      objective,
+      outcomes,
+      modules,
+      practicals,
+      tutorials,
+      assignments,
+      reccTextbooks,
+      refBooks,
+    );
+    res.json({ res: `added course ${newCourse.ERPID}` });
+  } catch (error) {
+    logger.error("Error while inserting", error);
+    res.status(500);
+    res.json({ err: "Error while inserting in DB" });
+  }
+}
+
+async function getCourse(req, res) {
+  try {
+    const filter = req.body;
+    const { limit, page } = req.query;
+    const courselist = await courseList(filter, limit, page);
+    res.json({ res: courselist });
+  } catch (error) {
+    logger.error("Error while fetching", error);
+    res.status(500);
+    res.json({ err: "Error while fetching the data" });
+  }
+}
+
+async function deleteCourse(req, res) {
+  const { courseId } = req.params;
+  try {
+    await deleteCourseById(courseId);
+    res.json({ res: "Course deleted successfully" });
+  } catch (error) {
+    logger.error("Error while deleting", error);
+    res.status(500);
+    res.json({ err: "Error while deleting from DB" });
+  }
+}
+
+async function updateCourse(req, res) {
+  const { id, ...data } = req.body;
+  try {
+    await updateCourseById(id, data);
+    res.json({ res: `updated course with id ${id}` });
+  } catch (error) {
+    logger.error("Error while updating", error);
+    res.status(500);
+    res.json({ err: "Error while updating in DB" });
+  }
+}
+
+export default {
+  addCourse,
+  getCourse,
+  deleteCourse,
+  updateCourse,
+};

controller/department.js

@@ -8,15 +8,22 @@ import {
 import { logger } from "#util";
 
 async function addDepartment(req, res) {
-  const { name, acronym, yearOfStarting, accreditations, infrastructures } =
-    req.body;
+  const {
+    name,
+    acronym,
+    yearOfStarting,
+    accreditations,
+    infrastructures,
+    organization,
+  } = req.body;
   try {
     const department = await createnewdepartment(
       name,
       acronym,
       yearOfStarting,
       accreditations,
       infrastructures,
+      organization,
     );
     res.json({
       res: `added Department successfully ${department.name}`,

controller/infrastructure.js

@@ -7,14 +7,15 @@ import {
 import { logger } from "#util";
 
 async function addInfrastructure(req, res) {
-  const { name, type, wing, floor, capacity } = req.body;
+  const { name, type, wing, floor, capacity, organization } = req.body;
   try {
     const newInfrastructure = await createInfrastructure(
       name,
       type,
       wing,
       floor,
       capacity,
+      organization,
     );
     res.json({
       res: `added infrastructure ${newInfrastructure.id}`,

controller/module.js

@@ -20,13 +20,11 @@ async function showModule(req, res) {
 }
 
 async function addModule(req, res) {
-  const { no, name, outcome, contents, hrsPerModule, cognitiveLevels } =
-    req.body;
+  const { no, name, contents, hrsPerModule, cognitiveLevels } = req.body;
   try {
     const newModule = await addNewModule(
       no,
       name,
-      outcome,
       contents,
       hrsPerModule,
       cognitiveLevels,

jsconfig.json

@@ -4,14 +4,16 @@
         "baseUrl": "./",
         "paths": {
             "#app": ["./app.js"],
-            "#util": ["./util.js"],
-            "#constant": ["./constant.js"],
+            "#util": ["./misc/util.js"],
+            "#constant": ["./misc/constant.js"],
             "#routes/*": ["./routes/*.js"],
             "#models/*": ["./models/*.js"],
             "#middleware/*": ["./middleware/*.js"],
             "#controller/*": ["./controller/*.js"],
             "#services/*": ["./services/*.js"],
-            "#error/*": ["./error/*.js"]
+            "#error/*": ["./error/*.js"],
+            "#misc/*": ["./misc/*.js"],
+            "#mockDB/*": ["./misc/mockDB/*.js"]
         }
     }
 }