update version 0.6.19

Author: khanh2906

SECURITY.md

@@ -6,6 +6,7 @@
 | ------- | ------------------ |
 | 0.5.3   | :white_check_mark: |
 | 0.6.18   | :white_check_mark: |
+| 0.6.19   | :white_check_mark: |
 
 
 ## Reporting a Vulnerability

lib/stubs/elements/ORM/nosql/mongoDb/User.stub

@@ -1,4 +1,4 @@
-const mongoose = require("@iKernel/database")();
+const mongoose = require("@iKernel/database").get();
 const Schema = mongoose.Schema;
 const auth = require("@iKernel/auth");
 

lib/stubs/elements/ORM/sql/User.stub

@@ -1,5 +1,5 @@
 const { Sequelize, DataTypes } = require("sequelize");
-const sequelize = require("@iKernel/database")();
+const sequelize = require("@iKernel/database").get();
 const auth = require("@iKernel/auth");
 
 const User = sequelize.define("users", {

lib/stubs/template/jsconfig.json

@@ -37,10 +37,10 @@
 		}
 	},
 	"include": [
-		"src/**/*"],
+		"src/**/*"
+	],
 	"exclude": [
 		"node_modules",
 		"dist"
 	]
-	
 }

lib/stubs/template/package.json

@@ -1,9 +1,9 @@
 {
   "name": "bamimi",
-  "version": "0.6.18",
+  "version": "0.6.19",
   "description": "Power framework for nodejs",
   "main": "src/server.js",
-  "bamimiVersion": "0.6.18",
+  "bamimiVersion": "0.6.19",
   "bin": {
     "bamimi-enjoy-": "./dist/routes/cli/index.js",
     "bamimi-enjoy-dev": "./src/routes/cli/index.js"

lib/stubs/template/src/configs/file.js

@@ -13,10 +13,6 @@ module.exports = {
         tmp: {
             url: '',
             folder: path.join(__dirname, './../storage/tmp')
-        },
-        s3: {
-            url: process.env.AWS_BUCKET_URL ?? "",
-            bucket: process.env.AWS_BUCKET_NAME,
         }
     }
 };

lib/stubs/template/src/kernel/cache/index.js

@@ -1,11 +1,10 @@
 "use strict";
 const cache = require("@iConfigs/cache")
-const redisInit = require("./redis")
 
 const getStorage = (storage = null) => {
     switch (storage) {
         case 'redis':
-            return redisInit();
+            return require("./redis")();
         default:
             return getStorage(cache.use)
     }

lib/stubs/template/src/kernel/database/index.js

@@ -1,11 +1,66 @@
 
+"use strict";
+/**
+ * Module `DB`
+ * 
+ * Module to init and return Database connection with SQL or NoSQL.
+ * Auto get config from `@iConfigs/database`.
+ * 
+ * @module DB
+ * 
+ * @requires @iConfigs/database - Config of database
+ * @requires sequelize
+ * @requires mongodb
+ */
+
 const config = require("@iConfigs/database");
 
-const getDB = ({ useDatabase }) => {
+/**
+ * Connect and get DB with params
+ * 
+ * @function get
+ * 
+ * @param {Object} options - To determine database information
+ * @param {string} options.useDatabase - Type of Database (e.g: "sql", "nosql").
+ *                                         If no specified, module will use default value
+ *                                         from `config.useDatabase`.
+ * 
+ * @returns {Object} - Connection Database Object:
+ *                     - With SQL: return Sequelize instance.
+ *                     - With NoSQL (e.g: MongoDB): return flexible connection (default is Mongoose)
+ * 
+ * @example
+ * Use default value from config
+ * const db = require('@iKernel/database').get();
+ * 
+ * @example
+ * // Use SQL (Sequelize)
+ * const db = require('@iKernel/database').get({ useDatabase: 'sql' });
+ * 
+ * @example
+ * // Use NoSQL (MongoDB)
+ * const db = require('@iKernel/database').get({ useDatabase: 'nosql' });
+ */
+exports.get = ({ useDatabase }) => {
+	/**
+	 * Many connection database method
+	 */
 	const useDBs = {
+		/**
+		 * SQL Connection
+		 * 
+		 * @function sql
+		 * @returns {require("sequelize")} - Return instance of Sequelize
+		 */
 		sql: function () {
 			return require("./sequelize")(config.sql[config.sql.environment])
 		},
+		/**
+		 * NoSQL Connection
+		 * 
+		 * @function nosql
+		 * @returns {Object} - Return mongoose or other (future update).
+		 */
 		nosql: function () {
 			switch (config.nosql.connection) {
 				case "mongodb":
@@ -18,6 +73,4 @@ const getDB = ({ useDatabase }) => {
 	const db = useDatabase ? useDBs[useDatabase]() : useDBs[config.useDatabase]();
 
 	return db
-}
-
-module.exports = getDB;
+}

lib/stubs/template/src/kernel/database/sequelize.js

@@ -1,7 +1,12 @@
+const { Sequelize } = require("sequelize");
+
+let sequelize = null;
 
 module.exports = (config) => {
-	const { Sequelize } = require("sequelize");
-	const sequelize =  new Sequelize(config);
+	if (!sequelize) {
+		sequelize = new Sequelize(config);
+		
+	}
 	sequelize.authenticate()
 		.then(() => {
 			console.log("Connection has been established successfully.");

lib/stubs/template/src/kernel/index.js

@@ -11,7 +11,7 @@ exports.middleware = {
     common: {
         before: [
             /**
-             * Update powerd by
+             * Update Powered by
              */
             async (req, res, next) => {
                 res.setHeader('X-Powered-By', 'Bamimi');
@@ -74,7 +74,9 @@ exports.middleware = {
             next();
         },
         /**
-         * method override
+         * ****************************
+         * CSRF
+         * ****************************
          */
         csrf.generate({
             tokenLength: 24,
@@ -90,9 +92,18 @@ exports.middleware = {
                 }
             }
         }),
-
         csrf.setTokenLocalsParam,
+        /**
+         * ****************************
+         * Response handle
+         * ****************************
+         */
         require("@iKernel/response/web"),
+        /**
+         * ****************************
+         * method override
+         * ****************************
+         */
         methodOverride('X-HTTP-Method'),
         methodOverride('X-HTTP-Method-Override'),
         methodOverride('X-Method-Override'),

lib/stubs/template/src/kernel/interface/apis/index.js

@@ -1,10 +1,61 @@
 "use strict";
+/**
+ * Module `interface api handle`
+ * 
+ * Module to init and return Database connection with SQL or NoSQL.
+ * Auto get config from `@iConfigs/database`.
+ * 
+ * @module 
+ * 
+ * @requires structure - structure of response
+ */
 const { content: ifaContent, message: ifaMsg } = require("./structure");
-
 /**
+ * @typedef {{code: number, content: string}} meta
+ * @typedef {{meta: meta, data: Object}} messageData 
+ * @typedef {{meta: meta, errors: Object}} messageError
+ */
+/**
+ * Get format response
+ * 
+ * @function handle
+ * 
+ * @param {Number} status - state of response
+ * @param {Object} data - response data
+ * 
+ * @returns {messageData | messageError} {@link messageData} | {@link messageError } 
+ * 
+ * @example
+ * Import module
+ * const { handle } = require("@iKernel/interface/api")
+ * 
+ * @example
+ * // With data
+ * const response = handle(200, {msg: "OK la"})
+ * console.log(response) - 
+ * {
+ *     meta: {
+ *         status: 200,
+ *         content: "OK"
+ *     },
+ *     data: {
+ *         msg: "Ok la"
+ *     }
+ *  }
  * 
- * @param {Number} status 
- * @param {Object} data 
+ * @example
+ * // With error
+ * const response = handle(403, [{"msg": "Not admin"}])
+ * console.log(response) - 
+ * {
+ *     meta: {
+ *         status: 403,
+ *         content: "Forbidden"
+ *     },
+ *     errors: [{
+ *         msg: "Not admin"
+ *     }]
+ *  }
  */
 exports.handle = (status, data = null) => {
 

lib/stubs/template/src/libs/file.lib.js

@@ -64,6 +64,7 @@ const remove = async ({ pathFile, storageType }) => {
             }
         },
     };
+
     return storageType ? await storages[storageType]() : await storages[config.use]();
 };
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knfs-tech/bamimi-cli",
-  "version": "0.6.18",
+  "version": "0.6.19",
   "description": "Command line of Bamimi framework",
   "bin": {
     "bamimi-cli": "./bin/cli.js"