@adaptivestone/framework 5.0.0-beta.3 → 5.0.0-beta.30

package/commands/SyncIndexes.js

@@ -1,39 +0,0 @@
-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(
-      path.join(dirname, '/../models'),
-      this.app.foldersConfig.models,
-    );
-    let models = [];
-
-    for (const file of files) {
-      models.push(path.basename(file.file, path.extname(file.file)));
-    }
-    models = models.sort();
-    this.logger.info(`Total found ${models.length} models`);
-
-    for (const modelName of models) {
-      const Model = this.app.getModel(modelName);
-      // eslint-disable-next-line no-await-in-loop
-      const removedIndexes = await Model.syncIndexes(); // await in loop not a bug. Lets do one by one
-      if (removedIndexes.length) {
-        this.logger.info(
-          `Model - ${modelName} removed indexes: ${removedIndexes}`,
-        );
-      } else {
-        this.logger.info(`Model - ${modelName} NO removed indexes`);
-      }
-    }
-  }
-
-  static get description() {
-    return 'Synchronize indexes defined in models with a real one indexed on the database.  Command will remove all indexes from the database that do not exist on model OR have different parameters. Then it will create a new indexes   ';
-  }
-}
-
-export default SyncIndexes;

package/commands/migration/Create.js

@@ -1,61 +0,0 @@
-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() {
-    return 'Create new migration';
-  }
-
-  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');
-    }
-    const fileName = `${Date.now()}_${this.constructor.camelSentence(
-      this.args.name,
-    )}.js`;
-
-    const fileContent = this.constructor.getTemplate(
-      this.constructor.camelSentence(this.args.name),
-    );
-
-    await fs.writeFile(
-      path.join(this.app.foldersConfig.migrations, fileName),
-      fileContent,
-    );
-    return this.logger.info(`Migration created ${fileName}`);
-  }
-
-  static camelSentence(str) {
-    return ` ${str}`
-      .toLowerCase()
-      .replace(/[^a-zA-Z0-9]+(.)/g, (match, chr) => chr.toUpperCase());
-  }
-
-  static getTemplate(name) {
-    return `/* eslint-disable class-methods-use-this */
-
-import Base from '@adaptivestone/framework/modules/Base.js';
-
-class ${name} extends Base {
-  async up() {
-    // put here your mirgation up logic
-    // const YourModel = this.app.getModel('ModelName');
-  }
-
-  async down() {
-    // put here your mirgation down logic
-  }
-}
-
-export default ${name};
-`;
-  }
-}
-
-export default CreateMigration;

package/commands/migration/Migrate.js

@@ -1,55 +0,0 @@
-import * as url from 'node:url';
-import path from 'node:path';
-import AbstractCommand from '../../modules/AbstractCommand.js';
-
-class Migrate extends AbstractCommand {
-  static get description() {
-    return 'Run all pending migrations';
-  }
-
-  async run() {
-    const dirname = url.fileURLToPath(new URL('.', import.meta.url));
-
-    const files = await this.getFilesPathWithInheritance(
-      path.join(dirname, '/../../migrations'),
-      this.app.foldersConfig.migrations,
-    );
-    files.sort(
-      (a, b) => Number(a.file.split('_')[0]) - Number(b.file.split('_')[0]),
-    );
-    const MigrationModel = this.app.getModel('Migration');
-    const lastMigration = await MigrationModel.findOne({})
-      .sort({ createdAt: -1 })
-      .exec();
-
-    let migrations = files;
-
-    if (lastMigration) {
-      const lastMigrationTime = Number(
-        lastMigration.migrationFile.split('_')[0],
-      );
-      migrations = files.filter(
-        (val) => Number(val.file.split('_')[0]) > lastMigrationTime,
-      );
-    }
-
-    for (const migration of migrations) {
-      this.logger.info(`=== Start migration ${migration.file} ===`);
-      // eslint-disable-next-line no-await-in-loop
-      const { default: MigrationCommand } = await import(migration.path);
-      const migrationCommand = new MigrationCommand(this.app);
-      // eslint-disable-next-line no-await-in-loop
-      await migrationCommand.up();
-      // eslint-disable-next-line no-await-in-loop
-      await MigrationModel.create({
-        migrationFile: migration.file,
-      });
-    }
-
-    this.logger.info(
-      `=== Migration Finished. Migrated ${migrations.length} files ===`,
-    );
-  }
-}
-
-export default Migrate;

package/config/auth.js

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

