nodejs-backpack 0.0.1-security → 2.0.28

package/sample-controller.js

@@ -0,0 +1,174 @@
+const {
+  successResponse,
+  checkValidationResult,
+  errorResponse,
+} = require("rest-api-response-npm");
+const ${schemaName} = require("../models/${schemaName}");
+const {
+  generatePaginationLinks,
+  searchableFields,
+  mergerFilesAndBody,
+  filterMissingFields,
+} = require("../helpers/helper.js");
+
+const ${fileName}Controller = {
+    list: async (req, res) => {
+      var currentPage = parseInt(req?.query?.page_no) || 1;
+      var perPage = parseInt(req?.query?.page_limit) || 10;
+      var searchInput = req?.query?.search || "";
+      
+      const rgx = (pattern) => new RegExp(`.*${pattern}.*`);
+      const searchRgx = rgx(searchInput);
+      
+      var SearchFieldArray = ${___SearchFieldArray___};
+
+      const count = await ${schemaName}.countDocuments({
+        $or: SearchFieldArray,
+      });
+
+      const totalPages = Math.ceil(count / perPage);
+
+      await ${schemaName}.find({
+        $or: SearchFieldArray,
+      })
+        .skip((currentPage - 1) * perPage)
+        .limit(perPage)
+        .sort({ createdAt: -1 })
+        .then((results) => {
+          const response = {
+            totalRecords: count,
+            totalPages: totalPages,
+            currentPage: currentPage,
+            perPage: perPage,
+            results: results,
+          };
+
+          generatePaginationLinks(
+            req,
+            response,
+            currentPage,
+            perPage,
+            totalPages,
+            searchInput
+          );
+          return successResponse(
+            res,
+            response,
+            "${fileName} list fetched successfully!"
+          );
+        })
+        .catch((err) => {
+          return errorResponse(res, err, "Opps something went wrong!", 500);
+        });
+    },
+    getDetail: async (req, res) => {
+      const response = checkValidationResult(res, req);
+      if (response["status_code"] === 422) {
+        return errorResponse(
+          res,
+          response["data"],
+          response["message"],
+          response["status_code"]
+        );
+      }
+      await ${schemaName}.findById(req.params.id)
+        .then((result) => {
+          if (result) {
+            return successResponse(res, result, "${fileName} detail fetched successfully!");
+          } else {
+            data = {
+              id: ["Record doesn't exist!"],
+            };
+            return validationResponse(res, data, "Record doesn't exist!");
+          }
+        })
+        .catch((err) =>
+          {
+            return errorResponse(res, err, "Opps something went wrong!", 500)
+          }
+        );
+    },
+    store: async (req, res) => {
+      const response = checkValidationResult(res, req);
+      if (response["status_code"] === 422) {
+        return errorResponse(
+          res,
+          response["data"],
+          response["message"],
+          response["status_code"]
+        );
+      }
+      /*File values into body*/
+      mergerFilesAndBody(req);
+      var storeData = ${___StoreFieldArray___};
+      var ${schemaName}Store = new ${schemaName}(storeData);
+      await ${schemaName}Store.save()
+        .then((result) => {
+          return successResponse(res, result, "${fileName} created successfully!");
+        })
+        .catch((err) => {
+          return errorResponse(res, err, "Opps something went wrong!", 500);
+        });
+    },
+    update: async (req, res) => {
+      const response = checkValidationResult(res, req);
+      if (response["status_code"] === 422) {
+        return errorResponse(
+          res,
+          response["data"],
+          response["message"],
+          response["status_code"]
+        );
+      }
+      /*File values into body*/
+      mergerFilesAndBody(req);
+
+      var updateData = ${___StoreFieldArray___};
+
+      updateData = filterMissingFields(updateData); // Removes fields with null values
+
+      await ${schemaName}.findByIdAndUpdate(req.params.id, updateData, { new: true })
+          .then((result) => {
+            if (result) {
+              successResponse(res, result, "${fileName} updated successfully!");
+            } else {
+              data = {
+                id: ["Record doesn't exist!"],
+              };
+              validationResponse(res, data, "Record doesn't exist!");
+            }
+          })
+          .catch((err) =>
+            errorResponse(res, err, "Opps something went wrong!", 500)
+          );
+    },
+    destroy: async (req, res) => {
+      const response = checkValidationResult(res, req);
+      if (response["status_code"] === 422) {
+        return errorResponse(
+          res,
+          response["data"],
+          response["message"],
+          response["status_code"]
+        );
+      }
+      await ${schemaName}.findByIdAndDelete(req.params.id)
+        .then((result) => {
+          if (result) {
+            return successResponse(res, result, "Deleted successfully!");
+          } else {
+            data = {
+              id: ["Record doesn't exist!"],
+            };
+            return validationResponse(res, data, "Record doesn't exist!");
+          }
+        })
+        .catch((err) =>
+          {
+            return errorResponse(res, err, "Opps something went wrong!", 500)
+          }
+        );
+    }
+  };
+
+  module.exports = ${fileName}Controller;

