@adaptivestone/framework 4.11.4 → 5.0.0-alpha.10

package/modules/AbstractConnector.js

@@ -1,4 +1,4 @@
-const Base = require('./Base');
+import Base from './Base.js';
 
 class AbstractConnector extends Base {
   static get loggerGroup() {
@@ -6,4 +6,4 @@ class AbstractConnector extends Base {
   }
 }
 
-module.exports = AbstractConnector;
+export default AbstractConnector;

package/modules/AbstractController.js

@@ -1,11 +1,12 @@
 /* eslint-disable no-restricted-syntax */
 /* eslint-disable guard-for-in */
-const express = require('express');
-const Base = require('./Base');
-const GetUserByToken = require('../services/http/middleware/GetUserByToken');
-const Auth = require('../services/http/middleware/Auth');
-const ValidateService = require('../services/validate/ValidateService');
-const DocumentationGenerator = require('../services/documentation/DocumentationGenerator');
+import express from 'express';
+
+import Base from './Base.js';
+import GetUserByToken from '../services/http/middleware/GetUserByToken.js';
+import Auth from '../services/http/middleware/Auth.js';
+import ValidateService from '../services/validate/ValidateService.js';
+import DocumentationGenerator from '../services/documentation/DocumentationGenerator.js';
 /**
  * Abstract controller. You should extend any controller from them.
  * Place you cintroller into controller folder and it be inited in auto way.
@@ -24,10 +25,12 @@ class AbstractController extends Base {
     const { routes } = this;
     let httpPath = this.getHttpPath();
 
+    // @ts-ignore
     if (this.getExpressPath) {
       this.logger.warn(
         `getExpressPath deprecated. Please use getHttpPath instead. Will be removed on v5`,
       );
+      // @ts-ignore
       httpPath = this.getExpressPath();
     }
 
@@ -57,6 +60,7 @@ class AbstractController extends Base {
       httpPath,
     );
     const middlewaresInfo = this.parseMiddlewares(
+      // @ts-ignore
       this.constructor.middleware,
       httpPath,
     );
@@ -369,6 +373,7 @@ class AbstractController extends Base {
    * You should provide path relative to controller and then array of middlewares to apply.
    * Order is matter.
    * Be default path apply to ANY' method, but you can preattach 'METHOD' into patch to scope patch to this METHOD
+   * @returns {Map<string, Array<AbstractMiddleware | [Function, ...any]>>}
    * @example
    * return new Map([
    *    ['/*', [GetUserByToken]] // for any method for this controller
@@ -405,4 +410,4 @@ class AbstractController extends Base {
   }
 }
 
-module.exports = AbstractController;
+export default AbstractController;

package/modules/AbstractModel.js

@@ -1,14 +1,14 @@
-const mongoose = require('mongoose');
-const Base = require('./Base');
+import mongoose from 'mongoose';
+import Base from './Base.js';
 
 class AbstractModel extends Base {
   /**
-   * @param {import('../server')} app  //TODO change to *.d.ts as this is a Server, not app
+   * @param {import('../server.js').default['app']} app  //TODO change to *.d.ts as this is a Server, not app
    * @param function callback optional callback when connection ready
    */
   constructor(app, callback = () => {}) {
     super(app);
-    this.mongooseSchema = mongoose.Schema(this.modelSchema);
+    this.mongooseSchema = new mongoose.Schema(this.modelSchema);
     mongoose.set('strictQuery', true);
     this.mongooseSchema.set('timestamps', true);
     this.mongooseSchema.set('minimize', false);
@@ -22,6 +22,9 @@ class AbstractModel extends Base {
     );
     if (!mongoose.connection.readyState) {
       this.app.events.on('shutdown', async () => {
+        this.logger.verbose(
+          'Shutdown was called. Closing all mongoose connections',
+        );
         for (const c of mongoose.connections) {
           c.close(true);
         }
@@ -59,4 +62,4 @@ class AbstractModel extends Base {
     this.logger.verbose('Model have no hooks');
   }
 }
-module.exports = AbstractModel;
+export default AbstractModel;

package/modules/Base.d.ts

@@ -1,5 +1,6 @@
 import winston from 'winston';
-import Server from '../server';
+import Server from '../server.js';
+import type { Dirent } from 'fs';
 
 declare class Base {
   app: Server['app'];
@@ -26,11 +27,11 @@ declare class Base {
   getFilesPathWithInheritance(
     internalFolder: string,
     externalFolder: string,
-  ): Promise<string[]>;
+  ): Promise<Dirent[]>;
 
   /**
    * Return logger group. Just to have all logs groupped logically
    */
   static get loggerGroup(): string;
 }
-export = Base;
+export default Base;

package/modules/Base.js

@@ -1,4 +1,4 @@
-const { getFilesPathWithInheritance } = require('../helpers/files');
+import { getFilesPathWithInheritance } from '../helpers/files.js';
 
 class Base {
   #realLogger = null;
@@ -50,4 +50,4 @@ class Base {
   }
 }
 
-module.exports = Base;
+export default Base;

package/modules/BaseCli.js

@@ -1,6 +1,7 @@
 /* eslint-disable no-console */
-const path = require('node:path');
-const Base = require('./Base');
+import path from 'node:path';
+import * as url from 'node:url';
+import Base from './Base.js';
 
 class Cli extends Base {
   constructor(server) {
@@ -13,8 +14,9 @@ class Cli extends Base {
     if (Object.keys(this.commands).length) {
       return true;
     }
+    const dirname = url.fileURLToPath(new URL('.', import.meta.url));
     const commandsToLoad = await this.getFilesPathWithInheritance(
-      path.join(__dirname, '/../commands'),
+      path.join(dirname, '../commands'),
       this.server.app.foldersConfig.commands,
     );
     for (const com of commandsToLoad) {
@@ -64,4 +66,4 @@ class Cli extends Base {
   }
 }
 
-module.exports = Cli;
+export default Cli;

package/modules/Modules.test.js

@@ -1,6 +1,6 @@
 import { describe, it, expect } from 'vitest';
-import SomeController from '../controllers/test/SomeController';
-import AbstractController from './AbstractController';
+import SomeController from '../controllers/test/SomeController.js';
+import AbstractController from './AbstractController.js';
 
 describe('abstract controller methods', () => {
   it('can get routes', async () => {

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@adaptivestone/framework",
-  "version": "4.11.4",
+  "version": "5.0.0-alpha.10",
   "description": "Adaptive stone node js framework",
   "main": "index.js",
+  "type": "module",
   "engines": {
-    "node": ">=18.17.0"
+    "node": ">=20.12.0"
   },
   "repository": {
     "type": "git",
@@ -12,14 +13,15 @@
   },
   "homepage": "https://framework.adaptivestone.com/",
   "scripts": {
-    "dev": "nodemon ./index.js",
-    "prod": "nodemon ./cluster.js",
+    "dev": "node --watch ./index.js",
+    "prod": "node --watch ./cluster.js",
     "test": "vitest run",
+    "t": "vitest --coverage=false --reporter=default",
     "prettier": "prettier --check '**/*.(js|jsx|ts|tsx|json|css|scss|md)'",
     "lint": "eslint '**/*.js'",
     "lint:fix": "eslint '**/*.js' --fix",
     "codestyle": "npm run prettier && npm run lint",
-    "prepare": "husky install",
+    "prepare": "husky",
     "cli": "node cliCommand",
     "benchmark": "h2load -n 10000 -c 50 -p 'http/1.1' http://localhost:3300/",
     "benchmark2": "h2load -n 10000 -c 50  https://localhost:3300/",
@@ -29,40 +31,38 @@
   "license": "MIT",
   "dependencies": {
     "deepmerge": "^4.2.2",
-    "dotenv": "^16.0.0",
     "express": "^4.17.1",
     "formidable": "^3.5.1",
     "html-to-text": "^9.0.3",
     "i18next": "^23.2.8",
     "i18next-chained-backend": "^4.0.0",
     "i18next-fs-backend": "^2.0.0",
-    "juice": "^9.0.0",
-    "mime": "^3.0.0",
+    "juice": "^10.0.0",
+    "mime": "^4.0.0",
     "minimist": "^1.2.5",
-    "mongoose": "^7.0.0",
+    "mongoose": "^8.0.0",
     "nodemailer": "^6.6.3",
     "nodemailer-sendmail-transport": "^1.0.2",
     "nodemailer-stub-transport": "^1.1.0",
     "pug": "^3.0.2",
-    "rate-limiter-flexible": "^3.0.0",
+    "rate-limiter-flexible": "^5.0.0",
     "redis": "^4.3.1",
     "winston": "^3.3.3",
     "winston-transport-sentry-node": "^2.0.0",
     "yup": "^1.0.0"
   },
   "devDependencies": {
-    "@vitest/coverage-v8": "^0.34.3",
+    "@vitest/coverage-v8": "^2.0.0",
     "eslint": "^8.0.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-prettier": "^5.0.0",
-    "eslint-plugin-vitest": "^0.3.1",
-    "husky": "^8.0.0",
+    "eslint-plugin-vitest": "^0.4.0",
+    "husky": "^9.0.0",
     "lint-staged": "^15.0.0",
-    "mongodb-memory-server": "^9.0.0",
-    "nodemon": "^3.0.1",
+    "mongodb-memory-server": "^10.0.0",
     "prettier": "^3.0.0",
-    "vitest": "^0.34.3"
+    "vitest": "^2.0.0"
   },
   "lint-staged": {
     "**/*.{js,jsx,ts,tsx,json,css,scss,md}": [

package/server.d.ts

@@ -9,6 +9,8 @@ import BaseCli from './modules/BaseCli';
 import Cache from './services/cache/Cache';
 import winston from 'winston';
 
+import HttpServer from './services/http/HttpServer.js';
+
 type ServerConfig = {
   folders: ExpandDeep<TFolderConfig>;
 };
@@ -24,7 +26,7 @@ declare class Server {
     events: EventEmitter;
     get cache(): Server['cacheService'];
     get logger(): winston.Logger;
-    httpServer: null;
+    httpServer: HttpServer | null;
     controllerManager: null;
   };
   cacheService: Cache;
@@ -33,7 +35,7 @@ declare class Server {
     configs: Map<string, {}>;
     models: Map<string, MongooseModel<any>>;
   };
-  cli: boolean;
+  cli: null | BaseCli;
 
   /**
    *  Construct new server
@@ -68,7 +70,7 @@ declare class Server {
    * @see updateConfig
    * @TODO generate that based on real data
    */
-  getConfig(configName: string): {};
+  getConfig(configName: string): { [key: string]: any };
 
   /**
    * Return or create new logger instance. This is a main logger instance
@@ -79,7 +81,7 @@ declare class Server {
    * Primary designed for tests when we need to update some configs before start testing
    * Should be called before any initialization was done
    */
-  updateConfig(configName: string, config: {}): {};
+  updateConfig(configName: string, config: {}): { [key: string]: any };
 
   /**
    * Return model from {modelName} (file name) on model folder.
@@ -93,4 +95,4 @@ declare class Server {
   runCliCommand(commandName: string, args: {}): Promise<BaseCli['run']>;
 }
 
-export = Server;
+export default Server;

package/server.js

@@ -1,14 +1,20 @@
 /* eslint-disable no-console */
-const EventEmitter = require('node:events');
-const { hrtime } = require('node:process');
-
-require('dotenv').config();
-const merge = require('deepmerge');
-const winston = require('winston');
-const { getFilesPathWithInheritance } = require('./helpers/files');
-const { consoleLogger } = require('./helpers/logger');
-
-const Cache = require('./services/cache/Cache');
+import EventEmitter from 'node:events';
+import { hrtime, loadEnvFile } from 'node:process';
+import * as url from 'node:url';
+import path from 'node:path';
+
+import merge from 'deepmerge';
+import winston from 'winston';
+import { getFilesPathWithInheritance } from './helpers/files.js';
+import { consoleLogger } from './helpers/logger.js';
+import Cache from './services/cache/Cache.js';
+
+try {
+  loadEnvFile();
+} catch (e) {
+  console.warn('No env file found. This is ok. But please check youself.');
+}
 
 /**
  * Main framework class.
@@ -18,6 +24,8 @@ class Server {
 
   #isInited = false;
 
+  cli = null;
+
   /**
    *  Construct new server
    * @param {Object} config main config object
@@ -26,7 +34,6 @@ class Server {
    * @param {String} config.folders.models path to folder with moidels files
    * @param {String} config.folders.controllers path to folder with controllers files
    * @param {String} config.folders.views path to folder with view files
-   * @param {String} config.folders.public path to folder with public files
    * @param {String} config.folders.locales path to folder with locales files
    * @param {String} config.folders.emails path to folder with emails files
    */
@@ -55,8 +62,6 @@ class Server {
       models: new Map(),
       modelConstructors: new Map(),
     };
-
-    this.cli = false;
   }
 
   /**
@@ -139,8 +144,9 @@ class Server {
   }
 
   async #initConfigFiles() {
+    const dirname = url.fileURLToPath(new URL('.', import.meta.url));
     const files = await getFilesPathWithInheritance({
-      internalFolder: `${__dirname}/config`,
+      internalFolder: path.join(dirname, '/config'),
       externalFolder: this.app.foldersConfig.config,
       loggerFileType: 'CONFIG',
       logger: (m) => consoleLogger('info', m),
@@ -192,8 +198,9 @@ class Server {
   }
 
   async #loadModelFiles() {
+    const dirname = url.fileURLToPath(new URL('.', import.meta.url));
     const files = await getFilesPathWithInheritance({
-      internalFolder: `${__dirname}/models`,
+      internalFolder: path.join(dirname, '/models'),
       externalFolder: this.app.foldersConfig.models,
       loggerFileType: 'MODEL',
       logger: (m) => consoleLogger('info', m),
@@ -347,7 +354,7 @@ class Server {
    * Return model from {modelName} (file name) on model folder.
    * Support cache
    * @param {String} modelName name on config file to load
-   * @returns {import('mongoose').Model}
+   * @returns {import('mongoose').Model | false| {}}
    */
   getModel(modelName) {
     if (modelName.endsWith('s')) {
@@ -395,4 +402,4 @@ class Server {
   }
 }
 
-module.exports = Server;
+export default Server;

package/services/cache/Cache.d.ts

@@ -1,5 +1,5 @@
 import Base from '../../modules/Base';
-import Server from '../../server';
+import Server from '../../server.js';
 
 declare class Cache extends Base {
   app: Server['app'];
@@ -32,4 +32,4 @@ declare class Cache extends Base {
   removeKey(key: string): Promise<number>;
 }
 
-export = Cache;
+export default Cache;

package/services/cache/Cache.js

@@ -1,4 +1,4 @@
-const Base = require('../../modules/Base');
+import Base from '../../modules/Base.js';
 
 class Cache extends Base {
   constructor(app) {
@@ -69,12 +69,14 @@ class Cache extends Base {
         return Promise.reject(e);
       }
 
-      this.redisClient.setEx(
+      this.redisClient.set(
         key,
-        storeTime,
         JSON.stringify(result, (jsonkey, value) =>
           typeof value === 'bigint' ? `${value}n` : value,
         ),
+        {
+          EX: storeTime,
+        },
       );
     } else {
       this.logger.verbose(
@@ -117,4 +119,4 @@ class Cache extends Base {
   }
 }
 
-module.exports = Cache;
+export default Cache;

package/services/documentation/DocumentationGenerator.js

@@ -1,5 +1,5 @@
-const Base = require('../../modules/Base');
-const ValidateService = require('../validate/ValidateService');
+import Base from '../../modules/Base.js';
+import ValidateService from '../validate/ValidateService.js';
 
 class DocumentationGenerator extends Base {
   // eslint-disable-next-line class-methods-use-this
@@ -166,4 +166,4 @@ class DocumentationGenerator extends Base {
   }
 }
 
-module.exports = DocumentationGenerator;
+export default DocumentationGenerator;

package/services/http/HttpServer.js

@@ -1,15 +1,14 @@
-const http = require('node:http');
-const path = require('node:path');
-const express = require('express');
-
-const RequestLoggerMiddleware = require('./middleware/RequestLogger');
-const I18nMiddleware = require('./middleware/I18n');
-const PrepareAppInfoMiddleware = require('./middleware/PrepareAppInfo');
-const RequestParserMiddleware = require('./middleware/RequestParser');
-const StaticFilesMiddleware = require('./middleware/StaticFiles');
-const Cors = require('./middleware/Cors');
-
-const Base = require('../../modules/Base');
+import http from 'node:http';
+import path from 'node:path';
+import * as url from 'node:url';
+import express from 'express';
+import RequestLoggerMiddleware from './middleware/RequestLogger.js';
+import I18nMiddleware from './middleware/I18n.js';
+import PrepareAppInfoMiddleware from './middleware/PrepareAppInfo.js';
+import RequestParserMiddleware from './middleware/RequestParser.js';
+import IpDetector from './middleware/IpDetector.js';
+import Cors from './middleware/Cors.js';
+import Base from '../../modules/Base.js';
 
 /**
  * HTTP server based on Express
@@ -19,13 +18,15 @@ class HttpServer extends Base {
     super(app);
     this.express = express();
     this.express.disable('x-powered-by');
+    const dirname = url.fileURLToPath(new URL('.', import.meta.url));
     this.express.set('views', [
       this.app.foldersConfig.views,
-      path.join(__dirname, '../../views'),
+      path.join(dirname, '../../views'),
     ]);
     this.express.set('view engine', 'pug');
 
     this.express.use(new PrepareAppInfoMiddleware(this.app).getMiddleware());
+    this.express.use(new IpDetector(this.app).getMiddleware());
     this.express.use(new RequestLoggerMiddleware(this.app).getMiddleware());
     this.express.use(new I18nMiddleware(this.app).getMiddleware());
 
@@ -35,15 +36,6 @@ class HttpServer extends Base {
         origins: httpConfig.corsDomains,
       }).getMiddleware(),
     );
-    // todo whitelist
-    this.express.use(
-      new StaticFilesMiddleware(this.app, {
-        folders: [
-          this.app.foldersConfig.public,
-          path.join(__dirname, '../../public/files'),
-        ],
-      }).getMiddleware(),
-    );
 
     this.express.use(new RequestParserMiddleware(this.app).getMiddleware());
 
@@ -57,7 +49,7 @@ class HttpServer extends Base {
       res.status(500).json({ message: 'Something broke!' });
     });
 
-    this.httpServer = http.Server(this.express);
+    this.httpServer = http.createServer(this.express);
 
     const listener = this.httpServer.listen(
       httpConfig.port,
@@ -101,4 +93,4 @@ class HttpServer extends Base {
   }
 }
 
-module.exports = HttpServer;
+export default HttpServer;

package/services/http/middleware/AbstractMiddleware.js

@@ -1,5 +1,5 @@
-const yup = require('yup');
-const Base = require('../../../modules/Base');
+import yup from 'yup';
+import Base from '../../../modules/Base.js';
 
 class AbstractMiddleware extends Base {
   constructor(app, params) {
@@ -48,4 +48,4 @@ class AbstractMiddleware extends Base {
   }
 }
 
-module.exports = AbstractMiddleware;
+export default AbstractMiddleware;

package/services/http/middleware/Auth.js

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

package/services/http/middleware/Auth.test.js

@@ -1,5 +1,5 @@
 import { beforeAll, describe, it, expect } from 'vitest';
-import Auth from './Auth';
+import Auth from './Auth.js';
 
 describe('atuh middleware methods', () => {
   let middleware;

package/services/http/middleware/Cors.js

@@ -1,4 +1,4 @@
-const AbstractMiddleware = require('./AbstractMiddleware');
+import AbstractMiddleware from './AbstractMiddleware.js';
 
 class Cors extends AbstractMiddleware {
   constructor(app, params) {
@@ -43,4 +43,4 @@ class Cors extends AbstractMiddleware {
   }
 }
 
-module.exports = Cors;
+export default Cors;

package/services/http/middleware/Cors.test.js

@@ -1,5 +1,5 @@
 import { describe, it, expect } from 'vitest';
-import Cors from './Cors';
+import Cors from './Cors.js';
 
 describe('cors middleware methods', () => {
   it('have description fields', async () => {

package/services/http/middleware/GetUserByToken.js

@@ -1,4 +1,4 @@
-const AbstractMiddleware = require('./AbstractMiddleware');
+import AbstractMiddleware from './AbstractMiddleware.js';
 
 class GetUserByToken extends AbstractMiddleware {
   static get description() {
@@ -11,7 +11,7 @@ class GetUserByToken extends AbstractMiddleware {
         name: 'Authorization',
         type: 'apiKey',
         in: 'header',
-        description: this?.description,
+        description: this.constructor.description,
       },
     ];
   }
@@ -43,4 +43,4 @@ class GetUserByToken extends AbstractMiddleware {
   }
 }
 
-module.exports = GetUserByToken;
+export default GetUserByToken;

package/services/http/middleware/GetUserByToken.test.js

@@ -1,5 +1,5 @@
 import { describe, it, expect } from 'vitest';
-import GetUserByToken from './GetUserByToken';
+import GetUserByToken from './GetUserByToken.js';
 
 describe('getUserByToken middleware methods', () => {
   it('have description fields', async () => {

package/services/http/middleware/I18n.js

@@ -1,8 +1,7 @@
-const i18next = require('i18next');
-const BackendFS = require('i18next-fs-backend');
-const Backend = require('i18next-chained-backend');
-
-const AbstractMiddleware = require('./AbstractMiddleware');
+import i18next from 'i18next';
+import BackendFS from 'i18next-fs-backend';
+import Backend from 'i18next-chained-backend';
+import AbstractMiddleware from './AbstractMiddleware.js';
 
 class I18n extends AbstractMiddleware {
   constructor(app, params) {
@@ -116,4 +115,4 @@ class I18n extends AbstractMiddleware {
   }
 }
 
-module.exports = I18n;
+export default I18n;

package/services/http/middleware/I18n.test.js

@@ -1,5 +1,5 @@
 import { beforeAll, describe, it, expect } from 'vitest';
-import I18n from './I18n';
+import I18n from './I18n.js';
 
 describe('i18n middleware methods', () => {
   let middleware;