nodejs-backpack 0.0.1-security → 2.0.28

package/package.json

@@ -1,6 +1,53 @@
-{
-  "name": "nodejs-backpack",
-  "version": "0.0.1-security",
-  "description": "security holding package",
-  "repository": "npm/security-holder"
-}
+{
+  "name": "nodejs-backpack",
+  "version": "2.0.28",
+  "description": "NodeJs Backpack is a powerful tool designed to simplify the development of Node.js REST APIs with ease and precision. It provides a streamlined workflow by automatically generating Mongoose schemas and handling the necessary configurations in your project. With just a few simple commands, NodeJs Backpack can create REST API components such as controllers and routes, while also ensuring route validation is implemented flawlessly. Additionally, NodeJs Backpack offers a command to generate sample files, providing a solid starting point for your project. With NodeJs Backpack, you can quickly set up your project and focus on building your APIs, letting the tool handle the repetitive tasks and allowing you to follow a smooth development process.",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "cli",
+    "CRUD Functionality",
+    "REST APIs",
+    "Files",
+    "Routing",
+    "Controllers",
+    "Models",
+    "Mongoose",
+    "jsonwebtoken",
+    "Authentication",
+    "JWT",
+    "Validation",
+    "Automation",
+    "Backpack",
+    "npm",
+    "node",
+    "node cli",
+    "node js",
+    "Node Js Project Builder",
+    "Project Builder",
+    "nodejs-backpack",
+    "jkg",
+    "jaykumar-gohil"
+  ],
+  "author": "Jaykumar Gohil",
+  "license": "CC BY-NC-ND 4.0",
+  "dependencies": {
+    "axios": "^1.6.2",
+    "cli-color": "^2.0.3",
+    "express": "^4.18.2",
+    "express-validator": "^7.0.1",
+    "jsonwebtoken": "^9.0.1",
+    "fs-extra": "^11.1.1",
+    "mongoose": "^7.3.1",
+    "mongoose-backpack": "^0.2.7",
+    "rest-api-response-npm": "^0.1.4"
+  },
+  "devDependencies": {
+    "uglify-js": "^3.17.4"
+  },
+  "bin": {
+    "nodejs-backpack": "./index.js"
+  }
+}

package/readme.md