package/sample-env

@@ -0,0 +1,4 @@
+PORT=3000
+DB="mongodb+srv://USERNAME:PASSWORD@mongo.9bdgpey.mongodb.net/node_backpack"
+JWT_SIGNATURE=node_backpack
+HOST=http://localhost:3000

package/sample-file-uploader.js

@@ -0,0 +1,27 @@
+const multer = require("multer");
+const fs = require("fs");
+const path = require("path");
+
+// Create a Multer instance with destination for uploaded files
+const storage = (routeName) =>
+  multer.diskStorage({
+    destination: function (req, file, cb) {
+      const folder = `./public/${routeName}`;
+
+      // Check if the folder exists, create it if it doesn't
+      if (!fs.existsSync(folder)) {
+        fs.mkdirSync(folder, { recursive: true });
+      }
+
+      cb(null, folder);
+    },
+    filename: function (req, file, cb) {
+      let fileExt = path.extname(file.originalname);
+      cb(null, `${routeName}-${Date.now()}${fileExt}`);
+    },
+  });
+
+// Enable file upload middleware using Multer
+const upload = (routeName) => multer({ storage: storage(routeName) });
+
+module.exports = upload;

package/sample-form-parser.js

@@ -0,0 +1,5 @@
+const multer = require("multer");
+
+let formParser = multer().none();
+
+module.exports = formParser;

package/sample-helper.js

