@adaptivestone/framework 4.0.0 → 4.2.0

package/CHANGELOG.md

@@ -1,4 +1,14 @@
-### 4.0.0 - DEV
+### 4.2.0
+
+[UPDATE] updated deps
+[NEW] CreateUser cli command. Ability to update user by email or id.
+
+### 4.1.0
+
+[UPDATE] updated deps
+[NEW] email - Ability to render templae to string for future usage
+
+### 4.0.0
 
 [BREAKING] change bcrypt encryption with scrypt
 [BREAKING] change internal express parser to formidable parser. Affect you if external formidable is used
@@ -266,9 +276,8 @@ const someTypeSequence = await SequenceModel.getSequence('someType');
 // will be 2
 const someTypeSequence2 = await SequenceModel.getSequence('someType');
 // will be 1 as type is another
-const someAnotherTypeSequence = await SequenceModel.getSequence(
-  'someAnotherType',
-);
+const someAnotherTypeSequence =
+  await SequenceModel.getSequence('someAnotherType');
 ```
 
 #### 2.13.1

package/commands/CreateUser.js

@@ -4,21 +4,63 @@ const AbstractCommand = require('../modules/AbstractCommand');
 class CreateUser extends AbstractCommand {
   async run() {
     const User = this.app.getModel('User');
-    const { email, password, roles } = this.args;
+    const { id, email, password, roles, update } = this.args;
 
-    if (!email || !password) {
+    if (!email && !id) {
       this.logger.error('Input validation failded');
-      this.logger.error('Please add "email" and "password" variables');
+      this.logger.error('Please add "email" or "id" variables');
       return false;
     }
-    const user = await User.create({
-      email,
-      password,
-      roles: roles?.split(','),
-    });
+
+    let user;
+
+    if (id) {
+      user = await User.findOne({ _id: id });
+    } else if (email) {
+      user = await User.findOne({ email });
+    }
+
+    if (user && !update) {
+      this.logger.error(
+        'We are found a user in database. But "update" option is not providing. Exitin',
+      );
+      return false;
+    }
+
+    if (!user && !password) {
+      this.logger.error(
+        'For a new user we alway asking for a password. Please provide it and rerun command',
+      );
+      return false;
+    }
+
+    if (!user && !email) {
+      this.logger.error(
+        'For a new user we alway asking for a email. Please provide it and rerun command',
+      );
+      return false;
+    }
+
+    if (!user) {
+      user = new User();
+    }
+
+    if (password) {
+      user.password = password;
+    }
+    if (email) {
+      user.email = email;
+    }
+
+    if (roles) {
+      user.roles = roles.split(',');
+    }
+
+    await user.save();
+
     await user.generateToken();
 
-    this.logger.info(`User was created ${JSON.stringify(user, 0, 4)}`);
+    this.logger.info(`User was created/updated ${JSON.stringify(user, 0, 4)}`);
 
     return user;
   }

package/models/User.js

@@ -174,9 +174,8 @@ class User extends AbstractModel {
   }
 
   async sendPasswordRecoveryEmail(i18n) {
-    const passwordRecoveryToken = await User.generateUserPasswordRecoveryToken(
-      this,
-    );
+    const passwordRecoveryToken =
+      await User.generateUserPasswordRecoveryToken(this);
     const mail = new Mailer(
       this.constructor.getSuper().app,
       'recovery',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptivestone/framework",
-  "version": "4.0.0",
+  "version": "4.2.0",
   "description": "Adaptive stone node js framework",
   "main": "index.js",
   "engines": {
@@ -64,11 +64,11 @@
   "devDependencies": {
     "eslint": "^8.0.0",
     "eslint-config-airbnb-base": "^15.0.0",
-    "eslint-config-prettier": "^8.3.0",
+    "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-jest": "^27.0.0",
     "husky": "^8.0.0",
     "jest": "^29.0.0",
-    "lint-staged": "^13.0.0",
+    "lint-staged": "^14.0.0",
     "mongodb-memory-server": "^8.0.2",
     "nodemon": "^3.0.1",
     "prettier": "^3.0.0",

package/services/http/middleware/RateLimiter.test.js

@@ -1,6 +1,14 @@
 const RateLimiter = require('./RateLimiter');
 
 describe('rate limiter methods', () => {
+  it('have description fields', async () => {
+    expect.assertions(1);
+    const middleware = new RateLimiter(global.server.app, {
+      driver: 'redis',
+    });
+    expect(middleware.constructor.description).toBeDefined();
+  });
+
   it('can create redis rateLimiter', async () => {
     expect.assertions(1);
 

package/services/messaging/email/index.js

@@ -59,7 +59,7 @@ class Mail extends Base {
    * @param {object} templateData
    * @returns string
    */
-  static async #renderTemplate({ type, fullPath } = {}, templateData = {}) {
+  static async #renderTemplateFile({ type, fullPath } = {}, templateData = {}) {
     if (!type) {
       return null;
     }
@@ -79,13 +79,10 @@ class Mail extends Base {
   }
 
   /**
-   * Send email
-   * @param {string} to email send to
-   * @param {string} [from = mailConfig.from]
-   * @param {object} [aditionalNodemailerOptions = {}] additional option to nodemailer
+   * Render template
    * @return {Promise}
    */
-  async send(to, from = null, aditionalNodemailerOptions = {}) {
+  async renderTemplate() {
     const files = await fs.promises.readdir(this.template);
     const templates = {};
     for (const file of files) {
@@ -112,13 +109,19 @@ class Mail extends Base {
 
     const [htmlRendered, subjectRendered, textRendered, extraCss] =
       await Promise.all([
-        this.constructor.#renderTemplate(templates.html, templateDataToRender),
-        this.constructor.#renderTemplate(
+        this.constructor.#renderTemplateFile(
+          templates.html,
+          templateDataToRender,
+        ),
+        this.constructor.#renderTemplateFile(
           templates.subject,
           templateDataToRender,
         ),
-        this.constructor.#renderTemplate(templates.text, templateDataToRender),
-        this.constructor.#renderTemplate(templates.style),
+        this.constructor.#renderTemplateFile(
+          templates.text,
+          templateDataToRender,
+        ),
+        this.constructor.#renderTemplateFile(templates.style),
       ]);
 
     juice.tableElements = ['TABLE'];
@@ -130,13 +133,30 @@ class Mail extends Base {
       webResources: mailConfig.webResources,
       extraCss,
     });
+    return {
+      htmlRaw: htmlRendered,
+      subject: subjectRendered,
+      text: textRendered,
+      inlinedHTML,
+    };
+  }
+
+  /**
+   * Send email
+   * @param {string} to email send to
+   * @param {string} [from = mailConfig.from]
+   * @param {object} [aditionalNodemailerOptions = {}] additional option to nodemailer
+   * @return {Promise}
+   */
+  async send(to, from = null, aditionalNodemailerOptions = {}) {
+    const { subject, text, inlinedHTML } = await this.renderTemplate();
 
     return this.constructor.sendRaw(
       this.app,
       to,
-      subjectRendered,
+      subject,
       inlinedHTML,
-      textRendered,
+      text,
       from,
       aditionalNodemailerOptions,
     );