@modular-rest/server 1.6.5 → 1.7.0

package/src/services/user_manager/service.js

@@ -8,13 +8,19 @@ class UserManager {
   }
 
   /**
-   *
-   * @param {function} method a method that return random verification code
+   * Set a custom method for generating verification codes.
+   * @param {function} method - A method that returns a random verification code.
    */
   setCustomVerificationCodeGeneratorMethod(method) {
     this.verificationCodeGeneratorMethod = method;
   }
 
+  /**
+   * Generate a verification code.
+   * @param {string} id - The ID for which to generate the verification code.
+   * @param {string} idType - The type of the ID.
+   * @returns {string} The generated verification code.
+   */
   generateVerificationCode(id, idType) {
     if (this.verificationCodeGeneratorMethod)
       return this.verificationCodeGeneratorMethod(id, idType);
@@ -24,9 +30,10 @@ class UserManager {
   }
 
   /**
-   * Get a user by its Id.
-   *
-   * @param {string} id userid
+   * Get a user by their ID.
+   * @param {string} id - The ID of the user.
+   * @returns {Promise<User>} A promise that resolves to the user.
+   * @throws {string} If the user is not found.
    */
   getUserById(id) {
     return new Promise(async (done, reject) => {
@@ -39,7 +46,43 @@ class UserManager {
         .exec()
         .catch(reject);
 
-      if (!userDoc) reject("user not found");
+      if (!userDoc) {
+        reject("user not found");
+        return;
+      }
+
+      let user = User.loadFromModel(userDoc);
+      done(user);
+    });
+  }
+
+  /**
+   * Get a user by their identity.
+   * @param {string} id - The identity of the user.
+   * @param {string} idType - The type of the identity (phone or email).
+   * @returns {Promise<User>} A promise that resolves to the user.
+   * @throws {string} If the user is not found.
+   */
+  getUserByIdentity(id, idType) {
+    return new Promise(async (done, reject) => {
+      let userModel = DataProvider.getCollection("cms", "auth");
+
+      let query = {};
+
+      if (idType == "phone") query["phone"] = id;
+      else if (idType == "email") query["email"] = id;
+
+      let userDoc = await userModel
+        .findOne(query)
+        .select({ password: 0 })
+        .populate("permission")
+        .exec()
+        .catch(reject);
+
+      if (!userDoc) {
+        reject("user not found");
+        return;
+      }
 
       let user = User.loadFromModel(userDoc);
       done(user);
@@ -47,9 +90,10 @@ class UserManager {
   }
 
   /**
-   * Get user by token.
-   *
-   * @param {string} token auth token
+   * Get a user by their token.
+   * @param {string} token - The token of the user.
+   * @returns {Promise<User>} A promise that resolves to the user.
+   * @throws {string} If the user has a wrong permission.
    */
   getUserByToken(token) {
     return JWT.main.verify(token).then(async (payload) => {
@@ -67,10 +111,10 @@ class UserManager {
   }
 
   /**
-   * Define whether or not verification code is valid.
-   *
-   * @param {string} id auth id phone|email
-   * @param {string} code verification code
+   * Check if a verification code is valid.
+   * @param {string} id - The ID of the user.
+   * @param {string} code - The verification code.
+   * @returns {boolean} Whether the verification code is valid.
    */
   isCodeValid(id, code) {
     let key = false;
@@ -85,23 +129,24 @@ class UserManager {
   }
 
   /**
-   * Login and return user token.
-   *
-   * @param {string} id auth id phone|email
-   * @param {string} idType auth type phone|email
-   * @param {string} password
+   * Login a user and return their token.
+   * @param {string} id - The ID of the user.
+   * @param {string} idType - The type of the ID (phone or email).
+   * @param {string} password - The password of the user.
+   * @returns {Promise<string>} A promise that resolves to the token of the user.
+   * @throws {string} If the user is not found.
    */
   loginUser(id = "", idType = "", password = "") {
     let token;
 
     return new Promise(async (done, reject) => {
       // Get user model
-      let userModel = DataProvider.getCollection("cms", "auth");
+      const userModel = DataProvider.getCollection("cms", "auth");
 
       /**
        * Setup query to find by phone or email
        */
-      let query = {
+      const query = {
         password: Buffer.from(password).toString("base64"),
         type: "user",
       };
@@ -110,7 +155,7 @@ class UserManager {
       else if (idType == "email") query["email"] = id;
 
       // Get from database
-      let gottenFromDB = await userModel
+      const gottenFromDB = await userModel
         .findOne(query)
         .populate("permission")
         .exec()
@@ -120,11 +165,13 @@ class UserManager {
       // Token
       else {
         // Load user
-        let user = await User.loadFromModel(gottenFromDB).then().catch(reject);
+        const user = await User.loadFromModel(gottenFromDB)
+          .then()
+          .catch(reject);
 
         // Get token payload
         // This is some information about the user.
-        let payload = user.getBrief();
+        const payload = user.getBrief();
 
         // Generate json web token
         token = await JWT.main.sign(payload).then().catch(reject);
@@ -135,7 +182,40 @@ class UserManager {
   }
 
   /**
-   * Login as anonymous user
+   * Issue a token for a user.
+   * @param {string} email - The email of the user.
+   * @returns {Promise<string>} A promise that resolves to the token of the user.
+   * @throws {string} If the user is not found.
+   */
+  issueTokenForUser(email) {
+    return new Promise(async (done, reject) => {
+      const userModel = DataProvider.getCollection("cms", "auth");
+      const query = { email: email };
+
+      // Get from database
+      const gottenFromDB = await userModel
+        .findOne(query)
+        .populate("permission")
+        .exec()
+        .catch(reject);
+
+      if (!gottenFromDB) reject("user not found");
+
+      const user = await User.loadFromModel(gottenFromDB).then().catch(reject);
+
+      // Get token payload
+      // This is some information about the user.
+      const payload = user.getBrief();
+
+      // Generate json web token
+      await JWT.main.sign(payload).then(done).catch(reject);
+    });
+  }
+
+  /**
+   * Login as an anonymous user.
+   * @returns {Promise<string>} A promise that resolves to the token of the anonymous user.
+   * @throws {string} If the anonymous user is not found.
    */
   loginAnonymous() {
     let token;
@@ -180,16 +260,22 @@ class UserManager {
   }
 
   /**
-   * 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.
+   * Register a temporary ID.
+   * @param {string} id - The ID to register.
+   * @param {string} type - The type of the ID.
+   * @param {string} code - The verification code.
    */
   registerTemporaryID(id, type, code) {
     this.tempIds[id] = { id: id, type: type, code: code };
   }
 
+  /**
+   * Submit a password for a temporary ID.
+   * @param {string} id - The ID.
+   * @param {string} password - The password.
+   * @param {string} code - The verification code.
+   * @returns {Promise<boolean>} A promise that resolves to whether the operation was successful.
+   */
   async submitPasswordForTemporaryID(id, password, code) {
     let key = false;
 
@@ -213,6 +299,13 @@ class UserManager {
     return key;
   }
 
+  /**
+   * Change the password for a temporary ID.
+   * @param {string} id - The ID.
+   * @param {string} password - The new password.
+   * @param {string} code - The verification code.
+   * @returns {Promise<boolean>} A promise that resolves to whether the operation was successful.
+   */
   async changePasswordForTemporaryID(id, password, code) {
     let key = false;
 
@@ -231,6 +324,12 @@ class UserManager {
     return key;
   }
 
+  /**
+   * Register a user.
+   * @param {Object} detail - The details of the user.
+   * @returns {Promise<string>} A promise that resolves to the ID of the new user.
+   * @throws {string} If the user could not be registered.
+   */
   registerUser(detail) {
     return new Promise(async (done, reject) => {
       // get default permission
@@ -263,13 +362,23 @@ class UserManager {
     });
   }
 
+  /**
+   * Change the password of a user.
+   * @param {Object} query - The query to find the user.
+   * @param {string} newPass - The new password.
+   * @returns {Promise<void>} A promise that resolves when the operation is complete.
+   */
   changePassword(query, newPass) {
     let update = { $set: { password: newPass } };
     let authM = DataProvider.getCollection("cms", "auth");
     return authM.updateOne(query, update).exec().then();
   }
+
+  static get instance() {
+    return instance;
+  }
 }
 
-UserManager.instance = new UserManager();
+const instance = new UserManager();
 module.exports.name = "userManager";
 module.exports.main = UserManager.instance;

package/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "include": ["**/*.js"],
+  "compilerOptions": {
+    "declaration": true,
+    "emitDeclarationOnly": true,
+    "allowJs": true,
+    "outDir": "./types",
+    "checkJs": false
+  }
+}