beech-api 3.4.12 → 3.5.12

package/README.md

@@ -29,7 +29,7 @@
 
 ## Environment
 
-- [`Node.js`](https://nodejs.org) >= 10.13.0+ (recommended)
+- [`Node.js`](https://nodejs.org) >= 14.19.0+ (recommended)
 - `npm` >= 6.4.1+ or `yarn` >= 1.22.4+
 
 ## Installation
@@ -106,12 +106,12 @@ $ beech make endpointName
 
   exports.init = () => {
 
-    /@GET/
+    //@GET
     endpoint.get('/fruits', (req, res) => {
       ...
     });
 
-    /@POST/
+    //@POST
     endpoint.post('/fruits', (req, res) => {
       ...
     });
@@ -131,7 +131,7 @@ The `models` keep the files of function(s) for retriving, inserting, updating an
 $ beech make modelName --model
 ```
 
-**Example:** Fruits model.
+**Example (basic):** Fruits model.
 
 ```js
   // Fruits.js
@@ -143,24 +143,53 @@ $ beech make modelName --model
       return { ... }
     },
 
-    // Example basic function get data from MySQL (must be return promise)
+    // Example basic function get data from MySQL table
     getFruits() {
-      return new Promise((resolve, reject) => {
-        try {
-          // call mysql `default_db` connection
-          mysql.default_db.query("SELECT * FROM fruits", (err, results) => {
-            if (err) { reject(err) }
-            resolve(results);
-          });
-        } catch (error) {
-          reject(error);
-        }
+      // call example mysql `mysql.default_db` connection name
+      mysql.default_db.query("SELECT * FROM fruits", (err, results) => {
+
+        if (err) { throw err }
+        return results;
+
       });
     }
 
   };
 ```
 
+**Example (sequelize):** Fruits model.
+
+```js
+  // Fruits.js
+
+  // call example define table with `sql.default_db` connection name
+  const Fruits = sql.default_db.define("fruits", {
+    // asign more DataTypes see more: https://sequelize.org/docs/v6/core-concepts/model-basics/#data-types
+    id: {
+      type: DataTypes.INTEGER,
+      autoIncrement: true,
+      primaryKey: true
+    },
+    fruitsName: DataTypes.STRING,
+    fruitsQty: DataTypes.INTEGER,
+    fruitsPrice: DataTypes.INTEGER,
+  });
+
+  module.exports = {
+
+    // Example basic function get one by id
+    findFruitsById(id) {
+      return Fruits.findOne({ where: { id: id } });
+    },
+
+    // Example basic function get all data from table fruits
+    findAll() {
+      return Fruits.findAll();
+    }
+
+  };
+```
+
 ## Helpers
 
 The `helpers` keep the files of functions for process specific something in the project. So, you might create the `helpers` in path `src/helpers` folder.
@@ -216,7 +245,7 @@ module.exports = {
   token_expired: 86400,
 
   model: {
-    // your mysql connection name inside `app.config.js` file (users table storage)
+    // Main sql connection name. You must make sure connection name like inside `app.config.js` file and choose one connection name.
     name: "default_db",
 
     // table name of users store, default table `users`

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "beech-api",
-  "version": "3.4.12",
+  "version": "3.5.12",
   "description": "Command line interface for rapid Beech API development",
   "keywords": [
+    "api",
+    "api-framework",
     "beech-api",
     "cli",
-    "api",
-    "nodejs",
-    "api-framework"
+    "nodejs"
   ],
   "license": "MIT",
   "repository": {
@@ -18,6 +18,7 @@
   "authors": "bombkiml",
   "bin": {
     "beech-app": "./packages/cli/bin/beech.js",
+    "beech-service": "./packages/cli/bin/beech-service.js",
     "beech": "./packages/cli/core/generator/index.js"
   },
   "bugs": {
@@ -26,37 +27,42 @@
   "homepage": "https://github.com/bombkiml/beech-api/blob/master/README.md",
   "deprecated": false,
   "engines": {
-    "node": ">=10.13"
+    "node": ">=14.19"
   },
   "dependencies": {
     "app-root-path": "^3.0.0",
     "axios": "^0.26.1",
+    "cli-clear": "^1.0.4",
     "cookie-parser": "1.4.3",
     "cors": "^2.8.1",
     "express": "4.16.3",
     "express-session": "^1.17.1",
     "express-validator": "2.21.0",
     "fs": "0.0.1-security",
+    "inquirer": "8.2.4",
     "jsonwebtoken": "^8.5.1",
     "log-update": "^4.0.0",
     "md5": "^2.3.0",
-    "mkdirp": "^0.5.1",
+    "mkdirp": "^2.1.6",
     "module-alias": "^2.2.2",
     "mysql": "^2.18.1",
     "mysql2": "^2.3.3",
     "node-cmd": "^3.0.0",
-    "passport": "^0.4.1",
+    "node-notifier": "^10.0.1",
+    "passport": "^0.6.0",
     "passport-facebook": "^3.0.0",
     "passport-google-oauth": "^2.0.0",
     "passport-jwt": "^4.0.0",
     "passport-local": "^1.0.0",
     "passport-oauth": "^1.0.0",
     "path": "^0.12.7",
-    "sequelize": "^5.21.6",
+    "sequelize": "^6.21.3",
     "walk": "^2.3.14"
   },
   "devDependencies": {
-    "jest": "^25.2.7",
+    "jest": "^28.1.3",
+    "node-dev": "^8.0.0",
+    "nodemon": "^3.0.1",
     "sequelize-cli": "^5.5.1"
   },
   "jest": {

package/packages/cli/beech

@@ -4,8 +4,8 @@
  * The beech api (cli) package generator and server (bash for developer and production build)
  *
  * @author bombkiml
- * @version 3.2
- * @built Apr 17, 2020 at 00:09:19
+ * @version 3.6
+ * @built Aug 14, 2023 at 00:09:19
  *
  */
 (process.argv[2]) ? require('./core/generator/index') : require('./core/index')

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

@@ -0,0 +1,305 @@
+#!/usr/bin/env node
+const logUpdate = require("log-update");
+const notifier = require("node-notifier");
+const path = require("path");
+const clear = require("cli-clear");
+const express = require("express");
+const _app_ = express();
+const Sequelize = require('sequelize');
+let testSql = {};
+
+class Beech {
+  constructor() {
+    this.embed(process.argv)
+      .then(() => this.init()
+        .then(status => console.log(status))
+        .catch(err => {
+          throw err;
+        })
+      );
+  }
+
+  init() {
+    return new Promise(async (resolve, reject) => {
+      try {
+        if (this.option == "serve") {
+          let turnNoti = true;
+          if (this.argument == "--silent" || this.argument == "-S") {
+            turnNoti = false;
+          }
+          // check project config file exists ?
+          if (this.fs.existsSync(this.configFile)) {
+            const testServ = _app_.listen(this._config_.main_config.app_port, () => {
+              //console.log("Test Started.");
+              testServ.close();
+              // Start real service.
+              this.getStart(turnNoti, (err, res) => {
+                if (err) {
+                  reject("\n Faltal  start service catch.");
+                  return;
+                }
+                // show info
+                console.clear();
+                //console.log(res);
+              });
+
+            });
+          } else {
+            resolve("\n Faltal  The app.conifg.js file is not found.");
+          }
+        } else if (!this.option || this.option == "-h" || this.option == "?" || this.option == "--help") {
+          // help for see avaliable command
+          this.help()
+            .then(help => resolve(help))
+            .catch(err => reject(err));
+        } else {
+          resolve("\n Faltal  commnad it's not available.");
+        }
+      } catch (error) {
+        reject(error);
+      }
+    });
+  }
+
+  filterDbIsTrue(dbConfig, cb) {
+    try {
+      let dbIsTrue = [];
+      dbConfig.filter((e, k) => {
+        if (e.is_connect) {
+          dbIsTrue.push(e);
+        }
+        if (dbConfig.length == k + 1) {
+          cb(null, dbIsTrue);
+        }
+      });
+    } catch (error) {
+      cb(error, null);
+    }
+  }
+
+  initSequelize(val, cb) {
+    try {
+      const sq = new Sequelize({
+        dialect: val.dialect || "mysql",
+        host: val.host,
+        username: val.username,
+        password: val.password,
+        database: val.database,
+        port: val.port,
+        storage: val.storage || ":memory:",
+        protocol: val.protocol || null,
+        logging: val.logging || false,
+        dialectOptions: {
+          socketPath: ((val.dialectOptions) ? ((val.dialectOptions.socketPath) ? val.dialectOptions.socketPath : "") : ""), //Applications/MAMP/tmp/mysql/mysql.sock
+          supportBigNumbers: ((val.dialectOptions) ? ((val.dialectOptions.supportBigNumbers) ? val.dialectOptions.supportBigNumbers : false) : false),
+          bigNumberStrings: ((val.dialectOptions) ? ((val.dialectOptions.bigNumberStrings) ? val.dialectOptions.bigNumberStrings : false) : false),
+          options: ((val.dialectOptions) ? ((val.dialectOptions.options) ? ({ encrypt: false, ...val.dialectOptions.options }) : { encrypt: false }) : { encrypt: false }),
+        },
+        omitNull: val.omitNull || false,
+        native: val.native || false,
+        define: {
+          underscored: ((val.define) ? ((val.define.underscored) ? val.define.underscored : false) : false),
+          freezeTableName: ((val.define) ? ((val.define.freezeTableName === false) ? val.define.freezeTableName : true) : true),
+          charset: ((val.define) ? ((val.define.charset) ? val.define.charset : "utf8") : "utf8"),
+          dialectOptions: {
+            collate: ((val.define) ? ((val.define.dialectOptions) ? ((val.define.dialectOptions.timestamps) ? val.define.dialectOptions.timestamps : "utf8_general_ci") : "utf8_general_ci") : "utf8_general_ci"),
+          },
+          timestamps: ((val.define) ? ((val.define.timestamps) ? val.define.timestamps : false) : false),
+        },
+        sync: {
+          force: ((val.sync) ? ((val.sync.force) ? val.sync.force : false) : false),
+        },
+        pool: {
+          max: ((val.pool) ? ((val.pool.max) ? val.pool.max : 5) : 5),
+          idle: ((val.pool) ? ((val.pool.idle) ? val.pool.idle : 30000) : 30000),
+          acquire: ((val.pool) ? ((val.pool.acquire) ? val.pool.acquire : 60000) : 60000),
+        },
+        isolationLevel: val.isolationLevel || "Transaction.ISOLATION_LEVELS.REPEATABLE_READ",
+        query: {
+          raw: ((val.query) ? ((val.query.raw) ? val.query.raw : true) : true),
+          nest: ((val.query) ? ((val.query.nest) ? val.query.nest : true) : true),
+        }
+      });
+      cb(false, sq);
+    } catch (error) {
+      cb(error, null);
+    }
+  }
+
+  testConnectInProcess = (database_config, dbConnTotal, cb) => {
+    try {
+      let val = database_config.shift();
+      if (val) {
+        this.initSequelize(val, async (err, sq) => {
+          if (err) {
+            console.error(" Failed  Can't to create a Sequelize instance:", val.name, "\n", err);
+            cb(err, null, null);
+          }
+          // Test connection
+          await sq.authenticate()
+            .then(() => {
+              // Database some is true perfectly.
+              if (database_config.length == 0) {
+                if (sq) {
+                  testSql[ val.name ] = sq;
+                  //console.log("DB true, Perfectly.", val.name);
+                  cb(null, true, testSql);
+                }
+              } else {
+                testSql[ val.name ] = sq;
+                this.testConnectInProcess(database_config, dbConnTotal, cb);
+              }
+            })
+            .catch(err => {
+              console.error(" Failed  Unable to connect to the database:", val.name, "\n", err);
+              cb(err, null, null);
+            });
+        });
+      } else if (!dbConnTotal) {
+        // All Database is falsly perfectly.
+        //console.log("DB all false, Perfectly.");
+        cb(null, true, testSql);
+      }
+    } catch (error) {
+      cb(error, null, null);
+    }
+  }
+
+  getStart(turnNoti, cb) {
+    try {
+      clear();
+      logUpdate("Compiling...");
+      // filter for check dabatase only true
+      this.filterDbIsTrue(this._config_.database_config, (err, dbConnectIsTrueOnly) => {
+        if (err) {
+          logUpdate("Config file crash.", err);
+          return;
+        }
+        // leave data to disconnect database
+        let leaveDataForDisconnect = dbConnectIsTrueOnly.slice(0);
+        // check db connect truthy length ?
+        if (dbConnectIsTrueOnly.length > 0) {
+          // Test connect process
+          this.testConnectInProcess(dbConnectIsTrueOnly, dbConnectIsTrueOnly.length, (err, result, dbs) => {
+            if (err) {
+              logUpdate(" Failed  Database connect failed.", err);
+              return;
+            }
+            if (result) {
+              // Disconnect database
+              this.disConnectTestDB(leaveDataForDisconnect, dbs, (err, disResult) => {
+                if (err) {
+                  logUpdate(" Failed  Testing Database connect failed.", err);
+                  return;
+                }
+                if (disResult) {
+                  // Start service
+                  this.serviceDevStart();
+                  // check turn on nofi
+                  if (turnNoti) {
+                    this.notiCompile();
+                  }
+                } else {
+                  cb(err, null);
+                }
+              });
+            }
+          });
+        } else {
+          this.serviceDevStart();
+        }
+      });
+    } catch (error) {
+      cb(error, null);
+    }
+  }
+
+  serviceDevStart() {
+    let firstCount = 0;
+    const command = this.cmd.get(`npx nodemon -q ./node_modules/beech-api/packages/cli/beech`);
+    command.stdout.on('data', (data) => {
+      firstCount++;
+      let leaveData = data.slice(0);
+      if (firstCount == 1) {
+        clear();
+      }
+      // shout out
+      if (data.trim().slice(-1) == ":") {
+        console.log("\n", leaveData.trim());
+      } else {
+        let serviceShoutOut = leaveData.trim().split('- ');
+        if (serviceShoutOut.length > 2) {
+          console.log("  -", serviceShoutOut[ 1 ].trim());
+          console.log("  -", serviceShoutOut[ 2 ].trim());
+        } else {
+          console.log(" ", leaveData.trim());
+        }
+      }
+
+    });
+  }
+
+  notiCompile() {
+    notifier.notify({
+      title: 'Beech API',
+      subtitle: 'Beech service getting started.',
+      message: "Service getting started.",
+      sound: 'Funk',
+      wait: false,
+      icon: path.join(__dirname, "/../../public/icon/beech_128.png"),
+      contentImage: path.join(__dirname, "../../public/icon/beech_128.png"),
+    });
+  }
+
+  disConnectTestDB(dbConfigTruthy, dbs, cb) {
+    try {
+      dbConfigTruthy.map((e, k) => {
+        // Closing database
+        if (dbs[ e.name ].close()) {
+          if (dbConfigTruthy.length == k + 1) {
+            cb(null, dbConfigTruthy);
+          }
+        } else {
+          cb(`Close database failed, ${e.name}`, null);
+        }
+      });
+    } catch (error) {
+      cb(error, null);
+    }
+  }
+
+  help() {
+    return new Promise((resolve, reject) => {
+      try {
+        this.fs.readFile(__dirname + "/../core/generator/_service", "utf8", (err, data) => {
+          if (err) {
+            reject(err);
+          } else {
+            resolve(data);
+          }
+        });
+      } catch (error) {
+        reject(error);
+      }
+    });
+  }
+
+  embed(argv) {
+    return new Promise((resolve, reject) => {
+      try {
+        this.fs = require("fs");
+        this.cmd = require('node-cmd');
+        this.argv = argv;
+        this.option = argv[ 2 ];
+        this.argument = argv[ 3 ];
+        this.configFile = path.resolve("./app.config.js");
+        this._config_ = require(this.configFile);
+        resolve(this);
+      } catch (error) {
+        reject(error);
+      }
+    });
+  }
+}
+
+new Beech();