jcc-express-mvc 1.1.8 → 1.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jcc-express-mvc",
-  "version": "1.1.8",
+  "version": "1.2.0",
   "description": "express mvc structure",
   "main": "index.js",
   "scripts": {

package/src/Router/Router.js

@@ -39,7 +39,8 @@ class Router {
    * @returns {Router} - Returns the router instance.
    */
   get(path, callback) {
-    this.util.routeHelper("get", path, callback);
+    this.util.routeHttpMethod("get", path, callback);
+    this.middlewares = null;
     return this;
   }
 
@@ -50,7 +51,8 @@ class Router {
    * @returns {Router} - Returns the router instance.
    */
   post(path, callback) {
-    this.util.routeHelper("post", path, callback);
+    this.util.routeHttpMethod("post", path, callback);
+    this.middlewares = null;
     return this;
   }
 
@@ -61,7 +63,8 @@ class Router {
    * @returns {Router} - Returns the router instance.
    */
   patch(path, callback) {
-    this.util.routeHelper("patch", path, callback);
+    this.util.routeHttpMethod("patch", path, callback);
+    this.middlewares = null;
     return this;
   }
 
@@ -72,7 +75,8 @@ class Router {
    * @returns {Router} - Returns the router instance.
    */
   put(path, callback) {
-    this.util.routeHelper("put", path, callback);
+    this.util.routeHttpMethod("put", path, callback);
+    this.middlewares = null;
     return this;
   }
 
@@ -83,14 +87,27 @@ class Router {
    * @returns {Router} - Returns the router instance.
    */
   delete(path, callback) {
-    this.util.routeHelper("delete", path, callback);
+    this.util.routeHttpMethod("delete", path, callback);
+    this.middlewares = null;
     return this;
   }
 
   /**
-   * Placeholder method for handling all HTTP methods.
+   * Adds a route handler for ALL requests.
+   * @param {Function} callback - Callback function to handle the request.
+   * @returns {Router} - Returns the router instance.
    */
-  all() {}
+  all(path, callback) {
+    this.util.routeHttpMethod("any", path, callback);
+    this.middlewares = null;
+    return this;
+  }
+
+  options(path, callback) {
+    this.util.routeHttpMethod("options", path, callback);
+    this.middlewares = null;
+    return this;
+  }
 }
 
 module.exports = Router;

package/src/command-line-interface/REPL.js

@@ -0,0 +1,28 @@
+const { REPL } = require("repl-cli");
+const getInput = require("./getInput");
+const repl = new REPL();
+
+const replPrompt = () => {
+  repl.use({
+    async evaluate(input) {
+      switch (input) {
+        case "exit()":
+          return process.exit(-1);
+
+        case "exit":
+          return process.exit(-1);
+        case "quit()":
+          return process.exit(-1);
+        case "quit":
+          return process.exit(-1);
+        default:
+          const result = await getInput(input);
+          console.log(result);
+          break;
+      }
+    },
+  });
+  repl.start();
+};
+
+module.exports = replPrompt;

package/src/command-line-interface/db.js

@@ -0,0 +1,20 @@
+const mongoose = require("mongoose");
+const dotenv = require("dotenv");
+dotenv.config(); // Load environment variables from .env file
+
+class Database {
+  async connect() {
+    try {
+      return await mongoose.connect(process.env.DB_HOST); // Connect to the MongoDB database
+    } catch (error) {
+      console.log("Database not connected"); // Log failure message if connection fails
+    }
+  }
+
+  // Method to close database connection
+  closeConnection() {
+    return mongoose.connection.close(); // Close the MongoDB database connection
+  }
+}
+
+module.exports = Database;

package/src/command-line-interface/getInput.js

@@ -0,0 +1,7 @@
+const TinkerNode = require("./");
+
+const getInput = async (input) => {
+  const cli = new TinkerNode();
+  return cli.extractCommand(input);
+};
+module.exports = getInput; // Export the getDbCommandLineArgv function

package/src/command-line-interface/index.js

@@ -0,0 +1,50 @@
+const { getModel } = require("../helpers");
+const Database = require("./db");
+
+class TinkerNode extends Database {
+  #allowedMethodsRegex = /[^\s{}()\[\]\(\)0-9a-zA-Z',_.:@]/g;
+
+  sanitizedInput(input) {
+    return input.replace(this.#allowedMethodsRegex, "");
+  }
+
+  validatedInput(input) {
+    const sanitizedInputData = this.sanitizedInput(input);
+    console.log(sanitizedInputData);
+    if (sanitizedInputData !== input) {
+      // Input contains disallowed characters, reject it
+      throw new Error("Input contains disallowed characters.");
+    }
+
+    const data = input.split(".");
+    if (data.length <= 1) {
+      throw new Error("Invalid Mongoose query:", input);
+    }
+    const model = data[0];
+
+    data.splice(0, 1);
+
+    return { model, methods: data.join(".") };
+  }
+
+  async extractCommand(input) {
+    try {
+      const { model, methods } = this.validatedInput(input);
+      const queryFunction = new Function(
+        "model",
+        "getModel",
+        `
+      const modelName = getModel(model)
+        return modelName.${methods}
+        `
+      );
+
+      this.connect();
+      return queryFunction(model, getModel);
+    } catch (error) {
+      return console.error("Error " + error?.message);
+    }
+  }
+}
+
+module.exports = TinkerNode;

package/src/index.js

@@ -1,6 +1,7 @@
 const App = require("./app");
 const { authenticated, protectedApi } = require("./Auth/protectedRoute");
 const Auth = require("./Auth");
+const replPrompt = require("./command-line-interface/REPL");
 
 const {
   bcrypt,
@@ -16,7 +17,6 @@ const {
   rootPath,
 } = require("./helpers");
 const FormRequest = require("./request/FormRequest");
-const getDbCli = require("./command-line-interface/getDbCliCommand");
 
 const app = new App();
 
@@ -39,6 +39,6 @@ module.exports = {
   authenticated,
   apiAuthenticated: protectedApi,
   Auth,
-  getDbCli,
   FormRequest,
+  replPrompt,
 };

package/src/utils/index.js

@@ -16,6 +16,18 @@ class Util {
     this.middlewares = middlewares;
   }
 
+  /**
+   * Replaces route parameters enclosed in curly braces with corresponding placeholders.
+   * For example, converts "{name}" to ":name".
+   *
+   * @param {string} path - The path containing route parameters.
+   * @returns {string} - The path with route parameters replaced by placeholders.
+   */
+  replaceRouteParameters(path) {
+    const regex = /\{([^}]+)\}/g;
+    return path.replace(regex, ":$1");
+  }
+
   /**
    * Sets the middlewares for the route group.
    * @param {function|array} middlewares - Route middlewares.
@@ -31,8 +43,8 @@ class Util {
    */
   resolvePath(path) {
     return this.prefix
-      ? `${this.basePath}${this.prefix}${path}`
-      : `${this.basePath}${path}`;
+      ? `${this.basePath}${this.prefix}${this.replaceRouteParameters(path)}`
+      : `${this.basePath}${this.replaceRouteParameters(path)}`;
   }
 
   /**
@@ -85,7 +97,7 @@ class Util {
    * @param {string} path - The route path.
    * @param {string} callback - The callback function or method name.
    */
-  async routeHelper(httpMethod, path, callback) {
+  async routeHttpMethod(httpMethod, path, callback) {
     try {
       if (this.classController(callback)) {
         if (this.isMiddleware()) {
@@ -107,7 +119,6 @@ class Util {
           this.middlewares,
           asyncHandler(callback),
         ]);
-        return (this.middlewares = null);
       }
       return this.app[httpMethod](
         this.resolvePath(path),

package/src/command-line-interface/dbCli.js

@@ -1,77 +0,0 @@
-const mongoose = require("mongoose"); // Import Mongoose for MongoDB interactions
-const dotenv = require("dotenv"); // Import dotenv for environment variables
-const { getModel, bcrypt } = require("../helpers"); // Import helper functions for database operations and password hashing
-
-class DbCli {
-  constructor(model) {
-    dotenv.config(); // Load environment variables from .env file
-    this.model = getModel(model); // Get the specified model for database operations
-    this.connection(); // Establish database connection
-  }
-
-  // Method to establish database connection
-  async connection() {
-    try {
-      const connect = await mongoose.connect(process.env.DB_HOST); // Connect to the MongoDB database
-      return connect
-        ? console.log("Database connected Successfully") // Log success message if connected
-        : console.log("Database not connected"); // Log failure message if connection fails
-    } catch (error) {
-      console.log("Database not connected"); // Log failure message if connection fails
-    }
-  }
-
-  // Method to close database connection
-  closeConnection() {
-    return mongoose.connection.close(); // Close the MongoDB database connection
-  }
-
-  // Method to retrieve all documents from the model
-  async all() {
-    const data = await this.model.find({}); // Find all documents in the model
-    console.log(data); // Log retrieved data
-    return this.closeConnection(); // Close database connection
-  }
-
-  // Method to create a new document in the model
-  async create(data) {
-    const obj = {}; // Initialize an empty object to store document fields
-    const items = data.split(","); // Split the input data into key-value pairs
-
-    // Iterate through each key-value pair
-    for (let i = 0; i < items.length; i++) {
-      const objName = items[i].split(":")[0]; // Extract the field name
-      const objValue = items[i].split(":")[1]; // Extract the field value
-
-      // If the field is a password, hash the value using bcrypt
-      if (objName === "password") {
-        obj[objName] = await bcrypt(objValue); // Hash the password value
-        continue; // Skip to the next iteration
-      }
-      obj[objName] = objValue; // Add the field and value to the object
-    }
-
-    const result = await this.model.create(obj); // Create a new document in the model with the constructed object
-    console.log(result); // Log the result of the creation operation
-    return this.closeConnection(); // Close database connection
-  }
-
-  // Method to find a document by its ID
-  async findById(id) {
-    const result = await this.model.findById(id); // Find a document by its ID
-    console.log(result); // Log the retrieved document
-    return this.closeConnection(); // Close database connection
-  }
-
-  // Method to delete a document by its ID
-  async delete(id) {
-    const result = await this.model.findByIdAndRemove(id); // Find and remove a document by its ID
-    console.log(result); // Log the result of the deletion operation
-    return this.closeConnection(); // Close database connection
-  }
-
-  // Method for updating documents (not implemented)
-  // update() {}
-}
-
-module.exports = DbCli; // Export the DbCli class

package/src/command-line-interface/getDbCliCommand.js

@@ -1,21 +0,0 @@
-const DbCli = require("./dbCli"); // Import DbCli class for interacting with the database
-
-// Function to extract the command from command line arguments
-const getCommand = (command, index = 0) => {
-  let cmd = command.slice(2); // Extract command arguments, excluding the first two (node and script name)
-  return `${cmd[0].split(".")[index]}`; // Extract the command from the first argument, splitting by "." and taking the specified index
-};
-
-// Function to extract the argument from command line arguments
-const getArg = (command) => command.slice(3)[0]; // Extract the argument from command arguments, starting from the fourth element
-
-// Function to handle command line arguments related to database operations
-const getDbCommandLineArgv = (commandArg) => {
-  let model = getCommand(commandArg); // Extract the model name from command line arguments
-  let method = getCommand(commandArg, 1); // Extract the method name (action) from command line arguments
-  let arg = getArg(commandArg); // Extract the argument (if any) from command line arguments
-  const db = new DbCli(model); // Instantiate DbCli class with the extracted model name
-  return arg ? db[method](arg) : db[method](); // Execute the specified method with the argument (if provided), otherwise without argument
-};
-
-module.exports = getDbCommandLineArgv; // Export the getDbCommandLineArgv function