@modular-rest/server 1.3.1 → 1.3.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@modular-rest/server",
-  "version": "1.3.1",
+  "version": "1.3.3",
   "description": "a nodejs module based on KOAJS for developing Rest-APIs in a modular solution.",
   "main": "src/index.js",
   "scripts": {
@@ -36,4 +36,4 @@
     "nested-property": "^4.0.0"
   },
   "devDependencies": {}
-}
+}

package/src/application.js

@@ -10,36 +10,32 @@ let UserService = require('./services/user_manager/service')
 let defaultServiceRoot = __dirname + '/services';
 
 /**
- * 
- * @param {object} options
- * 
- * @param {object} options.cors @koa/cors options
- * 
- * @param {string} options.componentDirectory root directory of your router.js/db.js files.
- * @param {string} options.uploadDirectory root directory for upload files.
- * @param {function} options.onBeforeInit a callback being called before init koa server.
- * @param {function} options.onAfterInit a callback being called after server initialization.
- * @param {number} options.port server port
- * @param {boolean} options.dontListen server will not being run if it was true and just return koa app object.
- * 
- * 
- * @param {string} options.mongo mongodb options.
- * @param {string} options.mongo.dbPrefix a prefix for your database name.
- * @param {string} options.mongo.mongoBaseAddress the address of your mongo server without any database specification on it.
- * @param {string} options.mongo.addressMap specific address for each database
- * 
- * @param {object} options.keypair RSA keypair for authentication module
- * @param {string} options.keypair.private
- * @param {string} options.keypair.public
- * 
- * @param {object} options.adminUser supper admin user to being created as the first user of the system.
- * @param {string} options.adminUser.email
- * @param {string} options.adminUser.password
- * 
- * @param {function} options.verificationCodeGeneratorMethod a method to return a code as verification when someone want to register a new user.
- * @param {array} options.CollectionDefinitions an array of additional collectionDefinitions
+ * @param {{
+ *   cors: any; // Options for @koa/cors middleware.
+ *   componentDirectory: string; // Root directory of your router.js/db.js files.
+ *   uploadDirectory: string; // Root directory 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.
+ *   dontListen: boolean; // If true, the server will not run and will only return the Koa app object.
+ *   mongo: {
+ *     dbPrefix: string; // A prefix for your database name.
+ *     mongoBaseAddress: string; // The address of your MongoDB server without any database specification.
+ *     addressMap: string; // Specific addresses for each database.
+ *   };
+ *   keypair: {
+ *     private: string; // Private key for RSA authentication.
+ *     public: string; // Public key for RSA authentication.
+ *   };
+ *   adminUser: {
+ *     email: string; // Admin user email.
+ *     password: string; // Admin user password.
+ *   };
+ *   verificationCodeGeneratorMethod: () => string; // A method to return a verification code when registering a new user.
+ *   collectionDefinitions: CollectionDefinition[]; // An array of additional collection definitions.
+ * }} options
  */
-async function createRest(options) {
+module.exports = async function createRest(options) {
 
     options = {
         port: 3000,
@@ -67,7 +63,9 @@ async function createRest(options) {
     /**
      * Plug in BodyParser
      */
-    let bodyParserOptions = { multipart: true };
+    let bodyParserOptions = {
+        multipart: true
+    };
     app.use(koaBody(bodyParserOptions));
 
     /**
@@ -75,8 +73,8 @@ async function createRest(options) {
      */
     if (options.uploadDirectory)
         app.use(koaStatic({
-            rootDir: options.uploadDirectory, 
-            rootPath: '/assets/', 
+            rootDir: options.uploadDirectory,
+            rootPath: '/assets/',
 
         }));
 
@@ -99,7 +97,10 @@ async function createRest(options) {
     // Collect default databaseDefinitions
     let defaultDatabaseDefinitionList = await Combination.combineModulesByFilePath({
         rootDirectory: defaultServiceRoot,
-        filename: { name: 'db', extension: '.js' },
+        filename: {
+            name: 'db',
+            extension: '.js'
+        },
         combineWithRoot: true
     });
 
@@ -126,13 +127,16 @@ async function createRest(options) {
         let userDatabaseDetail = [];
         userDatabaseDetail = await Combination.combineModulesByFilePath({
             rootDirectory: options.componentDirectory,
-            filename: { name: 'db', extension: '.js' },
+            filename: {
+                name: 'db',
+                extension: '.js'
+            },
             combineWithRoot: true
         });
 
         // combine additional CollectionDefinitions
-        if (options.CollectionDefinitions) {
-            userDatabaseDetail.concat(options.CollectionDefinitions)
+        if (options.collectionDefinitions) {
+            userDatabaseDetail.concat(options.collectionDefinitions)
         }
 
         // Plug in user CollectionDefinitions
@@ -168,8 +172,9 @@ async function createRest(options) {
         if (options.onAfterInit) options.onAfterInit(app);
 
         //done
-        done({ app, server });
+        done({
+            app,
+            server
+        });
     });
-}
-
-module.exports = createRest;
+}