@adaptivestone/framework 5.0.0-beta.3 → 5.0.0-beta.31

package/dist/tests/testHelpers.js

@@ -0,0 +1,48 @@
+import { appInstance } from "../helpers/appInstance.js";
+export let serverInstance;
+export let defaultUser;
+export let defaultAuthToken;
+export const setServerInstance = (serverInstanceToSet) => {
+    if (serverInstance) {
+        throw new Error('Server instance is already set');
+    }
+    serverInstance = serverInstanceToSet;
+};
+export const setDefaultUser = (userToSet) => {
+    if (defaultUser) {
+        throw new Error('Default user is already set');
+    }
+    defaultUser = userToSet;
+};
+export const setDefaultAuthToken = (tokenToSet) => {
+    if (defaultAuthToken) {
+        throw new Error('Auth token is already set');
+    }
+    defaultAuthToken = tokenToSet;
+};
+export const getTestServerURL = (urlPart) => `http://127.0.0.1:${appInstance.getConfig('http').port}${urlPart}`;
+export const createDefaultTestUser = async () => {
+    if (defaultUser) {
+        throw new Error('You already have created default user');
+    }
+    const User = appInstance.getModel('User');
+    const user = await User.create({
+        email: 'test@test.com',
+        password: 'testPassword',
+        isVerified: true,
+        name: {
+            nick: 'testUserNickName',
+        },
+    }).catch((e) => {
+        console.error(e);
+        console.info('That error can happens in case you have custom user model. Please implment user creation by youself');
+    });
+    if (!user) {
+        return false;
+    }
+    setDefaultUser(user);
+    const token = await user.generateToken();
+    setDefaultAuthToken(token.token);
+    return { user, token: token.token };
+};
+//# sourceMappingURL=testHelpers.js.map

package/dist/tests/testHelpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testHelpers.js","sourceRoot":"","sources":["../../src/tests/testHelpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAMxD,MAAM,CAAC,IAAI,cAAuB,CAAC;AACnC,MAAM,CAAC,IAAI,WAAkE,CAAC;AAC9E,MAAM,CAAC,IAAI,gBAAwB,CAAC;AAEpC,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,mBAA2B,EAAE,EAAE;IAC/D,IAAI,cAAc,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;IACpD,CAAC;IACD,cAAc,GAAG,mBAAmB,CAAC;AACvC,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,SAAgE,EAChE,EAAE;IACF,IAAI,WAAW,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;IACjD,CAAC;IACD,WAAW,GAAG,SAAS,CAAC;AAC1B,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,UAAkB,EAAE,EAAE;IACxD,IAAI,gBAAgB,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC/C,CAAC;IACD,gBAAgB,GAAG,UAAU,CAAC;AAChC,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,OAAgB,EAAE,EAAE,CACnD,oBAAoB,WAAW,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,IAAI,GAAG,OAAO,EAAE,CAAC;AAErE,MAAM,CAAC,MAAM,qBAAqB,GAAG,KAAK,IAAI,EAAE;IAC9C,IAAI,WAAW,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;IAC3D,CAAC;IACD,MAAM,IAAI,GAAG,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAqB,CAAC;IAC9D,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC;QAC7B,KAAK,EAAE,eAAe;QACtB,QAAQ,EAAE,cAAc;QACxB,UAAU,EAAE,IAAI;QAChB,IAAI,EAAE;YACJ,IAAI,EAAE,kBAAkB;SACzB;KACF,CAAC,CAAC,KAAK,CAAC,CAAC,CAAQ,EAAE,EAAE;QACpB,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACjB,OAAO,CAAC,IAAI,CACV,qGAAqG,CACtG,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,KAAK,CAAC;IACf,CAAC;IACD,cAAc,CAAC,IAAI,CAAC,CAAC;IACrB,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;IACzC,mBAAmB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACjC,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC;AACtC,CAAC,CAAC"}

package/package.json

