@adaptivestone/framework 5.0.0-alpha.9 → 5.0.0-beta.10

package/CHANGELOG.md

@@ -1,3 +1,125 @@
+### 5.0.0-beta.9
+
+[BREAKING] move email module to separate package @adaptivestone/framework-module-email. Please use it if you want to send emails
+[NEW] app now contains 'frameworkFolder' folder the framework located. Mostly for modules usage
+[BREAKING] remove VIEWS folders at all. Should not afffect any user as this was not used internally
+[UPDATE] update typing
+[UPDATE] change redis -> @redis/client as we are using only client from pakage
+[BREAKING] removed noidemailer-sendmail-transport. Not needed anymore and not recommended to use as well
+
+### 5.0.0-beta.8
+
+[UPDATE] update deps
+[NEW] Lock model for working locks via mongoDB
+
+### 5.0.0-beta.7
+
+[UPDATE] update deps
+[UPDATE] change vitest shutdown behavior as mongo driver v6.13 change befaviur that affect us (MongoClient.close now closes any outstanding cursors)
+
+### 5.0.0-beta.5
+
+[BREAKING] remove minimist CLI parsing and replace it by commandArguments parser
+[UPDATE] migrated from eslint-plugin-import to eslint-plugin-import-x
+
+### 5.0.0-beta.5
+
+[UPDATE] migrate to eslint 9 and away from aibnb styles (they are abonded)
+
+### 5.0.0-beta.4
+
+[NEW] on shutdown event now after timeout we are forcing to shutdown
+
+### 5.0.0-beta.2
+
+[UPDATE] update deps
+[NEW] add ability to skip mongo model init in CLI env
+[NEW] now each mongo connection on CLI have own name and inslude command name there too (getMongoConnectionName in command)
+
+### 5.0.0-beta.1
+
+[UPDATE] update deps
+[BREAKING] vitest v3 https://vitest.dev/guide/migration.html
+
+### 5.0.0-alpha.26
+
+[UPDATE] update deps
+[UPDATE] new commands view in CLI
+
+### 5.0.0-alpha.24
+
+[UPDATE] update deps
+[BREAKING] i18next v24 https://www.i18next.com/misc/migration-guide#v23.x.x-to-v24.0.0
+
+### 5.0.0-alpha.23
+
+[UPDATE] update deps
+
+### 5.0.0-alpha.22
+
+[UPDATE] update deps
+[FIX] fix optional routing parameters
+
+### 5.0.0-alpha.21
+
+[BREAKING] possible breaking. Framework start using express 5 instead of express 4. Please follow express migration guide too https://expressjs.com/en/guide/migrating-5.html.
+[BREAKING] AS part of express 5 migration _ in rotes (middlewares) should have perameter. please replace _ to \*splat
+[UPDATE] update deps
+[UPDATE] Mailer uses await import() for startup speedup
+
+### 5.0.0-alpha.20
+
+[UPDATE] update deps
+[UPDATE] #realLogger do not throw error in a scecific cases (model toJSON({virtual:true}))
+
+### 5.0.0-alpha.19
+
+[NEW] added modelSchemaOptions for models
+
+### 5.0.0-alpha.18
+
+[BREAKING] default auth responce changed to be unified. {token, user} = > {data:{token, user}}
+[UPDATE] RateLimiter updae key generation
+
+### 5.0.0-alpha.17
+
+[NEW] generateRandomBytes command
+[UPDATE] update deps
+
+### 5.0.0-alpha.16
+
+[UPDATE] no warning of direct usage body and query
+[UPDATE] update deps
+
+### 5.0.0-alpha.15
+
+[BUG] fix bug with pagination
+[UPDATE] update deps
+
+### 5.0.0-alpha.14
+
+[NEW] add types for Abstract model (wip)
+
+### 5.0.0-alpha.13
+
+[UPDATE] update deps
+[UPDATE] update i18n internal implementation
+[CHANGE] disable https server view
+
+### 5.0.0-alpha.12
+
+[UPDATE] update deps
+
+### 5.0.0-alpha.11
+
+[UPDATE] update deps
+
+### 5.0.0-alpha.10
+
+[UPDATE] update deps
+[NEW] IpDetector middleware that support detecting proxy and X-Forwarded-For header
+[BREAKING] RateLimiter now need to have IpDetector middleware before
+
 ### 5.0.0-alpha.9
 
 [UPDATE] update deps
