@adaptivestone/framework 5.0.0-beta.10 → 5.0.0-beta.12

package/services/http/middleware/IpDetector.js

@@ -1,59 +0,0 @@
-import { BlockList } from 'node:net';
-
-import AbstractMiddleware from './AbstractMiddleware.js';
-
-class IpDetector extends AbstractMiddleware {
-  static get description() {
-    return 'Detect real user IP address. Support proxy and load balancer';
-  }
-
-  constructor(app, params) {
-    super(app, params);
-    const { trustedProxy } = this.app.getConfig('ipDetector');
-
-    this.blockList = new BlockList();
-
-    for (const subnet of trustedProxy) {
-      const addressType = subnet.includes(':') ? 'ipv6' : 'ipv4';
-      if (subnet.includes('/')) {
-        // CIDR
-        const [realSubnet, prefixLength] = subnet.split('/');
-        this.blockList.addSubnet(
-          realSubnet,
-          parseInt(prefixLength, 10),
-          addressType,
-        );
-      } else if (subnet.includes('-')) {
-        // RANGE
-        const [start, end] = subnet.split('-');
-        this.blockList.addRange(start, end, addressType);
-      } else {
-        // just an address
-        this.blockList.addAddress(subnet, addressType);
-      }
-    }
-  }
-
-  async middleware(req, res, next) {
-    const { headers } = this.app.getConfig('ipDetector');
-    const initialIp = req.socket.remoteAddress;
-    req.appInfo.ip = initialIp;
-    const addressType = initialIp.includes(':') ? 'ipv6' : 'ipv4';
-
-    if (this.blockList.check(initialIp, addressType)) {
-      // we can trust this source
-      for (const header of headers) {
-        // in a range
-        const ipHeader = req.headers[header.toLowerCase()];
-        if (ipHeader) {
-          const [firstIp] = ipHeader.split(',').map((ip) => ip.trim());
-          req.appInfo.ip = firstIp;
-          break;
-        }
-      }
-    }
-    next();
-  }
-}
-
-export default IpDetector;

package/services/http/middleware/Pagination.js

@@ -1,57 +0,0 @@
-import { object, number } from 'yup';
-import AbstractMiddleware from './AbstractMiddleware.js';
-/**
- * Middleware for reusing pagination
- */
-class Pagination extends AbstractMiddleware {
-  static get description() {
-    return 'Pagination middleware. You can use limit=10 and maxLimit=100 parameters';
-  }
-
-  // eslint-disable-next-line class-methods-use-this
-  get relatedQueryParameters() {
-    return object().shape({
-      page: number(),
-      limit: number(),
-    });
-  }
-
-  async middleware(req, res, next) {
-    let { limit, maxLimit } = this.params;
-
-    limit = (typeof limit !== 'number' ? parseInt(limit, 10) : limit) || 10;
-    maxLimit =
-      (typeof maxLimit !== 'number' ? parseInt(maxLimit, 10) : maxLimit) || 100;
-
-    req.appInfo.pagination = {};
-    req.appInfo.pagination.page =
-      typeof req?.query?.page === 'string'
-        ? parseInt(req?.query?.page, 10) || 1
-        : 1;
-
-    req.appInfo.pagination.limit =
-      typeof req?.query?.limit === 'string'
-        ? parseInt(req?.query?.limit, 10) || 0
-        : limit;
-
-    if (req.appInfo.pagination.limit > maxLimit) {
-      req.appInfo.pagination.limit = maxLimit;
-    }
-
-    if (req.appInfo.pagination.page < 1) {
-      req.appInfo.pagination.page = 1;
-    }
-
-    if (req.appInfo.pagination.limit < 0) {
-      req.appInfo.pagination.limit = 0;
-    }
-
-    req.appInfo.pagination.skip =
-      req.appInfo.pagination.page * req.appInfo.pagination.limit -
-      req.appInfo.pagination.limit;
-
-    return next();
-  }
-}
-
-export default Pagination;

