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

package/services/http/middleware/RateLimiter.js

@@ -4,7 +4,7 @@ import {
   RateLimiterMongo,
 } from 'rate-limiter-flexible';
 import merge from 'deepmerge';
-import redis from 'redis';
+import { createClient } from '@redis/client';
 import mongoose from 'mongoose';
 import AbstractMiddleware from './AbstractMiddleware.js';
 
@@ -46,7 +46,7 @@ class RateLimiter extends AbstractMiddleware {
 
   initRedisLimiter() {
     const redisConfig = this.app.getConfig('redis');
-    const redisClient = redis.createClient({
+    const redisClient = createClient({
       url: redisConfig.url,
     });
 

package/services/validate/ValidateService.js

@@ -1,4 +1,4 @@
-import yup from 'yup';
+import { isSchema } from 'yup';
 import YupValidator from './drivers/YupValidator.js';
 import CustomValidator from './drivers/CustomValidator.js';
 import Base from '../../modules/Base.js';
@@ -7,7 +7,7 @@ class ValidateService extends Base {
   constructor(app, validator) {
     super(app);
     this.validator = validator
-      ? this.constructor.getDriverByValidatorBody(app, validator)
+      ? ValidateService.getDriverByValidatorBody(app, validator)
       : null;
   }
 
@@ -30,7 +30,7 @@ class ValidateService extends Base {
     if (this.isValidatorExists(body)) {
       return body;
     }
-    if (yup.isSchema(body)) {
+    if (isSchema(body)) {
       const yupValidator = new YupValidator(app, body);
       return yupValidator;
     }
@@ -104,7 +104,7 @@ class ValidateService extends Base {
     const result = [];
 
     for (const validator of validators) {
-      const formatedValidator = this.constructor.getDriverByValidatorBody(
+      const formatedValidator = ValidateService.getDriverByValidatorBody(
         this.app,
         validator,
       );

package/services/validate/drivers/AbstractValidator.js

@@ -18,8 +18,8 @@ class AbstractValidator extends Base {
     return {};
   }
 
-  // eslint-disable-next-line class-methods-use-this
-  async validateFields() {
+  // eslint-disable-next-line class-methods-use-this, no-unused-vars
+  async validateFields(data, { query, body, appInfo }) {
     // IMPLENT;
     return true;
   }

package/services/validate/drivers/CustomValidator.js

@@ -1,4 +1,4 @@
-import yup from 'yup';
+import { ValidationError } from 'yup';
 import AbstractValidator from './AbstractValidator.js';
 
 class CustomValidator extends AbstractValidator {
@@ -19,7 +19,7 @@ class CustomValidator extends AbstractValidator {
     } catch (e) {
       this.logger.warn(`CustomValidator validateFields ${e}`);
       if (e.path) {
-        throw new yup.ValidationError({
+        throw new ValidationError({
           [e.path]: e.message,
         });
       }

package/services/validate/drivers/YupValidator.js

@@ -1,9 +1,9 @@
-import yup from 'yup';
+import { ValidationError } from 'yup';
 import AbstractValidator from './AbstractValidator.js';
 
 class YupValidator extends AbstractValidator {
   get fieldsInJsonFormat() {
-    return this.constructor.convertFieldsToJson(this.body);
+    return YupValidator.convertFieldsToJson(this.body);
   }
 
   static convertFieldsToJson(fields) {
@@ -76,7 +76,7 @@ class YupValidator extends AbstractValidator {
         });
       }
 
-      throw new yup.ValidationError({
+      throw new ValidationError({
         ...errorAnswer,
       });
     }

package/tests/setup.js

@@ -3,7 +3,7 @@ import path from 'node:path';
 import { randomBytes } from 'node:crypto';
 import { MongoMemoryReplSet } from 'mongodb-memory-server';
 import mongoose from 'mongoose';
-import redis from 'redis';
+import { createClient } from '@redis/client';
 import Server from '../server.js';
 
 import clearRedisNamespace from '../helpers/redis/clearNamespace.js';
@@ -12,7 +12,9 @@ mongoose.set('autoIndex', false);
 
 let mongoMemoryServerInstance;
 
+// @ts-ignore
 jest.setTimeout(1000000);
+// @ts-ignore
 beforeAll(async () => {
   mongoMemoryServerInstance = await MongoMemoryReplSet.create({
     // binary: { version: '4.4.6' },
@@ -29,7 +31,6 @@ beforeAll(async () => {
       config: process.env.TEST_FOLDER_CONFIG || path.resolve('./config'),
       controllers:
         process.env.TEST_FOLDER_CONTROLLERS || path.resolve('./controllers'),
-      views: process.env.TEST_FOLDER_VIEWS || path.resolve('./views'),
       models: process.env.TEST_FOLDER_MODELS || path.resolve('./models'),
       emails:
         process.env.TEST_FOLDER_EMAIL ||
@@ -64,9 +65,7 @@ beforeAll(async () => {
         nick: 'testUserNickName',
       },
     }).catch((e) => {
-      // eslint-disable-next-line no-console
       console.error(e);
-      // eslint-disable-next-line no-console
       console.info(
         'That error can happens in case you have custom user model. Please use global.testSetup.disableUserCreate flag to skip user creating',
       );
@@ -79,6 +78,7 @@ beforeAll(async () => {
   await global.server.startServer();
 });
 
+// @ts-ignore
 beforeEach(() => {
   if (global.server) {
     const key = `test-${Math.random().toString(36).substring(7)}`;
@@ -88,21 +88,23 @@ beforeEach(() => {
   }
 });
 
+// @ts-ignore
 afterEach(async () => {
   if (global.server) {
     const { url, namespace } = global.server.getConfig('redis');
-    const redisClient = redis.createClient({ url });
+    const redisClient = createClient({ url });
 
     try {
       await redisClient.connect();
       await clearRedisNamespace(redisClient, namespace);
       await redisClient.disconnect();
-    } catch (err) {
+    } catch {
       // that ok. No redis connection
     }
   }
 });
 
+// @ts-ignore
 afterAll(async () => {
   if (global.server) {
     global.server.app.httpServer.shutdown();

package/tests/setupVitest.js

@@ -4,7 +4,7 @@ import { beforeAll, beforeEach, afterEach, afterAll } from 'vitest';
 
 import mongoose from 'mongoose'; // we do not need create indexes on tests
 
-import redis from 'redis';
+import { createClient } from '@redis/client';
 import clearRedisNamespace from '../helpers/redis/clearNamespace.js';
 import Server from '../server.js';
 
@@ -18,7 +18,6 @@ beforeAll(async () => {
       config: process.env.TEST_FOLDER_CONFIG || path.resolve('./config'),
       controllers:
         process.env.TEST_FOLDER_CONTROLLERS || path.resolve('./controllers'),
-      views: process.env.TEST_FOLDER_VIEWS || path.resolve('./views'),
       models: process.env.TEST_FOLDER_MODELS || path.resolve('./models'),
       emails:
         process.env.TEST_FOLDER_EMAIL ||
@@ -57,9 +56,7 @@ beforeAll(async () => {
         nick: 'testUserNickName',
       },
     }).catch((e) => {
-      // eslint-disable-next-line no-console
       console.error(e);
-      // eslint-disable-next-line no-console
       console.info(
         'That error can happens in case you have custom user model. Please use global.testSetup.disableUserCreate flag to skip user creating',
       );
@@ -84,13 +81,13 @@ beforeEach(() => {
 afterEach(async () => {
   if (global.server) {
     const { url, namespace } = global.server.getConfig('redis');
-    const redisClient = redis.createClient({ url });
+    const redisClient = createClient({ url });
 
     try {
       await redisClient.connect();
       await clearRedisNamespace(redisClient, namespace);
       await redisClient.disconnect();
-    } catch (err) {
+    } catch {
       // that ok. No redis connection
     }
   }
@@ -104,6 +101,11 @@ afterAll(async () => {
   if (typeof global.testSetup.afterAll === 'function') {
     await global.testSetup.afterAll();
   }
-  await mongoose.connection.db.dropDatabase(); // clean database after test
+  try {
+    await mongoose.connection.db.dropDatabase(); // clean database after test
+  } catch {
+    // that ok. No mongoose connection
+  }
+
   await mongoose.disconnect();
 });

package/types/ICommandArguments.d.ts

@@ -0,0 +1,41 @@
+// this is from nodejs types
+interface ParseArgsOptionConfig {
+  /**
+   * Type of argument.
+   */
+  type: 'string' | 'boolean';
+  /**
+   * Whether this option can be provided multiple times.
+   * If `true`, all values will be collected in an array.
+   * If `false`, values for the option are last-wins.
+   * @default false.
+   */
+  multiple?: boolean | undefined;
+  /**
+   * A single character alias for the option.
+   */
+  short?: string | undefined;
+  /**
+   * The default option value when it is not set by args.
+   * It must be of the same type as the the `type` property.
+   * When `multiple` is `true`, it must be an array.
+   * @since v18.11.0
+   */
+  default?: string | boolean | string[] | boolean[] | undefined;
+}
+
+interface ParseArgsOptionsConfigExtended extends ParseArgsOptionConfig {
+  /**
+   * A description of the option.
+   */
+  description?: string;
+
+  /**
+   * Is it required?
+   */
+  required?: boolean;
+}
+
+export interface ICommandArguments {
+  [longOption: string]: ParseArgsOptionsConfigExtended;
+}

package/types/TFoldersConfig.d.ts

@@ -2,16 +2,19 @@
  * @param config path to folder with config files
  * @param models path to folder with moidels files
  * @param controllers path to folder with controllers files
- * @param views path to folder with view files
+ * @param migrations path to folder with migrations files
  * @param locales path to folder with locales files
- * @param emails path to folder with emails files
+ * @param migrations path to folder with migrations files
+ * @param [emails] path to folder with emails files. Optional
  */
 type FolderConfig = {
   config: string;
   models: string;
   controllers: string;
-  views: string;
-  emails: string;
+  commands: string;
+  locales: string;
+  migrations: string;
+  emails?: string;
 };
 
 export default FolderConfig;

package/vitest.config.js

@@ -1,4 +1,4 @@
-// eslint-disable-next-line import/no-unresolved
+// eslint-disable-next-line import-x/no-unresolved
 import { defineConfig } from 'vitest/config';
 
 export default defineConfig({
@@ -6,11 +6,12 @@ export default defineConfig({
     globalSetup: './tests/globalSetupVitest.js',
     setupFiles: './tests/setupVitest.js',
     testTimeout: 10000,
-    outputFile: './coverage/rspec.xml',
+    outputFile: './coverage/junit.rspec.xml',
     reporters: ['default', 'junit'],
     coverage: {
+      provider: 'v8',
       enabled: true,
-      reporter: ['text', 'html', 'clover', 'json', 'cobertura'],
+      reporter: ['text', 'html', 'clover', 'json'],
     },
   },
 });

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

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