Merge pull request #10 from Modarb-Ai-Trainer/refactor

package-lock.json

@@ -10,7 +10,6 @@
       "license": "ISC",
       "dependencies": {
         "bcrypt": "^5.1.1",
-        "body-parser": "^1.20.2",
         "cors": "^2.8.5",
         "dotenv": "^16.3.1",
         "express": "^4.18.2",
@@ -21,6 +20,7 @@
         "path": "^0.12.7"
       },
       "devDependencies": {
+        "@types/express": "^4.17.21",
         "nodemon": "^3.0.2",
         "ts-node": "^10.9.2",
         "typescript": "^5.3.3"
@@ -159,6 +159,61 @@
       "integrity": "sha512-vxhUy4J8lyeyinH7Azl1pdd43GJhZH/tP2weN8TntQblOY+A0XbT8DJk1/oCPuOOyg/Ja757rG0CgHcWC8OfMA==",
       "dev": true
     },
+    "node_modules/@types/body-parser": {
+      "version": "1.19.5",
+      "resolved": "https://registry.npmjs.org/@types/body-parser/-/body-parser-1.19.5.tgz",
+      "integrity": "sha512-fB3Zu92ucau0iQ0JMCFQE7b/dv8Ot07NI3KaZIkIUNXq82k4eBAqUaneXfleGY9JWskeS9y+u0nXMyspcuQrCg==",
+      "dev": true,
+      "dependencies": {
+        "@types/connect": "*",
+        "@types/node": "*"
+      }
+    },
+    "node_modules/@types/connect": {
+      "version": "3.4.38",
+      "resolved": "https://registry.npmjs.org/@types/connect/-/connect-3.4.38.tgz",
+      "integrity": "sha512-K6uROf1LD88uDQqJCktA4yzL1YYAK6NgfsI0v/mTgyPKWsX1CnJ0XPSDhViejru1GcRkLWb8RlzFYJRqGUbaug==",
+      "dev": true,
+      "dependencies": {
+        "@types/node": "*"
+      }
+    },
+    "node_modules/@types/express": {
+      "version": "4.17.21",
+      "resolved": "https://registry.npmjs.org/@types/express/-/express-4.17.21.tgz",
+      "integrity": "sha512-ejlPM315qwLpaQlQDTjPdsUFSc6ZsP4AN6AlWnogPjQ7CVi7PYF3YVz+CY3jE2pwYf7E/7HlDAN0rV2GxTG0HQ==",
+      "dev": true,
+      "dependencies": {
+        "@types/body-parser": "*",
+        "@types/express-serve-static-core": "^4.17.33",
+        "@types/qs": "*",
+        "@types/serve-static": "*"
+      }
+    },
+    "node_modules/@types/express-serve-static-core": {
+      "version": "4.17.41",
+      "resolved": "https://registry.npmjs.org/@types/express-serve-static-core/-/express-serve-static-core-4.17.41.tgz",
+      "integrity": "sha512-OaJ7XLaelTgrvlZD8/aa0vvvxZdUmlCn6MtWeB7TkiKW70BQLc9XEPpDLPdbo52ZhXUCrznlWdCHWxJWtdyajA==",
+      "dev": true,
+      "dependencies": {
+        "@types/node": "*",
+        "@types/qs": "*",
+        "@types/range-parser": "*",
+        "@types/send": "*"
+      }
+    },
+    "node_modules/@types/http-errors": {
+      "version": "2.0.4",
+      "resolved": "https://registry.npmjs.org/@types/http-errors/-/http-errors-2.0.4.tgz",
+      "integrity": "sha512-D0CFMMtydbJAegzOyHjtiKPLlvnm3iTZyZRSZoLq2mRhDdmLfIWOCYPfQJ4cu2erKghU++QvjcUjp/5h7hESpA==",
+      "dev": true
+    },
+    "node_modules/@types/mime": {
+      "version": "1.3.5",
+      "resolved": "https://registry.npmjs.org/@types/mime/-/mime-1.3.5.tgz",
+      "integrity": "sha512-/pyBZWSLD2n0dcHE3hq8s8ZvcETHtEuF+3E7XVt0Ig2nvsVQXdghHVcEkIWjy9A0wKfTn97a/PSDYohKIlnP/w==",
+      "dev": true
+    },
     "node_modules/@types/node": {
       "version": "20.10.4",
       "resolved": "https://registry.npmjs.org/@types/node/-/node-20.10.4.tgz",
@@ -167,6 +222,39 @@
         "undici-types": "~5.26.4"
       }
     },
