@adaptivestone/framework 5.0.0-beta.4 → 5.0.0-beta.40

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 yup 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 yup.object().shape({
-      page: yup.number(),
-      limit: yup.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 redis from 'redis';
-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 = redis.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/index.js

@@ -1,217 +0,0 @@
-import fs from 'node:fs';
-import path from 'node:path';
-import * as url from 'node:url';
-import { promisify } from 'node:util';
-import nodemailer from 'nodemailer';
-import sendMail from 'nodemailer-sendmail-transport';
-import stub from 'nodemailer-stub-transport';
-import pug from 'pug';
-import juice from 'juice';
-import { convert } from 'html-to-text';
-import Base from '../../../modules/Base.js';
-
-const mailTransports = {
-  sendMail,
-  stub,
-  smtp: (data) => data,
-};
-
-class Mail extends Base {
-  /**
-   * Construct mail class
-   * @param {object} app
-   * @param {string} template template name
-   * @param {object} [templateData={}] data to render in template. Object with value that available inside template
-   * @param {object} [i18n] data to render in template
-   */
-  constructor(app, template, templateData = {}, i18n = null) {
-    super(app);
-    const dirname = url.fileURLToPath(new URL('.', import.meta.url));
-    if (!path.isAbsolute(template)) {
-      if (
-        fs.existsSync(
-          `${this.app.foldersConfig.emails}/${path.basename(template)}`,
-        )
-      ) {
-        this.template = `${this.app.foldersConfig.emails}/${path.basename(
-          template,
-        )}`;
-      } else if (
-        fs.existsSync(
-          path.join(dirname, `/templates/${path.basename(template)}`),
-        )
-      ) {
-        this.template = path.join(
-          dirname,
-          `/templates/${path.basename(template)}`,
-        );
-      } else {
-        this.template = path.join(dirname, `/templates/emptyTemplate`);
-        this.logger.error(
-          `Template '${template}' not found. Using 'emptyTemplate' as a fallback`,
-        );
-      }
-    }
-    this.templateData = templateData;
-    this.i18n = i18n ?? {
-      t: (str) => str,
-      locale: 'en', // todo change it to config
-    };
-    this.locale = this.i18n?.language;
-  }
-
-  /**
-   * Render template
-   * @param {object} type and fullpath
-   * @param {object} templateData
-   * @returns string
-   */
-  // eslint-disable-next-line class-methods-use-this
-  async #renderTemplateFile({ type, fullPath } = {}, templateData = {}) {
-    if (!type) {
-      return null;
-    }
-
-    switch (type) {
-      case 'html':
-      case 'text':
-      case 'css':
-        return fs.promises.readFile(fullPath, { encoding: 'utf8' });
-      case 'pug': {
-        const compiledFunction = pug.compileFile(fullPath);
-        return compiledFunction(templateData);
-      }
-      default:
-        throw new Error(`Template type ${type} is not supported`);
-    }
-  }
-
-  /**
-   * Render template
-   * @return {Promise}
-   */
-  async renderTemplate() {
-    const files = await fs.promises.readdir(this.template);
-    const templates = {};
-    for (const file of files) {
-      const [name, extension] = file.split('.');
-      templates[name] = {
-        type: extension,
-        fullPath: path.join(this.template, file),
-      };
-    }
-
-    if (!templates.html || !templates.subject) {
-      throw new Error(
-        'Template HTML and Subject must be provided. Please follow documentation for details https://framework.adaptivestone.com/docs/email',
-      );
-    }
-    const mailConfig = this.app.getConfig('mail');
-
-    const templateDataToRender = {
-      locale: this.locale,
-      t: this.i18n.t.bind(this.i18n),
-      ...mailConfig.globalVariablesToTemplates,
-      ...this.templateData,
-    };
-
-    const [htmlRendered, subjectRendered, textRendered, extraCss] =
-      await Promise.all([
-        this.#renderTemplateFile(templates.html, templateDataToRender),
-        this.#renderTemplateFile(templates.subject, templateDataToRender),
-        this.#renderTemplateFile(templates.text, templateDataToRender),
-        this.#renderTemplateFile(templates.style),
-      ]);
-
-    juice.tableElements = ['TABLE'];
-
-    const juiceResourcesAsync = promisify(juice.juiceResources);
-
-    const inlinedHTML = await juiceResourcesAsync(htmlRendered, {
-      preserveImportant: true,
-      webResources: mailConfig.webResources,
-      extraCss,
-    });
-    return {
-      htmlRaw: htmlRendered,
-      subject: subjectRendered,
-      text: textRendered,
-      inlinedHTML,
-    };
-  }
-
-  /**
-   * Send email
-   * @param {string} to email send to
-   * @param {string} [from = mailConfig.from]
-   * @param {object} [aditionalNodemailerOptions = {}] additional option to nodemailer
-   * @return {Promise}
-   */
-  async send(to, from = null, aditionalNodemailerOptions = {}) {
-    const { subject, text, inlinedHTML } = await this.renderTemplate();
-
-    return this.constructor.sendRaw(
-      this.app,
-      to,
-      subject,
-      inlinedHTML,
-      text,
-      from,
-      aditionalNodemailerOptions,
-    );
-  }
-
-  /**
-   * Send provided text (html) to email. Low level function. All data should be prepared before sending (like inline styles)
-   * @param {import('../../../server.js').default['app']} app application
-   * @param {string} to send to
-   * @param {string} subject email topic
-   * @param {string} html hmlt body of emain
-   * @param {string} [text] if not provided will be generated from html string
-   * @param {string} [from = mailConfig.from] from. If not provided will be grabbed from config
-   * @param {object} [additionalNodeMailerOption = {}] any otipns to pass to nodemailer  https://nodemailer.com/message/
-   */
-  static async sendRaw(
-    app,
-    to,
-    subject,
-    html,
-    text = null,
-    from = null,
-    additionalNodeMailerOption = {},
-  ) {
-    if (!app || !to || !subject || !html) {
-      throw new Error('App, to, subject and html is required fields.');
-    }
-    const mailConfig = app.getConfig('mail');
-    if (!from) {
-      // eslint-disable-next-line no-param-reassign
-      from = mailConfig.from;
-    }
-
-    if (!text) {
-      // eslint-disable-next-line no-param-reassign
-      text = convert(html, {
-        selectors: [{ selector: 'img', format: 'skip' }],
-      });
-    }
-    const transportConfig = mailConfig.transports[mailConfig.transport];
-    const transport = mailTransports[mailConfig.transport];
-    const transporter = nodemailer.createTransport(transport(transportConfig));
-
-    return transporter.sendMail({
-      from,
-      to,
-      subject,
-      text,
-      html,
-      ...additionalNodeMailerOption,
-    });
-  }
-
-  static get loggerGroup() {
-    return 'email_';
-  }
-}
-
-export default Mail;

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

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

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

@@ -1,9 +0,0 @@
-doctype html
-html(lang='en')
-   head
-     meta(charset='UTF-8')
-     title New message
-   body
-     h1 Good day
-     p
-       | Sorry, message template not found

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

@@ -1 +0,0 @@
-= `New message`

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

@@ -1 +0,0 @@
-= `Good day`

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/messaging/index.js

@@ -1,3 +0,0 @@
-import email from './email/index.js';
-
-export { email };