@modular-rest/server 1.4.2 → 1.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@modular-rest/server",
-  "version": "1.4.2",
+  "version": "1.5.0",
   "description": "a nodejs module based on KOAJS for developing Rest-APIs in a modular solution.",
   "main": "src/index.js",
   "scripts": {
@@ -26,8 +26,8 @@
     "@koa/cors": "^3.1.0",
     "colog": "^1.0.4",
     "file-system": "^2.2.2",
-    "generate-rsa-keypair": "^0.2.1",
     "jsonwebtoken": "^8.5.1",
+    "keypair": "^1.0.4",
     "koa": "^2.5.3",
     "koa-body": "^4.2.0",
     "koa-router": "^7.4.0",

package/src/application.js

@@ -1,19 +1,22 @@
-let koa = require('koa');
-const cors = require('@koa/cors');
-const koaBody = require('koa-body');
-const koaStatic = require('koa-static-server');
-var path = require('path');
-var Combination = require('./class/combinator');
-let DataProvider = require('./services/data_provider/service');
-let UserService = require('./services/user_manager/service')
+let koa = require("koa");
+const cors = require("@koa/cors");
+const koaBody = require("koa-body");
+const koaStatic = require("koa-static-server");
+var path = require("path");
+var Combination = require("./class/combinator");
+let DataProvider = require("./services/data_provider/service");
+let UserService = require("./services/user_manager/service");
 
-let defaultServiceRoot = __dirname + '/services';
+let defaultServiceRoot = __dirname + "/services";
 
 /**
  * @param {{
  *   cors: any; // Options for @koa/cors middleware.
  *   modulesPath: string; // Root directory of your router.js/db.js files.
- *   staticPath: string; // Root directory for uploaded files.
+ *   static: {
+ *      dir: string; // Root directory for uploaded files.
+ *      rootPath: string; // Root path for uploaded files.
+ *   };
  *   onBeforeInit: (koaApp) => void; // A callback called before initializing the Koa server.
  *   onAfterInit: (koaApp) => void; // A callback called after server initialization.
  *   port: number; // Server port.
@@ -36,145 +39,146 @@ let defaultServiceRoot = __dirname + '/services';
  * }} options
  */
 module.exports = async function createRest(options) {
+  options = {
+    port: 3000,
+    dontListen: false,
+    mongo: {
+      atlas: false,
+      mongoBaseAddress: "mongodb://localhost:27017",
+      dbPrefix: "mrest_",
+    },
+    adminUser: {
+      email: "admin@email.com",
+      password: "@dmin",
+    },
+
+    ...options,
+  };
+
+  let app = new koa();
+
+  /**
+   * Plug in Cors
+   */
+  app.use(cors(options.cors || {}));
+
+  /**
+   * Plug in BodyParser
+   */
+  let bodyParserOptions = {
+    multipart: true,
+  };
+  app.use(koaBody(bodyParserOptions));
+
+  /**
+   * Plug In KoaStatic
+   */
+  if (options.staticPath) {
+    app.use(
+      koaStatic({
+        rootDir: options.static.dir,
+        rootPath: options.static.rootPath || "/assets/",
+      })
+    );
+  }
+
+  /**
+   * Run before hook
+   */
+  if (options.onBeforeInit) options.onBeforeInit(app);
+
+  /**
+   * Setup default services
+   *
+   * - Collect and plug in router.js/db.js of default services
+   * - Setting up default services
+   */
+
+  // Plug in default routes
+  await Combination.combineRoutesByFilePath(path.join(defaultServiceRoot), app);
+
+  // Collect default databaseDefinitions
+  let defaultDatabaseDefinitionList =
+    await Combination.combineModulesByFilePath({
+      rootDirectory: defaultServiceRoot,
+      filename: {
+        name: "db",
+        extension: ".js",
+      },
+      combineWithRoot: true,
+    });
 
-    options = {
-        port: 3000,
-        dontListen: false,
-        mongo: {
-            atlas: false,
-            mongoBaseAddress: 'mongodb://localhost:27017',
-            dbPrefix: 'mrest_',
-        },
-        adminUser: {
-            email: 'admin@email.com',
-            password: '@dmin',
-        },
-
-        ...options,
-    }
-
-    let app = new koa();
-
-    /**
-     * Plug in Cors
-     */
-    app.use(cors(options.cors || {}));
-
-    /**
-     * Plug in BodyParser
-     */
-    let bodyParserOptions = {
-        multipart: true
-    };
-    app.use(koaBody(bodyParserOptions));
-
-    /**
-     * Plug In KoaStatic
-     */
-    if (options.staticPath)
-        app.use(koaStatic({
-            rootDir: options.staticPath,
-            rootPath: '/assets/',
-
-        }));
-
-    /**
-     * Run before hook
-     */
-    if (options.onBeforeInit) options.onBeforeInit(app);
-
-    /**
-     * Setup default services
-     * 
-     * - Collect and plug in router.js/db.js of default services
-     * - Setting up default services 
-     */
-
-    // Plug in default routes
-    await Combination.combineRoutesByFilePath(
-        path.join(defaultServiceRoot), app);
-
-    // Collect default databaseDefinitions
-    let defaultDatabaseDefinitionList = await Combination.combineModulesByFilePath({
-        rootDirectory: defaultServiceRoot,
-        filename: {
-            name: 'db',
-            extension: '.js'
-        },
-        combineWithRoot: true
+  // Plug in default databaseDefinitions
+  await DataProvider.addCollectionDefinitionByList({
+    list: defaultDatabaseDefinitionList,
+    mongoOption: options.mongo,
+  });
+
+  // Setting up default services
+  await require("./helper/presetup_services").setup(options);
+
+  /**
+   * User Services
+   *
+   * Plug in routes and database
+   */
+  if (options.modulesPath) {
+    // Plug in user routes
+    await Combination.combineRoutesByFilePath(options.modulesPath, app);
+
+    // Collect user CollectionDefinitions (db.js files)
+    let userDatabaseDetail = [];
+    userDatabaseDetail = await Combination.combineModulesByFilePath({
+      rootDirectory: options.modulesPath,
+      filename: {
+        name: "db",
+        extension: ".js",
+      },
+      combineWithRoot: true,
     });
 
-    // Plug in default databaseDefinitions
-    await DataProvider.addCollectionDefinitionByList({
-        list: defaultDatabaseDefinitionList,
-        mongoOption: options.mongo
-    })
-
-    // Setting up default services
-    await require('./helper/presetup_services').setup(options);
-
-    /**
-     * User Services
-     * 
-     * Plug in routes and database
-     */
-    if (options.modulesPath) {
-
-        // Plug in user routes
-        await Combination.combineRoutesByFilePath(options.modulesPath, app);
-
-        // Collect user CollectionDefinitions (db.js files)
-        let userDatabaseDetail = [];
-        userDatabaseDetail = await Combination.combineModulesByFilePath({
-            rootDirectory: options.modulesPath,
-            filename: {
-                name: 'db',
-                extension: '.js'
-            },
-            combineWithRoot: true
-        });
-
-        // combine additional CollectionDefinitions
-        if (options.collectionDefinitions) {
-            userDatabaseDetail.concat(options.collectionDefinitions)
-        }
-
-        // Plug in user CollectionDefinitions
-        await DataProvider.addCollectionDefinitionByList({
-            list: userDatabaseDetail || [],
-            mongoOption: options.mongo
-        })
-
-        // Plug in Verification method
-        if (typeof options.verificationCodeGeneratorMethod == 'function') {
-            UserService.main.setCustomVerificationCodeGeneratorMethod(
-                options.verificationCodeGeneratorMethod
-            )
-        }
+    // combine additional CollectionDefinitions
+    if (options.collectionDefinitions) {
+      userDatabaseDetail.concat(options.collectionDefinitions);
     }
 
-    /**
-     * Run the server
-     * 
-     * return KOA app object 
-     */
-    return new Promise((done, reject) => {
-
-        let server;
-
-        if (!options.dontListen) {
-            server = app.listen(options.port);
-            console.log('\x1b[35m', `KOAS has been launched on: localhost:${options.port}`);
-        }
+    // Plug in user CollectionDefinitions
+    await DataProvider.addCollectionDefinitionByList({
+      list: userDatabaseDetail || [],
+      mongoOption: options.mongo,
+    });
 
+    // Plug in Verification method
+    if (typeof options.verificationCodeGeneratorMethod == "function") {
+      UserService.main.setCustomVerificationCodeGeneratorMethod(
+        options.verificationCodeGeneratorMethod
+      );
+    }
+  }
+
+  /**
+   * Run the server
+   *
+   * return KOA app object
+   */
+  return new Promise((done, reject) => {
+    let server;
+
+    if (!options.dontListen) {
+      server = app.listen(options.port);
+      console.log(
+        "\x1b[35m",
+        `KOAS has been launched on: localhost:${options.port}`
+      );
+    }
 
-        // on after init
-        if (options.onAfterInit) options.onAfterInit(app);
+    // on after init
+    if (options.onAfterInit) options.onAfterInit(app);
 
-        //done
-        done({
-            app,
-            server
-        });
+    //done
+    done({
+      app,
+      server,
     });
-}
+  });
+};

package/src/helper/presetup_services.js

@@ -1,34 +1,32 @@
-let DataInsertion = require('./data_insertion');
-let JWT = require('../services/jwt/service');
-let FileService = require('../services/file/service');
+let DataInsertion = require("./data_insertion");
+let JWT = require("../services/jwt/service");
+let FileService = require("../services/file/service");
 
 module.exports.setup = async ({ keypair, adminUser, uploadDirectory }) => {
+  /**
+   * Json web Token
+   *
+   * Setup private and public keys for JWT module
+   */
+  if (!keypair) {
+    // generate new keypair
+    const generateKeypair = require("keypair");
+    keypair = generateKeypair();
+  }
 
-    /**
-     * Json web Token
-     * 
-     * Setup private and public keys for JWT module 
-     */
-    if (!keypair) {
-        // generate new keypair
-        var generateRSAKeypair = require('generate-rsa-keypair')
-        keypair = generateRSAKeypair()
-    }
+  JWT.main.setKies(keypair.private, keypair.public);
 
-    JWT.main.setKies(keypair.private, keypair.public);
+  /**
+   * Data Insertion
+   *
+   * Insert permissions and admin user
+   * for the first time
+   */
+  await DataInsertion.createPermissions();
+  await DataInsertion.createAdminUser(adminUser);
 
-    /**
-     * Data Insertion
-     * 
-     * Insert permissions and admin user
-     * for the first time
-     */
-    await DataInsertion.createPermissions();
-    await DataInsertion.createAdminUser(adminUser)
-
-    /**
-     * File Service
-     */
-    FileService.setUploadDirectory(uploadDirectory);
-
-}
+  /**
+   * File Service
+   */
+  FileService.setUploadDirectory(uploadDirectory);
+};

package/src/index.js

@@ -1,57 +1,57 @@
 // Application
-const createRest = require('./application');
-const Schema = require('mongoose').Schema;
+const createRest = require("./application");
+const Schema = require("mongoose").Schema;
 
 // Utilities
-const paginator = require('./class/paginator');
-const reply = require('./class/reply');
-const validator = require('./class/validator');
-const {
-    getCollection
-} = require('./services/data_provider/service');
-const TypeCasters = require('./services/data_provider/typeCasters');
+const paginator = require("./class/paginator");
+const reply = require("./class/reply");
+const validator = require("./class/validator");
+const { getCollection } = require("./services/data_provider/service");
+const TypeCasters = require("./services/data_provider/typeCasters");
 
 // Base class
-const CollectionDefinition = require('./class/collection_definition');
-const Schemas = require('./class/db_schemas');
-const DatabaseTrigger = require('./class/database_trigger');
-const SecurityClass = require('./class/security');
+const CollectionDefinition = require("./class/collection_definition");
+const Schemas = require("./class/db_schemas");
+const DatabaseTrigger = require("./class/database_trigger");
+const SecurityClass = require("./class/security");
 
-const middleware = require('./middlewares');
+const middleware = require("./middlewares");
 
 module.exports = {
-    createRest,
-
-    //
-    // Utilities
-    //
-    reply,
-    TypeCasters,
-
-    /**
-     * @type {import('./class/paginator').create}
-     */
-    paginator,
-
-    /**
-     * @type {import('./class/validator')}
-     */
-    validator,
-
-    /** 
-     * @type {import('./services/data_provider/service').getCollection}
-     * @return {import('mongoose').Model} Mongoose model https://mongoosejs.com/docs/api/model.html
-     */
-    getCollection,
-
-    //
-    // Base class
-    //
-    CollectionDefinition,
-    Schemas,
-    Schema,
-    DatabaseTrigger,
-
-    ...SecurityClass,
-    middleware
-}
+  createRest,
+
+  //
+  // Utilities
+  //
+  reply,
+  TypeCasters,
+
+  /**
+   * @type {import('./class/paginator').create}
+   */
+  paginator,
+
+  /**
+   * @type {import('./class/validator')}
+   */
+  validator,
+
+  /**
+   * @type {import('./services/data_provider/service').getCollection}
+   * @return {import('mongoose').Model} Mongoose model https://mongoosejs.com/docs/api/model.html
+   */
+  getCollection,
+
+  //
+  // Base class
+  //
+  CollectionDefinition,
+  Schemas,
+  Schema,
+  DatabaseTrigger,
+
+  ...SecurityClass,
+
+  // Middlewares
+  middleware,
+};

package/src/middlewares.js

@@ -1,24 +1,30 @@
-let validateObject = require('./class/validator');
-const userManager = require('./services/user_manager/service');
+let validateObject = require("./class/validator");
+const userManager = require("./services/user_manager/service");
 
-module.exports.auth = async (ctx, next) => 
-{
-    let headers = ctx.header;
-    let headersValidated = validateObject(headers, 'authorization');
+/**
+ * Authentication middleware
+ * It checks if incoming request has a valid token in header.authorization
+ *
+ * @param {Object} ctx - Koa context
+ * @param {Function} next - Koa next function
+ * @returns {Promise<void>}
+ */
+module.exports.auth = async (ctx, next) => {
+  let headers = ctx.header;
+  let headersValidated = validateObject(headers, "authorization");
 
-    if(!headersValidated.isValid)
-        ctx.throw(401 , 'authentication is required');
-        
-    let token = headers.authorization;
-    
-    await userManager.main.getUserByToken(token)
-        .then(async user => 
-        {
-            ctx.state.user = user;
-            await next();
-        })
-        .catch(err => {
-            console.log(err);
-            ctx.throw(err.status || 412, err.message);
-        });
-}
+  if (!headersValidated.isValid) ctx.throw(401, "authentication is required");
+
+  let token = headers.authorization;
+
+  await userManager.main
+    .getUserByToken(token)
+    .then(async (user) => {
+      ctx.state.user = user;
+      await next();
+    })
+    .catch((err) => {
+      console.log(err);
+      ctx.throw(err.status || 412, err.message);
+    });
+};