+    "node_modules/@types/qs": {
+      "version": "6.9.11",
+      "resolved": "https://registry.npmjs.org/@types/qs/-/qs-6.9.11.tgz",
+      "integrity": "sha512-oGk0gmhnEJK4Yyk+oI7EfXsLayXatCWPHary1MtcmbAifkobT9cM9yutG/hZKIseOU0MqbIwQ/u2nn/Gb+ltuQ==",
+      "dev": true
+    },
+    "node_modules/@types/range-parser": {
+      "version": "1.2.7",
+      "resolved": "https://registry.npmjs.org/@types/range-parser/-/range-parser-1.2.7.tgz",
+      "integrity": "sha512-hKormJbkJqzQGhziax5PItDUTMAM9uE2XXQmM37dyd4hVM+5aVl7oVxMVUiVQn2oCQFN/LKCZdvSM0pFRqbSmQ==",
+      "dev": true
+    },
+    "node_modules/@types/send": {
+      "version": "0.17.4",
+      "resolved": "https://registry.npmjs.org/@types/send/-/send-0.17.4.tgz",
+      "integrity": "sha512-x2EM6TJOybec7c52BX0ZspPodMsQUd5L6PRwOunVyVUhXiBSKf3AezDL8Dgvgt5o0UfKNfuA0eMLr2wLT4AiBA==",
+      "dev": true,
+      "dependencies": {
+        "@types/mime": "^1",
+        "@types/node": "*"
+      }
+    },
+    "node_modules/@types/serve-static": {
+      "version": "1.15.5",
+      "resolved": "https://registry.npmjs.org/@types/serve-static/-/serve-static-1.15.5.tgz",
+      "integrity": "sha512-PDRk21MnK70hja/YF8AHfC7yIsiQHn1rcXx7ijCFBX/k+XQJhQT/gw3xekXKJvx+5SXaMMS8oqQy09Mzvz2TuQ==",
+      "dev": true,
+      "dependencies": {
+        "@types/http-errors": "*",
+        "@types/mime": "*",
+        "@types/node": "*"
+      }
+    },
     "node_modules/@types/webidl-conversions": {
       "version": "7.0.3",
       "resolved": "https://registry.npmjs.org/@types/webidl-conversions/-/webidl-conversions-7.0.3.tgz",
@@ -306,42 +394,6 @@
         "node": ">=8"
       }
     },
-    "node_modules/body-parser": {
-      "version": "1.20.2",
-      "resolved": "https://registry.npmjs.org/body-parser/-/body-parser-1.20.2.tgz",
-      "integrity": "sha512-ml9pReCu3M61kGlqoTm2umSXTlRTuGTx0bfYj+uIUKKYycG5NtSbeetV3faSU6R7ajOPw0g/J1PvK4qNy7s5bA==",
-      "dependencies": {
-        "bytes": "3.1.2",
-        "content-type": "~1.0.5",
-        "debug": "2.6.9",
-        "depd": "2.0.0",
-        "destroy": "1.2.0",
-        "http-errors": "2.0.0",
-        "iconv-lite": "0.4.24",
-        "on-finished": "2.4.1",
-        "qs": "6.11.0",
-        "raw-body": "2.5.2",
-        "type-is": "~1.6.18",
-        "unpipe": "1.0.0"
-      },
-      "engines": {
-        "node": ">= 0.8",
-        "npm": "1.2.8000 || >= 1.4.16"
-      }
-    },
-    "node_modules/body-parser/node_modules/debug": {
-      "version": "2.6.9",
-      "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz",
-      "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==",
-      "dependencies": {
-        "ms": "2.0.0"
-      }
-    },
-    "node_modules/body-parser/node_modules/ms": {
-      "version": "2.0.0",
-      "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz",
-      "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A=="
-    },
     "node_modules/brace-expansion": {
       "version": "1.1.11",
       "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz",
@@ -1664,20 +1716,6 @@
         "node": ">= 0.6"
       }
     },