package/config/http.js

@@ -1,9 +0,0 @@
-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
-  // and set "corsDomains: [/./]
-  corsDomains: ['http://localhost:3000'],
-  myDomain: process.env.HTTP_DOMAIN || 'http://localhost:3300',
-  siteDomain: process.env.FRONT_DOMAIN || 'http://localhost:3000',
-};

package/config/i18n.js

@@ -1,12 +0,0 @@
-/**
- * You can use any options from https://www.i18next.com/overview/configuration-options
- */
-export default {
-  enabled: true,
-  preload: ['en', 'ru'],
-  supportedLngs: ['en', 'ru'], // should be at least one supported
-  fallbackLng: 'en',
-  saveMissing: false,
-  debug: false,
-  lookupQuerystring: 'lng', // string to detect language on query
-};

package/config/ipDetector.js

@@ -1,14 +0,0 @@
-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,22 +0,0 @@
-export default {
-  transports: [
-    {
-      transport: 'winston-transport-sentry-node',
-      transportOptions: {
-        sentry: {
-          dsn: process.env.LOGGER_SENTRY_DSN || process.env.SENTRY_DSN,
-        },
-        level: process.env.LOGGER_SENTRY_LEVEL || 'info',
-      },
-      enable: process.env.LOGGER_SENTRY_ENABLE || false,
-    },
-    {
-      transport: 'console',
-      transportOptions: {
-        level: process.env.LOGGER_CONSOLE_LEVEL || 'silly',
-        timestamp: true,
-      },
-      enable: process.env.LOGGER_CONSOLE_ENABLE || true,
-    },
-  ],
-};

package/config/mail.js

@@ -1,29 +0,0 @@
-import path from 'node:path';
-
-export default {
-  from: 'Localhost <info@localhost>',
-  transports: {
-    sendMail: {
-      // path:  "path to the sendmail command (defaults to 'sendmail')"
-      // args: 'an array of extra command line options to pass to the sendmail command (ie. ["-f", "foo@blurdybloop.com"]).'
-    },
-    stub: {},
-    smtp: {
-      // https://github.com/nodemailer/nodemailer#set-up-smtp
-      host: process.env.EMAIL_HOST || 'smtp.mailtrap.io',
-      port: process.env.EMAIL_PORT || 2525,
-      auth: {
-        user: process.env.EMAIL_USER,
-        pass: process.env.EMAIL_PASSWORD,
-      },
-      connectionTimeout: 10000, // timeout to 10 seconds
-    },
-  },
-  transport: process.env.EMAIL_TRANSPORT || 'smtp',
-  webResources: {
-    // https://github.com/jrit/web-resource-inliner path to find resources
-    relativeTo: path.resolve('src/services/messaging/email/resources'),
-    images: false,
-  },
-  globalVariablesToTemplates: {},
-};

package/config/mongo.js

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

package/config/rateLimiter.js

@@ -1,16 +0,0 @@
-export default {
-  limiterOptions: {
-    // https://github.com/animir/node-rate-limiter-flexible
-    // https://github.com/animir/node-rate-limiter-flexible/wiki/Options
-    points: 10, // 10 points
-    duration: 60, // Per 60 seconds
-  },
-  driver: 'memory', // can be 'mongo', 'redis'
-  consumePoints: 1,
-  consumeKeyComponents: {
-    ip: true, // include ip to key generation
-    route: true, // include route to key generation
-    user: true, // include user id to key generation (if user exits)
-    request: [], // what should be included from request (req.appInfo.request) if it presented
-  },
-};

package/config/redis.js

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

package/config/validate.js

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

package/controllers/Auth.js