@@ -0,0 +1,155 @@
+# NodeJs Backpack
+
+NodeJs Backpack is a powerful tool designed to simplify the development of Node.js REST APIs with ease and precision. It provides a streamlined workflow by automatically generating Mongoose schemas and handling the necessary configurations in your project.
+
+With just a few simple commands, NodeJs Backpack can create REST API components such as controllers and routes, while also ensuring route validation is implemented flawlessly. Additionally, NodeJs Backpack offers a command to generate sample files, providing a solid starting point for your project.
+
+With NodeJs Backpack, you can quickly set up your project and focus on building your APIs, letting the tool handle the repetitive tasks and allowing you to follow a smooth development process.
+
+## Installation
+
+Install package globally with npm
+
+```bash
+npm install nodejs-backpack -g
+```
+
+## Features
+
+- Robust REST APIs
+- Focus on optimized code
+- Auto file creation for schemas, routes, controllers and validations
+- helpers (modelsParams, appendParams, etc)
+- Mongoose DB support,
+- AppendParams for append data in APIs using Mongoose schema
+- Executable for generating applications quickly
+- Auto create logic for API CRUD
+
+## YouTube Tutorial
+
+[![Watch the video](https://img.youtube.com/vi/-L80PJucbEo/0.jpg)](https://youtu.be/-L80PJucbEo)
+
+## Quick Start (Rest APIs)
+
+The quickest way to get started with nodejs-backpack is to utilize the executable to generate an REST APIs as shown below:
+
+**Step1:** Create an empty directory:
+
+```bash
+mkdir NodeJs-REST-APIs
+```
+
+**Step2:** Enter into directory:
+
+```bash
+cd NodeJs-REST-APIs
+```
+
+**Step3:** Run Command:
+
+```bash
+nodejs-backpack sample:files
+```
+
+- File "`sample-app.js`", "`sample-package.json`" & "`.sample-env`" created in the root directory.
+- **Rename sample files** to "**`app.js`**", "**`package.json`**" & "**`.env`**" which are created in the root directory.
+
+  ![](https://github.com/GohilJaykumar/sharable/blob/main/typing.gif)
+
+- Update .env > **`DB=mongodb+srv...`** with valid connection.
+
+```bash
+PORT=3000
+DB="mongodb+srv://........mongodb.net/node_backpack"
+JWT_SIGNATURE=node_backpack
+HOST=http://localhost:3000
+```
+
+**Step4:** Run Command:
+
+```bash
+npm install
+```
+
+**Step5:** Run Command:
+
+```bash
+nodejs-backpack make:schema Tests
+```
+
+**Step6:** Run Command:
+
+```bash
+nodejs-backpack make:apis Test --url=tests --schema=Tests
+```
+
+- Rename schema name in comand as per your requirement **_nodejs-backpack make:apis Test --url=tests --schema=Tests_**.
+- Example: _nodejs-backpack make:apis **ROUTE_NAME** --url=**ROUTE_URL** --schema=**SCHEMA_NAME**_.
+- **Note:** _`SCHEMA_NAME` must exist in model directory `/models/SCHEMA_NAME`_
+
+**Step7:** Install 'nodemon' on global level for development purpose:
+
+```bash
+npm install nodemon -g
+```
+
+**Step8:** Now your APIs are ready to use and Server your project with:
+
+```bash
+npm run dev
+```
+
+**Step9:** Open Postman and create new collection and check the below apis:
+
+- Based on my command,
+  **_nodejs-backpack make:apis `Test` --url=`tests` --schema=`Tests`_**.
+- ROUTE_NAME = `Test`
+- ROUTE_URL = `tests`
+- SCHEMA_NAME = `Tests`
+- Below are list of APIs created by commands `.../api/ROUTE_URL`:
+- _**Get List API**_: **`GET:`** _`http://localhost:3000/api/tests?page_no=1&page_limit=20&search=` (Parameters: page_no, page_limit, search)_
+- _**Get Detail API**_: **`GET:`** _`http://localhost:3000/api/tests/64a41036174844d0394e7b2f`_
+- _**Store API**_: **`POST:`** _`http://localhost:3000/api/tests` (Body-Parameters: based on model schema)_
+- _**Update API**_: **`PUT:`** _`http://localhost:3000/api/tests/64a41036174844d0394e7b2f` (Body-Parameters: based on model schema)_
+- _**Delete API**_: **`DELETE:`** _`http://localhost:3000/api/tests/64a41036174844d0394e7b2f`_
+
+## Quick Start (Authentication APIs)
+
+The quickest way to get started with **signup**, **register**, **forgot-password**, **reset-password**, **get-profile** API's using nodejs-backpack is to utilize the executable to generate an REST APIs as shown below:
+
+**Step1:** Run Command:
+
+```bash
+nodejs-backpack make:auth
+```
+
+- Under **./routes/\*** '**IndexRoute.js**' and '**AuthRoute.js**' file will be create/updated.
+- '**AuthController.js**' file will be create in the '**./controllers/AuthController.js**' folder with all neccessary logics.
+- '**AuthMiddleware.js**' file will be create in the '**./middleware/AuthMiddleware.js**' folder with all neccessary JWT token verification logics.
+- mailtrap.js file will be create in the '**./config/mailtrap.js**' folder where you can configure SMTP mail credentials.
+- Under **./models/\*** '**User.js**' and '**ResetToken.js**' file will be create.
+
+**Step2:** Open Postman and create new collection and check the below apis:
+
+- Below are list of APIs created by commands `.../api/ROUTE_URL`:
+- _**Register API**_: **`POST:`** _`http://localhost:3000/api/register` (Body-Parameters: first_name, last_name, email, password)_
+- _**Login API**_: **`POST:`** _`http://localhost:3000/api/login` (Body-Parameters: email, password)_
+- _**Forgot Password API**_: **`POST:`** _`http://localhost:3000/api/forgot-password` (Body-Parameters: email)_
+- _**Reset Password API**_: **`POST:`** _`http://localhost:3000/api/reset-password` (Body-Parameters: email, password, reset_token)_. **Note**: Forgot password reset link will contain '**reset_token**' on mail.
+- _**Logout API**_: **`GET:`** _`http://localhost:3000/api/logout`_
+- _**Get Profile API**_: **`GET:`** _`http://localhost:3000/api/get-profile`_
+
+## Environment Variables
+
+To run this project, you will need to add the following environment variables to your .env file.
+
+```bash
+PORT=3000
+DB="mongodb+srv://........mongodb.net/node_backpack"
+JWT_SIGNATURE=node_backpack
+HOST=http://localhost:3000
+```
+
+## Authors
+
+- Jaykumar Gohil ([@jksk21](https://www.npmjs.com/~jksk21))

package/sample-app.js

@@ -0,0 +1,41 @@
+const express = require("express");
+const app = express();
+const routes = require("./routes/IndexRoute");
+const dotenv = require("dotenv").config().parsed;
+const mongoose = require("mongoose");
+const { catchError } = require("rest-api-response-npm");
+
+app.use((req, res, next) => {
+  res.setHeader("Access-Control-Allow-Origin", "*");
+  res.setHeader(
+    "Access-Control-Allow-Methods",
+    "OPTIONS, GET, POST, PUT, PATCH, DELETE"
+  );
+  res.setHeader("Access-Control-Allow-Headers", "Content-Type, Authorization");
+  next();
+});
+
+// Routes
+app.use("/api", routes);
+
+// default error messgae
+app.use((error, req, res, next) => {
+  catchError(res, error);
+  console.error(error);
+});
+
+// Serve files from the 'public' directory
+app.use(express.static("public"));
+
+// Start server mongooes and port
+mongoose
+  .connect(dotenv.DB)
+  .then((result) => {
+    const port = dotenv.PORT;
+    app.listen(port, () => {
+      console.log(`Server started on port http://localhost:${port}`);
+    });
+  })
+  .catch((err) => {
+    console.log(err);
+  });

package/sample-auth-controller.js

@@ -0,0 +1,217 @@
+const User = require("../models/User"); //
+const ResetToken = require("../models/ResetToken");
+const bcrypt = require("bcryptjs");
+const jwt = require("jsonwebtoken");
+const dotenv = require("dotenv").config().parsed;
+const crypto = require("crypto");
+const {
+  successResponse,
+  checkValidationResult,
+  customResponse,
+  errorResponse,
+} = require("rest-api-response-npm");
+const nodemailer = require("../config/mailtrap");
+
+const AuthController = {
+  signUp: (req, res, next) => {
+    const response = checkValidationResult(res, req);
+    if (response["status_code"] === 422) {
+      return errorResponse(
+        res,
+        response["data"],
+        response["message"],
+        response["status_code"]
+      );
+    }
+    const password = req.body.password;
+    bcrypt
+      .hash(password, 12)
+      .then((hashPw) => {
+        req.body.password = hashPw;
+        const user = new User(req.body);
+        return user.save();
+      })
+      .then((result) => {
+        return successResponse(res, result, "User Registerd Successfully");
+      })
+      .catch((err) => {
+        next(err);
+      });
+  },
+  login: (req, res, next) => {
+    const response = checkValidationResult(res, req);
+    if (response["status_code"] === 422) {
+      return errorResponse(
+        res,
+        response["data"],
+        response["message"],
+        response["status_code"]
+      );
+    }
+    const email = req.body.email;
+    const password = req.body.password;
+    let loadedUser;
+    User.findOne({ email: email })
+      .then((user) => {
+        loadedUser = user;
+        return bcrypt.compare(password, user.password);
+      })
+      .then((isEqual) => {
+        if (!isEqual) {
+          data = {
+            password: ["Wrong Password"],
+          };
+          return customResponse(res, data, "Wrong Password", 422);
+        }
+        // create new token using sign
+        return jwt.sign(
+          {
+            userId: loadedUser._id,
+          },
+          dotenv.JWT_SIGNATURE,
+          { expiresIn: "365d" }
+        );
+      })
+      .then((token) => {
+        loadedUser.token = token;
+        loadedUser.save();
+        return successResponse(
+          res,
+          { access_token: token, user_data: loadedUser },
+          "Login Successfully"
+        );
+      })
+      .catch((err) => {
+        next(err);
+      });
+  },
+  logout: (req, res, next) => {
+    const filter = { _id: req.userId };
+    const update = { token: "" };
+    User.findOneAndUpdate(filter, update)
+      .then(() => {
+        return successResponse(res, null, "You have been Logged Out");
+      })
+      .catch((err) => {
+        next(err);
+      });
+  },
+  forgotPassword: (req, res, next) => {
+    const response = checkValidationResult(res, req);
+    if (response["status_code"] === 422) {
+      return errorResponse(
+        res,
+        response["data"],
+        response["message"],
+        response["status_code"]
+      );
+    }
+    crypto.randomBytes(32, (err, buffer) => {
+      if (err) {
+        return customResponse(res, null, "Something went wrong", 400);
+      }
+      const token = buffer.toString("hex");
+      User.findOne({ email: req.body.email })
+        .then((user) => {
+          const reset_token = new ResetToken({
+            reset_token: token,
+            email: user.email,
+          });
+          return reset_token.save();
+        })
+        .then((result) => {
+          nodemailer.sendMail({
+            to: req.body.email,
+            from: "ats@technomarktest.io",
+            subject: "Password reset",
+            html: `
+            <p>You requested a password reset</p>
+            <p>Click this <a href="${dotenv?.HOST}/reset/?token=${token}&email=${req.body.email}">link</a> to set a new password.</p>
+          `,
+          });
+          return successResponse(
+            res,
+            null,
+            "Reset password link send your registerd email address"
+          );
+        })
+        .catch((err) => {
+          next(err);
+        });
+    });
+  },
+  resetPassword: (req, res, next) => {
+    const response = checkValidationResult(res, req);
+    if (response["status_code"] === 422) {
+      return errorResponse(
+        res,
+        response["data"],
+        response["message"],
+        response["status_code"]
+      );
+    }
+    const new_password = req.body.password;
+    const r_token = req.body.reset_token;
+    const email = req.body.email;
+    let resetUser;
+    ResetToken.findOne({
+      email: email,
+      reset_token: r_token,
+    })
+      .then((result) => {
+        if (!result) {
+          return customResponse(
+            res,
+            null,
+            `Reset token has expired. Please try the 'forgot password' option again to get a new reset token!`,
+            401
+          );
+        }
+        return User.findOne({
+          email: email,
+        });
+      })
+      .then((user) => {
+        resetUser = user;
+        return bcrypt.hash(new_password, 12);
+      })
+      .then((hashedPassword) => {
+        resetUser.password = hashedPassword;
+        return resetUser.save();
+      })
+      .then((result1) => {
+        return ResetToken.findOneAndDelete({
+          email: email,
+          reset_token: r_token,
+        });
+      })
+      .then((result1) => {
+        return successResponse(res, null, "Your Password Change Successfully");
+      })
+      .catch((err) => {
+        next(err);
+      });
+  },
+  profile: (req, res, next) => {
+    const usertoken = req.headers.authorization;
+    const token = usertoken.split(" ");
+    const user = jwt.verify(token[1], dotenv.JWT_SIGNATURE);
+    User.findOne({ _id: user.userId })
+      .then((userData) => {
+        if (!userData) {
+          return customResponse(
+            res,
+            null,
+            "A user with this email could not be found",
+            400
+          );
+        }
+        return successResponse(res, userData);
+      })
+      .catch((err) => {
+        next(err);
+      });
+  },
+};
+
+module.exports = AuthController;

package/sample-auth-middleware.js

@@ -0,0 +1,44 @@
+const jwt = require("jsonwebtoken");
+const dotenv = require("dotenv").config().parsed;
+const User = require("../models/User"); //
+const { customResponse } = require("rest-api-response-npm");
+
+function authenticateToken(req, res, next) {
+  const authHeader = req.headers["authorization"];
+
+  if (authHeader) {
+    const token = authHeader.split(" ")[1];
+
+    if (token) {
+      try {
+        const jwt_secret_key = dotenv?.JWT_SIGNATURE;
+        const decoded = jwt.verify(token, jwt_secret_key);
+        // Token is valid, you can access the decoded payload
+        console.log("decoded?.data?.token", decoded?.userId);
+        if (decoded?.userId) {
+          User.findOne({ _id: decoded?.userId })
+            .then((userData) => {
+              console.log("token", token);
+              console.log("userData", userData);
+              if (userData && token === userData?.token) {
+                req.user = decoded.data;
+                req.userId = decoded.userId;
+                next();
+              } else {
+                return customResponse(res, null, "Token is expired", 401);
+              }
+            })
+            .catch((err) => {});
+        }
+      } catch (err) {
+        return customResponse(res, null, "Token is invalid or expired", 401);
+      }
+    } else {
+      return customResponse(res, null, "No token found", 401);
+    }
+  } else {
+    return customResponse(res, null, "No authorization header", 401);
+  }
+}
+
+module.exports = authenticateToken;

package/sample-auth-route.js

@@ -0,0 +1,19 @@
+const express = require('express');
+const router = express.Router();
+const AuthController = require('../controllers/AuthController');
+const signUpRequestValidationRequest = require('./validationRequest/Auth/signUpRequestValidationRequest');
+const signInValidationRequest = require('./validationRequest/Auth/signInValidationRequest');
+const forgotPasswordValidationRequest = require('./validationRequest/Auth/forgotPasswordValidationRequest');
+const resetPasswordValidationRequest = require('./validationRequest/Auth/resetPasswordValidationRequest');
+const formParser = require('../helpers/formParser');
+const isAuth = require("../middleware/AuthMiddleware");
+
+
+router.post(`/register`,formParser,signUpRequestValidationRequest, AuthController.signUp);
+router.post(`/login`,formParser,signInValidationRequest, AuthController.login);
+router.post(`/forgot-password`,formParser,forgotPasswordValidationRequest, AuthController.forgotPassword);
+router.post(`/reset-password`,formParser,resetPasswordValidationRequest, AuthController.resetPassword);
+router.get(`/logout`,formParser,isAuth, AuthController.logout);
+router.get(`/get-profile`,formParser,isAuth, AuthController.profile);
+
+module.exports = router;

package/sample-config-mailer.js

@@ -0,0 +1,10 @@
+const nodemailer = require("nodemailer");
+module.exports = defaultExport = nodemailer.createTransport({
+  service: "mailtrap",
+  host: "sandbox.smtp.mailtrap.io",
+  port: 2525,
+  auth: {
+    user: "1f60b50#########",
+    pass: "f0dfc61#########",
+  },
+});