Merge branch 'development' into 168-update_create_apidoc_for_infrastr…

…ucture

_apidoc.js

@@ -1,17 +1,161 @@
+// ------------------------------------------------------------------------------------------
+// General apiDoc documentation blocks and old history blocks.
+// ------------------------------------------------------------------------------------------
+// ------------------------------------------------------------------------------------------
+// Current Success.
+// ------------------------------------------------------------------------------------------
+// ------------------------------------------------------------------------------------------
+// Current Errors.
+// ------------------------------------------------------------------------------------------
+// ------------------------------------------------------------------------------------------
+// Current Permissions.
+// ------------------------------------------------------------------------------------------
+// ------------------------------------------------------------------------------------------
+// History.
+// ------------------------------------------------------------------------------------------
+
+
+// ------------------------------------------------------------------------------------------
+// Index.
+// ------------------------------------------------------------------------------------------
+
+/**
+ * @api {get} / Retrieve Home Information
+ * @apiName GetIndex
+ * @apiGroup index
+ *
+ * @apiSuccess {String} res server working.
+ */
+
+// ------------------------------------------------------------------------------------------
+// Auth.
+// ------------------------------------------------------------------------------------------
+
+/**
+ * @api {post} /auth Login User
+ * @apiName LoginUser
+ * @apiGroup Authentication
+ * 
+ * @apiBody {String} id User ID.
+ * @apiBody {String} password User password.
+ * 
+ * @apiSuccess {String} res Response message.
+ * @apiSuccess {Object} user User details.
+ * @apiSuccess {String} user.uid User ID.
+ * @apiSuccess {String} user.name User name.
+ * @apiSuccess {String} user.emailId User email ID.
+ * @apiSuccess {String} user.type User type.
+ * @apiSuccess {String} user.token User token.
+ * 
+ * @apiSuccessExample Success Response:
+ *     HTTP/1.1 200 OK
+ *     {
+ *       "res": "welcome",
+ *       "user": {
+ *         "uid": "123",
+ *         "name": "Some User",
+ *         "emailId": "[email protected]",
+ *         "type": "user",
+ *         "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
+ *       }
+ *     }
+ * 
+ * @apiError (Error 403) UserDoesNotExist Incorrect ID or password.
+ * @apiError (Error 500) ServerError Something is wrong on our side. Try again.
+ */
+
+/**
+ * @api {post} /auth/validateUser Validate User
+ * @apiName ValidateUser
+ * @apiGroup Authentication
+ * @apiDescription Validates the user's authentication token.
+ * 
+ * @apiHeader {String} Authorization User's authentication token.
+ * 
+ * @apiSuccess {Object} res User object.
+ * @apiSuccess {Object} res.user User details.
+ * @apiSuccess {String} res.user.uid User ID.
+ * @apiSuccess {String} res.user.name User name.
+ * @apiSuccess {String} res.user.emailId User email ID.
+ * @apiSuccess {String} res.user.type User type.
+ * 
+ * @apiSuccessExample Success Response:
+ *     HTTP/1.1 200 OK
+ *     {
+ *       "res": {
+ *         "user": {
+ *           "uid": "123",
+ *           "name": "Some User",
+ *           "emailId": "[email protected]",
+ *           "type": "user"
+ *         },
+ *         "msg": "user validated",
+ *         "err": null
+ *       }
+ *     }
+ */
+
+/**
+ * @api {post} /auth/sendOTP Send OTP
+ * @apiName SendOTP
+ * @apiGroup Authentication
+ * @apiDescription Sends an OTP (One-Time Password) to the user's email ID.
+ * 
+ * @apiBody {String} uid User ID.
+ * @apiBody {String} emailId User email ID.
+ * 
+ * @apiSuccess {String} res Response message.
+ * 
+ * @apiSuccessExample Success Response:
+ *     HTTP/1.1 200 OK
+ *     {
+ *       "res": "otp sent to emailID"
+ *     }
+ * 
+ * @apiError (Error) IncorrectUidOrEmail Incorrect UID or emailId.
+ */
+
+/**
+ * @api {post} /auth/resetPassword Reset Password
+ * @apiName ResetPassword
+ * @apiGroup Authentication
+ * @apiDescription Resets the user's password using the provided OTP (One-Time Password).
+ * 
+ * @apiBody {String} uid User ID.
+ * @apiBody {String} otp One-Time Password received by the user.
+ * @apiBody {String} password New password.
+ * 
+ * @apiSuccess {String} res Response message.
+ * 
+ * @apiSuccessExample Success Response:
+ *     HTTP/1.1 200 OK
+ *     {
+ *       "res": "successfully updated password"
+ *     }
+ * 
+ * @apiError (Error) IncorrectOtp Incorrect OTP.
+ * @apiError (Error 500) UpdateError Something went wrong while updating password.
+ * @apiError (Error 500) ServerError Something went wrong.
+ */
+
+// ------------------------------------------------------------------------------------------
+// Infrastructure.
+// ------------------------------------------------------------------------------------------
+
 /**
  * @api {post} /infrastructure/add Add Infrastructure
  * @apiName AddInfrastructure
  * @apiGroup Infrastructure
  *
- * @apiParam {String} name The name of the infrastructure.
- * @apiParam {String} type The type of the infrastructure.
- * @apiParam {String} wing The wing where the infrastructure is located.
- * @apiParam {Number} floor The floor where the infrastructure is located.
- * @apiParam {Number} capacity The capacity of the infrastructure.
+ * @apiBody {String} name The name of the infrastructure.
+ * @apiBody {String} type The type of the infrastructure.
+ * @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 {String} res Success message with the ID of the added infrastructure.
  *
  * @apiError (Error 500) DatabaseError Error while inserting in the database.
  *
  * @apiDescription Adds a new infrastructure to the system.
- */
+ */

