@adaptivestone/framework 2.15.4 → 3.0.1

package/CHANGELOG.md

@@ -1,3 +1,75 @@
+### 3.0.1
+
+[UPDATE] update deps
+[UPDATE] getUserByTokens more logs
+
+### 3.0.0
+
+[BREAKING] Mongoose v6. Than a lot of changes:[mongoDB drive changes](https://github.com/mongodb/node-mongodb-native/blob/4.0/docs/CHANGES_4.0.0.md), [Mongoose changes](https://mongoosejs.com/docs/migrating_to_6.html).
+Notable changes from migration
+Removed `execPopulate()`[link](https://mongoosejs.com/docs/migrating_to_6.html#removed-execpopulate)
+
+```js
+// Document#populate() now returns a promise and is now no longer chainable.
+
+//Replace
+await doc.populate('path1').populate('path2').execPopulate();
+// with
+await doc.populate(['path1', 'path2']);
+//Replace
+await doc
+  .populate('path1', 'select1')
+  .populate('path2', 'select2')
+  .execPopulate();
+// with
+await doc.populate([
+  { path: 'path1', select: 'select1' },
+  { path: 'path2', select: 'select2' },
+]);
+```
+
+[REMOVED] removed deprecated router handler string not allowed anymore. Use functions by itself
+[REMOVED] removed deprecated someSecretSalt() on user model (use this.saltSecret instead)
+[REMOVED] removed deprecated validate() on abstract controller and as result validator dependency. Use request validators instead
+[REMOVED] removed deprecated isUseControllerNameForRouting() on abstract controller. Use getExpressPath() instead
+[REMOVED] removed deprecated Base.loadFilesWithInheritance please use getFilesPathWithInheritance that produce almost the same output
+[BREAKING] Removed "success" field on Auth contreoller. Please use http status instead
+[BREAKING] Auth controller - "error" error responce renamed to "message"
+
+```js
+// Before
+{
+  error: 'Some error';
+}
+// After
+{
+  message: 'Some error';
+}
+```
+
+[UPDATE] update deps
+[UPDATE] winston console transport now using timestapms
+[UPDATE] PrepareAppInfo middleware now a global one. Do not need to include it on every controller
+[NEW] Request anso works with req.query, but req.body have bigger priority
+
+### 2.18.0
+
+[UPDATE] update deps
+[UPDATE] replace body-parser with express.json
+[NEW] role middleware
+
+### 2.17.0
+
+[UPDATE] update deps
+[NEW] new env variable LOGGER_SENTRY_LEVEL (default=info)
+[NEW] new env variable LOGGER_CONSOLE_ENABLE (default=true)
+[BREAKING] on translation we changed i18next. Please convert files if you have plurals inside it https://i18next.github.io/i18next-v4-format-converter-web/
+
+#### 2.16.0
+
+[UPDATE] update deps
+[NEW] begin adding type script definitions
+
 #### 2.15.4
 
 [UPDATE] update deps

package/README.md

@@ -1 +1,3 @@
 # Adaptive stone node js framework
+
+[https://framework.adaptivestone.com/](https://framework.adaptivestone.com/)

package/commands/Documentation.js

@@ -0,0 +1,14 @@
+const AbstractCommand = require('../modules/AbstractCommand');
+const ControllerManager = require('../controllers/index');
+
+class Documentation extends AbstractCommand {
+  async run() {
+    const CM = new ControllerManager(this.app);
+    this.app.documentation = [];
+    await CM.initControllers({ folders: this.app.foldersConfig });
+    console.log(JSON.stringify(this.app.documentation));
+    return JSON.stringify(this.app.documentation);
+  }
+}
+
+module.exports = Documentation;

package/commands/DropIndex.js

@@ -1,6 +1,10 @@
 const AbstractCommand = require('../modules/AbstractCommand');
 
 class DropIndex extends AbstractCommand {
+  static get description() {
+    return 'Drop indexes of model';
+  }
+
   async run() {
     if (!this.args.model) {
       this.logger.error('Please provide model name as "--model=BestUserModel"');

package/commands/migration/Create.js

@@ -5,6 +5,10 @@ const fs = require('fs').promises;
 const AbstractCommand = require('../../modules/AbstractCommand');
 
 class CreateMigration extends AbstractCommand {
+  static get description() {
+    return 'Create new migration';
+  }
+
   async run() {
     if (!this.args.name) {
       return this.logger.error(

package/commands/migration/Migrate.js

@@ -2,6 +2,10 @@
 const AbstractCommand = require('../../modules/AbstractCommand');
 
 class Migrate extends AbstractCommand {
+  static get description() {
+    return 'Run all pending migrations';
+  }
+
   async run() {
     const files = await this.getFilesPathWithInheritance(
       `${__dirname}/../../migrations`,

package/config/http.js

@@ -1,7 +1,7 @@
 module.exports = {
   port: process.env.HTTP_PORT || 3300,
   hostname: process.env.HTTP_HOST || '0.0.0.0',
-  // if you watn to use 'all' domains please copy this file to your app
+  // if you want to use 'all' domains please copy this file to your app
   // and set "corsDomains: '*'" (not a mistake, string instead of array)
   corsDomains: ['http://localhost:3000'],
   myDomain: process.env.HTTP_DOMAIN || 'http://localhost:3300',

package/config/i18n.js

@@ -4,6 +4,6 @@ module.exports = {
   fallbackLng: 'en',
   // https://github.com/i18next/i18next-http-middleware#detector-options
   // in additional we have 'xLang' that detect language based on header 'xLang'
-  langDetectionOders: ['xLang'], // from oreder option
+  langDetectionOders: ['xLang'], // from order option
   lookupQuerystring: 'lng', // string to detect language on query
 };

package/config/log.js

@@ -4,9 +4,9 @@ module.exports = {
       transport: 'winston-transport-sentry-node',
       transportOptions: {
         sentry: {
-          dsn: process.env.SENTRY_DSN,
+          dsn: process.env.LOGGER_SENTRY_DSN || process.env.SENTRY_DSN,
         },
-        level: 'info',
+        level: process.env.LOGGER_SENTRY_LEVEL || 'info',
       },
       enable: process.env.LOGGER_SENTRY_ENABLE || false,
     },
@@ -14,8 +14,9 @@ module.exports = {
       transport: 'console',
       transportOptions: {
         level: process.env.LOGGER_CONSOLE_LEVEL || 'silly',
+        timestamp: true,
       },
-      enable: true,
+      enable: process.env.LOGGER_CONSOLE_ENABLE || true,
     },
   ],
 };

package/controllers/Auth.js

@@ -1,6 +1,5 @@
 const yup = require('yup');
 const AbstractController = require('../modules/AbstractController');
-const PrepareAppInfo = require('../services/http/middleware/PrepareAppInfo');
 const GetUserByToken = require('../services/http/middleware/GetUserByToken');
 const RateLimiter = require('../services/http/middleware/RateLimiter');
 
@@ -74,33 +73,31 @@ class Auth extends AbstractController {
       req.appInfo.request.password, // we do a request casting
     );
     if (!user) {
-      return res.status(400).json({ error: req.i18n.t('auth.errorUPValid') });
+      return res.status(400).json({ message: req.i18n.t('auth.errorUPValid') });
     }
     const { isAuthWithVefificationFlow } = this.app.getConfig('auth');
     if (isAuthWithVefificationFlow && !user.isVerified) {
       return res
         .status(400)
-        .json({ error: req.i18n.t('email.notVerified'), notVerified: true });
+        .json({ message: req.i18n.t('email.notVerified'), notVerified: true });
     }
     const token = await user.generateToken();
 
-    return res
-      .status(200)
-      .json({ success: true, token, user: user.getPublic() });
+    return res.status(200).json({ token, user: user.getPublic() });
   }
 
   async postRegister(req, res) {
     const User = req.appInfo.app.getModel('User');
     let user = await User.getUserByEmail(req.appInfo.request.email);
     if (user) {
-      return res.status(400).json({ error: req.i18n.t('email.registered') });
+      return res.status(400).json({ message: req.i18n.t('email.registered') });
     }
     if (req.appInfo.request.nickName) {
       user = await User.findOne({ 'name.nick': req.appInfo.request.nickName });
       if (user) {
         return res
           .status(400)
-          .json({ error: req.i18n.t('auth.nicknameExists') });
+          .json({ message: req.i18n.t('auth.nicknameExists') });
       }
     }
 
@@ -120,16 +117,16 @@ class Auth extends AbstractController {
         this.logger.error(e.message);
       });
       if (!answer) {
-        return res.status(500).json({ success: false });
+        return res.status(500).json();
       }
     }
-    return res.status(201).json({ success: true });
+    return res.status(201).json();
   }
 
   // eslint-disable-next-line class-methods-use-this
   async postLogout(req, res) {
     // todo remove token
-    return res.status(200).json({ success: true });
+    return res.status(200).json();
   }
 
   async verifyUser(req, res) {
@@ -141,21 +138,19 @@ class Auth extends AbstractController {
       );
     } catch (e) {
       return res.status(400).json({
-        success: false,
-        error: req.i18n.t('email.alreadyVerifiedOrWrongToken'),
+        message: req.i18n.t('email.alreadyVerifiedOrWrongToken'),
       });
     }
     this.logger.debug(`Verify user user is :${user}`);
     if (!user) {
       return res.status(400).json({
-        success: false,
-        error: req.i18n.t('email.alreadyVerifiedOrWrongToken'),
+        message: req.i18n.t('email.alreadyVerifiedOrWrongToken'),
       });
     }
 
     user.isVerified = true;
     await user.save();
-    return res.status(200).json({ success: true });
+    return res.status(200).json();
   }
 
   async sendPasswordRecoveryEmail(req, res) {
@@ -165,15 +160,13 @@ class Auth extends AbstractController {
       if (!user) {
         return res
           .status(400)
-          .json({ success: false, error: req.i18n.t('auth.errorUExist') });
+          .json({ message: req.i18n.t('auth.errorUExist') });
       }
       await user.sendPasswordRecoveryEmail(req.i18n);
-      return res.status(200).json({ success: true });
+      return res.status(200).json();
     } catch (e) {
       this.logger.error(e.message);
-      return res
-        .status(400)
-        .json({ success: false, error: req.i18n.t('auth.errorUExist') });
+      return res.status(400).json({ message: req.i18n.t('auth.errorUExist') });
     }
   }
 
@@ -190,7 +183,7 @@ class Auth extends AbstractController {
     if (!user) {
       return res
         .status(400)
-        .json({ success: false, error: req.i18n.t('password.wrongToken') });
+        .json({ message: req.i18n.t('password.wrongToken') });
     }
 
     this.logger.debug(`Password recovery user is :${user}`);
@@ -198,23 +191,21 @@ class Auth extends AbstractController {
     user.password = req.appInfo.request.password;
     user.isVerified = true;
     await user.save();
-    return res.status(200).json({ success: true });
+    return res.status(200).json();
   }
 
   async sendVerification(req, res) {
     const User = this.app.getModel('User');
     const user = await User.getUserByEmail(req.appInfo.request.email);
     if (!user) {
-      return res
-        .status(400)
-        .json({ success: false, error: req.i18n.t('auth.errorUExist') });
+      return res.status(400).json({ message: req.i18n.t('auth.errorUExist') });
     }
     await user.sendVerificationEmail(req.i18n);
-    return res.status(200).json({ success: true });
+    return res.status(200).json();
   }
 
   static get middleware() {
-    return new Map([['/*', [PrepareAppInfo, GetUserByToken, RateLimiter]]]);
+    return new Map([['/*', [GetUserByToken, RateLimiter]]]);
   }
 }
 

package/controllers/Auth.test.js

@@ -20,10 +20,8 @@ describe('auth', () => {
     });
 
     it('can create user', async () => {
-      expect.assertions(2);
-      const { status, body } = await request(
-        global.server.app.httpServer.express,
-      )
+      expect.assertions(1);
+      const { status } = await request(global.server.app.httpServer.express)
         .post('/auth/register')
         .send({
           email: userEmail,
@@ -31,7 +29,6 @@ describe('auth', () => {
           nickName: 'test',
         });
       expect(status).toBe(201);
-      expect(body.success).toBe(true);
     });
 
     it('can NOT create SAME user', async () => {
@@ -71,7 +68,7 @@ describe('auth', () => {
     });
 
     it('can login with normal creds and verifyed email', async () => {
-      expect.assertions(3);
+      expect.assertions(2);
 
       const user = await global.server.app
         .getModel('User')
@@ -88,14 +85,13 @@ describe('auth', () => {
           password: userPassword,
         });
       expect(status).toBe(200);
-      expect(body.success).toBe(true);
       expect(body.token).toBeDefined();
     });
   });
 
   describe('isAuthWithVefificationFlow auth option', () => {
     it('can login with normal creds and  NOT verifyed email is option isAuthWithVefificationFlow is set', async () => {
-      expect.assertions(5);
+      expect.assertions(4);
 
       const { status } = await request(global.server.app.httpServer.express)
         .post('/auth/register')
@@ -129,7 +125,6 @@ describe('auth', () => {
       expect(status).toBe(201);
       expect(status2).toBe(400);
       expect(status3).toBe(200);
-      expect(body.success).toBe(true);
       expect(body.token).toBeDefined();
     });
   });

package/controllers/Home.js

@@ -1,5 +1,4 @@
 const AbstractController = require('../modules/AbstractController');
-const PrepareAppInfo = require('../services/http/middleware/PrepareAppInfo');
 const GetUserByToken = require('../services/http/middleware/GetUserByToken');
 
 class Home extends AbstractController {
@@ -22,7 +21,7 @@ class Home extends AbstractController {
   }
 
   static get middleware() {
-    return new Map([['/*', [PrepareAppInfo, GetUserByToken]]]);
+    return new Map([['/*', [GetUserByToken]]]);
   }
 }
 

package/models/User.js

@@ -12,16 +12,6 @@ class User extends AbstractModel {
     this.saltSecret = authConfig.saltSecret;
   }
 
-  /**
-   * @deprecated
-   */
-  get someSecretSalt() {
-    this.logger.warn(
-      'someSecretSalt deprecatred and will be removed in future release. Please use "this.saltSecret" instead ',
-    );
-    return this.saltSecret;
-  }
-
   initHooks() {
     this.mongooseSchema.pre('save', async function () {
       if (this.isModified('password')) {
@@ -69,6 +59,7 @@ class User extends AbstractModel {
       verificationTokens: [{ until: Date, token: String }],
       passwordRecoveryTokens: [{ until: Date, token: String }],
       permissions: [],
+      roles: [],
       isVerified: { type: Boolean, default: false },
       locale: { type: String, default: 'en' },
       languages: [String],

package/modules/AbstractCommand.js

@@ -7,6 +7,10 @@ class AbstractCommand extends Base {
     this.commands = commands;
   }
 
+  static get description() {
+    return 'Command description';
+  }
+
   static get loggerGroup() {
     return 'command';
   }