@adaptivestone/framework 3.2.1 → 3.3.0

package/CHANGELOG.md

@@ -1,3 +1,14 @@
+### 3.3.0
+
+[NEW] new command 'SyncIndexes' to sync indexes for mongodb https://framework.adaptivestone.com/docs/cli#syncindexes
+[UPDATE] updated deps
+[FIX] fix documentation generation
+
+### 3.2.2
+
+[UPDATE] add options for i18n to config.
+[CHANGE] by default i18n not writing missed keys. Can be enabled via config
+
 ### 3.2.1
 
 [UPDATE] updated deps

package/commands/GetOpenApiJson.js

@@ -1,5 +1,4 @@
 const fs = require('fs').promises;
-
 const AbstractCommand = require('../modules/AbstractCommand');
 
 /**
@@ -96,13 +95,18 @@ class GetOpenApiJson extends AbstractCommand {
           for (const middleware of middlewares) {
             if (middleware?.authParams?.length) {
               for (const authParam of middleware.authParams) {
-                if (!openApi.components.securitySchemes[authParam.name]) {
-                  openApi.components.securitySchemes[authParam.name] =
-                    authParam;
+                const { permissions, ...mainFields } = authParam;
+                let fullName = authParam.name;
+                if (permissions) {
+                  fullName = `${fullName}-permissions-${permissions}`;
+                }
+
+                if (!openApi.components.securitySchemes[fullName]) {
+                  openApi.components.securitySchemes[fullName] = mainFields;
                 }
 
                 securitySchemaNames.push({
-                  [authParam.name]: [],
+                  [fullName]: [],
                 });
               }
             }

package/commands/SyncIndexes.js

@@ -0,0 +1,37 @@
+const path = require('node:path');
+const AbstractCommand = require('../modules/AbstractCommand');
+
+class SyncIndexes extends AbstractCommand {
+  async run() {
+    const files = await this.getFilesPathWithInheritance(
+      `${__dirname}/../models`,
+      this.app.foldersConfig.models,
+    );
+    let models = [];
+
+    for (const file of files) {
+      models.push(path.basename(file.file, path.extname(file.file)));
+    }
+    models = models.sort();
+    this.logger.info(`Total found ${models.length} models`);
+
+    for (const modelName of models) {
+      const Model = this.app.getModel(modelName);
+      // eslint-disable-next-line no-await-in-loop
+      const removedIndexes = await Model.syncIndexes(); // that not a bug. Lets do one by one
+      if (removedIndexes.length) {
+        this.logger.info(
+          `Model - ${modelName} removed indexes: ${removedIndexes}`,
+        );
+      } else {
+        this.logger.info(`Model - ${modelName} NO removed indexes`);
+      }
+    }
+  }
+
+  static get description() {
+    return 'Synchronize indexes defined in models with a real one indexed on the database.  Command will remove all indexes from the database that do not exist on model OR have different parameters. Then it will create a new indexes   ';
+  }
+}
+
+module.exports = SyncIndexes;

package/config/i18n.js

@@ -2,6 +2,8 @@ module.exports = {
   enabled: true,
   preload: ['en', 'ru'],
   fallbackLng: 'en',
+  saveMissing: false,
+  debug: false,
   // https://github.com/i18next/i18next-http-middleware#detector-options
   // in additional we have 'xLang' that detect language based on header 'xLang'
   langDetectionOders: ['xLang'], // from order option

package/modules/AbstractController.js

@@ -98,7 +98,8 @@ class AbstractController extends Base {
             path: realPath,
             fullPath,
             params: middlewareParams,
-            authParams: MiddlewareFunction?.usedAuthParameters,
+            authParams: new MiddlewareFunction(this.app, middlewareParams)
+              ?.usedAuthParameters,
             MiddlewareFunction,
           });
         }

package/modules/Base.js

@@ -1,5 +1,5 @@
 const fs = require('fs').promises;
-const { join } = require('path');
+const { join, normalize } = require('path');
 
 class Base {
   #realLogger = null;
@@ -108,7 +108,7 @@ class Base {
           return null;
         }),
       );
-      return allFiles.map((file) => file.replace(`${dir}/`, ''));
+      return allFiles.map((file) => file.replace(`${normalize(dir)}/`, ''));
     }
 
     let [internalFiles, externalFiles] = await Promise.all([

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptivestone/framework",
-  "version": "3.2.1",
+  "version": "3.3.0",
   "description": "Adaptive stone node js framework",
   "main": "src/index.js",
   "engines": {
@@ -49,7 +49,6 @@
     "nodemailer": "^6.6.3",
     "nodemailer-sendmail-transport": "^1.0.2",
     "nodemailer-stub-transport": "^1.1.0",
-    "prettier": "^2.3.2",
     "pug": "^3.0.2",
     "rate-limiter-flexible": "^2.2.4",
     "redis": "^4.3.1",
@@ -68,6 +67,7 @@
     "lint-staged": "^13.0.0",
     "mongodb-memory-server": "^8.0.2",
     "nodemon": "^2.0.12",
+    "prettier": "^2.3.2",
     "supertest": "^6.1.4"
   },
   "lint-staged": {

package/services/http/HttpServer.js

@@ -133,8 +133,8 @@ class HttpServer extends Base {
         },
         fallbackLng: I18NConfig.fallbackLng,
         preload: I18NConfig.preload,
-        saveMissing: true,
-        debug: false,
+        saveMissing: I18NConfig.saveMissing,
+        debug: I18NConfig.debug,
         detection: {
           // caches: ['cookie'],
           order: I18NConfig.langDetectionOders || ['xLang'],

package/services/http/middleware/GetUserByToken.js

@@ -5,7 +5,7 @@ class GetUserByToken extends AbstractMiddleware {
     return 'Grab a token and try to parse the user from it. It user exist will add req.appInfo.user variable';
   }
 
-  static get usedAuthParameters() {
+  get usedAuthParameters() {
     return [
       {
         name: 'Authorization',