Merge branch 'development' into 258-endpoints-from-pracs

Author: TejasNair9977

_apidoc.js

@@ -309,3 +309,117 @@
  * @apiSuccess {Date} accreditation.dateofAccreditation Date on which accreditation was issued.
  * @apiSuccess {Date} accreditation.dateofExpiry Date till which accreditation is valid.
  */
+
+// ------------------------------------------------------------------------------------------
+// Coursework.
+// ------------------------------------------------------------------------------------------
+
+/**
+ * @api {post} /coursework/add Add Coursework
+ * @apiName AddCoursework
+ * @apiGroup Coursework
+ * @apiDescription Add a new coursework entry.
+ *
+ * @apiBody {ObjectId} student ID of the student (ObjectId).
+ * @apiBody {String} Coursework type that is either onCampus or offCampus.
+ * @apiBody {ObjectId} course ID of the Course in Coursework (ObjectId).
+ * @apiBody {ObjectId} task ID of the task in Coursework (ObjectId).
+ * @apiBody {String} objectID either its practicals or tutorial or assignment .
+ * @apiBody {ObjectId} activity Id of the activity in Coursework.
+ * @apiBody {Number} Marks in the Coursework.
+ *
+ * @apiSuccess {String} res Response message.
+ * @apiError (Error 500) DatabaseError Err message if there is an error inserting into the database.
+ *
+ * @apiSuccessExample Success-Response:
+ *     HTTP/1.1 200 OK
+ *     {
+ *       "res": "Added coursework"
+ *     }
+ *
+ * @apiErrorExample Error-Response:
+ *     HTTP/1.1 500 Internal Server Error
+ *     {
+ *       "err": "Error while inserting in DB"
+ *     }
+ */
+
+/**
+ * @api {delete} /coursework/delete/:courseworkId Delete Coursework
+ * @apiName DeleteCoursework
+ * @apiGroup Coursework
+ *
+ * @apiParam {String} courseworkId The ID of the Coursework document to delete.
+ *
+ * @apiSuccess {String} res Success message indicating the deletion.
+ *
+ * @apiError (Error 500) DatabaseError Error message if there was an error during the deletion.
+ */
+
+/**
+ * @api {post} /coursework/update Update Coursework
+ * @apiName UpdateCoursework
+ * @apiGroup Coursework
+ * @apiDescription Update existing coursework data.
+ *
+ * @apiBody {String} id ID of the Coursework to be updated.
+ * @apiBody {ObjectId} student ID of the student (ObjectId).
+ * @apiBody {String} Coursework type that is either onCampus or offCampus.
+ * @apiBody {ObjectId} course ID of the Course in Coursework (ObjectId).
+ * @apiBody {ObjectId} task ID of the task in Coursework (ObjectId).
+ * @apiBody {String} objectID either its practicals or tutorial or assignment .
+ * @apiBody {ObjectId} activity Id of the activity in Coursework.
+ * @apiBody {Number} Marks in the Coursework.
+ *
+ * @apiSuccess {String} res Coursework updated.
+ * @apiError (Error 500) DatabaseError Error in updating the database.
+ */
+
+/**
+ * @api {get} /coursework/list Get Coursework List
+ * @apiName GetCourseworkList
+ * @apiGroup Coursework
+ *
+ * @apiQuery {ObjectId} student ID of the student (ObjectId).
+ * @apiQuery {String} Coursework type that is either onCampus or offCampus.
+ * @apiQuery {ObjectId} course ID of the Course in Coursework (ObjectId).
+ * @apiQuery {ObjectId} task ID of the task in Coursework (ObjectId).
+ * @apiQuery {String} objectID either its practicals or tutorial or assignment .
+ * @apiQuery {ObjectId} activity Id of the activity in Coursework.
+ * @apiQuery {Number} Marks in the Coursework.
+ *
+ * @apiSuccess {Coursework[]} res Array of filtered coursework documents.
+ * @apiSuccess {String} coursework._id ID of the coursework document given by the database.
+ * @apiSuccess {ObjectId} coursework.student ID of the student (ObjectId).
+ * @apiSuccess {String} coursework.type Coursework type that is either onCampus or offCampus.
+ * @apiSuccess {ObjectId} coursework.course ID of the Course in Coursework (ObjectId).
+ * @apiSuccess {ObjectId} coursework.task ID of the task in Coursework (ObjectId).
+ * @apiSuccess {String} coursework.objectID objectID either Practicals or Tutorial or Assignment .
+ * @apiSuccess {ObjectId} coursework.activity Id of the activity in Coursework.
+ * @apiSuccess {Number} coursework.marks Marks in the Coursework.
+ */
+=======
+// Module.
+// ------------------------------------------------------------------------------------------
+
+/**
+ * @api {get} module/list Get Module List
+ * @apiName GetModule
+ * @apiGroup Module
+ *
+ * @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 {Number} [hrsPerModule] Number of hours required per module.
+ * @apiQuery {String[]} [cognitiveLevels] Array of cognitive levels of attainment as per Bloom's Taxanomy (L1-L6).
+ *
+ * @apiSuccess {module[]} res Array of Filtered module Doc.
+ * @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 attainment as per Bloom's Taxanomy (L1-L6).
+ */

