@modular-rest/server 1.6.2 → 1.6.4

package/package.json

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

package/src/helper/data_insertion.js

@@ -1,21 +1,31 @@
-const DataProvider = require('../services/data_provider/service');
+const DataProvider = require("../services/data_provider/service");
 
 function createPermissions() {
-  let model = DataProvider.getCollection('cms', 'permission');
-  
-  return new Promise(async (done, reject) => {
+  let model = DataProvider.getCollection("cms", "permission");
 
+  return new Promise(async (done, reject) => {
     // create customer permission
-    let isAnonymousExisted = await model.countDocuments({ title: 'anonymous' }).exec().catch(reject);
-    let isCoustomerExisted = await model.countDocuments({ title: 'customer' }).exec().catch(reject);
-    let isAdministratorExisted = await model.countDocuments({ title: 'administrator' }).exec().catch(reject);
+    let isAnonymousExisted = await model
+      .countDocuments({ title: "anonymous" })
+      .exec()
+      .catch(reject);
+    let isCoustomerExisted = await model
+      .countDocuments({ title: "customer" })
+      .exec()
+      .catch(reject);
+    let isAdministratorExisted = await model
+      .countDocuments({ title: "administrator" })
+      .exec()
+      .catch(reject);
 
     if (!isAnonymousExisted) {
       await new model({
         anonymous_access: true,
         isAnonymous: true,
-        title: 'anonymous',
-      }).save().catch(reject);
+        title: "anonymous",
+      })
+        .save()
+        .catch(reject);
     }
 
     if (!isCoustomerExisted) {
@@ -25,8 +35,10 @@ function createPermissions() {
         upload_file_access: true,
         remove_file_access: true,
         isDefault: true,
-        title: 'customer',
-      }).save().catch(reject);
+        title: "customer",
+      })
+        .save()
+        .catch(reject);
     }
 
     if (!isAdministratorExisted) {
@@ -36,50 +48,61 @@ function createPermissions() {
         anonymous_access: true,
         upload_file_access: true,
         remove_file_access: true,
-        title: 'administrator',
-      }).save().catch(reject);
+        title: "administrator",
+      })
+        .save()
+        .catch(reject);
     }
 
     done();
   });
-
 }
 
-function createAdminUser({ email, password }) {
-  let permissionModel = DataProvider.getCollection('cms', 'permission');
-  let authModel = DataProvider.getCollection('cms', 'auth');
+async function createAdminUser({ email, password }) {
+  let permissionModel = DataProvider.getCollection("cms", "permission");
+  let authModel = DataProvider.getCollection("cms", "auth");
 
-  return new Promise(async (done, reject) => {
-    let isAnonymousExisted = await authModel.countDocuments({ type: 'anonymous' }).exec().catch(reject);
-    let isAdministratorExisted = await authModel.countDocuments({ type: 'user', email: email }).exec().catch(reject);
+  try {
+    let isAnonymousExisted = await authModel
+      .countDocuments({ type: "anonymous" })
+      .exec();
 
-    let anonymousPermission = await permissionModel.findOne({ title: 'anonymous' }).exec().catch(reject);
-    let administratorPermission = await permissionModel.findOne({ title: 'administrator' }).exec().catch(reject);
+    let isAdministratorExisted = await authModel
+      .countDocuments({ type: "user", email: email })
+      .exec();
 
-    if (!isAnonymousExisted) {
+    let anonymousPermission = await permissionModel
+      .findOne({ title: "anonymous" })
+      .exec();
+
+    let administratorPermission = await permissionModel
+      .findOne({ title: "administrator" })
+      .exec();
+
+    if (isAnonymousExisted == 0) {
       await new authModel({
         permission: anonymousPermission._id,
-        email: '',
-        phone: '',
-        password: '',
-        type: 'anonymous',
-      }).save().catch(reject);
+        email: "",
+        phone: "",
+        password: "",
+        type: "anonymous",
+      }).save();
     }
 
-    if (!isAdministratorExisted) {
+    if (isAdministratorExisted == 0) {
       await new authModel({
         permission: administratorPermission._id,
         email: email,
         password: password,
-        type: 'user'
-      }).save().catch(reject);
+        type: "user",
+      }).save();
     }
-
-    done();
-  });
+  } catch (e) {
+    return Promise.reject(e);
+  }
 }
 
 module.exports = {
   createPermissions,
   createAdminUser,
-};
+};

