@modular-rest/server 1.10.0 → 1.10.2

package/package.json

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

package/src/application.js

@@ -14,6 +14,7 @@ const defaultServiceRoot = __dirname + "/services";
  * @typedef {import('http').Server} server
  * @typedef {import('@koa/cors').Options} Cors
  * @typedef {import('./class/security').PermissionGroup} PermissionGroup
+ * @typedef {import('./class/database_trigger.js')} DatabaseTrigger
  */
 
 const { config, setConfig } = require("./config");
@@ -55,6 +56,7 @@ const { config, setConfig } = require("./config");
  *   verificationCodeGeneratorMethod: () => string; // A method to return a verification code when registering a new user.
  *   collectionDefinitions?: CollectionDefinition[]; // An array of additional collection definitions.
  *   permissionGroups?: PermissionGroup[]; // An array of additional permission groups.
+ *   authTriggers?: DatabaseTrigger[]; // An array of additional database triggers for the auth collection.
  * }} options
  * @returns {Promise<{app: Koa, server: Server}>}
  */

package/src/class/collection_definition.js

@@ -14,9 +14,9 @@ class CollectionDefinition {
    * @param {string} option.collection - Collection name
    * @param {Object} option.schema - Mongoose schema
    * @param {Array<Permission>} option.permissions - A list of permissions for this collection
-   * @param {Array<DatabaseTrigger>=} option.trigger - A database trigger
+   * @param {Array<DatabaseTrigger>=} option.triggers - A database trigger
    */
-  constructor({ db, collection, schema, permissions, trigger }) {
+  constructor({ db, collection, schema, permissions, triggers }) {
     // string
     this.database = db;
     // string
@@ -26,7 +26,7 @@ class CollectionDefinition {
     // a list of Permission for this collection
     this.permissions = permissions;
 
-    this.trigger = trigger;
+    this.triggers = triggers;
   }
 }
 

package/src/class/database_trigger.js

@@ -7,10 +7,11 @@ class DatabaseTrigger {
   /**
    * Creates a new instance of `DatabaseTrigger`.
    *
-   * @param {'find' | 'find-one' | 'count' | 'update-one' | 'insert-one' | 'remove-one' | 'aggregate'} operation - The operation to be triggered. Supported operations are:
-   * @param {function(query, queryResult)} callback - The callback to be called when the operation is executed.
+   * @param {'find' | 'find-one' | 'count' | 'update-one' | 'insert-one' | 'remove-one' | 'aggregate'} operation - The operation to be triggered. Supported operations are: 'find', 'find-one', 'count', 'update-one', 'insert-one', 'remove-one', 'aggregate'.
+   * @param {function({query: any, queryResult: any}): void} [callback=(context) => {}] - The callback to be called when the operation is executed. The callback function takes an object as parameter with two properties: 'query' and 'queryResult'.
+   * @constructor
    */
-  constructor(operation, callback = (query, queryResult) => {}) {
+  constructor(operation, callback = (context) => {}) {
     this.operation = operation;
     this.callback = callback;
   }

package/src/class/trigger_operator.js

@@ -13,24 +13,21 @@ class TriggerOperator {
 
   /**
    * Call a trigger
-   * @param {string} operation operation name
+   * @param {'find' | 'find-one' | 'count' | 'update-one' | 'insert-one' | 'remove-one' | 'aggregate'} operation operation name
    * @param {string} database database name
    * @param {string} collection collection name
    * @param {string} data
    */
   call(operation, database, collection, data) {
-    let result;
-
     this.triggers.forEach((trigger) => {
       if (
         operation == trigger.operation &&
         database == trigger.database &&
-        collection == trigger.collection
+        collection == trigger.collection &&
+        trigger.callback
       )
-        result = trigger.callback(data.input, data.output);
+        trigger.callback(data);
     });
-
-    return result;
   }
 
   static get instance() {

package/src/config.js

@@ -3,6 +3,7 @@
  * @typedef {import('@koa/cors').Options} Cors
  * @typedef {import('./class/collection_definition')} CollectionDefinition
  * @typedef {import('./class/security').PermissionGroup} PermissionGroup
+ * @typedef {import('./class/database_trigger.js')} DatabaseTrigger
  */
 
 /**
@@ -41,10 +42,16 @@
  *   verificationCodeGeneratorMethod: () => string; // A method to return a verification code when registering a new user.
  *   collectionDefinitions?: CollectionDefinition[]; // An array of additional collection definitions.
  *   permissionGroups?: PermissionGroup[]; // An array of additional permission groups.
+ *   authTriggers?: DatabaseTrigger[]; // An array of additional database triggers for the auth collection.
  * }} Config
  * @exports Config
  */
 
+/**
+ * @type {Config}
+ */
+const config = {};
+
 /**
  * @param {Config} options
  */
@@ -52,11 +59,6 @@ function setConfig(options) {
   Object.assign(config, options);
 }
 
-/**
- * @type {Config}
- */
-const config = {};
-
 module.exports = {
   setConfig,
   config,

package/src/events.js

@@ -0,0 +1,15 @@
+const eventCallbacks = [];
+/**
+ * onBeforeInit: (koaApp:Koa) => void; // A callback called before initializing the Koa server.
+ * onAfterInit: (koaApp:Koa) => void; // A callback called after server initialization.
+ * onNewUser:
+ */
+
+function registerEventCallback(event, callback) {
+  if (typeof event !== "string") throw new Error("Event must be a string");
+
+  if (typeof callback !== "function")
+    throw new Error("Callback must be a function");
+
+  eventCallbacks.push({ event, callback });
+}

package/src/helper/data_insertion.js

@@ -4,6 +4,8 @@ const {
   getDefaultAdministratorPermissionGroup,
 } = require("../services/user_manager/permissionManager");
 
+const userManager = require("../services/user_manager/service");
+
 async function createAdminUser({ email, password }) {
   let authModel = DataProvider.getCollection("cms", "auth");
 
@@ -17,13 +19,20 @@ async function createAdminUser({ email, password }) {
       .exec();
 
     if (isAnonymousExisted == 0) {
-      await new authModel({
-        permission: getDefaultAnonymousPermissionGroup().title,
+      await userManager.main.registerUser({
+        permissionGroup: getDefaultAnonymousPermissionGroup().title,
         email: "",
         phone: "",
         password: "",
         type: "anonymous",
-      }).save();
+      });
+      // await new authModel({
+      //   permission: getDefaultAnonymousPermissionGroup().title,
+      //   email: "",
+      //   phone: "",
+      //   password: "",
+      //   type: "anonymous",
+      // }).save();
     }
 
     if (isAdministratorExisted == 0) {
@@ -31,12 +40,19 @@ async function createAdminUser({ email, password }) {
         return Promise.reject("Invalid email or password for admin user.");
       }
 
-      await new authModel({
-        permission: getDefaultAdministratorPermissionGroup().title,
+      await userManager.main.registerUser({
+        permissionGroup: getDefaultAdministratorPermissionGroup().title,
         email: email,
         password: password,
         type: "user",
-      }).save();
+      });
+
+      // await new authModel({
+      //   permission: getDefaultAdministratorPermissionGroup().title,
+      //   email: email,
+      //   password: password,
+      //   type: "user",
+      // }).save();
     }
   } catch (e) {
     return Promise.reject(e);

package/src/services/data_provider/service.js

@@ -35,7 +35,6 @@ function connectToDatabaseByCollectionDefinitionList(
     colog.info(`- Connecting to database ${connectionString}`);
 
     let connection = Mongoose.createConnection(connectionString, {
-      ...mongoOption,
       useUnifiedTopology: true,
       useNewUrlParser: true,
     });
@@ -67,8 +66,16 @@ function connectToDatabaseByCollectionDefinitionList(
       });
 
       // add trigger
-      if (collectionDefinition.trigger != undefined) {
-        triggers.addTrigger(collectionDefinition.trigger);
+      if (collectionDefinition.triggers != undefined) {
+        if (!Array.isArray(collectionDefinition.triggers)) {
+          throw "Triggers must be an array";
+        }
+
+        collectionDefinition.triggers.forEach((trigger) => {
+          trigger.database = collectionDefinition.database;
+          trigger.collection = collectionDefinition.collection;
+          triggers.addTrigger(trigger);
+        });
       }
     });
 
@@ -185,7 +192,7 @@ function checkAccess(db, collection, operationType, queryOrDoc, user) {
     } else if (operationType == AccessTypes.read && permission.read) {
       key = user.hasPermission(collectionPermissionType);
     } else if (operationType == AccessTypes.write && permission.write) {
-      key = user.permission[collectionPermissionType];
+      key = user.hasPermission(collectionPermissionType);
     }
   });
 

package/src/services/user_manager/db.js

@@ -3,6 +3,8 @@ var Schema = mongoose.Schema;
 
 let CollectionDefinition = require("../../class/collection_definition");
 let { Permission, PermissionTypes } = require("../../class/security");
+const { config } = require("../../config");
+const triggerOperator = require("./../../class/trigger_operator");
 
 let authSchema = new Schema({
   permissionGroup: String,
@@ -21,6 +23,46 @@ authSchema.pre(["save", "updateOne"], function (next) {
   next();
 });
 
+authSchema.post("save", function (doc, next) {
+  triggerOperator.call("insert-one", "cms", "auth", {
+    query: null,
+    queryResult: doc._doc,
+  });
+  next();
+});
+
+authSchema.post("findOneAndUpdate", function (doc, next) {
+  triggerOperator.call("update-one", "cms", "auth", {
+    query: null,
+    queryResult: doc._doc,
+  });
+  next();
+});
+
+authSchema.post("updateOne", function (result, next) {
+  triggerOperator.call("update-one", "cms", "auth", {
+    query: null,
+    queryResult: doc._doc,
+  });
+  next();
+});
+
+authSchema.post("findOneAndDelete", function (doc, next) {
+  triggerOperator.call("remove-one", "cms", "auth", {
+    query: null,
+    queryResult: doc._doc,
+  });
+  next();
+});
+
+authSchema.post("deleteOne", function (result, next) {
+  triggerOperator.call("remove-one", "cms", "auth", {
+    query: null,
+    queryResult: doc._doc,
+  });
+  next();
+});
+
 module.exports = [
   new CollectionDefinition({
     db: "cms",
@@ -33,5 +75,6 @@ module.exports = [
         write: true,
       }),
     ],
+    triggers: config.authTriggers || [],
   }),
 ];

package/src/services/user_manager/service.js

@@ -1,8 +1,13 @@
-let User = require("../../class/user");
+const User = require("../../class/user");
 const DataProvider = require("../data_provider/service");
 const JWT = require("../jwt/service");
 const { getDefaultPermissionGroups } = require("./permissionManager");
 
+/**
+ * import user type
+ * @typedef {import('../../class/user')} User
+ */
+
 class UserManager {
   constructor() {
     this.tempIds = {};
@@ -93,8 +98,9 @@ class UserManager {
    * @param {string} token - The token of the user.
    * @returns {Promise<User>} A promise that resolves to the user.
    */
-  getUserByToken(token) {
-    return JWT.main.verify(token);
+  async getUserByToken(token) {
+    const { id } = await JWT.main.verify(token);
+    return this.getUserById(id);
   }
 
   /**
@@ -311,7 +317,9 @@ class UserManager {
   registerUser(detail) {
     return new Promise(async (done, reject) => {
       // get default permission
-      detail.permissionGroup = getDefaultPermissionGroups().title;
+      if (!detail.permissionGroup) {
+        detail.permissionGroup = getDefaultPermissionGroups().title;
+      }
 
       if (!detail.permissionGroup) {
         reject("default permission group not found");