@@ -1,70 +1,73 @@
 {
   "name": "@adaptivestone/framework",
-  "version": "5.0.0-beta.3",
+  "version": "5.0.0-beta.31",
   "description": "Adaptive stone node js framework",
-  "main": "index.js",
   "type": "module",
   "engines": {
-    "node": ">=20.12.0"
+    "node": ">=23.6.0"
+  },
+  "exports": {
+    "./package.json": "./package.json",
+    "./*": "./dist/*"
   },
   "repository": {
     "type": "git",
-    "url": "https://gitlab.com/adaptivestone/framework"
+    "url": "git+https://github.com/adaptivestone/framework.git"
   },
   "homepage": "https://framework.adaptivestone.com/",
   "scripts": {
-    "dev": "node --watch ./index.js",
-    "prod": "node --watch ./cluster.js",
+    "build": "rm -rf dist && tsc",
+    "postbuild": "cp -R ./src/migrations ./dist/migrations",
+    "check:types": "tsc --noEmit",
+    "dev": "node --watch ./src/index.ts",
+    "prod": "node --watch ./src/cluster.ts",
     "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",
-    "cli": "node cliCommand",
+    "format": "biome format",
+    "format:fix": "biome format --write",
+    "knip": "knip",
+    "lint": "biome lint",
+    "lint:fix": "biome lint --write",
+    "check": "biome check",
+    "check:fix": "biome check --write",
+    "prepublishOnly": "npm run build",
+    "cli": "node cliCommand.ts",
     "benchmark": "h2load -n 10000 -c 50 -p 'http/1.1' http://localhost:3300/",
     "benchmark2": "h2load -n 10000 -c 50  https://localhost:3300/",
     "redis:docker": "docker run --rm  -p 6379:6379 redis"
   },
-  "author": "Andrey Logunov",
+  "author": "Andrei Lahunou",
   "license": "MIT",
   "dependencies": {
+    "@redis/client": "^5.0.0",
     "deepmerge": "^4.2.2",
     "express": "^5.0.1",
     "formidable": "^3.5.1",
-    "html-to-text": "^9.0.3",
-    "i18next": "^24.0.0",
+    "i18next": "^25.0.0",
     "i18next-fs-backend": "^2.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": "^5.0.0",
-    "redis": "^4.3.1",
+    "rate-limiter-flexible": "^7.0.0",
     "winston": "^3.3.3",
     "winston-transport-sentry-node": "^3.0.0",
     "yup": "^1.0.0"
   },
   "devDependencies": {
+    "@biomejs/biome": "^2.0.6",
+    "@types/express": "^5.0.1",
+    "@types/formidable": "^3.4.5",
+    "@types/node": "^24.0.0",
     "@vitest/coverage-v8": "^3.0.0",
-    "eslint": "^8.0.0",
-    "eslint-config-airbnb-base": "^15.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",
+    "lefthook": "^1.11.14",
     "mongodb-memory-server": "^10.0.0",
-    "prettier": "^3.0.0",
+    "typescript": "^5.8.3",
     "vitest": "^3.0.0"
   },
-  "lint-staged": {
-    "**/*.{js,jsx,ts,tsx,json,css,scss,md}": [
-      "prettier --write"
-    ]
+  "peerDependencies": {
+    "@adaptivestone/framework-module-email": "^1.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@adaptivestone/framework-module-email": {
+      "optional": true
+    }
   }
 }

package/Cli.js

@@ -1,22 +0,0 @@
-import parseArgs from 'minimist';
-import mongoose from 'mongoose';
-import BaseCli from './modules/BaseCli.js';
-import Server from './server.js';
-
-class Cli extends BaseCli {
-  constructor(serverConfig) {
-    mongoose.set('autoIndex', false); // we do not need create indexes on CLI.
-    const server = new Server(serverConfig);
-    super(server);
-    this.args = parseArgs(process.argv.slice(3));
-  }
-
-  async run() {
-    await this.server.init({ isSkipModelInit: true, isSkipModelLoading: true });
-    const command = process.argv[2]?.toLowerCase();
-    await super.run(command, this.args);
-    this.app.events.emit('shutdown');
-  }
-}
-
-export default Cli;

package/cluster.js

@@ -1,27 +0,0 @@
-import cluster from 'node:cluster';
-import { cpus } from 'node:os';
-
-const numCPUs = cpus().length;
-
-if (cluster.isPrimary) {
-  // eslint-disable-next-line no-console
-  console.log(`Master ${process.pid} is running`);
-  // Fork workers.
-  for (let i = 0; i < numCPUs; i += 1) {
-    cluster.fork();
-  }
-
-  cluster.on('exit', (worker, code, signal) => {
-    // eslint-disable-next-line no-console
-    console.log(
-      `Worker \x1B[45m ${
-        worker.process.pid
-      } \x1B[49m \x1B[41m †††† died †††† \x1B[49m. Code: ${
-        signal || code
-      }. Restarting...`,
-    );
-    cluster.fork();
-  });
-} else {
-  import('./server.js');
-}

package/commands/CreateUser.js

@@ -1,75 +0,0 @@
-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;
-
-    if (!email && !id) {
-      this.logger.error('Input validation failded');
-      this.logger.error('Please add "email" or "id" variables');
-      return false;
-    }
-
-    let user;
-
-    if (id) {
-      user = await User.findOne({ _id: id });
-    } else if (email) {
-      user = await User.findOne({ email });
-    }
-
-    if (user && !update) {
-      this.logger.error(
-        'We are found a user in database. But "update" option is not providing. Exitin',
-      );
-      return false;
-    }
-
-    if (!user && !password) {
-      this.logger.error(
-        'For a new user we alway asking for a password. Please provide it and rerun command',
-      );
-      return false;
-    }
-
-    if (!user && !email) {
-      this.logger.error(
-        'For a new user we alway asking for a email. Please provide it and rerun command',
-      );
-      return false;
-    }
-
-    if (!user) {
-      user = new User();
-    }
-
-    if (password) {
-      user.password = password;
-    }
-    if (email) {
-      user.email = email;
-    }
-
-    if (roles) {
-      user.roles = roles.split(',');
-    }
-
-    await user.save();
-
-    await user.generateToken();
-
-    this.logger.info(
-      `User was created/updated ${JSON.stringify(user, null, 4)}`,
-    );
-
-    return user;
-  }
-}
-
-export default CreateUser;

