@adaptivestone/framework 5.0.0-alpha.2 → 5.0.0-alpha.20

package/CHANGELOG.md

@@ -1,3 +1,92 @@
+### 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
+[BREAKING] removing staticFiles middleware as it not used in projects anymore. Docs with nginx config will be provided
+[BREAKING] remove default AUTH_SALT. It should be provided on a app level now
+[BREAKING] Vitest 2.0.0 https://vitest.dev/guide/migration.html#migrating-to-vitest-2-0
+
+### 5.0.0-alpha.8
+
+[UPDATE] replace dotenv with loadEnvFile
+[UPDATE] replace nodemon with node --watch (dev only)
+[BREAKING] Minimum node version is 20.12 as for now (process.loadEnvFile)
+
+### 5.0.0-alpha.7
+
+[UPDATE] deps update
+
+### 5.0.0-alpha.6
+
+[UPDATE] Update internal documentation (jsdoc, d.ts)
+
+### 5.0.0-alpha.5
+
+[UPDATE] More verbose errors for rapsing body request.
+[UPDATE] deps update
+
+### 5.0.0-alpha.4
+
+[UPDATE] Update rate-limiter-flexible to v5
+[CHANGE] Cache update redis.setEX to redis.set(..,..,{EX:xx}) as setEX deprecated
+
+### 5.0.0-alpha.3
+
+[UPDATE] deps update
+[FIX] Migration commands apply
+
 ### 5.0.0-alpha.2
 
 [UPDATE] deps update

package/commands/CreateUser.js

@@ -60,7 +60,9 @@ class CreateUser extends AbstractCommand {
 
     await user.generateToken();
 
-    this.logger.info(`User was created/updated ${JSON.stringify(user, 0, 4)}`);
+    this.logger.info(
+      `User was created/updated ${JSON.stringify(user, null, 4)}`,
+    );
 
     return user;
   }

package/commands/GenerateRandomBytes.js

@@ -0,0 +1,15 @@
+import { randomBytes } from 'node:crypto';
+import AbstractCommand from '../modules/AbstractCommand.js';
+
+class GenerateRandomBytes extends AbstractCommand {
+  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/migration/Migrate.js

@@ -36,7 +36,7 @@ class Migrate extends AbstractCommand {
     for (const migration of migrations) {
       this.logger.info(`=== Start migration ${migration.file} ===`);
       // eslint-disable-next-line no-await-in-loop
-      const MigrationCommand = await import(migration.path);
+      const { default: MigrationCommand } = await import(migration.path);
       const migrationCommand = new MigrationCommand(this.app);
       // eslint-disable-next-line no-await-in-loop
       await migrationCommand.up();

package/config/auth.js

@@ -1,5 +1,9 @@
 export default {
   hashRounds: 64,
-  saltSecret: process.env.AUTH_SALT || 'gdfg45667_%%^trterte',
+  saltSecret:
+    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) {

package/folderConfig.js

@@ -6,7 +6,6 @@ export default {
     models: path.resolve('./models'),
     controllers: path.resolve('./controllers'),
     views: path.resolve('./views'),
-    public: path.resolve('./public'),
     locales: path.resolve('./locales'),
     emails: path.resolve('./services/messaging/email/templates'),
     commands: path.resolve('./commands'),

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/jsconfig.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "module": "node16",
+    "target": "ES2022",
+    "moduleResolution": "node16",
+    "checkJs": true
+  },
+  "exclude": ["node_modules"]
+}

package/modules/AbstractCommand.js

@@ -13,10 +13,11 @@ class AbstractCommand extends Base {
 
   /**
    * Entry point to every command. This method should be overridden
-   * @override
+   * @return {Promise<boolean>} resut
    */
   async run() {
     this.logger.error('You should implement run method');
+    return false;
   }
 
   static get loggerGroup() {

package/modules/AbstractController.js

@@ -25,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();
     }
 
@@ -58,6 +60,7 @@ class AbstractController extends Base {
       httpPath,
     );
     const middlewaresInfo = this.parseMiddlewares(
+      // @ts-ignore
       this.constructor.middleware,
       httpPath,
     );
@@ -193,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`);
@@ -370,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<typeof import('../services/http/middleware/AbstractMiddleware.js').default | [Function, ...any]>>}
    * @example
    * return new Map([
    *    ['/*', [GetUserByToken]] // for any method for this controller

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')} 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,
+      this.modelSchemaOptions,
+    );
     mongoose.set('strictQuery', true);
     this.mongooseSchema.set('timestamps', true);
     this.mongooseSchema.set('minimize', false);
@@ -22,6 +29,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);
         }
@@ -51,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,5 +1,6 @@
-import winston from 'winston';
-import Server from '../server';
+import type winston from 'winston';
+import type Server from '../server.js';
+import type { Dirent } from 'node.fs';
 
 declare class Base {
   app: Server['app'];
@@ -26,11 +27,11 @@ declare class Base {
   getFilesPathWithInheritance(
     internalFolder: string,
     externalFolder: string,
-  ): Promise<string[]>;
+  ): Promise<{ path: string; file: string }[]>;
 
   /**
    * Return logger group. Just to have all logs groupped logically
    */
   static get loggerGroup(): string;
 }
-export = Base;
+export default Base;

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/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@adaptivestone/framework",
-  "version": "5.0.0-alpha.2",
+  "version": "5.0.0-alpha.20",
   "description": "Adaptive stone node js framework",
   "main": "index.js",
   "type": "module",
   "engines": {
-    "node": ">=18.17.0"
+    "node": ">=20.12.0"
   },
   "repository": {
     "type": "git",
@@ -13,9 +13,10 @@
   },
   "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",
@@ -30,40 +31,36 @@
   "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": "^10.0.0",
-    "mime": "^4.0.0",
+    "juice": "^11.0.0",
     "minimist": "^1.2.5",
     "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": "^4.0.0",
+    "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": "^1.0.0",
+    "@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",
+    "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": "^1.0.0"
+    "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,16 +1,21 @@
 /* eslint-disable no-console */
 import EventEmitter from 'node:events';
-import { hrtime } from 'node:process';
+import { hrtime, loadEnvFile } from 'node:process';
 import * as url from 'node:url';
 import path from 'node:path';
 
-import 'dotenv/config';
 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.
  */
@@ -19,6 +24,8 @@ class Server {
 
   #isInited = false;
 
+  cli = null;
+
   /**
    *  Construct new server
    * @param {Object} config main config object
@@ -27,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
    */
@@ -56,13 +62,11 @@ class Server {
       models: new Map(),
       modelConstructors: new Map(),
     };
-
-    this.cli = false;
   }
 
   /**
    * 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()) {
@@ -350,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')) {

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;