package/services/http/middleware/PrepareAppInfo.js

@@ -1,18 +0,0 @@
-import AbstractMiddleware from './AbstractMiddleware.js';
-
-class PrepareAppInfo extends AbstractMiddleware {
-  static get description() {
-    return 'Basic middleware that creates "req.appInfo" object';
-  }
-
-  async middleware(req, res, next) {
-    if (!req.appInfo) {
-      req.appInfo = {
-        app: this.app,
-      };
-    }
-    next();
-  }
-}
-
-export default PrepareAppInfo;

package/services/http/middleware/RateLimiter.js

@@ -1,134 +0,0 @@
-import {
-  RateLimiterMemory,
-  RateLimiterRedis,
-  RateLimiterMongo,
-} from 'rate-limiter-flexible';
-import merge from 'deepmerge';
-import { createClient } from '@redis/client';
-import mongoose from 'mongoose';
-import AbstractMiddleware from './AbstractMiddleware.js';
-
-class RateLimiter extends AbstractMiddleware {
-  static get description() {
-    return 'Rate limiter middleware. Limit amount of request. Please refer to documentation';
-  }
-
-  constructor(app, params) {
-    super(app, params);
-    const limiterOptions = this.app.getConfig('rateLimiter');
-
-    this.finalOptions = merge(limiterOptions, params);
-    this.limiter = null;
-
-    switch (this.finalOptions.driver) {
-      case 'memory':
-        this.limiter = new RateLimiterMemory(this.finalOptions.limiterOptions);
-        break;
-
-      case 'redis':
-        this.limiter = this.initRedisLimiter();
-        break;
-
-      case 'mongo':
-        this.limiter = new RateLimiterMongo({
-          storeClient: mongoose.connection,
-          ...this.finalOptions.limiterOptions,
-        });
-        break;
-
-      default:
-        this.logger.error(
-          `Unknwon option for driver ${this.finalOptions.driver}`,
-        );
-        break;
-    }
-  }
-
-  initRedisLimiter() {
-    const redisConfig = this.app.getConfig('redis');
-    const redisClient = createClient({
-      url: redisConfig.url,
-    });
-
-    // TODO: change it
-    (async () => {
-      await redisClient.connect();
-    })();
-
-    redisClient.on('error', (error, b, c) => {
-      this.logger.error(error, b, c);
-    });
-    redisClient.on('connect', () => {
-      this.logger.info('Redis connection success');
-    });
-
-    this.app.events.on('shutdown', async () => {
-      await redisClient.disconnect();
-    });
-
-    return new RateLimiterRedis({
-      storeClient: redisClient,
-      useRedisPackage: true,
-      ...this.finalOptions.limiterOptions,
-    });
-  }
-
-  gerenateConsumeKey(req) {
-    const { ip, route, user, request } = this.finalOptions.consumeKeyComponents;
-
-    const key = [];
-    if (ip) {
-      if (!req.appInfo.ip) {
-        this.logger.error(
-          `RateLimiter: Can't get remote address from request. Please check that you used IpDetecor middleware before RateLimiter`,
-        );
-      } else {
-        key.push(req.appInfo.ip);
-      }
-    }
-    if (route) {
-      key.push(`${req.baseUrl ?? ''}${req.path ?? ''}`); // to avoid quesry params
-    }
-    if (user && req.appInfo?.user) {
-      key.push(req.appInfo?.user.id);
-    }
-
-    if (request && request.length) {
-      request.forEach((val) => {
-        if (req.body && req.body[val]) {
-          key.push(req.body[val]);
-        }
-        // if (req.appInfo.request && req.appInfo.request[val]) {
-        //   key.push(req.appInfo.request[val]);
-        // }
-      });
-    }
-
-    return key.join('_');
-  }
-
-  async middleware(req, res, next) {
-    if (!this.limiter) {
-      this.logger.info(
-        `RateLimiter not inited correclty! Please check init logs `,
-      );
-      return res.status(500).json({ message: 'RateLimiter error' });
-    }
-
-    const { namespace } = this.app.getConfig('redis');
-
-    const consumeKey = `${namespace}-${this.gerenateConsumeKey(req)}`;
-
-    const consumeResult = await this.limiter
-      .consume(consumeKey, this.finalOptions.consumePoints)
-      .catch(() => {
-        this.logger.warn(`Too many requests. Consume key: ${consumeKey}`);
-      });
-    if (consumeResult) {
-      return next();
-    }
-    return res.status(429).json({ message: 'Too Many Requests' });
-  }
-}
-
-export default RateLimiter;