@@ -368,7 +490,7 @@ await doc.populate([
 [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
+[NEW] Request also works with req.query, but req.body have bigger priority
 
 ### 2.18.0
 

package/Cli.js

@@ -1,4 +1,3 @@
-import parseArgs from 'minimist';
 import mongoose from 'mongoose';
 import BaseCli from './modules/BaseCli.js';
 import Server from './server.js';
@@ -8,14 +7,14 @@ class Cli extends BaseCli {
     mongoose.set('autoIndex', false); // we do not need create indexes on CLI.
     const server = new Server(serverConfig);
     super(server);
-    this.args = parseArgs(process.argv.slice(3));
   }
 
   async run() {
-    await this.server.init();
+    await this.server.init({ isSkipModelInit: true, isSkipModelLoading: true });
     const command = process.argv[2]?.toLowerCase();
-    await super.run(command, this.args);
+    await super.run(command);
     this.app.events.emit('shutdown');
+    return true;
   }
 }
 

package/cluster.js

@@ -4,7 +4,6 @@ import { cpus } from 'node:os';
 const numCPUs = cpus().length;
 
 if (cluster.isPrimary) {
-  // eslint-disable-next-line no-console
   console.log(`Master ${process.pid} is running`);
   // Fork workers.
   for (let i = 0; i < numCPUs; i += 1) {
@@ -12,7 +11,6 @@ if (cluster.isPrimary) {
   }
 
   cluster.on('exit', (worker, code, signal) => {
-    // eslint-disable-next-line no-console
     console.log(
       `Worker \x1B[45m ${
         worker.process.pid

package/commands/CreateUser.js

@@ -2,6 +2,41 @@ import AbstractCommand from '../modules/AbstractCommand.js';
 
 // Example: node src/cli createuser --email=somemail@gmail.com  --password=somePassword --roles=user,admin,someOtherRoles
 class CreateUser extends AbstractCommand {
+  static get description() {
+    return 'Create user in a database';
+  }
+
+  /**
+   * You able to add command arguments for parsing there.
+   * @returns {import("../types/ICommandArguments.js").ICommandArguments}
+   */
+  static get commandArguments() {
+    return {
+      id: {
+        type: 'string',
+        description: 'User id to find user',
+      },
+      email: {
+        type: 'string',
+        description: 'User id to find/create user',
+      },
+      password: {
+        type: 'string',
+        description: 'New password for user',
+      },
+      roles: {
+        type: 'string',
+        description:
+          'User roles comma separated string (--roles=user,admin,someOtherRoles)',
+      },
+      update: {
+        type: 'boolean',
+        default: false,
+        description: 'Update user if it exists',
+      },
+    };
+  }
+
   async run() {
     const User = this.app.getModel('User');
     const { id, email, password, roles, update } = this.args;

package/commands/Documentation.js

@@ -2,6 +2,10 @@ import AbstractCommand from '../modules/AbstractCommand.js';
 import ControllerManager from '../controllers/index.js';
 
 class Documentation extends AbstractCommand {
+  static get description() {
+    return 'Generate documentation (internal)';
+  }
+
   async run() {
     const CM = new ControllerManager(this.app);
     this.app.documentation = [];

package/commands/DropIndex.js

@@ -5,12 +5,21 @@ class DropIndex extends AbstractCommand {
     return 'Drop indexes of model';
   }
 
-  async run() {
-    if (!this.args.model) {
-      this.logger.error('Please provide model name as "--model=BestUserModel"');
-      return false;
-    }
+  /**
+   * You able to add command arguments for parsing there.
+   * @returns {import("../types/ICommandArguments.js").ICommandArguments}
+   */
+  static get commandArguments() {
+    return {
+      model: {
+        type: 'string',
+        description: 'Model name',
+        required: true,
+      },
+    };
+  }
 
+  async run() {
     const Model = this.app.getModel(this.args.model);
 
     if (!Model) {

package/commands/GenerateRandomBytes.js

@@ -0,0 +1,21 @@
+import { randomBytes } from 'node:crypto';
+import AbstractCommand from '../modules/AbstractCommand.js';
+
+class GenerateRandomBytes extends AbstractCommand {
+  static get description() {
+    return 'Generate random bytes ising randomBytes from  node:crypto';
+  }
+
+  static isShouldInitModels = false;
+
+  async run() {
+    const sizes = [16, 32, 64, 128, 256];
+    for (const size of sizes) {
+      const bytes = randomBytes(size).toString('hex');
+      this.logger.info(`${size} bytes: ${bytes}`);
+    }
+    return true;
+  }
+}
+
+export default GenerateRandomBytes;

package/commands/GetOpenApiJson.js

@@ -5,6 +5,22 @@ import AbstractCommand from '../modules/AbstractCommand.js';
  * Command for generate documentation json file openApi
  */
 class GetOpenApiJson extends AbstractCommand {
+  static get description() {
+    return 'Generate documentation (openApi) ';
+  }
+  /**
+   * You able to add command arguments for parsing there.
+   * @returns {import("../types/ICommandArguments.js").ICommandArguments}
+   */
+  static get commandArguments() {
+    return {
+      output: {
+        type: 'string',
+        description: 'Output file path',
+      },
+    };
+  }
+
   async run() {
     const { myDomain } = this.app.getConfig('http');
     let jsonFile = process.env.npm_package_json;
@@ -14,7 +30,7 @@ class GetOpenApiJson extends AbstractCommand {
 
     try {
       jsonFile = JSON.parse(await fs.readFile(jsonFile, 'utf8'));
-    } catch (e) {
+    } catch {
       this.logger.error(
         'No npm package detected. Please start this command via NPM as it depends on package.json',
       );
@@ -119,7 +135,6 @@ class GetOpenApiJson extends AbstractCommand {
 
         let routeName = Object.keys(route)[0];
         if (routeName === '/') {
-          // eslint-disable-next-line no-continue
           continue;
         }
 

package/commands/SyncIndexes.js

@@ -29,6 +29,7 @@ class SyncIndexes extends AbstractCommand {
         this.logger.info(`Model - ${modelName} NO removed indexes`);
       }
     }
+    return true;
   }
 
   static get description() {

package/commands/migration/Create.js

@@ -7,28 +7,39 @@ class CreateMigration extends AbstractCommand {
     return 'Create new migration';
   }
 
+  /**
+   * You able to add command arguments for parsing there.
+   * @returns {import("../../types/ICommandArguments.js").ICommandArguments}
+   */
+  static get commandArguments() {
+    return {
+      name: {
+        type: 'string',
+        description: 'Migration name',
+        required: true,
+      },
+    };
+  }
+
   async run() {
-    if (!this.args.name) {
-      return this.logger.error(
-        'Please provide migration name with key "--name={someName}"',
-      );
-    }
     if (this.args.name.match(/^\d/)) {
-      return this.logger.error('Command cant start from nubmer');
+      this.logger.error('Command cant start from nubmer');
+      return false;
     }
-    const fileName = `${Date.now()}_${this.constructor.camelSentence(
+    const fileName = `${Date.now()}_${CreateMigration.camelSentence(
       this.args.name,
     )}.js`;
 
-    const fileContent = this.constructor.getTemplate(
-      this.constructor.camelSentence(this.args.name),
+    const fileContent = CreateMigration.getTemplate(
+      CreateMigration.camelSentence(this.args.name),
     );
 
     await fs.writeFile(
       path.join(this.app.foldersConfig.migrations, fileName),
       fileContent,
     );
-    return this.logger.info(`Migration created ${fileName}`);
+    this.logger.info(`Migration created ${fileName}`);
+    return true;
   }
 
   static camelSentence(str) {

package/commands/migration/Migrate.js

@@ -49,6 +49,7 @@ class Migrate extends AbstractCommand {
     this.logger.info(
       `=== Migration Finished. Migrated ${migrations.length} files ===`,
     );
+    return true;
   }
 }
 

package/config/auth.js

@@ -1,6 +1,9 @@
 export default {
   hashRounds: 64,
   saltSecret:
-    process.env.AUTH_SALT || console.error('AUTH_SALT is not defined'),
+    process.env.AUTH_SALT ||
+    console.error(
+      'AUTH_SALT is not defined. You can "npm run cli generateRandomBytes" and use it',
+    ),
   isAuthWithVefificationFlow: true,
 };

package/config/ipDetector.js

@@ -0,0 +1,14 @@
+export default {
+  headers: ['X-Forwarded-For'],
+  trustedProxy: [
+    // list of trusted proxies.
+    '169.254.0.0/16', // linklocal
+    'fe80::/10', // linklocal
+    '127.0.0.1/8', // loopback
+    '::1/128', // loopback
+    '10.0.0.0/8', // uniquelocal
+    '172.16.0.0/12', // uniquelocal
+    '192.168.0.0/16', // uniquelocal
+    'fc00::/7', // uniquelocal
+  ],
+};

package/controllers/Auth.js

@@ -1,4 +1,4 @@
-import yup from 'yup';
+import { object, string } from 'yup';
 import AbstractController from '../modules/AbstractController.js';
 import GetUserByToken from '../services/http/middleware/GetUserByToken.js';
 import RateLimiter from '../services/http/middleware/RateLimiter.js';
@@ -9,58 +9,52 @@ class Auth extends AbstractController {
       post: {
         '/login': {
           handler: this.postLogin,
-          request: yup.object().shape({
-            email: yup.string().email().required('auth.emailProvided'), // if not provided then error will be generated
-            password: yup.string().required('auth.passwordProvided'), // possible to provide values from translation
+          request: object().shape({
+            email: string().email().required('auth.emailProvided'), // if not provided then error will be generated
+            password: string().required('auth.passwordProvided'), // possible to provide values from translation
           }),
         },
         '/register': {
           handler: this.postRegister,
-          request: yup.object().shape({
-            email: yup
-              .string()
+          request: object().shape({
+            email: string()
               .email('auth.emailValid')
               .required('auth.emailProvided'),
-            password: yup
-              .string()
+            password: string()
               .matches(
                 /^[a-zA-Z0-9!@#$%ˆ^&*()_+\-{}[\]<>]+$/,
                 'auth.passwordValid',
               )
               .required('auth.passwordProvided'),
-            nickName: yup
-              .string()
-              .matches(/^[a-zA-Z0-9_\-.]+$/, 'auth.nickNameValid'),
-            firstName: yup.string(),
-            lastName: yup.string(),
+            nickName: string().matches(
+              /^[a-zA-Z0-9_\-.]+$/,
+              'auth.nickNameValid',
+            ),
+            firstName: string(),
+            lastName: string(),
           }),
         },
         '/logout': this.postLogout,
         '/verify': this.verifyUser,
         '/send-recovery-email': {
           handler: this.sendPasswordRecoveryEmail,
-          request: yup
-            .object()
-            .shape({ email: yup.string().email().required() }),
+          request: object().shape({ email: string().email().required() }),
         },
         '/recover-password': {
           handler: this.recoverPassword,
-          request: yup.object().shape({
-            password: yup
-              .string()
+          request: object().shape({
+            password: string()
               .matches(
                 /^[a-zA-Z0-9!@#$%ˆ^&*()_+\-{}[\]<>]+$/,
                 'auth.passwordValid',
               )
               .required(),
-            passwordRecoveryToken: yup.string().required(),
+            passwordRecoveryToken: string().required(),
           }),
         },
         '/send-verification': {
           handler: this.sendVerification,
-          request: yup
-            .object()
-            .shape({ email: yup.string().email().required() }),
+          request: object().shape({ email: string().email().required() }),
         },
       },
     };
@@ -83,7 +77,7 @@ class Auth extends AbstractController {
     }
     const token = await user.generateToken();
 
-    return res.status(200).json({ token, user: user.getPublic() });
+    return res.status(200).json({ data: { token, user: user.getPublic() } });
   }
 
   async postRegister(req, res) {
@@ -113,12 +107,9 @@ class Auth extends AbstractController {
 
     const { isAuthWithVefificationFlow } = this.app.getConfig('auth');
     if (isAuthWithVefificationFlow) {
-      const answer = await user.sendVerificationEmail(req.i18n).catch((e) => {
+      await user.sendVerificationEmail(req.i18n).catch((e) => {
         this.logger.error(e);
       });
-      if (!answer) {
-        return res.status(500).json();
-      }
     }
     return res.status(201).json();
   }
@@ -136,7 +127,7 @@ class Auth extends AbstractController {
       user = await User.getUserByVerificationToken(
         req.query.verification_token,
       );
-    } catch (e) {
+    } catch {
       return res.status(400).json({
         message: req.i18n.t('email.alreadyVerifiedOrWrongToken'),
       });
@@ -203,7 +194,7 @@ class Auth extends AbstractController {
   }
 
   static get middleware() {
-    return new Map([['/*', [GetUserByToken, RateLimiter]]]);
+    return new Map([['/{*splat}', [GetUserByToken, RateLimiter]]]);
   }
 }
 

package/controllers/Home.js

@@ -21,7 +21,7 @@ class Home extends AbstractController {
   }
 
   static get middleware() {
-    return new Map([['/*', [GetUserByToken]]]);
+    return new Map([['/{*splat}', [GetUserByToken]]]);
   }
 }
 

package/eslint.config.js

@@ -0,0 +1,68 @@
+import globals from 'globals';
+import pluginJs from '@eslint/js';
+import importPlugin from 'eslint-plugin-import-x';
+import vitest from '@vitest/eslint-plugin';
+import eslintConfigPrettier from 'eslint-config-prettier';
+import prettierPlugin from 'eslint-plugin-prettier/recommended';
+
+/** @type {import('eslint').Linter.Config[]} */
+// @ts-ignore
+export default [
+  pluginJs.configs.recommended,
+  importPlugin.flatConfigs.recommended,
+  eslintConfigPrettier,
+  prettierPlugin,
+  {
+    languageOptions: {
+      sourceType: 'module',
+      ecmaVersion: 'latest',
+      globals: {
+        ...globals.es2023,
+        ...globals.node,
+      },
+    },
+  },
+  {
+    rules: {
+      'no-await-in-loop': 'error',
+      'no-param-reassign': 'error',
+      'class-methods-use-this': 'error',
+      'no-shadow': 'error',
+      'prefer-const': 'error',
+      'import-x/no-extraneous-dependencies': ['error'],
+      'import-x/first': ['error'],
+      camelcase: ['error', { properties: 'never', ignoreDestructuring: false }],
+      'prefer-destructuring': [
+        'error',
+        {
+          VariableDeclarator: {
+            array: false,
+            object: true,
+          },
+          AssignmentExpression: {
+            array: true,
+            object: false,
+          },
+        },
+        {
+          enforceForRenamedProperties: false,
+        },
+      ],
+      'no-plusplus': 'error',
+      'consistent-return': 'error',
+      'no-return-await': 'error',
+      'arrow-body-style': 'error',
+      'dot-notation': 'error',
+      curly: 'error',
+    },
+  },
+  {
+    files: ['**/*.test.js'],
+    plugins: {
+      vitest,
+    },
+    rules: {
+      ...vitest.configs.recommended.rules,
+    },
+  },
+];

package/folderConfig.js

@@ -5,7 +5,6 @@ export default {
     config: path.resolve('./config'),
     models: path.resolve('./models'),
     controllers: path.resolve('./controllers'),
-    views: path.resolve('./views'),
     locales: path.resolve('./locales'),
     emails: path.resolve('./services/messaging/email/templates'),
     commands: path.resolve('./commands'),

package/helpers/files.js

@@ -8,7 +8,7 @@ const getFilesPathWithInheritance = async ({
   loggerFileType = '',
   filter: { startWithCapital = true, notTests = true, notHidden = true } = {},
 }) => {
-  let [internalFiles, externalFiles] = await Promise.all([
+  const [internalFiles, externalFiles] = await Promise.all([
     fs.readdir(internalFolder, { recursive: true, withFileTypes: true }),
     fs.readdir(externalFolder, { recursive: true, withFileTypes: true }),
   ]);
@@ -33,24 +33,24 @@ const getFilesPathWithInheritance = async ({
     return true;
   };
 
-  internalFiles = internalFiles
+  const internalFilesString = internalFiles
     .filter(filterIndexFile)
     .map((fileDirent) =>
-      join(fileDirent.path, fileDirent.name)
+      join(fileDirent.parentPath, fileDirent.name)
         .replace(`${internalFolder}/`, '')
         .replace(`${internalFolder}`, ''),
     );
-  externalFiles = externalFiles
+  const externalFilesString = externalFiles
     .filter(filterIndexFile)
     .map((fileDirent) =>
-      join(fileDirent.path, fileDirent.name)
+      join(fileDirent.parentPath, fileDirent.name)
         .replace(`${externalFolder}/`, '')
         .replace(`${externalFolder}`, ''),
     );
 
   const filesToLoad = [];
-  for (const file of internalFiles) {
-    if (externalFiles.includes(file)) {
+  for (const file of internalFilesString) {
+    if (externalFilesString.includes(file)) {
       logger(
         `Skipping register INTERNAL file '${file}' ${
           loggerFileType ? `of type ${loggerFileType}` : ''
@@ -64,7 +64,7 @@ const getFilesPathWithInheritance = async ({
     }
   }
 
-  for (const file of externalFiles) {
+  for (const file of externalFilesString) {
     filesToLoad.push({
       path: join(externalFolder, file),
       file,
@@ -73,7 +73,4 @@ const getFilesPathWithInheritance = async ({
   return filesToLoad;
 };
 
-export {
-  // eslint-disable-next-line import/prefer-default-export
-  getFilesPathWithInheritance,
-};
+export { getFilesPathWithInheritance };