-    "node_modules/raw-body": {
-      "version": "2.5.2",
-      "resolved": "https://registry.npmjs.org/raw-body/-/raw-body-2.5.2.tgz",
-      "integrity": "sha512-8zGqypfENjCIqGhgXToC8aB2r7YrBX+AQAfIPs/Mlk+BtPTztOvTS01NRW/3Eh60J+a48lt8qsCzirQ6loCVfA==",
-      "dependencies": {
-        "bytes": "3.1.2",
-        "http-errors": "2.0.0",
-        "iconv-lite": "0.4.24",
-        "unpipe": "1.0.0"
-      },
-      "engines": {
-        "node": ">= 0.8"
-      }
-    },
     "node_modules/readable-stream": {
       "version": "3.6.2",
       "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-3.6.2.tgz",

package.json

@@ -12,13 +12,13 @@
   "author": "",
   "license": "ISC",
   "devDependencies": {
+    "@types/express": "^4.17.21",
     "nodemon": "^3.0.2",
     "ts-node": "^10.9.2",
     "typescript": "^5.3.3"
   },
   "dependencies": {
     "bcrypt": "^5.1.1",
-    "body-parser": "^1.20.2",
     "cors": "^2.8.5",
     "dotenv": "^16.3.1",
     "express": "^4.18.2",

src/configs/app.ts

@@ -1,17 +0,0 @@
-import dotenv from "dotenv";
-dotenv.config();
-import express from "express";
-import bodyParser from "body-parser";
-import cors from "cors";
-import path from 'path';
-import { routes } from "../index.route";
-import { connection as databaseConnection } from "./database";
-
-databaseConnection();
-export const app = express();
-app.use(cors());
-app.use(express.json());
-app.use(routes);
-app.use(bodyParser.json());
-
-app.use(bodyParser.urlencoded({ extended: false }));

src/configs/config.ts

@@ -0,0 +1,17 @@
+import { Env } from "./env";
+import dotenv from "dotenv";
+dotenv.config();
+
+export interface Config {
+  port: number;
+  db: {
+    uri: string;
+  };
+}
+
+export const config: Config = {
+  port: Env.get("PORT", 4000).toNumber(),
+  db: {
+    uri: Env.get("DB_URI").toString(),
+  },
+};

src/configs/database.ts

@@ -1,20 +1,8 @@
-import mongoose from 'mongoose';
+import mongoose from "mongoose";
+import { config } from "./config";
 
-const uriMap = {
-    local: process.env.LOCAL_DB_CONNECTION_STRING,
-    development: process.env.DEV_DB_CONNECTION_STRING,
+export const connectDatabase = async () => {
+  return mongoose.connect(config.db.uri).then(() => {
+    console.log(`Connected to MongoDB database successfully!`);
+  });
 };
-
-console.log("CURRENT_ENV", process.env.CURRENT_ENV);
-const selectedEnv = process.env.CURRENT_ENV || 'development';
-let uri = uriMap[selectedEnv];
-console.log(uri);
-
-export const connection = async () => {
-    return mongoose.connect(uri)
-        .then(() => {
-            console.log(`Connected to MongoDB database successfully on ${selectedEnv} environment!`);
-        }).catch((err) => {
-            console.log("MongoDB Error: ", err);
-        })
-}

src/configs/env.ts

@@ -0,0 +1,25 @@
+export class EnvValue {
+  constructor(public value: string | number | boolean) {}
+
+  toString(): string {
+    return String(this.value);
+  }
+  toNumber(): number {
+    return Number(this.value);
+  }
+  toBoolean(): boolean {
+    return this.value === "true";
+  }
+}
+
+export class Env {
+  static get(key: string, defaultValue?: string | number | boolean): EnvValue {
+    const value = process.env[key] || defaultValue;
+
+    if (!value) {
+      throw new Error(`Environment variable ${key} not found`);
+    }
+
+    return new EnvValue(value);
+  }
+}

src/index.route.ts

@@ -1,38 +1,20 @@
-import express from 'express';
-const app = express.Router();
+import express from "express";
 
-import { userRoutes } from './modules/user/index.route';
-import { adminRoutes } from './modules/console/index.route';
+import { userRoutes } from "./modules/user/index.route";
+import { adminRouter } from "./modules/console/index.route";
 
-app.use("/api/v1/user", userRoutes);
-app.use("/api/v1/admin", adminRoutes);
+const mainRouter = express.Router();
 
+mainRouter.use("/user", userRoutes);
+mainRouter.use("/admin", adminRouter);
 
-app.get("/", (req: any, res: any) => {
-    res.status(200).json({ success: true, message: 'Welcome Message', code: 200 })
-})
+mainRouter.get("/health", (_req: any, res: any) => {
+  res.status(200).json({ success: true, message: "Server is up!", code: 200 });
+});
 
-app.get("*", (req: any, res: any) => {
-    res.status(404).json({ success: false, message: "Invalid URL!", code: 404 })
-})
+// catch non existing routes
+mainRouter.all("*", (_req: any, res: any) => {
+  res.status(404).json({ success: false, message: "Invalid URL!", code: 404 });
+});
 
-app.post("*", (req: any, res: any) => {
-    res.status(404).json({ success: false, message: "Invalid URL!", code: 404 })
-})
-
-app.put("*", (req: any, res: any) => {
-    res.status(404).json({ success: false, message: "Invalid URL!", code: 404 })
-})
-
-app.delete("*", (req: any, res: any) => {
-    res.status(404).json({ success: false, message: "Invalid URL!", code: 404 })
-})
-
-
-app.patch("*", (req: any, res: any) => {
-    res.status(404).json({ success: false, message: "Invalid URL!", code: 404 })
-})
-
-
-
-export { app as routes };
+export { mainRouter };

src/index.ts

@@ -1,10 +1,28 @@
-import { app } from "./configs/app"
-import http from 'http';
+import express from "express";
+import cors from "cors";
+import { connectDatabase } from "./configs/database";
+import { config } from "./configs/config";
+import { mainRouter } from "./index.route";
 
-const server = http.createServer(app);
+const main = async () => {
+  // set up database connection
+  await connectDatabase();
 
-server.listen(process.env.PORT || 4000, () => {
-    console.log(`Server is up and runing on port ${process.env.PORT}!`)
-})
+  // set up express server
+  const app = express();
 
+  // set up middlewares
+  app.use(cors());
+  app.use(express.urlencoded({ extended: true }));
+  app.use(express.json());
 
+  // set up routes
+  app.use("/api/v1", mainRouter);
+
+  // start server
+  app.listen(config.port, () => {
+    console.log(`Server is up and running on port ${config.port}!`);
+  });
+};
+
+main();

src/modules/common/{User/services/user.base.service.ts → users/services/users.base.service.ts}

@@ -1,7 +1,7 @@
 import { userModel, } from '../models/user.model'
 
 
-export class UserBaseService {
+export class UsersBaseService {
   static async find(filterObject) {
     try {
       const resultObject = await userModel.findOne(filterObject).lean();

src/modules/console/User/services/user.service.ts

@@ -1,8 +0,0 @@
-import { UserBaseService } from "../../../common/User/services/user.base.service";
-
-export class userService extends UserBaseService {
-
-}
-
-
-

src/modules/console/{Admin/services/admin.service.ts → admins/services/admins.service.ts}

@@ -2,7 +2,7 @@ import bcrypt from "bcrypt";
 import { adminModel, saltrounds } from '../models/admin.model'
 
 
-export class AdminService {
+export class AdminsService {
   static async find(filterObject) {
     try {
       const resultObject = await adminModel.findOne(filterObject).lean();

src/modules/console/index.route.ts

@@ -1,11 +1,11 @@
-import express from 'express';
-const app = express();
+import express from "express";
+const adminRouter = express.Router();
 
-import { jwtHelper } from '../../helpers/jwt.helper';
+import { jwtHelper } from "../../helpers/jwt.helper";
 const allowedRoles = ["superAdmin", "admin"];
 
-import { adminUserRoutes } from './User/routes/admin.userRoute';
+import { adminUserRoutes } from "./users/routes/admin-users.route";
 
-app.use("/users", jwtHelper.verifyToken(allowedRoles), adminUserRoutes);
+adminRouter.use("/users", jwtHelper.verifyToken(allowedRoles), adminUserRoutes);
 
-export { app as adminRoutes };
+export { adminRouter };

src/modules/console/{User/controllers/user.controller.ts → users/controllers/users.controller.ts}

@@ -1,10 +1,10 @@
-import { userService } from "../services/user.service";
+import { usersService } from "../services/users.service";
 
-export class adminUserController {
+export class adminUsersController {
 
     static async create(req, res) {
         try {
-            let result = await userService.create(req.body);
+            let result = await usersService.create(req.body);
             return res.status(result.code).json(result);
         } catch (err) {
             console.log(`err.message`, err.message);

src/modules/console/{User/routes/admin.userRoute.ts → users/routes/admin-users.route.ts}

@@ -1,11 +1,11 @@
 import express from "express";
-import { adminUserController } from "../controllers/user.controller";
+import { adminUsersController } from "../controllers/users.controller";
 import { adminUserValidation } from "../validation/admin.userValidation";
 import { validator } from "../../../../helpers/validation.helper";
 
 const app = express.Router();
 
-app.post("/create", validator(adminUserValidation.createValidation), adminUserController.create);
+app.post("/create", validator(adminUserValidation.createValidation), adminUsersController.create);
 
 export { app as adminUserRoutes };
 

src/modules/console/users/services/users.service.ts

@@ -0,0 +1,3 @@
+import { UsersBaseService } from "../../../common/users/services/users.base.service";
+
+export class usersService extends UsersBaseService {}

src/modules/console/{User → users}/validation/admin.userValidation.ts

@@ -1,5 +1,4 @@
-import joi from 'joi';
-import { userBaseValidation } from '../../../common/User/validation/user.baseValidation';
+import { userBaseValidation } from '../../../common/users/validation/user.baseValidation';
 
 export class adminUserValidation extends userBaseValidation {
 

src/modules/user/index.route.ts

@@ -4,7 +4,7 @@ const app = express();
 import { jwtHelper } from '../../helpers/jwt.helper';
 const allowedRoles = ["user"];
 
-import { authRoutes } from './User/routes/auth.route';
+import { authRoutes } from './users/routes/auth.route';
 
 app.use(authRoutes);
 

src/modules/user/{User → users}/controllers/auth.controller.ts

@@ -1,11 +1,11 @@
-import { userService } from "../services/user.service";
+import { usersService } from "../services/users.service";
 import { jwtHelper } from "../../../../helpers/jwt.helper";
 
 export class authController {
 
     static async register(req, res) {
         try {
-            let result = await userService.create(req.body);
+            let result = await usersService.create(req.body);
             return res.status(result.code).json(result);
         } catch (err) {
             console.log(`err.message`, err.message);
@@ -20,7 +20,7 @@ export class authController {
     static async login(req, res) {
         try {
             const { email, password } = req.body;
-            let result: { success: boolean; code: number; record?: any; message?: string } = await userService.comparePassword(email, password);
+            let result: { success: boolean; code: number; record?: any; message?: string } = await usersService.comparePassword(email, password);
             if (!result.success) return res.status(result.code).json(result);
             let payload = {
                 _id: result.record?._id, name: result.record?.name,

src/modules/user/{User/services/user.service.ts → users/services/users.service.ts}

@@ -1,15 +1,15 @@
-import { UserBaseService } from "../../../common/User/services/user.base.service";
-import { userModel, } from "../../../common/User/models/user.model";
+import { UsersBaseService } from "../../../common/users/services/users.base.service";
+import { userModel, } from "../../../common/users/models/user.model";
 import bcrypt from "bcrypt";
 
-export class userService extends UserBaseService {
+export class usersService extends UsersBaseService {
 
     static async comparePassword(email: string, password: string) {
         try {
             if (email != undefined) {
                 email = email.toLowerCase();
             }
-            let result = await UserBaseService.find({ email })
+            let result = await UsersBaseService.find({ email })
             if (!result.success) return result;
 
             let match = await bcrypt.compare(password, result.record.password)

src/modules/user/{User → users}/validation/user.Validation.ts

@@ -1,5 +1,5 @@
 import joi from 'joi';
-import { userBaseValidation } from '../../../common/User/validation/user.baseValidation';
+import { userBaseValidation } from '../../../common/users/validation/user.baseValidation';
 
 export class userValidation extends userBaseValidation {
     static loginValidation = {