package/services/http/middleware/RequestLogger.js

@@ -1,22 +0,0 @@
-import AbstractMiddleware from './AbstractMiddleware.js';
-
-class RequestLogger extends AbstractMiddleware {
-  static get description() {
-    return 'Log info about the request';
-  }
-
-  async middleware(req, res, next) {
-    const startTime = performance.now();
-    const text = `Request is  [${req.method}] ${req.url}`;
-    this.logger.info(text);
-    res.on('finish', () => {
-      const end = performance.now();
-      this.logger.info(
-        `Finished ${text}. Status: ${res.statusCode}.  [${(end - startTime).toFixed(2)} ms]`,
-      );
-    });
-    next();
-  }
-}
-
-export default RequestLogger;

package/services/http/middleware/RequestParser.js

@@ -1,40 +0,0 @@
-import formidable from 'formidable';
-import AbstractMiddleware from './AbstractMiddleware.js';
-
-class RequestParser extends AbstractMiddleware {
-  static get description() {
-    return 'Parses incoming request. Based on Formidable library';
-  }
-
-  async middleware(req, res, next) {
-    const time = Date.now();
-    this.logger.verbose(`Parsing request`);
-    // TODO update this to https://github.com/node-formidable/formidable/issues/412#issuecomment-1367914268 in node v20 (in 2023?)
-
-    const form = formidable(this.params); // not in construstor as reuse formidable affects performance
-    let fields;
-    let files;
-    try {
-      [fields, files] = await form.parse(req);
-    } catch (err) {
-      this.logger.error(`Parsing failed ${err}`);
-      return res.status(400).json({
-        message: `Error to parse your request. You provided invalid content type or content-length. Please check your request headers and content type.`,
-      });
-      // return next(err);
-    }
-    this.logger.verbose(
-      `Parsing multipart/formdata request DONE ${Date.now() - time}ms`,
-    );
-
-    req.body = {
-      // todo avoid body in next versions
-      ...(req.body || {}),
-      ...fields,
-      ...files,
-    };
-    return next();
-  }
-}
-
-export default RequestParser;

package/services/http/middleware/Role.js

@@ -1,29 +0,0 @@
-import AbstractMiddleware from './AbstractMiddleware.js';
-
-class RoleMiddleware extends AbstractMiddleware {
-  static get description() {
-    return 'Check user role (user.roles property). If the user has no role then stop request and return error. OR logic (any role will pass user)';
-  }
-
-  async middleware(req, res, next) {
-    const { user } = req.appInfo;
-
-    if (!user) {
-      return res.status(401).json({ message: 'User should be provided' });
-    }
-
-    let hasRole = false;
-    user.roles.forEach((role) => {
-      if (this.params.roles.includes(role)) {
-        hasRole = true;
-      }
-    });
-
-    if (!hasRole) {
-      return res.status(403).json({ message: 'You do not have access' });
-    }
-    return next();
-  }
-}
-
-export default RoleMiddleware;

package/services/messaging/email/resources/.gitkeep

@@ -1 +0,0 @@
-This folder for you resources to inline

package/services/messaging/email/templates/recovery/html.pug

