Merge pull request #1 from nabadeep25/dev

✨ IMPROVEMENT: Swagger docs adeed, code restructured etc.

Author: nabadeep25

package-lock.json

@@ -2,8 +2,10 @@
   "name": "typescript-node-sequelize-boilerplate",
   "version": "0.1.0",
   "description": "",
-  "author": "",
-  "license": " ",
+  "author": "Nabadeep Thakuria",
+  "homepage": "https://github.com/nabadeep25/typescript-node-sequelize-boilerplate",
+  "license": "MIT",
+  "keywords": ["typescript","node","express","sequelize","mysql","postgres","boilerplate","template","typescript node sequelize boilerplate","typescript node","typescript sequelize boilerplate"],
   "scripts": {
     "build-ts": "tsc",
     "build": "npm run build-ts && npm run lint ",
@@ -40,6 +42,8 @@
     "nodemailer": "^6.6.1",
     "otplib": "^12.0.1",
     "sequelize": "^6.25.3",
+    "swagger-jsdoc": "^6.2.5",
+    "swagger-ui-express": "^4.6.0",
     "winston": "3.3.3"
   },
   "devDependencies": {
@@ -54,6 +58,8 @@
     "@types/nodemailer": "6.4.0",
     "@types/request": "2.48.5",
     "@types/request-promise": "4.1.47",
+    "@types/swagger-jsdoc": "^6.0.1",
+    "@types/swagger-ui-express": "^4.1.3",
     "@types/winston": "2.4.4",
     "@typescript-eslint/eslint-plugin": "4.14.2",
     "@typescript-eslint/parser": "4.14.2",

package.json

@@ -2,10 +2,9 @@ import express from "express";
 import logger from "morgan";
 import dbInit from "./model/init";
 import cors from "cors";
-import { customRequest } from "./middleware/requiresUser";
+import { customRequest } from "./types/customDefinition";
 import { deserializeUser } from "./middleware";
-import userRouter from "./routes/userRoutes";
-import authRouter from "./routes/authRoute";
+import appRouter from "./routes/v1";
 
 // Create Express server
 const app = express();
@@ -23,8 +22,7 @@ app.use(deserializeUser);
  * Primary app routes.
  */
 
-app.use("/api/auth", authRouter);
-app.use("/api/user", userRouter);
+app.use("/api/v1", appRouter);
 
 /**
  * route to test server
@@ -39,7 +37,7 @@ app.get("/api/", (req: customRequest, res) => {
  */
 app.patch("/api/sync", async (req, res) => {
   try {
-    const sync = await dbInit(req.body?.alter);
+    const sync = await dbInit();
     res.status(200).json({ ...sync, error: false });
   } catch (err) {
     console.log("ERR", err);

src/app.ts

@@ -0,0 +1,26 @@
+const swaggerOption = {
+  definition: {
+    openapi: "3.0.0",
+    info: {
+      title: "typescript-node-sequelize-boilerplate API documentation",
+      version: "1.0.0",
+    },
+    servers: [
+      {
+        url: `http://localhost:${process.env.PORT || 3000}/api/v1`,
+      },
+    ],
+    components: {
+      securitySchemes: {
+        bearerAuth: {
+          type: "http",
+          scheme: "bearer",
+          bearerFormat: "JWT",
+        },
+      },
+    },
+  },
+
+  apis: ["src/routes/v1/*.ts"],
+};
+export { swaggerOption };

src/config/option.ts

@@ -1,12 +1,12 @@
 import { findOneUser, updateUserById } from "../services/userService";
-import { Request, Response } from "express";
+import { Response } from "express";
 import { omit } from "lodash";
-import { customRequest } from "../middleware/requiresUser";
+import { customRequest } from "../types/customDefinition";
 
 const omitData = ["password"];
-export const updateUser = async (req: Request, res: Response) => {
+export const updateUser = async (req: customRequest, res: Response) => {
   try {
-    const { userId } = req.params;
+    const { id: userId } = req.user;
 
     let body = req.body;
     body = omit(body, omitData);
@@ -39,7 +39,6 @@ export const getUserData = async (req: customRequest, res: Response) => {
   try {
     return res.status(200).json({
       data: req.user,
-
       error: false,
     });
   } catch (err) {
@@ -52,3 +51,4 @@ export const getUserData = async (req: customRequest, res: Response) => {
     return res.status(400).json({ errorMsg: msg, error: true });
   }
 };
+

src/controllers/user.ts

@@ -1,7 +1,7 @@
 import { get } from "lodash";
 import { verify } from "../util/jwt";
-import { Request, Response, NextFunction } from "express";
-import { customRequest } from "./requiresUser";
+import { Response, NextFunction } from "express";
+import { customRequest } from "../types/customDefinition";
 
 const deserializeUser = async (
   req: customRequest,

src/middleware/deserializeUser.ts

@@ -1,6 +1,6 @@
 import { get } from "lodash";
 import { Response, NextFunction } from "express";
-import { customRequest } from "./requiresUser";
+import { customRequest } from "../types/customDefinition";
 
 const isAdmin = async (
   req: customRequest,

src/middleware/isAdmin.ts

@@ -1,10 +1,7 @@
 import { get } from "lodash";
 import { getUserById } from "../services/userService";
-import { Request, Response, NextFunction } from "express";
-
-export interface customRequest extends Request {
-  user: any;
-}
+import { Response, NextFunction } from "express";
+import { customRequest } from "../types/customDefinition";
 
 const requireUser = async (
   req: customRequest,

src/middleware/requiresUser.ts

@@ -12,11 +12,11 @@ export const modelList = {
 
 /**
  * Sync database
- * @param alter
+
  * @returns  boolean
  */
 
-const dbInit = async (alter: boolean) => {
+const dbInit = async () => {
   try {
     await sequelizeConnection.sync({ alter: isDev });
     return { success: true };