package/commands/Documentation.js

@@ -1,17 +0,0 @@
-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 = [];
-    await CM.initControllers();
-    return this.app.documentation;
-  }
-}
-
-export default Documentation;

package/commands/DropIndex.js

@@ -1,29 +0,0 @@
-import AbstractCommand from '../modules/AbstractCommand.js';
-
-class DropIndex extends AbstractCommand {
-  static get description() {
-    return 'Drop indexes of model';
-  }
-
-  async run() {
-    if (!this.args.model) {
-      this.logger.error('Please provide model name as "--model=BestUserModel"');
-      return false;
-    }
-
-    const Model = this.app.getModel(this.args.model);
-
-    if (!Model) {
-      this.logger.error('Not able to find model');
-      return false;
-    }
-
-    await Model.collection.dropIndexes();
-
-    this.logger.info('Success');
-
-    return true;
-  }
-}
-
-export default DropIndex;

package/commands/GenerateRandomBytes.js

@@ -1,21 +0,0 @@
-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';
-  }
-
-  static isShouldInitModels = false;
-
-  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

@@ -1,325 +0,0 @@
-import { promises as fs } from 'node:fs';
-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;
-    if (!jsonFile) {
-      jsonFile = `${process.env.PWD}/package.json`;
-    }
-
-    try {
-      jsonFile = JSON.parse(await fs.readFile(jsonFile, 'utf8'));
-    } catch (e) {
-      this.logger.error(
-        'No npm package detected. Please start this command via NPM as it depends on package.json',
-      );
-    }
-
-    if (!jsonFile) {
-      jsonFile = {
-        name: 'UNDETECTD PROJECT',
-        description: 'UNDETECTD PROJECT DECCRIPTION',
-        version: '0.0.0-undetrcted',
-        author: {
-          email: 'none@example.com',
-        },
-      };
-    }
-
-    if (!jsonFile.author) {
-      jsonFile.author = 'none@example.com';
-    }
-
-    const openApi = {
-      openapi: '3.0.0',
-      info: {
-        title: jsonFile.name,
-        description: jsonFile.description,
-        contact: {
-          email: jsonFile.author.email,
-        },
-        version: jsonFile.version,
-      },
-      servers: [
-        {
-          url: 'http://localhost:3300',
-          description: 'Localhost',
-        },
-        {
-          url: myDomain,
-          description: 'Domain from config',
-        },
-      ],
-    };
-
-    const baseDocumentation = await this.app.runCliCommand('documentation');
-
-    if (!baseDocumentation) {
-      throw new Error('Problems with basic documenation generation');
-    }
-
-    openApi.components = {};
-    openApi.components.securitySchemes = {};
-
-    openApi.tags = [];
-
-    for (const controller of baseDocumentation) {
-      const controllerName = controller.contollerName.split('/')[0];
-      if (!openApi.tags.find((tag) => tag.name === controllerName)) {
-        openApi.tags.push({
-          name: controllerName,
-          description: '',
-        });
-      }
-    }
-
-    openApi.paths = {};
-
-    const permissionWithRoutes = {};
-    for (const controller of baseDocumentation) {
-      for (const route of controller.routesInfo) {
-        const routeInfo = route[Object.keys(route)?.[0]];
-        const middlewares = [
-          ...routeInfo.controllerMiddlewares,
-          ...routeInfo.routeMiddlewares,
-        ];
-
-        const securitySchemaNames = [];
-
-        permissionWithRoutes[Object.keys(route)?.[0]] = [];
-
-        if (middlewares?.length) {
-          for (const middleware of middlewares) {
-            if (middleware?.authParams?.length) {
-              for (const authParam of middleware.authParams) {
-                const { permissions, ...mainFields } = authParam;
-                const fullName = authParam.name;
-                if (permissions) {
-                  permissionWithRoutes[Object.keys(route)?.[0]].push(
-                    permissions,
-                  );
-                }
-
-                if (!openApi.components.securitySchemes[fullName]) {
-                  openApi.components.securitySchemes[fullName] = mainFields;
-                }
-
-                securitySchemaNames.push({
-                  [fullName]: [],
-                });
-              }
-            }
-          }
-        }
-
-        let routeName = Object.keys(route)[0];
-        if (routeName === '/') {
-          // eslint-disable-next-line no-continue
-          continue;
-        }
-
-        if (routeName.slice(-1) === '/') {
-          routeName = routeName.substring(0, routeName.length - 1);
-        }
-
-        const partsRoute = routeName.split('/');
-
-        const newRoute = [];
-        const routeParameters = [];
-        for (const routeDetail of partsRoute) {
-          let routeCopy = routeDetail;
-
-          if (routeDetail.startsWith(':')) {
-            const routeChange = routeCopy.split('');
-            routeChange[0] = '{';
-            routeChange.push('}');
-            routeCopy = routeChange.join('');
-            routeParameters.push(routeCopy.replace(/^.|.$/g, ''));
-          }
-
-          newRoute.push(routeCopy);
-        }
-
-        routeName = newRoute.join('/');
-
-        if (!openApi.paths[routeName]) {
-          openApi.paths[routeName] = {};
-        }
-
-        const routeDescription =
-          route[Object.keys(route)[0]]?.description || 'empty description';
-        const permissions =
-          permissionWithRoutes[Object.keys(route)[0]][
-            permissionWithRoutes[Object.keys(route)[0]].length - 1
-          ];
-        const routeDescriptionWithPermissions = `${
-          permissions || ''
-        } ${routeDescription}`;
-        const methodName = route[Object.keys(route)[0]].method.toLowerCase();
-        const routeTitle = route[Object.keys(route)[0]].name;
-
-        const routeFields = route[Object.keys(route)[0]].fields;
-        const routeQueryFields = route[Object.keys(route)[0]].queryFields;
-
-        if (!openApi.paths[routeName][methodName]) {
-          openApi.paths[routeName][methodName] = {};
-        }
-
-        openApi.paths[routeName][methodName].tags = [];
-
-        openApi.paths[routeName][methodName].tags.push(
-          controller.contollerName.split('/')[0],
-        );
-
-        openApi.paths[routeName][methodName].summary = routeTitle;
-        openApi.paths[routeName][methodName].description =
-          routeDescriptionWithPermissions;
-        openApi.paths[routeName][methodName].parameters = [];
-        openApi.paths[routeName][methodName].security = securitySchemaNames;
-
-        openApi.paths[routeName][methodName].responses = {
-          200: {
-            description: 'Successfully',
-          },
-          201: {
-            description: 'The resource was created successfully',
-          },
-          400: {
-            description: 'There is a syntax error in the request',
-          },
-          401: {
-            description:
-              'Authentication is required to access the requested resource',
-          },
-          404: {
-            description:
-              'The server accepted the request, but did not find the corresponding resource at the specified URI',
-          },
-        };
-
-        for (const queryField of routeQueryFields) {
-          openApi.paths[routeName][methodName].parameters.push({
-            name: queryField.name,
-            in: 'query',
-            required: queryField?.required,
-            schema: {
-              type: queryField.type,
-            },
-          });
-        }
-
-        for (const routeField of routeParameters) {
-          openApi.paths[routeName][methodName].parameters.push({
-            name: routeField,
-            in: 'path',
-            required: true,
-            schema: {
-              type: 'string',
-            },
-          });
-        }
-
-        if (routeFields.length) {
-          const groupBodyFields = {};
-          const requiredFields = [];
-          let isMultipartFormaData = false;
-          for (const field of routeFields) {
-            if (field.required) {
-              requiredFields.push(field.name);
-            }
-
-            switch (field.type) {
-              case 'object':
-                groupBodyFields[field.name] = {
-                  properties: {},
-                };
-
-                for (const objField of field.fields) {
-                  groupBodyFields[field.name].properties[objField.name] = {
-                    // fields file has mixed type but openApi doesnt have this type
-                    type: objField.type === 'mixed' ? 'string' : objField.type,
-                  };
-                }
-
-                break;
-
-              case 'array':
-                groupBodyFields[field.name] = {
-                  items: {
-                    type: field.innerType,
-                  },
-                };
-                break;
-
-              case 'lazy':
-                groupBodyFields[field.name] = {
-                  oneOf: [
-                    {
-                      type: 'object',
-                    },
-                    {
-                      type: 'string',
-                    },
-                  ],
-                };
-                break;
-
-              case 'file':
-                groupBodyFields[field.name] = {
-                  type: 'string',
-                  format: 'binary',
-                };
-                isMultipartFormaData = true;
-                break;
-              default:
-                groupBodyFields[field.name] = {
-                  type: field.type,
-                };
-            }
-          }
-
-          const contentType = isMultipartFormaData
-            ? 'multipart/form-data'
-            : 'application/json';
-
-          openApi.paths[routeName][methodName].requestBody = {
-            content: {
-              [contentType]: {
-                schema: {
-                  type: 'object',
-                  properties: groupBodyFields,
-                },
-              },
-            },
-          };
-
-          if (requiredFields.length) {
-            openApi.paths[routeName][methodName].requestBody.content[
-              contentType
-            ].schema.required = requiredFields;
-          }
-        }
-      }
-    }
-
-    const result = JSON.stringify(openApi);
-
-    if (this.args.output) {
-      await fs.writeFile(this.args.output, result);
-      this.logger.info(`Output to: ${this.args.output}`);
-    }
-
-    return result;
-  }
-}
-
-export default GetOpenApiJson;