arkos 2.0.0-next.5 → 2.0.0-next.7

package/dist/cjs/modules/auth/auth.router.js

@@ -10,18 +10,32 @@ const arkos_router_1 = __importDefault(require("../../utils/arkos-router/index.j
 const arkos_loadable_registry_1 = __importDefault(require("../../components/arkos-loadable-registry/index.js"));
 const reader_1 = require("../../components/arkos-route-hook/reader.js");
 const auth_controller_1 = __importDefault(require("./auth.controller.js"));
+const auth_openapi_generator_1 = __importDefault(require("./utils/auth-openapi-generator.js"));
 function getAuthRouter() {
     const router = (0, arkos_router_1.default)();
     const routeHook = arkos_loadable_registry_1.default.getItem("ArkosRouteHook", "auth");
-    const op = (operation) => routeHook
-        ? reader_1.routeHookReader.forOperation("auth", operation)
-        : {
-            before: [],
-            after: [],
-            onError: [],
-            prismaArgs: {},
-            routeConfig: {},
-        };
+    const op = (operation) => {
+        const components = routeHook
+            ? reader_1.routeHookReader.forOperation("auth", operation)
+            : {
+                before: [],
+                after: [],
+                onError: [],
+                prismaArgs: {},
+                routeConfig: {},
+            };
+        let endpointConfig = components.routeConfig || {};
+        if (endpointConfig?.experimental?.openapi !== false)
+            endpointConfig = {
+                ...(endpointConfig || {}),
+                experimental: {
+                    ...(endpointConfig?.experimental || {}),
+                    openapi: auth_openapi_generator_1.default.getOpenApiConfig(endpointConfig, operation),
+                },
+            };
+        components.routeConfig = endpointConfig;
+        return components;
+    };
     {
         const { before, after, onError, prismaArgs, routeConfig } = op("getMe");
         router.get({

package/dist/cjs/modules/auth/auth.router.js.map

@@ -1 +1 @@
-{"version":3,"file":"auth.router.js","sourceRoot":"","sources":["../../../../src/modules/auth/auth.router.ts"],"names":[],"mappings":";;;;;AAaA,sCA4NC;AAxOD,+DAGkC;AAElC,yEAAwE;AACxE,4EAAmD;AACnD,uGAAwE;AACxE,qEAA2E;AAE3E,wEAA+C;AAE/C,SAAgB,aAAa;IAC3B,MAAM,MAAM,GAAG,IAAA,sBAAW,GAAE,CAAC;IAC7B,MAAM,SAAS,GAAG,iCAAgB,CAAC,OAAO,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC;IAErE,MAAM,EAAE,GAAG,CACT,SAA0E,EAC1E,EAAE,CACF,SAAS;QACP,CAAC,CAAC,wBAAe,CAAC,YAAY,CAAC,MAAM,EAAE,SAAS,CAAC;QACjD,CAAC,CAAC;YACE,MAAM,EAAE,EAAE;YACV,KAAK,EAAE,EAAE;YACT,OAAO,EAAE,EAAE;YACX,UAAU,EAAE,EAAE;YACd,WAAW,EAAE,EAAE;SAChB,CAAC;IAGR,CAAC;QACC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,CAAC;QAExE,MAAM,CAAC,GAAG,CACR;YACE,GAAG,WAAW;YACd,IAAI,EAAE,WAAW;SAClB,EACD,IAAA,iDAA8B,EAC5B,EAAE,KAAK,EAAE,UAAU,EAAiC,EACpD,OAAO,CACR,EACD,GAAG,IAAA,mCAAiB,EAAC,MAAM,CAAC,EAC5B,yBAAc,CAAC,KAAK,EACpB,GAAG,IAAA,mCAAiB,EAAC,KAAK,CAAC,EAC3B,+BAAY,EACZ,GAAG,IAAA,mCAAiB,EAAC,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CACjD,CAAC;IACJ,CAAC;IAGD,CAAC;QACC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,CAAC;QAE3E,MAAM,CAAC,KAAK,CACV;YACE,GAAG,WAAW;YACd,IAAI,EAAE,WAAW;SAClB,EACD,IAAA,iDAA8B,EAC5B,EAAE,QAAQ,EAAE,UAAU,EAAiC,EACvD,UAAU,CACX,EACD,GAAG,IAAA,mCAAiB,EAAC,MAAM,CAAC,EAC5B,yBAAc,CAAC,QAAQ,EACvB,GAAG,IAAA,mCAAiB,EAAC,KAAK,CAAC,EAC3B,+BAAY,EACZ,GAAG,IAAA,mCAAiB,EAAC,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CACjD,CAAC;IACJ,CAAC;IAGD,CAAC;QACC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,CAAC;QAE3E,MAAM,CAAC,MAAM,CACX;YACE,GAAG,WAAW;YACd,IAAI,EAAE,WAAW;SAClB,EACD,IAAA,iDAA8B,EAC5B,EAAE,QAAQ,EAAE,UAAU,EAAiC,EACvD,UAAU,CACX,EACD,GAAG,IAAA,mCAAiB,EAAC,MAAM,CAAC,EAC5B,yBAAc,CAAC,QAAQ,EACvB,GAAG,IAAA,mCAAiB,EAAC,KAAK,CAAC,EAC3B,+BAAY,EACZ,GAAG,IAAA,mCAAiB,EAAC,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CACjD,CAAC;IACJ,CAAC;IAED,MAAM,eAAe,GAA8B;QACjD,QAAQ,EAAE,IAAI;QACd,KAAK,EAAE,EAAE;QACT,eAAe,EAAE,SAAS;QAC1B,aAAa,EAAE,KAAK;QACpB,OAAO,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE;YAClB,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;gBACnB,OAAO,EAAE,2CAA2C;aACrD,CAAC,CAAC;QACL,CAAC;KACF,CAAC;IAGF,CAAC;QACC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,CAAC;QAExE,MAAM,CAAC,IAAI,CACT;YACE,cAAc,EAAE,KAAK;YACrB,SAAS,EAAE,eAAe;YAC1B,GAAG,WAAW;YACd,IAAI,EAAE,aAAa;SACpB,EACD,IAAA,iDAA8B,EAC5B,EAAE,KAAK,EAAE,UAAU,EAAiC,EACpD,OAAO,CACR,EACD,GAAG,IAAA,mCAAiB,EAAC,MAAM,CAAC,EAC5B,yBAAc,CAAC,KAAK,EACpB,GAAG,IAAA,mCAAiB,EAAC,KAAK,CAAC,EAC3B,+BAAY,EACZ,GAAG,IAAA,mCAAiB,EAAC,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CACjD,CAAC;IACJ,CAAC;IAGD,CAAC;QACC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,CAAC;QAE7D,MAAM,CAAC,MAAM,CACX;YACE,SAAS,EAAE,eAAe;YAC1B,GAAG,WAAW;YACd,IAAI,EAAE,cAAc;SACrB,EACD,GAAG,IAAA,mCAAiB,EAAC,MAAM,CAAC,EAC5B,yBAAc,CAAC,MAAM,EACrB,GAAG,IAAA,mCAAiB,EAAC,KAAK,CAAC,EAC3B,+BAAY,EACZ,GAAG,IAAA,mCAAiB,EAAC,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CACjD,CAAC;IACJ,CAAC;IAGD,CAAC;QACC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,CAAC;QAEzE,MAAM,CAAC,IAAI,CACT;YACE,cAAc,EAAE,KAAK;YACrB,SAAS,EAAE,eAAe;YAC1B,GAAG,WAAW;YACd,IAAI,EAAE,cAAc;SACrB,EACD,IAAA,iDAA8B,EAC5B,EAAE,MAAM,EAAE,UAAU,EAAiC,EACrD,QAAQ,CACT,EACD,GAAG,IAAA,mCAAiB,EAAC,MAAM,CAAC,EAC5B,yBAAc,CAAC,MAAM,EACrB,GAAG,IAAA,mCAAiB,EAAC,KAAK,CAAC,EAC3B,+BAAY,EACZ,GAAG,IAAA,mCAAiB,EAAC,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CACjD,CAAC;IACJ,CAAC;IAGD,CAAC;QACC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,GACvD,EAAE,CAAC,gBAAgB,CAAC,CAAC;QAEvB,MAAM,CAAC,IAAI,CACT;YACE,SAAS,EAAE,eAAe;YAC1B,GAAG,WAAW;YACd,IAAI,EAAE,uBAAuB;SAC9B,EACD,IAAA,iDAA8B,EAC5B,EAAE,cAAc,EAAE,UAAU,EAAiC,EAC7D,gBAAgB,CACjB,EACD,GAAG,IAAA,mCAAiB,EAAC,MAAM,CAAC,EAC5B,yBAAc,CAAC,cAAc,EAC7B,GAAG,IAAA,mCAAiB,EAAC,KAAK,CAAC,EAC3B,+BAAY,EACZ,GAAG,IAAA,mCAAiB,EAAC,OAAO,EAAE;YAC5B,IAAI,EAAE,OAAO;SACd,CAAC,CACH,CAAC;IACJ,CAAC;IAGD,CAAC;QACC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,EAAE,CAAC,oBAAoB,CAAC,CAAC;QAEzE,MAAM,CAAC,GAAG,CACR;YACE,GAAG,WAAW;YACd,IAAI,EAAE,eAAe;SACtB,EACD,GAAG,IAAA,mCAAiB,EAAC,MAAM,CAAC,EAC5B,yBAAc,CAAC,kBAAkB,EACjC,GAAG,IAAA,mCAAiB,EAAC,KAAK,CAAC,EAC3B,+BAAY,EACZ,GAAG,IAAA,mCAAiB,EAAC,OAAO,EAAE;YAC5B,IAAI,EAAE,OAAO;SACd,CAAC,CACH,CAAC;IACJ,CAAC;IAGD,CAAC;QACC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,EAAE,CAAC,mBAAmB,CAAC,CAAC;QAExE,MAAM,CAAC,GAAG,CACR;YACE,GAAG,WAAW;YACd,IAAI,EAAE,6BAA6B;SACpC,EACD,GAAG,IAAA,mCAAiB,EAAC,MAAM,CAAC,EAC5B,yBAAc,CAAC,iBAAiB,EAChC,GAAG,IAAA,mCAAiB,EAAC,KAAK,CAAC,EAC3B,+BAAY,EACZ,GAAG,IAAA,mCAAiB,EAAC,OAAO,EAAE;YAC5B,IAAI,EAAE,OAAO;SACd,CAAC,CACH,CAAC;IACJ,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC","sourcesContent":["import { Options as RateLimitOptions } from \"express-rate-limit\";\nimport {\n  addPrismaQueryOptionsToRequest,\n  sendResponse,\n} from \"../base/base.middlewares\";\nimport { AuthPrismaQueryOptions } from \"../../types\";\nimport { processMiddleware } from \"../../utils/helpers/routers.helpers\";\nimport ArkosRouter from \"../../utils/arkos-router\";\nimport loadableRegistry from \"../../components/arkos-loadable-registry\";\nimport { routeHookReader } from \"../../components/arkos-route-hook/reader\";\nimport { ArkosAuthRouteHookInstance } from \"../../components/arkos-route-hook/types\";\nimport authController from \"./auth.controller\";\n\nexport function getAuthRouter() {\n  const router = ArkosRouter();\n  const routeHook = loadableRegistry.getItem(\"ArkosRouteHook\", \"auth\");\n\n  const op = (\n    operation: keyof Omit<ArkosAuthRouteHookInstance, \"__type\" | \"moduleName\">\n  ) =>\n    routeHook\n      ? routeHookReader.forOperation(\"auth\", operation)\n      : {\n          before: [],\n          after: [],\n          onError: [],\n          prismaArgs: {},\n          routeConfig: {},\n        };\n\n  // GET /users/me - Get current user\n  {\n    const { before, after, onError, prismaArgs, routeConfig } = op(\"getMe\");\n\n    router.get(\n      {\n        ...routeConfig,\n        path: \"/users/me\",\n      },\n      addPrismaQueryOptionsToRequest<any>(\n        { getMe: prismaArgs } as AuthPrismaQueryOptions<any>,\n        \"getMe\"\n      ),\n      ...processMiddleware(before),\n      authController.getMe,\n      ...processMiddleware(after),\n      sendResponse,\n      ...processMiddleware(onError, { type: \"error\" })\n    );\n  }\n\n  // PATCH /users/me - Update current user\n  {\n    const { before, after, onError, prismaArgs, routeConfig } = op(\"updateMe\");\n\n    router.patch(\n      {\n        ...routeConfig,\n        path: \"/users/me\",\n      },\n      addPrismaQueryOptionsToRequest<any>(\n        { updateMe: prismaArgs } as AuthPrismaQueryOptions<any>,\n        \"updateMe\"\n      ),\n      ...processMiddleware(before),\n      authController.updateMe,\n      ...processMiddleware(after),\n      sendResponse,\n      ...processMiddleware(onError, { type: \"error\" })\n    );\n  }\n\n  // DELETE /users/me - Delete current user\n  {\n    const { before, after, onError, prismaArgs, routeConfig } = op(\"deleteMe\");\n\n    router.delete(\n      {\n        ...routeConfig,\n        path: \"/users/me\",\n      },\n      addPrismaQueryOptionsToRequest<any>(\n        { deleteMe: prismaArgs } as AuthPrismaQueryOptions<any>,\n        \"deleteMe\"\n      ),\n      ...processMiddleware(before),\n      authController.deleteMe,\n      ...processMiddleware(after),\n      sendResponse,\n      ...processMiddleware(onError, { type: \"error\" })\n    );\n  }\n\n  const rateLimitConfig: Partial<RateLimitOptions> = {\n    windowMs: 5000,\n    limit: 10,\n    standardHeaders: \"draft-7\",\n    legacyHeaders: false,\n    handler: (_, res) => {\n      res.status(429).json({\n        message: \"Too many requests, please try again later\",\n      });\n    },\n  };\n\n  // POST /auth/login - Login\n  {\n    const { before, after, onError, prismaArgs, routeConfig } = op(\"login\");\n\n    router.post(\n      {\n        authentication: false,\n        rateLimit: rateLimitConfig,\n        ...routeConfig,\n        path: \"/auth/login\",\n      },\n      addPrismaQueryOptionsToRequest<any>(\n        { login: prismaArgs } as AuthPrismaQueryOptions<any>,\n        \"login\"\n      ),\n      ...processMiddleware(before),\n      authController.login,\n      ...processMiddleware(after),\n      sendResponse,\n      ...processMiddleware(onError, { type: \"error\" })\n    );\n  }\n\n  // DELETE /auth/logout - Logout\n  {\n    const { before, after, onError, routeConfig } = op(\"logout\");\n\n    router.delete(\n      {\n        rateLimit: rateLimitConfig,\n        ...routeConfig,\n        path: \"/auth/logout\",\n      },\n      ...processMiddleware(before),\n      authController.logout,\n      ...processMiddleware(after),\n      sendResponse,\n      ...processMiddleware(onError, { type: \"error\" })\n    );\n  }\n\n  // POST /auth/signup - Signup\n  {\n    const { before, after, onError, prismaArgs, routeConfig } = op(\"signup\");\n\n    router.post(\n      {\n        authentication: false,\n        rateLimit: rateLimitConfig,\n        ...routeConfig,\n        path: \"/auth/signup\",\n      },\n      addPrismaQueryOptionsToRequest<any>(\n        { signup: prismaArgs } as AuthPrismaQueryOptions<any>,\n        \"signup\"\n      ),\n      ...processMiddleware(before),\n      authController.signup,\n      ...processMiddleware(after),\n      sendResponse,\n      ...processMiddleware(onError, { type: \"error\" })\n    );\n  }\n\n  // POST /auth/update-password - Update password\n  {\n    const { before, after, onError, prismaArgs, routeConfig } =\n      op(\"updatePassword\");\n\n    router.post(\n      {\n        rateLimit: rateLimitConfig,\n        ...routeConfig,\n        path: \"/auth/update-password\",\n      },\n      addPrismaQueryOptionsToRequest<any>(\n        { updatePassword: prismaArgs } as AuthPrismaQueryOptions<any>,\n        \"updatePassword\"\n      ),\n      ...processMiddleware(before),\n      authController.updatePassword,\n      ...processMiddleware(after),\n      sendResponse,\n      ...processMiddleware(onError, {\n        type: \"error\",\n      })\n    );\n  }\n\n  // GET /auth-actions - Find many auth actions\n  {\n    const { before, after, onError, routeConfig } = op(\"findManyAuthAction\");\n\n    router.get(\n      {\n        ...routeConfig,\n        path: \"/auth-actions\",\n      },\n      ...processMiddleware(before),\n      authController.findManyAuthAction,\n      ...processMiddleware(after),\n      sendResponse,\n      ...processMiddleware(onError, {\n        type: \"error\",\n      })\n    );\n  }\n\n  // GET /auth-actions/:resourceName - Find one auth action\n  {\n    const { before, after, onError, routeConfig } = op(\"findOneAuthAction\");\n\n    router.get(\n      {\n        ...routeConfig,\n        path: \"/auth-actions/:resourceName\",\n      },\n      ...processMiddleware(before),\n      authController.findOneAuthAction,\n      ...processMiddleware(after),\n      sendResponse,\n      ...processMiddleware(onError, {\n        type: \"error\",\n      })\n    );\n  }\n\n  return router;\n}\n"]}
+{"version":3,"file":"auth.router.js","sourceRoot":"","sources":["../../../../src/modules/auth/auth.router.ts"],"names":[],"mappings":";;;;;AAcA,sCA8OC;AA3PD,+DAGkC;AAElC,yEAAwE;AACxE,4EAAmD;AACnD,uGAAwE;AACxE,qEAA2E;AAE3E,wEAA+C;AAC/C,4FAAkE;AAElE,SAAgB,aAAa;IAC3B,MAAM,MAAM,GAAG,IAAA,sBAAW,GAAE,CAAC;IAC7B,MAAM,SAAS,GAAG,iCAAgB,CAAC,OAAO,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC;IAErE,MAAM,EAAE,GAAG,CACT,SAA0E,EAC1E,EAAE;QACF,MAAM,UAAU,GAAG,SAAS;YAC1B,CAAC,CAAC,wBAAe,CAAC,YAAY,CAAC,MAAM,EAAE,SAAS,CAAC;YACjD,CAAC,CAAC;gBACE,MAAM,EAAE,EAAE;gBACV,KAAK,EAAE,EAAE;gBACT,OAAO,EAAE,EAAE;gBACX,UAAU,EAAE,EAAE;gBACd,WAAW,EAAE,EAAE;aAChB,CAAC;QAEN,IAAI,cAAc,GAAG,UAAU,CAAC,WAAW,IAAI,EAAE,CAAC;QAElD,IAAI,cAAc,EAAE,YAAY,EAAE,OAAO,KAAK,KAAK;YACjD,cAAc,GAAG;gBACf,GAAG,CAAC,cAAc,IAAI,EAAE,CAAC;gBACzB,YAAY,EAAE;oBACZ,GAAG,CAAC,cAAc,EAAE,YAAY,IAAI,EAAE,CAAC;oBACvC,OAAO,EAAE,gCAAoB,CAAC,gBAAgB,CAC5C,cAAc,EACd,SAAS,CACV;iBACF;aACF,CAAC;QAEJ,UAAU,CAAC,WAAW,GAAG,cAAc,CAAC;QACxC,OAAO,UAAU,CAAC;IACpB,CAAC,CAAC;IAGF,CAAC;QACC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,CAAC;QAExE,MAAM,CAAC,GAAG,CACR;YACE,GAAG,WAAW;YACd,IAAI,EAAE,WAAW;SAClB,EACD,IAAA,iDAA8B,EAC5B,EAAE,KAAK,EAAE,UAAU,EAAiC,EACpD,OAAO,CACR,EACD,GAAG,IAAA,mCAAiB,EAAC,MAAM,CAAC,EAC5B,yBAAc,CAAC,KAAK,EACpB,GAAG,IAAA,mCAAiB,EAAC,KAAK,CAAC,EAC3B,+BAAY,EACZ,GAAG,IAAA,mCAAiB,EAAC,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CACjD,CAAC;IACJ,CAAC;IAGD,CAAC;QACC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,CAAC;QAE3E,MAAM,CAAC,KAAK,CACV;YACE,GAAG,WAAW;YACd,IAAI,EAAE,WAAW;SAClB,EACD,IAAA,iDAA8B,EAC5B,EAAE,QAAQ,EAAE,UAAU,EAAiC,EACvD,UAAU,CACX,EACD,GAAG,IAAA,mCAAiB,EAAC,MAAM,CAAC,EAC5B,yBAAc,CAAC,QAAQ,EACvB,GAAG,IAAA,mCAAiB,EAAC,KAAK,CAAC,EAC3B,+BAAY,EACZ,GAAG,IAAA,mCAAiB,EAAC,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CACjD,CAAC;IACJ,CAAC;IAGD,CAAC;QACC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,CAAC;QAE3E,MAAM,CAAC,MAAM,CACX;YACE,GAAG,WAAW;YACd,IAAI,EAAE,WAAW;SAClB,EACD,IAAA,iDAA8B,EAC5B,EAAE,QAAQ,EAAE,UAAU,EAAiC,EACvD,UAAU,CACX,EACD,GAAG,IAAA,mCAAiB,EAAC,MAAM,CAAC,EAC5B,yBAAc,CAAC,QAAQ,EACvB,GAAG,IAAA,mCAAiB,EAAC,KAAK,CAAC,EAC3B,+BAAY,EACZ,GAAG,IAAA,mCAAiB,EAAC,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CACjD,CAAC;IACJ,CAAC;IAED,MAAM,eAAe,GAA8B;QACjD,QAAQ,EAAE,IAAI;QACd,KAAK,EAAE,EAAE;QACT,eAAe,EAAE,SAAS;QAC1B,aAAa,EAAE,KAAK;QACpB,OAAO,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE;YAClB,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;gBACnB,OAAO,EAAE,2CAA2C;aACrD,CAAC,CAAC;QACL,CAAC;KACF,CAAC;IAGF,CAAC;QACC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,CAAC;QAExE,MAAM,CAAC,IAAI,CACT;YACE,cAAc,EAAE,KAAK;YACrB,SAAS,EAAE,eAAe;YAC1B,GAAG,WAAW;YACd,IAAI,EAAE,aAAa;SACpB,EACD,IAAA,iDAA8B,EAC5B,EAAE,KAAK,EAAE,UAAU,EAAiC,EACpD,OAAO,CACR,EACD,GAAG,IAAA,mCAAiB,EAAC,MAAM,CAAC,EAC5B,yBAAc,CAAC,KAAK,EACpB,GAAG,IAAA,mCAAiB,EAAC,KAAK,CAAC,EAC3B,+BAAY,EACZ,GAAG,IAAA,mCAAiB,EAAC,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CACjD,CAAC;IACJ,CAAC;IAGD,CAAC;QACC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,CAAC;QAE7D,MAAM,CAAC,MAAM,CACX;YACE,SAAS,EAAE,eAAe;YAC1B,GAAG,WAAW;YACd,IAAI,EAAE,cAAc;SACrB,EACD,GAAG,IAAA,mCAAiB,EAAC,MAAM,CAAC,EAC5B,yBAAc,CAAC,MAAM,EACrB,GAAG,IAAA,mCAAiB,EAAC,KAAK,CAAC,EAC3B,+BAAY,EACZ,GAAG,IAAA,mCAAiB,EAAC,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CACjD,CAAC;IACJ,CAAC;IAGD,CAAC;QACC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,CAAC;QAEzE,MAAM,CAAC,IAAI,CACT;YACE,cAAc,EAAE,KAAK;YACrB,SAAS,EAAE,eAAe;YAC1B,GAAG,WAAW;YACd,IAAI,EAAE,cAAc;SACrB,EACD,IAAA,iDAA8B,EAC5B,EAAE,MAAM,EAAE,UAAU,EAAiC,EACrD,QAAQ,CACT,EACD,GAAG,IAAA,mCAAiB,EAAC,MAAM,CAAC,EAC5B,yBAAc,CAAC,MAAM,EACrB,GAAG,IAAA,mCAAiB,EAAC,KAAK,CAAC,EAC3B,+BAAY,EACZ,GAAG,IAAA,mCAAiB,EAAC,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CACjD,CAAC;IACJ,CAAC;IAGD,CAAC;QACC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,GACvD,EAAE,CAAC,gBAAgB,CAAC,CAAC;QAEvB,MAAM,CAAC,IAAI,CACT;YACE,SAAS,EAAE,eAAe;YAC1B,GAAG,WAAW;YACd,IAAI,EAAE,uBAAuB;SAC9B,EACD,IAAA,iDAA8B,EAC5B,EAAE,cAAc,EAAE,UAAU,EAAiC,EAC7D,gBAAgB,CACjB,EACD,GAAG,IAAA,mCAAiB,EAAC,MAAM,CAAC,EAC5B,yBAAc,CAAC,cAAc,EAC7B,GAAG,IAAA,mCAAiB,EAAC,KAAK,CAAC,EAC3B,+BAAY,EACZ,GAAG,IAAA,mCAAiB,EAAC,OAAO,EAAE;YAC5B,IAAI,EAAE,OAAO;SACd,CAAC,CACH,CAAC;IACJ,CAAC;IAGD,CAAC;QACC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,EAAE,CAAC,oBAAoB,CAAC,CAAC;QAEzE,MAAM,CAAC,GAAG,CACR;YACE,GAAG,WAAW;YACd,IAAI,EAAE,eAAe;SACtB,EACD,GAAG,IAAA,mCAAiB,EAAC,MAAM,CAAC,EAC5B,yBAAc,CAAC,kBAAkB,EACjC,GAAG,IAAA,mCAAiB,EAAC,KAAK,CAAC,EAC3B,+BAAY,EACZ,GAAG,IAAA,mCAAiB,EAAC,OAAO,EAAE;YAC5B,IAAI,EAAE,OAAO;SACd,CAAC,CACH,CAAC;IACJ,CAAC;IAGD,CAAC;QACC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,EAAE,CAAC,mBAAmB,CAAC,CAAC;QAExE,MAAM,CAAC,GAAG,CACR;YACE,GAAG,WAAW;YACd,IAAI,EAAE,6BAA6B;SACpC,EACD,GAAG,IAAA,mCAAiB,EAAC,MAAM,CAAC,EAC5B,yBAAc,CAAC,iBAAiB,EAChC,GAAG,IAAA,mCAAiB,EAAC,KAAK,CAAC,EAC3B,+BAAY,EACZ,GAAG,IAAA,mCAAiB,EAAC,OAAO,EAAE;YAC5B,IAAI,EAAE,OAAO;SACd,CAAC,CACH,CAAC;IACJ,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC","sourcesContent":["import { Options as RateLimitOptions } from \"express-rate-limit\";\nimport {\n  addPrismaQueryOptionsToRequest,\n  sendResponse,\n} from \"../base/base.middlewares\";\nimport { AuthPrismaQueryOptions } from \"../../types\";\nimport { processMiddleware } from \"../../utils/helpers/routers.helpers\";\nimport ArkosRouter from \"../../utils/arkos-router\";\nimport loadableRegistry from \"../../components/arkos-loadable-registry\";\nimport { routeHookReader } from \"../../components/arkos-route-hook/reader\";\nimport { ArkosAuthRouteHookInstance } from \"../../components/arkos-route-hook/types\";\nimport authController from \"./auth.controller\";\nimport authOpenAPIGenerator from \"./utils/auth-openapi-generator\";\n\nexport function getAuthRouter() {\n  const router = ArkosRouter();\n  const routeHook = loadableRegistry.getItem(\"ArkosRouteHook\", \"auth\");\n\n  const op = (\n    operation: keyof Omit<ArkosAuthRouteHookInstance, \"__type\" | \"moduleName\">\n  ) => {\n    const components = routeHook\n      ? routeHookReader.forOperation(\"auth\", operation)\n      : {\n          before: [],\n          after: [],\n          onError: [],\n          prismaArgs: {},\n          routeConfig: {},\n        };\n\n    let endpointConfig = components.routeConfig || {};\n\n    if (endpointConfig?.experimental?.openapi !== false)\n      endpointConfig = {\n        ...(endpointConfig || {}),\n        experimental: {\n          ...(endpointConfig?.experimental || {}),\n          openapi: authOpenAPIGenerator.getOpenApiConfig(\n            endpointConfig,\n            operation\n          ),\n        },\n      };\n\n    components.routeConfig = endpointConfig;\n    return components;\n  };\n\n  // GET /users/me - Get current user\n  {\n    const { before, after, onError, prismaArgs, routeConfig } = op(\"getMe\");\n\n    router.get(\n      {\n        ...routeConfig,\n        path: \"/users/me\",\n      },\n      addPrismaQueryOptionsToRequest<any>(\n        { getMe: prismaArgs } as AuthPrismaQueryOptions<any>,\n        \"getMe\"\n      ),\n      ...processMiddleware(before),\n      authController.getMe,\n      ...processMiddleware(after),\n      sendResponse,\n      ...processMiddleware(onError, { type: \"error\" })\n    );\n  }\n\n  // PATCH /users/me - Update current user\n  {\n    const { before, after, onError, prismaArgs, routeConfig } = op(\"updateMe\");\n\n    router.patch(\n      {\n        ...routeConfig,\n        path: \"/users/me\",\n      },\n      addPrismaQueryOptionsToRequest<any>(\n        { updateMe: prismaArgs } as AuthPrismaQueryOptions<any>,\n        \"updateMe\"\n      ),\n      ...processMiddleware(before),\n      authController.updateMe,\n      ...processMiddleware(after),\n      sendResponse,\n      ...processMiddleware(onError, { type: \"error\" })\n    );\n  }\n\n  // DELETE /users/me - Delete current user\n  {\n    const { before, after, onError, prismaArgs, routeConfig } = op(\"deleteMe\");\n\n    router.delete(\n      {\n        ...routeConfig,\n        path: \"/users/me\",\n      },\n      addPrismaQueryOptionsToRequest<any>(\n        { deleteMe: prismaArgs } as AuthPrismaQueryOptions<any>,\n        \"deleteMe\"\n      ),\n      ...processMiddleware(before),\n      authController.deleteMe,\n      ...processMiddleware(after),\n      sendResponse,\n      ...processMiddleware(onError, { type: \"error\" })\n    );\n  }\n\n  const rateLimitConfig: Partial<RateLimitOptions> = {\n    windowMs: 5000,\n    limit: 10,\n    standardHeaders: \"draft-7\",\n    legacyHeaders: false,\n    handler: (_, res) => {\n      res.status(429).json({\n        message: \"Too many requests, please try again later\",\n      });\n    },\n  };\n\n  // POST /auth/login - Login\n  {\n    const { before, after, onError, prismaArgs, routeConfig } = op(\"login\");\n\n    router.post(\n      {\n        authentication: false,\n        rateLimit: rateLimitConfig,\n        ...routeConfig,\n        path: \"/auth/login\",\n      },\n      addPrismaQueryOptionsToRequest<any>(\n        { login: prismaArgs } as AuthPrismaQueryOptions<any>,\n        \"login\"\n      ),\n      ...processMiddleware(before),\n      authController.login,\n      ...processMiddleware(after),\n      sendResponse,\n      ...processMiddleware(onError, { type: \"error\" })\n    );\n  }\n\n  // DELETE /auth/logout - Logout\n  {\n    const { before, after, onError, routeConfig } = op(\"logout\");\n\n    router.delete(\n      {\n        rateLimit: rateLimitConfig,\n        ...routeConfig,\n        path: \"/auth/logout\",\n      },\n      ...processMiddleware(before),\n      authController.logout,\n      ...processMiddleware(after),\n      sendResponse,\n      ...processMiddleware(onError, { type: \"error\" })\n    );\n  }\n\n  // POST /auth/signup - Signup\n  {\n    const { before, after, onError, prismaArgs, routeConfig } = op(\"signup\");\n\n    router.post(\n      {\n        authentication: false,\n        rateLimit: rateLimitConfig,\n        ...routeConfig,\n        path: \"/auth/signup\",\n      },\n      addPrismaQueryOptionsToRequest<any>(\n        { signup: prismaArgs } as AuthPrismaQueryOptions<any>,\n        \"signup\"\n      ),\n      ...processMiddleware(before),\n      authController.signup,\n      ...processMiddleware(after),\n      sendResponse,\n      ...processMiddleware(onError, { type: \"error\" })\n    );\n  }\n\n  // POST /auth/update-password - Update password\n  {\n    const { before, after, onError, prismaArgs, routeConfig } =\n      op(\"updatePassword\");\n\n    router.post(\n      {\n        rateLimit: rateLimitConfig,\n        ...routeConfig,\n        path: \"/auth/update-password\",\n      },\n      addPrismaQueryOptionsToRequest<any>(\n        { updatePassword: prismaArgs } as AuthPrismaQueryOptions<any>,\n        \"updatePassword\"\n      ),\n      ...processMiddleware(before),\n      authController.updatePassword,\n      ...processMiddleware(after),\n      sendResponse,\n      ...processMiddleware(onError, {\n        type: \"error\",\n      })\n    );\n  }\n\n  // GET /auth-actions - Find many auth actions\n  {\n    const { before, after, onError, routeConfig } = op(\"findManyAuthAction\");\n\n    router.get(\n      {\n        ...routeConfig,\n        path: \"/auth-actions\",\n      },\n      ...processMiddleware(before),\n      authController.findManyAuthAction,\n      ...processMiddleware(after),\n      sendResponse,\n      ...processMiddleware(onError, {\n        type: \"error\",\n      })\n    );\n  }\n\n  // GET /auth-actions/:resourceName - Find one auth action\n  {\n    const { before, after, onError, routeConfig } = op(\"findOneAuthAction\");\n\n    router.get(\n      {\n        ...routeConfig,\n        path: \"/auth-actions/:resourceName\",\n      },\n      ...processMiddleware(before),\n      authController.findOneAuthAction,\n      ...processMiddleware(after),\n      sendResponse,\n      ...processMiddleware(onError, {\n        type: \"error\",\n      })\n    );\n  }\n\n  return router;\n}\n"]}

package/dist/cjs/modules/auth/utils/auth-openapi-generator.js

@@ -0,0 +1,372 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const auth_prisma_json_schema_generator_1 = __importDefault(require("./auth-prisma-json-schema-generator.js"));
+const arkos_config_helpers_1 = require("../../../utils/helpers/arkos-config.helpers.js");
+class AuthOpenAPIGenerator {
+    getOpenApiConfig(endpointRouterConfig = {}, endpoint) {
+        const existingOpenApi = endpointRouterConfig?.experimental?.openapi || {};
+        const hasBodyValidation = typeof endpointRouterConfig?.validation !== "boolean" &&
+            !!endpointRouterConfig?.validation?.body;
+        switch (endpoint) {
+            case "login":
+                return {
+                    ...existingOpenApi,
+                    tags: ["Authentication", ...(existingOpenApi?.tags || [])].filter((tag) => tag !== "Defaults"),
+                    summary: existingOpenApi?.summary || "Login to the system",
+                    description: existingOpenApi?.description ||
+                        "Authenticates a user and returns an access token",
+                    operationId: existingOpenApi?.operationId || "login",
+                    ...(!hasBodyValidation && {
+                        requestBody: existingOpenApi?.requestBody || {
+                            required: true,
+                            content: {
+                                "application/json": {
+                                    schema: auth_prisma_json_schema_generator_1.default.generateLoginSchema(),
+                                },
+                            },
+                        },
+                    }),
+                    responses: {
+                        ...(existingOpenApi?.responses || {}),
+                        "200": existingOpenApi?.responses?.["200"] || {
+                            description: "Login successful",
+                            content: {
+                                "application/json": {
+                                    schema: {
+                                        type: "object",
+                                        properties: {
+                                            accessToken: {
+                                                type: "string",
+                                                description: "JWT access token",
+                                            },
+                                        },
+                                    },
+                                },
+                            },
+                        },
+                        "400": existingOpenApi?.responses?.["400"] || {
+                            description: "Invalid input data",
+                        },
+                        "401": existingOpenApi?.responses?.["401"] || {
+                            description: "Invalid credentials",
+                        },
+                    },
+                };
+            case "logout":
+                return {
+                    ...existingOpenApi,
+                    tags: ["Authentication", ...(existingOpenApi?.tags || [])].filter((tag) => tag !== "Defaults"),
+                    summary: existingOpenApi?.summary || "Logout from the system",
+                    description: existingOpenApi?.description ||
+                        "Invalidates the current user's JWT token",
+                    operationId: existingOpenApi?.operationId || "logout",
+                    security: existingOpenApi?.security || [{ BearerAuth: [] }],
+                    responses: {
+                        ...(existingOpenApi?.responses || {}),
+                        "204": existingOpenApi?.responses?.["204"] || {
+                            description: "Logout successful",
+                        },
+                        "401": existingOpenApi?.responses?.["401"] || {
+                            description: "Authentication required",
+                        },
+                    },
+                };
+            case "signup":
+                return {
+                    ...existingOpenApi,
+                    tags: ["Authentication", ...(existingOpenApi?.tags || [])].filter((tag) => tag !== "Defaults"),
+                    summary: existingOpenApi?.summary || "Register a new user",
+                    description: existingOpenApi?.description || "Creates a new user account",
+                    operationId: existingOpenApi?.operationId || "signup",
+                    ...(!hasBodyValidation && {
+                        requestBody: existingOpenApi?.requestBody || {
+                            description: "User registration data",
+                            required: true,
+                            content: {
+                                "application/json": {
+                                    schema: auth_prisma_json_schema_generator_1.default.generateSignupSchema(),
+                                },
+                            },
+                        },
+                    }),
+                    responses: {
+                        ...(existingOpenApi?.responses || {}),
+                        "201": existingOpenApi?.responses?.["201"] || {
+                            description: "User created successfully",
+                            content: {
+                                "application/json": {
+                                    schema: auth_prisma_json_schema_generator_1.default.generateGetMeResponse(),
+                                },
+                            },
+                        },
+                        "400": existingOpenApi?.responses?.["400"] || {
+                            description: "Invalid input data",
+                        },
+                        "409": existingOpenApi?.responses?.["409"] || {
+                            description: "User already exists",
+                        },
+                    },
+                };
+            case "updatePassword":
+                return {
+                    ...existingOpenApi,
+                    tags: ["Authentication", ...(existingOpenApi?.tags || [])].filter((tag) => tag !== "Defaults"),
+                    summary: existingOpenApi?.summary || "Update user password",
+                    description: existingOpenApi?.description ||
+                        "Changes the password for the authenticated user",
+                    operationId: existingOpenApi?.operationId || "updatePassword",
+                    security: existingOpenApi?.security || [{ BearerAuth: [] }],
+                    ...(!hasBodyValidation && {
+                        requestBody: existingOpenApi?.requestBody || {
+                            required: true,
+                            content: {
+                                "application/json": {
+                                    schema: auth_prisma_json_schema_generator_1.default.generateUpdatePasswordSchema(),
+                                },
+                            },
+                        },
+                    }),
+                    responses: {
+                        ...(existingOpenApi?.responses || {}),
+                        "200": existingOpenApi?.responses?.["200"] || {
+                            description: "Password updated successfully",
+                            content: {
+                                "application/json": {
+                                    schema: {
+                                        type: "object",
+                                        properties: {
+                                            status: { type: "string", example: "success" },
+                                            message: {
+                                                type: "string",
+                                                example: "Password updated successfully!",
+                                            },
+                                        },
+                                    },
+                                },
+                            },
+                        },
+                        "400": existingOpenApi?.responses?.["400"] || {
+                            description: "Invalid input data or current password incorrect",
+                        },
+                        "401": existingOpenApi?.responses?.["401"] || {
+                            description: "Authentication required",
+                        },
+                    },
+                };
+            case "getMe":
+                return {
+                    ...existingOpenApi,
+                    tags: ["Authentication", ...(existingOpenApi?.tags || [])].filter((tag) => tag !== "Defaults"),
+                    summary: existingOpenApi?.summary || "Get current user information",
+                    description: existingOpenApi?.description ||
+                        "Retrieves information about the currently authenticated user",
+                    operationId: existingOpenApi?.operationId || "getMe",
+                    security: existingOpenApi?.security || [{ BearerAuth: [] }],
+                    responses: {
+                        ...(existingOpenApi?.responses || {}),
+                        "200": existingOpenApi?.responses?.["200"] || {
+                            description: "User information retrieved successfully",
+                            content: {
+                                "application/json": {
+                                    schema: auth_prisma_json_schema_generator_1.default.generateGetMeResponse(),
+                                },
+                            },
+                        },
+                        "401": existingOpenApi?.responses?.["401"] || {
+                            description: "Authentication required",
+                        },
+                    },
+                };
+            case "updateMe":
+                return {
+                    ...existingOpenApi,
+                    tags: ["Authentication", ...(existingOpenApi?.tags || [])].filter((tag) => tag !== "Defaults"),
+                    summary: existingOpenApi?.summary || "Update current user information",
+                    description: existingOpenApi?.description ||
+                        "Updates information for the currently authenticated user",
+                    operationId: existingOpenApi?.operationId || "updateMe",
+                    security: existingOpenApi?.security || [{ BearerAuth: [] }],
+                    ...(!hasBodyValidation && {
+                        requestBody: existingOpenApi?.requestBody || {
+                            description: "User data to update",
+                            required: true,
+                            content: {
+                                "application/json": {
+                                    schema: auth_prisma_json_schema_generator_1.default.generateUpdateMeSchema(),
+                                },
+                            },
+                        },
+                    }),
+                    responses: {
+                        ...(existingOpenApi?.responses || {}),
+                        "200": existingOpenApi?.responses?.["200"] || {
+                            description: "User updated successfully",
+                            content: {
+                                "application/json": {
+                                    schema: auth_prisma_json_schema_generator_1.default.generateGetMeResponse(),
+                                },
+                            },
+                        },
+                        "400": existingOpenApi?.responses?.["400"] || {
+                            description: "Invalid input data",
+                        },
+                        "401": existingOpenApi?.responses?.["401"] || {
+                            description: "Authentication required",
+                        },
+                    },
+                };
+            case "deleteMe":
+                return {
+                    ...existingOpenApi,
+                    tags: ["Authentication", ...(existingOpenApi?.tags || [])].filter((tag) => tag !== "Defaults"),
+                    summary: existingOpenApi?.summary || "Delete current user account",
+                    description: existingOpenApi?.description ||
+                        "Marks the current user's account as deleted",
+                    operationId: existingOpenApi?.operationId || "deleteMe",
+                    security: existingOpenApi?.security || [{ BearerAuth: [] }],
+                    responses: {
+                        ...(existingOpenApi?.responses || {}),
+                        "200": existingOpenApi?.responses?.["200"] || {
+                            description: "Account deleted successfully",
+                            content: {
+                                "application/json": {
+                                    schema: {
+                                        type: "object",
+                                        properties: {
+                                            message: {
+                                                type: "string",
+                                                example: "Account deleted successfully",
+                                            },
+                                        },
+                                    },
+                                },
+                            },
+                        },
+                        "401": existingOpenApi?.responses?.["401"] || {
+                            description: "Authentication required",
+                        },
+                    },
+                };
+            case "findManyAuthAction":
+                return {
+                    ...existingOpenApi,
+                    tags: ["Authentication", ...(existingOpenApi?.tags || [])].filter((tag) => tag !== "Defaults"),
+                    summary: existingOpenApi?.summary || "Get all authentication actions",
+                    description: existingOpenApi?.description ||
+                        "Retrieves a list of all available authentication actions and permissions",
+                    operationId: existingOpenApi?.operationId || "findManyAuthAction",
+                    security: existingOpenApi?.security || [{ BearerAuth: [] }],
+                    responses: {
+                        ...(existingOpenApi?.responses || {}),
+                        "200": existingOpenApi?.responses?.["200"] || {
+                            description: "Auth actions retrieved successfully",
+                            content: {
+                                "application/json": {
+                                    schema: this.getAuthActionSchema(),
+                                },
+                            },
+                        },
+                        "401": existingOpenApi?.responses?.["401"] || {
+                            description: "Authentication required",
+                        },
+                        "403": existingOpenApi?.responses?.["403"] || {
+                            description: "Insufficient permissions",
+                        },
+                    },
+                };
+            case "findOneAuthAction":
+                return {
+                    ...existingOpenApi,
+                    tags: ["Authentication", ...(existingOpenApi?.tags || [])].filter((tag) => tag !== "Defaults"),
+                    summary: existingOpenApi?.summary ||
+                        "Get authentication actions by resource",
+                    description: existingOpenApi?.description ||
+                        "Retrieves all authentication actions for a specific resource",
+                    operationId: existingOpenApi?.operationId || "findOneAuthAction",
+                    security: existingOpenApi?.security || [{ BearerAuth: [] }],
+                    parameters: [
+                        ...(existingOpenApi?.parameters || []),
+                        ...[
+                            {
+                                name: "resourceName",
+                                in: "path",
+                                required: true,
+                                schema: { type: "string" },
+                                description: "Name of the resource to retrieve auth actions for",
+                            },
+                        ].filter((p) => !(existingOpenApi?.parameters || []).find((ep) => ep.name === p.name && ep.in === p.in)),
+                    ],
+                    responses: {
+                        ...(existingOpenApi?.responses || {}),
+                        "200": existingOpenApi?.responses?.["200"] || {
+                            description: "Auth actions for resource retrieved successfully",
+                            content: {
+                                "application/json": {
+                                    schema: this.getAuthActionSchema(),
+                                },
+                            },
+                        },
+                        "401": existingOpenApi?.responses?.["401"] || {
+                            description: "Authentication required",
+                        },
+                        "403": existingOpenApi?.responses?.["403"] || {
+                            description: "Insufficient permissions",
+                        },
+                        "404": existingOpenApi?.responses?.["404"] || {
+                            description: "Resource not found",
+                        },
+                    },
+                };
+            default:
+                return {};
+        }
+    }
+    getAuthActionSchema() {
+        const arkosConfig = (0, arkos_config_helpers_1.getArkosConfig)();
+        const isDynamicMode = arkosConfig?.authentication?.mode === "dynamic";
+        const properties = {
+            action: {
+                type: "string",
+                description: "Action name, e.g Create, View, Update, Download, Cancel",
+            },
+            resource: {
+                type: "string",
+                description: "Resource name, e.g user, user-role, product, author",
+            },
+            name: {
+                type: "string",
+                description: "Human-readable name for this permission",
+                nullable: true,
+            },
+            description: {
+                type: "string",
+                description: "Detailed description of what this permission allows",
+                nullable: true,
+            },
+            errorMessage: {
+                type: "string",
+                description: "Error message returned on forbidden response",
+                nullable: true,
+            },
+        };
+        if (!isDynamicMode) {
+            properties.roles = {
+                type: "array",
+                description: "Role names that have this permission, e.g Admin, Manager",
+                items: { type: "string" },
+            };
+        }
+        return {
+            type: "object",
+            properties,
+            required: ["action", "resource"],
+            additionalProperties: false,
+        };
+    }
+}
+const authOpenAPIGenerator = new AuthOpenAPIGenerator();
+exports.default = authOpenAPIGenerator;
+//# sourceMappingURL=auth-openapi-generator.js.map

package/dist/cjs/modules/auth/utils/auth-openapi-generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth-openapi-generator.js","sourceRoot":"","sources":["../../../../../src/modules/auth/utils/auth-openapi-generator.ts"],"names":[],"mappings":";;;;;AAIA,4GAAgF;AAChF,sFAA6E;AAE7E,MAAM,oBAAoB;IACxB,gBAAgB,CACd,uBAAuD,EAAE,EACzD,QAA4B;QAE5B,MAAM,eAAe,GAAG,oBAAoB,EAAE,YAAY,EAAE,OAAO,IAAI,EAAE,CAAC;QAC1E,MAAM,iBAAiB,GACrB,OAAO,oBAAoB,EAAE,UAAU,KAAK,SAAS;YACrD,CAAC,CAAC,oBAAoB,EAAE,UAAU,EAAE,IAAI,CAAC;QAE3C,QAAQ,QAAQ,EAAE,CAAC;YACjB,KAAK,OAAO;gBACV,OAAO;oBACL,GAAG,eAAe;oBAClB,IAAI,EAAE,CAAC,gBAAgB,EAAE,GAAG,CAAC,eAAe,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,MAAM,CAC/D,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,UAAU,CAC5B;oBACD,OAAO,EAAE,eAAe,EAAE,OAAO,IAAI,qBAAqB;oBAC1D,WAAW,EACT,eAAe,EAAE,WAAW;wBAC5B,kDAAkD;oBACpD,WAAW,EAAE,eAAe,EAAE,WAAW,IAAI,OAAO;oBACpD,GAAG,CAAC,CAAC,iBAAiB,IAAI;wBACxB,WAAW,EAAE,eAAe,EAAE,WAAW,IAAI;4BAC3C,QAAQ,EAAE,IAAI;4BACd,OAAO,EAAE;gCACP,kBAAkB,EAAE;oCAClB,MAAM,EAAE,2CAA6B,CAAC,mBAAmB,EAAE;iCAC5D;6BACF;yBACF;qBACF,CAAC;oBACF,SAAS,EAAE;wBACT,GAAG,CAAC,eAAe,EAAE,SAAS,IAAI,EAAE,CAAC;wBACrC,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC,KAAK,CAAC,IAAI;4BAC5C,WAAW,EAAE,kBAAkB;4BAC/B,OAAO,EAAE;gCACP,kBAAkB,EAAE;oCAClB,MAAM,EAAE;wCACN,IAAI,EAAE,QAAQ;wCACd,UAAU,EAAE;4CACV,WAAW,EAAE;gDACX,IAAI,EAAE,QAAQ;gDACd,WAAW,EAAE,kBAAkB;6CAChC;yCACF;qCACF;iCACF;6BACF;yBACF;wBACD,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC,KAAK,CAAC,IAAI;4BAC5C,WAAW,EAAE,oBAAoB;yBAClC;wBACD,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC,KAAK,CAAC,IAAI;4BAC5C,WAAW,EAAE,qBAAqB;yBACnC;qBACF;iBACF,CAAC;YAEJ,KAAK,QAAQ;gBACX,OAAO;oBACL,GAAG,eAAe;oBAClB,IAAI,EAAE,CAAC,gBAAgB,EAAE,GAAG,CAAC,eAAe,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,MAAM,CAC/D,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,UAAU,CAC5B;oBACD,OAAO,EAAE,eAAe,EAAE,OAAO,IAAI,wBAAwB;oBAC7D,WAAW,EACT,eAAe,EAAE,WAAW;wBAC5B,0CAA0C;oBAC5C,WAAW,EAAE,eAAe,EAAE,WAAW,IAAI,QAAQ;oBACrD,QAAQ,EAAE,eAAe,EAAE,QAAQ,IAAI,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;oBAC3D,SAAS,EAAE;wBACT,GAAG,CAAC,eAAe,EAAE,SAAS,IAAI,EAAE,CAAC;wBACrC,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC,KAAK,CAAC,IAAI;4BAC5C,WAAW,EAAE,mBAAmB;yBACjC;wBACD,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC,KAAK,CAAC,IAAI;4BAC5C,WAAW,EAAE,yBAAyB;yBACvC;qBACF;iBACF,CAAC;YAEJ,KAAK,QAAQ;gBACX,OAAO;oBACL,GAAG,eAAe;oBAClB,IAAI,EAAE,CAAC,gBAAgB,EAAE,GAAG,CAAC,eAAe,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,MAAM,CAC/D,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,UAAU,CAC5B;oBACD,OAAO,EAAE,eAAe,EAAE,OAAO,IAAI,qBAAqB;oBAC1D,WAAW,EACT,eAAe,EAAE,WAAW,IAAI,4BAA4B;oBAC9D,WAAW,EAAE,eAAe,EAAE,WAAW,IAAI,QAAQ;oBACrD,GAAG,CAAC,CAAC,iBAAiB,IAAI;wBACxB,WAAW,EAAE,eAAe,EAAE,WAAW,IAAI;4BAC3C,WAAW,EAAE,wBAAwB;4BACrC,QAAQ,EAAE,IAAI;4BACd,OAAO,EAAE;gCACP,kBAAkB,EAAE;oCAClB,MAAM,EAAE,2CAA6B,CAAC,oBAAoB,EAAE;iCAC7D;6BACF;yBACF;qBACF,CAAC;oBACF,SAAS,EAAE;wBACT,GAAG,CAAC,eAAe,EAAE,SAAS,IAAI,EAAE,CAAC;wBACrC,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC,KAAK,CAAC,IAAI;4BAC5C,WAAW,EAAE,2BAA2B;4BACxC,OAAO,EAAE;gCACP,kBAAkB,EAAE;oCAClB,MAAM,EAAE,2CAA6B,CAAC,qBAAqB,EAAE;iCAC9D;6BACF;yBACF;wBACD,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC,KAAK,CAAC,IAAI;4BAC5C,WAAW,EAAE,oBAAoB;yBAClC;wBACD,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC,KAAK,CAAC,IAAI;4BAC5C,WAAW,EAAE,qBAAqB;yBACnC;qBACF;iBACF,CAAC;YAEJ,KAAK,gBAAgB;gBACnB,OAAO;oBACL,GAAG,eAAe;oBAClB,IAAI,EAAE,CAAC,gBAAgB,EAAE,GAAG,CAAC,eAAe,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,MAAM,CAC/D,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,UAAU,CAC5B;oBACD,OAAO,EAAE,eAAe,EAAE,OAAO,IAAI,sBAAsB;oBAC3D,WAAW,EACT,eAAe,EAAE,WAAW;wBAC5B,iDAAiD;oBACnD,WAAW,EAAE,eAAe,EAAE,WAAW,IAAI,gBAAgB;oBAC7D,QAAQ,EAAE,eAAe,EAAE,QAAQ,IAAI,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;oBAC3D,GAAG,CAAC,CAAC,iBAAiB,IAAI;wBACxB,WAAW,EAAE,eAAe,EAAE,WAAW,IAAI;4BAC3C,QAAQ,EAAE,IAAI;4BACd,OAAO,EAAE;gCACP,kBAAkB,EAAE;oCAClB,MAAM,EACJ,2CAA6B,CAAC,4BAA4B,EAAE;iCAC/D;6BACF;yBACF;qBACF,CAAC;oBACF,SAAS,EAAE;wBACT,GAAG,CAAC,eAAe,EAAE,SAAS,IAAI,EAAE,CAAC;wBACrC,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC,KAAK,CAAC,IAAI;4BAC5C,WAAW,EAAE,+BAA+B;4BAC5C,OAAO,EAAE;gCACP,kBAAkB,EAAE;oCAClB,MAAM,EAAE;wCACN,IAAI,EAAE,QAAQ;wCACd,UAAU,EAAE;4CACV,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE;4CAC9C,OAAO,EAAE;gDACP,IAAI,EAAE,QAAQ;gDACd,OAAO,EAAE,gCAAgC;6CAC1C;yCACF;qCACF;iCACF;6BACF;yBACF;wBACD,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC,KAAK,CAAC,IAAI;4BAC5C,WAAW,EAAE,kDAAkD;yBAChE;wBACD,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC,KAAK,CAAC,IAAI;4BAC5C,WAAW,EAAE,yBAAyB;yBACvC;qBACF;iBACF,CAAC;YAEJ,KAAK,OAAO;gBACV,OAAO;oBACL,GAAG,eAAe;oBAClB,IAAI,EAAE,CAAC,gBAAgB,EAAE,GAAG,CAAC,eAAe,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,MAAM,CAC/D,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,UAAU,CAC5B;oBACD,OAAO,EAAE,eAAe,EAAE,OAAO,IAAI,8BAA8B;oBACnE,WAAW,EACT,eAAe,EAAE,WAAW;wBAC5B,8DAA8D;oBAChE,WAAW,EAAE,eAAe,EAAE,WAAW,IAAI,OAAO;oBACpD,QAAQ,EAAE,eAAe,EAAE,QAAQ,IAAI,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;oBAC3D,SAAS,EAAE;wBACT,GAAG,CAAC,eAAe,EAAE,SAAS,IAAI,EAAE,CAAC;wBACrC,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC,KAAK,CAAC,IAAI;4BAC5C,WAAW,EAAE,yCAAyC;4BACtD,OAAO,EAAE;gCACP,kBAAkB,EAAE;oCAClB,MAAM,EAAE,2CAA6B,CAAC,qBAAqB,EAAE;iCAC9D;6BACF;yBACF;wBACD,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC,KAAK,CAAC,IAAI;4BAC5C,WAAW,EAAE,yBAAyB;yBACvC;qBACF;iBACF,CAAC;YAEJ,KAAK,UAAU;gBACb,OAAO;oBACL,GAAG,eAAe;oBAClB,IAAI,EAAE,CAAC,gBAAgB,EAAE,GAAG,CAAC,eAAe,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,MAAM,CAC/D,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,UAAU,CAC5B;oBACD,OAAO,EACL,eAAe,EAAE,OAAO,IAAI,iCAAiC;oBAC/D,WAAW,EACT,eAAe,EAAE,WAAW;wBAC5B,0DAA0D;oBAC5D,WAAW,EAAE,eAAe,EAAE,WAAW,IAAI,UAAU;oBACvD,QAAQ,EAAE,eAAe,EAAE,QAAQ,IAAI,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;oBAC3D,GAAG,CAAC,CAAC,iBAAiB,IAAI;wBACxB,WAAW,EAAE,eAAe,EAAE,WAAW,IAAI;4BAC3C,WAAW,EAAE,qBAAqB;4BAClC,QAAQ,EAAE,IAAI;4BACd,OAAO,EAAE;gCACP,kBAAkB,EAAE;oCAClB,MAAM,EACJ,2CAA6B,CAAC,sBAAsB,EAAE;iCACzD;6BACF;yBACF;qBACF,CAAC;oBACF,SAAS,EAAE;wBACT,GAAG,CAAC,eAAe,EAAE,SAAS,IAAI,EAAE,CAAC;wBACrC,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC,KAAK,CAAC,IAAI;4BAC5C,WAAW,EAAE,2BAA2B;4BACxC,OAAO,EAAE;gCACP,kBAAkB,EAAE;oCAClB,MAAM,EAAE,2CAA6B,CAAC,qBAAqB,EAAE;iCAC9D;6BACF;yBACF;wBACD,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC,KAAK,CAAC,IAAI;4BAC5C,WAAW,EAAE,oBAAoB;yBAClC;wBACD,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC,KAAK,CAAC,IAAI;4BAC5C,WAAW,EAAE,yBAAyB;yBACvC;qBACF;iBACF,CAAC;YAEJ,KAAK,UAAU;gBACb,OAAO;oBACL,GAAG,eAAe;oBAClB,IAAI,EAAE,CAAC,gBAAgB,EAAE,GAAG,CAAC,eAAe,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,MAAM,CAC/D,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,UAAU,CAC5B;oBACD,OAAO,EAAE,eAAe,EAAE,OAAO,IAAI,6BAA6B;oBAClE,WAAW,EACT,eAAe,EAAE,WAAW;wBAC5B,6CAA6C;oBAC/C,WAAW,EAAE,eAAe,EAAE,WAAW,IAAI,UAAU;oBACvD,QAAQ,EAAE,eAAe,EAAE,QAAQ,IAAI,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;oBAC3D,SAAS,EAAE;wBACT,GAAG,CAAC,eAAe,EAAE,SAAS,IAAI,EAAE,CAAC;wBACrC,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC,KAAK,CAAC,IAAI;4BAC5C,WAAW,EAAE,8BAA8B;4BAC3C,OAAO,EAAE;gCACP,kBAAkB,EAAE;oCAClB,MAAM,EAAE;wCACN,IAAI,EAAE,QAAQ;wCACd,UAAU,EAAE;4CACV,OAAO,EAAE;gDACP,IAAI,EAAE,QAAQ;gDACd,OAAO,EAAE,8BAA8B;6CACxC;yCACF;qCACF;iCACF;6BACF;yBACF;wBACD,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC,KAAK,CAAC,IAAI;4BAC5C,WAAW,EAAE,yBAAyB;yBACvC;qBACF;iBACF,CAAC;YAEJ,KAAK,oBAAoB;gBACvB,OAAO;oBACL,GAAG,eAAe;oBAClB,IAAI,EAAE,CAAC,gBAAgB,EAAE,GAAG,CAAC,eAAe,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,MAAM,CAC/D,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,UAAU,CAC5B;oBACD,OAAO,EAAE,eAAe,EAAE,OAAO,IAAI,gCAAgC;oBACrE,WAAW,EACT,eAAe,EAAE,WAAW;wBAC5B,0EAA0E;oBAC5E,WAAW,EAAE,eAAe,EAAE,WAAW,IAAI,oBAAoB;oBACjE,QAAQ,EAAE,eAAe,EAAE,QAAQ,IAAI,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;oBAC3D,SAAS,EAAE;wBACT,GAAG,CAAC,eAAe,EAAE,SAAS,IAAI,EAAE,CAAC;wBACrC,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC,KAAK,CAAC,IAAI;4BAC5C,WAAW,EAAE,qCAAqC;4BAClD,OAAO,EAAE;gCACP,kBAAkB,EAAE;oCAClB,MAAM,EAAE,IAAI,CAAC,mBAAmB,EAAE;iCACnC;6BACF;yBACF;wBACD,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC,KAAK,CAAC,IAAI;4BAC5C,WAAW,EAAE,yBAAyB;yBACvC;wBACD,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC,KAAK,CAAC,IAAI;4BAC5C,WAAW,EAAE,0BAA0B;yBACxC;qBACF;iBACF,CAAC;YAEJ,KAAK,mBAAmB;gBACtB,OAAO;oBACL,GAAG,eAAe;oBAClB,IAAI,EAAE,CAAC,gBAAgB,EAAE,GAAG,CAAC,eAAe,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,MAAM,CAC/D,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,UAAU,CAC5B;oBACD,OAAO,EACL,eAAe,EAAE,OAAO;wBACxB,wCAAwC;oBAC1C,WAAW,EACT,eAAe,EAAE,WAAW;wBAC5B,8DAA8D;oBAChE,WAAW,EAAE,eAAe,EAAE,WAAW,IAAI,mBAAmB;oBAChE,QAAQ,EAAE,eAAe,EAAE,QAAQ,IAAI,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;oBAC3D,UAAU,EAAE;wBACV,GAAG,CAAC,eAAe,EAAE,UAAU,IAAI,EAAE,CAAC;wBACtC,GACE;4BACE;gCACE,IAAI,EAAE,cAAc;gCACpB,EAAE,EAAE,MAAM;gCACV,QAAQ,EAAE,IAAI;gCACd,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gCAC1B,WAAW,EACT,mDAAmD;6BACtD;yBAEJ,CAAC,MAAM,CACN,CAAC,CAAC,EAAE,EAAE,CACJ,CAAC,CAAC,eAAe,EAAE,UAAU,IAAI,EAAE,CAAC,CAAC,IAAI,CACvC,CAAC,EAAO,EAAE,EAAE,CAAC,EAAE,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE,CAClD,CACJ;qBACF;oBACD,SAAS,EAAE;wBACT,GAAG,CAAC,eAAe,EAAE,SAAS,IAAI,EAAE,CAAC;wBACrC,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC,KAAK,CAAC,IAAI;4BAC5C,WAAW,EAAE,kDAAkD;4BAC/D,OAAO,EAAE;gCACP,kBAAkB,EAAE;oCAClB,MAAM,EAAE,IAAI,CAAC,mBAAmB,EAAE;iCACnC;6BACF;yBACF;wBACD,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC,KAAK,CAAC,IAAI;4BAC5C,WAAW,EAAE,yBAAyB;yBACvC;wBACD,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC,KAAK,CAAC,IAAI;4BAC5C,WAAW,EAAE,0BAA0B;yBACxC;wBACD,KAAK,EAAE,eAAe,EAAE,SAAS,EAAE,CAAC,KAAK,CAAC,IAAI;4BAC5C,WAAW,EAAE,oBAAoB;yBAClC;qBACF;iBACF,CAAC;YAEJ;gBACE,OAAO,EAAE,CAAC;QACd,CAAC;IACH,CAAC;IAEO,mBAAmB;QACzB,MAAM,WAAW,GAAG,IAAA,qCAAc,GAAE,CAAC;QACrC,MAAM,aAAa,GAAG,WAAW,EAAE,cAAc,EAAE,IAAI,KAAK,SAAS,CAAC;QAEtE,MAAM,UAAU,GAAwB;YACtC,MAAM,EAAE;gBACN,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,yDAAyD;aACvE;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,qDAAqD;aACnE;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,yCAAyC;gBACtD,QAAQ,EAAE,IAAI;aACf;YACD,WAAW,EAAE;gBACX,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,qDAAqD;gBAClE,QAAQ,EAAE,IAAI;aACf;YACD,YAAY,EAAE;gBACZ,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,8CAA8C;gBAC3D,QAAQ,EAAE,IAAI;aACf;SACF,CAAC;QAEF,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,UAAU,CAAC,KAAK,GAAG;gBACjB,IAAI,EAAE,OAAO;gBACb,WAAW,EAAE,0DAA0D;gBACvE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;aAC1B,CAAC;QACJ,CAAC;QAED,OAAO;YACL,IAAI,EAAE,QAAQ;YACd,UAAU;YACV,QAAQ,EAAE,CAAC,QAAQ,EAAE,UAAU,CAAC;YAChC,oBAAoB,EAAE,KAAK;SAC5B,CAAC;IACJ,CAAC;CACF;AAED,MAAM,oBAAoB,GAAG,IAAI,oBAAoB,EAAE,CAAC;AAExD,kBAAe,oBAAoB,CAAC","sourcesContent":["import { AuthRouterEndpoint } from \"../../../types/router-config\";\nimport { ArkosRouteConfig } from \"../../../exports\";\nimport { ExtendedOperationObject } from \"../../../utils/arkos-router/types/openapi-config\";\nimport { OpenAPIV3 } from \"openapi-types\";\nimport authPrismaJsonSchemaGenerator from \"./auth-prisma-json-schema-generator\";\nimport { getArkosConfig } from \"../../../utils/helpers/arkos-config.helpers\";\n\nclass AuthOpenAPIGenerator {\n  getOpenApiConfig(\n    endpointRouterConfig: Omit<ArkosRouteConfig, \"path\"> = {},\n    endpoint: AuthRouterEndpoint\n  ): Partial<ExtendedOperationObject> {\n    const existingOpenApi = endpointRouterConfig?.experimental?.openapi || {};\n    const hasBodyValidation =\n      typeof endpointRouterConfig?.validation !== \"boolean\" &&\n      !!endpointRouterConfig?.validation?.body;\n\n    switch (endpoint) {\n      case \"login\":\n        return {\n          ...existingOpenApi,\n          tags: [\"Authentication\", ...(existingOpenApi?.tags || [])].filter(\n            (tag) => tag !== \"Defaults\"\n          ),\n          summary: existingOpenApi?.summary || \"Login to the system\",\n          description:\n            existingOpenApi?.description ||\n            \"Authenticates a user and returns an access token\",\n          operationId: existingOpenApi?.operationId || \"login\",\n          ...(!hasBodyValidation && {\n            requestBody: existingOpenApi?.requestBody || {\n              required: true,\n              content: {\n                \"application/json\": {\n                  schema: authPrismaJsonSchemaGenerator.generateLoginSchema(),\n                },\n              },\n            },\n          }),\n          responses: {\n            ...(existingOpenApi?.responses || {}),\n            \"200\": existingOpenApi?.responses?.[\"200\"] || {\n              description: \"Login successful\",\n              content: {\n                \"application/json\": {\n                  schema: {\n                    type: \"object\",\n                    properties: {\n                      accessToken: {\n                        type: \"string\",\n                        description: \"JWT access token\",\n                      },\n                    },\n                  },\n                },\n              },\n            },\n            \"400\": existingOpenApi?.responses?.[\"400\"] || {\n              description: \"Invalid input data\",\n            },\n            \"401\": existingOpenApi?.responses?.[\"401\"] || {\n              description: \"Invalid credentials\",\n            },\n          },\n        };\n\n      case \"logout\":\n        return {\n          ...existingOpenApi,\n          tags: [\"Authentication\", ...(existingOpenApi?.tags || [])].filter(\n            (tag) => tag !== \"Defaults\"\n          ),\n          summary: existingOpenApi?.summary || \"Logout from the system\",\n          description:\n            existingOpenApi?.description ||\n            \"Invalidates the current user's JWT token\",\n          operationId: existingOpenApi?.operationId || \"logout\",\n          security: existingOpenApi?.security || [{ BearerAuth: [] }],\n          responses: {\n            ...(existingOpenApi?.responses || {}),\n            \"204\": existingOpenApi?.responses?.[\"204\"] || {\n              description: \"Logout successful\",\n            },\n            \"401\": existingOpenApi?.responses?.[\"401\"] || {\n              description: \"Authentication required\",\n            },\n          },\n        };\n\n      case \"signup\":\n        return {\n          ...existingOpenApi,\n          tags: [\"Authentication\", ...(existingOpenApi?.tags || [])].filter(\n            (tag) => tag !== \"Defaults\"\n          ),\n          summary: existingOpenApi?.summary || \"Register a new user\",\n          description:\n            existingOpenApi?.description || \"Creates a new user account\",\n          operationId: existingOpenApi?.operationId || \"signup\",\n          ...(!hasBodyValidation && {\n            requestBody: existingOpenApi?.requestBody || {\n              description: \"User registration data\",\n              required: true,\n              content: {\n                \"application/json\": {\n                  schema: authPrismaJsonSchemaGenerator.generateSignupSchema(),\n                },\n              },\n            },\n          }),\n          responses: {\n            ...(existingOpenApi?.responses || {}),\n            \"201\": existingOpenApi?.responses?.[\"201\"] || {\n              description: \"User created successfully\",\n              content: {\n                \"application/json\": {\n                  schema: authPrismaJsonSchemaGenerator.generateGetMeResponse(),\n                },\n              },\n            },\n            \"400\": existingOpenApi?.responses?.[\"400\"] || {\n              description: \"Invalid input data\",\n            },\n            \"409\": existingOpenApi?.responses?.[\"409\"] || {\n              description: \"User already exists\",\n            },\n          },\n        };\n\n      case \"updatePassword\":\n        return {\n          ...existingOpenApi,\n          tags: [\"Authentication\", ...(existingOpenApi?.tags || [])].filter(\n            (tag) => tag !== \"Defaults\"\n          ),\n          summary: existingOpenApi?.summary || \"Update user password\",\n          description:\n            existingOpenApi?.description ||\n            \"Changes the password for the authenticated user\",\n          operationId: existingOpenApi?.operationId || \"updatePassword\",\n          security: existingOpenApi?.security || [{ BearerAuth: [] }],\n          ...(!hasBodyValidation && {\n            requestBody: existingOpenApi?.requestBody || {\n              required: true,\n              content: {\n                \"application/json\": {\n                  schema:\n                    authPrismaJsonSchemaGenerator.generateUpdatePasswordSchema(),\n                },\n              },\n            },\n          }),\n          responses: {\n            ...(existingOpenApi?.responses || {}),\n            \"200\": existingOpenApi?.responses?.[\"200\"] || {\n              description: \"Password updated successfully\",\n              content: {\n                \"application/json\": {\n                  schema: {\n                    type: \"object\",\n                    properties: {\n                      status: { type: \"string\", example: \"success\" },\n                      message: {\n                        type: \"string\",\n                        example: \"Password updated successfully!\",\n                      },\n                    },\n                  },\n                },\n              },\n            },\n            \"400\": existingOpenApi?.responses?.[\"400\"] || {\n              description: \"Invalid input data or current password incorrect\",\n            },\n            \"401\": existingOpenApi?.responses?.[\"401\"] || {\n              description: \"Authentication required\",\n            },\n          },\n        };\n\n      case \"getMe\":\n        return {\n          ...existingOpenApi,\n          tags: [\"Authentication\", ...(existingOpenApi?.tags || [])].filter(\n            (tag) => tag !== \"Defaults\"\n          ),\n          summary: existingOpenApi?.summary || \"Get current user information\",\n          description:\n            existingOpenApi?.description ||\n            \"Retrieves information about the currently authenticated user\",\n          operationId: existingOpenApi?.operationId || \"getMe\",\n          security: existingOpenApi?.security || [{ BearerAuth: [] }],\n          responses: {\n            ...(existingOpenApi?.responses || {}),\n            \"200\": existingOpenApi?.responses?.[\"200\"] || {\n              description: \"User information retrieved successfully\",\n              content: {\n                \"application/json\": {\n                  schema: authPrismaJsonSchemaGenerator.generateGetMeResponse(),\n                },\n              },\n            },\n            \"401\": existingOpenApi?.responses?.[\"401\"] || {\n              description: \"Authentication required\",\n            },\n          },\n        };\n\n      case \"updateMe\":\n        return {\n          ...existingOpenApi,\n          tags: [\"Authentication\", ...(existingOpenApi?.tags || [])].filter(\n            (tag) => tag !== \"Defaults\"\n          ),\n          summary:\n            existingOpenApi?.summary || \"Update current user information\",\n          description:\n            existingOpenApi?.description ||\n            \"Updates information for the currently authenticated user\",\n          operationId: existingOpenApi?.operationId || \"updateMe\",\n          security: existingOpenApi?.security || [{ BearerAuth: [] }],\n          ...(!hasBodyValidation && {\n            requestBody: existingOpenApi?.requestBody || {\n              description: \"User data to update\",\n              required: true,\n              content: {\n                \"application/json\": {\n                  schema:\n                    authPrismaJsonSchemaGenerator.generateUpdateMeSchema(),\n                },\n              },\n            },\n          }),\n          responses: {\n            ...(existingOpenApi?.responses || {}),\n            \"200\": existingOpenApi?.responses?.[\"200\"] || {\n              description: \"User updated successfully\",\n              content: {\n                \"application/json\": {\n                  schema: authPrismaJsonSchemaGenerator.generateGetMeResponse(),\n                },\n              },\n            },\n            \"400\": existingOpenApi?.responses?.[\"400\"] || {\n              description: \"Invalid input data\",\n            },\n            \"401\": existingOpenApi?.responses?.[\"401\"] || {\n              description: \"Authentication required\",\n            },\n          },\n        };\n\n      case \"deleteMe\":\n        return {\n          ...existingOpenApi,\n          tags: [\"Authentication\", ...(existingOpenApi?.tags || [])].filter(\n            (tag) => tag !== \"Defaults\"\n          ),\n          summary: existingOpenApi?.summary || \"Delete current user account\",\n          description:\n            existingOpenApi?.description ||\n            \"Marks the current user's account as deleted\",\n          operationId: existingOpenApi?.operationId || \"deleteMe\",\n          security: existingOpenApi?.security || [{ BearerAuth: [] }],\n          responses: {\n            ...(existingOpenApi?.responses || {}),\n            \"200\": existingOpenApi?.responses?.[\"200\"] || {\n              description: \"Account deleted successfully\",\n              content: {\n                \"application/json\": {\n                  schema: {\n                    type: \"object\",\n                    properties: {\n                      message: {\n                        type: \"string\",\n                        example: \"Account deleted successfully\",\n                      },\n                    },\n                  },\n                },\n              },\n            },\n            \"401\": existingOpenApi?.responses?.[\"401\"] || {\n              description: \"Authentication required\",\n            },\n          },\n        };\n\n      case \"findManyAuthAction\":\n        return {\n          ...existingOpenApi,\n          tags: [\"Authentication\", ...(existingOpenApi?.tags || [])].filter(\n            (tag) => tag !== \"Defaults\"\n          ),\n          summary: existingOpenApi?.summary || \"Get all authentication actions\",\n          description:\n            existingOpenApi?.description ||\n            \"Retrieves a list of all available authentication actions and permissions\",\n          operationId: existingOpenApi?.operationId || \"findManyAuthAction\",\n          security: existingOpenApi?.security || [{ BearerAuth: [] }],\n          responses: {\n            ...(existingOpenApi?.responses || {}),\n            \"200\": existingOpenApi?.responses?.[\"200\"] || {\n              description: \"Auth actions retrieved successfully\",\n              content: {\n                \"application/json\": {\n                  schema: this.getAuthActionSchema(),\n                },\n              },\n            },\n            \"401\": existingOpenApi?.responses?.[\"401\"] || {\n              description: \"Authentication required\",\n            },\n            \"403\": existingOpenApi?.responses?.[\"403\"] || {\n              description: \"Insufficient permissions\",\n            },\n          },\n        };\n\n      case \"findOneAuthAction\":\n        return {\n          ...existingOpenApi,\n          tags: [\"Authentication\", ...(existingOpenApi?.tags || [])].filter(\n            (tag) => tag !== \"Defaults\"\n          ),\n          summary:\n            existingOpenApi?.summary ||\n            \"Get authentication actions by resource\",\n          description:\n            existingOpenApi?.description ||\n            \"Retrieves all authentication actions for a specific resource\",\n          operationId: existingOpenApi?.operationId || \"findOneAuthAction\",\n          security: existingOpenApi?.security || [{ BearerAuth: [] }],\n          parameters: [\n            ...(existingOpenApi?.parameters || []),\n            ...(\n              [\n                {\n                  name: \"resourceName\",\n                  in: \"path\",\n                  required: true,\n                  schema: { type: \"string\" },\n                  description:\n                    \"Name of the resource to retrieve auth actions for\",\n                },\n              ] as OpenAPIV3.ParameterObject[]\n            ).filter(\n              (p) =>\n                !(existingOpenApi?.parameters || []).find(\n                  (ep: any) => ep.name === p.name && ep.in === p.in\n                )\n            ),\n          ],\n          responses: {\n            ...(existingOpenApi?.responses || {}),\n            \"200\": existingOpenApi?.responses?.[\"200\"] || {\n              description: \"Auth actions for resource retrieved successfully\",\n              content: {\n                \"application/json\": {\n                  schema: this.getAuthActionSchema(),\n                },\n              },\n            },\n            \"401\": existingOpenApi?.responses?.[\"401\"] || {\n              description: \"Authentication required\",\n            },\n            \"403\": existingOpenApi?.responses?.[\"403\"] || {\n              description: \"Insufficient permissions\",\n            },\n            \"404\": existingOpenApi?.responses?.[\"404\"] || {\n              description: \"Resource not found\",\n            },\n          },\n        };\n\n      default:\n        return {};\n    }\n  }\n\n  private getAuthActionSchema() {\n    const arkosConfig = getArkosConfig();\n    const isDynamicMode = arkosConfig?.authentication?.mode === \"dynamic\";\n\n    const properties: Record<string, any> = {\n      action: {\n        type: \"string\",\n        description: \"Action name, e.g Create, View, Update, Download, Cancel\",\n      },\n      resource: {\n        type: \"string\",\n        description: \"Resource name, e.g user, user-role, product, author\",\n      },\n      name: {\n        type: \"string\",\n        description: \"Human-readable name for this permission\",\n        nullable: true,\n      },\n      description: {\n        type: \"string\",\n        description: \"Detailed description of what this permission allows\",\n        nullable: true,\n      },\n      errorMessage: {\n        type: \"string\",\n        description: \"Error message returned on forbidden response\",\n        nullable: true,\n      },\n    };\n\n    if (!isDynamicMode) {\n      properties.roles = {\n        type: \"array\",\n        description: \"Role names that have this permission, e.g Admin, Manager\",\n        items: { type: \"string\" },\n      };\n    }\n\n    return {\n      type: \"object\",\n      properties,\n      required: [\"action\", \"resource\"],\n      additionalProperties: false,\n    };\n  }\n}\n\nconst authOpenAPIGenerator = new AuthOpenAPIGenerator();\n\nexport default authOpenAPIGenerator;\n"]}

package/dist/cjs/modules/auth/utils/auth-prisma-json-schema-generator.js

@@ -0,0 +1,101 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const arkos_config_helpers_1 = require("../../../utils/helpers/arkos-config.helpers.js");
+const prisma_1 = require("../../../exports/prisma/index.js");
+const prisma_json_schema_generator_1 = __importDefault(require("../../../utils/prisma/prisma-json-schema-generator.js"));
+const reader_1 = require("../../../components/arkos-route-hook/reader.js");
+class AuthPrismaJsonSchemaGenerator {
+    getUserModel() {
+        if (!this.userModel)
+            this.userModel = prisma_1.prismaSchemaParser.models.find((m) => m.name.toLowerCase() === "user");
+        return this.userModel;
+    }
+    getPrismaArgs(endpoint) {
+        return reader_1.routeHookReader.getPrismaArgs("auth", endpoint) || {};
+    }
+    generateGetMeResponse() {
+        return prisma_json_schema_generator_1.default.generateResponseSchema(this.getUserModel(), this.getPrismaArgs("getMe"));
+    }
+    generateUpdatePasswordSchema() {
+        return {
+            type: "object",
+            properties: {
+                currentPassword: { type: "string" },
+                newPassword: { type: "string", minLength: 8 },
+            },
+            required: ["currentPassword", "newPassword"],
+        };
+    }
+    generateUpdateMeSchema() {
+        const updateSchema = prisma_json_schema_generator_1.default.generateUpdateSchema(this.getUserModel());
+        const restrictedFields = [
+            "roles",
+            "role",
+            "isActive",
+            "isStaff",
+            "isSuperUser",
+            "passwordChangedAt",
+            "deletedSelfAccountAt",
+            "password",
+            "lastLoginAt",
+        ];
+        restrictedFields.forEach((field) => {
+            delete updateSchema?.properties?.[field];
+        });
+        return updateSchema;
+    }
+    generateSignupSchema() {
+        const singupSchema = prisma_json_schema_generator_1.default.generateCreateSchema(this.getUserModel());
+        const restrictedFields = [
+            "roles",
+            "role",
+            "isActive",
+            "isStaff",
+            "isSuperUser",
+            "passwordChangedAt",
+            "deletedSelfAccountAt",
+            "lastLoginAt",
+        ];
+        restrictedFields.forEach((field) => {
+            delete singupSchema?.properties?.[field];
+        });
+        return singupSchema;
+    }
+    generateLoginSchema() {
+        const allowedUsernames = (0, arkos_config_helpers_1.getArkosConfig)()?.authentication?.login
+            ?.allowedUsernames || ["username"];
+        const usernameProperties = {};
+        allowedUsernames.forEach((field) => {
+            const displayName = field.includes(".") ? field.split(".").pop() : field;
+            usernameProperties[displayName] = {
+                type: "string",
+                description: `Username field: ${field}`,
+            };
+        });
+        const baseSchema = {
+            type: "object",
+            properties: {
+                ...usernameProperties,
+                password: {
+                    type: "string",
+                    minLength: 8,
+                },
+            },
+            required: ["password"],
+        };
+        return {
+            ...baseSchema,
+            ...(allowedUsernames.length > 0 && {
+                anyOf: allowedUsernames.map((field) => ({
+                    required: [field.includes(".") ? field.split(".").pop() : field],
+                })),
+            }),
+        };
+    }
+}
+const authPrismaJsonSchemaGenerator = new AuthPrismaJsonSchemaGenerator();
+exports.default = authPrismaJsonSchemaGenerator;
+//# sourceMappingURL=auth-prisma-json-schema-generator.js.map