@@ -1,8 +0,0 @@
-doctype html
-html(lang='en')
-  head
-    meta(charset='UTF-8')
-  body
-    h1 #{t('email.passwordRecovery')}
-    p #{t('email.passwordChanged')} #{link}
-

package/services/messaging/email/templates/recovery/subject.pug

@@ -1,2 +0,0 @@
-= `${t('email.passwordRecovery')}`
-

package/services/messaging/email/templates/recovery/text.pug

@@ -1,3 +0,0 @@
-.
-  #{t('email.greeating')}
-  #{t('email.passwordRecovery')} #{link}

package/services/messaging/email/templates/verification/html.pug

@@ -1,10 +0,0 @@
-doctype html
-html(lang='en')
-   head
-     meta(charset='UTF-8')
-     title верификация емейла
-   body
-     h1 Добрый день #{username}
-     p
-       | Для верификации емейла перейдите по ссылке
-       a(href='#{link}')  #{link}

package/services/messaging/email/templates/verification/subject.pug

@@ -1 +0,0 @@
-= `Верификаия емейла`

package/services/messaging/email/templates/verification/text.pug

@@ -1 +0,0 @@
-= `Добрый день {{username}} Для верификации емейла перейдите по ссылке ${link}`

package/services/validate/ValidateService.js

@@ -1,157 +0,0 @@
-import { isSchema } from 'yup';
-import YupValidator from './drivers/YupValidator.js';
-import CustomValidator from './drivers/CustomValidator.js';
-import Base from '../../modules/Base.js';
-
-class ValidateService extends Base {
-  constructor(app, validator) {
-    super(app);
-    this.validator = validator
-      ? ValidateService.getDriverByValidatorBody(app, validator)
-      : null;
-  }
-
-  static drivers = {
-    YupValidator,
-    CustomValidator,
-  };
-
-  static isValidatorExists(validator) {
-    if (!(validator instanceof Object)) {
-      return false;
-    }
-
-    return Object.values(this.drivers).some(
-      (driver) => validator instanceof driver,
-    );
-  }
-
-  static getDriverByValidatorBody(app, body = {}) {
-    if (this.isValidatorExists(body)) {
-      return body;
-    }
-    if (isSchema(body)) {
-      const yupValidator = new YupValidator(app, body);
-      return yupValidator;
-    }
-    const customValidator = new CustomValidator(app, body);
-    return customValidator;
-  }
-
-  /**
-   * Filter middlewares by route path and select all parameters
-   */
-  filterRelatedParametersByRoute(middlewares, method, path) {
-    const middlewaresParams = middlewares
-      .filter(
-        (middleware) =>
-          middleware.method.toLowerCase() === method.toLowerCase() &&
-          middleware.fullPath.toLowerCase() === path.toLowerCase(),
-      )
-      ?.map((middleware) => {
-        const instance = new middleware.MiddlewareFunction(
-          this.app,
-          middleware.params,
-        );
-
-        return instance.relatedReqParameters;
-      });
-
-    return middlewaresParams;
-  }
-
-  /**
-   * Group all middleware(routes + controller) parameters
-   */
-  getMiddlewareParams(controllerMiddlewares, AllrouteMiddlewares, options) {
-    const { method, path } = options;
-    const routeMiddlewaresParams = this.filterRelatedParametersByRoute(
-      AllrouteMiddlewares,
-      method,
-      path,
-    );
-
-    const controllerMiddlewaresParams = this.filterRelatedParametersByRoute(
-      controllerMiddlewares,
-      method,
-      path,
-    );
-
-    return {
-      request: [
-        ...controllerMiddlewaresParams.map((x) => x.request),
-        ...routeMiddlewaresParams.map((x) => x.request),
-      ],
-      query: [
-        ...controllerMiddlewaresParams.map((x) => x.query),
-        ...routeMiddlewaresParams.map((x) => x.query),
-      ],
-    };
-  }
-
-  // eslint-disable-next-line class-methods-use-this
-  async validateSchema(req, validator, data) {
-    if (!validator) {
-      return {};
-    }
-
-    await validator.validateFields(data, req);
-
-    return validator.castFields(data, req);
-  }
-
-  async validateArrayOfSchemas(req, validators, data) {
-    const result = [];
-
-    for (const validator of validators) {
-      const formatedValidator = ValidateService.getDriverByValidatorBody(
-        this.app,
-        validator,
-      );
-      result.push(this.validateSchema(req, formatedValidator, data));
-    }
-
-    return Promise.all(result);
-  }
-
-  /**
-   * Validate req data. For example req.body, req.query
-   */
-  async validateReqData(req, options) {
-    const { selectedReqData, additionalMiddlewareFieldsData } = options;
-    const {
-      middlewaresInfo,
-      routeMiddlewaresReg,
-      options: routeOptions,
-    } = additionalMiddlewareFieldsData;
-
-    let validatedFields = await this.validateSchema(
-      req,
-      this.validator,
-      selectedReqData,
-    );
-    const additionalMiddlewareSchemas = this.getMiddlewareParams(
-      middlewaresInfo,
-      routeMiddlewaresReg,
-      routeOptions,
-    )[routeOptions.prefix];
-
-    if (additionalMiddlewareSchemas.length) {
-      const middlewareValidatedFields = await this.validateArrayOfSchemas(
-        req,
-        additionalMiddlewareSchemas,
-        selectedReqData,
-      );
-
-      validatedFields = Object.assign(
-        {},
-        validatedFields,
-        ...middlewareValidatedFields,
-      );
-    }
-
-    return validatedFields;
-  }
-}
-
-export default ValidateService;

