Merge branch 'development' of https://github.com/tcet-opensource/erp-backend into 54-update-the-documentation-for-the-project

Author: Aastha-S-Rai

.eslintignore

@@ -0,0 +1 @@
+apidoc

.github/pull_request_template.md

@@ -0,0 +1,17 @@
+## Description
+Briefly describe the changes made in this pull request.
+
+## Fixes
+Specify the related issues or tickets that this pull request fixes (e.g., Fixes #123).
+
+## Checklist
+<!-- add x inside brackets for ticking the checkbox eg - [x] -->
+- [ ] Code follows project's style guidelines.
+- [ ] Changes are documented appropriately.
+
+## Notes
+Add any additional notes or context that might be useful for reviewers.
+
+
+
+####  (PS →  Make Sure Pull request title is meaningful.)

.gitignore

@@ -129,3 +129,5 @@ dist
 .yarn/install-state.gz
 .pnp.*
 
+# ingore genrated APIdocs
+apidoc

_apidoc.js

@@ -0,0 +1,19 @@
+// ------------------------------------------------------------------------------------------
+// General apiDoc documentation blocks and old history blocks.
+// ------------------------------------------------------------------------------------------
+
+// ------------------------------------------------------------------------------------------
+// Current Success.
+// ------------------------------------------------------------------------------------------
+
+// ------------------------------------------------------------------------------------------
+// Current Errors.
+// ------------------------------------------------------------------------------------------
+
+// ------------------------------------------------------------------------------------------
+// Current Permissions.
+// ------------------------------------------------------------------------------------------
+
+// ------------------------------------------------------------------------------------------
+// History.
+// ------------------------------------------------------------------------------------------

apidoc.json

@@ -0,0 +1,5 @@
+{
+    "name": "ERP-backend",
+    "version": "0.1.0",
+    "description": "TCET ERP System is a project that aims to simplify and automate daily operation in TCET."
+  }

controller/auth.js

@@ -1,8 +1,7 @@
-import util, {logger} from "#util";
+import OTPStore from "#models/otpStore";
+import util, { logger } from "#util";
 import { authenticateUser, userExists, updatePassword } from "#services/user";
 
-const otpStore = {};
-
 async function login(req, res) {
   const { id, password } = req.body;
   try {
@@ -17,7 +16,7 @@ async function login(req, res) {
     userDetails.token = token;
     res.json({ res: "welcome", user: userDetails });
   } catch (error) {
-    logger.error("Error while login", error)
+    logger.error("Error while login", error);
     if (error.name === "UserDoesNotExist") {
       res.status(403);
       res.json({ err: "Incorrect ID password" });
@@ -36,7 +35,7 @@ async function sendOTP(req, res) {
   const { uid, emailId } = req.body;
   if (await userExists(uid, emailId)) {
     const otp = Math.floor(1000 + Math.random() * 9000);
-    otpStore[uid] = otp;
+    await OTPStore.update({ uid }, { otp });
     util.sendOTP(emailId, otp);
     res.json({ res: "otp sent to emailID" });
   } else {
@@ -46,12 +45,13 @@ async function sendOTP(req, res) {
 
 async function resetPassword(req, res) {
   const { uid, otp, password } = req.body;
-  if (otpStore[uid] === otp) {
+  const storedOtp = await OTPStore.read({ uid });
+  if (storedOtp[0].otp === `${otp}`) {
     try {
       await updatePassword(uid, password);
       res.json({ res: "successfully updated password" });
     } catch (error) {
-      logger.log("Error while updating", error)
+      logger.log("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/user.js

@@ -9,8 +9,8 @@ async function addUser(req, res) {
     const newUser = await createUser(name, password, emailId, uid, userType);
     res.json({ res: `added user ${newUser.id}` });
   } catch (error) {
-    logger.error("Error while inserting", error)
-    res.status(500)
+    logger.error("Error while inserting", error);
+    res.status(500);
     res.json({ err: "Error while inserting in DB" });
   }
 }

hooks/pre-commit

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+for file in $(git diff --diff-filter=d --cached --name-only | grep -E '\.(js|jsx)$')
+do
+  git show ":$file" | npm run eslint --stdin --stdin-filename "$file" 
+  if [ $? -ne 0 ]; then
+    echo "ESLint failed on staged file '$file'. Please check your code and try again. You can run ESLint manually via npm run eslint."
+    exit 1 
+  fi
+done

middleware/auth.js

@@ -1,5 +1,5 @@
 import jwt from "jsonwebtoken";
-import util, {logger} from "#util";
+import util from "#util";
 
 async function authenticateToken(req, res, next) {
   const authHeader = req.headers.authorization;
@@ -9,15 +9,17 @@ async function authenticateToken(req, res, next) {
     const payload = jwt.verify(token, process.env.TOKEN_SECRET);
     const decryptedIP = util.decrypt(payload.ip);
     if (decryptedIP !== req.ip) {
-      res.status(403)
-      res.send({err:"Unauthorized"});
+      res.status(403);
+      res.send({ err: "Unauthorized" });
     }
 
     req.user = payload.data;
     next();
+    return true;
   } catch (error) {
-    res.status(403)
-    res.send({err:"Unauthorized"});
+    res.status(403);
+    res.send({ err: "Unauthorized" });
+    return false;
   }
 }
 

models/accreditation.js

@@ -1,25 +1,23 @@
 import connector from "#models/databaseUtil";
 
 const accreditationSchema = {
-  uid: { type: String, unique: true, required: true },
-  accreditationName: { type: String, required: true },
+  name: { type: String, required: true },
   agencyName: { type: String, required: true },
   dateofAccreditation: { type: Date, required: true },
   dateofExpiry: { type: Date, required: true },
 };
 
-const Accreditation = new connector.model("Accreditation", accreditationSchema);
+const Accreditation = connector.model("Accreditation", accreditationSchema);
 
 async function remove(filter) {
   const res = await Accreditation.findOneAndDelete(filter);
   return res;
 }
 
-async function create(uid, accreditationName, agencyName, dateofAccreditation, dateofExpiry) {
+async function create(name, agencyName, dateofAccreditation, dateofExpiry) {
   const accreditation = new Accreditation({
-    accreditationName,
+    name,
     agencyName,
-    uid,
     dateofAccreditation,
     dateofExpiry,
   });