@@ -1,210 +0,0 @@
-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() {
-    return {
-      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
-          }),
-        },
-        '/register': {
-          handler: this.postRegister,
-          request: yup.object().shape({
-            email: yup
-              .string()
-              .email('auth.emailValid')
-              .required('auth.emailProvided'),
-            password: yup
-              .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(),
-          }),
-        },
-        '/logout': this.postLogout,
-        '/verify': this.verifyUser,
-        '/send-recovery-email': {
-          handler: this.sendPasswordRecoveryEmail,
-          request: yup
-            .object()
-            .shape({ email: yup.string().email().required() }),
-        },
-        '/recover-password': {
-          handler: this.recoverPassword,
-          request: yup.object().shape({
-            password: yup
-              .string()
-              .matches(
-                /^[a-zA-Z0-9!@#$%ˆ^&*()_+\-{}[\]<>]+$/,
-                'auth.passwordValid',
-              )
-              .required(),
-            passwordRecoveryToken: yup.string().required(),
-          }),
-        },
-        '/send-verification': {
-          handler: this.sendVerification,
-          request: yup
-            .object()
-            .shape({ email: yup.string().email().required() }),
-        },
-      },
-    };
-  }
-
-  async postLogin(req, res) {
-    const User = this.app.getModel('User');
-    const user = await User.getUserByEmailAndPassword(
-      req.appInfo.request.email, // we do a request casting
-      req.appInfo.request.password, // we do a request casting
-    );
-    if (!user) {
-      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({ message: req.i18n.t('email.notVerified'), notVerified: true });
-    }
-    const token = await user.generateToken();
-
-    return res.status(200).json({ data: { 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({ 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({ message: req.i18n.t('auth.nicknameExists') });
-      }
-    }
-
-    user = await User.create({
-      email: req.appInfo.request.email,
-      password: req.appInfo.request.password,
-      name: {
-        first: req.appInfo.request.firstName,
-        last: req.appInfo.request.lastName,
-        nick: req.appInfo.request.nickName,
-      },
-    });
-
-    const { isAuthWithVefificationFlow } = this.app.getConfig('auth');
-    if (isAuthWithVefificationFlow) {
-      const answer = await user.sendVerificationEmail(req.i18n).catch((e) => {
-        this.logger.error(e);
-      });
-      if (!answer) {
-        return res.status(500).json();
-      }
-    }
-    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();
-  }
-
-  async verifyUser(req, res) {
-    const User = req.appInfo.app.getModel('User');
-    let user;
-    try {
-      user = await User.getUserByVerificationToken(
-        req.query.verification_token,
-      );
-    } catch (e) {
-      return res.status(400).json({
-        message: req.i18n.t('email.alreadyVerifiedOrWrongToken'),
-      });
-    }
-    this.logger.debug(`Verify user user is :${user}`);
-    if (!user) {
-      return res.status(400).json({
-        message: req.i18n.t('email.alreadyVerifiedOrWrongToken'),
-      });
-    }
-
-    user.isVerified = true;
-    await user.save();
-    return res.status(200).json();
-  }
-
-  async sendPasswordRecoveryEmail(req, res) {
-    const User = req.appInfo.app.getModel('User');
-    try {
-      const user = await User.getUserByEmail(req.appInfo.request.email);
-      if (!user) {
-        return res
-          .status(400)
-          .json({ message: req.i18n.t('auth.errorUExist') });
-      }
-      await user.sendPasswordRecoveryEmail(req.i18n);
-      return res.status(200).json();
-    } catch (e) {
-      this.logger.error(e);
-      return res.status(400).json({ message: req.i18n.t('auth.errorUExist') });
-    }
-  }
-
-  async recoverPassword(req, res) {
-    const User = this.app.getModel('User');
-    const user = await User.getUserByPasswordRecoveryToken(
-      req.appInfo.request.passwordRecoveryToken,
-    ).catch((e) => {
-      this.logger.error(e);
-    });
-
-    if (!user) {
-      return res
-        .status(400)
-        .json({ message: req.i18n.t('password.wrongToken') });
-    }
-
-    this.logger.debug(`Password recovery user is :${user}`);
-
-    user.password = req.appInfo.request.password;
-    user.isVerified = true;
-    await user.save();
-    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({ message: req.i18n.t('auth.errorUExist') });
-    }
-    await user.sendVerificationEmail(req.i18n);
-    return res.status(200).json();
-  }
-
-  static get middleware() {
-    return new Map([['/{*splat}', [GetUserByToken, RateLimiter]]]);
-  }
-}
-
-export default Auth;

package/controllers/Home.js

@@ -1,28 +0,0 @@
-import AbstractController from '../modules/AbstractController.js';
-import GetUserByToken from '../services/http/middleware/GetUserByToken.js';
-
-class Home extends AbstractController {
-  get routes() {
-    return {
-      get: {
-        '/': this.home,
-      },
-    };
-  }
-
-  // eslint-disable-next-line class-methods-use-this
-  async home(req, res) {
-    return res.json({ message: 'Home' });
-  }
-
-  // eslint-disable-next-line class-methods-use-this
-  getHttpPath() {
-    return '/';
-  }
-
-  static get middleware() {
-    return new Map([['/{*splat}', [GetUserByToken]]]);
-  }
-}
-
-export default Home;

package/controllers/index.js

@@ -1,60 +0,0 @@
-import path from 'node:path';
-import * as url from 'node:url';
-import Base from '../modules/Base.js';
-
-/**
- * Class do autoloading a http controllers
- */
-class ControllerManager extends Base {
-  constructor(app) {
-    super(app);
-    this.controllers = {};
-  }
-
-  /**
-   * Load controllers
-   */
-  async initControllers() {
-    const dirname = url.fileURLToPath(new URL('.', import.meta.url));
-    const controllersToLoad = await this.getFilesPathWithInheritance(
-      dirname,
-      this.app.foldersConfig.controllers,
-    );
-
-    controllersToLoad.sort((a, b) => {
-      if (a.file.toLowerCase().endsWith('index.js')) {
-        if (b.file.toLowerCase().endsWith('index.js')) {
-          return 0;
-        }
-        return -1;
-      }
-      return 0;
-    });
-    const controllers = [];
-    for (const controller of controllersToLoad) {
-      controllers.push(
-        import(controller.path).then(({ default: ControllerModule }) => {
-          const contollerName = ControllerModule.name.toLowerCase();
-          let prefix = path.dirname(controller.file);
-          if (prefix === '.') {
-            prefix = '';
-          }
-          const controllePath = prefix
-            ? `${prefix}/${contollerName}`
-            : contollerName;
-          this.controllers[controllePath] = new ControllerModule(
-            this.app,
-            prefix,
-          );
-        }),
-      );
-    }
-    await Promise.all(controllers);
-  }
-
-  static get loggerGroup() {
-    return 'controller';
-  }
-}
-
-export default ControllerManager;

package/folderConfig.js

@@ -1,14 +0,0 @@
-import path from 'node:path';
-
-export default {
-  folders: {
-    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'),
-    migrations: path.resolve('./migrations'),
-  },
-};

package/helpers/files.js

@@ -1,79 +0,0 @@
-import { promises as fs } from 'node:fs';
-import { join } from 'node:path';
-
-const getFilesPathWithInheritance = async ({
-  internalFolder,
-  externalFolder,
-  logger,
-  loggerFileType = '',
-  filter: { startWithCapital = true, notTests = true, notHidden = true } = {},
-}) => {
-  const [internalFiles, externalFiles] = await Promise.all([
-    fs.readdir(internalFolder, { recursive: true, withFileTypes: true }),
-    fs.readdir(externalFolder, { recursive: true, withFileTypes: true }),
-  ]);
-
-  const filterIndexFile = (fileDirent) => {
-    if (!fileDirent.isFile()) {
-      return false;
-    }
-    const fileArray = fileDirent.name.split('/');
-    const file = fileArray[fileArray.length - 1];
-    if (startWithCapital && file[0] !== file[0].toUpperCase()) {
-      // not start with capital
-      return false;
-    }
-    if (notTests && file.endsWith('.test.js')) {
-      return false;
-    }
-    if (notHidden && file[0] === '.') {
-      // not start with dot
-      return false;
-    }
-    return true;
-  };
-
-  const internalFilesString = internalFiles
-    .filter(filterIndexFile)
-    .map((fileDirent) =>
-      join(fileDirent.parentPath, fileDirent.name)
-        .replace(`${internalFolder}/`, '')
-        .replace(`${internalFolder}`, ''),
-    );
-  const externalFilesString = externalFiles
-    .filter(filterIndexFile)
-    .map((fileDirent) =>
-      join(fileDirent.parentPath, fileDirent.name)
-        .replace(`${externalFolder}/`, '')
-        .replace(`${externalFolder}`, ''),
-    );
-
-  const filesToLoad = [];
-  for (const file of internalFilesString) {
-    if (externalFilesString.includes(file)) {
-      logger(
-        `Skipping register INTERNAL file '${file}' ${
-          loggerFileType ? `of type ${loggerFileType}` : ''
-        } as it override by EXTERNAL ONE`,
-      );
-    } else {
-      filesToLoad.push({
-        path: join(internalFolder, file),
-        file,
-      });
-    }
-  }
-
-  for (const file of externalFilesString) {
-    filesToLoad.push({
-      path: join(externalFolder, file),
-      file,
-    });
-  }
-  return filesToLoad;
-};
-
-export {
-  // eslint-disable-next-line import/prefer-default-export
-  getFilesPathWithInheritance,
-};