@@ -0,0 +1,138 @@
+function extractRouteName(req) {
+  const path = req.originalUrl.split("?")[0]; // Remove query parameters
+  const parts = path.split("/").filter(Boolean); // Remove empty parts
+  return parts[parts.length - 1];
+}
+
+function generatePaginationLinks(
+  req,
+  response,
+  currentPage,
+  perPage,
+  totalPages,
+  searchInput
+) {
+  const routeName = extractRouteName(req);
+
+  // add first page link
+  const firstLink = `${req.protocol}://${req.get("host")}${
+    req.baseUrl
+  }/${routeName}?page_no=1&page_limit=${perPage}&search=${searchInput}`;
+  response.firstLink = firstLink;
+
+  // add previous page link if exist
+  if (currentPage > 1) {
+    const previousPage = currentPage - 1;
+    const previousLink = `${req.protocol}://${req.get("host")}${
+      req.baseUrl
+    }/${routeName}?page_no=${previousPage}&page_limit=${perPage}&search=${searchInput}`;
+    response.previousLink = previousLink;
+  } else {
+    response.previousLink = null;
+  }
+
+  // add current page link if exist
+  if (currentPage >= 1 || currentPage <= totalPages) {
+    const currentLink = `${req.protocol}://${req.get("host")}${
+      req.baseUrl
+    }/${routeName}?page_no=${currentPage}&page_limit=${perPage}&search=${searchInput}`;
+    response.currentLink = currentLink;
+  } else {
+    response.currentLink = null;
+  }
+
+  // add next page link if exist
+  if (currentPage < totalPages) {
+    const nextPage = currentPage + 1;
+    const nextLink = `${req.protocol}://${req.get("host")}${
+      req.baseUrl
+    }/${routeName}?page_no=${nextPage}&page_limit=${perPage}&search=${searchInput}`;
+    response.nextLink = nextLink;
+  } else {
+    response.nextLink = null;
+  }
+
+  // add last page link
+  const lastPage = totalPages ? totalPages : 1;
+  const lastLink = `${req.protocol}://${req.get("host")}${
+    req.baseUrl
+  }/${routeName}?page_no=${lastPage}&page_limit=${perPage}&search=${searchInput}`;
+  response.lastLink = lastLink;
+
+  return response;
+}
+
+function modelsParams(Schema) {
+  // Obtain the schema parameters object
+  const paths = Schema?.schema?.paths;
+  let parameters = [];
+  let all = [];
+  let required = [];
+  let optional = [];
+  // Loop over the paths and log each field's name and type
+  for (const path in paths) {
+    let isRequired = paths[path]?.options?.required ? true : false;
+    parameters.push({
+      field: path,
+      is_required: isRequired,
+    });
+    if (isRequired) {
+      required.push(path);
+    } else {
+      optional.push(path);
+    }
+    all.push(path);
+  }
+  const unwantedProps = ["_id", "createdAt", "updatedAt", "__v"];
+  const filteredFormData = all.filter((prop) => !unwantedProps.includes(prop));
+  return {
+    parameters: parameters,
+    allFields: all,
+    requiredFields: required,
+    optionalFields: optional,
+    filteredFormFields: filteredFormData,
+  };
+}
+
+function searchableFields(Model) {
+  var formFields = modelsParams(Model);
+  var uploadFieldArray = [];
+  var searchFields = [];
+  if (
+    formFields &&
+    formFields?.filteredFormFields &&
+    formFields?.filteredFormFields.length
+  ) {
+    searchFields = formFields?.filteredFormFields;
+    return searchFields;
+  }
+}
+function mergerFilesAndBody(req) {
+  if (req.files && Object.keys(req.files).length > 0) {
+    Object.keys(req.files).forEach(function (key) {
+      if (req.files[key] && req.files[key] !== undefined) {
+        var file = req.files[key];
+        if (file && file?.path && file?.fieldname)
+          req.body[file?.fieldname] = file?.path.replace(/\public\\/g, "");
+      }
+    });
+    req.files = [];
+    return req;
+  }
+}
+function filterMissingFields(data) {
+  for (var key in data) {
+    if (data[key] === null) {
+      delete data[key];
+    }
+  }
+  return data;
+}
+
+module.exports = {
+  generatePaginationLinks,
+  modelsParams,
+  searchableFields,
+  mergerFilesAndBody,
+  filterMissingFields,
+};

package/sample-index-route.js

@@ -0,0 +1,7 @@
+const express = require("express");
+const router = express.Router();
+// individual-route-module-imported
+
+// defining-api-routes
+
+module.exports = router;

package/sample-package.json

@@ -0,0 +1,29 @@
+{
+  "name": "my-node-project",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "dev": "nodemon app.js"
+  },
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "bcryptjs": "^2.4.3",
+    "body-parser": "^1.20.2",
+    "dotenv": "^16.3.1",
+    "express": "^4.18.2",
+    "express-validator": "^7.0.1",
+    "jsonwebtoken": "^9.0.1",
+    "mongoose": "^7.3.1",
+    "mongoose-backpack": "^0.2.7",
+    "multer": "^1.4.5-lts.1",
+    "node-backpack": "^0.0.427",
+    "nodemailer": "^6.9.3",
+    "rest-api-response-npm": "^0.1.4"
+  },
+  "devDependencies": {
+    "nodemon": "^3.0.1"
+  }
+}

package/sample-route.js

@@ -0,0 +1,20 @@
+const express = require('express');
+const router = express.Router();
+const ${fileName}Controller = require('../controllers/${fileName}Controller');
+const ListValidationRequest = require('./validationRequest/${fileName}/ListValidationRequest');
+const GetDetailValidationRequest = require('./validationRequest/${fileName}/GetDetailValidationRequest');
+const StoreValidationRequest = require('./validationRequest/${fileName}/StoreValidationRequest');
+const UpdateValidationRequest = require('./validationRequest/${fileName}/UpdateValidationRequest');
+const DestroyValidationRequest = require('./validationRequest/${fileName}/DestroyValidationRequest');
+const upload = require('../helpers/fileUploader');
+const formParser = require('../helpers/formParser');
+
+const prefix = '${apiUrl}';
+
+router.get(`/${prefix}/`,formParser,ListValidationRequest, ${fileName}Controller.list);
+router.get(`/${prefix}/:id`,formParser,GetDetailValidationRequest, ${fileName}Controller.getDetail);
+router.post(`/${prefix}/`,upload(prefix).any(),StoreValidationRequest, ${fileName}Controller.store);
+router.put(`/${prefix}/:id`,upload(prefix).any(),UpdateValidationRequest, ${fileName}Controller.update);
+router.delete(`/${prefix}/:id`,formParser,DestroyValidationRequest, ${fileName}Controller.destroy);
+
+module.exports = router;

