@adaptivestone/framework 4.11.4 → 5.0.0-alpha.10

package/.eslintrc.cjs

@@ -0,0 +1,41 @@
+module.exports = {
+  env: {
+    es2023: true,
+    node: true,
+  },
+  extends: ['airbnb-base', 'prettier'],
+  plugins: ['prettier'],
+  parserOptions: {
+    ecmaVersion: 2023,
+  },
+  rules: {
+    'no-restricted-syntax': [
+      'error',
+      {
+        selector: 'ForInStatement',
+        message:
+          'for..in loops iterate over the entire prototype chain, which is virtually never what you want. Use Object.{keys,values,entries}, and iterate over the resulting array.',
+      },
+      {
+        selector: 'LabeledStatement',
+        message:
+          'Labels are a form of GOTO; using them makes code confusing and hard to maintain and understand.',
+      },
+      {
+        selector: 'WithStatement',
+        message:
+          '`with` is disallowed in strict mode because it makes code impossible to predict and optimize.',
+      },
+    ],
+    'prettier/prettier': 'error',
+    'import/extensions': 'off', // it have a problem with dynamic imports
+    'import/prefer-default-export': 'off', // we want to have signgke default export too
+  },
+  overrides: [
+    {
+      files: ['**/*.test.js'],
+      extends: ['plugin:vitest/all', 'plugin:vitest/recommended'],
+      plugins: ['vitest'],
+    },
+  ],
+};

package/CHANGELOG.md

@@ -1,3 +1,55 @@
+### 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
+[BREAKING] removing staticFiles middleware as it not used in projects anymore. Docs with nginx config will be provided
+[BREAKING] remove default AUTH_SALT. It should be provided on a app level now
+[BREAKING] Vitest 2.0.0 https://vitest.dev/guide/migration.html#migrating-to-vitest-2-0
+
+### 5.0.0-alpha.8
+
+[UPDATE] replace dotenv with loadEnvFile
+[UPDATE] replace nodemon with node --watch (dev only)
+[BREAKING] Minimum node version is 20.12 as for now (process.loadEnvFile)
+
+### 5.0.0-alpha.7
+
+[UPDATE] deps update
+
+### 5.0.0-alpha.6
+
+[UPDATE] Update internal documentation (jsdoc, d.ts)
+
+### 5.0.0-alpha.5
+
+[UPDATE] More verbose errors for rapsing body request.
+[UPDATE] deps update
+
+### 5.0.0-alpha.4
+
+[UPDATE] Update rate-limiter-flexible to v5
+[CHANGE] Cache update redis.setEX to redis.set(..,..,{EX:xx}) as setEX deprecated
+
+### 5.0.0-alpha.3
+
+[UPDATE] deps update
+[FIX] Migration commands apply
+
+### 5.0.0-alpha.2
+
+[UPDATE] deps update
+
+### 5.0.0-alpha.1
+
+[BREAKING] Vitest 1.0.0 https://vitest.dev/guide/migration.html#migrating-from-vitest-0-34-6
+[BREAKING] ESM only. No more commonJS. That help to fix a lot of bugs with tests and provides better development expirience
+[BREAKING] Mongoose v8. https://mongoosejs.com/docs/migrating_to_8.html
+
 ### 4.11.4
 
 [UPDATE] deps update

package/Cli.js

