@adaptivestone/framework 5.0.0-alpha.9 → 5.0.0-beta.1

package/CHANGELOG.md

@@ -1,3 +1,87 @@
+### 5.0.0-beta.1
+
+[UPDATE] update deps
+[BREAKING] vitest v3 https://vitest.dev/guide/migration.html
+
+### 5.0.0-alpha.26
+
+[UPDATE] update deps
+[UPDATE] new commands view in CLI
+
+### 5.0.0-alpha.24
+
+[UPDATE] update deps
+[BREAKING] i18next v24 https://www.i18next.com/misc/migration-guide#v23.x.x-to-v24.0.0
+
+### 5.0.0-alpha.23
+
+[UPDATE] update deps
+
+### 5.0.0-alpha.22
+
+[UPDATE] update deps
+[FIX] fix optional routing parameters
+
+### 5.0.0-alpha.21
+
+[BREAKING] possible breaking. Framework start using express 5 instead of express 4. Please follow express migration guide too https://expressjs.com/en/guide/migrating-5.html.
+[BREAKING] AS part of express 5 migration _ in rotes (middlewares) should have perameter. please replace _ to \*splat
+[UPDATE] update deps
+[UPDATE] Mailer uses await import() for startup speedup
+
+### 5.0.0-alpha.20
+
+[UPDATE] update deps
+[UPDATE] #realLogger do not throw error in a scecific cases (model toJSON({virtual:true}))
+
+### 5.0.0-alpha.19
+
+[NEW] added modelSchemaOptions for models
+
+### 5.0.0-alpha.18
+
+[BREAKING] default auth responce changed to be unified. {token, user} = > {data:{token, user}}
+[UPDATE] RateLimiter updae key generation
+
+### 5.0.0-alpha.17
+
+[NEW] generateRandomBytes command
+[UPDATE] update deps
+
+### 5.0.0-alpha.16
+
+[UPDATE] no warning of direct usage body and query
+[UPDATE] update deps
+
+### 5.0.0-alpha.15
+
+[BUG] fix bug with pagination
+[UPDATE] update deps
+
+### 5.0.0-alpha.14
+
+[NEW] add types for Abstract model (wip)
+
+### 5.0.0-alpha.13
+
+[UPDATE] update deps
+[UPDATE] update i18n internal implementation
+[CHANGE] disable https server view
+
+### 5.0.0-alpha.12
+
+[UPDATE] update deps
+
+### 5.0.0-alpha.11
+
+[UPDATE] update deps
+
+### 5.0.0-alpha.10
+
+[UPDATE] update deps
+[NEW] IpDetector middleware that support detecting proxy and X-Forwarded-For header
+[BREAKING] RateLimiter now need to have IpDetector middleware before
+
 ### 5.0.0-alpha.9
 
 [UPDATE] update deps

package/commands/CreateUser.js

