Merge branch 'development' into 252-apidoc-for-organization

Author: TejasNair9977

.eslintrc.cjs

@@ -4,7 +4,7 @@ module.exports = {
     es2021: true,
     jest: true
   },
-  extends: "airbnb-base",
+  extends: ["airbnb-base", "prettier"],
   overrides: [],
   parserOptions: {
     ecmaVersion: "latest",

.prettierignore

@@ -0,0 +1,7 @@
+**/node_modules
+**/apidoc
+**/.git
+**/_apidoc.js
+**/*.json
+**/*.css
+Dockerfile

.prettierrc

@@ -1,4 +1,5 @@
 {
-    "singleQuote": true,
-    "tabWidth": 2
+    "singleQuote": false,
+    "tabWidth": 2,
+    "semi": true
 }

_apidoc.js

@@ -713,6 +713,58 @@
  * @apiError (Error 500) DatabaseError Error message if there was an error during the deletion.
  */
 
+// ------------------------------------------------------------------------------------------
+// Activity.
+// ------------------------------------------------------------------------------------------
+
+/**
+ * @api {post} /activity/add Add Activty.
+ * @apiName AddActivity
+ * @apiGroup Activity
+ *
+ * @apiBody {Date} startTime The startTime of the activity.
+ * @apiBody {Number} duration The duration of the activity (in minutes).
+ * @apiBody {ObjectId} course The course of the activity (ObjectId).
+ * @apiBody {ObjectId} faculty The faculty alloted for the activity(ObjectId).
+ * @apiBody {String} type The type of activity.One of possible LECTURE, PRACTICAL, TUTORIAL.
+ * @apiBody {ObjectId} task The task of the activity (ObjectId).One of possible Topic,Practical,Tutorial.
+ * @apiBody {ObjectId} group The group of the activity (ObjectId).
+ * @apiBody {ObjectId} students the students who gonna attend the activity(ObjectId).
+ *
+ * @apiSuccess {String} res Response message.
+ *
+ * @apiError (Error 500) DatabaseError Error while inserting in the database.
+ *
+ * @apiDescription Adds a new Activity to the system.
+ */
+
+/**
+ *
+ * @apiSuccessExample Success-Response:
+ *     HTTP/1.1 200 OK
+ *     {
+ *       "res": "Added activity"
+ *     }
+ *
+ * @apiErrorExample Error-Response:
+ *     HTTP/1.1 500 Internal Server Error
+ *     {
+ *       "err": "Error while inserting in DB"
+ *     }
+ */
+
+/**
+ * @api {delete} /timetable/delete/:timetableId Delete Timetable
+ * @apiName DeleteTimetable
+ * @apiGroup Timetable
+ *
+ * @apiParam {String} timetableId The ID of the timetable 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} /organization/update/:organizationId Update Organisation
  * @apiName UpdateOrganization
@@ -727,3 +779,100 @@
  * @apiSuccess {String} res organization updated
  * @apiError (Error 500) Error while inserting in DB
  */
+
+/**
+ * @api {delete} /activity/delete/:activity Delete Activity.
+ * @apiName DeleteActivity
+ * @apiGroup Activity
+ *
+ * @apiParam {String} Activity The activity 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} /timetable/update Update Timetable
+ * @apiName UpdateTimetable
+ * @apiGroup Timetable
+ * @apiDescription Update existing timetable data.
+ *
+ * @apiBody {Date} startTime The startTime of the activity.
+ * @apiBody {Number} duration The duration of the activity (in minutes).
+ * @apiBody {ObjectId} course The course of the activity (ObjectId).
+ * @apiBody {ObjectId} faculty The faculty alloted for the activity(ObjectId).
+ * @apiBody {String} type The type of activity.One of possible LECTURE, PRACTICAL, TUTORIAL.
+ * @apiBody {ObjectId} task The task of the activity (ObjectId).One of possible Topic,Practical,Tutorial.
+ * @apiBody {ObjectId} group The group of the activity (ObjectId).
+ * @apiBody {ObjectId} students the students who gonna attend the activity(ObjectId).
+ *
+ * @apiSuccess {String} res Timetable updated.
+ */
+
+/**
+ * @api {post} /activity/update Update Activity.
+ * @apiName UpdateActivity
+ * @apiGroup Activity
+ * @apiDescription Update existing activity data.
+ *
+ * @apiBody {Date} startTime The startTime of the activity.
+ * @apiBody {Number} duration The duration of the activity (in minutes).
+ * @apiBody {ObjectId} course The course of the activity (ObjectId).
+ * @apiBody {ObjectId} faculty The faculty alloted for the activity(ObjectId).
+ * @apiBody {String} type The type of activity.One of possible LECTURE, PRACTICAL, TUTORIAL.
+ * @apiBody {ObjectId} task The task of the activity (ObjectId).One of possible Topic,Practical,Tutorial.
+ * @apiBody {ObjectId} group The group of the activity (ObjectId).
+ * @apiBody {ObjectId} students the students who gonna attend the activity(ObjectId).
+ *
+ * @apiSuccess {String} res Activity updated.
+ * @apiError (Error 500) DatabaseError Error in updating the database.
+ */
+
+/**
+ * @api {get} /timetable/list Get Timetable List
+ * @apiName GetTimetableList
+ * @apiGroup Timetable
+ *
+ * @apiQuery {Date} startTime The startTime of the activity.
+ * @apiQuery {Number} duration The duration of the activity (in minutes).
+ * @apiQUERY {ObjectId} course The course of the activity (ObjectId).
+ * @apiQuery {ObjectId} faculty The faculty alloted for the activity(ObjectId).
+ * @apiQuery {String} type The type of activity.One of possible LECTURE, PRACTICAL, TUTORIAL.
+ * @apiQuery {ObjectId} task The task of the activity (ObjectId).One of possible Topic,Practical,Tutorial.
+ * @apiQuery {ObjectId} group The group of the activity (ObjectId).
+ * @apiQuery {ObjectId} students the students who gonna attend the activity(ObjectId).
+ *
+ * @apiSuccess {Date} startTime The startTime of the activity.
+ * @apiSuccess {Number} duration The duration of the activity (in minutes).
+ * @apiSuccess {ObjectId} course The course of the activity (ObjectId).
+ * @apiSuccess {ObjectId} faculty The faculty alloted for the activity(ObjectId).
+ * @apiSuccess {String} type The type of activity.One of possible LECTURE, PRACTICAL, TUTORIAL.
+ * @apiSuccess {ObjectId} task The task of the activity (ObjectId).One of possible Topic,Practical,Tutorial.
+ * @apiSuccess {ObjectId} group The group of the activity (ObjectId).
+ * @apiSucess {ObjectId} students the students who gonna attend the activity(ObjectId).
+ */
+
+/**
+ * @api {get} /activity/list Get Activity List
+ * @apiName GetActivityList
+ * @apiGroup Activity
+ *
+ * @apiQuery {Date} startTime The startTime of the activity.
+ * @apiQuery {Number} duration The duration of the activity (in minutes).
+ * @apiQUERY {ObjectId} course The course of the activity (ObjectId).
+ * @apiQuery {ObjectId} faculty The faculty alloted for the activity(ObjectId).
+ * @apiQuery {String} type The type of activity.One of possible LECTURE, PRACTICAL, TUTORIAL.
+ * @apiQuery {ObjectId} task The task of the activity (ObjectId).One of possible Topic,Practical,Tutorial.
+ * @apiQuery {ObjectId} group The group of the activity (ObjectId).
+ * @apiQuery {ObjectId} students the students who gonna attend the activity(ObjectId).
+ *
+ * @apiSuccess {Date} startTime The startTime of the activity.
+ * @apiSuccess {Number} duration The duration of the activity (in minutes).
+ * @apiSuccess {ObjectId} course The course of the activity (ObjectId).
+ * @apiSuccess {ObjectId} faculty The faculty alloted for the activity(ObjectId).
+ * @apiSuccess {String} type The type of activity.One of possible LECTURE, PRACTICAL, TUTORIAL.
+ * @apiSuccess {ObjectId} task The task of the activity (ObjectId).One of possible Topic,Practical,Tutorial.
+ * @apiSuccess {ObjectId} group The group of the activity (ObjectId).
+ * @apiSucess {ObjectId} students the students who gonna attend the activity(ObjectId).
+ */

app.js

@@ -17,7 +17,9 @@ import tutorialRouter from "#routes/tutorial";
 import assignmentRouter from "#routes/assignment";
 import timetableRouter from "#routes/timetable";
 import courseworkRouter from "#routes/coursework";
+import activityRouter from "#routes/activity";
 import moduleRouter from "#routes/module";
+import facultyRouter from "#routes/faculty";
 import { identifyUser } from "#middleware/identifyUser";
 import departmentRouter from "#routes/department";
 
@@ -46,10 +48,12 @@ app.use("/department", departmentRouter);
 app.use("/practical", practicalRouter);
 app.use("/organization", organizationRouter);
 app.use("/student", studentRouter);
+app.use("/activity", activityRouter);
 app.use("/tutorial", tutorialRouter);
 app.use("/assignment", assignmentRouter);
 app.use("/timetable", timetableRouter);
 app.use("/department", departmentRouter);
 app.use("/coursework", courseworkRouter);
 app.use("/module", moduleRouter);
+app.use("/faculty", facultyRouter);
 export default app;

controller/activity.js

@@ -0,0 +1,64 @@
+import {
+    createActivity,deleteActivityById, activityList ,updateActivityById,
+}from "#services/activity";
+import {logger} from "#util" ;
+
+async function addActivity(req,res) {
+    const{
+        activityBlueprint,
+        startTime,
+        duration,
+        course,
+        faculty,
+        type,
+        task,
+        group,
+        students,
+    }=req.body;
+    try{
+        const newActivity = await createActivity(activityBlueprint,startTime,duration,course,faculty,type,task,group,students);
+        res.json ({res: `added activity ${newActivity.id}`, id: newActivity.id});
+    } catch (error){
+        logger.error ("Error while inserting",error);
+        res.status(500);
+        res.json({err:"Error while inserting in DB"});
+    }
+}
+
+async function updateActivity(req,res){
+    const { id }=req.params;
+    const {
+        ...data  
+    }=req.body;
+    try {
+         await updateActivityById(id,data);
+        res.json({res:`updated activity with id ${id}`});
+    }catch (error){
+        logger.error("Error while updating",error);
+        res.status(500);
+        res.json({err:"Error while updating in DB"});
+    }
+}
+
+async function getActivity(req,res){
+    const filter = req.query;
+    const activitylist =await activityList(filter);
+    res.json({res:activitylist});
+}
+
+
+async function deleteActivity(res,req){
+    const { id }=req.params;
+    try{
+        await deleteActivityById(id);
+
+        res.json({res:`Deleted activity with ID ${id}`});
+    }catch(error){
+        logger.error ("Error while deleting",error);
+        res.status(500).json({error:"Error while deleting from DB"});
+    }
+}
+
+export default {
+    addActivity, deleteActivity ,getActivity ,updateActivity,
+};

controller/assignment.js

@@ -9,7 +9,7 @@ async function addAssignment(req, res) {
   } = req.body;
   try {
     const newAssignment = await createAssignment(no, title, type, marks);
-    res.json({ res: `added user ${newAssignment.id}`, id: newAssignment.id });
+    res.json({ res: `added assignment ${newAssignment.id}`, id: newAssignment.id });
   } catch (error) {
     logger.error("Error while inserting", error);
     res.status(500);
@@ -24,7 +24,7 @@ async function updateAssignment(req, res) {
   } = req.body;
   try {
     await updateAssignmentById(id, data);
-    res.json({ res: `updated assignment with id ${id}` });
+    res.json({ res: `updated assignment ${id}` });
   } catch (error) {
     logger.error("Error while updating", error);
     res.status(500);

controller/faculty.js

@@ -0,0 +1,84 @@
+import {
+  createFaculty, facultyList, deleteFacultyById, updateFacultyById,
+} from "#services/faculty";
+import { logger } from "#util";
+
+async function addFaculty(req, res) {
+  const {
+    ERPID,
+    dateOfJoining,
+    dateOfLeaving,
+    profileLink,
+    qualifications,
+    totalExperience,
+    achievements,
+    areaOfSpecialization,
+    papersPublishedPG,
+    papersPublishedUG,
+    department,
+    preferredSubjects,
+    designation,
+    natureOfAssociation,
+    additionalResponsibilities,
+  } = req.body;
+  try {
+    const newFaculty = await createFaculty(
+      ERPID,
+      dateOfJoining,
+      dateOfLeaving,
+      profileLink,
+      qualifications,
+      totalExperience,
+      achievements,
+      areaOfSpecialization,
+      papersPublishedPG,
+      papersPublishedUG,
+      department,
+      preferredSubjects,
+      designation,
+      natureOfAssociation,
+      additionalResponsibilities,
+    );
+    res.json({ res: `added faculty ${newFaculty.ERPID}` });
+  } catch (error) {
+    logger.error("Error while inserting", error);
+    res.status(500);
+    res.json({ err: "Error while inserting in DB" });
+  }
+}
+
+async function getFaculty(req, res) {
+  const filter = req.query;
+  const facultylist = await facultyList(filter);
+  res.json({ res: facultylist });
+}
+
+async function deleteFaculty(req, res) {
+  const { facultyId } = req.params;
+  try {
+    await deleteFacultyById(facultyId);
+    res.json({ res: "Faculty deleted successfully" });
+  } catch (error) {
+    logger.error("Error while deleting", error);
+    res.status(500);
+    res.json({ err: "Error while deleting from DB" });
+  }
+}
+
+async function updateFaculty(req, res) {
+  const {
+    id, ...data
+  } = req.body;
+  try {
+    await updateFacultyById(id, data);
+    res.json({ res: `updated faculty with id ${id}` });
+  } catch (error) {
+    logger.error("Error while updating", error);
+    res.status(500);
+    res.json({ err: "Error while updating in DB" });
+  }
+}
+
+export default {
+  addFaculty, getFaculty, deleteFaculty, updateFaculty,
+};

hooks/pre-commit

@@ -9,6 +9,9 @@ do
   # Get staged content of the file
   staged_content=$(git show ":$file")
 
+  # Format staged files 
+  npx prettier --write $file
+
   # Run ESLint with the staged content and filename
   # echo "$staged_content" | npm run eslint -- --stdin 
   npx eslint $file
@@ -20,4 +23,4 @@ done
 
 if [ $flag -eq 1 ]; then
   exit 1
-fi
+fi