controller/accreditation.js

@@ -1,4 +1,4 @@
-import { addNewAccreditation } from "#services/accreditation";
+import { addNewAccreditation, deleteAccreditationById } from "#services/accreditation";
 import { logger } from "#util";
 
 async function addAccreditation(req, res) {
@@ -15,5 +15,15 @@ async function addAccreditation(req, res) {
     res.json({ err: "Error while inserting in DB" });
   }
 }
-
-export default { addAccreditation };
+async function deleteAccreditation(req, res) {
+  const { accredationId} = req.params;
+  try {
+    await deleteAccreditationById(accredationId);
+    res.json({ res: "Accreditation deleted successfully" });
+  } catch (error) {
+    logger.error("Error while deleting", error);
+    res.status(500);
+    res.json({ err: "Error while deleting from DB" });
+  }
+}
+export default { addAccreditation, deleteAccreditation };

controller/auth.js

@@ -51,7 +51,7 @@ async function resetPassword(req, res) {
       await updatePassword(uid, password);
       res.json({ res: "successfully updated password" });
     } catch (error) {
-      logger.log("Error while updating", error);
+      logger.error("Error while updating", error);
       res.status(500);
       if (error.name === "UpdateError") res.json({ err: "Something went wrong while updating password" });
       else res.json({ err: "something went wrong" });

controller/infrastructure.js

@@ -1,12 +1,12 @@
-import { createinfrastructure } from "#services/infrastructure";
+import { createInfrastructure } from "#services/infrastructure";
 import { logger } from "#util";
 
 async function addinfrastructure(req, res) {
   const {
     name, type, wing, floor, capacity,
   } = req.body;
   try {
-    const newinfrastructure = await createinfrastructure(name, type, wing, floor, capacity);
+    const newinfrastructure = await createInfrastructure(name, type, wing, floor, capacity);
     res.json({ res: `added user ${newinfrastructure.id}` });
   } catch (error) {
     logger.error("Error while inserting", error);

models/accreditation.js

@@ -10,11 +10,14 @@ const accreditationSchema = {
 const Accreditation = connector.model("Accreditation", accreditationSchema);
 
 async function remove(filter) {
-  const res = await Accreditation.findOneAndDelete(filter);
-  return res;
+  const deleteResult = await Accreditation.deleteMany(filter);
+  return deleteResult.acknowledged;
 }
 
-async function create(name, agencyName, dateofAccreditation, dateofExpiry) {
+async function create(accreditationData) {
+  const {
+    name, agencyName, dateofAccreditation, dateofExpiry,
+  } = accreditationData;
   const accreditation = new Accreditation({
     name,
     agencyName,
@@ -26,13 +29,13 @@ async function create(name, agencyName, dateofAccreditation, dateofExpiry) {
 }
 
 async function read(filter, limit = 1) {
-  const accreditationData = await Accreditation.find(filter).limit(limit);
-  return accreditationData;
+  const accreditationDoc = await Accreditation.find(filter).limit(limit);
+  return accreditationDoc;
 }
 
-async function update(filter, updateObject) {
-  const accreditation = await Accreditation.findOneAndUpdate(filter, updateObject, { new: true });
-  return accreditation;
+async function update(filter, updateObject, options = { multi: true }) {
+  const deleteResult = await Accreditation.updateMany(filter, { $set: updateObject }, options);
+  return deleteResult.acknowledged;
 }
 
 export default {

models/assignment.js

@@ -1,10 +1,11 @@
-import connector from '#models/databaseUtil';
+import connector from "#models/databaseUtil";
 
 const assignmentSchema = {
   no: { type: Number, required: true },
   title: { type: String, required: true },
-  type: { type: String, required: true, enum: ['FA', 'RA'] },
+  type: { type: String, required: true, enum: ["FA", "RA"] },
   marks: { type: Number, required: true },
 };
 
-const Assignment = connector.model('Assignment', assignmentSchema);
+// eslint-disable-next-line  no-unused-vars
+const Assignment = connector.model("Assignment", assignmentSchema);

models/attendance.js

@@ -1,4 +1,4 @@
-import connector from "./databaseUtil";
+import connector from "#models/databaseUtil";
 
 connector.set("debug", true);
 
@@ -13,52 +13,35 @@ const attendanceSchema = {
 
 const Attendance = connector.model("Attendance", attendanceSchema);
 
-async function create(studentId, courseId) {
-  try {
-    const attendance = new Attendance({
-      student: studentId,
-      course: courseId,
-    });
-    const createAttendance = await attendance.save();
-    return createAttendance;
-  } catch (error) {
-    console.error("Error creating attendance:", error);
-    return null;
-  }
+async function create(attendanceData) {
+  const {
+    student, course, monthlyAttended, monthlyOccured, cumulativeAttended, cumulativeOccured,
+  } = attendanceData;
+  const attendance = new Attendance({
+    student,
+    course,
+    monthlyAttended,
+    monthlyOccured,
+    cumulativeAttended,
+    cumulativeOccured,
+  });
+  const attendanceDoc = await attendance.save();
+  return attendanceDoc;
 }
 
-async function read(attendanceId) {
-  try {
-    const attendance = await Attendance.findById(attendanceId);
-    return attendance;
-  } catch (error) {
-    console.error("error reading attendance", error);
-    return null;
-  }
+async function read(filter, limit = 1) {
+  const attendanceDoc = await Attendance.find(filter).limit(limit);
+  return attendanceDoc;
 }
 
-async function update(attendanceId, updateData) {
-  try {
-    const updatedAttendance = await Attendance.findByIdAndUpdate(
-      attendanceId,
-      updateData,
-      { new: true },
-    );
-    return updatedAttendance;
-  } catch (error) {
-    console.error("error updating attendance:", error);
-    return null;
-  }
+async function update(filter, updateObject, options = { multi: true }) {
+  const updateResult = await Attendance.updateMany(filter, { $set: updateObject }, options);
+  return updateResult.acknowledged;
 }
 
-async function remove(attendanceId) {
-  try {
-    const deletedAttendance = await Attendance.findByIdAndDelete(attendanceId);
-    return deletedAttendance;
-  } catch (error) {
-    console.error("error removing attendance", error);
-    return null;
-  }
+async function remove(filter) {
+  const deleteResult = await Attendance.deleteMany(filter);
+  return deleteResult.acknowledged;
 }
 export default {
   create, remove, update, read,