app.js

@@ -11,6 +11,8 @@ import authRouter from "#routes/auth";
 import accreditationRouter from "#routes/accreditation";
 import infrastructureRouter from "#routes/infrastructure";
 import practicalRouter from "#routes/practical";
+import courseworkRouter from "#routes/coursework";
+import moduleRouter from "#routes/module";
 import { identifyUser } from "#middleware/identifyUser";
 
 
@@ -36,4 +38,7 @@ app.use("/auth", authRouter);
 app.use("/accreditation", accreditationRouter);
 app.use("/infrastructure", infrastructureRouter);
 app.use("/practical", practicalRouter);
+app.use("/coursework", courseworkRouter);
+app.use("/module", moduleRouter);
+
 export default app;

controller/coursework.js

@@ -0,0 +1,67 @@
+// Import Coursework-related services and utilities
+import {
+  createCoursework,
+  deleteCourseworkById,
+  listCoursework,
+  updateCourseworkById,
+} from "#services/coursework";
+
+import { logger } from "#util"; // Import the logger utility
+
+// Controller function to add a new Coursework entity
+async function addCoursework(req, res) {
+  const {
+    student, type, course, task, objectID, activity, marks,
+  } = req.body;
+  try {
+    const newCoursework = await createCoursework({
+      student, type, course, task, objectID, activity, marks,
+    });
+    res.json({ res: `Added Coursework with ID ${newCoursework.id}` });
+  } catch (error) {
+    logger.error("Error while inserting Coursework", error);
+    res.status(500);
+    res.json({ err: "Error while inserting Coursework in DB" });
+  }
+}
+
+// Controller function to update a Coursework entity
+async function updateCoursework(req, res) {
+  const {
+    id, ...data
+  } = req.body;
+  try {
+    await updateCourseworkById(id, data);
+    res.json({ res: "/Updated Coursework/" });
+  } catch (error) {
+    logger.error("Error while updating Coursework", error);
+    res.status(500);
+    res.json({ err: "Error while updating Coursework in DB" });
+  }
+}
+
+// Controller function to get a list of Coursework entities
+async function getCoursework(req, res) {
+  const filter = req.query;
+  const courseworkList = await listCoursework(filter);
+  res.json({ res: courseworkList });
+}
+
+// Controller function to delete a Coursework entity
+async function deleteCoursework(req, res) {
+  const { courseworkId } = req.params;
+  try {
+    await deleteCourseworkById(courseworkId);
+    res.json({ res: `Deleted Coursework with ID ${courseworkId}` });
+  } catch (error) {
+    logger.error("Error while deleting Coursework", error);
+    res.status(500).json({ error: "Error while deleting Coursework from DB" });
+  }
+}
+
+export default {
+  addCoursework,
+  deleteCoursework,
+  getCoursework,
+  updateCoursework,
+};

controller/module.js

@@ -0,0 +1,17 @@
+import { getModule } from "#services/module";
+import { logger } from "#util";
+
+async function showModule(req, res) {
+  try {
+    const modules = await getModule(req.query);
+    return res.json({ res: modules });
+  } catch (error) {
+    logger.error("Error while fetching", error);
+    res.status(500);
+    return res.json({ err: "Error while fetching the data" });
+  }
+}
+
+export default {
+  showModule,
+}

models/activityBlueprint.js

@@ -6,7 +6,7 @@ const activityBluePrintSchema = {
     type: String,
     required: true,
     validate: {
-      validator: (value) => /^20\d{2}$/.test(value), //changed the valid year format starting from "20" !!
+      validator: (value) => /^20\d{2}$/.test(value), // changed the valid year format starting from "20" !!
       message: (props) => `${props.value} is not a valid year format starting with "2"!`,
     },
   },