package/src/services/user_manager/db.js

@@ -35,38 +35,14 @@ let authSchema = new Schema({
   type: { type: String, default: "user", enum: ["user", "anonymous"] },
 });
 authSchema.index({ email: 1 }, { unique: true });
-
-authSchema
-  .virtual("base64Password")
-  .get(function () {
-    return Buffer.from(this.password, "base64").toString("utf-8");
-  })
-  .set(function (value) {
-    this.password = Buffer.from(value).toString("base64");
-  });
-
-// Middleware for encoding password on save and init
-authSchema.pre("save", function (next) {
+authSchema.pre(["save", "updateOne"], function (next) {
   // Encode the password before saving
   if (this.isModified("password")) {
-    this.base64Password = this.password;
+    this.password = Buffer.from(this.password).toString("base64");
   }
   next();
 });
 
-authSchema.pre("init", function (next) {
-  // Decode the password on init
-  this.password = this.base64Password;
-  next();
-});
-
-// Middleware for decoding password on findOne
-authSchema.post("findOne", function (doc) {
-  if (this._conditions.password) {
-    this._conditions.password = Buffer.from(value).toString("base64");
-  }
-});
-
 module.exports = [
   new CollectionDefinition({
     db: "cms",

package/src/services/user_manager/service.js

@@ -1,271 +1,275 @@
-let User = require('../../class/user');
-const DataProvider = require('../data_provider/service')
-const JWT = require('../jwt/service')
+let User = require("../../class/user");
+const DataProvider = require("../data_provider/service");
+const JWT = require("../jwt/service");
 
 class UserManager {
-
-    constructor() {
-        this.tempIds = {};
-    }
-
-    /**
-     * 
-     * @param {function} method a method that return random verification code
-     */
-    setCustomVerificationCodeGeneratorMethod(method) {
-        this.verificationCodeGeneratorMethod = method
-    }
-
-    generateVerificationCode(id, idType) {
-
-        if (this.verificationCodeGeneratorMethod)
-            return this.verificationCodeGeneratorMethod(id, idType)
-
-        // this is default code 
-        return '123'
-    }
-
-
-    /**
-     * Get a user by its Id.
-     * 
-     * @param {string} id userid
-     */
-    getUserById(id) {
-        return new Promise(async (done, reject) => {
-            let userModel = DataProvider.getCollection('cms', 'auth');
-
-            let userDoc = await userModel.findOne({ '_id': id }).select({ password: 0 })
-                .populate('permission').exec().catch(reject);
-
-            if (!userDoc) reject('user not found');
-
-            let user = User.loadFromModel(userDoc);
-            done(user);
-        })
-    }
-
-    /**
-     * Get user by token.
-     * 
-     * @param {string} token auth token
-     */
-    getUserByToken(token) {
-        return JWT.main.verify(token)
-            .then(async payload => {
-                let user = payload;
-                let permission = await DataProvider.getCollection('cms', 'permission')
-                    .findOne({ _id: user.permission }).exec().then();
-
-                if (!permission) throw ('user has a wrong permission');
-
-                user.permission = permission;
-                return user;
-            });
-    }
-
-    /**
-     * Define whether or not verification code is valid.
-     * 
-     * @param {string} id auth id phone|email
-     * @param {string} code verification code
-     */
-    isCodeValid(id, code) {
-        let key = false;
-
-        if (this.tempIds.hasOwnProperty(id) && this.tempIds[id].code.toString() === code.toString())
-            key = true;
-
-        return key;
-    }
-
-    /**
-     * Login and return user token.
-     * 
-     * @param {string} id auth id phone|email
-     * @param {string} idType auth type phone|email
-     * @param {string} password 
-     */
-    loginUser(id = '', idType = '', password = '') {
-        let token;
-
-        return new Promise(async (done, reject) => {
-
-            // Get user model
-            let userModel = DataProvider.getCollection('cms', 'auth');
-
-            /**
-             * Setup query to find by phone or email
-             */
-            let query = { 'password': password, type: "user" };
-
-            if (idType == 'phone') query['phone'] = id;
-            else if (idType == 'email') query['email'] = id;
-
-            // Get from database
-            let gottenFromDB = await userModel
-                .findOne(query).populate('permission')
-                .exec().catch(reject);
-
-            if (!gottenFromDB) reject('user not found');
-
-            // Token
-            else {
-
-                // Load user
-                let user = await User.loadFromModel(gottenFromDB)
-                    .then().catch(reject);
-
-                // Get token payload
-                // This is some information about the user.
-                let payload = user.getBrief();
-
-                // Generate json web token
-                token = await JWT.main.sign(payload)
-                    .then().catch(reject);
-
-                done(token);
-            }
-        });
-    }
-
-    /**
-     * Login as anonymous user
-     */
-    loginAnonymous() {
-        let token;
-
-        return new Promise(async (done, reject) => {
-
-            // Get user model
-            let userModel = DataProvider.getCollection('cms', 'auth');
-
-            // Setup query
-            let query = { 'type': 'anonymous' };
-
-            // Get from database
-            let gottenFromDB = await userModel
-                .findOne(query).populate('permission')
-                .exec().then().catch(reject);
-
-            // Create a new anonymous user if it doesn't exist.
-            // There are only one anonymous user in the database
-            // and every guest token being generated from it.
-            if (!gottenFromDB) {
-                let newUserId = await this.registerUser({ 'type': 'anonymous' }).catch(reject);
-                gottenFromDB = await this.getUserById(newUserId).catch(reject);
-            }
-
-            // load User
-            let user = await User.loadFromModel(gottenFromDB)
-                .then().catch(reject);
-
-            // Get token payload
-            // This is some information about the user.
-            let payload = user.getBrief();
-
-            // Generate json web token
-            token = await JWT.main.sign(payload)
-                .then().catch(reject);
-
-            done(token);
-        });
-    }
-
-    /**
-     * Store user email|phone temporarily in memory.
-     *  
-     * @param {string} id id is username or phone number
-     * @param {string} type type is the type of id
-     * @param {string} code code is a string being sent to user and he/she must return it back.
-     */
-    registerTemporaryID(id, type, code) {
-        this.tempIds[id] = { 'id': id, 'type': type, 'code': code };
-    }
-
-    async submitPasswordForTemporaryID(id, password, code) {
-        let key = false;
-
-        // If user email|phone has already stored
-        // a new user being created 
-        if (
-            this.tempIds.hasOwnProperty(id) &&
-            this.tempIds[id].code.toString() == code.toString()
-        ) {
-
-            let authDetail = { 'password': password };
-
-            if (this.tempIds[id].type == 'phone')
-                authDetail['phone'] = id;
-            else if (this.tempIds[id].type == 'email')
-                authDetail['email'] = id;
-
-            await this.registerUser(authDetail)
-                .then(() => key = true)
-                .catch((e) => console.log(e));
-        }
-
-        delete this.tempIds[id];
-        return key;
+  constructor() {
+    this.tempIds = {};
+  }
+
+  /**
+   *
+   * @param {function} method a method that return random verification code
+   */
+  setCustomVerificationCodeGeneratorMethod(method) {
+    this.verificationCodeGeneratorMethod = method;
+  }
+
+  generateVerificationCode(id, idType) {
+    if (this.verificationCodeGeneratorMethod)
+      return this.verificationCodeGeneratorMethod(id, idType);
+
+    // this is default code
+    return "123";
+  }
+
+  /**
+   * Get a user by its Id.
+   *
+   * @param {string} id userid
+   */
+  getUserById(id) {
+    return new Promise(async (done, reject) => {
+      let userModel = DataProvider.getCollection("cms", "auth");
+
+      let userDoc = await userModel
+        .findOne({ _id: id })
+        .select({ password: 0 })
+        .populate("permission")
+        .exec()
+        .catch(reject);
+
+      if (!userDoc) reject("user not found");
+
+      let user = User.loadFromModel(userDoc);
+      done(user);
+    });
+  }
+
+  /**
+   * Get user by token.
+   *
+   * @param {string} token auth token
+   */
+  getUserByToken(token) {
+    return JWT.main.verify(token).then(async (payload) => {
+      let user = payload;
+      let permission = await DataProvider.getCollection("cms", "permission")
+        .findOne({ _id: user.permission })
+        .exec()
+        .then();
+
+      if (!permission) throw "user has a wrong permission";
+
+      user.permission = permission;
+      return user;
+    });
+  }
+
+  /**
+   * Define whether or not verification code is valid.
+   *
+   * @param {string} id auth id phone|email
+   * @param {string} code verification code
+   */
+  isCodeValid(id, code) {
+    let key = false;
+
+    if (
+      this.tempIds.hasOwnProperty(id) &&
+      this.tempIds[id].code.toString() === code.toString()
+    )
+      key = true;
+
+    return key;
+  }
+
+  /**
+   * Login and return user token.
+   *
+   * @param {string} id auth id phone|email
+   * @param {string} idType auth type phone|email
+   * @param {string} password
+   */
+  loginUser(id = "", idType = "", password = "") {
+    let token;
+
+    return new Promise(async (done, reject) => {
+      // Get user model
+      let userModel = DataProvider.getCollection("cms", "auth");
+
+      /**
+       * Setup query to find by phone or email
+       */
+      let query = {
+        password: Buffer.from(password).toString("base64"),
+        type: "user",
+      };
+
+      if (idType == "phone") query["phone"] = id;
+      else if (idType == "email") query["email"] = id;
+
+      // Get from database
+      let gottenFromDB = await userModel
+        .findOne(query)
+        .populate("permission")
+        .exec()
+        .catch(reject);
+
+      if (!gottenFromDB) reject("user not found");
+      // Token
+      else {
+        // Load user
+        let user = await User.loadFromModel(gottenFromDB).then().catch(reject);
+
+        // Get token payload
+        // This is some information about the user.
+        let payload = user.getBrief();
+
+        // Generate json web token
+        token = await JWT.main.sign(payload).then().catch(reject);
+
+        done(token);
+      }
+    });
+  }
+
+  /**
+   * Login as anonymous user
+   */
+  loginAnonymous() {
+    let token;
+
+    return new Promise(async (done, reject) => {
+      // Get user model
+      let userModel = DataProvider.getCollection("cms", "auth");
+
+      // Setup query
+      let query = { type: "anonymous" };
+
+      // Get from database
+      let gottenFromDB = await userModel
+        .findOne(query)
+        .populate("permission")
+        .exec()
+        .then()
+        .catch(reject);
+
+      // Create a new anonymous user if it doesn't exist.
+      // There are only one anonymous user in the database
+      // and every guest token being generated from it.
+      if (!gottenFromDB) {
+        let newUserId = await this.registerUser({ type: "anonymous" }).catch(
+          reject
+        );
+        gottenFromDB = await this.getUserById(newUserId).catch(reject);
+      }
+
+      // load User
+      let user = await User.loadFromModel(gottenFromDB).then().catch(reject);
+
+      // Get token payload
+      // This is some information about the user.
+      let payload = user.getBrief();
+
+      // Generate json web token
+      token = await JWT.main.sign(payload).then().catch(reject);
+
+      done(token);
+    });
+  }
+
+  /**
+   * Store user email|phone temporarily in memory.
+   *
+   * @param {string} id id is username or phone number
+   * @param {string} type type is the type of id
+   * @param {string} code code is a string being sent to user and he/she must return it back.
+   */
+  registerTemporaryID(id, type, code) {
+    this.tempIds[id] = { id: id, type: type, code: code };
+  }
+
+  async submitPasswordForTemporaryID(id, password, code) {
+    let key = false;
+
+    // If user email|phone has already stored
+    // a new user being created
+    if (
+      this.tempIds.hasOwnProperty(id) &&
+      this.tempIds[id].code.toString() == code.toString()
+    ) {
+      let authDetail = { password: password };
+
+      if (this.tempIds[id].type == "phone") authDetail["phone"] = id;
+      else if (this.tempIds[id].type == "email") authDetail["email"] = id;
+
+      await this.registerUser(authDetail)
+        .then(() => (key = true))
+        .catch((e) => console.log(e));
     }
 
-    async changePasswordForTemporaryID(id, password, code) {
-        let key = false;
+    delete this.tempIds[id];
+    return key;
+  }
 
-        if (this.tempIds.hasOwnProperty(id)
-            && this.tempIds[id].code == code) {
-            let query = {};
+  async changePasswordForTemporaryID(id, password, code) {
+    let key = false;
 
-            if (this.tempIds[id].type == 'phone')
-                query['phone'] = id;
-            else if (this.tempIds[id].type == 'email')
-                query['email'] = id;
+    if (this.tempIds.hasOwnProperty(id) && this.tempIds[id].code == code) {
+      let query = {};
 
-            await this.changePassword(query, password)
-                .then(() => key = true)
-                .catch((e) => console.log(e));
-        }
+      if (this.tempIds[id].type == "phone") query["phone"] = id;
+      else if (this.tempIds[id].type == "email") query["email"] = id;
 
-        delete this.tempIds[id];
-        return key;
+      await this.changePassword(query, password)
+        .then(() => (key = true))
+        .catch((e) => console.log(e));
     }
 
-    registerUser(detail) {
-        return new Promise(async (done, reject) => {
-            // get default permission
-            let permissionId;
-            let perM = DataProvider.getCollection('cms', 'permission');
+    delete this.tempIds[id];
+    return key;
+  }
 
-            let pQuery = { isDefault: true };
+  registerUser(detail) {
+    return new Promise(async (done, reject) => {
+      // get default permission
+      let permissionId;
+      let perM = DataProvider.getCollection("cms", "permission");
 
-            if (detail.type == 'anonymous')
-                pQuery = { isAnonymous: true };
+      let pQuery = { isDefault: true };
 
-            await perM.findOne(pQuery, '_id').exec()
-                .then((doc) => permissionId = doc._id)
-                .catch(reject);
+      if (detail.type == "anonymous") pQuery = { isAnonymous: true };
 
-            detail.permission = permissionId;
+      await perM
+        .findOne(pQuery, "_id")
+        .exec()
+        .then((doc) => (permissionId = doc._id))
+        .catch(reject);
 
-            let authM = DataProvider.getCollection('cms', 'auth');
-            return User.createFromModel(authM, detail)
-                .then(newUser => {
-                    DataProvider.triggers
-                        .call('insertOne', 'cms', 'auth', { 'input': detail, 'output': newUser.dbModel });
+      detail.permission = permissionId;
 
-                    done(newUser.id);
-                })
-                .catch(reject);
-        });
-    }
+      let authM = DataProvider.getCollection("cms", "auth");
+      return User.createFromModel(authM, detail)
+        .then((newUser) => {
+          DataProvider.triggers.call("insertOne", "cms", "auth", {
+            input: detail,
+            output: newUser.dbModel,
+          });
 
-    changePassword(query, newPass) {
-        let update = { '$set': { 'password': newPass } };
-        let authM = DataProvider.getCollection('cms', 'auth');
-        return authM.updateOne(query, update).exec().then();
-    }
+          done(newUser.id);
+        })
+        .catch(reject);
+    });
+  }
+
+  changePassword(query, newPass) {
+    let update = { $set: { password: newPass } };
+    let authM = DataProvider.getCollection("cms", "auth");
+    return authM.updateOne(query, update).exec().then();
+  }
 }
 
-UserManager.instance = new UserManager()
-module.exports.name = 'userManager';
-module.exports.main = UserManager.instance;
+UserManager.instance = new UserManager();
+module.exports.name = "userManager";
+module.exports.main = UserManager.instance;