@modular-rest/server 1.3.3 → 1.4.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@modular-rest/server",
-  "version": "1.3.3",
+  "version": "1.4.1",
   "description": "a nodejs module based on KOAJS for developing Rest-APIs in a modular solution.",
   "main": "src/index.js",
   "scripts": {

package/src/application.js

@@ -12,8 +12,8 @@ let defaultServiceRoot = __dirname + '/services';
 /**
  * @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.
+ *   modulesPath: string; // Root directory of your router.js/db.js files.
+ *   staticPath: 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.
@@ -71,9 +71,9 @@ module.exports = async function createRest(options) {
     /**
      * Plug In KoaStatic
      */
-    if (options.uploadDirectory)
+    if (options.staticPath)
         app.use(koaStatic({
-            rootDir: options.uploadDirectory,
+            rootDir: options.staticPath,
             rootPath: '/assets/',
 
         }));
@@ -118,15 +118,15 @@ module.exports = async function createRest(options) {
      * 
      * Plug in routes and database
      */
-    if (options.componentDirectory) {
+    if (options.modulesPath) {
 
         // Plug in user routes
-        await Combination.combineRoutesByFilePath(options.componentDirectory, app);
+        await Combination.combineRoutesByFilePath(options.modulesPath, app);
 
         // Collect user CollectionDefinitions (db.js files)
         let userDatabaseDetail = [];
         userDatabaseDetail = await Combination.combineModulesByFilePath({
-            rootDirectory: options.componentDirectory,
+            rootDirectory: options.modulesPath,
             filename: {
                 name: 'db',
                 extension: '.js'

package/src/class/paginator.js

@@ -1,19 +1,30 @@
-function create(count, perPage, page)
-{
+/**
+ * Creates a pagination object based on the given parameters.
+ * @param {number} count - The total number of items to paginate.
+ * @param {number} perPage - The number of items to display per page.
+ * @param {number} page - The current page number.
+ * @returns {Object} - An object containing pagination information.
+ */
+function create(count, perPage, page) {
   let totalPgaes = Math.ceil(count / perPage);
-  if(page > totalPgaes) page = 1;
+  if (page > totalPgaes) page = 1;
 
   let from = 0;
-  if(perPage == 1) from = page-1;
+  if (perPage == 1) from = page - 1;
   else from = (perPage * page) - perPage;
 
-  if(page <= 1) from = 0;
-  
-  let result = {'pages':totalPgaes, 'page':page, 'from': from, 'to': perPage};
-  
+  if (page <= 1) from = 0;
+
+  let result = {
+    'pages': totalPgaes,
+    'page': page,
+    'from': from,
+    'to': perPage
+  };
+
   return result;
 };
 
 module.exports = {
-    create,
+  create,
 }

package/src/class/reply.js

@@ -1,13 +1,11 @@
-// generate structured respons json
-module.exports.create = function(status, detail={})
-{
-    /* result template
-    * status : "success", "fail", "error",
-    * data : {},
-    * error: {},
-    * message: "...",
-    * more detail
-    */
+/**
+ * Creates a response object with the given status and detail.
+ *
+ * @param {string} status - The status of the response. Can be "s" for success, "f" for fail, or "e" for error.
+ * @param {Object} [detail={}] - The detail of the response. Can contain any additional information about the response.
+ * @returns {Object} - The response object with the given status and detail.
+ */
+function create(status, detail = {}) {
 
     let result = detail || {};
 
@@ -20,7 +18,7 @@ module.exports.create = function(status, detail={})
         case 'f':
             result['status'] = 'fail';
             break;
-    
+
         case 'e':
             result['status'] = 'error';
             break;
@@ -32,4 +30,8 @@ module.exports.create = function(status, detail={})
 
     // return
     return result;
+}
+
+module.exports = {
+    create
 }

package/src/class/validator.js

@@ -1,5 +1,11 @@
-module.exports = function(obj, requiredFields)
-{
+/**
+ * Validates an object by checking if it contains all the required fields.
+ * @param {Object} obj - The object to be validated.
+ * @param {string|Object} requiredFields - The list of required fields. If it's a string, it should contain keys separated by spaces. If it's an object, it should contain key-value pairs where the key is the field name and the value is a boolean indicating whether the field is required or not.
+ * @returns {boolean} - Returns true if the object contains all the required fields, otherwise returns false.
+ * @throws {string} - Throws an error if the requiredFields parameter is not a string or an object.
+ */
+function validate(obj, requiredFields) {
     /*
         this method could validate an Object by given field's name list and return bool.
         - requiredFields: is a string that contains keys being spareted by " ".
@@ -7,18 +13,19 @@ module.exports = function(obj, requiredFields)
     let type = typeof requiredFields;
     let result;
 
-    if(type == 'string') 
+    if (type == 'string')
         result = ckeckSimple(obj, requiredFields);
-    else if(type == 'object')
+    else if (type == 'object')
         result = checkComplex(obj, requiredFields);
 
-    else throw('requiredFields has wrong form, it must be string or object');
+    else throw ('requiredFields has wrong form, it must be string or object');
 
     return result;
 }
 
-function ckeckSimple(obj, requiredFields='')
-{
+module.exports = validate;
+
+function ckeckSimple(obj, requiredFields = '') {
     let isValide = false;
     let requires = requiredFields.split(' ');
 
@@ -26,22 +33,20 @@ function ckeckSimple(obj, requiredFields='')
     let notValidKeys = [];
 
     // return if obj is null
-    if(obj == null) return _returnResult(isValide, requires);
+    if (obj == null) return _returnResult(isValide, requires);
 
-    requires.forEach(key =>
-    {
-        if (obj[key]) 
+    requires.forEach(key => {
+        if (obj[key])
             validMembers++;
         else notValidKeys.push(key);
     });
-        
+
     // check validation
     isValide = (requires.length == validMembers) ? true : false;
     return _returnResult(isValide, notValidKeys);
 }
 
-function checkComplex(obj, requiredFields={})
-{
+function checkComplex(obj, requiredFields = {}) {
     let isValide = false;
     let requireKeys = Object.keys(requiredFields);
 
@@ -49,38 +54,38 @@ function checkComplex(obj, requiredFields={})
     let notValidKeys = [];
 
     // return if obj is null
-    if(obj == null) return _returnResult(isValide, requireKeys);
+    if (obj == null) return _returnResult(isValide, requireKeys);
 
-    for (let i = 0; i < requireKeys.length; i++) 
-    {
+    for (let i = 0; i < requireKeys.length; i++) {
         const key = requireKeys[i];
         let isValidField = false;
 
         // if field has specific values
-        if(requiredFields[key].length > 0)
-        {
+        if (requiredFields[key].length > 0) {
             let expectedValues = requiredFields[key].split(' ');
 
-            if(typeof expectedValues != 'object')
-                throw(`${key} must be array of strings`);
+            if (typeof expectedValues != 'object')
+                throw (`${key} must be array of strings`);
 
             expectedValues.forEach(value => {
-                if(obj[key] == value) isValidField = true;
+                if (obj[key] == value) isValidField = true;
             })
         }
         // else does not has specific value
-        else if(obj[key] != null) isValidField = true;
+        else if (obj[key] != null) isValidField = true;
 
         if (isValidField) validMembers++;
         else notValidKeys.push(key);
     }
-        
+
     // check validation
     isValide = (requireKeys.length == validMembers) ? true : false;
     return _returnResult(isValide, notValidKeys);
 }
 
-function _returnResult(isValide, notValidKeys)
-{
-    return {'isValid': isValide, 'requires': notValidKeys};
+function _returnResult(isValide, notValidKeys) {
+    return {
+        'isValid': isValide,
+        'requires': notValidKeys
+    };
 }

package/src/index.js

@@ -6,7 +6,9 @@ const Schema = require('mongoose').Schema;
 const paginator = require('./class/paginator');
 const reply = require('./class/reply');
 const validator = require('./class/validator');
-const { getCollection } = require('./services/data_provider/service');
+const {
+    getCollection
+} = require('./services/data_provider/service');
 const TypeCasters = require('./services/data_provider/typeCasters');
 
 // Base class
@@ -20,11 +22,31 @@ const middleware = require('./middlewares');
 module.exports = {
     createRest,
 
+    //
     // Utilities
-    paginator, reply, validator,
-    getCollection, TypeCasters,
-
+    //
+    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
+     */
+    getCollection,
+
+    //
     // Base class
+    //
     CollectionDefinition,
     Schemas,
     Schema,
@@ -32,5 +54,4 @@ module.exports = {
 
     ...SecurityClass,
     middleware
-}
-
+}

package/src/services/data_provider/service.js

@@ -222,8 +222,8 @@ function performAdditionalOptionsToQueryObject(queryObj, options) {
 
 module.exports = {
     name,
-    addCollectionDefinitionByList,
     getCollection,
+    addCollectionDefinitionByList,
     checkAccess,
     getAsID,
     performPopulateToQueryObject,