@@ -26,12 +26,12 @@ async function remove(filter) {
 async function create(activityBlueprintData) {
   const {
     number, academicYear, type, startDate, endDate,
-  } = activityBlueprintDataData;
+  } = activityBlueprintData;
   const activityblueprint = new ActivityBlueprint({
     number,
-    academicYear, 
-    type, 
-    startDate, 
+    academicYear,
+    type,
+    startDate,
     endDate,
   });
   const activityblueprintDoc = await activityblueprint.save();
@@ -48,6 +48,6 @@ async function update(filter, updateObject, options = { multi: true }) {
   return deleteResult.acknowledged;
 }
 
-export default{
+export default {
   create, read, update, remove,
-}
+};

models/coursework.js

@@ -10,5 +10,43 @@ const courseworkSchema = {
   marks: { type: Number, required: true },
 };
 
-// eslint-disable-next-line  no-unused-vars
 const Coursework = connector.model("Coursework", courseworkSchema);
+
+async function create(courseworkData) {
+  const {
+    student, type, course, task, objectID, activity, marks,
+  } = courseworkData;
+  const coursework = new Coursework({
+    student,
+    type,
+    course,
+    task,
+    objectID,
+    activity,
+    marks,
+  });
+  const courseworkDoc = await coursework.save();
+  return courseworkDoc;
+}
+
+async function read(filter, limit = 1) {
+  const courseworkDoc = await Coursework.find(filter).limit(limit);
+  return courseworkDoc;
+}
+
+async function update(filter, updateObject, options = { multi: true }) {
+  const updateResult = await Coursework.updateMany(filter, { $set: updateObject }, options);
+  return updateResult.acknowledged;
+}
+
+async function remove(filter) {
+  const deleteResult = await Coursework.deleteMany(filter).exec();
+  return deleteResult.acknowledged;
+}
+
+export default {
+  create,
+  read,
+  update,
+  remove,
+};

models/semester.js

@@ -0,0 +1,59 @@
+import connector from "#models/databaseUtil";
+const semesterSchema = {
+  number:{ type: Number,enum: [1,2,3,4,5,6,7,8], required:true},
+  academicYear: {
+    type: String,
+    required: true,
+    validate: {
+      validator: (value) => /^20\d{2}$/.test(value),
+      message: (props) => `${props.value} is not a valid year format starting with "2"!`,
+    },
+  },
+  type:{ enum: ["ODD", "EVEN"], required: true },
+
+  startDate: { type: Date, required: true },
+  endDate: { type: Date, required: true },
+};
+
+// eslint-disable-next-line  no-unused-vars
+const Semester = connector.model("Semester", semesterSchema);
+
+//  CURD operations
+async function create(semesterData) {
+    const {
+      number,
+      academicYear,
+      type,
+      startDate,
+      endDate,
+    } = semesterData;
+    const semester = new Semester({
+      number,
+      academicYear,
+      type,
+      startDate,
+      endDate,
+
+    });
+    const semesterDoc = await semester.save();
+    return semesterDoc;
+  }
+  
+  async function read(filter, limit = 1) {
+    const semesterDoc = await Semester.find(filter).limit(limit);
+    return semesterDoc;
+  }
+  
+  async function update(filter, updateObject, options = { multi: true }) {
+    const updateResult = await Semester.updateMany(filter, { $set: updateObject }, options);
+    return updateResult.acknowledged;
+  }
+  
+  async function remove(filter) {
+    const deleteResult = await Semester.deleteMany(filter);
+    return deleteResult.acknowledged;
+  }
+  export default {
+    create, remove, update, read,
+  };
+  

routes/coursework.js

@@ -0,0 +1,10 @@
+import express from "express";
+import courseworkController from "#controller/coursework";
+
+const router = express.Router();
+router.post("/add", courseworkController.addCoursework);
+router.get("/list", courseworkController.getCoursework);
+router.post("/update", courseworkController.updateCoursework);
+router.post("/delete/:courseworkId", courseworkController.deleteCoursework);
+
+export default router;

routes/module.js

@@ -0,0 +1,8 @@
+import express from "express";
+import moduleController from "#controller/module";
+
+const router = express.Router();
+
+router.get("/list", moduleController.showModule);
+
+export default router;