@@ -1,7 +1,7 @@
-const parseArgs = require('minimist');
-const mongoose = require('mongoose');
-const BaseCli = require('./modules/BaseCli');
-const Server = require('./server');
+import parseArgs from 'minimist';
+import mongoose from 'mongoose';
+import BaseCli from './modules/BaseCli.js';
+import Server from './server.js';
 
 class Cli extends BaseCli {
   constructor(serverConfig) {
@@ -19,4 +19,4 @@ class Cli extends BaseCli {
   }
 }
 
-module.exports = Cli;
+export default Cli;

package/cluster.js

@@ -1,7 +1,9 @@
-const cluster = require('node:cluster');
-const numCPUs = require('node:os').cpus().length;
+import cluster from 'node:cluster';
+import { cpus } from 'node:os';
 
-if (cluster.isMaster) {
+const numCPUs = cpus().length;
+
+if (cluster.isPrimary) {
   // eslint-disable-next-line no-console
   console.log(`Master ${process.pid} is running`);
   // Fork workers.

package/commands/CreateUser.js

@@ -1,4 +1,4 @@
-const AbstractCommand = require('../modules/AbstractCommand');
+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 {
@@ -60,10 +60,12 @@ class CreateUser extends AbstractCommand {
 
     await user.generateToken();
 
-    this.logger.info(`User was created/updated ${JSON.stringify(user, 0, 4)}`);
+    this.logger.info(
+      `User was created/updated ${JSON.stringify(user, null, 4)}`,
+    );
 
     return user;
   }
 }
 
-module.exports = CreateUser;
+export default CreateUser;

package/commands/Documentation.js

@@ -1,5 +1,5 @@
-const AbstractCommand = require('../modules/AbstractCommand');
-const ControllerManager = require('../controllers/index');
+import AbstractCommand from '../modules/AbstractCommand.js';
+import ControllerManager from '../controllers/index.js';
 
 class Documentation extends AbstractCommand {
   async run() {
@@ -10,4 +10,4 @@ class Documentation extends AbstractCommand {
   }
 }
 
-module.exports = Documentation;
+export default Documentation;

package/commands/DropIndex.js

@@ -1,4 +1,4 @@
-const AbstractCommand = require('../modules/AbstractCommand');
+import AbstractCommand from '../modules/AbstractCommand.js';
 
 class DropIndex extends AbstractCommand {
   static get description() {
@@ -26,4 +26,4 @@ class DropIndex extends AbstractCommand {
   }
 }
 
-module.exports = DropIndex;
+export default DropIndex;

package/commands/Generate.js

@@ -1,4 +1,4 @@
-const AbstractCommand = require('../modules/AbstractCommand');
+import AbstractCommand from '../modules/AbstractCommand.js';
 
 class Generate extends AbstractCommand {
   async run() {
@@ -11,4 +11,4 @@ class Generate extends AbstractCommand {
   }
 }
 
-module.exports = Generate;
+export default Generate;

package/commands/GetOpenApiJson.js

@@ -1,5 +1,5 @@
-const fs = require('node:fs').promises;
-const AbstractCommand = require('../modules/AbstractCommand');
+import { promises as fs } from 'node:fs';
+import AbstractCommand from '../modules/AbstractCommand.js';
 
 /**
  * Command for generate documentation json file openApi
@@ -318,4 +318,4 @@ class GetOpenApiJson extends AbstractCommand {
   }
 }
 
-module.exports = GetOpenApiJson;
+export default GetOpenApiJson;

package/commands/SyncIndexes.js

@@ -1,10 +1,12 @@
-const path = require('node:path');
-const AbstractCommand = require('../modules/AbstractCommand');
+import path from 'node:path';
+import * as url from 'node:url';
+import AbstractCommand from '../modules/AbstractCommand.js';
 
 class SyncIndexes extends AbstractCommand {
   async run() {
+    const dirname = url.fileURLToPath(new URL('.', import.meta.url));
     const files = await this.getFilesPathWithInheritance(
-      `${__dirname}/../models`,
+      path.join(dirname, '/../models'),
       this.app.foldersConfig.models,
     );
     let models = [];
@@ -34,4 +36,4 @@ class SyncIndexes extends AbstractCommand {
   }
 }
 
-module.exports = SyncIndexes;
+export default SyncIndexes;

package/commands/migration/Create.js

@@ -1,7 +1,6 @@
-const path = require('node:path');
-const fs = require('node:fs').promises;
-
-const AbstractCommand = require('../../modules/AbstractCommand');
+import path from 'node:path';
+import { promises as fs } from 'node:fs';
+import AbstractCommand from '../../modules/AbstractCommand.js';
 
 class CreateMigration extends AbstractCommand {
   static get description() {
@@ -41,7 +40,6 @@ class CreateMigration extends AbstractCommand {
   static getTemplate(name) {
     return `/* eslint-disable class-methods-use-this */
 
-// const Base = require('@adaptivestone/framework/modules/Base');
 import Base from '@adaptivestone/framework/modules/Base.js';
 
 class ${name} extends Base {
@@ -55,10 +53,9 @@ class ${name} extends Base {
   }
 }
 
-// module.exports = ${name};
 export default ${name};
 `;
   }
 }
 
-module.exports = CreateMigration;
+export default CreateMigration;

package/commands/migration/Migrate.js

@@ -1,4 +1,6 @@
-const AbstractCommand = require('../../modules/AbstractCommand');
+import * as url from 'node:url';
+import path from 'node:path';
+import AbstractCommand from '../../modules/AbstractCommand.js';
 
 class Migrate extends AbstractCommand {
   static get description() {
@@ -6,8 +8,10 @@ class Migrate extends AbstractCommand {
   }
 
   async run() {
+    const dirname = url.fileURLToPath(new URL('.', import.meta.url));
+
     const files = await this.getFilesPathWithInheritance(
-      `${__dirname}/../../migrations`,
+      path.join(dirname, '/../../migrations'),
       this.app.foldersConfig.migrations,
     );
     files.sort(
@@ -32,7 +36,7 @@ class Migrate extends AbstractCommand {
     for (const migration of migrations) {
       this.logger.info(`=== Start migration ${migration.file} ===`);
       // eslint-disable-next-line no-await-in-loop
-      const MigrationCommand = await import(migration.path);
+      const { default: MigrationCommand } = await import(migration.path);
       const migrationCommand = new MigrationCommand(this.app);
       // eslint-disable-next-line no-await-in-loop
       await migrationCommand.up();
@@ -48,4 +52,4 @@ class Migrate extends AbstractCommand {
   }
 }
 
-module.exports = Migrate;
+export default Migrate;

package/config/auth.js

@@ -1,5 +1,6 @@
-module.exports = {
+export default {
   hashRounds: 64,
-  saltSecret: process.env.AUTH_SALT || 'gdfg45667_%%^trterte',
+  saltSecret:
+    process.env.AUTH_SALT || console.error('AUTH_SALT is not defined'),
   isAuthWithVefificationFlow: true,
 };

package/config/http.js

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
   port: process.env.HTTP_PORT || 3300,
   hostname: process.env.HTTP_HOST || '0.0.0.0',
   // if you want to use 'all' domains please copy this file to your app

package/config/i18n.js

@@ -1,7 +1,7 @@
 /**
  * You can use any options from https://www.i18next.com/overview/configuration-options
  */
-module.exports = {
+export default {
   enabled: true,
   preload: ['en', 'ru'],
   supportedLngs: ['en', 'ru'], // should be at least one supported

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/config/log.js

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
   transports: [
     {
       transport: 'winston-transport-sentry-node',

package/config/mail.js

@@ -1,6 +1,6 @@
-const path = require('node:path');
+import path from 'node:path';
 
-module.exports = {
+export default {
   from: 'Localhost <info@localhost>',
   transports: {
     sendMail: {

package/config/mongo.js

@@ -1,3 +1,3 @@
-module.exports = {
+export default {
   connectionString: process.env.MONGO_DSN,
 };

package/config/rateLimiter.js

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
   limiterOptions: {
     // https://github.com/animir/node-rate-limiter-flexible
     // https://github.com/animir/node-rate-limiter-flexible/wiki/Options

package/config/redis.js

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
   url: process.env.REDIS_URI || 'redis://localhost',
   namespace: process.env.REDIS_NAMESPACE || 'main',
 };

package/config/validate.js

@@ -1,3 +1,3 @@
-module.exports = {
+export default {
   controllerValidationAbortEarly: true, // abort validation on first error and return first error
 };

package/controllers/Auth.js

@@ -1,7 +1,7 @@
-const yup = require('yup');
-const AbstractController = require('../modules/AbstractController');
-const GetUserByToken = require('../services/http/middleware/GetUserByToken');
-const RateLimiter = require('../services/http/middleware/RateLimiter');
+import yup from 'yup';
+import AbstractController from '../modules/AbstractController.js';
+import GetUserByToken from '../services/http/middleware/GetUserByToken.js';
+import RateLimiter from '../services/http/middleware/RateLimiter.js';
 
 class Auth extends AbstractController {
   get routes() {
@@ -207,4 +207,4 @@ class Auth extends AbstractController {
   }
 }
 
-module.exports = Auth;
+export default Auth;

package/controllers/Home.js

@@ -1,5 +1,5 @@
-const AbstractController = require('../modules/AbstractController');
-const GetUserByToken = require('../services/http/middleware/GetUserByToken');
+import AbstractController from '../modules/AbstractController.js';
+import GetUserByToken from '../services/http/middleware/GetUserByToken.js';
 
 class Home extends AbstractController {
   get routes() {
@@ -25,4 +25,4 @@ class Home extends AbstractController {
   }
 }
 
-module.exports = Home;
+export default Home;

package/controllers/index.js

@@ -1,5 +1,6 @@
-const path = require('node:path');
-const Base = require('../modules/Base');
+import path from 'node:path';
+import * as url from 'node:url';
+import Base from '../modules/Base.js';
 
 /**
  * Class do autoloading a http controllers
@@ -14,8 +15,9 @@ class ControllerManager extends Base {
    * Load controllers
    */
   async initControllers() {
+    const dirname = url.fileURLToPath(new URL('.', import.meta.url));
     const controllersToLoad = await this.getFilesPathWithInheritance(
-      __dirname,
+      dirname,
       this.app.foldersConfig.controllers,
     );
 
@@ -55,4 +57,4 @@ class ControllerManager extends Base {
   }
 }
 
-module.exports = ControllerManager;
+export default ControllerManager;

package/folderConfig.js

@@ -1,12 +1,11 @@
-const path = require('node:path');
+import path from 'node:path';
 
-module.exports = {
+export default {
   folders: {
     config: path.resolve('./config'),
     models: path.resolve('./models'),
     controllers: path.resolve('./controllers'),
     views: path.resolve('./views'),
-    public: path.resolve('./public'),
     locales: path.resolve('./locales'),
     emails: path.resolve('./services/messaging/email/templates'),
     commands: path.resolve('./commands'),

package/helpers/files.js

@@ -1,5 +1,5 @@
-const fs = require('node:fs').promises;
-const { join } = require('node:path');
+import { promises as fs } from 'node:fs';
+import { join } from 'node:path';
 
 const getFilesPathWithInheritance = async ({
   internalFolder,
@@ -36,12 +36,16 @@ const getFilesPathWithInheritance = async ({
   internalFiles = internalFiles
     .filter(filterIndexFile)
     .map((fileDirent) =>
-      join(fileDirent.path, fileDirent.name).replace(`${internalFolder}/`, ''),
+      join(fileDirent.path, fileDirent.name)
+        .replace(`${internalFolder}/`, '')
+        .replace(`${internalFolder}`, ''),
     );
   externalFiles = externalFiles
     .filter(filterIndexFile)
     .map((fileDirent) =>
-      join(fileDirent.path, fileDirent.name).replace(`${externalFolder}/`, ''),
+      join(fileDirent.path, fileDirent.name)
+        .replace(`${externalFolder}/`, '')
+        .replace(`${externalFolder}`, ''),
     );
 
   const filesToLoad = [];
@@ -54,7 +58,7 @@ const getFilesPathWithInheritance = async ({
       );
     } else {
       filesToLoad.push({
-        path: `${internalFolder}/${file}`,
+        path: join(internalFolder, file),
         file,
       });
     }
@@ -62,14 +66,14 @@ const getFilesPathWithInheritance = async ({
 
   for (const file of externalFiles) {
     filesToLoad.push({
-      path: `${externalFolder}/${file}`,
+      path: join(externalFolder, file),
       file,
     });
   }
   return filesToLoad;
 };
 
-module.exports = {
+export {
   // eslint-disable-next-line import/prefer-default-export
   getFilesPathWithInheritance,
 };

package/helpers/logger.js

@@ -13,7 +13,5 @@ const consoleLogger = (level, message) => {
     }
   }
 };
-module.exports = {
-  levels,
-  consoleLogger,
-};
+
+export { levels, consoleLogger };

package/helpers/redis/clearNamespace.js

@@ -11,4 +11,4 @@ async function clearNamespace(redisClient, namespace) {
   }
 }
 
-module.exports = clearNamespace;
+export default clearNamespace;

package/helpers/yup.js

@@ -1,5 +1,5 @@
-const { Schema } = require('yup');
-const formidable = require('formidable');
+import { Schema } from 'yup';
+import { PersistentFile } from 'formidable';
 
 /**
  * Validator for file
@@ -13,13 +13,12 @@ class YupFile extends Schema {
   constructor() {
     super({
       type: 'file',
-      check: (value) =>
-        value.every((item) => item instanceof formidable.PersistentFile),
+      check: (value) => value.every((item) => item instanceof PersistentFile),
     });
   }
 }
 
-module.exports = {
+export {
   // eslint-disable-next-line import/prefer-default-export
   YupFile,
 };

package/index.js

@@ -1,5 +1,5 @@
-const Server = require('./server');
-const folderConfig = require('./folderConfig');
+import Server from './server.js';
+import folderConfig from './folderConfig.js';
 
 const server = new Server(folderConfig);
 

package/jsconfig.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "module": "node16",
+    "target": "ES2022",
+    "moduleResolution": "node16",
+    "checkJs": true
+  },
+  "exclude": ["node_modules"]
+}

package/models/Migration.js

@@ -1,4 +1,4 @@
-const AbstractModel = require('../modules/AbstractModel');
+import AbstractModel from '../modules/AbstractModel.js';
 
 class Migration extends AbstractModel {
   // eslint-disable-next-line class-methods-use-this
@@ -12,4 +12,4 @@ class Migration extends AbstractModel {
   }
 }
 
-module.exports = Migration;
+export default Migration;

package/models/Sequence.js

@@ -1,4 +1,4 @@
-const AbstractModel = require('../modules/AbstractModel');
+import AbstractModel from '../modules/AbstractModel.js';
 
 class Sequence extends AbstractModel {
   // eslint-disable-next-line class-methods-use-this
@@ -19,4 +19,4 @@ class Sequence extends AbstractModel {
   }
 }
 
-module.exports = Sequence;
+export default Sequence;

package/models/User.js

@@ -1,11 +1,10 @@
 /* eslint-disable no-param-reassign */
 
-const { scrypt } = require('node:crypto');
-const { promisify } = require('node:util');
+import { scrypt } from 'node:crypto';
 
-const AbstractModel = require('../modules/AbstractModel');
-
-const Mailer = require('../services/messaging').email;
+import { promisify } from 'node:util';
+import AbstractModel from '../modules/AbstractModel.js';
+import Mailer from '../services/messaging/email/index.js';
 
 class User extends AbstractModel {
   constructor(app) {
@@ -255,4 +254,4 @@ class User extends AbstractModel {
   }
 }
 
-module.exports = User;
+export default User;

package/modules/AbstractCommand.js

@@ -1,4 +1,4 @@
-const Base = require('./Base');
+import Base from './Base.js';
 
 class AbstractCommand extends Base {
   constructor(app, commands, args) {
@@ -13,10 +13,11 @@ class AbstractCommand extends Base {
 
   /**
    * Entry point to every command. This method should be overridden
-   * @override
+   * @return {Promise<boolean>} resut
    */
   async run() {
     this.logger.error('You should implement run method');
+    return false;
   }
 
   static get loggerGroup() {
@@ -24,4 +25,4 @@ class AbstractCommand extends Base {
   }
 }
 
-module.exports = AbstractCommand;
+export default AbstractCommand;