beech-api 3.8.0 → 3.9.0-beta.9-rc

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "beech-api",
-  "version": "3.8.0",
+  "version": "3.9.0-beta.9-rc",
   "description": "Command line interface for rapid Beech API development",
   "keywords": [
     "api",
@@ -18,9 +18,9 @@
   },
   "authors": "bombkiml",
   "bin": {
-    "beech-app": "./packages/cli/bin/beech-app.js",
-    "beech-service": "./packages/cli/bin/beech-service.js",
-    "beech": "./packages/cli/core/generator/index.js"
+    "beech-app": "packages/cli/bin/beech-app.js",
+    "beech-service": "packages/cli/bin/beech-service.js",
+    "beech": "packages/cli/core/generator/index.js"
   },
   "bugs": {
     "url": "https://github.com/bombkiml/beech-api/issues"
@@ -28,20 +28,21 @@
   "homepage": "https://github.com/bombkiml/beech-api/blob/master/README.md",
   "deprecated": false,
   "engines": {
-    "node": ">=14.19"
+    "node": ">=16.20"
   },
   "dependencies": {
     "app-root-path": "^3.0.0",
-    "axios": "^0.26.1",
+    "axios": "^1.8.4",
     "child-process-promise": "^2.2.1",
     "cli-clear": "^1.0.4",
     "compression": "^1.7.5",
-    "cookie-parser": "1.4.3",
+    "cookie-parser": "^1.4.7",
     "cors": "^2.8.1",
+    "cron": "^4.4.0",
     "crypto-js": "^4.2.0",
     "cryptr": "^6.3.0",
-    "express": "4.19.2",
-    "express-duplicate-request": "^1.0.3",
+    "express": "^4.20.0",
+    "express-duplicate-request": "^1.0.5",
     "express-rate-limit": "^7.4.0",
     "express-session": "^1.17.1",
     "express-slow-down": "^2.0.3",
@@ -49,14 +50,14 @@
     "fs": "0.0.1-security",
     "helmet": "^8.1.0",
     "inquirer": "8.2.4",
-    "jsonwebtoken": "^8.5.1",
+    "jsonwebtoken": "^9.0.2",
     "log-update": "^4.0.0",
     "md5": "^2.3.0",
     "method-override": "^3.0.0",
     "mkdirp": "^2.1.6",
     "module-alias": "^2.2.2",
     "mysql": "^2.18.1",
-    "mysql2": "^2.3.3",
+    "mysql2": "^3.14.0",
     "node-cmd": "^3.0.0",
     "node-emoji": "^1.11.0",
     "node-notifier": "^10.0.1",
@@ -72,7 +73,7 @@
     "walk": "^2.3.14"
   },
   "devDependencies": {
-    "jest": "^28.1.3",
+    "jest": "^30.2.0",
     "nodemon": "^3.1.0",
     "sequelize-cli": "^5.5.1"
   },

package/packages/cli/bin/beech-app.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 const logUpdate = require("log-update");
 const clear = require("cli-clear");
 const inquirer = require('inquirer');
@@ -52,8 +52,8 @@ class Beech {
               inquirer.prompt([ {
                 type: "list",
                 name: "sql",
-                message: "Please pick a SQL structure base:",
-                choices: [ "Basic (mysql only)", "Sequelize (mysql, sqlite, mariadb, postgres, mssql)" ],
+                message: "Please pick a pool base engine:",
+                choices: [ "Basic (mysql only)", "Sequelize ORM tool (mysql, sqlite, mariadb, postgres, mssql)" ],
               } ]).then(async resSql => {
                 if (resSql.sql.split(' ')[ 0 ] != "Basic") {
                   tmpGloablConfigFile = await __dirname + '/../core/configure/global.config-sequelize.js';
@@ -231,7 +231,7 @@ class Beech {
   successfully() {
     clear();
     console.log("Beech CLI v" + require(__dirname + "/../../../package.json").version);
-    console.log('\n Passed  The project has been successfully created.\n\n  $ cd ' + this.argument + '\n  $ npm start or yarn start');
+    console.log('\n Passed  The project has been successfully created.\n\n  $ cd ' + this.argument + '\n  $ npm run dev or yarn dev');
   }
 
   async contentReplace(pathFile, textCondition) {

package/packages/cli/bin/beech-service.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 const logUpdate = require("log-update");
 const notifier = require("node-notifier");
 const path = require("path");
@@ -20,6 +20,14 @@ class Beech {
     return new Promise(async (resolve, reject) => {
       try {
         if (this.option == "serve") {
+          // Show comiling msg
+          const frames = ['\n[-] Compiling', '\n[\\] Compiling.', '\n[|] Compiling..', '\n[/] Compiling...'];
+          let i = 0;
+          var refreshCompileIntervalId = setInterval(() => {
+            const frame = frames[i = ++i % frames.length];
+            logUpdate(`${frame}`);
+          }, 300);
+          // option logic for silent notify
           let turnNoti = true;
           if (this.argument == "--silent" || this.argument == "-S") {
             turnNoti = false;
@@ -30,15 +38,32 @@ class Beech {
             testServ.listen(this._config_.main_config.app_port, async () => {
               await testServ.close();
               // Start real service.
-              await this.serviceDevStart(this.argument);
-              // check turn on nofi
-              if (turnNoti) {
-                this.notiCompile();
-              }
+              this.serviceDevStart(this.argument, (err, run) => {
+                if(!err && run) {
+                  // Check turn on noti
+                  if (turnNoti) {
+                    this.notiCompile();
+                  }
+                  // Delay for new replace Compiling msg to Running
+                  setTimeout(() => {
+                    clearInterval(refreshCompileIntervalId);
+                    logUpdate("\n[OK] Running...");
+                  }, 1500);
+                } else {
+                  setTimeout(() => {
+                    clearInterval(refreshCompileIntervalId);
+                    logUpdate("\n[ERR] Failed... ", err);
+                    reject();
+                  }, 1000);
+                }
+              });
             }).on('error', (err) => {
+              clearInterval(refreshCompileIntervalId);
               console.log("\n Faltal ", err);
+              reject();
             })
           } else {
+            clearInterval(refreshCompileIntervalId);
             resolve("\n Faltal  The app.conifg.js file is not found.");
           }
         } else if (!this.option || this.option == "-h" || this.option == "?" || this.option == "--help") {
@@ -60,28 +85,40 @@ class Beech {
     });
   }
 
-  serviceDevStart(argument) {
-    logUpdate("Compiling...");
+  serviceDevStart(argument, cb) {
     let promise = null;
-    // check Dev. run service
-    const spawnData = new Promise((resolve) => {
-      if(argument == "-D" || argument == "--dev") {
-        promise = this.spawn('npx', ['nodemon', '-q', './cli/beech']); // For Dev.
-      } else {
-        promise = this.spawn('npx', ['nodemon', '-q', './node_modules/beech-api/packages/cli/beech']); // For Prd.
-      }
-      resolve(promise.childProcess);
-    });
-    Promise.all([spawnData]).then((childProcess) => {
-      childProcess[0].stdout.on('data', (data) => {
-        console.log(data.toString().slice(0, -1));
-      });
-      childProcess[0].stderr.on('data', (data) => {
-        if(data.toString().slice(0, 8) != "Ignoring" && data.toString().match(/\[SEQUELIZE0006\]/g) != "[SEQUELIZE0006]") {
-          console.log(data.toString());
+    try {
+      const spawnData = new Promise((resolve) => {
+        // check Dev. run service
+        if(argument == "-D" || argument == "--dev") {
+          console.log("\n  Starting Beech service in Development mode  ");
+          promise = this.spawn('npx', ['nodemon', '-q', './cli/beech']); // For Dev.
+        } else {
+          promise = this.spawn('npx', ['nodemon', '-q', './node_modules/beech-api/packages/cli/beech']); // For Prd.
         }
+        resolve(promise.childProcess);
       });
-    });
+      Promise.all([spawnData]).then((childProcess) => {
+        childProcess[0].stdout.on('data', (data) => {
+          console.log(data.toString().slice(0, -1));
+        });
+        // Check process error
+        childProcess[0].stderr.on('data', (data) => {
+          // Check Error from std Allow for Mysql version error
+          if(data.toString().slice(0, 8) != "Ignoring" && data.toString().match(/\[SEQUELIZE0006\]/g) != "[SEQUELIZE0006]") {
+            if(data.toString().slice(0, 13) == "node:internal") {
+              cb(data.toString(), false);
+            } else {
+              console.log(data.toString());
+            }
+          }
+        });
+        // Callback first
+        cb(null, true);
+      });
+    } catch (error) {
+      cb(error, false);
+    }
   }
 
   notiCompile() {

package/packages/cli/core/auth/Credentials.js

@@ -11,7 +11,9 @@ const byPassCredentials = (options, _res = {}, _next = () => {}) => {
   if(!options.length) {
     if(passport_config.jwt_broken_role ? passport_config.jwt_broken_role.length > 0 : false) {
       // CASE: jwt_broken_role DEFUALT is set
-      return [credentials, checkRoleMiddleware(passport_config.jwt_broken_role)(options, _res, _next)];
+      return credentials(options, _res, () => {
+        return checkRoleMiddleware(passport_config.jwt_broken_role)(options, _res, _next);
+      });
     } else {
       if(!Object.keys(options).length) {
         return [credentials];
@@ -34,78 +36,117 @@ const byPassCredentials = (options, _res = {}, _next = () => {}) => {
 const credentials = (req, res, next) => {
   if (passport_config.jwt_allow === true) {
     const auth_endpoint = (passport_config.auth_endpoint) ? (passport_config.auth_endpoint[ 0 ] === "/" ? passport_config.auth_endpoint : "/" + passport_config.auth_endpoint) : "/authentication";
-    if(auth_endpoint.split("/")[1] == req.params.hash) {
-      return next();
-    }
-  }
-
-  return passport.authenticate("jwt", {
-    session: false,
-  }, (err, user, info) => {
-    // error check
-    if (err) {
-      console.log(err, info);
-      return res.status(401).json({
-        code: 401,
-        error: "UNAUTHORIZED",
-        message: {
-          name: "WrongTokenError",
-          message: "token error.",
-        },
-        /* dev: { err, info }, */ // for dev info
-      });
-    }
-    // anything token check
-    if (!user) {
-      if (info) {
-        if (info.name == "TokenExpiredError") {
-          return res.status(401).json({
-            code: 401,
-            status: "TOKEN_EXPIRED",
-            message: info,
-          });
-        }
-        if (info.name == "Error") {
-          return res.status(401).json({
-            code: 401,
-            status: "NO_AUTH_TOKEN",
-            message: {
-              name: "NoTokenError",
-              message: "No auth token",
-            },
-          });
-        }
-        if (info.name == "SyntaxError") {
-          return res.status(401).json({
-            code: 401,
-            status: "PAYLOAD_SYNTAX_ERROR",
-            message: {
-              name: "SyntaxError",
-              message: "Unexpected token < in JSON at position 0",
-            },
-          });
-        }
-      }
-      return res.status(401).json({
-        code: 401,
-        status: "UNAUTHORIZED_USER",
-        message: info || {
-          name: "TokenError",
-          message: "Unauthorized token."
-        },
-      });
+    const slashOneIsHash = auth_endpoint.split("/")[1];
+    if(req.params === undefined) {
+      // Request is not valid
+      console.log("\n REQUEST|OPTION  Error: Request is not valid, missing params.");
+      return;
     } else {
-      // Perfectly user jwt
-      return next();
+      // Check first HASH equal Authentication
+      if(slashOneIsHash == req.params.hash) {
+        // Bypass authentication for auth endpoint
+        return next();
+      } else {
+        return passport.authenticate("jwt", {
+          session: false,
+        }, (err, user, info) => {
+            // error check
+            if (err) {
+              console.log(err, info);
+              return res.status(401).json({
+                code: 401,
+                error: "UNAUTHORIZED",
+                message: {
+                  name: "WrongTokenError",
+                  message: "token error.",
+                },
+                /* dev: { err, info }, */ // for dev info
+              });
+            } else {
+              // anything token check
+              if (!user) {
+                if (info) {
+                  if (info.name == "TokenExpiredError") {
+                    return res.status(401).json({
+                      code: 401,
+                      status: "TOKEN_EXPIRED",
+                      message: info,
+                    });
+                  } else if (info.name == "Error") {
+                    return res.status(401).json({
+                      code: 401,
+                      status: "NO_AUTH_TOKEN",
+                      message: {
+                        name: "NoTokenError",
+                        message: "No auth token",
+                      },
+                    });
+                  } else if (info.name == "SyntaxError") {
+                    return res.status(401).json({
+                      code: 401,
+                      status: "PAYLOAD_SYNTAX_ERROR",
+                      message: {
+                        name: "SyntaxError",
+                        message: "Unexpected token < in JSON at position 0",
+                      },
+                    });
+                  } else if (info.name == "JsonWebTokenError") {
+                    return res.status(401).json({
+                      code: 401,
+                      status: "INVALID_TOKEN",
+                      message: {
+                        name: "JsonWebTokenError",
+                        message: "invalid token.",
+                      },
+                    });
+                  } else {
+                    return res.status(401).json({
+                      code: 401,
+                      status: "OTHER_TOKEN_ERR",
+                      message: {
+                        name: "OtherTokenError",
+                        message: String(info),
+                      },
+                    });
+                  }
+                } else {
+                  return res.status(401).json({
+                    code: 401,
+                    status: "UNAUTHORIZED_USER",
+                    message: info || {
+                      name: "TokenError",
+                      message: String(info),
+                    },
+                  });
+                }
+              } else {
+                // Perfectly user jwt
+                return next();
+              }
+            }
+          }
+        )(req, res, next);
+      }
     }
-  })(req, res, next);
+  } else {
+    // Bypass authentication
+    return next();
+  }
 }
 
 const credentialsGuard = (req, res, next) => {
-  checkAppKey(req, res, (checked) => {
-    if (checked) {
+  checkAppKey(req, res, (err) => {
+    if (!err) {
       // Perfectly
       next();
+    } else {
+      // Bad Request
+      return res.status(400).json({
+        code: 400,
+        status: 'BAD_REQUEST',
+        message: "Bad request.",
+        info: err,
+      });
     }
   });
 }
@@ -114,33 +155,19 @@ function checkAppKey(req, res, cb) {
   if (_passport_config_.app_key_allow) {
     if (req.headers.app_key) {
       if (_config_.main_config.app_key == req.headers.app_key) {
-        return cb(true);
+        // Perfectly
+        cb(null, true);
       } else {
-        res.status(400).json({
-          code: 400,
-          status: 'BAD_REQUEST',
-          message: "Bad request.",
-          info: {
-            status: "BAD_VALUE",
-            message: "Bad with wrong key."
-          },
-        });
-        return cb(false);
+        // Wrong App key
+        cb({ status: "BAD_VALUE", message: "Bad with wrong key." }, false);
       }
     } else {
-      res.status(400).json({
-        code: 400,
-        status: 'BAD_REQUEST',
-        message: "Bad request.",
-        info: {
-          status: "BAD_ENTITY",
-          message: "Bad with app entity key.",
-        },
-      });
-      return cb(false);
+      // No App key
+      cb({ status: "BAD_ENTITY", message: "Bad with app entity key." }, false);
     }
   } else {
-    return cb(true);
+    // App key not allow, bypass
+    cb(null, true);
   }
 }
 

package/packages/cli/core/auth/Passport.js

@@ -24,9 +24,38 @@ module.exports = {
             if (passport_config.jwt_allow === true) {
               // Check if the APP_KEY is allow
               if(passport_config.app_key_allow) {
-                global.Credentials = (_options = {}, _res, _next) => [credentialsGuard, byPassCredentials(_options, _res, _next)];
+                // All allow JWT & APP_KEY
+                //global.Credentials = [credentialsGuard, byPassCredentials]; // perfect
+                global.Credentials = (..._options) => {
+                  const [option_or_req, res, next] = _options;
+                  if (_options.length === 3) {
+                    // Used as: app.use(Credentials)
+                    return credentialsGuard(option_or_req, res, () => {
+                      return byPassCredentials(option_or_req, res, next);
+                    });
+                  } else if (_options.length === 0) {
+                    // Used as: app.use(Credentials())
+                    return [credentialsGuard, byPassCredentials];
+                  } else {
+                    // Used as: app.use(Credentials([...] ))
+                    return [credentialsGuard, byPassCredentials(option_or_req)];
+                  }
+                };
               } else {
-                global.Credentials = (_options = {}, _res, _next) => [byPassCredentials(_options, _res, _next)];
+                // Only allow JWT
+                global.Credentials = (..._options) => {
+                  const [option_or_req, res, next] = _options;
+                  if (_options.length === 3) {
+                    // Used as: app.use(Credentials)
+                    return byPassCredentials(option_or_req, res, next);
+                  } else if (_options.length === 0) {
+                    // Used as: app.use(Credentials())
+                    return byPassCredentials;
+                  } else {
+                    // Used as: app.use(Credentials([...]))
+                    return byPassCredentials(option_or_req);
+                  }
+                };
               }
               // loop check db connect is true
               fs.readFile("./app.config.js", "utf-8", (err, data) => {
@@ -52,16 +81,61 @@ module.exports = {
                 }
               });
             } else if (passport_config.app_key_allow === true) {
-              global.Credentials = (_options = {}, _res, _next) => [credentialsGuard];
+              // Only allow APP_KEY
+              global.Credentials = (..._options) => {
+                const [option_or_req, res, next] = _options;
+                if (_options.length === 3) {
+                  // Used as: app.use(Credentials)
+                  return credentialsGuard(option_or_req, res, () => {
+                    return next();
+                  });
+                } else if (_options.length === 0) {
+                  // Used as: app.use(Credentials())
+                  return [credentialsGuard];
+
+                } else {
+                  // Used as: app.use(Credentials([...] ))
+                  return [credentialsGuard];
+                }
+              };
+              // Resolve it
               resolve([true, false, null]);
             } else {
-              global.Credentials = (_options = {}, _res, _next) => [];
+              // Neither APP_KEY nor JWT allow
+              global.Credentials = (..._options) => {
+                const [option_or_req, res, next] = _options;
+                if (_options.length === 3) {
+                  // Used as: app.use(Credentials)
+                  return next();
+                } else if (_options.length === 0) {
+                  // Used as: app.use(Credentials())
+                  return [];
+                } else {
+                  // Used as: app.use(Credentials([...] ))
+                  return [];
+                }
+              };
+              // Resolve it
               resolve([true, false, null]);
             }
           } else {
-            global.Credentials = (_options = {}, _res, _next) => [];
+            // Passport config file not found
+            global.Credentials = (..._options) => {
+              const [option_or_req, res, next] = _options;
+              if (_options.length === 3) {
+                // Used as: app.use(Credentials)
+                return next();
+              } else {
+                // Used as: app.use(Credentials() or Credentials([...] ))
+                return [];
+              }
+            };
+
+            // Old logic
             //const Requests = require("./_Request");
-            //global.Credentials = (_options = {}, _res, _next) => [Requests.requests]; ----> // [Closed] TODO check passport.config file if not exists show error when file src/ using the JWT (maybe for show JWT is ON/OFF)
+            //global.Credentials = (_options = {}, _res, _next) => [Requests.requests]; // ---->  [Closed] TODO check passport.config file if not exists show error when file src/ using the JWT (maybe for show JWT is ON/OFF)
+
+            // Resolve it
             resolve([false, null, null]);
           }
         });
@@ -80,10 +154,12 @@ module.exports = {
             var passportPasswordField = passport_config.model.password_field || "password";
             var passportTable = passport_config.model.table || "users";
             var pool = eval("sql." + passport_config.model.name);
+            // Check your assign auth fields
             checkAuthFields(pool_base, pool, passportTable, passport_config.model.fields, (err, msg) => {
               if(err) {
-                console.error("\n Error ", err);
+                console.log("\n Error ", err);
                 return;
+                //throw err;
               } else {
                 // find passport primary key
                 findPassportPk(pool_base, pool, passportTable, passport_config.model.fields, (err, passportFields) => {
@@ -163,42 +239,38 @@ module.exports = {
                         } else if (pool_base == "sequelize") {
                           // pool base is Sequelize
                           try {
-                            pool.query("SHOW KEYS FROM " + passportTable + " WHERE Key_name = 'PRIMARY'", { type: QueryTypes.SELECT }).then((pk) => {
-                              let fieldPk = pk[0].Column_name;
-                              pool.query("SELECT " + passportFields + " FROM " + passportTable + " WHERE " + fieldPk + " = :pk", {
-                                replacements: {
-                                  pk: + jwtPayload[fieldPk]
-                                },
-                                type: QueryTypes.SELECT,
-                              }).then((result) => {
-                                return done(null, JSON.parse(JSON.stringify(result[ 0 ] || null)));
-                              }).catch((error) => {
-                                if(pool.options.logging) {
-                                  return done(error, null);
-                                } else {
-                                  if(error.sql) {
-                                    delete error.sql;
-                                    if(error.errors) {
-                                      delete error.errors;
-                                    }
-                                    if(error.parent) {
-                                      delete error.parent;
-                                    }
-                                    if(error.original) {
-                                      delete error.original.sql;
-                                    }
-                                    if(error.parameters) {
-                                      delete error.parameters;
-                                    }
-                                    return done(error, null);
+                            // Function Find table primaryKey
+                            const findPkOfTable = () => {
+                              return new Promise(async (resolve, reject) => {
+                                try {
+                                  const tableInfo = await pool.getQueryInterface().describeTable(String(passportTable));
+                                  const primaryKeys = Object.entries(tableInfo).filter(([columnName, columnInfo]) => columnInfo.primaryKey).map(([columnName]) => columnName);
+                                  if(primaryKeys.length) {
+                                    resolve(primaryKeys);
                                   } else {
-                                    return done(String(error), null);
+                                    resolve([Object.keys(tableInfo)[0]]);
                                   }
+                                } catch (error) {
+                                  reject(`Query Interface ${error}`);
                                 }
                               });
-                            }).catch((err) => {
-                              return done(err, null);
-                            });
+                            }
+                            // Find table primaryKey
+                            findPkOfTable()
+                              .then((fieldPk) => {
+                                pool.query("SELECT " + passportFields + " FROM " + passportTable + " WHERE " + fieldPk + " = :pk", {
+                                  replacements: {
+                                    pk: + jwtPayload[fieldPk]
+                                  },
+                                  type: QueryTypes.SELECT,
+                                }).then((result) => {
+                                  return done(null, JSON.parse(JSON.stringify(result[ 0 ] || null)));
+                                }).catch((err) => {
+                                  return done(err, null);
+                                });
+                              }).catch(err => {
+                                return done(err, null);
+                              });
                           } catch (error) {
                             return done(error, null);
                           }

package/packages/cli/core/configure/passport.config.js

@@ -24,7 +24,7 @@ module.exports = {
     // The fields for authenticate, default fields: (`username` and `password`)
     username_field: "",
     password_field: "",
-    // JWT playload data
+    // JWT playload data, You can add it. Example: ["name", "email", ...]
     fields: [],
     // Other fields add for authentication.
     guard: {

package/packages/cli/core/databases/mysql.js

@@ -27,7 +27,7 @@ mysqlInProcess = (database_config, headDbShow, cb) => {
         // check hash ?
         if(val.username && val.password) {
           if(val.username.length < 55 || val.password < 55) {
-            return cb("Error: No Hash access for connect to database.\n", null);
+            return cb("Error: Incorrect Hash access for connect to database.\n", null);
           }
           let accessDb = [];
           [val.username, val.password].map((e, k) => {