@adaptivestone/framework 3.4.0 → 3.4.2

package/CHANGELOG.md

@@ -1,3 +1,12 @@
+### 3.4.2
+
+[UPDATE] updated deps
+[FIX] fix documentation generation
+
+### 3.4.1
+
+[FIX] fix documentation generation
+
 ### 3.4.0
 
 [NEW] now we pass 'req' to validation and casting as a second parameter. This done mostly for custom validators

package/commands/GetOpenApiJson.js

@@ -81,6 +81,7 @@ class GetOpenApiJson extends AbstractCommand {
 
     openApi.paths = {};
 
+    const permissionWithRoutes = {};
     for (const controller of baseDocumentation) {
       for (const route of controller.routesInfo) {
         const routeInfo = route[Object.keys(route)?.[0]];
@@ -91,14 +92,18 @@ class GetOpenApiJson extends AbstractCommand {
 
         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;
-                let fullName = authParam.name;
+                const fullName = authParam.name;
                 if (permissions) {
-                  fullName = `${fullName}-permissions-${permissions}`;
+                  permissionWithRoutes[Object.keys(route)?.[0]].push(
+                    permissions,
+                  );
                 }
 
                 if (!openApi.components.securitySchemes[fullName]) {
@@ -114,7 +119,6 @@ class GetOpenApiJson extends AbstractCommand {
         }
 
         let routeName = Object.keys(route)[0];
-
         if (routeName === '/') {
           // eslint-disable-next-line no-continue
           continue;
@@ -148,10 +152,18 @@ class GetOpenApiJson extends AbstractCommand {
           openApi.paths[routeName] = {};
         }
 
-        const methodName = route[Object.keys(route)[0]].method.toLowerCase();
-        const routeTitle = route[Object.keys(route)[0]].name;
         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;
 
         if (!openApi.paths[routeName][methodName]) {
@@ -165,7 +177,8 @@ class GetOpenApiJson extends AbstractCommand {
         );
 
         openApi.paths[routeName][methodName].summary = routeTitle;
-        openApi.paths[routeName][methodName].description = routeDescription;
+        openApi.paths[routeName][methodName].description =
+          routeDescriptionWithPermissions;
         openApi.paths[routeName][methodName].parameters = [];
         openApi.paths[routeName][methodName].security = securitySchemaNames;
 
@@ -229,6 +242,19 @@ class GetOpenApiJson extends AbstractCommand {
                   type: field.innerType,
                 };
               }
+
+              if (field.type === 'lazy') {
+                groupBodyFields[field.name] = {
+                  oneOf: [
+                    {
+                      type: 'object',
+                    },
+                    {
+                      type: 'string',
+                    },
+                  ],
+                };
+              }
             }
           }
 

package/modules/AbstractController.js

@@ -364,13 +364,11 @@ class AbstractController extends Base {
               .map((middleware) => {
                 const routeFullPath = route.fullPath.toUpperCase();
                 const middlewareFullPath = middleware.fullPath.toUpperCase();
-                const middlewareFullPathWithSliced = middleware.fullPath
-                  .toUpperCase()
-                  .slice(0, -1);
                 if (
-                  middlewareFullPath === routeFullPath ||
-                  middlewareFullPath === `${routeFullPath}*` ||
-                  routeFullPath?.indexOf(middlewareFullPathWithSliced) !== -1
+                  route.method.toLowerCase() ===
+                    middleware.method.toLowerCase() &&
+                  (middlewareFullPath === routeFullPath ||
+                    middlewareFullPath === `${routeFullPath}*`)
                 ) {
                   return {
                     name: middleware.name,
@@ -390,6 +388,7 @@ class AbstractController extends Base {
                     const middlewareFullPathWithSliced = middleware.fullPath
                       .toUpperCase()
                       .slice(0, -1);
+
                     return (
                       middlewareFullPath === routeFullPath ||
                       middlewareFullPath === `${routeFullPath}*` ||

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptivestone/framework",
-  "version": "3.4.0",
+  "version": "3.4.2",
   "description": "Adaptive stone node js framework",
   "main": "src/index.js",
   "engines": {