package/sample-schema-ResetToken.js

@@ -0,0 +1,26 @@
+const mongoose = require("mongoose");
+const Schema = mongoose.Schema;
+const { appendParams } = require("mongoose-backpack");
+
+const ResetToken = new Schema(
+  {
+    email: {
+      type: String,
+      required: true,
+    },
+    reset_token: {
+      type: String,
+      required: false,
+    },
+  },
+  { timestamps: true }
+);
+
+appendData = {
+  id: function () {
+    return this._id;
+  },
+};
+appendParams(ResetToken, appendData);
+
+module.exports = mongoose.model("ResetToken", ResetToken);

package/sample-schema-User.js

@@ -0,0 +1,51 @@
+const mongoose = require("mongoose");
+const Schema = mongoose.Schema;
+const { appendParams } = require("mongoose-backpack");
+
+const User = new Schema(
+  {
+    first_name: {
+      type: String,
+      required: true,
+    },
+    last_name: {
+      type: String,
+      required: true,
+    },
+    email: {
+      type: String,
+      required: true,
+    },
+    phone_no: {
+      type: String,
+      required: false,
+    },
+    password: {
+      type: String,
+      required: true,
+    },
+    image: {
+      type: String,
+      required: false,
+    },
+    token: {
+      type: String,
+      required: false,
+    },
+  },
+  { timestamps: true }
+);
+
+appendData = {
+  id: function () {
+    return this._id;
+  },
+  full_name: function () {
+    const firstName = this?.first_name ? this.first_name + " " : "";
+    const lastName = this?.last_name ? this.last_name : "";
+    return `${firstName}${lastName}`;
+  },
+};
+appendParams(User, appendData);
+
+module.exports = mongoose.model("User", User);

package/sample-schema.js

@@ -0,0 +1,49 @@
+const mongoose = require("mongoose");
+const Schema = mongoose.Schema;
+const { appendParams } = require("mongoose-backpack");
+
+const ${fileContent} = new Schema(
+  {
+    name: {
+      type: String,
+      required: true,
+    },
+  },
+  { timestamps: true }
+);
+
+const appendData = {
+  id: function () {
+    return this._id;
+  },
+};
+appendParams(${fileContent}, appendData);
+
+const ${fileContent}Model = mongoose.model("${fileContent}", ${fileContent});
+
+// Created a change stream. The 'change' event gets emitted when there's a change in the database
+/*
+${fileContent}Model.watch().on("change", (data) => {
+  const timestamp = new Date();
+  const operationType = data.operationType;
+
+  switch (operationType) {
+    case "insert":
+      // TODO Logic Code...
+      console.log(timestamp, "Document created:", data.fullDocument);
+      break;
+    case "update":
+      // TODO Logic Code...
+      console.log(timestamp, "Document updated:", data.updateDescription);
+      break;
+    case "delete":
+      // TODO Logic Code...
+      console.log(timestamp, "Document deleted:", data.documentKey);
+      break;
+    default:
+      console.log(timestamp, "Unknown operation type:", operationType);
+  }
+});
+*/
+
+module.exports = ${fileContent}Model;

package/sample-validation.js

@@ -0,0 +1,4 @@
+const { body, param, check } = require("express-validator");
+const ${schemaName} = require("../../../models/${schemaName}");
+
+module.exports = defaultExport = [__validation__dynamic__code__];

package/README.md

@@ -1,5 +0,0 @@
-# Security holding package
-
-This package contained malicious code and was removed from the registry by the npm security team. A placeholder was published to ensure users are not affected in the future.
-
-Please refer to www.npmjs.com/advisories?search=nodejs-backpack for more information.