@@ -2,6 +2,10 @@ import AbstractCommand from '../modules/AbstractCommand.js';
 
 // Example: node src/cli createuser --email=somemail@gmail.com  --password=somePassword --roles=user,admin,someOtherRoles
 class CreateUser extends AbstractCommand {
+  static get description() {
+    return 'Create user in a database';
+  }
+
   async run() {
     const User = this.app.getModel('User');
     const { id, email, password, roles, update } = this.args;

package/commands/Documentation.js

@@ -2,6 +2,10 @@ import AbstractCommand from '../modules/AbstractCommand.js';
 import ControllerManager from '../controllers/index.js';
 
 class Documentation extends AbstractCommand {
+  static get description() {
+    return 'Generate documentation (internal)';
+  }
+
   async run() {
     const CM = new ControllerManager(this.app);
     this.app.documentation = [];

package/commands/GenerateRandomBytes.js

@@ -0,0 +1,19 @@
+import { randomBytes } from 'node:crypto';
+import AbstractCommand from '../modules/AbstractCommand.js';
+
+class GenerateRandomBytes extends AbstractCommand {
+  static get description() {
+    return 'Generate random bytes ising randomBytes from  node:crypto';
+  }
+
+  async run() {
+    const sizes = [16, 32, 64, 128, 256];
+    for (const size of sizes) {
+      const bytes = randomBytes(size).toString('hex');
+      this.logger.info(`${size} bytes: ${bytes}`);
+    }
+    return true;
+  }
+}
+
+export default GenerateRandomBytes;

package/commands/GetOpenApiJson.js

@@ -5,6 +5,10 @@ import AbstractCommand from '../modules/AbstractCommand.js';
  * Command for generate documentation json file openApi
  */
 class GetOpenApiJson extends AbstractCommand {
+  static get description() {
+    return 'Generate documentation (openApi) ';
+  }
+
   async run() {
     const { myDomain } = this.app.getConfig('http');
     let jsonFile = process.env.npm_package_json;

package/config/auth.js

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

package/config/ipDetector.js

@@ -0,0 +1,14 @@
+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/controllers/Auth.js

@@ -83,7 +83,7 @@ class Auth extends AbstractController {
     }
     const token = await user.generateToken();
 
-    return res.status(200).json({ token, user: user.getPublic() });
+    return res.status(200).json({ data: { token, user: user.getPublic() } });
   }
 
   async postRegister(req, res) {
@@ -203,7 +203,7 @@ class Auth extends AbstractController {
   }
 
   static get middleware() {
-    return new Map([['/*', [GetUserByToken, RateLimiter]]]);
+    return new Map([['/{*splat}', [GetUserByToken, RateLimiter]]]);
   }
 }
 

package/controllers/Home.js

@@ -21,7 +21,7 @@ class Home extends AbstractController {
   }
 
   static get middleware() {
-    return new Map([['/*', [GetUserByToken]]]);
+    return new Map([['/{*splat}', [GetUserByToken]]]);
   }
 }
 

package/helpers/files.js

@@ -8,7 +8,7 @@ const getFilesPathWithInheritance = async ({
   loggerFileType = '',
   filter: { startWithCapital = true, notTests = true, notHidden = true } = {},
 }) => {
-  let [internalFiles, externalFiles] = await Promise.all([
+  const [internalFiles, externalFiles] = await Promise.all([
     fs.readdir(internalFolder, { recursive: true, withFileTypes: true }),
     fs.readdir(externalFolder, { recursive: true, withFileTypes: true }),
   ]);
@@ -33,24 +33,24 @@ const getFilesPathWithInheritance = async ({
     return true;
   };
 
-  internalFiles = internalFiles
+  const internalFilesString = internalFiles
     .filter(filterIndexFile)
     .map((fileDirent) =>
-      join(fileDirent.path, fileDirent.name)
+      join(fileDirent.parentPath, fileDirent.name)
         .replace(`${internalFolder}/`, '')
         .replace(`${internalFolder}`, ''),
     );
-  externalFiles = externalFiles
+  const externalFilesString = externalFiles
     .filter(filterIndexFile)
     .map((fileDirent) =>
-      join(fileDirent.path, fileDirent.name)
+      join(fileDirent.parentPath, fileDirent.name)
         .replace(`${externalFolder}/`, '')
         .replace(`${externalFolder}`, ''),
     );
 
   const filesToLoad = [];
-  for (const file of internalFiles) {
-    if (externalFiles.includes(file)) {
+  for (const file of internalFilesString) {
+    if (externalFilesString.includes(file)) {
       logger(
         `Skipping register INTERNAL file '${file}' ${
           loggerFileType ? `of type ${loggerFileType}` : ''
@@ -64,7 +64,7 @@ const getFilesPathWithInheritance = async ({
     }
   }
 
-  for (const file of externalFiles) {
+  for (const file of externalFilesString) {
     filesToLoad.push({
       path: join(externalFolder, file),
       file,

package/models/User.js

@@ -4,7 +4,6 @@ import { scrypt } from 'node:crypto';
 
 import { promisify } from 'node:util';
 import AbstractModel from '../modules/AbstractModel.js';
-import Mailer from '../services/messaging/email/index.js';
 
 class User extends AbstractModel {
   constructor(app) {
@@ -175,6 +174,10 @@ class User extends AbstractModel {
   async sendPasswordRecoveryEmail(i18n) {
     const passwordRecoveryToken =
       await User.generateUserPasswordRecoveryToken(this);
+    // speed optimisation
+    const Mailer = (await import('../services/messaging/email/index.js'))
+      .default;
+
     const mail = new Mailer(
       this.getSuper().app,
       'recovery',
@@ -241,6 +244,9 @@ class User extends AbstractModel {
 
   async sendVerificationEmail(i18n) {
     const verificationToken = await User.generateUserVerificationToken(this);
+    // speed optimisation
+    const Mailer = (await import('../services/messaging/email/index.js'))
+      .default;
     const mail = new Mailer(
       this.getSuper().app,
       'verification',

package/modules/AbstractCommand.js

@@ -8,7 +8,7 @@ class AbstractCommand extends Base {
   }
 
   static get description() {
-    return 'Command description';
+    return 'Command description. PLEASE PROVIDE IT';
   }
 
   /**

package/modules/AbstractController.js

@@ -196,22 +196,22 @@ class AbstractController extends Base {
                 errors: err.message,
               });
             }
-            req.body = new Proxy(req.body, {
-              get: (target, prop) => {
-                this.logger.warn(
-                  'Please not use "req.body" directly. Implement "request" and use "req.appInfo.request" ',
-                );
-                return target[prop];
-              },
-            });
-            req.query = new Proxy(req.query, {
-              get: (target, prop) => {
-                this.logger.warn(
-                  'Please not use "req.query" directly. Implement "query" and use "req.appInfo.query" ',
-                );
-                return target[prop];
-              },
-            });
+            // req.body = new Proxy(req.body, {
+            //   get: (target, prop) => {
+            //     this.logger.warn(
+            //       'Please not use "req.body" directly. Implement "request" and use "req.appInfo.request" ',
+            //     );
+            //     return target[prop];
+            //   },
+            // });
+            // req.query = new Proxy(req.query, {
+            //   get: (target, prop) => {
+            //     this.logger.warn(
+            //       'Please not use "req.query" directly. Implement "query" and use "req.appInfo.query" ',
+            //     );
+            //     return target[prop];
+            //   },
+            // });
 
             if (!routeObject.handler) {
               this.logger.error(`Route object have no handler defined`);
@@ -373,17 +373,17 @@ 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]>>}
+   * @returns {Map<string, Array<typeof import('../services/http/middleware/AbstractMiddleware.js').default | [Function, ...any]>>}
    * @example
    * return new Map([
-   *    ['/*', [GetUserByToken]] // for any method for this controller
+   *    ['/{*splat}', [GetUserByToken]] // for any method for this controller
    *    ['POST/', [Auth]] // for POST method
    *    ['/superSecretMethod', [OnlySuperSecretUsers]] // route with ANY method
    *    ['PUT/superSecretMathod', [OnlySuperSecretAdmin]] // route with PUT method
    * ]);
    */
   static get middleware() {
-    return new Map([['/*', [GetUserByToken, Auth]]]);
+    return new Map([['/{*splat}', [GetUserByToken, Auth]]]);
   }
 
   /**

package/modules/AbstractModel.d.ts

@@ -0,0 +1,48 @@
+import type Base from './Base.js';
+import { Model, Schema } from 'mongoose';
+import type Server from '../server.js';
+
+interface AbstractModel<T extends Document> extends Model, Base {
+  constructor(app: Server['app'], callback?: () => void);
+
+  /**
+   *  Return itself for internal methods.
+   */
+  getSuper(): this;
+
+  /**
+   *  Model schema in Js object (not a mongoose schema).
+   */
+  get modelSchema(): Object;
+
+  /**
+   * Mongoose schema.
+   */
+  mongooseSchema: Schema<T>;
+
+  /**
+   * Acces to mongoose model too
+   */
+  mongooseModel: Model<T>;
+
+  /**
+   * Init custom hooks before model
+   */
+  initHooks(): void;
+}
+
+abstract class AbstractModel<T extends Document>
+  extends Model
+  implements AbstractModel
+{
+  abstract get modelSchema(): Object;
+
+  /**
+   * Return itself for internal methods.
+   */
+  static abstract getSuper(): this;
+
+  mongooseSchema: Schema<T> = new Schema<T>(this.modelSchema);
+}
+
+export default AbstractModel;

package/modules/AbstractModel.js

@@ -2,13 +2,20 @@ import mongoose from 'mongoose';
 import Base from './Base.js';
 
 class AbstractModel extends Base {
+  mongooseSchema = null;
+
+  mongooseModel = null;
+
   /**
    * @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 = new mongoose.Schema(this.modelSchema);
+    this.mongooseSchema = new mongoose.Schema(
+      this.modelSchema,
+      this.modelSchemaOptions,
+    );
     mongoose.set('strictQuery', true);
     this.mongooseSchema.set('timestamps', true);
     this.mongooseSchema.set('minimize', false);
@@ -54,6 +61,14 @@ class AbstractModel extends Base {
     return {};
   }
 
+  /**
+   * Mongoose schema options
+   */
+  // eslint-disable-next-line class-methods-use-this
+  get modelSchemaOptions() {
+    return {};
+  }
+
   static get loggerGroup() {
     return 'model';
   }

package/modules/Base.d.ts

@@ -1,6 +1,6 @@
-import winston from 'winston';
-import Server from '../server.js';
-import type { Dirent } from 'fs';
+import type winston from 'winston';
+import type Server from '../server.js';
+import type { Dirent } from 'node.fs';
 
 declare class Base {
   app: Server['app'];
@@ -27,7 +27,7 @@ declare class Base {
   getFilesPathWithInheritance(
     internalFolder: string,
     externalFolder: string,
-  ): Promise<Dirent[]>;
+  ): Promise<{ path: string; file: string }[]>;
 
   /**
    * Return logger group. Just to have all logs groupped logically

package/modules/Base.js

@@ -18,7 +18,17 @@ class Base {
    * Optimzation to lazy load logger. It will be inited only on request
    */
   get logger() {
-    if (!this.#realLogger) {
+    let l;
+    try {
+      l = this.#realLogger;
+    } catch (e) {
+      console.warn(
+        `You try to accees logger not from class. that can be ok in case of models.`,
+      );
+      return null;
+    }
+
+    if (!l) {
       this.#realLogger = this.getLogger(
         this.constructor.loggerGroup + this.getConstructorName(),
       );

package/modules/BaseCli.js

@@ -29,24 +29,39 @@ class Cli extends Base {
     return true;
   }
 
+  async printComandTable() {
+    const commands = Object.keys(this.commands);
+    const maxLength = commands.reduce((max, c) => Math.max(max, c.length), 0);
+    console.log('Available commands:');
+    let commandsClasses = [];
+    for (const c of commands) {
+      // eslint-disable-next-line no-await-in-loop
+      commandsClasses.push(import(this.commands[c]));
+      // console.log(
+      //   ` \x1b[36m${c.padEnd(maxLength)}\x1b[0m - ${f.default.description}`,
+      // );
+    }
+    commandsClasses = await Promise.all(commandsClasses);
+    for (const [key, c] of Object.entries(commands)) {
+      // eslint-disable-next-line no-await-in-loop
+      console.log(
+        ` \x1b[36m${c.padEnd(maxLength)}\x1b[0m - ${commandsClasses[key].default.description}`,
+      );
+    }
+  }
+
   async run(command, args) {
     await this.loadCommands();
 
     if (!command) {
       console.log('Please provide command name');
-      console.log(
-        'Availalble commands:',
-        Object.keys(this.commands).join(', '),
-      );
+      await this.printComandTable();
       return false;
     }
 
     if (!this.commands[command]) {
       console.log(`Command ${command} not found `);
-      console.log(
-        'Availalble commands:',
-        Object.keys(this.commands).join(', '),
-      );
+      await this.printComandTable();
       return false;
     }
     const { default: Command } = await import(this.commands[command]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptivestone/framework",
-  "version": "5.0.0-alpha.9",
+  "version": "5.0.0-beta.1",
   "description": "Adaptive stone node js framework",
   "main": "index.js",
   "type": "module",
@@ -16,6 +16,7 @@
     "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",
@@ -30,14 +31,12 @@
   "license": "MIT",
   "dependencies": {
     "deepmerge": "^4.2.2",
-    "express": "^4.17.1",
+    "express": "^5.0.1",
     "formidable": "^3.5.1",
     "html-to-text": "^9.0.3",
-    "i18next": "^23.2.8",
-    "i18next-chained-backend": "^4.0.0",
+    "i18next": "^24.0.0",
     "i18next-fs-backend": "^2.0.0",
-    "juice": "^10.0.0",
-    "mime": "^4.0.0",
+    "juice": "^11.0.0",
     "minimist": "^1.2.5",
     "mongoose": "^8.0.0",
     "nodemailer": "^6.6.3",
@@ -47,21 +46,21 @@
     "rate-limiter-flexible": "^5.0.0",
     "redis": "^4.3.1",
     "winston": "^3.3.3",
-    "winston-transport-sentry-node": "^2.0.0",
+    "winston-transport-sentry-node": "^3.0.0",
     "yup": "^1.0.0"
   },
   "devDependencies": {
-    "@vitest/coverage-v8": "^2.0.0",
+    "@vitest/coverage-v8": "^3.0.0",
     "eslint": "^8.0.0",
     "eslint-config-airbnb-base": "^15.0.0",
-    "eslint-config-prettier": "^9.0.0",
+    "eslint-config-prettier": "^10.0.0",
     "eslint-plugin-prettier": "^5.0.0",
     "eslint-plugin-vitest": "^0.4.0",
     "husky": "^9.0.0",
     "lint-staged": "^15.0.0",
-    "mongodb-memory-server": "^9.0.0",
+    "mongodb-memory-server": "^10.0.0",
     "prettier": "^3.0.0",
-    "vitest": "^2.0.0"
+    "vitest": "^3.0.0"
   },
   "lint-staged": {
     "**/*.{js,jsx,ts,tsx,json,css,scss,md}": [

package/server.js

@@ -66,7 +66,7 @@ class Server {
 
   /**
    * Start server (http  + init all http ralated functions)
-   * @param <Promise>callbackBefore404 code that should be executed before adding page 404
+   * @param {Function} callbackBefore404 code that should be executed before adding page 404
    * @returns {Promise}
    */
   async startServer(callbackBefore404 = async () => Promise.resolve()) {

package/services/cache/Cache.js

@@ -43,8 +43,10 @@ class Cache extends Base {
     }
     const key = this.getKeyWithNameSpace(keyValue);
     // 5 mins default
-    let resolve = null;
-    let reject = null;
+    // eslint-disable-next-line no-unused-vars
+    let resolve = (value) => {};
+    // eslint-disable-next-line no-unused-vars
+    let reject = (value) => {};
     if (this.promiseMapping.has(key)) {
       return this.promiseMapping.get(key);
     }
@@ -71,7 +73,7 @@ class Cache extends Base {
 
       this.redisClient.set(
         key,
-        JSON.stringify(result, (jsonkey, value) =>
+        JSON.stringify(result, (_jsonkey, value) =>
           typeof value === 'bigint' ? `${value}n` : value,
         ),
         {
@@ -86,7 +88,7 @@ class Cache extends Base {
         )}`,
       );
       try {
-        result = JSON.parse(result, (jsonkey, value) => {
+        result = JSON.parse(result, (_jsonkey, value) => {
           if (typeof value === 'string' && /^\d+n$/.test(value)) {
             return BigInt(value.slice(0, value.length - 1));
           }

package/services/http/HttpServer.js

@@ -1,11 +1,12 @@
 import http from 'node:http';
-import path from 'node:path';
-import * as url from 'node:url';
+// 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';
 
@@ -17,15 +18,16 @@ 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'),
-    ]);
-    this.express.set('view engine', 'pug');
+    // const dirname = url.fileURLToPath(new URL('.', import.meta.url));
+    // this.express.set('views', [
+    //   this.app.foldersConfig.views,
+    //   path.join(dirname, '../../views'),
+    // ]);
+    // this.express.set('view engine', 'pug');
 
-    this.express.use(new PrepareAppInfoMiddleware(this.app).getMiddleware());
     this.express.use(new RequestLoggerMiddleware(this.app).getMiddleware());
+    this.express.use(new PrepareAppInfoMiddleware(this.app).getMiddleware());
+    this.express.use(new IpDetector(this.app).getMiddleware());
     this.express.use(new I18nMiddleware(this.app).getMiddleware());
 
     const httpConfig = this.app.getConfig('http');