@adaptivestone/framework 5.0.0-alpha.7 → 5.0.0-alpha.9

package/CHANGELOG.md

@@ -1,3 +1,16 @@
+### 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

package/config/auth.js

@@ -1,5 +1,6 @@
 export default {
   hashRounds: 64,
-  saltSecret: process.env.AUTH_SALT || 'gdfg45667_%%^trterte',
+  saltSecret:
+    process.env.AUTH_SALT || console.error('AUTH_SALT is not defined'),
   isAuthWithVefificationFlow: true,
 };

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

@@ -1,11 +1,11 @@
 {
   "name": "@adaptivestone/framework",
-  "version": "5.0.0-alpha.7",
+  "version": "5.0.0-alpha.9",
   "description": "Adaptive stone node js framework",
   "main": "index.js",
   "type": "module",
   "engines": {
-    "node": ">=18.17.0"
+    "node": ">=20.12.0"
   },
   "repository": {
     "type": "git",
@@ -13,8 +13,8 @@
   },
   "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",
     "prettier": "prettier --check '**/*.(js|jsx|ts|tsx|json|css|scss|md)'",
     "lint": "eslint '**/*.js'",
@@ -30,7 +30,6 @@
   "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",
@@ -52,18 +51,17 @@
     "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",
     "prettier": "^3.0.0",
-    "vitest": "^1.0.0"
+    "vitest": "^2.0.0"
   },
   "lint-staged": {
     "**/*.{js,jsx,ts,tsx,json,css,scss,md}": [

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.
  */
@@ -29,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
    */

package/services/http/HttpServer.js

@@ -6,7 +6,6 @@ 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 StaticFilesMiddleware from './middleware/StaticFiles.js';
 import Cors from './middleware/Cors.js';
 import Base from '../../modules/Base.js';
 
@@ -35,15 +34,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());
 

package/tests/setup.js

@@ -1,5 +1,6 @@
 /* eslint-disable no-undef */
 import path from 'node:path';
+import { randomBytes } from 'node:crypto';
 import { MongoMemoryReplSet } from 'mongodb-memory-server';
 import mongoose from 'mongoose';
 import redis from 'redis';
@@ -19,6 +20,8 @@ beforeAll(async () => {
   });
   await mongoMemoryServerInstance.waitUntilRunning();
   process.env.LOGGER_CONSOLE_LEVEL = 'error';
+  process.env.AUTH_SALT = randomBytes(16).toString('hex');
+
   const connectionStringMongo = await mongoMemoryServerInstance.getUri();
   // console.info('MONGO_URI: ', connectionStringMongo);
   global.server = new Server({
@@ -27,7 +30,6 @@ beforeAll(async () => {
       controllers:
         process.env.TEST_FOLDER_CONTROLLERS || path.resolve('./controllers'),
       views: process.env.TEST_FOLDER_VIEWS || path.resolve('./views'),
-      public: process.env.TEST_FOLDER_PUBLIC || path.resolve('./public'),
       models: process.env.TEST_FOLDER_MODELS || path.resolve('./models'),
       emails:
         process.env.TEST_FOLDER_EMAIL ||

package/tests/setupVitest.js

@@ -12,13 +12,13 @@ mongoose.set('autoIndex', false);
 
 beforeAll(async () => {
   process.env.LOGGER_CONSOLE_LEVEL = 'error';
+  process.env.AUTH_SALT = crypto.randomBytes(16).toString('hex');
   global.server = new Server({
     folders: {
       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'),
-      public: process.env.TEST_FOLDER_PUBLIC || path.resolve('./public'),
       models: process.env.TEST_FOLDER_MODELS || path.resolve('./models'),
       emails:
         process.env.TEST_FOLDER_EMAIL ||

package/types/TFoldersConfig.d.ts

@@ -3,7 +3,6 @@
  * @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 public path to folder with public files
  * @param locales path to folder with locales files
  * @param emails path to folder with emails files
  */
@@ -12,7 +11,6 @@ type FolderConfig = {
   models: string;
   controllers: string;
   views: string;
-  public: string;
   emails: string;
 };
 

package/services/http/middleware/StaticFiles.js

@@ -1,59 +0,0 @@
-import fsPromises from 'node:fs/promises';
-import fs from 'node:fs';
-import path from 'node:path';
-import mime from 'mime';
-import AbstractMiddleware from './AbstractMiddleware.js';
-/**
- * Middleware for static files
- */
-class StaticFiles extends AbstractMiddleware {
-  constructor(app, params) {
-    super(app);
-    this.params = params;
-    if (!params || !params.folders || !params.folders.length) {
-      throw new Error('StaticFiles inited without folders config');
-    }
-  }
-
-  static get description() {
-    return 'Static file server middleware. Host you static files from public foolder. Mostly for dev.';
-  }
-
-  async middleware(req, res, next) {
-    if (req.method !== 'GET') {
-      // only get supported
-      return next();
-    }
-    const { folders } = this.params;
-
-    const promises = [];
-
-    for (const f of folders) {
-      const filePath = path.join(f, req.url);
-      promises.push(
-        fsPromises
-          .stat(filePath)
-          .catch(() => {
-            // nothing there, file just not exists
-          })
-          .then((stats) => ({ stats, file: filePath })),
-      );
-    }
-
-    const fileStats = await Promise.all(promises);
-
-    for (const fileStat of fileStats) {
-      if (fileStat.stats && fileStat.stats.isFile()) {
-        const contentType = mime.getType(fileStat.file);
-        const fileStream = fs.createReadStream(fileStat.file);
-        res.set('Content-Type', contentType);
-        fileStream.pipe(res);
-        return null;
-      }
-    }
-
-    return next();
-  }
-}
-
-export default StaticFiles;