package/services/validate/drivers/AbstractValidator.js

@@ -1,37 +0,0 @@
-import Base from '../../../modules/Base.js';
-
-class AbstractValidator extends Base {
-  constructor(app, body) {
-    super(app);
-    this.body = body;
-  }
-
-  // eslint-disable-next-line no-unused-vars
-  static convertFieldsToJson(fields) {
-    // IMPLENT;
-    return {};
-  }
-
-  // eslint-disable-next-line class-methods-use-this
-  get fieldsInJsonFormat() {
-    // IMPLENT;
-    return {};
-  }
-
-  // eslint-disable-next-line class-methods-use-this, no-unused-vars
-  async validateFields(data, { query, body, appInfo }) {
-    // IMPLENT;
-    return true;
-  }
-
-  // eslint-disable-next-line class-methods-use-this
-  async castFields() {
-    // IMPLENT;
-    return true;
-  }
-
-  static get loggerGroup() {
-    return 'AbstractValidator_';
-  }
-}
-export default AbstractValidator;

package/services/validate/drivers/CustomValidator.js

@@ -1,51 +0,0 @@
-import { ValidationError } from 'yup';
-import AbstractValidator from './AbstractValidator.js';
-
-class CustomValidator extends AbstractValidator {
-  async validateFields(data, { query, body, appInfo }) {
-    if (this.body) {
-      if (typeof this.body.validate !== 'function') {
-        this.logger.error('request.validate should be a function');
-      }
-    }
-    try {
-      await this.body.validate(data, {
-        req: {
-          query,
-          body,
-          appInfo,
-        },
-      });
-    } catch (e) {
-      this.logger.warn(`CustomValidator validateFields ${e}`);
-      if (e.path) {
-        throw new ValidationError({
-          [e.path]: e.message,
-        });
-      }
-      throw new Error(e);
-    }
-  }
-
-  async castFields(data, { query, body, appInfo }) {
-    if (this.body) {
-      if (typeof this.body.cast !== 'function') {
-        this.logger.error('request.validate should be a function');
-      }
-    }
-
-    return this.body.cast(data, {
-      req: {
-        query,
-        body,
-        appInfo,
-      },
-    });
-  }
-
-  static get loggerGroup() {
-    return 'CustomValidator_';
-  }
-}
-
-export default CustomValidator;