added mock data for accred, org, infra, department, topics, modules, major fixes

Author: TejasNair9977

.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

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"]
         }
     }
 }

constant.js renamed to misc/constant.js

@@ -0,0 +1,61 @@
+import { faker } from "@faker-js/faker"; // eslint-disable-line import/no-extraneous-dependencies
+import Infrastructure from "#models/infrastructure";
+import Accreditation from "#models/accreditation";
+import Organization from "#models/organization";
+import Department from "#models/department";
+import Topics from "#models/topic";
+import Module from "#models/module";
+import generateOrganizations from "#mockDB/orgMock";
+import ACCREDS from "#mockDB/accredMock";
+import TOPICS from "#mockDB/topicMock";
+import generateDepartments from "#mockDB/deptMock";
+import generateModules from "#mockDB/moduleMock";
+import generateInfrastructures from "#mockDB/infraMock";
+/* eslint-disable no-underscore-dangle */
+const createdAccreds = await Accreditation.createMultiple(ACCREDS);
+
+const parentOrg = await Organization.create({
+  startDate: faker.date.past({ years: 10 }),
+  name: "Thakur Education",
+  accreditations: [
+    createdAccreds[faker.number.int({ min: 0, max: createdAccreds.length - 1 })]
+      ._id,
+    createdAccreds[faker.number.int({ min: 0, max: createdAccreds.length - 1 })]
+      ._id,
+  ],
+});
+
+const ORGS = generateOrganizations(parentOrg._id, createdAccreds);
+
+const createdOrgs = await Organization.createMultiple(ORGS);
+
+const tcetObject = createdOrgs.filter(
+  (obj) => obj.name === "Thakur College of Engineering & Technology",
+)[0];
+
+const INFRA = generateInfrastructures(tcetObject._id);
+
+const createdInfras = await Infrastructure.createMultiple(INFRA);
+
+const filteredInfrastructures = createdInfras.filter((infrastructure) => {
+  const allowedTypes = ["LAB", "CLASSROOM", "COMPUTER LAB"];
+  return allowedTypes.includes(infrastructure.type);
+});
+
+const DEPTS = generateDepartments(
+  tcetObject._id,
+  createdAccreds.map((createdAccred) => createdAccred._id),
+  filteredInfrastructures.map((createdInfra) => createdInfra._id),
+);
+
+const createdDepts = await Department.createMultiple(DEPTS); // eslint-disable-line no-unused-vars
+
+const createdTopics = await Topics.createMultiple(TOPICS);
+
+const MODULES = await generateModules(
+  createdTopics.map((createdTopic) => createdTopic._id),
+);
+
+const createdModules = await Module.createMultiple(MODULES); // eslint-disable-line no-unused-vars
+
+process.exit(0);