@adaptivestone/framework 5.0.0-beta.5 → 5.0.0-beta.7

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+### 5.0.0-beta.7
+[UPDATE] update deps
+[UPDATE] change vitest shutdown behavior as mongo driver v6.13 change befaviur that affect us (MongoClient.close now closes any outstanding cursors)
+
+
+
+
+### 5.0.0-beta.5
+
+[BREAKING] remove minimist CLI parsing and replace it by commandArguments parser
+[UPDATE] migrated from eslint-plugin-import to eslint-plugin-import-x
+
 ### 5.0.0-beta.5
 
 [UPDATE] migrate to eslint 9 and away from aibnb styles (they are abonded)
@@ -466,7 +478,7 @@ await doc.populate([
 [UPDATE] update deps
 [UPDATE] winston console transport now using timestapms
 [UPDATE] PrepareAppInfo middleware now a global one. Do not need to include it on every controller
-[NEW] Request anso works with req.query, but req.body have bigger priority
+[NEW] Request also works with req.query, but req.body have bigger priority
 
 ### 2.18.0
 

package/Cli.js

@@ -1,4 +1,3 @@
-import parseArgs from 'minimist';
 import mongoose from 'mongoose';
 import BaseCli from './modules/BaseCli.js';
 import Server from './server.js';
@@ -8,14 +7,14 @@ class Cli extends BaseCli {
     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);
+    await super.run(command);
     this.app.events.emit('shutdown');
+    return true;
   }
 }
 

package/commands/CreateUser.js

@@ -6,6 +6,37 @@ class CreateUser extends AbstractCommand {
     return 'Create user in a database';
   }
 
+  /**
+   * You able to add command arguments for parsing there.
+   * @returns {import("../types/ICommandArguments.js").ICommandArguments}
+   */
+  static get commandArguments() {
+    return {
+      id: {
+        type: 'string',
+        description: 'User id to find user',
+      },
+      email: {
+        type: 'string',
+        description: 'User id to find/create user',
+      },
+      password: {
+        type: 'string',
+        description: 'New password for user',
+      },
+      roles: {
+        type: 'string',
+        description:
+          'User roles comma separated string (--roles=user,admin,someOtherRoles)',
+      },
+      update: {
+        type: 'boolean',
+        default: false,
+        description: 'Update user if it exists',
+      },
+    };
+  }
+
   async run() {
     const User = this.app.getModel('User');
     const { id, email, password, roles, update } = this.args;

package/commands/DropIndex.js

@@ -5,12 +5,21 @@ class DropIndex extends AbstractCommand {
     return 'Drop indexes of model';
   }
 
-  async run() {
-    if (!this.args.model) {
-      this.logger.error('Please provide model name as "--model=BestUserModel"');
-      return false;
-    }
+  /**
+   * You able to add command arguments for parsing there.
+   * @returns {import("../types/ICommandArguments.js").ICommandArguments}
+   */
+  static get commandArguments() {
+    return {
+      model: {
+        type: 'string',
+        description: 'Model name',
+        required: true,
+      },
+    };
+  }
 
+  async run() {
     const Model = this.app.getModel(this.args.model);
 
     if (!Model) {

package/commands/GetOpenApiJson.js

@@ -8,6 +8,18 @@ class GetOpenApiJson extends AbstractCommand {
   static get description() {
     return 'Generate documentation (openApi) ';
   }
+  /**
+   * You able to add command arguments for parsing there.
+   * @returns {import("../types/ICommandArguments.js").ICommandArguments}
+   */
+  static get commandArguments() {
+    return {
+      output: {
+        type: 'string',
+        description: 'Output file path',
+      },
+    };
+  }
 
   async run() {
     const { myDomain } = this.app.getConfig('http');

package/commands/SyncIndexes.js

@@ -29,6 +29,7 @@ class SyncIndexes extends AbstractCommand {
         this.logger.info(`Model - ${modelName} NO removed indexes`);
       }
     }
+    return true;
   }
 
   static get description() {

package/commands/migration/Create.js

@@ -7,28 +7,39 @@ class CreateMigration extends AbstractCommand {
     return 'Create new migration';
   }
 
+  /**
+   * You able to add command arguments for parsing there.
+   * @returns {import("../../types/ICommandArguments.js").ICommandArguments}
+   */
+  static get commandArguments() {
+    return {
+      name: {
+        type: 'string',
+        description: 'Migration name',
+        required: true,
+      },
+    };
+  }
+
   async run() {
-    if (!this.args.name) {
-      return this.logger.error(
-        'Please provide migration name with key "--name={someName}"',
-      );
-    }
     if (this.args.name.match(/^\d/)) {
-      return this.logger.error('Command cant start from nubmer');
+      this.logger.error('Command cant start from nubmer');
+      return false;
     }
-    const fileName = `${Date.now()}_${this.constructor.camelSentence(
+    const fileName = `${Date.now()}_${CreateMigration.camelSentence(
       this.args.name,
     )}.js`;
 
-    const fileContent = this.constructor.getTemplate(
-      this.constructor.camelSentence(this.args.name),
+    const fileContent = CreateMigration.getTemplate(
+      CreateMigration.camelSentence(this.args.name),
     );
 
     await fs.writeFile(
       path.join(this.app.foldersConfig.migrations, fileName),
       fileContent,
     );
-    return this.logger.info(`Migration created ${fileName}`);
+    this.logger.info(`Migration created ${fileName}`);
+    return true;
   }
 
   static camelSentence(str) {

package/commands/migration/Migrate.js

@@ -49,6 +49,7 @@ class Migrate extends AbstractCommand {
     this.logger.info(
       `=== Migration Finished. Migrated ${migrations.length} files ===`,
     );
+    return true;
   }
 }
 

package/eslint.config.js

@@ -1,11 +1,12 @@
 import globals from 'globals';
 import pluginJs from '@eslint/js';
-import importPlugin from 'eslint-plugin-import';
+import importPlugin from 'eslint-plugin-import-x';
 import vitest from '@vitest/eslint-plugin';
 import eslintConfigPrettier from 'eslint-config-prettier';
 import prettierPlugin from 'eslint-plugin-prettier/recommended';
 
 /** @type {import('eslint').Linter.Config[]} */
+// @ts-ignore
 export default [
   pluginJs.configs.recommended,
   importPlugin.flatConfigs.recommended,
@@ -28,8 +29,31 @@ export default [
       'class-methods-use-this': 'error',
       'no-shadow': 'error',
       'prefer-const': 'error',
-      'import/no-extraneous-dependencies': ['error'],
-      'import/first': ['error'],
+      'import-x/no-extraneous-dependencies': ['error'],
+      'import-x/first': ['error'],
+      camelcase: ['error', { properties: 'never', ignoreDestructuring: false }],
+      'prefer-destructuring': [
+        'error',
+        {
+          VariableDeclarator: {
+            array: false,
+            object: true,
+          },
+          AssignmentExpression: {
+            array: true,
+            object: false,
+          },
+        },
+        {
+          enforceForRenamedProperties: false,
+        },
+      ],
+      'no-plusplus': 'error',
+      'consistent-return': 'error',
+      'no-return-await': 'error',
+      'arrow-body-style': 'error',
+      'dot-notation': 'error',
+      curly: 'error',
     },
   },
   {

package/helpers/yup.js

@@ -13,6 +13,7 @@ class YupFile extends Schema {
   constructor() {
     super({
       type: 'file',
+      // @ts-ignore
       check: (value) => value.every((item) => item instanceof PersistentFile),
     });
   }

package/jsconfig.json

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

package/modules/AbstractCommand.js

@@ -26,9 +26,18 @@ class AbstractCommand extends Base {
     return `CLI: ${commandName} ${JSON.stringify(args)}`;
   }
 
+  /**
+   * You able to add command arguments for parsing there.
+   * @see https://nodejs.org/api/util.html#utilparseargsconfig in config.options plus extended with description and required
+   * @returns {import("../types/ICommandArguments.js").ICommandArguments}
+   */
+  static get commandArguments() {
+    return {};
+  }
+
   /**
    * Entry point to every command. This method should be overridden
-   * @return {Promise<boolean>} resut
+   * @return {Promise<boolean>} result
    */
   async run() {
     this.logger.error('You should implement run method');

package/modules/Base.js

@@ -29,8 +29,9 @@ class Base {
     }
 
     if (!l) {
+      const { loggerGroup } = /** @type {typeof Base} */ (this.constructor);
       this.#realLogger = this.getLogger(
-        this.constructor.loggerGroup + this.getConstructorName(),
+        loggerGroup + this.getConstructorName(),
       );
     }
     return this.#realLogger;

package/modules/BaseCli.js

@@ -1,5 +1,6 @@
 import path from 'node:path';
 import * as url from 'node:url';
+import { parseArgs } from 'node:util';
 import Base from './Base.js';
 
 class Cli extends Base {
@@ -45,9 +46,37 @@ class Cli extends Base {
         ` \x1b[36m${c.padEnd(maxLength)}\x1b[0m - ${commandsClasses[key].default.description}`,
       );
     }
+    console.log(
+      '\nUsage (use one of option): \n node cli.js <command> [options] \n npm run cli <command>  -- [options]',
+    );
+  }
+
+  static showHelp(Command, finalArguments) {
+    console.log(`\n\x1b[32m${Command.description}\x1b[0m`);
+    let output = '';
+
+    Object.entries(finalArguments).forEach(([key, opt]) => {
+      const outputLocal = [];
+      outputLocal.push(`\n\x1b[36m  --${key} \x1b[0m`);
+      if (opt.type !== 'boolean') {
+        outputLocal.push(`<${opt.type}>`);
+        // flag += `<${opt.type}>`;
+      }
+      if (opt.required) {
+        outputLocal.push('(required)');
+      }
+      outputLocal.push(`\n      \x1b[2m${opt.description}`);
+      if (opt.default !== undefined) {
+        outputLocal.push(` (default: ${opt.default})`);
+      }
+      outputLocal.push('\x1b[0m');
+      output += outputLocal.join(' ');
+    });
+
+    console.log(output);
   }
 
-  async run(command, args) {
+  async run(command) {
     await this.loadCommands();
 
     if (!command) {
@@ -63,20 +92,54 @@ class Cli extends Base {
     }
     const { default: Command } = await import(this.commands[command]);
 
+    const defaultArgs = {
+      help: {
+        type: 'boolean',
+        description: 'Show help',
+      },
+    };
+
+    const finalArguments = {
+      ...Command.commandArguments,
+      ...defaultArgs,
+    };
+
+    const parsedArgs = parseArgs({
+      args: process.argv.slice(3), // remove command name
+      options: finalArguments,
+      tokens: true,
+    });
+
+    // @ts-ignore
+    if (parsedArgs.values.help) {
+      Cli.showHelp(Command, finalArguments);
+      return true;
+    }
+
+    for (const [key, opt] of Object.entries(finalArguments)) {
+      if (opt.required && !parsedArgs.values[key]) {
+        console.log(
+          `\x1b[31mRequired field not proivded. Please provide "${key}" argument\x1b[0m`,
+        );
+        Cli.showHelp(Command, finalArguments);
+        return false;
+      }
+    }
+
     if (Command.isShouldInitModels) {
       this.logger.debug(
         `Command ${command} isShouldInitModels called. If you want to skip loading and init models, please set isShouldInitModels to false in tyou command`,
       );
       process.env.MONGO_APP_NAME = Command.getMongoConnectionName(
         command,
-        args,
+        parsedArgs.values,
       );
       await this.server.initAllModels();
     } else {
       this.logger.debug(`Command ${command} NOT need to isShouldInitModels`);
     }
 
-    const c = new Command(this.app, this.commands, args);
+    const c = new Command(this.app, this.commands, parsedArgs.values);
     let result = false;
 
     result = await c.run().catch((e) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptivestone/framework",
-  "version": "5.0.0-beta.5",
+  "version": "5.0.0-beta.7",
   "description": "Adaptive stone node js framework",
   "main": "index.js",
   "type": "module",
@@ -37,7 +37,6 @@
     "i18next": "^24.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",
@@ -51,11 +50,12 @@
   },
   "devDependencies": {
     "@eslint/js": "^9.19.0",
+    "@types/node": "^22.13.1",
     "@vitest/coverage-v8": "^3.0.0",
     "@vitest/eslint-plugin": "^1.1.25",
     "eslint": "^9.0.0",
     "eslint-config-prettier": "^10.0.0",
-    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-import-x": "^4.6.1",
     "eslint-plugin-prettier": "^5.0.0",
     "globals": "^15.14.0",
     "husky": "^9.0.0",

package/server.d.ts

@@ -10,6 +10,7 @@ import Cache from './services/cache/Cache';
 import winston from 'winston';
 
 import HttpServer from './services/http/HttpServer.js';
+import ControllerManager from './services/http/ControllerManager.js';
 
 type ServerConfig = {
   folders: ExpandDeep<TFolderConfig>;
@@ -27,7 +28,7 @@ declare class Server {
     get cache(): Server['cacheService'];
     get logger(): winston.Logger;
     httpServer: HttpServer | null;
-    controllerManager: null;
+    controllerManager: ControllerManager | null;
   };
   cacheService: Cache;
 
@@ -45,7 +46,7 @@ declare class Server {
   /**
    * Start server (http  + init all http ralated functions)
    */
-  startServer(callbackBefore404?: Promise<null>): Promise<null>;
+  startServer(callbackBefore404?: () => Promise<null>): Promise<null>;
 
   /**
    * Do an initialization (config reading,  etc)
@@ -92,7 +93,7 @@ declare class Server {
   /**
    * Run cli command into framework (http, ws, etc)
    */
-  runCliCommand(commandName: string, args: {}): Promise<BaseCli['run']>;
+  runCliCommand(commandName: string, args?: {}): Promise<BaseCli['run']>;
 }
 
 export default Server;

package/server.js

@@ -414,7 +414,7 @@ class Server {
    * @param {String} commandName name of command to load
    * @param {Object} args list of arguments to pass into command
    */
-  async runCliCommand(commandName, args) {
+  async runCliCommand(commandName, args = {}) {
     if (!this.cli) {
       const { default: BaseCli } = await import('./modules/BaseCli.js'); // Speed optimisation
       this.cli = new BaseCli(this);

package/services/http/HttpServer.js

@@ -54,15 +54,15 @@ class HttpServer extends Base {
       httpConfig.port,
       httpConfig.hostname,
       () => {
-        this.logger.info(
-          `App started and listening on port ${listener.address().port}`,
-        );
-        if (+listener.address().port !== +httpConfig.port) {
+        const address = listener.address();
+        const port = typeof address === 'string' ? 0 : address.port;
+        this.logger.info(`App started and listening on port ${port}`);
+        if (+port !== +httpConfig.port) {
           // in case we using port 0
-          this.app.updateConfig('http', { port: listener.address().port });
+          this.app.updateConfig('http', { port });
           this.logger.info(
             `Updating http config to use new port ${
-              listener.address().port
+              port
             }. Old was ${httpConfig.port} `,
           );
         }

package/services/http/middleware/I18n.js

@@ -27,7 +27,7 @@ class I18n extends AbstractMiddleware {
     if (I18NConfig.enabled) {
       this.logger.info('Enabling i18n support');
       this.i18n = i18next;
-      // eslint-disable-next-line import/no-named-as-default-member
+      // eslint-disable-next-line import-x/no-named-as-default-member
       i18next.use(BackendFS).init({
         backend: {
           loadPath: `${this.app.foldersConfig.locales}/{{lng}}/{{ns}}.json`,

package/services/messaging/email/index.js

@@ -123,6 +123,7 @@ class Mail extends Base {
         this.#renderTemplateFile(templates.style),
       ]);
 
+    // @ts-ignore
     juice.tableElements = ['TABLE'];
 
     const juiceResourcesAsync = promisify(juice.juiceResources);
@@ -139,7 +140,6 @@ class Mail extends Base {
       inlinedHTML,
     };
   }
-
   /**
    * Send email
    * @param {string} to email send to
@@ -150,7 +150,7 @@ class Mail extends Base {
   async send(to, from = null, aditionalNodemailerOptions = {}) {
     const { subject, text, inlinedHTML } = await this.renderTemplate();
 
-    return this.constructor.sendRaw(
+    return Mail.sendRaw(
       this.app,
       to,
       subject,

package/services/validate/ValidateService.js

@@ -7,7 +7,7 @@ class ValidateService extends Base {
   constructor(app, validator) {
     super(app);
     this.validator = validator
-      ? this.constructor.getDriverByValidatorBody(app, validator)
+      ? ValidateService.getDriverByValidatorBody(app, validator)
       : null;
   }
 
@@ -104,7 +104,7 @@ class ValidateService extends Base {
     const result = [];
 
     for (const validator of validators) {
-      const formatedValidator = this.constructor.getDriverByValidatorBody(
+      const formatedValidator = ValidateService.getDriverByValidatorBody(
         this.app,
         validator,
       );

package/services/validate/drivers/AbstractValidator.js

@@ -18,8 +18,8 @@ class AbstractValidator extends Base {
     return {};
   }
 
-  // eslint-disable-next-line class-methods-use-this
-  async validateFields() {
+  // eslint-disable-next-line class-methods-use-this, no-unused-vars
+  async validateFields(data, { query, body, appInfo }) {
     // IMPLENT;
     return true;
   }

package/services/validate/drivers/YupValidator.js

@@ -3,7 +3,7 @@ import AbstractValidator from './AbstractValidator.js';
 
 class YupValidator extends AbstractValidator {
   get fieldsInJsonFormat() {
-    return this.constructor.convertFieldsToJson(this.body);
+    return YupValidator.convertFieldsToJson(this.body);
   }
 
   static convertFieldsToJson(fields) {

package/tests/setup.js

@@ -12,7 +12,9 @@ mongoose.set('autoIndex', false);
 
 let mongoMemoryServerInstance;
 
+// @ts-ignore
 jest.setTimeout(1000000);
+// @ts-ignore
 beforeAll(async () => {
   mongoMemoryServerInstance = await MongoMemoryReplSet.create({
     // binary: { version: '4.4.6' },
@@ -77,6 +79,7 @@ beforeAll(async () => {
   await global.server.startServer();
 });
 
+// @ts-ignore
 beforeEach(() => {
   if (global.server) {
     const key = `test-${Math.random().toString(36).substring(7)}`;
@@ -86,6 +89,7 @@ beforeEach(() => {
   }
 });
 
+// @ts-ignore
 afterEach(async () => {
   if (global.server) {
     const { url, namespace } = global.server.getConfig('redis');
@@ -101,6 +105,7 @@ afterEach(async () => {
   }
 });
 
+// @ts-ignore
 afterAll(async () => {
   if (global.server) {
     global.server.app.httpServer.shutdown();

package/tests/setupVitest.js

@@ -102,6 +102,11 @@ afterAll(async () => {
   if (typeof global.testSetup.afterAll === 'function') {
     await global.testSetup.afterAll();
   }
-  await mongoose.connection.db.dropDatabase(); // clean database after test
+  try {
+    await mongoose.connection.db.dropDatabase(); // clean database after test
+  } catch {
+    // that ok. No mongoose connection
+  }
+
   await mongoose.disconnect();
 });

package/types/ICommandArguments.d.ts

@@ -0,0 +1,41 @@
+// this is from nodejs types
+interface ParseArgsOptionConfig {
+  /**
+   * Type of argument.
+   */
+  type: 'string' | 'boolean';
+  /**
+   * Whether this option can be provided multiple times.
+   * If `true`, all values will be collected in an array.
+   * If `false`, values for the option are last-wins.
+   * @default false.
+   */
+  multiple?: boolean | undefined;
+  /**
+   * A single character alias for the option.
+   */
+  short?: string | undefined;
+  /**
+   * The default option value when it is not set by args.
+   * It must be of the same type as the the `type` property.
+   * When `multiple` is `true`, it must be an array.
+   * @since v18.11.0
+   */
+  default?: string | boolean | string[] | boolean[] | undefined;
+}
+
+interface ParseArgsOptionsConfigExtended extends ParseArgsOptionConfig {
+  /**
+   * A description of the option.
+   */
+  description?: string;
+
+  /**
+   * Is it required?
+   */
+  required?: boolean;
+}
+
+export interface ICommandArguments {
+  [longOption: string]: ParseArgsOptionsConfigExtended;
+}

package/vitest.config.js

@@ -1,4 +1,4 @@
-// eslint-disable-next-line import/no-unresolved
+// eslint-disable-next-line import-x/no-unresolved
 import { defineConfig } from 'vitest/config';
 
 export default defineConfig({
@@ -9,6 +9,7 @@ export default defineConfig({
     outputFile: './coverage/rspec.xml',
     reporters: ['default', 'junit'],
     coverage: {
+      provider: 'v8',
       enabled: true,
       reporter: ['text', 'html', 'clover', 'json', 'cobertura'],
     },