npm - arkos - Versions diffs - 1.4.0-canary.27 → 1.4.0-canary.29 - Mend

arkos 1.4.0-canary.27 → 1.4.0-canary.29

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (19) hide show

package/dist/cjs/app.js +5 -5
package/dist/cjs/app.js.map +1 -1
package/dist/cjs/modules/swagger/swagger.router.js +5 -3
package/dist/cjs/modules/swagger/swagger.router.js.map +1 -1
package/dist/cjs/types/arkos-config.js.map +1 -1
package/dist/cjs/utils/arkos-router/types/index.js.map +1 -1
package/dist/cjs/utils/arkos-router/utils/helpers/index.js.map +1 -1
package/dist/cjs/utils/cli/utils/cli.helpers.js +1 -1
package/dist/esm/app.js +5 -5
package/dist/esm/app.js.map +1 -1
package/dist/esm/modules/swagger/swagger.router.js +5 -3
package/dist/esm/modules/swagger/swagger.router.js.map +1 -1
package/dist/esm/types/arkos-config.js.map +1 -1
package/dist/esm/utils/arkos-router/types/index.js.map +1 -1
package/dist/esm/utils/arkos-router/utils/helpers/index.js.map +1 -1
package/dist/esm/utils/cli/utils/cli.helpers.js +1 -1
package/dist/types/types/arkos-config.d.ts +2 -1
package/dist/types/utils/arkos-router/types/index.d.ts +1 -1
package/package.json +1 -1

package/dist/cjs/app.js CHANGED Viewed

@@ -156,16 +156,16 @@ async function bootstrap(arkosConfig) {
     }
     exports.app.use(knowModulesRouter);
     exports.app.use("/api", (0, base_router_1.getAvailableResourcesAndRoutesRouter)());
-    if (arkosConfig.swagger &&
-        (process.env.ARKOS_BUILD !== "true" ||
-            arkosConfig.swagger.enableAfterBuild === true))
-        exports.app.use("/api", await (0, swagger_router_1.getSwaggerRouter)(arkosConfig, exports.app));
     if (routersConfig?.additional)
         routersConfig.additional.forEach((router) => {
             exports.app.use(router);
         });
+    if (arkosConfig.swagger &&
+        (process.env.ARKOS_BUILD !== "true" ||
+            arkosConfig.swagger.enableAfterBuild === true))
+        exports.app.use("/api", await (0, swagger_router_1.getSwaggerRouter)(arkosConfig, exports.app));
     exports.app.use("*", (req) => {
-        throw new error_handler_1.AppError("Route not found", 404, { route: req.route }, "RouteNotFound");
+        throw new error_handler_1.AppError("Route not found", 404, { route: req.path }, "RouteNotFound");
     });
     if (!disabledMiddlewares?.includes?.("global-error-handler"))
         exports.app.use(replacedMiddlewares.globalErrorHandler || error_handler_controller_1.default);

package/dist/cjs/app.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"app.js","sourceRoot":"","sources":["../../src/app.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,8BAmLC;AA5MD,mDAA0C;AAC1C,gDAAwB;AACxB,kEAAyC;AACzC,4DAA2D;AAC3D,4DAGoC;AACpC,gHAA4E;AAC5E,2DAA+C;AAC/C,8DAAsC;AACtC,sEAAoE;AACpE,mEAAkE;AAClE,iFAA+E;AAE/E,+EAAmE;AACnE,wFAAyD;AACzD,qEAAoE;AACpE,2DAAiE;AACjE,2DAAmD;AACnD,2FAAkE;AAErD,QAAA,GAAG,GAAoB,IAAA,iBAAO,GAAE,CAAC;AAC9C,MAAM,iBAAiB,GAAG,IAAA,gBAAM,GAAE,CAAC;AAE5B,KAAK,UAAU,SAAS,CAC7B,WAAwB;IAExB,MAAM,OAAO,CAAC,GAAG,CAAC;QAChB,IAAA,iCAAgB,GAAE;QAClB,IAAA,wCAAuB,EAAC,WAAW,CAAC;QACpC,WAAW,EAAE,YAAY,IAAI,CAAC,MAAM,WAAW,EAAE,YAAY,CAAC,WAAG,CAAC,CAAC;KACpE,CAAC,CAAC;IAEH,MAAM,iBAAiB,GAAG,WAAW,EAAE,WAAW,CAAC;IACnD,MAAM,mBAAmB,GAAG,iBAAiB,EAAE,OAAO,IAAI,EAAE,CAAC;IAC7D,MAAM,mBAAmB,GAAG,iBAAiB,EAAE,OAAO,IAAI,EAAE,CAAC;IAE7D,IAAI,CAAC,mBAAmB,EAAE,QAAQ,EAAE,CAAC,aAAa,CAAC;QACjD,WAAG,CAAC,GAAG,CACL,mBAAmB,CAAC,WAAW;YAC7B,IAAA,qBAAW,EAAC,WAAW,EAAE,kBAAkB,CAAC,CAC/C,CAAC;IAEJ,IAAI,CAAC,mBAAmB,EAAE,QAAQ,EAAE,CAAC,mBAAmB,CAAC;QACvD,WAAG,CAAC,GAAG,CACL,mBAAmB,CAAC,eAAe;YACjC,IAAA,8BAAS,EACP,IAAA,0BAAS,EACP;gBACE,QAAQ,EAAE,EAAE,GAAG,IAAI;gBACnB,KAAK,EAAE,GAAG;gBACV,eAAe,EAAE,SAAS;gBAC1B,aAAa,EAAE,KAAK;gBACpB,OAAO,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE;oBAClB,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;wBACnB,OAAO,EAAE,2CAA2C;qBACrD,CAAC,CAAC;gBACL,CAAC;aACF,EACD,WAAW,EAAE,6BAA6B,IAAI,EAAE,CACjD,CACF,CACJ,CAAC;IAEJ,IAAI,CAAC,mBAAmB,EAAE,QAAQ,EAAE,CAAC,MAAM,CAAC;QAC1C,WAAG,CAAC,GAAG,CACL,mBAAmB,CAAC,IAAI;YACtB,IAAA,cAAI,EACF,WAAW,EAAE,IAAI,EAAE,aAAa;gBAC9B,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,aAAa;gBAChC,CAAC,CAAC,IAAA,0BAAS,EACP;oBACE,MAAM,EAAE,CACN,MAAc,EACd,EAAgD,EAChD,EAAE;wBACF,MAAM,OAAO,GAAG,WAAW,EAAE,IAAI,EAAE,cAAc,CAAC;wBAElD,IAAI,OAAO,KAAK,GAAG;4BAAE,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;6BAC/B,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;4BAC7B,EAAE,CAAC,IAAI,EAAE,CAAC,MAAM,IAAI,OAAO,EAAE,QAAQ,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;6BAC9C,IAAI,OAAO,OAAO,KAAK,QAAQ;4BAClC,EAAE,CAAC,IAAI,EAAE,CAAC,MAAM,IAAI,OAAO,KAAK,MAAM,CAAC,CAAC;;4BACrC,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;oBACvB,CAAC;oBAED,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,CAAC;oBAC7D,cAAc,EAAE;wBACd,cAAc;wBACd,eAAe;wBACf,YAAY;qBACb;oBACD,WAAW,EAAE,IAAI;iBAClB,EACD,WAAW,EAAE,IAAI,EAAE,OAAO,IAAI,EAAE,CACjC,CACN,CACJ,CAAC;IAEJ,IAAI,CAAC,mBAAmB,EAAE,QAAQ,EAAE,CAAC,cAAc,CAAC;QAClD,WAAG,CAAC,GAAG,CACL,mBAAmB,CAAC,WAAW;YAC7B,iBAAO,CAAC,IAAI,CAAC,WAAW,EAAE,qBAAqB,CAAC,CACnD,CAAC;IAEJ,IAAI,CAAC,mBAAmB,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC;QACnD,WAAG,CAAC,GAAG,CACL,mBAAmB,CAAC,YAAY;YAC9B,IAAA,uBAAY,EAAC,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,sBAAsB,IAAI,EAAE,CAAC,CAAC,CAAC,CACpE,CAAC;IAEJ,IAAI,CAAC,mBAAmB,EAAE,QAAQ,EAAE,CAAC,cAAc,CAAC;QAClD,WAAG,CAAC,GAAG,CACL,mBAAmB,CAAC,WAAW;YAC7B,IAAA,kCAAW,EACT,IAAA,0BAAS,EACP;gBACE,SAAS,EAAE,IAAI;gBACf,cAAc,EAAE,IAAI;gBACpB,YAAY,EAAE,IAAI;aACnB,EACD,WAAW,EAAE,kBAAkB,IAAI,EAAE,CACtC,CACF,CACJ,CAAC;IAEJ,IAAI,CAAC,mBAAmB,EAAE,QAAQ,EAAE,CAAC,gBAAgB,CAAC;QACpD,WAAG,CAAC,GAAG,CAAC,mBAAmB,CAAC,aAAa,IAAI,oCAAiB,CAAC,CAAC;IAElE,IAAI,WAAW,EAAE,WAAW,EAAE,UAAU;QACtC,WAAW,CAAC,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YACxD,WAAG,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC;IAEL,WAAG,CAAC,GAAG,CAAC,0BAAe,CAAC,cAAc,CAAC,CAAC;IAExC,MAAM,aAAa,GAAG,WAAW,EAAE,OAAO,CAAC;IAC3C,MAAM,eAAe,GAAG,aAAa,EAAE,OAAO,IAAI,EAAE,CAAC;IACrD,MAAM,eAAe,GAAG,aAAa,EAAE,OAAO,IAAI,EAAE,CAAC;IAErD,IAAI,CAAC,eAAe,EAAE,QAAQ,EAAE,CAAC,kBAAkB,CAAC;QAClD,WAAG,CAAC,GAAG,CACL,MAAM,EACN,eAAe,CAAC,eAAe;YAC7B,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE;gBACV,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,WAAW,CAAC,cAAc,EAAE,CAAC,CAAC;YAChE,CAAC,CAAC,CACL,CAAC;IAEJ,WAAG,CAAC,GAAG,CAAC,0BAAe,CAAC,cAAc,CAAC,CAAC;IAExC,IAAI,CAAC,eAAe,EAAE,QAAQ,EAAE,CAAC,aAAa,CAAC,EAAE,CAAC;QAChD,MAAM,gBAAgB,GAAG,eAAe,CAAC,UAAU;YACjD,CAAC,CAAC,MAAM,eAAe,CAAC,UAAU,CAAC,WAAW,CAAC;YAC/C,CAAC,CAAC,MAAM,IAAA,wCAAmB,EAAC,WAAW,CAAC,CAAC;QAC3C,iBAAiB,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;IAC1C,CAAC;IAED,IACE,CAAC,eAAe,EAAE,QAAQ,EAAE,CAAC,aAAa,CAAC;QAC3C,WAAW,CAAC,cAAc,EAC1B,CAAC;QACD,MAAM,UAAU,GAAG,eAAe,CAAC,UAAU;YAC3C,CAAC,CAAC,MAAM,eAAe,CAAC,UAAU,CAAC,WAAW,CAAC;YAC/C,CAAC,CAAC,MAAM,IAAA,2BAAa,EAAC,WAAW,CAAC,CAAC;QACrC,iBAAiB,CAAC,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,CAAC,eAAe,EAAE,QAAQ,EAAE,CAAC,sBAAsB,CAAC,EAAE,CAAC;QACzD,MAAM,YAAY,GAAG,eAAe,CAAC,kBAAkB;YACrD,CAAC,CAAC,MAAM,eAAe,CAAC,kBAAkB,CAAC,WAAW,CAAC;YACvD,CAAC,CAAC,MAAM,IAAA,mCAAqB,EAAC,WAAW,CAAC,CAAC;QAC7C,iBAAiB,CAAC,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAC9C,CAAC;IAED,WAAG,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;IAC3B,WAAG,CAAC,GAAG,CAAC,MAAM,EAAE,IAAA,kDAAoC,GAAE,CAAC,CAAC;IAExD,IACE,WAAW,CAAC,OAAO;QACnB,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,KAAK,MAAM;YACjC,WAAW,CAAC,OAAO,CAAC,gBAAgB,KAAK,IAAI,CAAC;QAEhD,WAAG,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,IAAA,iCAAgB,EAAC,WAAW,EAAE,WAAG,CAAC,CAAC,CAAC;IAE5D,IAAI,aAAa,EAAE,UAAU;QAC3B,aAAa,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YAC1C,WAAG,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAClB,CAAC,CAAC,CAAC;IAEL,WAAG,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,EAAE;QACnB,MAAM,IAAI,wBAAQ,CAChB,iBAAiB,EACjB,GAAG,EACH,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,EACpB,eAAe,CAChB,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,mBAAmB,EAAE,QAAQ,EAAE,CAAC,sBAAsB,CAAC;QAC1D,WAAG,CAAC,GAAG,CAAC,mBAAmB,CAAC,kBAAkB,IAAI,kCAAY,CAAC,CAAC;IAElE,OAAO,WAAG,CAAC;AACb,CAAC","sourcesContent":["import express, { Router } from \"express\";\nimport cors from \"cors\";\nimport cookieParser from \"cookie-parser\";\nimport { getAuthRouter } from \"./modules/auth/auth.router\";\nimport {\n getPrismaModelsRouter,\n getAvailableResourcesAndRoutesRouter,\n} from \"./modules/base/base.router\";\nimport errorHandler from \"./modules/error-handler/error-handler.controller\";\nimport { rateLimit } from \"express-rate-limit\";\nimport compression from \"compression\";\nimport { handleRequestLogs } from \"./modules/base/base.middlewares\";\nimport { loadPrismaModule } from \"./utils/helpers/prisma.helpers\";\nimport { getFileUploadRouter } from \"./modules/file-upload/file-upload.router\";\nimport { ArkosConfig } from \"./types/arkos-config\";\nimport { queryParser } from \"./utils/helpers/query-parser.helpers\";\nimport deepmerge from \"./utils/helpers/deepmerge.helper\";\nimport { getSwaggerRouter } from \"./modules/swagger/swagger.router\";\nimport { loadAllModuleComponents } from \"./utils/dynamic-loader\";\nimport { AppError } from \"./exports/error-handler\";\nimport debuggerService from \"./modules/debugger/debugger.service\";\n\nexport const app: express.Express = express();\nconst knowModulesRouter = Router();\n\nexport async function bootstrap(\n arkosConfig: ArkosConfig\n): Promise<express.Express> {\n await Promise.all([\n loadPrismaModule(),\n loadAllModuleComponents(arkosConfig),\n arkosConfig?.configureApp && (await arkosConfig?.configureApp(app)),\n ]);\n\n const middlewaresConfig = arkosConfig?.middlewares;\n const disabledMiddlewares = middlewaresConfig?.disable \|\| [];\n const replacedMiddlewares = middlewaresConfig?.replace \|\| {};\n\n if (!disabledMiddlewares?.includes?.(\"compression\"))\n app.use(\n replacedMiddlewares.compression \|\|\n compression(arkosConfig?.compressionOptions)\n );\n\n if (!disabledMiddlewares?.includes?.(\"global-rate-limit\"))\n app.use(\n replacedMiddlewares.globalRateLimit \|\|\n rateLimit(\n deepmerge(\n {\n windowMs: 60 * 1000,\n limit: 300,\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 arkosConfig?.globalRequestRateLimitOptions \|\| {}\n )\n )\n );\n\n if (!disabledMiddlewares?.includes?.(\"cors\"))\n app.use(\n replacedMiddlewares.cors \|\|\n cors(\n arkosConfig?.cors?.customHandler\n ? arkosConfig.cors.customHandler\n : deepmerge(\n {\n origin: (\n origin: string,\n cb: (err: Error \| null, allow?: boolean) => void\n ) => {\n const allowed = arkosConfig?.cors?.allowedOrigins;\n\n if (allowed === \"\") cb(null, true);\n else if (Array.isArray(allowed))\n cb(null, !origin \|\| allowed?.includes?.(origin));\n else if (typeof allowed === \"string\")\n cb(null, !origin \|\| allowed === origin);\n else cb(null, false);\n },\n\n methods: [\"GET\", \"POST\", \"PUT\", \"DELETE\", \"PATCH\", \"OPTIONS\"],\n allowedHeaders: [\n \"Content-Type\",\n \"Authorization\",\n \"Connection\",\n ],\n credentials: true,\n },\n arkosConfig?.cors?.options \|\| {}\n )\n )\n );\n\n if (!disabledMiddlewares?.includes?.(\"express-json\"))\n app.use(\n replacedMiddlewares.expressJson \|\|\n express.json(arkosConfig?.jsonBodyParserOptions)\n );\n\n if (!disabledMiddlewares?.includes?.(\"cookie-parser\"))\n app.use(\n replacedMiddlewares.cookieParser \|\|\n cookieParser(...[...(arkosConfig?.cookieParserParameters \|\| [])])\n );\n\n if (!disabledMiddlewares?.includes?.(\"query-parser\"))\n app.use(\n replacedMiddlewares.queryParser \|\|\n queryParser(\n deepmerge(\n {\n parseNull: true,\n parseUndefined: true,\n parseBoolean: true,\n },\n arkosConfig?.queryParserOptions \|\| {}\n )\n )\n );\n\n if (!disabledMiddlewares?.includes?.(\"request-logger\"))\n app.use(replacedMiddlewares.requestLogger \|\| handleRequestLogs);\n\n if (arkosConfig?.middlewares?.additional)\n arkosConfig.middlewares.additional.forEach((middleware) => {\n app.use(middleware);\n });\n\n app.use(debuggerService.logRequestInfo);\n\n const routersConfig = arkosConfig?.routers;\n const disabledRouters = routersConfig?.disable \|\| [];\n const replacedRouters = routersConfig?.replace \|\| {};\n\n if (!disabledRouters?.includes?.(\"welcome-endpoint\"))\n app.get(\n \"/api\",\n replacedRouters.welcomeEndpoint \|\|\n ((_, res) => {\n res.status(200).json({ message: arkosConfig.welcomeMessage });\n })\n );\n\n app.use(debuggerService.logRequestInfo);\n\n if (!disabledRouters?.includes?.(\"file-upload\")) {\n const fileUploadRouter = replacedRouters.fileUpload\n ? await replacedRouters.fileUpload(arkosConfig)\n : await getFileUploadRouter(arkosConfig);\n knowModulesRouter.use(fileUploadRouter);\n }\n\n if (\n !disabledRouters?.includes?.(\"auth-router\") &&\n arkosConfig.authentication\n ) {\n const authRouter = replacedRouters.authRouter\n ? await replacedRouters.authRouter(arkosConfig)\n : await getAuthRouter(arkosConfig);\n knowModulesRouter.use(\"/api\", authRouter);\n }\n\n if (!disabledRouters?.includes?.(\"prisma-models-router\")) {\n const modelsRouter = replacedRouters.prismaModelsRouter\n ? await replacedRouters.prismaModelsRouter(arkosConfig)\n : await getPrismaModelsRouter(arkosConfig);\n knowModulesRouter.use(\"/api\", modelsRouter);\n }\n\n app.use(knowModulesRouter);\n app.use(\"/api\", getAvailableResourcesAndRoutesRouter());\n\n if (\n arkosConfig.swagger &&\n (process.env.ARKOS_BUILD !== \"true\" \|\|\n arkosConfig.swagger.enableAfterBuild === true)\n )\n app.use(\"/api\", await getSwaggerRouter(arkosConfig, app));\n\n if (routersConfig?.additional)\n routersConfig.additional.forEach((router) => {\n app.use(router);\n });\n\n app.use(\"\", (req) => {\n throw new AppError(\n \"Route not found\",\n 404,\n { route: req.route },\n \"RouteNotFound\"\n );\n });\n\n if (!disabledMiddlewares?.includes?.(\"global-error-handler\"))\n app.use(replacedMiddlewares.globalErrorHandler \|\| errorHandler);\n\n return app;\n}\n"]}
1	+ {"version":3,"file":"app.js","sourceRoot":"","sources":["../../src/app.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,8BAuLC;AAhND,mDAA0C;AAC1C,gDAAwB;AACxB,kEAAyC;AACzC,4DAA2D;AAC3D,4DAGoC;AACpC,gHAA4E;AAC5E,2DAA+C;AAC/C,8DAAsC;AACtC,sEAAoE;AACpE,mEAAkE;AAClE,iFAA+E;AAE/E,+EAAmE;AACnE,wFAAyD;AACzD,qEAAoE;AACpE,2DAAiE;AACjE,2DAAmD;AACnD,2FAAkE;AAErD,QAAA,GAAG,GAAoB,IAAA,iBAAO,GAAE,CAAC;AAC9C,MAAM,iBAAiB,GAAG,IAAA,gBAAM,GAAE,CAAC;AAE5B,KAAK,UAAU,SAAS,CAC7B,WAAwB;IAExB,MAAM,OAAO,CAAC,GAAG,CAAC;QAChB,IAAA,iCAAgB,GAAE;QAClB,IAAA,wCAAuB,EAAC,WAAW,CAAC;QACpC,WAAW,EAAE,YAAY,IAAI,CAAC,MAAM,WAAW,EAAE,YAAY,CAAC,WAAG,CAAC,CAAC;KACpE,CAAC,CAAC;IAEH,MAAM,iBAAiB,GAAG,WAAW,EAAE,WAAW,CAAC;IACnD,MAAM,mBAAmB,GAAG,iBAAiB,EAAE,OAAO,IAAI,EAAE,CAAC;IAC7D,MAAM,mBAAmB,GAAG,iBAAiB,EAAE,OAAO,IAAI,EAAE,CAAC;IAE7D,IAAI,CAAC,mBAAmB,EAAE,QAAQ,EAAE,CAAC,aAAa,CAAC;QACjD,WAAG,CAAC,GAAG,CACL,mBAAmB,CAAC,WAAW;YAC7B,IAAA,qBAAW,EAAC,WAAW,EAAE,kBAAkB,CAAC,CAC/C,CAAC;IAEJ,IAAI,CAAC,mBAAmB,EAAE,QAAQ,EAAE,CAAC,mBAAmB,CAAC;QACvD,WAAG,CAAC,GAAG,CACL,mBAAmB,CAAC,eAAe;YACjC,IAAA,8BAAS,EACP,IAAA,0BAAS,EACP;gBACE,QAAQ,EAAE,EAAE,GAAG,IAAI;gBACnB,KAAK,EAAE,GAAG;gBACV,eAAe,EAAE,SAAS;gBAC1B,aAAa,EAAE,KAAK;gBACpB,OAAO,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE;oBAClB,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;wBACnB,OAAO,EAAE,2CAA2C;qBACrD,CAAC,CAAC;gBACL,CAAC;aACF,EACD,WAAW,EAAE,6BAA6B,IAAI,EAAE,CACjD,CACF,CACJ,CAAC;IAEJ,IAAI,CAAC,mBAAmB,EAAE,QAAQ,EAAE,CAAC,MAAM,CAAC;QAC1C,WAAG,CAAC,GAAG,CACL,mBAAmB,CAAC,IAAI;YACtB,IAAA,cAAI,EACF,WAAW,EAAE,IAAI,EAAE,aAAa;gBAC9B,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,aAAa;gBAChC,CAAC,CAAC,IAAA,0BAAS,EACP;oBACE,MAAM,EAAE,CACN,MAAc,EACd,EAAgD,EAChD,EAAE;wBACF,MAAM,OAAO,GAAG,WAAW,EAAE,IAAI,EAAE,cAAc,CAAC;wBAElD,IAAI,OAAO,KAAK,GAAG;4BAAE,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;6BAC/B,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;4BAC7B,EAAE,CAAC,IAAI,EAAE,CAAC,MAAM,IAAI,OAAO,EAAE,QAAQ,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;6BAC9C,IAAI,OAAO,OAAO,KAAK,QAAQ;4BAClC,EAAE,CAAC,IAAI,EAAE,CAAC,MAAM,IAAI,OAAO,KAAK,MAAM,CAAC,CAAC;;4BACrC,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;oBACvB,CAAC;oBAED,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,CAAC;oBAC7D,cAAc,EAAE;wBACd,cAAc;wBACd,eAAe;wBACf,YAAY;qBACb;oBACD,WAAW,EAAE,IAAI;iBAClB,EACD,WAAW,EAAE,IAAI,EAAE,OAAO,IAAI,EAAE,CACjC,CACN,CACJ,CAAC;IAEJ,IAAI,CAAC,mBAAmB,EAAE,QAAQ,EAAE,CAAC,cAAc,CAAC;QAClD,WAAG,CAAC,GAAG,CACL,mBAAmB,CAAC,WAAW;YAC7B,iBAAO,CAAC,IAAI,CAAC,WAAW,EAAE,qBAAqB,CAAC,CACnD,CAAC;IAEJ,IAAI,CAAC,mBAAmB,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC;QACnD,WAAG,CAAC,GAAG,CACL,mBAAmB,CAAC,YAAY;YAC9B,IAAA,uBAAY,EAAC,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,sBAAsB,IAAI,EAAE,CAAC,CAAC,CAAC,CACpE,CAAC;IAEJ,IAAI,CAAC,mBAAmB,EAAE,QAAQ,EAAE,CAAC,cAAc,CAAC;QAClD,WAAG,CAAC,GAAG,CACL,mBAAmB,CAAC,WAAW;YAC7B,IAAA,kCAAW,EACT,IAAA,0BAAS,EACP;gBACE,SAAS,EAAE,IAAI;gBACf,cAAc,EAAE,IAAI;gBACpB,YAAY,EAAE,IAAI;aACnB,EACD,WAAW,EAAE,kBAAkB,IAAI,EAAE,CACtC,CACF,CACJ,CAAC;IAEJ,IAAI,CAAC,mBAAmB,EAAE,QAAQ,EAAE,CAAC,gBAAgB,CAAC;QACpD,WAAG,CAAC,GAAG,CAAC,mBAAmB,CAAC,aAAa,IAAI,oCAAiB,CAAC,CAAC;IAElE,IAAI,WAAW,EAAE,WAAW,EAAE,UAAU;QACtC,WAAW,CAAC,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YACxD,WAAG,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC;IAEL,WAAG,CAAC,GAAG,CAAC,0BAAe,CAAC,cAAc,CAAC,CAAC;IAExC,MAAM,aAAa,GAAG,WAAW,EAAE,OAAO,CAAC;IAC3C,MAAM,eAAe,GAAG,aAAa,EAAE,OAAO,IAAI,EAAE,CAAC;IACrD,MAAM,eAAe,GAAG,aAAa,EAAE,OAAO,IAAI,EAAE,CAAC;IAErD,IAAI,CAAC,eAAe,EAAE,QAAQ,EAAE,CAAC,kBAAkB,CAAC;QAClD,WAAG,CAAC,GAAG,CACL,MAAM,EACN,eAAe,CAAC,eAAe;YAC7B,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE;gBACV,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,WAAW,CAAC,cAAc,EAAE,CAAC,CAAC;YAChE,CAAC,CAAC,CACL,CAAC;IAEJ,WAAG,CAAC,GAAG,CAAC,0BAAe,CAAC,cAAc,CAAC,CAAC;IAExC,IAAI,CAAC,eAAe,EAAE,QAAQ,EAAE,CAAC,aAAa,CAAC,EAAE,CAAC;QAChD,MAAM,gBAAgB,GAAG,eAAe,CAAC,UAAU;YACjD,CAAC,CAAC,MAAM,eAAe,CAAC,UAAU,CAAC,WAAW,CAAC;YAC/C,CAAC,CAAC,MAAM,IAAA,wCAAmB,EAAC,WAAW,CAAC,CAAC;QAC3C,iBAAiB,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;IAC1C,CAAC;IAED,IACE,CAAC,eAAe,EAAE,QAAQ,EAAE,CAAC,aAAa,CAAC;QAC3C,WAAW,CAAC,cAAc,EAC1B,CAAC;QACD,MAAM,UAAU,GAAG,eAAe,CAAC,UAAU;YAC3C,CAAC,CAAC,MAAM,eAAe,CAAC,UAAU,CAAC,WAAW,CAAC;YAC/C,CAAC,CAAC,MAAM,IAAA,2BAAa,EAAC,WAAW,CAAC,CAAC;QACrC,iBAAiB,CAAC,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,CAAC,eAAe,EAAE,QAAQ,EAAE,CAAC,sBAAsB,CAAC,EAAE,CAAC;QACzD,MAAM,YAAY,GAAG,eAAe,CAAC,kBAAkB;YACrD,CAAC,CAAC,MAAM,eAAe,CAAC,kBAAkB,CAAC,WAAW,CAAC;YACvD,CAAC,CAAC,MAAM,IAAA,mCAAqB,EAAC,WAAW,CAAC,CAAC;QAC7C,iBAAiB,CAAC,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAC9C,CAAC;IAED,WAAG,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;IAC3B,WAAG,CAAC,GAAG,CAAC,MAAM,EAAE,IAAA,kDAAoC,GAAE,CAAC,CAAC;IAExD,IAAI,aAAa,EAAE,UAAU;QAC3B,aAAa,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YAC1C,WAAG,CAAC,GAAG,CAAC,MAAa,CAAC,CAAC;QACzB,CAAC,CAAC,CAAC;IAML,IACE,WAAW,CAAC,OAAO;QACnB,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,KAAK,MAAM;YACjC,WAAW,CAAC,OAAO,CAAC,gBAAgB,KAAK,IAAI,CAAC;QAEhD,WAAG,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,IAAA,iCAAgB,EAAC,WAAW,EAAE,WAAG,CAAC,CAAC,CAAC;IAE5D,WAAG,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,EAAE;QACnB,MAAM,IAAI,wBAAQ,CAChB,iBAAiB,EACjB,GAAG,EACH,EAAE,KAAK,EAAE,GAAG,CAAC,IAAI,EAAE,EACnB,eAAe,CAChB,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,mBAAmB,EAAE,QAAQ,EAAE,CAAC,sBAAsB,CAAC;QAC1D,WAAG,CAAC,GAAG,CAAC,mBAAmB,CAAC,kBAAkB,IAAI,kCAAY,CAAC,CAAC;IAElE,OAAO,WAAG,CAAC;AACb,CAAC","sourcesContent":["import express, { Router } from \"express\";\nimport cors from \"cors\";\nimport cookieParser from \"cookie-parser\";\nimport { getAuthRouter } from \"./modules/auth/auth.router\";\nimport {\n getPrismaModelsRouter,\n getAvailableResourcesAndRoutesRouter,\n} from \"./modules/base/base.router\";\nimport errorHandler from \"./modules/error-handler/error-handler.controller\";\nimport { rateLimit } from \"express-rate-limit\";\nimport compression from \"compression\";\nimport { handleRequestLogs } from \"./modules/base/base.middlewares\";\nimport { loadPrismaModule } from \"./utils/helpers/prisma.helpers\";\nimport { getFileUploadRouter } from \"./modules/file-upload/file-upload.router\";\nimport { ArkosConfig } from \"./types/arkos-config\";\nimport { queryParser } from \"./utils/helpers/query-parser.helpers\";\nimport deepmerge from \"./utils/helpers/deepmerge.helper\";\nimport { getSwaggerRouter } from \"./modules/swagger/swagger.router\";\nimport { loadAllModuleComponents } from \"./utils/dynamic-loader\";\nimport { AppError } from \"./exports/error-handler\";\nimport debuggerService from \"./modules/debugger/debugger.service\";\n\nexport const app: express.Express = express();\nconst knowModulesRouter = Router();\n\nexport async function bootstrap(\n arkosConfig: ArkosConfig\n): Promise<express.Express> {\n await Promise.all([\n loadPrismaModule(),\n loadAllModuleComponents(arkosConfig),\n arkosConfig?.configureApp && (await arkosConfig?.configureApp(app)),\n ]);\n\n const middlewaresConfig = arkosConfig?.middlewares;\n const disabledMiddlewares = middlewaresConfig?.disable \|\| [];\n const replacedMiddlewares = middlewaresConfig?.replace \|\| {};\n\n if (!disabledMiddlewares?.includes?.(\"compression\"))\n app.use(\n replacedMiddlewares.compression \|\|\n compression(arkosConfig?.compressionOptions)\n );\n\n if (!disabledMiddlewares?.includes?.(\"global-rate-limit\"))\n app.use(\n replacedMiddlewares.globalRateLimit \|\|\n rateLimit(\n deepmerge(\n {\n windowMs: 60 * 1000,\n limit: 300,\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 arkosConfig?.globalRequestRateLimitOptions \|\| {}\n )\n )\n );\n\n if (!disabledMiddlewares?.includes?.(\"cors\"))\n app.use(\n replacedMiddlewares.cors \|\|\n cors(\n arkosConfig?.cors?.customHandler\n ? arkosConfig.cors.customHandler\n : deepmerge(\n {\n origin: (\n origin: string,\n cb: (err: Error \| null, allow?: boolean) => void\n ) => {\n const allowed = arkosConfig?.cors?.allowedOrigins;\n\n if (allowed === \"\") cb(null, true);\n else if (Array.isArray(allowed))\n cb(null, !origin \|\| allowed?.includes?.(origin));\n else if (typeof allowed === \"string\")\n cb(null, !origin \|\| allowed === origin);\n else cb(null, false);\n },\n\n methods: [\"GET\", \"POST\", \"PUT\", \"DELETE\", \"PATCH\", \"OPTIONS\"],\n allowedHeaders: [\n \"Content-Type\",\n \"Authorization\",\n \"Connection\",\n ],\n credentials: true,\n },\n arkosConfig?.cors?.options \|\| {}\n )\n )\n );\n\n if (!disabledMiddlewares?.includes?.(\"express-json\"))\n app.use(\n replacedMiddlewares.expressJson \|\|\n express.json(arkosConfig?.jsonBodyParserOptions)\n );\n\n if (!disabledMiddlewares?.includes?.(\"cookie-parser\"))\n app.use(\n replacedMiddlewares.cookieParser \|\|\n cookieParser(...[...(arkosConfig?.cookieParserParameters \|\| [])])\n );\n\n if (!disabledMiddlewares?.includes?.(\"query-parser\"))\n app.use(\n replacedMiddlewares.queryParser \|\|\n queryParser(\n deepmerge(\n {\n parseNull: true,\n parseUndefined: true,\n parseBoolean: true,\n },\n arkosConfig?.queryParserOptions \|\| {}\n )\n )\n );\n\n if (!disabledMiddlewares?.includes?.(\"request-logger\"))\n app.use(replacedMiddlewares.requestLogger \|\| handleRequestLogs);\n\n if (arkosConfig?.middlewares?.additional)\n arkosConfig.middlewares.additional.forEach((middleware) => {\n app.use(middleware);\n });\n\n app.use(debuggerService.logRequestInfo);\n\n const routersConfig = arkosConfig?.routers;\n const disabledRouters = routersConfig?.disable \|\| [];\n const replacedRouters = routersConfig?.replace \|\| {};\n\n if (!disabledRouters?.includes?.(\"welcome-endpoint\"))\n app.get(\n \"/api\",\n replacedRouters.welcomeEndpoint \|\|\n ((_, res) => {\n res.status(200).json({ message: arkosConfig.welcomeMessage });\n })\n );\n\n app.use(debuggerService.logRequestInfo);\n\n if (!disabledRouters?.includes?.(\"file-upload\")) {\n const fileUploadRouter = replacedRouters.fileUpload\n ? await replacedRouters.fileUpload(arkosConfig)\n : await getFileUploadRouter(arkosConfig);\n knowModulesRouter.use(fileUploadRouter);\n }\n\n if (\n !disabledRouters?.includes?.(\"auth-router\") &&\n arkosConfig.authentication\n ) {\n const authRouter = replacedRouters.authRouter\n ? await replacedRouters.authRouter(arkosConfig)\n : await getAuthRouter(arkosConfig);\n knowModulesRouter.use(\"/api\", authRouter);\n }\n\n if (!disabledRouters?.includes?.(\"prisma-models-router\")) {\n const modelsRouter = replacedRouters.prismaModelsRouter\n ? await replacedRouters.prismaModelsRouter(arkosConfig)\n : await getPrismaModelsRouter(arkosConfig);\n knowModulesRouter.use(\"/api\", modelsRouter);\n }\n\n app.use(knowModulesRouter);\n app.use(\"/api\", getAvailableResourcesAndRoutesRouter());\n\n if (routersConfig?.additional)\n routersConfig.additional.forEach((router) => {\n app.use(router as any);\n });\n\n /\n Must be last called in order to be able to get all\n * routes built using ArkosRouter\n /\n if (\n arkosConfig.swagger &&\n (process.env.ARKOS_BUILD !== \"true\" \|\|\n arkosConfig.swagger.enableAfterBuild === true)\n )\n app.use(\"/api\", await getSwaggerRouter(arkosConfig, app));\n\n app.use(\"\", (req) => {\n throw new AppError(\n \"Route not found\",\n 404,\n { route: req.path },\n \"RouteNotFound\"\n );\n });\n\n if (!disabledMiddlewares?.includes?.(\"global-error-handler\"))\n app.use(replacedMiddlewares.globalErrorHandler \|\| errorHandler);\n\n return app;\n}\n"]}

package/dist/cjs/modules/swagger/swagger.router.js CHANGED Viewed

@@ -16,9 +16,11 @@ const arkos_router_1 = require("../../utils/arkos-router");
 const get_file_upload_json_schema_paths_1 = __importDefault(require("./utils/helpers/get-file-upload-json-schema-paths"));
 const swaggerRouter = (0, express_1.Router)();
 async function getSwaggerRouter(arkosConfig, app) {
-    let defaultJsonSchemas = await (0, swagger_router_helpers_1.getOpenAPIJsonSchemasByConfigMode)(arkosConfig);
-    const defaultModelsPaths = await (0, swagger_router_helpers_1.generatePathsForModels)(arkosConfig);
-    const pathsFromCustomArkosRouters = (0, arkos_router_1.generateOpenAPIFromApp)(app);
+    let [defaultJsonSchemas, defaultModelsPaths, pathsFromCustomArkosRouters] = await Promise.all([
+        await (0, swagger_router_helpers_1.getOpenAPIJsonSchemasByConfigMode)(arkosConfig),
+        await (0, swagger_router_helpers_1.generatePathsForModels)(arkosConfig),
+        await (0, arkos_router_1.generateOpenAPIFromApp)(app),
+    ]);
     const fileUploadDefaultPaths = (0, get_file_upload_json_schema_paths_1.default)(arkosConfig);
     const missingJsonSchemas = await missing_json_schemas_generator_1.default.generateMissingJsonSchemas(defaultModelsPaths, defaultJsonSchemas, arkosConfig);
     defaultJsonSchemas = {

package/dist/cjs/modules/swagger/swagger.router.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"swagger.router.js","sourceRoot":"","sources":["../../../../src/modules/swagger/swagger.router.ts"],"names":[],"mappings":";;;;;AAkBA,~~4CAsDC~~;~~AAxED~~,qCAAiC;AACjC,kEAAyC;AAEzC,4FAA6D;AAC7D,mFAGgD;AAChD,oHAAwF;AACxF,8GAAkF;AAClF,uEAAyF;AACzF,uIAA4G;AAC5G,2DAAkE;AAElE,0HAA6F;AAE7F,MAAM,aAAa,GAAG,IAAA,gBAAM,GAAE,CAAC;AAExB,KAAK,UAAU,gBAAgB,CACpC,WAAwB,EACxB,GAAoB;IAEpB,IAAI,kBAAkB,GAAG,MAAM,IAAA,0DAAiC,EAAC,WAAW,CAAC~~,CAAC~~;~~IAC9E~~,MAAM,~~kBAAkB,GAAG,MAAM,~~IAAA,+CAAsB,EAAC,WAAW,CAAC~~,CAAC~~;~~IACrE~~,MAAM,~~2BAA2B,GAAG,~~IAAA,qCAAsB,EAAC,GAAG,CAAC,CAAC;~~IAEhE~~,MAAM,sBAAsB,GAAG,IAAA,2CAA4B,EAAC,WAAW,CAAC,CAAC;IACzE,MAAM,kBAAkB,GACtB,MAAM,wCAA0B,CAAC,0BAA0B,CACzD,kBAAkB,EAClB,kBAAkB,EAClB,WAAW,CACZ,CAAC;IAEJ,kBAAkB,GAAG;QACnB,GAAG,kBAAkB;QACrB,GAAG,kBAAkB;QACrB,GAAG,IAAA,sCAAyB,EAAC,WAAW,CAAC;KAC1C,CAAC;IAEF,MAAM,cAAc,GAAG,IAAA,0BAAS,EAC9B,CAAC,MAAM,IAAA,qCAAuB,EAC5B;QACE,GAAG,kBAAkB;QACrB,GAAG,sBAAsB;QACzB,GAAG,2BAA2B;KAC/B,EACD,kBAAkB,CACnB,CAAC,IAAI,EAAE,EACR,WAAW,CAAC,OAAO,IAAI,EAAE,CACA,CAAC;IAE5B,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,EAAE,GAAG,cAAc,EAAE,OAAQ,CAAC;IAE5D,MAAM,oBAAoB,GAAG,IAAA,uBAAY,EAAC;QACxC,UAAU,EAAE,UAA4C;QACxD,GAAG,OAAO;KACX,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,MAAM,IAAA,oDAAmC,EACtD,+BAA+B,CAChC,CAAC;IAEF,aAAa,CAAC,GAAG,CACf,cAAe,CAAC,QAAS,EACzB,MAAM,CAAC,YAAY,CAAC;QAClB,OAAO,EAAE,oBAAoB;QAC7B,GAAG,cAAc,EAAE,+BAA+B;KACnD,CAAC,CACH,CAAC;IAEF,OAAO,aAAa,CAAC;AACvB,CAAC","sourcesContent":["import { Router } from \"express\";\nimport swaggerJsdoc from \"swagger-jsdoc\";\nimport { ArkosConfig } from \"../../types/arkos-config\";\nimport deepmerge from \"../../utils/helpers/deepmerge.helper\";\nimport {\n generatePathsForModels,\n getOpenAPIJsonSchemasByConfigMode,\n} from \"./utils/helpers/swagger.router.helpers\";\nimport missingJsonSchemaGenerator from \"./utils/helpers/missing-json-schemas-generator\";\nimport getSwaggerDefaultConfig from \"./utils/helpers/get-swagger-default-configs\";\nimport { importEsmPreventingTsTransformation } from \"../../utils/helpers/global.helpers\";\nimport generateSystemJsonSchemas from \"./utils/helpers/json-schema-generators/generate-system-json-schemas\";\nimport { generateOpenAPIFromApp } from \"../../utils/arkos-router\";\nimport express from \"express\";\nimport getFileUploadJsonSchemaPaths from \"./utils/helpers/get-file-upload-json-schema-paths\";\n\nconst swaggerRouter = Router();\n\nexport async function getSwaggerRouter(\n arkosConfig: ArkosConfig,\n app: express.Express\n): Promise<Router> {\n let defaultJsonSchemas = await getOpenAPIJsonSchemasByConfigMode(arkosConfig);\n ~~const defaultModelsPaths =~~ await generatePathsForModels(arkosConfig);\n ~~const~~ ~~pathsFromCustomArkosRouters =~~ generateOpenAPIFromApp(app);\n\n const fileUploadDefaultPaths = getFileUploadJsonSchemaPaths(arkosConfig);\n const missingJsonSchemas =\n await missingJsonSchemaGenerator.generateMissingJsonSchemas(\n defaultModelsPaths,\n defaultJsonSchemas,\n arkosConfig\n );\n\n defaultJsonSchemas = {\n ...defaultJsonSchemas,\n ...missingJsonSchemas,\n ...generateSystemJsonSchemas(arkosConfig),\n };\n\n const swaggerConfigs = deepmerge(\n (await getSwaggerDefaultConfig(\n {\n ...defaultModelsPaths,\n ...fileUploadDefaultPaths,\n ...pathsFromCustomArkosRouters,\n },\n defaultJsonSchemas\n )) \|\| {},\n arkosConfig.swagger \|\| {}\n ) as ArkosConfig[\"swagger\"];\n\n const { definition, ...options } = swaggerConfigs?.options!;\n\n const swaggerSpecification = swaggerJsdoc({\n definition: definition as swaggerJsdoc.SwaggerDefinition,\n ...options,\n });\n\n const scalar = await importEsmPreventingTsTransformation(\n \"@scalar/express-api-reference\"\n );\n\n swaggerRouter.use(\n swaggerConfigs!.endpoint!,\n scalar.apiReference({\n content: swaggerSpecification,\n ...swaggerConfigs?.scalarApiReferenceConfiguration,\n })\n );\n\n return swaggerRouter;\n}\n"]}
1	+ {"version":3,"file":"swagger.router.js","sourceRoot":"","sources":["../../../../src/modules/swagger/swagger.router.ts"],"names":[],"mappings":";;;;;AAkBA,4CAyDC;AA3ED,qCAAiC;AACjC,kEAAyC;AAEzC,4FAA6D;AAC7D,mFAGgD;AAChD,oHAAwF;AACxF,8GAAkF;AAClF,uEAAyF;AACzF,uIAA4G;AAC5G,2DAAkE;AAElE,0HAA6F;AAE7F,MAAM,aAAa,GAAG,IAAA,gBAAM,GAAE,CAAC;AAExB,KAAK,UAAU,gBAAgB,CACpC,WAAwB,EACxB,GAAoB;IAEpB,IAAI,CAAC,kBAAkB,EAAE,kBAAkB,EAAE,2BAA2B,CAAC,GACvE,MAAM,OAAO,CAAC,GAAG,CAAC;QAChB,MAAM,IAAA,0DAAiC,EAAC,WAAW,CAAC;QACpD,MAAM,IAAA,+CAAsB,EAAC,WAAW,CAAC;QACzC,MAAM,IAAA,qCAAsB,EAAC,GAAG,CAAC;KAClC,CAAC,CAAC;IAEL,MAAM,sBAAsB,GAAG,IAAA,2CAA4B,EAAC,WAAW,CAAC,CAAC;IACzE,MAAM,kBAAkB,GACtB,MAAM,wCAA0B,CAAC,0BAA0B,CACzD,kBAAkB,EAClB,kBAAkB,EAClB,WAAW,CACZ,CAAC;IAEJ,kBAAkB,GAAG;QACnB,GAAG,kBAAkB;QACrB,GAAG,kBAAkB;QACrB,GAAG,IAAA,sCAAyB,EAAC,WAAW,CAAC;KAC1C,CAAC;IAEF,MAAM,cAAc,GAAG,IAAA,0BAAS,EAC9B,CAAC,MAAM,IAAA,qCAAuB,EAC5B;QACE,GAAG,kBAAkB;QACrB,GAAG,sBAAsB;QACzB,GAAG,2BAA2B;KAC/B,EACD,kBAAkB,CACnB,CAAC,IAAI,EAAE,EACR,WAAW,CAAC,OAAO,IAAI,EAAE,CACA,CAAC;IAE5B,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,EAAE,GAAG,cAAc,EAAE,OAAQ,CAAC;IAE5D,MAAM,oBAAoB,GAAG,IAAA,uBAAY,EAAC;QACxC,UAAU,EAAE,UAA4C;QACxD,GAAG,OAAO;KACX,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,MAAM,IAAA,oDAAmC,EACtD,+BAA+B,CAChC,CAAC;IAEF,aAAa,CAAC,GAAG,CACf,cAAe,CAAC,QAAS,EACzB,MAAM,CAAC,YAAY,CAAC;QAClB,OAAO,EAAE,oBAAoB;QAC7B,GAAG,cAAc,EAAE,+BAA+B;KACnD,CAAC,CACH,CAAC;IAEF,OAAO,aAAa,CAAC;AACvB,CAAC","sourcesContent":["import { Router } from \"express\";\nimport swaggerJsdoc from \"swagger-jsdoc\";\nimport { ArkosConfig } from \"../../types/arkos-config\";\nimport deepmerge from \"../../utils/helpers/deepmerge.helper\";\nimport {\n generatePathsForModels,\n getOpenAPIJsonSchemasByConfigMode,\n} from \"./utils/helpers/swagger.router.helpers\";\nimport missingJsonSchemaGenerator from \"./utils/helpers/missing-json-schemas-generator\";\nimport getSwaggerDefaultConfig from \"./utils/helpers/get-swagger-default-configs\";\nimport { importEsmPreventingTsTransformation } from \"../../utils/helpers/global.helpers\";\nimport generateSystemJsonSchemas from \"./utils/helpers/json-schema-generators/generate-system-json-schemas\";\nimport { generateOpenAPIFromApp } from \"../../utils/arkos-router\";\nimport express from \"express\";\nimport getFileUploadJsonSchemaPaths from \"./utils/helpers/get-file-upload-json-schema-paths\";\n\nconst swaggerRouter = Router();\n\nexport async function getSwaggerRouter(\n arkosConfig: ArkosConfig,\n app: express.Express\n): Promise<Router> {\n let [defaultJsonSchemas, defaultModelsPaths, pathsFromCustomArkosRouters] =\n await Promise.all([\n await getOpenAPIJsonSchemasByConfigMode(arkosConfig),\n await generatePathsForModels(arkosConfig),\n await generateOpenAPIFromApp(app),\n ]);\n\n const fileUploadDefaultPaths = getFileUploadJsonSchemaPaths(arkosConfig);\n const missingJsonSchemas =\n await missingJsonSchemaGenerator.generateMissingJsonSchemas(\n defaultModelsPaths,\n defaultJsonSchemas,\n arkosConfig\n );\n\n defaultJsonSchemas = {\n ...defaultJsonSchemas,\n ...missingJsonSchemas,\n ...generateSystemJsonSchemas(arkosConfig),\n };\n\n const swaggerConfigs = deepmerge(\n (await getSwaggerDefaultConfig(\n {\n ...defaultModelsPaths,\n ...fileUploadDefaultPaths,\n ...pathsFromCustomArkosRouters,\n },\n defaultJsonSchemas\n )) \|\| {},\n arkosConfig.swagger \|\| {}\n ) as ArkosConfig[\"swagger\"];\n\n const { definition, ...options } = swaggerConfigs?.options!;\n\n const swaggerSpecification = swaggerJsdoc({\n definition: definition as swaggerJsdoc.SwaggerDefinition,\n ...options,\n });\n\n const scalar = await importEsmPreventingTsTransformation(\n \"@scalar/express-api-reference\"\n );\n\n swaggerRouter.use(\n swaggerConfigs!.endpoint!,\n scalar.apiReference({\n content: swaggerSpecification,\n ...swaggerConfigs?.scalarApiReferenceConfiguration,\n })\n );\n\n return swaggerRouter;\n}\n"]}

package/dist/cjs/types/arkos-config.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"arkos-config.js","sourceRoot":"","sources":["../../../src/types/arkos-config.ts"],"names":[],"mappings":"","sourcesContent":["import http from \"http\";\nimport cors from \"cors\";\nimport express from \"express\";\nimport { Options as RateLimitOptions } from \"express-rate-limit\";\nimport cookieParser from \"cookie-parser\";\nimport compression from \"compression\";\nimport { Options as QueryParserOptions } from \"../utils/helpers/query-parser.helpers\";\nimport { ValidatorOptions } from \"class-validator\";\nimport { MsDuration } from \"../modules/auth/utils/helpers/auth.controller.helpers\";\nimport { OpenAPIV3 } from \"openapi-types\";\nimport type { ApiReferenceConfiguration } from \"@scalar/express-api-reference\" with { \"resolution-mode\": \"import\" };\nimport nodemailer from \"nodemailer\";\nimport { ModuleComponents } from \"../utils/dynamic-loader\";\n/*\n Defines the initial configs of the api to be loaded at startup when arkos.init() is called.\n /\nexport type ArkosConfig = {\n /\n Allows to configure request configs\n /\n request?: {\n /\n Allows to configure request parameters\n /\n parameters?: {\n /\n Toggles allowing `VERY DANGEROUS` request paramateres under `req.query` for passing prisma query options.\n \n See more\n /\n allowDangerousPrismaQueryOptions?: boolean;\n };\n };\n /* Message you would like to send, as Json and 200 response when\n * ```curl\n * GET /api\n * ```\n \n ```json\n * { \"message\": \"Welcome to YourAppName\" }\n * ```\n \n default message is: Welcome to our Rest API generated by Arkos, find more about Arkos at www.arkosjs.com.\n \n \n * /\n welcomeMessage?: string;\n /\n Port where the application will run, can be set in 3 ways:\n \n 1. default is 8000\n * 2. PORT under environment variables (Lower precedence)\n * 3. this config option (Higher precedence)\n /\n port?: number \| undefined;\n /\n Allows to listen on a different host than localhost only\n /\n host?: string;\n /\n Defines authentication related configurations, by default is undefined.\n \n See [www.arkosjs.com/docs/core-concepts/authentication-system](https://www.arkosjs.com/docs/core-concepts/authentication-system) for details.\n /\n authentication?: {\n /\n Defines whether to use Static or Dynamic Role-Based Acess Control\n \n Visit [www.arkosjs.com/docs/core-concepts/authentication-system](https://www.arkosjs.com/docs/core-concepts/authentication-system) for more details.\n /\n mode: \"static\" \| \"dynamic\";\n /\n Defines auth login related configurations to customize the api.\n /\n login?: {\n /\n Defines the field that will be used as username by the built-in auth system, by default arkos will look for the field \"username\" in your model User, hence when making login for example you must send:\n \n ```json\n * {\n * \"username\": \"johndoe\",\n * \"password\": \"somePassword123\"\n * }\n * ```\n \n Note: You can also modify the usernameField on the fly by passing it to the request query parameters. example:\n \n ```curl\n * POST /api/auth/login?usernameField=email\n * ```\n \n See more at [www.arkosjs.com/docs/core-concepts/authentication-system#login-with-different-fileds](https://www.arkosjs.com/docs/core-concepts/authentication-system#login-with-different-fileds)\n \n By specifing here another field for username, for example passing \"email\", \"companyCode\" or something else your json will be like:\n \n Example with email\n \n ```json\n * {\n * \"email\": \"john.doe@example.com\",\n * \"password\": \"somePassword123\"\n * }\n * ```\n /\n allowedUsernames?: string[];\n /* Defines wether to send the access token in response after login or only send as cookie, defeault is both./\n sendAccessTokenThrough?: \"cookie-only\" \| \"response-only\" \| \"both\";\n };\n /\n Specifies the regex pattern used by the authentication system to enforce password strength requirements.\n \n Important: If using validation libraries like Zod or class-validator, this will be completely overwritten.\n \n Default: ```/^(?=.[A-Z])(?=.[a-z])(?=.\\d).+$/``` - Ensures the password contains at least one uppercase letter, one lowercase letter, and one numeric digit.\n \n * message: (Optional) A custom error message to display when the password does not meet the required strength criteria.\n /\n passwordValidation?: { regex: RegExp; message?: string };\n /\n Allows to specify the request rate limit for all authentication endpoints but `/api/users/me`.\n * \n * #### Default\n {\n windowMs: 5000,\n limit: 10,\n standardHeaders: \"draft-7\",\n legacyHeaders: false,\n }\n \n * Passing an object not overriding all the default options will only\n * cause it to be deepmerged and not actually replace with empty fields\n * \n @see This is are the options used on the `express-rate-limit` npm package used on epxress. read more about [https://www.npmjs.com/package/express-rate-limit](https://www.npmjs.com/package/express-rate-limit)\n /\n requestRateLimitOptions?: Partial<RateLimitOptions>;\n /*\n JWT (JSON Web Token) authentication configuration.\n \n You can override these values directly in code, or use environment variables:\n \n - `JWT_SECRET`: Secret used to sign and verify JWT tokens.\n * - `JWT_EXPIRES_IN`: Duration string or number indicating when the token should expire (e.g. \"30d\", 3600).\n * - `JWT_COOKIE_SECURE`: Whether the cookie is sent only over HTTPS. Default: `true` in production.\n * - `JWT_COOKIE_HTTP_ONLY`: Whether the cookie is HTTP-only. Default: `true`.\n * - `JWT_COOKIE_SAME_SITE`: Can be \"lax\", \"strict\", or \"none\". Defaults to \"lax\" in dev, \"none\" in prod.\n \n ⚠️ Values passed here take precedence over environment variables.\n /\n jwt?: {\n /* Secret key used for signing and verifying JWT tokens /\n secret?: string;\n /\n Duration after which the JWT token expires.\n * Accepts either a duration string (e.g. \"30d\", \"1h\") or a number in milliseconds.\n * Defaults to \"30d\" if not provided.\n /\n expiresIn?: MsDuration \| number;\n\n /\n Configuration for the JWT cookie sent to the client\n /\n cookie?: {\n /\n Whether the cookie should be marked as secure (sent only over HTTPS).\n * Defaults to `true` in production and `false` in development.\n /\n secure?: boolean;\n\n /\n Whether the cookie should be marked as HTTP-only.\n * Default is `true` to prevent access via JavaScript.\n /\n httpOnly?: boolean;\n\n /\n Controls the SameSite attribute of the cookie.\n * Defaults to \"none\" in production and \"lax\" in development.\n * Options: \"lax\" \| \"strict\" \| \"none\"\n /\n sameSite?: \"lax\" \| \"strict\" \| \"none\";\n };\n };\n };\n /* Allows to customize and toggle the built-in validation, by default it is set to `false`. If true is passed it will use validation with the default resolver set to `class-validator` if you intend to change the resolver to `zod` do the following:\n \n ```ts\n * // src/app.ts\n * import arkos from 'arkos'\n \n arkos.init({\n * validation: {\n * resolver: \"zod\"\n * }\n * })\n * ```\n \n @See [www.arkosjs.com/docs/core-concepts/request-data-validation](https://www.arkosjs.com/docs/core-concepts/request-data-validation) for more details.\n /\n validation?: {\n /\n Defines whether to use strict request validation, it means in every request using `ArkosRouter()` you must pass the validation options with all options (e.g: query, params, body, etc.).\n \n How It Works:\n * - If it is true, Arkos will require all the options a stated above on the routes and if you don't pass it will throw an error.\n * What if you don't want to pass a validator to some options?\n * - You will need to pass `undefined` to the validator option (see example below), this way Arkos will throw an error if something is passed to `req.query` if you passed undefined as validator into `validation.query`\n \n ```ts\n * import { ArkosRouter } from \"arkos\"\n \n const router = ArkosRouter()\n \n router.get({\n * route: \"/api/posts\",\n * validation: {\n * query: undefined\n * }\n * })\n \n ```\n /\n strict?: boolean;\n } & (\n \| {\n resolver?: \"class-validator\";\n /\n ValidatorOptions to used while validating request data.\n \n Default:\n * ```ts\n * {\n * whitelist: true\n * }\n * ```\n /\n validationOptions?: ValidatorOptions;\n }\n \| {\n resolver?: \"zod\";\n validationOptions?: Record<string, any>;\n }\n );\n /\n Defines file upload configurations\n \n See [www.arkosjs.com/docs/core-concepts/file-upload#costum-configurations](https://www.arkosjs.com/docs/core-concepts/file-upload#costum-configurations)\n /\n fileUpload?: {\n /\n Defiens the base file upload directory, default is set to /uploads (on root directory)\n \n When setting up a path dir always now that root directory will be the starting reference.\n \n #### Example\n * passing `../my-arkos-uploaded-files`\n \n Will save uploaded files one level outside the root dir inside `my-arkos-uploaded-files`\n \n NB: You must be aware of permissions on your server to acess files outside your project directory.\n \n /\n baseUploadDir?: string;\n /*\n Changes the default `/api/uploads` base route for accessing file upload route.\n \n #### IMPORTANT\n * Changing this will not affect the `baseUploadDir` folder. You can\n * pass here `/api/files/my-user-files` and `baseUploadDir` be `/uploaded-files`.\n \n /\n baseRoute?: string;\n /*\n Defines options for `express.static(somePath, someOptions)`\n \n #### Default:\n \n ```ts\n {\n maxAge: \"1y\",\n etag: true,\n lastModified: true,\n dotfiles: \"ignore\",\n fallthrough: true,\n index: false,\n cacheControl: true,\n }\n ```\n * \n * By passing your custom options have in mind that it\n * will be deepmerged with the default.\n * \n * Visit [https://expressjs.com/en/4x/api.html#express.static](https://expressjs.com/en/4x/api.html#express.static) for more understanding.\n * \n /\n expressStaticOptions?: Parameters<typeof express.static>[1];\n /\n Defines upload restrictions for each file type: image, video, document or other.\n \n #### Important:\n * Passing an object without overriding everything will only cause it\n * to be deepmerged with the default options.\n \n See [www.arkosjs.com/docs/api-reference/default-supported-upload-files](https://www.arkosjs.com/docs/api-reference/default-supported-upload-files) for detailed explanation about default values.\n * ```\n /\n restrictions?: {\n images?: {\n maxCount?: number;\n maxSize?: number;\n supportedFilesRegex?: RegExp;\n };\n videos?: {\n maxCount?: number;\n maxSize?: number;\n supportedFilesRegex?: RegExp;\n };\n documents?: {\n maxCount?: number;\n maxSize?: number;\n supportedFilesRegex?: RegExp;\n };\n files?: {\n maxCount?: number;\n maxSize?: number;\n supportedFilesRegex?: RegExp;\n };\n };\n };\n /\n Allows to specify the request rate limit for all endpoints.\n * \n * #### Default\n ```ts\n {\n windowMs: 60 * 1000,\n limit: 1000,\n standardHeaders: \"draft-7\",\n legacyHeaders: false,\n }\n ```\n * \n * Passing an object not overriding all the default options will only\n * cause it to be deepmerged and not actually replace with empty fields\n * \n * This is are the options used on the `express-rate-limit` npm package used on epxress. read more about [https://www.npmjs.com/package/express-rate-limit](https://www.npmjs.com/package/express-rate-limit)\n /\n globalRequestRateLimitOptions?: Partial<RateLimitOptions>;\n /\n Defines options for the built-in express.json() middleware\n * Nothing is passed by default.\n /\n jsonBodyParserOptions?: Parameters<typeof express.json>[0];\n /\n Allows to pass paremeters to cookieParser from npm package cookie-parser\n * Nothing is passed by default.\n \n See [www.npmjs.com/package/cookie-parser](https://www.npmjs.com/package/cookie-parser) for further details.\n /\n cookieParserParameters?: Parameters<typeof cookieParser>;\n /\n Allows to define options for npm package compression\n * Nothing is passed by default.\n \n See [www.npmjs.com/package/compression](https://www.npmjs.com/package/compression) for further details.\n /\n compressionOptions?: compression.CompressionOptions;\n /\n Options to define how query must be parsed.\n \n #### for example:\n * ```\n * GET /api/product?saleId=null\n * ```\n \n Normally would parsed to { saleId: \"null\" } so query parser\n * trough setting option `parseNull` will transform { saleId: null }\n * \n * #### Default:\n * \n * {\n parseNull: true,\n parseUndefined: true,\n parseBoolean: true,\n }\n * \n * parseNumber may convert fields that are string but you only passed\n * numbers to query pay attention to this.\n * \n * Soon a feature to converted the query to the end prisma type will be added.\n /\n queryParserOptions?: QueryParserOptions;\n /\n Configuration for CORS (Cross-Origin Resource Sharing).\n \n @property {string \| string[] \| \"all\"} [allowedOrigins] - List of allowed origins. If set to `\"all\"`, all origins are accepted.\n * @property {import('cors').CorsOptions} [options] - Additional CORS options passed directly to the `cors` middleware.\n * @property {import('cors').CorsOptionsDelegate} [customMiddleware] - A custom middleware function that overrides the default behavior.\n \n @remarks\n * If `customMiddleware` is provided, both `allowedOrigins` and `options` will be ignored in favor of the custom logic.\n \n See https://www.npmjs.com/package/cors\n /\n cors?: {\n /\n Defines allowed origins to acess the API.\n /\n allowedOrigins?: string \| string[] \| \"\";\n options?: cors.CorsOptions;\n /*\n If you would like to override the entire middleware\n \n see\n /\n customHandler?: cors.CorsOptionsDelegate;\n };\n /\n Defines express/arkos middlewares configurations\n /\n middlewares?: {\n /\n Allows to add an array of custom express middlewares into the default middleware stack.\n \n Tip: If you would like to acess the express app before everthing use `configureApp` and pass a function.\n \n Where will these be placed?: see [www.arkosjs.com/docs/advanced-guide/replace-or-disable-built-in-middlewares#middleware-execution-order](https://www.arkosjs.com/docs/advanced-guide/replace-or-disable-built-in-middlewares#middleware-execution-order)\n \n Note: If you want to use custom global error handler middleware use `middlewares.replace.globalErrorHandler`.\n \n Read more about The Arkos Middleware Stack at [www.arkosjs.com/docs/the-middleware-stack](https://www.arkosjs.com/docs/the-middleware-stack) for in-depth details.\n /\n additional?: express.RequestHandler[];\n /\n An array containing a list of defaults middlewares to be disabled\n \n Caution: Be careful with this because you may endup breaking your entire application.\n \n /\n disable?: (\n \| \"compression\"\n \| \"global-rate-limit\"\n \| \"auth-rate-limit\"\n \| \"cors\"\n \| \"express-json\"\n \| \"cookie-parser\"\n \| \"query-parser\"\n \| \"request-logger\"\n \| \"global-error-handler\"\n )[];\n /*\n Allows you to replace each of the built-in middlewares with your own implementation\n \n Caution: Be careful with this because you may endup breaking your entire application.\n /\n replace?: {\n /\n Replace the default compression middleware\n /\n compression?: express.RequestHandler;\n /\n Replace the default global rate limit middleware\n /\n globalRateLimit?: express.RequestHandler;\n /\n Replace the default authentication rate limit middleware\n /\n authRateLimit?: express.RequestHandler;\n /\n Replace the default CORS middleware\n /\n cors?: express.RequestHandler;\n /\n Replace the default JSON body parser middleware\n /\n expressJson?: express.RequestHandler;\n /\n Replace the default cookie parser middleware\n /\n cookieParser?: express.RequestHandler;\n /\n Replace the default query parser middleware\n /\n queryParser?: express.RequestHandler;\n /\n Replace the default request logger middleware\n /\n requestLogger?: express.RequestHandler;\n /\n Replace the default global error handler middleware\n /\n globalErrorHandler?: express.ErrorRequestHandler;\n };\n };\n /\n Defines express/arkos routers configurations\n /\n routers?: {\n /\n Strict mode configuration for routing security\n \n @default false\n * - all CRUD + Auth (if using auth) endpoits are enabled and avialable by default.\n \n When enabled:\n * - If `true`: All CRUD endpoints start disabled and must be explicitly enabled\n * in each model's router configuration\n * - If `'no-bulk'`: Bulk operations (createMany, updateMany, deleteMany) are disabled\n * by default, while individual operations can be enabled per model\n \n This provides enhanced security by ensuring no routes are accidentally exposed.\n * Use this in production environments to follow the principle of least privilege.\n \n See documentation: https://www.arkosjs.com/docs/guide/security#strict-mode\n /\n strict?: boolean \| \"no-bulk\";\n /\n Allows to add an array of custom express routers into the default middleware/router stack.\n \n Where will these be placed?: see [www.arkosjs.com/docs/advanced-guide/adding-custom-routers](https://www.arkosjs.com/docs/advanced-guide/adding-custom-routers)\n \n \n * Read more about The Arkos Middleware Stack at [www.arkosjs.com/docs/the-middleware-stack](https://www.arkosjs.com/docs/the-middleware-stack) for in-depth details.\n /\n additional?: express.Router[];\n disable?: (\n \| \"auth-router\"\n \| \"prisma-models-router\"\n \| \"file-upload\"\n \| \"welcome-endpoint\"\n )[];\n /\n Allows you to replace each of the built-in routers with your own implementation.\n \n Note: Doing this you will lose all default middleware chaining, auth control, handlers from the specific router.\n \n Tip: I you want to disable some prisma models specific endpoint\n * see [www.arkosjs.com/docs/guide/adding-custom-routers#disabling-auto-generated-endpoints](https://www.arkosjs.com/docs/guide/adding-custom-routers#disabling-auto-generated-endpoints)\n \n Caution: Be careful with this because you may endup breaking your entire application.\n /\n replace?: {\n /\n Replace the default authentication router\n * @param config The original Arkos configuration\n * @returns A router handling authentication endpoints\n /\n authRouter?: (\n config: ArkosConfig\n ) => express.Router \| Promise<express.Router>;\n /\n Replace the default Prisma models router\n * @param config The original Arkos configuration\n * @returns A router handling Prisma model endpoints\n /\n prismaModelsRouter?: (\n config: ArkosConfig\n ) => express.Router \| Promise<express.Router>;\n /\n Replace the default file upload router\n * @param config The original Arkos configuration\n * @returns A router handling file upload endpoints\n /\n fileUpload?: (\n config: ArkosConfig\n ) => express.Router \| Promise<express.Router>;\n /\n Replace the default welcome endpoint handler\n * @param req Express request object\n * @param res Express response object\n * @param next Express next function\n /\n welcomeEndpoint?: express.RequestHandler;\n };\n };\n /\n Gives acess to the underlying express app so that you can add custom configurations beyong Arkos customization capabilities\n \n Note: In the end Arkos will call `app.listen` for you.\n \n If you want to call `app.listen` by yourself pass port as `undefined` and then use the return app from `arkos.init()`.\n \n See how to call `app.listen` correctly [www.arkosjs.com/docs/guide/accessing-the-express-app#calling-applisten-by-yourself](https://www.arkosjs.com/docs/guide/accessing-the-express-app#calling-applisten-by-yourself)\n \n See [www.arkosjs.com/docs/guide/accessing-the-express-app](https://www.arkosjs.com/docs/guide/accessing-the-express-app) for further details on the method configureApp.\n \n @param {express.Express} app\n * @returns {any}\n /\n configureApp?: (app: express.Express) => Promise<any> \| any;\n /\n Gives access to the underlying HTTP server so that you can add custom configurations beyond Arkos customization capabilities\n \n Note: In the end Arkos will call `server.listen` for you.\n \n If you want to call `server.listen` by yourself pass port as `undefined` and then use the return server from `arkos.init()`.\n \n See how to call `server.listen` correctly [www.arkosjs.com/docs/guide/accessing-the-express-app#creating-your-own-http-server](https://www.arkosjs.com/docs/guide/accessing-the-express-app#creating-your-own-http-server)\n \n See [www.arkosjs.com/docs/guide/accessing-the-express-app#accessing-the-http-server](https://www.arkosjs.com/docs/guide/accessing-the-express-app#accessing-the-http-server) for further details on the method configureServer.\n \n @param {http.Server} server - The HTTP server instance\n * @returns {any}\n /\n configureServer?: (server: http.Server) => Promise<any> \| any;\n /\n Allows to configure email configurations for sending emails through `emailService`\n \n See [www.arkosjs.com/docs/core-concepts/sending-emails](https://www.arkosjs.com/docs/core-concepts/sending-emails)\n /\n email?: {\n /\n Email name to used like:\n \n John Doe\\<john.doe@gmail.com>\n /\n name?: string;\n /\n Your email provider url\n /\n host: string;\n /\n Email provider SMTP port, Default is `465`\n /\n port?: number;\n /\n If smtp connection must be secure, Default is `true`\n /\n secure?: boolean;\n /\n Used to authenticate in your smtp server\n /\n auth: {\n /\n Email used for auth as well as sending emails\n /\n user: string;\n /\n Your SMTP password\n /\n pass: string;\n };\n } & Parameters<typeof nodemailer.createTransport>[0];\n /\n Defines Swagger and OpenApi specifications for auto generating swagger documentation UI using whether it is Prisma Schemas, Class-validator DTOs, Zod Schemas or JSON-Schemas.\n \n Important: Is worth mentioning that this works alongside `@scalar/express-api-reference` npm package, you define it's ApiReferenceConfiguration under ``. also consider checking the package documentation at []\n \n Usage\n \n ```ts\n * // src/app.ts\n \n import arkos from \"arkos\"\n \n arkos.init({\n * // other configs\n * swagger: {\n * mode: \"zod\",\n * options: {\n * defintion: {\n * info: {\n * openapi: \"3.0.0\",\n * title: \"API Generated By Arkos.js\",\n * description: \"This API was automatically generated by Arkos.js read more about at www.arkosjs.com\"\n * }\n * }\n * }\n * }\n * })\n * ```\n * @see {@link https://www.arkosjs.com/docs/core-concepts/swagger-api-documentation}\n /\n swagger?: {\n /\n By default Arkos will disable API Documentation when the project is built `npm run build`, it does not matter what node environment is set. If you want to use it even after the `arkos build` command just set this to `true`.\n * /\n enableAfterBuild?: boolean;\n /\n Endpoint where the Swagger UI will be available.\n \n @default \"/api/api-docs\"\n /\n endpoint?: string;\n /\n Determines how your API schemas should be generated.\n \n - \"prisma\": Generates schemas based on Prisma models\n * - \"class-validator\": Uses class-validator and class-transformer DTO classes\n * - \"zod\": Uses OpenAPI-compliant schemas directly\n /\n mode: \"prisma\" \| \"class-validator\" \| \"zod\";\n /\n Allows `Arkos.js` to fallback to prisma schema and use them as json schema for defining request body and response data\n * when a given zod Schema or class-validator Class is not found to be transformed to json schema.\n \n @default false\n /\n strict?: boolean;\n /\n Defines your swagger configurations\n /\n options?: {\n /\n Swagger definition according to OpenAPI Specification.\n /\n definition?: {\n /\n OpenAPI version.\n \n @default \"3.0.0\"\n /\n openapi?: string;\n\n /\n Information about your API.\n /\n info?: {\n /\n Title of the API documentation.\n \n \n * @example \"My API\"\n \n @default \"API Generated By Arkos.js\"\n /\n title?: string;\n\n /\n Version of the API.\n \n @example \"1.0.0\"\n /\n version?: string;\n\n /\n Description of the API.\n \n @default \"This API was automatically generated by Arkos.js read more about at www.arkosjs.com\"\n /\n description?: string;\n };\n\n /\n Server configurations for the API.\n \n @default [{ url: \"http://localhost:8000\", description: \"Development server\" }]\n \n This can be overridden automatically by Arkos based on CLI, .env, or `arkos.init()`.\n /\n servers?: {\n /\n Base URL of the server.\n \n @example \"http://localhost:8000\"\n /\n url: string;\n\n /\n Human-readable description of the server.\n \n @example \"Development Server\"\n /\n description?: string;\n }[];\n /\n Allows adding more paths for your OpenAPI documentation\n \n /\n paths?: OpenAPIV3.PathsObject;\n /\n (Optional) Additional metadata such as terms of service, contact, or license.\n \n See: https://swagger.io/specification/#infoObject\n /\n termsOfService?: string;\n contact?: {\n name?: string;\n url?: string;\n email?: string;\n };\n license?: {\n name: string;\n url?: string;\n };\n\n /\n Tags to group and describe endpoints.\n /\n tags?: {\n name: string;\n description?: string;\n }[];\n\n /\n Security definitions (e.g., Bearer Auth).\n /\n components?: {\n securitySchemes?: Record<string, any>;\n schemas?: Record<string, any>;\n };\n\n /\n Global security requirements.\n /\n security?: Array<Record<string, string[]>>;\n };\n\n /\n Glob patterns defining where Swagger should look for API route definitions and comments.\n \n @default \n * ```ts\n * [\"./src/routers/.router.{ts,js}\", \"./src/modules/\\/.router.{ts,js}\"]\n ```\n \n Adjust depending on TypeScript or JavaScript usage.\n /\n apis?: string[];\n\n /\n Enables deep linking in the Swagger UI.\n \n @default true\n /\n deepLinking?: boolean;\n\n /\n Enable/disable the \"Try it out\" button globally.\n \n @default true\n /\n tryItOutEnabled?: boolean;\n\n /\n Whether to persist authorization data across page reloads.\n \n @default false\n /\n persistAuthorization?: boolean;\n };\n /\n Custom `@scalar/express-api-reference` package options.\n \n @see {@link https://guides.scalar.com/scalar/scalar-api-references/integrations/express}\n /\n scalarApiReferenceConfiguration?: Partial<ApiReferenceConfiguration>;\n };\n /\n Helps in debugging some of the variables values that are used inside arkos from dynamic loaded components towhat is used into the generated api.\n \n /\n debugging?: {\n /*\n Controls debugging over HTTP request level\n /\n requests?: {\n level?: 0 \| 1 \| 2 \| 3;\n filter?: (\n \| \"Query\"\n \| \"Body\"\n \| \"Params\"\n \| \"TransformedQuery\"\n \| \"ServiceArgs\"\n \| \"FinalPrismaQueryArgs\"\n )[];\n };\n /\n Controls debugging over the dynamic loaded modules and it's components on app starting\n /\n dynamicLoader?: {\n /\n Adjusts logging details\n \n 1 - Loaded modules and list of it's components files\n * 2 - All from 1 and detailed inspection per module component\n * 3 - All from 1 and 2, plus the final router component after merged with autho generated router.\n /\n level?: 0 \| 1 \| 2 \| 3;\n filters?: {\n /\n Allows filtering by specific modules.\n \n Supports only searching for the starting parts of the module name, e.g: If there is`user-profile`, `user`, `posts`, passing `[\"user\"]` will match both `user-profile` and `user`.\n /\n modules?: string[];\n /\n Allows filtering by component's names\n */\n components?: keyof ModuleComponents[];\n };\n };\n };\n};\n"]}
1	+ {"version":3,"file":"arkos-config.js","sourceRoot":"","sources":["../../../src/types/arkos-config.ts"],"names":[],"mappings":"","sourcesContent":["import http from \"http\";\nimport cors from \"cors\";\nimport express from \"express\";\nimport { Options as RateLimitOptions } from \"express-rate-limit\";\nimport cookieParser from \"cookie-parser\";\nimport compression from \"compression\";\nimport { Options as QueryParserOptions } from \"../utils/helpers/query-parser.helpers\";\nimport { ValidatorOptions } from \"class-validator\";\nimport { MsDuration } from \"../modules/auth/utils/helpers/auth.controller.helpers\";\nimport { OpenAPIV3 } from \"openapi-types\";\nimport type { ApiReferenceConfiguration } from \"@scalar/express-api-reference\" with { \"resolution-mode\": \"import\" };\nimport nodemailer from \"nodemailer\";\nimport { ModuleComponents } from \"../utils/dynamic-loader\";\nimport { IArkosRouter } from \"../utils/arkos-router/types\";\n/*\n Defines the initial configs of the api to be loaded at startup when arkos.init() is called.\n /\nexport type ArkosConfig = {\n /\n Allows to configure request configs\n /\n request?: {\n /\n Allows to configure request parameters\n /\n parameters?: {\n /\n Toggles allowing `VERY DANGEROUS` request paramateres under `req.query` for passing prisma query options.\n \n See more\n /\n allowDangerousPrismaQueryOptions?: boolean;\n };\n };\n /* Message you would like to send, as Json and 200 response when\n * ```curl\n * GET /api\n * ```\n \n ```json\n * { \"message\": \"Welcome to YourAppName\" }\n * ```\n \n default message is: Welcome to our Rest API generated by Arkos, find more about Arkos at www.arkosjs.com.\n \n \n * /\n welcomeMessage?: string;\n /\n Port where the application will run, can be set in 3 ways:\n \n 1. default is 8000\n * 2. PORT under environment variables (Lower precedence)\n * 3. this config option (Higher precedence)\n /\n port?: number \| undefined;\n /\n Allows to listen on a different host than localhost only\n /\n host?: string;\n /\n Defines authentication related configurations, by default is undefined.\n \n See [www.arkosjs.com/docs/core-concepts/authentication-system](https://www.arkosjs.com/docs/core-concepts/authentication-system) for details.\n /\n authentication?: {\n /\n Defines whether to use Static or Dynamic Role-Based Acess Control\n \n Visit [www.arkosjs.com/docs/core-concepts/authentication-system](https://www.arkosjs.com/docs/core-concepts/authentication-system) for more details.\n /\n mode: \"static\" \| \"dynamic\";\n /\n Defines auth login related configurations to customize the api.\n /\n login?: {\n /\n Defines the field that will be used as username by the built-in auth system, by default arkos will look for the field \"username\" in your model User, hence when making login for example you must send:\n \n ```json\n * {\n * \"username\": \"johndoe\",\n * \"password\": \"somePassword123\"\n * }\n * ```\n \n Note: You can also modify the usernameField on the fly by passing it to the request query parameters. example:\n \n ```curl\n * POST /api/auth/login?usernameField=email\n * ```\n \n See more at [www.arkosjs.com/docs/core-concepts/authentication-system#login-with-different-fileds](https://www.arkosjs.com/docs/core-concepts/authentication-system#login-with-different-fileds)\n \n By specifing here another field for username, for example passing \"email\", \"companyCode\" or something else your json will be like:\n \n Example with email\n \n ```json\n * {\n * \"email\": \"john.doe@example.com\",\n * \"password\": \"somePassword123\"\n * }\n * ```\n /\n allowedUsernames?: string[];\n /* Defines wether to send the access token in response after login or only send as cookie, defeault is both./\n sendAccessTokenThrough?: \"cookie-only\" \| \"response-only\" \| \"both\";\n };\n /\n Specifies the regex pattern used by the authentication system to enforce password strength requirements.\n \n Important: If using validation libraries like Zod or class-validator, this will be completely overwritten.\n \n Default: ```/^(?=.[A-Z])(?=.[a-z])(?=.\\d).+$/``` - Ensures the password contains at least one uppercase letter, one lowercase letter, and one numeric digit.\n \n * message: (Optional) A custom error message to display when the password does not meet the required strength criteria.\n /\n passwordValidation?: { regex: RegExp; message?: string };\n /\n Allows to specify the request rate limit for all authentication endpoints but `/api/users/me`.\n * \n * #### Default\n {\n windowMs: 5000,\n limit: 10,\n standardHeaders: \"draft-7\",\n legacyHeaders: false,\n }\n \n * Passing an object not overriding all the default options will only\n * cause it to be deepmerged and not actually replace with empty fields\n * \n @see This is are the options used on the `express-rate-limit` npm package used on epxress. read more about [https://www.npmjs.com/package/express-rate-limit](https://www.npmjs.com/package/express-rate-limit)\n /\n requestRateLimitOptions?: Partial<RateLimitOptions>;\n /*\n JWT (JSON Web Token) authentication configuration.\n \n You can override these values directly in code, or use environment variables:\n \n - `JWT_SECRET`: Secret used to sign and verify JWT tokens.\n * - `JWT_EXPIRES_IN`: Duration string or number indicating when the token should expire (e.g. \"30d\", 3600).\n * - `JWT_COOKIE_SECURE`: Whether the cookie is sent only over HTTPS. Default: `true` in production.\n * - `JWT_COOKIE_HTTP_ONLY`: Whether the cookie is HTTP-only. Default: `true`.\n * - `JWT_COOKIE_SAME_SITE`: Can be \"lax\", \"strict\", or \"none\". Defaults to \"lax\" in dev, \"none\" in prod.\n \n ⚠️ Values passed here take precedence over environment variables.\n /\n jwt?: {\n /* Secret key used for signing and verifying JWT tokens /\n secret?: string;\n /\n Duration after which the JWT token expires.\n * Accepts either a duration string (e.g. \"30d\", \"1h\") or a number in milliseconds.\n * Defaults to \"30d\" if not provided.\n /\n expiresIn?: MsDuration \| number;\n\n /\n Configuration for the JWT cookie sent to the client\n /\n cookie?: {\n /\n Whether the cookie should be marked as secure (sent only over HTTPS).\n * Defaults to `true` in production and `false` in development.\n /\n secure?: boolean;\n\n /\n Whether the cookie should be marked as HTTP-only.\n * Default is `true` to prevent access via JavaScript.\n /\n httpOnly?: boolean;\n\n /\n Controls the SameSite attribute of the cookie.\n * Defaults to \"none\" in production and \"lax\" in development.\n * Options: \"lax\" \| \"strict\" \| \"none\"\n /\n sameSite?: \"lax\" \| \"strict\" \| \"none\";\n };\n };\n };\n /* Allows to customize and toggle the built-in validation, by default it is set to `false`. If true is passed it will use validation with the default resolver set to `class-validator` if you intend to change the resolver to `zod` do the following:\n \n ```ts\n * // src/app.ts\n * import arkos from 'arkos'\n \n arkos.init({\n * validation: {\n * resolver: \"zod\"\n * }\n * })\n * ```\n \n @See [www.arkosjs.com/docs/core-concepts/request-data-validation](https://www.arkosjs.com/docs/core-concepts/request-data-validation) for more details.\n /\n validation?: {\n /\n Defines whether to use strict request validation, it means in every request using `ArkosRouter()` you must pass the validation options with all options (e.g: query, params, body, etc.).\n \n How It Works:\n * - If it is true, Arkos will require all the options a stated above on the routes and if you don't pass it will throw an error.\n * What if you don't want to pass a validator to some options?\n * - You will need to pass `undefined` to the validator option (see example below), this way Arkos will throw an error if something is passed to `req.query` if you passed undefined as validator into `validation.query`\n \n ```ts\n * import { ArkosRouter } from \"arkos\"\n \n const router = ArkosRouter()\n \n router.get({\n * route: \"/api/posts\",\n * validation: {\n * query: undefined\n * }\n * })\n \n ```\n /\n strict?: boolean;\n } & (\n \| {\n resolver?: \"class-validator\";\n /\n ValidatorOptions to used while validating request data.\n \n Default:\n * ```ts\n * {\n * whitelist: true\n * }\n * ```\n /\n validationOptions?: ValidatorOptions;\n }\n \| {\n resolver?: \"zod\";\n validationOptions?: Record<string, any>;\n }\n );\n /\n Defines file upload configurations\n \n See [www.arkosjs.com/docs/core-concepts/file-upload#costum-configurations](https://www.arkosjs.com/docs/core-concepts/file-upload#costum-configurations)\n /\n fileUpload?: {\n /\n Defiens the base file upload directory, default is set to /uploads (on root directory)\n \n When setting up a path dir always now that root directory will be the starting reference.\n \n #### Example\n * passing `../my-arkos-uploaded-files`\n \n Will save uploaded files one level outside the root dir inside `my-arkos-uploaded-files`\n \n NB: You must be aware of permissions on your server to acess files outside your project directory.\n \n /\n baseUploadDir?: string;\n /*\n Changes the default `/api/uploads` base route for accessing file upload route.\n \n #### IMPORTANT\n * Changing this will not affect the `baseUploadDir` folder. You can\n * pass here `/api/files/my-user-files` and `baseUploadDir` be `/uploaded-files`.\n \n /\n baseRoute?: string;\n /*\n Defines options for `express.static(somePath, someOptions)`\n \n #### Default:\n \n ```ts\n {\n maxAge: \"1y\",\n etag: true,\n lastModified: true,\n dotfiles: \"ignore\",\n fallthrough: true,\n index: false,\n cacheControl: true,\n }\n ```\n * \n * By passing your custom options have in mind that it\n * will be deepmerged with the default.\n * \n * Visit [https://expressjs.com/en/4x/api.html#express.static](https://expressjs.com/en/4x/api.html#express.static) for more understanding.\n * \n /\n expressStaticOptions?: Parameters<typeof express.static>[1];\n /\n Defines upload restrictions for each file type: image, video, document or other.\n \n #### Important:\n * Passing an object without overriding everything will only cause it\n * to be deepmerged with the default options.\n \n See [www.arkosjs.com/docs/api-reference/default-supported-upload-files](https://www.arkosjs.com/docs/api-reference/default-supported-upload-files) for detailed explanation about default values.\n * ```\n /\n restrictions?: {\n images?: {\n maxCount?: number;\n maxSize?: number;\n supportedFilesRegex?: RegExp;\n };\n videos?: {\n maxCount?: number;\n maxSize?: number;\n supportedFilesRegex?: RegExp;\n };\n documents?: {\n maxCount?: number;\n maxSize?: number;\n supportedFilesRegex?: RegExp;\n };\n files?: {\n maxCount?: number;\n maxSize?: number;\n supportedFilesRegex?: RegExp;\n };\n };\n };\n /\n Allows to specify the request rate limit for all endpoints.\n * \n * #### Default\n ```ts\n {\n windowMs: 60 * 1000,\n limit: 1000,\n standardHeaders: \"draft-7\",\n legacyHeaders: false,\n }\n ```\n * \n * Passing an object not overriding all the default options will only\n * cause it to be deepmerged and not actually replace with empty fields\n * \n * This is are the options used on the `express-rate-limit` npm package used on epxress. read more about [https://www.npmjs.com/package/express-rate-limit](https://www.npmjs.com/package/express-rate-limit)\n /\n globalRequestRateLimitOptions?: Partial<RateLimitOptions>;\n /\n Defines options for the built-in express.json() middleware\n * Nothing is passed by default.\n /\n jsonBodyParserOptions?: Parameters<typeof express.json>[0];\n /\n Allows to pass paremeters to cookieParser from npm package cookie-parser\n * Nothing is passed by default.\n \n See [www.npmjs.com/package/cookie-parser](https://www.npmjs.com/package/cookie-parser) for further details.\n /\n cookieParserParameters?: Parameters<typeof cookieParser>;\n /\n Allows to define options for npm package compression\n * Nothing is passed by default.\n \n See [www.npmjs.com/package/compression](https://www.npmjs.com/package/compression) for further details.\n /\n compressionOptions?: compression.CompressionOptions;\n /\n Options to define how query must be parsed.\n \n #### for example:\n * ```\n * GET /api/product?saleId=null\n * ```\n \n Normally would parsed to { saleId: \"null\" } so query parser\n * trough setting option `parseNull` will transform { saleId: null }\n * \n * #### Default:\n * \n * {\n parseNull: true,\n parseUndefined: true,\n parseBoolean: true,\n }\n * \n * parseNumber may convert fields that are string but you only passed\n * numbers to query pay attention to this.\n * \n * Soon a feature to converted the query to the end prisma type will be added.\n /\n queryParserOptions?: QueryParserOptions;\n /\n Configuration for CORS (Cross-Origin Resource Sharing).\n \n @property {string \| string[] \| \"all\"} [allowedOrigins] - List of allowed origins. If set to `\"all\"`, all origins are accepted.\n * @property {import('cors').CorsOptions} [options] - Additional CORS options passed directly to the `cors` middleware.\n * @property {import('cors').CorsOptionsDelegate} [customMiddleware] - A custom middleware function that overrides the default behavior.\n \n @remarks\n * If `customMiddleware` is provided, both `allowedOrigins` and `options` will be ignored in favor of the custom logic.\n \n See https://www.npmjs.com/package/cors\n /\n cors?: {\n /\n Defines allowed origins to acess the API.\n /\n allowedOrigins?: string \| string[] \| \"\";\n options?: cors.CorsOptions;\n /*\n If you would like to override the entire middleware\n \n see\n /\n customHandler?: cors.CorsOptionsDelegate;\n };\n /\n Defines express/arkos middlewares configurations\n /\n middlewares?: {\n /\n Allows to add an array of custom express middlewares into the default middleware stack.\n \n Tip: If you would like to acess the express app before everthing use `configureApp` and pass a function.\n \n Where will these be placed?: see [www.arkosjs.com/docs/advanced-guide/replace-or-disable-built-in-middlewares#middleware-execution-order](https://www.arkosjs.com/docs/advanced-guide/replace-or-disable-built-in-middlewares#middleware-execution-order)\n \n Note: If you want to use custom global error handler middleware use `middlewares.replace.globalErrorHandler`.\n \n Read more about The Arkos Middleware Stack at [www.arkosjs.com/docs/the-middleware-stack](https://www.arkosjs.com/docs/the-middleware-stack) for in-depth details.\n /\n additional?: express.RequestHandler[];\n /\n An array containing a list of defaults middlewares to be disabled\n \n Caution: Be careful with this because you may endup breaking your entire application.\n \n /\n disable?: (\n \| \"compression\"\n \| \"global-rate-limit\"\n \| \"auth-rate-limit\"\n \| \"cors\"\n \| \"express-json\"\n \| \"cookie-parser\"\n \| \"query-parser\"\n \| \"request-logger\"\n \| \"global-error-handler\"\n )[];\n /*\n Allows you to replace each of the built-in middlewares with your own implementation\n \n Caution: Be careful with this because you may endup breaking your entire application.\n /\n replace?: {\n /\n Replace the default compression middleware\n /\n compression?: express.RequestHandler;\n /\n Replace the default global rate limit middleware\n /\n globalRateLimit?: express.RequestHandler;\n /\n Replace the default authentication rate limit middleware\n /\n authRateLimit?: express.RequestHandler;\n /\n Replace the default CORS middleware\n /\n cors?: express.RequestHandler;\n /\n Replace the default JSON body parser middleware\n /\n expressJson?: express.RequestHandler;\n /\n Replace the default cookie parser middleware\n /\n cookieParser?: express.RequestHandler;\n /\n Replace the default query parser middleware\n /\n queryParser?: express.RequestHandler;\n /\n Replace the default request logger middleware\n /\n requestLogger?: express.RequestHandler;\n /\n Replace the default global error handler middleware\n /\n globalErrorHandler?: express.ErrorRequestHandler;\n };\n };\n /\n Defines express/arkos routers configurations\n /\n routers?: {\n /\n Strict mode configuration for routing security\n \n @default false\n * - all CRUD + Auth (if using auth) endpoits are enabled and avialable by default.\n \n When enabled:\n * - If `true`: All CRUD endpoints start disabled and must be explicitly enabled\n * in each model's router configuration\n * - If `'no-bulk'`: Bulk operations (createMany, updateMany, deleteMany) are disabled\n * by default, while individual operations can be enabled per model\n \n This provides enhanced security by ensuring no routes are accidentally exposed.\n * Use this in production environments to follow the principle of least privilege.\n \n See documentation: https://www.arkosjs.com/docs/guide/security#strict-mode\n /\n strict?: boolean \| \"no-bulk\";\n /\n Allows to add an array of custom express routers into the default middleware/router stack.\n \n Where will these be placed?: see [www.arkosjs.com/docs/advanced-guide/adding-custom-routers](https://www.arkosjs.com/docs/advanced-guide/adding-custom-routers)\n \n \n * Read more about The Arkos Middleware Stack at [www.arkosjs.com/docs/the-middleware-stack](https://www.arkosjs.com/docs/the-middleware-stack) for in-depth details.\n /\n additional?: express.Router[] \| IArkosRouter[];\n disable?: (\n \| \"auth-router\"\n \| \"prisma-models-router\"\n \| \"file-upload\"\n \| \"welcome-endpoint\"\n )[];\n /\n Allows you to replace each of the built-in routers with your own implementation.\n \n Note: Doing this you will lose all default middleware chaining, auth control, handlers from the specific router.\n \n Tip: I you want to disable some prisma models specific endpoint\n * see [www.arkosjs.com/docs/guide/adding-custom-routers#disabling-auto-generated-endpoints](https://www.arkosjs.com/docs/guide/adding-custom-routers#disabling-auto-generated-endpoints)\n \n Caution: Be careful with this because you may endup breaking your entire application.\n /\n replace?: {\n /\n Replace the default authentication router\n * @param config The original Arkos configuration\n * @returns A router handling authentication endpoints\n /\n authRouter?: (\n config: ArkosConfig\n ) => express.Router \| Promise<express.Router>;\n /\n Replace the default Prisma models router\n * @param config The original Arkos configuration\n * @returns A router handling Prisma model endpoints\n /\n prismaModelsRouter?: (\n config: ArkosConfig\n ) => express.Router \| Promise<express.Router>;\n /\n Replace the default file upload router\n * @param config The original Arkos configuration\n * @returns A router handling file upload endpoints\n /\n fileUpload?: (\n config: ArkosConfig\n ) => express.Router \| Promise<express.Router>;\n /\n Replace the default welcome endpoint handler\n * @param req Express request object\n * @param res Express response object\n * @param next Express next function\n /\n welcomeEndpoint?: express.RequestHandler;\n };\n };\n /\n Gives acess to the underlying express app so that you can add custom configurations beyong Arkos customization capabilities\n \n Note: In the end Arkos will call `app.listen` for you.\n \n If you want to call `app.listen` by yourself pass port as `undefined` and then use the return app from `arkos.init()`.\n \n See how to call `app.listen` correctly [www.arkosjs.com/docs/guide/accessing-the-express-app#calling-applisten-by-yourself](https://www.arkosjs.com/docs/guide/accessing-the-express-app#calling-applisten-by-yourself)\n \n See [www.arkosjs.com/docs/guide/accessing-the-express-app](https://www.arkosjs.com/docs/guide/accessing-the-express-app) for further details on the method configureApp.\n \n @param {express.Express} app\n * @returns {any}\n /\n configureApp?: (app: express.Express) => Promise<any> \| any;\n /\n Gives access to the underlying HTTP server so that you can add custom configurations beyond Arkos customization capabilities\n \n Note: In the end Arkos will call `server.listen` for you.\n \n If you want to call `server.listen` by yourself pass port as `undefined` and then use the return server from `arkos.init()`.\n \n See how to call `server.listen` correctly [www.arkosjs.com/docs/guide/accessing-the-express-app#creating-your-own-http-server](https://www.arkosjs.com/docs/guide/accessing-the-express-app#creating-your-own-http-server)\n \n See [www.arkosjs.com/docs/guide/accessing-the-express-app#accessing-the-http-server](https://www.arkosjs.com/docs/guide/accessing-the-express-app#accessing-the-http-server) for further details on the method configureServer.\n \n @param {http.Server} server - The HTTP server instance\n * @returns {any}\n /\n configureServer?: (server: http.Server) => Promise<any> \| any;\n /\n Allows to configure email configurations for sending emails through `emailService`\n \n See [www.arkosjs.com/docs/core-concepts/sending-emails](https://www.arkosjs.com/docs/core-concepts/sending-emails)\n /\n email?: {\n /\n Email name to used like:\n \n John Doe\\<john.doe@gmail.com>\n /\n name?: string;\n /\n Your email provider url\n /\n host: string;\n /\n Email provider SMTP port, Default is `465`\n /\n port?: number;\n /\n If smtp connection must be secure, Default is `true`\n /\n secure?: boolean;\n /\n Used to authenticate in your smtp server\n /\n auth: {\n /\n Email used for auth as well as sending emails\n /\n user: string;\n /\n Your SMTP password\n /\n pass: string;\n };\n } & Parameters<typeof nodemailer.createTransport>[0];\n /\n Defines Swagger and OpenApi specifications for auto generating swagger documentation UI using whether it is Prisma Schemas, Class-validator DTOs, Zod Schemas or JSON-Schemas.\n \n Important: Is worth mentioning that this works alongside `@scalar/express-api-reference` npm package, you define it's ApiReferenceConfiguration under ``. also consider checking the package documentation at []\n \n Usage\n \n ```ts\n * // src/app.ts\n \n import arkos from \"arkos\"\n \n arkos.init({\n * // other configs\n * swagger: {\n * mode: \"zod\",\n * options: {\n * defintion: {\n * info: {\n * openapi: \"3.0.0\",\n * title: \"API Generated By Arkos.js\",\n * description: \"This API was automatically generated by Arkos.js read more about at www.arkosjs.com\"\n * }\n * }\n * }\n * }\n * })\n * ```\n * @see {@link https://www.arkosjs.com/docs/core-concepts/swagger-api-documentation}\n /\n swagger?: {\n /\n By default Arkos will disable API Documentation when the project is built `npm run build`, it does not matter what node environment is set. If you want to use it even after the `arkos build` command just set this to `true`.\n * /\n enableAfterBuild?: boolean;\n /\n Endpoint where the Swagger UI will be available.\n \n @default \"/api/api-docs\"\n /\n endpoint?: string;\n /\n Determines how your API schemas should be generated.\n \n - \"prisma\": Generates schemas based on Prisma models\n * - \"class-validator\": Uses class-validator and class-transformer DTO classes\n * - \"zod\": Uses OpenAPI-compliant schemas directly\n /\n mode: \"prisma\" \| \"class-validator\" \| \"zod\";\n /\n Allows `Arkos.js` to fallback to prisma schema and use them as json schema for defining request body and response data\n * when a given zod Schema or class-validator Class is not found to be transformed to json schema.\n \n @default false\n /\n strict?: boolean;\n /\n Defines your swagger configurations\n /\n options?: {\n /\n Swagger definition according to OpenAPI Specification.\n /\n definition?: {\n /\n OpenAPI version.\n \n @default \"3.0.0\"\n /\n openapi?: string;\n\n /\n Information about your API.\n /\n info?: {\n /\n Title of the API documentation.\n \n \n * @example \"My API\"\n \n @default \"API Generated By Arkos.js\"\n /\n title?: string;\n\n /\n Version of the API.\n \n @example \"1.0.0\"\n /\n version?: string;\n\n /\n Description of the API.\n \n @default \"This API was automatically generated by Arkos.js read more about at www.arkosjs.com\"\n /\n description?: string;\n };\n\n /\n Server configurations for the API.\n \n @default [{ url: \"http://localhost:8000\", description: \"Development server\" }]\n \n This can be overridden automatically by Arkos based on CLI, .env, or `arkos.init()`.\n /\n servers?: {\n /\n Base URL of the server.\n \n @example \"http://localhost:8000\"\n /\n url: string;\n\n /\n Human-readable description of the server.\n \n @example \"Development Server\"\n /\n description?: string;\n }[];\n /\n Allows adding more paths for your OpenAPI documentation\n \n /\n paths?: OpenAPIV3.PathsObject;\n /\n (Optional) Additional metadata such as terms of service, contact, or license.\n \n See: https://swagger.io/specification/#infoObject\n /\n termsOfService?: string;\n contact?: {\n name?: string;\n url?: string;\n email?: string;\n };\n license?: {\n name: string;\n url?: string;\n };\n\n /\n Tags to group and describe endpoints.\n /\n tags?: {\n name: string;\n description?: string;\n }[];\n\n /\n Security definitions (e.g., Bearer Auth).\n /\n components?: {\n securitySchemes?: Record<string, any>;\n schemas?: Record<string, any>;\n };\n\n /\n Global security requirements.\n /\n security?: Array<Record<string, string[]>>;\n };\n\n /\n Glob patterns defining where Swagger should look for API route definitions and comments.\n \n @default \n * ```ts\n * [\"./src/routers/.router.{ts,js}\", \"./src/modules/\\/.router.{ts,js}\"]\n ```\n \n Adjust depending on TypeScript or JavaScript usage.\n /\n apis?: string[];\n\n /\n Enables deep linking in the Swagger UI.\n \n @default true\n /\n deepLinking?: boolean;\n\n /\n Enable/disable the \"Try it out\" button globally.\n \n @default true\n /\n tryItOutEnabled?: boolean;\n\n /\n Whether to persist authorization data across page reloads.\n \n @default false\n /\n persistAuthorization?: boolean;\n };\n /\n Custom `@scalar/express-api-reference` package options.\n \n @see {@link https://guides.scalar.com/scalar/scalar-api-references/integrations/express}\n /\n scalarApiReferenceConfiguration?: Partial<ApiReferenceConfiguration>;\n };\n /\n Helps in debugging some of the variables values that are used inside arkos from dynamic loaded components towhat is used into the generated api.\n \n /\n debugging?: {\n /*\n Controls debugging over HTTP request level\n /\n requests?: {\n level?: 0 \| 1 \| 2 \| 3;\n filter?: (\n \| \"Query\"\n \| \"Body\"\n \| \"Params\"\n \| \"TransformedQuery\"\n \| \"ServiceArgs\"\n \| \"FinalPrismaQueryArgs\"\n )[];\n };\n /\n Controls debugging over the dynamic loaded modules and it's components on app starting\n /\n dynamicLoader?: {\n /\n Adjusts logging details\n \n 1 - Loaded modules and list of it's components files\n * 2 - All from 1 and detailed inspection per module component\n * 3 - All from 1 and 2, plus the final router component after merged with autho generated router.\n /\n level?: 0 \| 1 \| 2 \| 3;\n filters?: {\n /\n Allows filtering by specific modules.\n \n Supports only searching for the starting parts of the module name, e.g: If there is`user-profile`, `user`, `posts`, passing `[\"user\"]` will match both `user-profile` and `user`.\n /\n modules?: string[];\n /\n Allows filtering by component's names\n */\n components?: keyof ModuleComponents[];\n };\n };\n };\n};\n"]}

package/dist/cjs/utils/arkos-router/types/index.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/utils/arkos-router/types/index.ts"],"names":[],"mappings":"","sourcesContent":["import { IRouter } from \"express\";\nimport { OpenAPIV3 } from \"openapi-types\";\nimport { ZodSchema } from \"zod\";\nimport { Options as RateLimitOptions } from \"express-rate-limit\";\nimport { AccessControlRules } from \"../../../types/auth\";\nimport { ArkosErrorRequestHandler, ArkosRequestHandler } from \"../../../types\";\nimport { CorsOptions } from \"cors\";\nimport express from \"express\";\n\ntype MethodHandler = (\n config: ArkosRouteConfig,\n ...handlers: (ArkosRequestHandler \| ArkosErrorRequestHandler)[]\n) => ~~IArkosRouter~~;\n\nexport interface IArkosRouter\n extends Omit<\n IRouter,\n \| \"get\"\n \| \"post\"\n \| \"put\"\n \| \"patch\"\n \| \"delete\"\n \| \"options\"\n \| \"head\"\n \| \"trace\"\n \| \"all\"\n > {\n get: MethodHandler;\n post: MethodHandler;\n put: MethodHandler;\n patch: MethodHandler;\n delete: MethodHandler;\n options: MethodHandler;\n head: MethodHandler;\n trace: MethodHandler;\n all: MethodHandler;\n}\n\nexport interface ArkosRouteConfig {\n route: string;\n authentication?:\n \| boolean\n \| {\n resource: string;\n action: string;\n rule?: AccessControlRules;\n };\n validation?:\n \| false\n \| {\n query?: ZodSchema \| (new (...args: any[]) => object) \| false;\n body?: ZodSchema \| (new (...args: any[]) => object) \| false;\n params?: ZodSchema \| (new (...args: any[]) => object) \| false;\n };\n openapi?: boolean \| Partial<OpenAPIV3.OperationObject>;\n rateLimit?: Partial<RateLimitOptions>;\n /*\n Configuration for CORS (Cross-Origin Resource Sharing).\n \n @property {string \| string[] \| \"all\"} [allowedOrigins] - List of allowed origins. If set to `\"all\"`, all origins are accepted.\n * @property {import('cors').CorsOptions} [options] - Additional CORS options passed directly to the `cors` middleware.\n * @property {import('cors').CorsOptionsDelegate} [customMiddleware] - A custom middleware function that overrides the default behavior.\n \n @remarks\n * If `customMiddleware` is provided, both `allowedOrigins` and `options` will be ignored in favor of the custom logic.\n \n See https://www.npmjs.com/package/cors\n /\n cors?: {\n /\n Defines allowed origins to acess the API.\n /\n allowedOrigins?: string \| string[] \| \"\";\n options?: CorsOptions;\n };\n /*\n Configuration for request body parsing.\n \n @property {(\"json\" \| \"urlencoded\" \| \"raw\" \| \"text\")} parser - The type of body parser to use.\n * @property {object} [options] - Parser-specific options passed to the corresponding Express body parser middleware.\n \n @remarks\n * - When `parser` is `\"json\"`, options are passed to `express.json()`.\n * - When `parser` is `\"urlencoded\"`, options are passed to `express.urlencoded()`.\n * - When `parser` is `\"raw\"`, options are passed to `express.raw()`.\n * - When `parser` is `\"text\"`, options are passed to `express.text()`.\n * - Set to `false` to disable body parsing for this route.\n \n See https://expressjs.com/en/api.html#express.json\n */\n bodyParser?:\n \| { parser: \"json\"; options?: Parameters<typeof express.json>[0] }\n \| {\n parser: \"urlencoded\";\n options?: Parameters<typeof express.urlencoded>[0];\n }\n \| { parser: \"raw\"; options?: Parameters<typeof express.raw>[0] }\n \| { parser: \"text\"; options?: Parameters<typeof express.text>[0] }\n \| false;\n}\n"]}
1	+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/utils/arkos-router/types/index.ts"],"names":[],"mappings":"","sourcesContent":["import { IRouter } from \"express\";\nimport { OpenAPIV3 } from \"openapi-types\";\nimport { ZodSchema } from \"zod\";\nimport { Options as RateLimitOptions } from \"express-rate-limit\";\nimport { AccessControlRules } from \"../../../types/auth\";\nimport { ArkosErrorRequestHandler, ArkosRequestHandler } from \"../../../types\";\nimport { CorsOptions } from \"cors\";\nimport express from \"express\";\n\ntype MethodHandler = (\n config: ArkosRouteConfig,\n ...handlers: (ArkosRequestHandler \| ArkosErrorRequestHandler)[]\n) => IRouter;\n\nexport interface IArkosRouter\n extends Omit<\n IRouter,\n \| \"get\"\n \| \"post\"\n \| \"put\"\n \| \"patch\"\n \| \"delete\"\n \| \"options\"\n \| \"head\"\n \| \"trace\"\n \| \"all\"\n > {\n get: MethodHandler;\n post: MethodHandler;\n put: MethodHandler;\n patch: MethodHandler;\n delete: MethodHandler;\n options: MethodHandler;\n head: MethodHandler;\n trace: MethodHandler;\n all: MethodHandler;\n}\n\nexport interface ArkosRouteConfig {\n route: string;\n authentication?:\n \| boolean\n \| {\n resource: string;\n action: string;\n rule?: AccessControlRules;\n };\n validation?:\n \| false\n \| {\n query?: ZodSchema \| (new (...args: any[]) => object) \| false;\n body?: ZodSchema \| (new (...args: any[]) => object) \| false;\n params?: ZodSchema \| (new (...args: any[]) => object) \| false;\n };\n openapi?: boolean \| Partial<OpenAPIV3.OperationObject>;\n rateLimit?: Partial<RateLimitOptions>;\n /*\n Configuration for CORS (Cross-Origin Resource Sharing).\n \n @property {string \| string[] \| \"all\"} [allowedOrigins] - List of allowed origins. If set to `\"all\"`, all origins are accepted.\n * @property {import('cors').CorsOptions} [options] - Additional CORS options passed directly to the `cors` middleware.\n * @property {import('cors').CorsOptionsDelegate} [customMiddleware] - A custom middleware function that overrides the default behavior.\n \n @remarks\n * If `customMiddleware` is provided, both `allowedOrigins` and `options` will be ignored in favor of the custom logic.\n \n See https://www.npmjs.com/package/cors\n /\n cors?: {\n /\n Defines allowed origins to acess the API.\n /\n allowedOrigins?: string \| string[] \| \"\";\n options?: CorsOptions;\n };\n /*\n Configuration for request body parsing.\n \n @property {(\"json\" \| \"urlencoded\" \| \"raw\" \| \"text\")} parser - The type of body parser to use.\n * @property {object} [options] - Parser-specific options passed to the corresponding Express body parser middleware.\n \n @remarks\n * - When `parser` is `\"json\"`, options are passed to `express.json()`.\n * - When `parser` is `\"urlencoded\"`, options are passed to `express.urlencoded()`.\n * - When `parser` is `\"raw\"`, options are passed to `express.raw()`.\n * - When `parser` is `\"text\"`, options are passed to `express.text()`.\n * - Set to `false` to disable body parsing for this route.\n \n See https://expressjs.com/en/api.html#express.json\n */\n bodyParser?:\n \| { parser: \"json\"; options?: Parameters<typeof express.json>[0] }\n \| {\n parser: \"urlencoded\";\n options?: Parameters<typeof express.urlencoded>[0];\n }\n \| { parser: \"raw\"; options?: Parameters<typeof express.raw>[0] }\n \| { parser: \"text\"; options?: Parameters<typeof express.text>[0] }\n \| false;\n}\n"]}

package/dist/cjs/utils/arkos-router/utils/helpers/index.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../src/utils/arkos-router/utils/helpers/index.ts"],"names":[],"mappings":";;;;;~~AAQA~~,gDA+DC;AAED,gDAiCC;~~AAzGD~~,2DAA2D;AAC3D,gFAAkF;AAClF,wFAA8D;~~AAG9D~~,sDAA8B;AAE9B,SAAgB,kBAAkB,CAChC,GAAQ,EACR,QAAQ,GAAG,EAAE;IAMb,MAAM,MAAM,GAIP,EAAE,CAAC;IAER,SAAS,gBAAgB,CAAC,KAAY,EAAE,MAAM,GAAG,EAAE;QACjD,KAAK,CAAC,OAAO,CAAC,CAAC,KAAU,EAAE,EAAE;YAC3B,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;gBAChB,MAAM,QAAQ,GAAG,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC;gBAC3C,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBAEjD,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;oBACzB,MAAM,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC;oBACzC,IAAI,MAAoC,CAAC;oBAEzC,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;wBAC/B,MAAM,WAAW,GAAG,+BAAmB,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;wBAE5D,IAAI,WAAW,EAAE,CAAC;4BAChB,MAAM,GAAG,WAAW,CAAC;4BACrB,MAAM,CAAC,IAAI,CAAC;gCACV,IAAI,EAAE,QAAQ;gCACd,MAAM,EAAE,MAAM,CAAC,WAAW,EAAE;gCAC5B,MAAM;6BACP,CAAC,CAAC;4BAEH,MAAM;wBACR,CAAC;oBACH,CAAC;gBACH,CAAC,CAAC,CAAC;YACL,CAAC;iBAAM,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC;gBAC1D,IAAI,YAAY,GAAG,MAAM,CAAC;gBAE1B,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;oBACjB,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM;yBACvB,QAAQ,EAAE;yBACV,KAAK,CAAC,0BAA0B,CAAC,CAAC;oBACrC,IAAI,KAAK,EAAE,CAAC;wBACV,YAAY,GAAG,MAAM,GAAG,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;wBAC7D,YAAY,GAAG,YAAY;6BACxB,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC;6BACrB,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;oBACxB,CAAC;gBACH,CAAC;gBAED,gBAAgB,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;YACrD,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,KAAK,GAAG,GAAG,CAAC,OAAO,EAAE,KAAK,IAAI,GAAG,CAAC,KAAK,CAAC;IAC9C,IAAI,KAAK;QAAE,gBAAgB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAE7C,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAgB,kBAAkB,CAAC,MAAwB;IACzD,MAAM,WAAW,GAAG,EAAE,CAAC;IAEvB,IAAI,MAAM,CAAC,cAAc;QAAE,WAAW,CAAC,IAAI,CAAC,sBAAW,CAAC,YAAY,CAAC,CAAC;IAEtE,IACE,OAAO,MAAM,CAAC,cAAc,KAAK,QAAQ;QACzC,MAAM,CAAC,cAAc,CAAC,MAAM;QAC5B,MAAM,CAAC,cAAc,CAAC,QAAQ;QAE9B,WAAW,CAAC,IAAI,CACd,sBAAW,CAAC,mBAAmB,CAC7B,MAAM,CAAC,cAAc,CAAC,MAAM,EAC5B,MAAM,CAAC,cAAc,CAAC,QAAQ,EAC9B,MAAM,CAAC,cAAc,EAAE,IAAI,CAC5B,CACF,CAAC;IAMJ,IACE,OAAO,MAAM,EAAE,UAAU,KAAK,QAAQ;QACtC,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,CAAC;QAE1E,WAAW,CAAC,IAAI,CACd,iBAAO,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAC7D,CAAC;IAEJ,WAAW,CAAC,IAAI,CAAC,IAAA,wCAAqB,EAAC,MAAM,CAAC,CAAC,CAAC;IAEhD,OAAO,WAAW,CAAC;AACrB,CAAC","sourcesContent":["import ~~rateLimit from \"express-rate-limit\";\nimport~~ { authService } from \"../../../../exports/services\";\nimport { validateRequestInputs } from \"../../../../modules/base/base.middlewares\";\nimport RouteConfigRegistry from \"../../route-config-registry\";\nimport { ArkosRouteConfig } from \"../../types\";\nimport ~~cors from \"cors\";\nimport~~ express from \"express\";\n\nexport function extractArkosRoutes(\n app: any,\n basePath = \"\"\n): Array<{\n path: string;\n method: string;\n config?: ArkosRouteConfig;\n}> {\n const routes: Array<{\n path: string;\n method: string;\n config?: ArkosRouteConfig;\n }> = [];\n\n function extractFromStack(stack: any[], prefix = \"\") {\n stack.forEach((layer: any) => {\n if (layer.route) {\n const fullPath = prefix + layer.route.path;\n const methods = Object.keys(layer.route.methods);\n\n methods.forEach((method) => {\n const handlers = layer.route.stack \|\| [];\n let config: ArkosRouteConfig \| undefined;\n\n for (const handler of handlers) {\n const foundConfig = RouteConfigRegistry.get(handler.handle);\n\n if (foundConfig) {\n config = foundConfig;\n routes.push({\n path: fullPath,\n method: method.toUpperCase(),\n config,\n });\n\n break;\n }\n }\n });\n } else if (layer.name === \"router\" && layer.handle?.stack) {\n let nestedPrefix = prefix;\n\n if (layer.regexp) {\n const match = layer.regexp\n .toString()\n .match(/\\/\\^?(\\\\\\/[^?]+\|\\/[^?]+)/);\n if (match) {\n nestedPrefix = prefix + \"/\" + match[1].replace(/\\\\\\//g, \"/\");\n nestedPrefix = nestedPrefix\n .replace(/\\/\\//g, \"/\")\n .replace(/\\/$/, \"\");\n }\n }\n\n extractFromStack(layer.handle.stack, nestedPrefix);\n }\n });\n }\n\n const stack = app._router?.stack \|\| app.stack;\n if (stack) extractFromStack(stack, basePath);\n\n return routes;\n}\n\nexport function getMiddlewareStack(config: ArkosRouteConfig) {\n const middlewares = [];\n\n if (config.authentication) middlewares.push(authService.authenticate);\n\n if (\n typeof config.authentication === \"object\" &&\n config.authentication.action &&\n config.authentication.resource\n )\n middlewares.push(\n authService.handleAccessControl(\n config.authentication.action,\n config.authentication.resource,\n config.authentication?.rule\n )\n );\n\n // if (config.rateLimit) middlewares.push(rateLimit(config.rateLimit));\n\n // if (config.cors) middlewares.push(cors(config.cors.options));\n\n if (\n typeof config?.bodyParser === \"object\" &&\n [\"json\", \"urlencoded\", \"raw\", \"text\"].includes(config?.bodyParser?.parser)\n )\n middlewares.push(\n express[config.bodyParser.parser](config.bodyParser.options)\n );\n\n middlewares.push(validateRequestInputs(config));\n\n return middlewares;\n}\n"]}
1	+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../src/utils/arkos-router/utils/helpers/index.ts"],"names":[],"mappings":";;;;;AAMA,gDA+DC;AAED,gDAiCC;AAxGD,2DAA2D;AAC3D,gFAAkF;AAClF,wFAA8D;AAE9D,sDAA8B;AAE9B,SAAgB,kBAAkB,CAChC,GAAQ,EACR,QAAQ,GAAG,EAAE;IAMb,MAAM,MAAM,GAIP,EAAE,CAAC;IAER,SAAS,gBAAgB,CAAC,KAAY,EAAE,MAAM,GAAG,EAAE;QACjD,KAAK,CAAC,OAAO,CAAC,CAAC,KAAU,EAAE,EAAE;YAC3B,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;gBAChB,MAAM,QAAQ,GAAG,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC;gBAC3C,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBAEjD,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;oBACzB,MAAM,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC;oBACzC,IAAI,MAAoC,CAAC;oBAEzC,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;wBAC/B,MAAM,WAAW,GAAG,+BAAmB,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;wBAE5D,IAAI,WAAW,EAAE,CAAC;4BAChB,MAAM,GAAG,WAAW,CAAC;4BACrB,MAAM,CAAC,IAAI,CAAC;gCACV,IAAI,EAAE,QAAQ;gCACd,MAAM,EAAE,MAAM,CAAC,WAAW,EAAE;gCAC5B,MAAM;6BACP,CAAC,CAAC;4BAEH,MAAM;wBACR,CAAC;oBACH,CAAC;gBACH,CAAC,CAAC,CAAC;YACL,CAAC;iBAAM,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC;gBAC1D,IAAI,YAAY,GAAG,MAAM,CAAC;gBAE1B,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;oBACjB,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM;yBACvB,QAAQ,EAAE;yBACV,KAAK,CAAC,0BAA0B,CAAC,CAAC;oBACrC,IAAI,KAAK,EAAE,CAAC;wBACV,YAAY,GAAG,MAAM,GAAG,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;wBAC7D,YAAY,GAAG,YAAY;6BACxB,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC;6BACrB,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;oBACxB,CAAC;gBACH,CAAC;gBAED,gBAAgB,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;YACrD,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,KAAK,GAAG,GAAG,CAAC,OAAO,EAAE,KAAK,IAAI,GAAG,CAAC,KAAK,CAAC;IAC9C,IAAI,KAAK;QAAE,gBAAgB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAE7C,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAgB,kBAAkB,CAAC,MAAwB;IACzD,MAAM,WAAW,GAAG,EAAE,CAAC;IAEvB,IAAI,MAAM,CAAC,cAAc;QAAE,WAAW,CAAC,IAAI,CAAC,sBAAW,CAAC,YAAY,CAAC,CAAC;IAEtE,IACE,OAAO,MAAM,CAAC,cAAc,KAAK,QAAQ;QACzC,MAAM,CAAC,cAAc,CAAC,MAAM;QAC5B,MAAM,CAAC,cAAc,CAAC,QAAQ;QAE9B,WAAW,CAAC,IAAI,CACd,sBAAW,CAAC,mBAAmB,CAC7B,MAAM,CAAC,cAAc,CAAC,MAAM,EAC5B,MAAM,CAAC,cAAc,CAAC,QAAQ,EAC9B,MAAM,CAAC,cAAc,EAAE,IAAI,CAC5B,CACF,CAAC;IAMJ,IACE,OAAO,MAAM,EAAE,UAAU,KAAK,QAAQ;QACtC,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,CAAC;QAE1E,WAAW,CAAC,IAAI,CACd,iBAAO,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAC7D,CAAC;IAEJ,WAAW,CAAC,IAAI,CAAC,IAAA,wCAAqB,EAAC,MAAM,CAAC,CAAC,CAAC;IAEhD,OAAO,WAAW,CAAC;AACrB,CAAC","sourcesContent":["import { authService } from \"../../../../exports/services\";\nimport { validateRequestInputs } from \"../../../../modules/base/base.middlewares\";\nimport RouteConfigRegistry from \"../../route-config-registry\";\nimport { ArkosRouteConfig } from \"../../types\";\nimport express from \"express\";\n\nexport function extractArkosRoutes(\n app: any,\n basePath = \"\"\n): Array<{\n path: string;\n method: string;\n config?: ArkosRouteConfig;\n}> {\n const routes: Array<{\n path: string;\n method: string;\n config?: ArkosRouteConfig;\n }> = [];\n\n function extractFromStack(stack: any[], prefix = \"\") {\n stack.forEach((layer: any) => {\n if (layer.route) {\n const fullPath = prefix + layer.route.path;\n const methods = Object.keys(layer.route.methods);\n\n methods.forEach((method) => {\n const handlers = layer.route.stack \|\| [];\n let config: ArkosRouteConfig \| undefined;\n\n for (const handler of handlers) {\n const foundConfig = RouteConfigRegistry.get(handler.handle);\n\n if (foundConfig) {\n config = foundConfig;\n routes.push({\n path: fullPath,\n method: method.toUpperCase(),\n config,\n });\n\n break;\n }\n }\n });\n } else if (layer.name === \"router\" && layer.handle?.stack) {\n let nestedPrefix = prefix;\n\n if (layer.regexp) {\n const match = layer.regexp\n .toString()\n .match(/\\/\\^?(\\\\\\/[^?]+\|\\/[^?]+)/);\n if (match) {\n nestedPrefix = prefix + \"/\" + match[1].replace(/\\\\\\//g, \"/\");\n nestedPrefix = nestedPrefix\n .replace(/\\/\\//g, \"/\")\n .replace(/\\/$/, \"\");\n }\n }\n\n extractFromStack(layer.handle.stack, nestedPrefix);\n }\n });\n }\n\n const stack = app._router?.stack \|\| app.stack;\n if (stack) extractFromStack(stack, basePath);\n\n return routes;\n}\n\nexport function getMiddlewareStack(config: ArkosRouteConfig) {\n const middlewares = [];\n\n if (config.authentication) middlewares.push(authService.authenticate);\n\n if (\n typeof config.authentication === \"object\" &&\n config.authentication.action &&\n config.authentication.resource\n )\n middlewares.push(\n authService.handleAccessControl(\n config.authentication.action,\n config.authentication.resource,\n config.authentication?.rule\n )\n );\n\n // if (config.rateLimit) middlewares.push(rateLimit(config.rateLimit));\n\n // if (config.cors) middlewares.push(cors(config.cors.options));\n\n if (\n typeof config?.bodyParser === \"object\" &&\n [\"json\", \"urlencoded\", \"raw\", \"text\"].includes(config?.bodyParser?.parser)\n )\n middlewares.push(\n express[config.bodyParser.parser](config.bodyParser.options)\n );\n\n middlewares.push(validateRequestInputs(config));\n\n return middlewares;\n}\n"]}

package/dist/cjs/utils/cli/utils/cli.helpers.js CHANGED Viewed

@@ -19,6 +19,6 @@ function killServerChildProcess() {
     (0, start_1.killProductionServerChildProcess)();
 }
 function getVersion() {
-    return "1.4.0-canary.27";
+    return "1.4.0-canary.29";
 }
 //# sourceMappingURL=cli.helpers.js.map

package/dist/esm/app.js CHANGED Viewed

@@ -116,16 +116,16 @@ export async function bootstrap(arkosConfig) {
     }
     app.use(knowModulesRouter);
     app.use("/api", getAvailableResourcesAndRoutesRouter());
-    if (arkosConfig.swagger &&
-        (process.env.ARKOS_BUILD !== "true" ||
-            arkosConfig.swagger.enableAfterBuild === true))
-        app.use("/api", await getSwaggerRouter(arkosConfig, app));
     if (routersConfig?.additional)
         routersConfig.additional.forEach((router) => {
             app.use(router);
         });
+    if (arkosConfig.swagger &&
+        (process.env.ARKOS_BUILD !== "true" ||
+            arkosConfig.swagger.enableAfterBuild === true))
+        app.use("/api", await getSwaggerRouter(arkosConfig, app));
     app.use("*", (req) => {
-        throw new AppError("Route not found", 404, { route: req.route }, "RouteNotFound");
+        throw new AppError("Route not found", 404, { route: req.path }, "RouteNotFound");
     });
     if (!disabledMiddlewares?.includes?.("global-error-handler"))
         app.use(replacedMiddlewares.globalErrorHandler || errorHandler);

package/dist/esm/app.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"app.js","sourceRoot":"","sources":["../../src/app.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,EAAE,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAC1C,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,YAAY,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EACL,qBAAqB,EACrB,oCAAoC,GACrC,MAAM,4BAA4B,CAAC;AACpC,OAAO,YAAY,MAAM,kDAAkD,CAAC;AAC5E,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,WAAW,MAAM,aAAa,CAAC;AACtC,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAClE,OAAO,EAAE,mBAAmB,EAAE,MAAM,0CAA0C,CAAC;AAE/E,OAAO,EAAE,WAAW,EAAE,MAAM,sCAAsC,CAAC;AACnE,OAAO,SAAS,MAAM,kCAAkC,CAAC;AACzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACpE,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AACnD,OAAO,eAAe,MAAM,qCAAqC,CAAC;AAElE,MAAM,CAAC,MAAM,GAAG,GAAoB,OAAO,EAAE,CAAC;AAC9C,MAAM,iBAAiB,GAAG,MAAM,EAAE,CAAC;AAEnC,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,WAAwB;IAExB,MAAM,OAAO,CAAC,GAAG,CAAC;QAChB,gBAAgB,EAAE;QAClB,uBAAuB,CAAC,WAAW,CAAC;QACpC,WAAW,EAAE,YAAY,IAAI,CAAC,MAAM,WAAW,EAAE,YAAY,CAAC,GAAG,CAAC,CAAC;KACpE,CAAC,CAAC;IAEH,MAAM,iBAAiB,GAAG,WAAW,EAAE,WAAW,CAAC;IACnD,MAAM,mBAAmB,GAAG,iBAAiB,EAAE,OAAO,IAAI,EAAE,CAAC;IAC7D,MAAM,mBAAmB,GAAG,iBAAiB,EAAE,OAAO,IAAI,EAAE,CAAC;IAE7D,IAAI,CAAC,mBAAmB,EAAE,QAAQ,EAAE,CAAC,aAAa,CAAC;QACjD,GAAG,CAAC,GAAG,CACL,mBAAmB,CAAC,WAAW;YAC7B,WAAW,CAAC,WAAW,EAAE,kBAAkB,CAAC,CAC/C,CAAC;IAEJ,IAAI,CAAC,mBAAmB,EAAE,QAAQ,EAAE,CAAC,mBAAmB,CAAC;QACvD,GAAG,CAAC,GAAG,CACL,mBAAmB,CAAC,eAAe;YACjC,SAAS,CACP,SAAS,CACP;gBACE,QAAQ,EAAE,EAAE,GAAG,IAAI;gBACnB,KAAK,EAAE,GAAG;gBACV,eAAe,EAAE,SAAS;gBAC1B,aAAa,EAAE,KAAK;gBACpB,OAAO,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE;oBAClB,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;wBACnB,OAAO,EAAE,2CAA2C;qBACrD,CAAC,CAAC;gBACL,CAAC;aACF,EACD,WAAW,EAAE,6BAA6B,IAAI,EAAE,CACjD,CACF,CACJ,CAAC;IAEJ,IAAI,CAAC,mBAAmB,EAAE,QAAQ,EAAE,CAAC,MAAM,CAAC;QAC1C,GAAG,CAAC,GAAG,CACL,mBAAmB,CAAC,IAAI;YACtB,IAAI,CACF,WAAW,EAAE,IAAI,EAAE,aAAa;gBAC9B,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,aAAa;gBAChC,CAAC,CAAC,SAAS,CACP;oBACE,MAAM,EAAE,CACN,MAAc,EACd,EAAgD,EAChD,EAAE;wBACF,MAAM,OAAO,GAAG,WAAW,EAAE,IAAI,EAAE,cAAc,CAAC;wBAElD,IAAI,OAAO,KAAK,GAAG;4BAAE,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;6BAC/B,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;4BAC7B,EAAE,CAAC,IAAI,EAAE,CAAC,MAAM,IAAI,OAAO,EAAE,QAAQ,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;6BAC9C,IAAI,OAAO,OAAO,KAAK,QAAQ;4BAClC,EAAE,CAAC,IAAI,EAAE,CAAC,MAAM,IAAI,OAAO,KAAK,MAAM,CAAC,CAAC;;4BACrC,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;oBACvB,CAAC;oBAED,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,CAAC;oBAC7D,cAAc,EAAE;wBACd,cAAc;wBACd,eAAe;wBACf,YAAY;qBACb;oBACD,WAAW,EAAE,IAAI;iBAClB,EACD,WAAW,EAAE,IAAI,EAAE,OAAO,IAAI,EAAE,CACjC,CACN,CACJ,CAAC;IAEJ,IAAI,CAAC,mBAAmB,EAAE,QAAQ,EAAE,CAAC,cAAc,CAAC;QAClD,GAAG,CAAC,GAAG,CACL,mBAAmB,CAAC,WAAW;YAC7B,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,qBAAqB,CAAC,CACnD,CAAC;IAEJ,IAAI,CAAC,mBAAmB,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC;QACnD,GAAG,CAAC,GAAG,CACL,mBAAmB,CAAC,YAAY;YAC9B,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,sBAAsB,IAAI,EAAE,CAAC,CAAC,CAAC,CACpE,CAAC;IAEJ,IAAI,CAAC,mBAAmB,EAAE,QAAQ,EAAE,CAAC,cAAc,CAAC;QAClD,GAAG,CAAC,GAAG,CACL,mBAAmB,CAAC,WAAW;YAC7B,WAAW,CACT,SAAS,CACP;gBACE,SAAS,EAAE,IAAI;gBACf,cAAc,EAAE,IAAI;gBACpB,YAAY,EAAE,IAAI;aACnB,EACD,WAAW,EAAE,kBAAkB,IAAI,EAAE,CACtC,CACF,CACJ,CAAC;IAEJ,IAAI,CAAC,mBAAmB,EAAE,QAAQ,EAAE,CAAC,gBAAgB,CAAC;QACpD,GAAG,CAAC,GAAG,CAAC,mBAAmB,CAAC,aAAa,IAAI,iBAAiB,CAAC,CAAC;IAElE,IAAI,WAAW,EAAE,WAAW,EAAE,UAAU;QACtC,WAAW,CAAC,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YACxD,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC;IAEL,GAAG,CAAC,GAAG,CAAC,eAAe,CAAC,cAAc,CAAC,CAAC;IAExC,MAAM,aAAa,GAAG,WAAW,EAAE,OAAO,CAAC;IAC3C,MAAM,eAAe,GAAG,aAAa,EAAE,OAAO,IAAI,EAAE,CAAC;IACrD,MAAM,eAAe,GAAG,aAAa,EAAE,OAAO,IAAI,EAAE,CAAC;IAErD,IAAI,CAAC,eAAe,EAAE,QAAQ,EAAE,CAAC,kBAAkB,CAAC;QAClD,GAAG,CAAC,GAAG,CACL,MAAM,EACN,eAAe,CAAC,eAAe;YAC7B,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE;gBACV,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,WAAW,CAAC,cAAc,EAAE,CAAC,CAAC;YAChE,CAAC,CAAC,CACL,CAAC;IAEJ,GAAG,CAAC,GAAG,CAAC,eAAe,CAAC,cAAc,CAAC,CAAC;IAExC,IAAI,CAAC,eAAe,EAAE,QAAQ,EAAE,CAAC,aAAa,CAAC,EAAE,CAAC;QAChD,MAAM,gBAAgB,GAAG,eAAe,CAAC,UAAU;YACjD,CAAC,CAAC,MAAM,eAAe,CAAC,UAAU,CAAC,WAAW,CAAC;YAC/C,CAAC,CAAC,MAAM,mBAAmB,CAAC,WAAW,CAAC,CAAC;QAC3C,iBAAiB,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;IAC1C,CAAC;IAED,IACE,CAAC,eAAe,EAAE,QAAQ,EAAE,CAAC,aAAa,CAAC;QAC3C,WAAW,CAAC,cAAc,EAC1B,CAAC;QACD,MAAM,UAAU,GAAG,eAAe,CAAC,UAAU;YAC3C,CAAC,CAAC,MAAM,eAAe,CAAC,UAAU,CAAC,WAAW,CAAC;YAC/C,CAAC,CAAC,MAAM,aAAa,CAAC,WAAW,CAAC,CAAC;QACrC,iBAAiB,CAAC,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,CAAC,eAAe,EAAE,QAAQ,EAAE,CAAC,sBAAsB,CAAC,EAAE,CAAC;QACzD,MAAM,YAAY,GAAG,eAAe,CAAC,kBAAkB;YACrD,CAAC,CAAC,MAAM,eAAe,CAAC,kBAAkB,CAAC,WAAW,CAAC;YACvD,CAAC,CAAC,MAAM,qBAAqB,CAAC,WAAW,CAAC,CAAC;QAC7C,iBAAiB,CAAC,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAC9C,CAAC;IAED,GAAG,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;IAC3B,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,oCAAoC,EAAE,CAAC,CAAC;IAExD,IACE,WAAW,CAAC,OAAO;QACnB,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,KAAK,MAAM;YACjC,WAAW,CAAC,OAAO,CAAC,gBAAgB,KAAK,IAAI,CAAC;QAEhD,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,gBAAgB,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,CAAC;IAE5D,IAAI,aAAa,EAAE,UAAU;QAC3B,aAAa,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YAC1C,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAClB,CAAC,CAAC,CAAC;IAEL,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,EAAE;QACnB,MAAM,IAAI,QAAQ,CAChB,iBAAiB,EACjB,GAAG,EACH,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,EACpB,eAAe,CAChB,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,mBAAmB,EAAE,QAAQ,EAAE,CAAC,sBAAsB,CAAC;QAC1D,GAAG,CAAC,GAAG,CAAC,mBAAmB,CAAC,kBAAkB,IAAI,YAAY,CAAC,CAAC;IAElE,OAAO,GAAG,CAAC;AACb,CAAC","sourcesContent":["import express, { Router } from \"express\";\nimport cors from \"cors\";\nimport cookieParser from \"cookie-parser\";\nimport { getAuthRouter } from \"./modules/auth/auth.router\";\nimport {\n getPrismaModelsRouter,\n getAvailableResourcesAndRoutesRouter,\n} from \"./modules/base/base.router\";\nimport errorHandler from \"./modules/error-handler/error-handler.controller\";\nimport { rateLimit } from \"express-rate-limit\";\nimport compression from \"compression\";\nimport { handleRequestLogs } from \"./modules/base/base.middlewares\";\nimport { loadPrismaModule } from \"./utils/helpers/prisma.helpers\";\nimport { getFileUploadRouter } from \"./modules/file-upload/file-upload.router\";\nimport { ArkosConfig } from \"./types/arkos-config\";\nimport { queryParser } from \"./utils/helpers/query-parser.helpers\";\nimport deepmerge from \"./utils/helpers/deepmerge.helper\";\nimport { getSwaggerRouter } from \"./modules/swagger/swagger.router\";\nimport { loadAllModuleComponents } from \"./utils/dynamic-loader\";\nimport { AppError } from \"./exports/error-handler\";\nimport debuggerService from \"./modules/debugger/debugger.service\";\n\nexport const app: express.Express = express();\nconst knowModulesRouter = Router();\n\nexport async function bootstrap(\n arkosConfig: ArkosConfig\n): Promise<express.Express> {\n await Promise.all([\n loadPrismaModule(),\n loadAllModuleComponents(arkosConfig),\n arkosConfig?.configureApp && (await arkosConfig?.configureApp(app)),\n ]);\n\n const middlewaresConfig = arkosConfig?.middlewares;\n const disabledMiddlewares = middlewaresConfig?.disable \|\| [];\n const replacedMiddlewares = middlewaresConfig?.replace \|\| {};\n\n if (!disabledMiddlewares?.includes?.(\"compression\"))\n app.use(\n replacedMiddlewares.compression \|\|\n compression(arkosConfig?.compressionOptions)\n );\n\n if (!disabledMiddlewares?.includes?.(\"global-rate-limit\"))\n app.use(\n replacedMiddlewares.globalRateLimit \|\|\n rateLimit(\n deepmerge(\n {\n windowMs: 60 * 1000,\n limit: 300,\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 arkosConfig?.globalRequestRateLimitOptions \|\| {}\n )\n )\n );\n\n if (!disabledMiddlewares?.includes?.(\"cors\"))\n app.use(\n replacedMiddlewares.cors \|\|\n cors(\n arkosConfig?.cors?.customHandler\n ? arkosConfig.cors.customHandler\n : deepmerge(\n {\n origin: (\n origin: string,\n cb: (err: Error \| null, allow?: boolean) => void\n ) => {\n const allowed = arkosConfig?.cors?.allowedOrigins;\n\n if (allowed === \"\") cb(null, true);\n else if (Array.isArray(allowed))\n cb(null, !origin \|\| allowed?.includes?.(origin));\n else if (typeof allowed === \"string\")\n cb(null, !origin \|\| allowed === origin);\n else cb(null, false);\n },\n\n methods: [\"GET\", \"POST\", \"PUT\", \"DELETE\", \"PATCH\", \"OPTIONS\"],\n allowedHeaders: [\n \"Content-Type\",\n \"Authorization\",\n \"Connection\",\n ],\n credentials: true,\n },\n arkosConfig?.cors?.options \|\| {}\n )\n )\n );\n\n if (!disabledMiddlewares?.includes?.(\"express-json\"))\n app.use(\n replacedMiddlewares.expressJson \|\|\n express.json(arkosConfig?.jsonBodyParserOptions)\n );\n\n if (!disabledMiddlewares?.includes?.(\"cookie-parser\"))\n app.use(\n replacedMiddlewares.cookieParser \|\|\n cookieParser(...[...(arkosConfig?.cookieParserParameters \|\| [])])\n );\n\n if (!disabledMiddlewares?.includes?.(\"query-parser\"))\n app.use(\n replacedMiddlewares.queryParser \|\|\n queryParser(\n deepmerge(\n {\n parseNull: true,\n parseUndefined: true,\n parseBoolean: true,\n },\n arkosConfig?.queryParserOptions \|\| {}\n )\n )\n );\n\n if (!disabledMiddlewares?.includes?.(\"request-logger\"))\n app.use(replacedMiddlewares.requestLogger \|\| handleRequestLogs);\n\n if (arkosConfig?.middlewares?.additional)\n arkosConfig.middlewares.additional.forEach((middleware) => {\n app.use(middleware);\n });\n\n app.use(debuggerService.logRequestInfo);\n\n const routersConfig = arkosConfig?.routers;\n const disabledRouters = routersConfig?.disable \|\| [];\n const replacedRouters = routersConfig?.replace \|\| {};\n\n if (!disabledRouters?.includes?.(\"welcome-endpoint\"))\n app.get(\n \"/api\",\n replacedRouters.welcomeEndpoint \|\|\n ((_, res) => {\n res.status(200).json({ message: arkosConfig.welcomeMessage });\n })\n );\n\n app.use(debuggerService.logRequestInfo);\n\n if (!disabledRouters?.includes?.(\"file-upload\")) {\n const fileUploadRouter = replacedRouters.fileUpload\n ? await replacedRouters.fileUpload(arkosConfig)\n : await getFileUploadRouter(arkosConfig);\n knowModulesRouter.use(fileUploadRouter);\n }\n\n if (\n !disabledRouters?.includes?.(\"auth-router\") &&\n arkosConfig.authentication\n ) {\n const authRouter = replacedRouters.authRouter\n ? await replacedRouters.authRouter(arkosConfig)\n : await getAuthRouter(arkosConfig);\n knowModulesRouter.use(\"/api\", authRouter);\n }\n\n if (!disabledRouters?.includes?.(\"prisma-models-router\")) {\n const modelsRouter = replacedRouters.prismaModelsRouter\n ? await replacedRouters.prismaModelsRouter(arkosConfig)\n : await getPrismaModelsRouter(arkosConfig);\n knowModulesRouter.use(\"/api\", modelsRouter);\n }\n\n app.use(knowModulesRouter);\n app.use(\"/api\", getAvailableResourcesAndRoutesRouter());\n\n if (\n arkosConfig.swagger &&\n (process.env.ARKOS_BUILD !== \"true\" \|\|\n arkosConfig.swagger.enableAfterBuild === true)\n )\n app.use(\"/api\", await getSwaggerRouter(arkosConfig, app));\n\n if (routersConfig?.additional)\n routersConfig.additional.forEach((router) => {\n app.use(router);\n });\n\n app.use(\"\", (req) => {\n throw new AppError(\n \"Route not found\",\n 404,\n { route: req.route },\n \"RouteNotFound\"\n );\n });\n\n if (!disabledMiddlewares?.includes?.(\"global-error-handler\"))\n app.use(replacedMiddlewares.globalErrorHandler \|\| errorHandler);\n\n return app;\n}\n"]}
1	+ {"version":3,"file":"app.js","sourceRoot":"","sources":["../../src/app.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,EAAE,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAC1C,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,YAAY,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EACL,qBAAqB,EACrB,oCAAoC,GACrC,MAAM,4BAA4B,CAAC;AACpC,OAAO,YAAY,MAAM,kDAAkD,CAAC;AAC5E,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,WAAW,MAAM,aAAa,CAAC;AACtC,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAClE,OAAO,EAAE,mBAAmB,EAAE,MAAM,0CAA0C,CAAC;AAE/E,OAAO,EAAE,WAAW,EAAE,MAAM,sCAAsC,CAAC;AACnE,OAAO,SAAS,MAAM,kCAAkC,CAAC;AACzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACpE,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AACnD,OAAO,eAAe,MAAM,qCAAqC,CAAC;AAElE,MAAM,CAAC,MAAM,GAAG,GAAoB,OAAO,EAAE,CAAC;AAC9C,MAAM,iBAAiB,GAAG,MAAM,EAAE,CAAC;AAEnC,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,WAAwB;IAExB,MAAM,OAAO,CAAC,GAAG,CAAC;QAChB,gBAAgB,EAAE;QAClB,uBAAuB,CAAC,WAAW,CAAC;QACpC,WAAW,EAAE,YAAY,IAAI,CAAC,MAAM,WAAW,EAAE,YAAY,CAAC,GAAG,CAAC,CAAC;KACpE,CAAC,CAAC;IAEH,MAAM,iBAAiB,GAAG,WAAW,EAAE,WAAW,CAAC;IACnD,MAAM,mBAAmB,GAAG,iBAAiB,EAAE,OAAO,IAAI,EAAE,CAAC;IAC7D,MAAM,mBAAmB,GAAG,iBAAiB,EAAE,OAAO,IAAI,EAAE,CAAC;IAE7D,IAAI,CAAC,mBAAmB,EAAE,QAAQ,EAAE,CAAC,aAAa,CAAC;QACjD,GAAG,CAAC,GAAG,CACL,mBAAmB,CAAC,WAAW;YAC7B,WAAW,CAAC,WAAW,EAAE,kBAAkB,CAAC,CAC/C,CAAC;IAEJ,IAAI,CAAC,mBAAmB,EAAE,QAAQ,EAAE,CAAC,mBAAmB,CAAC;QACvD,GAAG,CAAC,GAAG,CACL,mBAAmB,CAAC,eAAe;YACjC,SAAS,CACP,SAAS,CACP;gBACE,QAAQ,EAAE,EAAE,GAAG,IAAI;gBACnB,KAAK,EAAE,GAAG;gBACV,eAAe,EAAE,SAAS;gBAC1B,aAAa,EAAE,KAAK;gBACpB,OAAO,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE;oBAClB,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;wBACnB,OAAO,EAAE,2CAA2C;qBACrD,CAAC,CAAC;gBACL,CAAC;aACF,EACD,WAAW,EAAE,6BAA6B,IAAI,EAAE,CACjD,CACF,CACJ,CAAC;IAEJ,IAAI,CAAC,mBAAmB,EAAE,QAAQ,EAAE,CAAC,MAAM,CAAC;QAC1C,GAAG,CAAC,GAAG,CACL,mBAAmB,CAAC,IAAI;YACtB,IAAI,CACF,WAAW,EAAE,IAAI,EAAE,aAAa;gBAC9B,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,aAAa;gBAChC,CAAC,CAAC,SAAS,CACP;oBACE,MAAM,EAAE,CACN,MAAc,EACd,EAAgD,EAChD,EAAE;wBACF,MAAM,OAAO,GAAG,WAAW,EAAE,IAAI,EAAE,cAAc,CAAC;wBAElD,IAAI,OAAO,KAAK,GAAG;4BAAE,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;6BAC/B,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;4BAC7B,EAAE,CAAC,IAAI,EAAE,CAAC,MAAM,IAAI,OAAO,EAAE,QAAQ,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;6BAC9C,IAAI,OAAO,OAAO,KAAK,QAAQ;4BAClC,EAAE,CAAC,IAAI,EAAE,CAAC,MAAM,IAAI,OAAO,KAAK,MAAM,CAAC,CAAC;;4BACrC,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;oBACvB,CAAC;oBAED,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,CAAC;oBAC7D,cAAc,EAAE;wBACd,cAAc;wBACd,eAAe;wBACf,YAAY;qBACb;oBACD,WAAW,EAAE,IAAI;iBAClB,EACD,WAAW,EAAE,IAAI,EAAE,OAAO,IAAI,EAAE,CACjC,CACN,CACJ,CAAC;IAEJ,IAAI,CAAC,mBAAmB,EAAE,QAAQ,EAAE,CAAC,cAAc,CAAC;QAClD,GAAG,CAAC,GAAG,CACL,mBAAmB,CAAC,WAAW;YAC7B,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,qBAAqB,CAAC,CACnD,CAAC;IAEJ,IAAI,CAAC,mBAAmB,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC;QACnD,GAAG,CAAC,GAAG,CACL,mBAAmB,CAAC,YAAY;YAC9B,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,sBAAsB,IAAI,EAAE,CAAC,CAAC,CAAC,CACpE,CAAC;IAEJ,IAAI,CAAC,mBAAmB,EAAE,QAAQ,EAAE,CAAC,cAAc,CAAC;QAClD,GAAG,CAAC,GAAG,CACL,mBAAmB,CAAC,WAAW;YAC7B,WAAW,CACT,SAAS,CACP;gBACE,SAAS,EAAE,IAAI;gBACf,cAAc,EAAE,IAAI;gBACpB,YAAY,EAAE,IAAI;aACnB,EACD,WAAW,EAAE,kBAAkB,IAAI,EAAE,CACtC,CACF,CACJ,CAAC;IAEJ,IAAI,CAAC,mBAAmB,EAAE,QAAQ,EAAE,CAAC,gBAAgB,CAAC;QACpD,GAAG,CAAC,GAAG,CAAC,mBAAmB,CAAC,aAAa,IAAI,iBAAiB,CAAC,CAAC;IAElE,IAAI,WAAW,EAAE,WAAW,EAAE,UAAU;QACtC,WAAW,CAAC,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YACxD,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC;IAEL,GAAG,CAAC,GAAG,CAAC,eAAe,CAAC,cAAc,CAAC,CAAC;IAExC,MAAM,aAAa,GAAG,WAAW,EAAE,OAAO,CAAC;IAC3C,MAAM,eAAe,GAAG,aAAa,EAAE,OAAO,IAAI,EAAE,CAAC;IACrD,MAAM,eAAe,GAAG,aAAa,EAAE,OAAO,IAAI,EAAE,CAAC;IAErD,IAAI,CAAC,eAAe,EAAE,QAAQ,EAAE,CAAC,kBAAkB,CAAC;QAClD,GAAG,CAAC,GAAG,CACL,MAAM,EACN,eAAe,CAAC,eAAe;YAC7B,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE;gBACV,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,WAAW,CAAC,cAAc,EAAE,CAAC,CAAC;YAChE,CAAC,CAAC,CACL,CAAC;IAEJ,GAAG,CAAC,GAAG,CAAC,eAAe,CAAC,cAAc,CAAC,CAAC;IAExC,IAAI,CAAC,eAAe,EAAE,QAAQ,EAAE,CAAC,aAAa,CAAC,EAAE,CAAC;QAChD,MAAM,gBAAgB,GAAG,eAAe,CAAC,UAAU;YACjD,CAAC,CAAC,MAAM,eAAe,CAAC,UAAU,CAAC,WAAW,CAAC;YAC/C,CAAC,CAAC,MAAM,mBAAmB,CAAC,WAAW,CAAC,CAAC;QAC3C,iBAAiB,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;IAC1C,CAAC;IAED,IACE,CAAC,eAAe,EAAE,QAAQ,EAAE,CAAC,aAAa,CAAC;QAC3C,WAAW,CAAC,cAAc,EAC1B,CAAC;QACD,MAAM,UAAU,GAAG,eAAe,CAAC,UAAU;YAC3C,CAAC,CAAC,MAAM,eAAe,CAAC,UAAU,CAAC,WAAW,CAAC;YAC/C,CAAC,CAAC,MAAM,aAAa,CAAC,WAAW,CAAC,CAAC;QACrC,iBAAiB,CAAC,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,CAAC,eAAe,EAAE,QAAQ,EAAE,CAAC,sBAAsB,CAAC,EAAE,CAAC;QACzD,MAAM,YAAY,GAAG,eAAe,CAAC,kBAAkB;YACrD,CAAC,CAAC,MAAM,eAAe,CAAC,kBAAkB,CAAC,WAAW,CAAC;YACvD,CAAC,CAAC,MAAM,qBAAqB,CAAC,WAAW,CAAC,CAAC;QAC7C,iBAAiB,CAAC,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAC9C,CAAC;IAED,GAAG,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;IAC3B,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,oCAAoC,EAAE,CAAC,CAAC;IAExD,IAAI,aAAa,EAAE,UAAU;QAC3B,aAAa,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YAC1C,GAAG,CAAC,GAAG,CAAC,MAAa,CAAC,CAAC;QACzB,CAAC,CAAC,CAAC;IAML,IACE,WAAW,CAAC,OAAO;QACnB,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,KAAK,MAAM;YACjC,WAAW,CAAC,OAAO,CAAC,gBAAgB,KAAK,IAAI,CAAC;QAEhD,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,gBAAgB,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,CAAC;IAE5D,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,EAAE;QACnB,MAAM,IAAI,QAAQ,CAChB,iBAAiB,EACjB,GAAG,EACH,EAAE,KAAK,EAAE,GAAG,CAAC,IAAI,EAAE,EACnB,eAAe,CAChB,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,mBAAmB,EAAE,QAAQ,EAAE,CAAC,sBAAsB,CAAC;QAC1D,GAAG,CAAC,GAAG,CAAC,mBAAmB,CAAC,kBAAkB,IAAI,YAAY,CAAC,CAAC;IAElE,OAAO,GAAG,CAAC;AACb,CAAC","sourcesContent":["import express, { Router } from \"express\";\nimport cors from \"cors\";\nimport cookieParser from \"cookie-parser\";\nimport { getAuthRouter } from \"./modules/auth/auth.router\";\nimport {\n getPrismaModelsRouter,\n getAvailableResourcesAndRoutesRouter,\n} from \"./modules/base/base.router\";\nimport errorHandler from \"./modules/error-handler/error-handler.controller\";\nimport { rateLimit } from \"express-rate-limit\";\nimport compression from \"compression\";\nimport { handleRequestLogs } from \"./modules/base/base.middlewares\";\nimport { loadPrismaModule } from \"./utils/helpers/prisma.helpers\";\nimport { getFileUploadRouter } from \"./modules/file-upload/file-upload.router\";\nimport { ArkosConfig } from \"./types/arkos-config\";\nimport { queryParser } from \"./utils/helpers/query-parser.helpers\";\nimport deepmerge from \"./utils/helpers/deepmerge.helper\";\nimport { getSwaggerRouter } from \"./modules/swagger/swagger.router\";\nimport { loadAllModuleComponents } from \"./utils/dynamic-loader\";\nimport { AppError } from \"./exports/error-handler\";\nimport debuggerService from \"./modules/debugger/debugger.service\";\n\nexport const app: express.Express = express();\nconst knowModulesRouter = Router();\n\nexport async function bootstrap(\n arkosConfig: ArkosConfig\n): Promise<express.Express> {\n await Promise.all([\n loadPrismaModule(),\n loadAllModuleComponents(arkosConfig),\n arkosConfig?.configureApp && (await arkosConfig?.configureApp(app)),\n ]);\n\n const middlewaresConfig = arkosConfig?.middlewares;\n const disabledMiddlewares = middlewaresConfig?.disable \|\| [];\n const replacedMiddlewares = middlewaresConfig?.replace \|\| {};\n\n if (!disabledMiddlewares?.includes?.(\"compression\"))\n app.use(\n replacedMiddlewares.compression \|\|\n compression(arkosConfig?.compressionOptions)\n );\n\n if (!disabledMiddlewares?.includes?.(\"global-rate-limit\"))\n app.use(\n replacedMiddlewares.globalRateLimit \|\|\n rateLimit(\n deepmerge(\n {\n windowMs: 60 * 1000,\n limit: 300,\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 arkosConfig?.globalRequestRateLimitOptions \|\| {}\n )\n )\n );\n\n if (!disabledMiddlewares?.includes?.(\"cors\"))\n app.use(\n replacedMiddlewares.cors \|\|\n cors(\n arkosConfig?.cors?.customHandler\n ? arkosConfig.cors.customHandler\n : deepmerge(\n {\n origin: (\n origin: string,\n cb: (err: Error \| null, allow?: boolean) => void\n ) => {\n const allowed = arkosConfig?.cors?.allowedOrigins;\n\n if (allowed === \"\") cb(null, true);\n else if (Array.isArray(allowed))\n cb(null, !origin \|\| allowed?.includes?.(origin));\n else if (typeof allowed === \"string\")\n cb(null, !origin \|\| allowed === origin);\n else cb(null, false);\n },\n\n methods: [\"GET\", \"POST\", \"PUT\", \"DELETE\", \"PATCH\", \"OPTIONS\"],\n allowedHeaders: [\n \"Content-Type\",\n \"Authorization\",\n \"Connection\",\n ],\n credentials: true,\n },\n arkosConfig?.cors?.options \|\| {}\n )\n )\n );\n\n if (!disabledMiddlewares?.includes?.(\"express-json\"))\n app.use(\n replacedMiddlewares.expressJson \|\|\n express.json(arkosConfig?.jsonBodyParserOptions)\n );\n\n if (!disabledMiddlewares?.includes?.(\"cookie-parser\"))\n app.use(\n replacedMiddlewares.cookieParser \|\|\n cookieParser(...[...(arkosConfig?.cookieParserParameters \|\| [])])\n );\n\n if (!disabledMiddlewares?.includes?.(\"query-parser\"))\n app.use(\n replacedMiddlewares.queryParser \|\|\n queryParser(\n deepmerge(\n {\n parseNull: true,\n parseUndefined: true,\n parseBoolean: true,\n },\n arkosConfig?.queryParserOptions \|\| {}\n )\n )\n );\n\n if (!disabledMiddlewares?.includes?.(\"request-logger\"))\n app.use(replacedMiddlewares.requestLogger \|\| handleRequestLogs);\n\n if (arkosConfig?.middlewares?.additional)\n arkosConfig.middlewares.additional.forEach((middleware) => {\n app.use(middleware);\n });\n\n app.use(debuggerService.logRequestInfo);\n\n const routersConfig = arkosConfig?.routers;\n const disabledRouters = routersConfig?.disable \|\| [];\n const replacedRouters = routersConfig?.replace \|\| {};\n\n if (!disabledRouters?.includes?.(\"welcome-endpoint\"))\n app.get(\n \"/api\",\n replacedRouters.welcomeEndpoint \|\|\n ((_, res) => {\n res.status(200).json({ message: arkosConfig.welcomeMessage });\n })\n );\n\n app.use(debuggerService.logRequestInfo);\n\n if (!disabledRouters?.includes?.(\"file-upload\")) {\n const fileUploadRouter = replacedRouters.fileUpload\n ? await replacedRouters.fileUpload(arkosConfig)\n : await getFileUploadRouter(arkosConfig);\n knowModulesRouter.use(fileUploadRouter);\n }\n\n if (\n !disabledRouters?.includes?.(\"auth-router\") &&\n arkosConfig.authentication\n ) {\n const authRouter = replacedRouters.authRouter\n ? await replacedRouters.authRouter(arkosConfig)\n : await getAuthRouter(arkosConfig);\n knowModulesRouter.use(\"/api\", authRouter);\n }\n\n if (!disabledRouters?.includes?.(\"prisma-models-router\")) {\n const modelsRouter = replacedRouters.prismaModelsRouter\n ? await replacedRouters.prismaModelsRouter(arkosConfig)\n : await getPrismaModelsRouter(arkosConfig);\n knowModulesRouter.use(\"/api\", modelsRouter);\n }\n\n app.use(knowModulesRouter);\n app.use(\"/api\", getAvailableResourcesAndRoutesRouter());\n\n if (routersConfig?.additional)\n routersConfig.additional.forEach((router) => {\n app.use(router as any);\n });\n\n /\n Must be last called in order to be able to get all\n * routes built using ArkosRouter\n /\n if (\n arkosConfig.swagger &&\n (process.env.ARKOS_BUILD !== \"true\" \|\|\n arkosConfig.swagger.enableAfterBuild === true)\n )\n app.use(\"/api\", await getSwaggerRouter(arkosConfig, app));\n\n app.use(\"\", (req) => {\n throw new AppError(\n \"Route not found\",\n 404,\n { route: req.path },\n \"RouteNotFound\"\n );\n });\n\n if (!disabledMiddlewares?.includes?.(\"global-error-handler\"))\n app.use(replacedMiddlewares.globalErrorHandler \|\| errorHandler);\n\n return app;\n}\n"]}

package/dist/esm/modules/swagger/swagger.router.js CHANGED Viewed

@@ -10,9 +10,11 @@ import { generateOpenAPIFromApp } from "../../utils/arkos-router/index.js";
 import getFileUploadJsonSchemaPaths from "./utils/helpers/get-file-upload-json-schema-paths.js";
 const swaggerRouter = Router();
 export async function getSwaggerRouter(arkosConfig, app) {
-    let defaultJsonSchemas = await getOpenAPIJsonSchemasByConfigMode(arkosConfig);
-    const defaultModelsPaths = await generatePathsForModels(arkosConfig);
-    const pathsFromCustomArkosRouters = generateOpenAPIFromApp(app);
+    let [defaultJsonSchemas, defaultModelsPaths, pathsFromCustomArkosRouters] = await Promise.all([
+        await getOpenAPIJsonSchemasByConfigMode(arkosConfig),
+        await generatePathsForModels(arkosConfig),
+        await generateOpenAPIFromApp(app),
+    ]);
     const fileUploadDefaultPaths = getFileUploadJsonSchemaPaths(arkosConfig);
     const missingJsonSchemas = await missingJsonSchemaGenerator.generateMissingJsonSchemas(defaultModelsPaths, defaultJsonSchemas, arkosConfig);
     defaultJsonSchemas = {

package/dist/esm/modules/swagger/swagger.router.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"swagger.router.js","sourceRoot":"","sources":["../../../../src/modules/swagger/swagger.router.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,YAAY,MAAM,eAAe,CAAC;AAEzC,OAAO,SAAS,MAAM,sCAAsC,CAAC;AAC7D,OAAO,EACL,sBAAsB,EACtB,iCAAiC,GAClC,MAAM,wCAAwC,CAAC;AAChD,OAAO,0BAA0B,MAAM,gDAAgD,CAAC;AACxF,OAAO,uBAAuB,MAAM,6CAA6C,CAAC;AAClF,OAAO,EAAE,mCAAmC,EAAE,MAAM,oCAAoC,CAAC;AACzF,OAAO,yBAAyB,MAAM,qEAAqE,CAAC;AAC5G,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElE,OAAO,4BAA4B,MAAM,mDAAmD,CAAC;AAE7F,MAAM,aAAa,GAAG,MAAM,EAAE,CAAC;AAE/B,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,WAAwB,EACxB,GAAoB;IAEpB,IAAI,kBAAkB,~~GAAG~~,~~MAAM~~,~~iCAAiC~~,CAAC,~~WAAW~~,CAAC,CAAC;~~IAC9E~~,MAAM,~~kBAAkB~~,~~GAAG~~,MAAM,sBAAsB,CAAC,WAAW,CAAC~~,CAAC~~;~~IACrE~~,MAAM,~~2BAA2B,GAAG,~~sBAAsB,CAAC,GAAG,CAAC,CAAC;~~IAEhE~~,MAAM,sBAAsB,GAAG,4BAA4B,CAAC,WAAW,CAAC,CAAC;IACzE,MAAM,kBAAkB,GACtB,MAAM,0BAA0B,CAAC,0BAA0B,CACzD,kBAAkB,EAClB,kBAAkB,EAClB,WAAW,CACZ,CAAC;IAEJ,kBAAkB,GAAG;QACnB,GAAG,kBAAkB;QACrB,GAAG,kBAAkB;QACrB,GAAG,yBAAyB,CAAC,WAAW,CAAC;KAC1C,CAAC;IAEF,MAAM,cAAc,GAAG,SAAS,CAC9B,CAAC,MAAM,uBAAuB,CAC5B;QACE,GAAG,kBAAkB;QACrB,GAAG,sBAAsB;QACzB,GAAG,2BAA2B;KAC/B,EACD,kBAAkB,CACnB,CAAC,IAAI,EAAE,EACR,WAAW,CAAC,OAAO,IAAI,EAAE,CACA,CAAC;IAE5B,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,EAAE,GAAG,cAAc,EAAE,OAAQ,CAAC;IAE5D,MAAM,oBAAoB,GAAG,YAAY,CAAC;QACxC,UAAU,EAAE,UAA4C;QACxD,GAAG,OAAO;KACX,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,MAAM,mCAAmC,CACtD,+BAA+B,CAChC,CAAC;IAEF,aAAa,CAAC,GAAG,CACf,cAAe,CAAC,QAAS,EACzB,MAAM,CAAC,YAAY,CAAC;QAClB,OAAO,EAAE,oBAAoB;QAC7B,GAAG,cAAc,EAAE,+BAA+B;KACnD,CAAC,CACH,CAAC;IAEF,OAAO,aAAa,CAAC;AACvB,CAAC","sourcesContent":["import { Router } from \"express\";\nimport swaggerJsdoc from \"swagger-jsdoc\";\nimport { ArkosConfig } from \"../../types/arkos-config\";\nimport deepmerge from \"../../utils/helpers/deepmerge.helper\";\nimport {\n generatePathsForModels,\n getOpenAPIJsonSchemasByConfigMode,\n} from \"./utils/helpers/swagger.router.helpers\";\nimport missingJsonSchemaGenerator from \"./utils/helpers/missing-json-schemas-generator\";\nimport getSwaggerDefaultConfig from \"./utils/helpers/get-swagger-default-configs\";\nimport { importEsmPreventingTsTransformation } from \"../../utils/helpers/global.helpers\";\nimport generateSystemJsonSchemas from \"./utils/helpers/json-schema-generators/generate-system-json-schemas\";\nimport { generateOpenAPIFromApp } from \"../../utils/arkos-router\";\nimport express from \"express\";\nimport getFileUploadJsonSchemaPaths from \"./utils/helpers/get-file-upload-json-schema-paths\";\n\nconst swaggerRouter = Router();\n\nexport async function getSwaggerRouter(\n arkosConfig: ArkosConfig,\n app: express.Express\n): Promise<Router> {\n let defaultJsonSchemas = await getOpenAPIJsonSchemasByConfigMode(arkosConfig);\n ~~const defaultModelsPaths =~~ await generatePathsForModels(arkosConfig);\n ~~const~~ ~~pathsFromCustomArkosRouters =~~ generateOpenAPIFromApp(app);\n\n const fileUploadDefaultPaths = getFileUploadJsonSchemaPaths(arkosConfig);\n const missingJsonSchemas =\n await missingJsonSchemaGenerator.generateMissingJsonSchemas(\n defaultModelsPaths,\n defaultJsonSchemas,\n arkosConfig\n );\n\n defaultJsonSchemas = {\n ...defaultJsonSchemas,\n ...missingJsonSchemas,\n ...generateSystemJsonSchemas(arkosConfig),\n };\n\n const swaggerConfigs = deepmerge(\n (await getSwaggerDefaultConfig(\n {\n ...defaultModelsPaths,\n ...fileUploadDefaultPaths,\n ...pathsFromCustomArkosRouters,\n },\n defaultJsonSchemas\n )) \|\| {},\n arkosConfig.swagger \|\| {}\n ) as ArkosConfig[\"swagger\"];\n\n const { definition, ...options } = swaggerConfigs?.options!;\n\n const swaggerSpecification = swaggerJsdoc({\n definition: definition as swaggerJsdoc.SwaggerDefinition,\n ...options,\n });\n\n const scalar = await importEsmPreventingTsTransformation(\n \"@scalar/express-api-reference\"\n );\n\n swaggerRouter.use(\n swaggerConfigs!.endpoint!,\n scalar.apiReference({\n content: swaggerSpecification,\n ...swaggerConfigs?.scalarApiReferenceConfiguration,\n })\n );\n\n return swaggerRouter;\n}\n"]}
1	+ {"version":3,"file":"swagger.router.js","sourceRoot":"","sources":["../../../../src/modules/swagger/swagger.router.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,YAAY,MAAM,eAAe,CAAC;AAEzC,OAAO,SAAS,MAAM,sCAAsC,CAAC;AAC7D,OAAO,EACL,sBAAsB,EACtB,iCAAiC,GAClC,MAAM,wCAAwC,CAAC;AAChD,OAAO,0BAA0B,MAAM,gDAAgD,CAAC;AACxF,OAAO,uBAAuB,MAAM,6CAA6C,CAAC;AAClF,OAAO,EAAE,mCAAmC,EAAE,MAAM,oCAAoC,CAAC;AACzF,OAAO,yBAAyB,MAAM,qEAAqE,CAAC;AAC5G,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElE,OAAO,4BAA4B,MAAM,mDAAmD,CAAC;AAE7F,MAAM,aAAa,GAAG,MAAM,EAAE,CAAC;AAE/B,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,WAAwB,EACxB,GAAoB;IAEpB,IAAI,CAAC,kBAAkB,EAAE,kBAAkB,EAAE,2BAA2B,CAAC,GACvE,MAAM,OAAO,CAAC,GAAG,CAAC;QAChB,MAAM,iCAAiC,CAAC,WAAW,CAAC;QACpD,MAAM,sBAAsB,CAAC,WAAW,CAAC;QACzC,MAAM,sBAAsB,CAAC,GAAG,CAAC;KAClC,CAAC,CAAC;IAEL,MAAM,sBAAsB,GAAG,4BAA4B,CAAC,WAAW,CAAC,CAAC;IACzE,MAAM,kBAAkB,GACtB,MAAM,0BAA0B,CAAC,0BAA0B,CACzD,kBAAkB,EAClB,kBAAkB,EAClB,WAAW,CACZ,CAAC;IAEJ,kBAAkB,GAAG;QACnB,GAAG,kBAAkB;QACrB,GAAG,kBAAkB;QACrB,GAAG,yBAAyB,CAAC,WAAW,CAAC;KAC1C,CAAC;IAEF,MAAM,cAAc,GAAG,SAAS,CAC9B,CAAC,MAAM,uBAAuB,CAC5B;QACE,GAAG,kBAAkB;QACrB,GAAG,sBAAsB;QACzB,GAAG,2BAA2B;KAC/B,EACD,kBAAkB,CACnB,CAAC,IAAI,EAAE,EACR,WAAW,CAAC,OAAO,IAAI,EAAE,CACA,CAAC;IAE5B,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,EAAE,GAAG,cAAc,EAAE,OAAQ,CAAC;IAE5D,MAAM,oBAAoB,GAAG,YAAY,CAAC;QACxC,UAAU,EAAE,UAA4C;QACxD,GAAG,OAAO;KACX,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,MAAM,mCAAmC,CACtD,+BAA+B,CAChC,CAAC;IAEF,aAAa,CAAC,GAAG,CACf,cAAe,CAAC,QAAS,EACzB,MAAM,CAAC,YAAY,CAAC;QAClB,OAAO,EAAE,oBAAoB;QAC7B,GAAG,cAAc,EAAE,+BAA+B;KACnD,CAAC,CACH,CAAC;IAEF,OAAO,aAAa,CAAC;AACvB,CAAC","sourcesContent":["import { Router } from \"express\";\nimport swaggerJsdoc from \"swagger-jsdoc\";\nimport { ArkosConfig } from \"../../types/arkos-config\";\nimport deepmerge from \"../../utils/helpers/deepmerge.helper\";\nimport {\n generatePathsForModels,\n getOpenAPIJsonSchemasByConfigMode,\n} from \"./utils/helpers/swagger.router.helpers\";\nimport missingJsonSchemaGenerator from \"./utils/helpers/missing-json-schemas-generator\";\nimport getSwaggerDefaultConfig from \"./utils/helpers/get-swagger-default-configs\";\nimport { importEsmPreventingTsTransformation } from \"../../utils/helpers/global.helpers\";\nimport generateSystemJsonSchemas from \"./utils/helpers/json-schema-generators/generate-system-json-schemas\";\nimport { generateOpenAPIFromApp } from \"../../utils/arkos-router\";\nimport express from \"express\";\nimport getFileUploadJsonSchemaPaths from \"./utils/helpers/get-file-upload-json-schema-paths\";\n\nconst swaggerRouter = Router();\n\nexport async function getSwaggerRouter(\n arkosConfig: ArkosConfig,\n app: express.Express\n): Promise<Router> {\n let [defaultJsonSchemas, defaultModelsPaths, pathsFromCustomArkosRouters] =\n await Promise.all([\n await getOpenAPIJsonSchemasByConfigMode(arkosConfig),\n await generatePathsForModels(arkosConfig),\n await generateOpenAPIFromApp(app),\n ]);\n\n const fileUploadDefaultPaths = getFileUploadJsonSchemaPaths(arkosConfig);\n const missingJsonSchemas =\n await missingJsonSchemaGenerator.generateMissingJsonSchemas(\n defaultModelsPaths,\n defaultJsonSchemas,\n arkosConfig\n );\n\n defaultJsonSchemas = {\n ...defaultJsonSchemas,\n ...missingJsonSchemas,\n ...generateSystemJsonSchemas(arkosConfig),\n };\n\n const swaggerConfigs = deepmerge(\n (await getSwaggerDefaultConfig(\n {\n ...defaultModelsPaths,\n ...fileUploadDefaultPaths,\n ...pathsFromCustomArkosRouters,\n },\n defaultJsonSchemas\n )) \|\| {},\n arkosConfig.swagger \|\| {}\n ) as ArkosConfig[\"swagger\"];\n\n const { definition, ...options } = swaggerConfigs?.options!;\n\n const swaggerSpecification = swaggerJsdoc({\n definition: definition as swaggerJsdoc.SwaggerDefinition,\n ...options,\n });\n\n const scalar = await importEsmPreventingTsTransformation(\n \"@scalar/express-api-reference\"\n );\n\n swaggerRouter.use(\n swaggerConfigs!.endpoint!,\n scalar.apiReference({\n content: swaggerSpecification,\n ...swaggerConfigs?.scalarApiReferenceConfiguration,\n })\n );\n\n return swaggerRouter;\n}\n"]}

package/dist/esm/types/arkos-config.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"arkos-config.js","sourceRoot":"","sources":["../../../src/types/arkos-config.ts"],"names":[],"mappings":"","sourcesContent":["import http from \"http\";\nimport cors from \"cors\";\nimport express from \"express\";\nimport { Options as RateLimitOptions } from \"express-rate-limit\";\nimport cookieParser from \"cookie-parser\";\nimport compression from \"compression\";\nimport { Options as QueryParserOptions } from \"../utils/helpers/query-parser.helpers\";\nimport { ValidatorOptions } from \"class-validator\";\nimport { MsDuration } from \"../modules/auth/utils/helpers/auth.controller.helpers\";\nimport { OpenAPIV3 } from \"openapi-types\";\nimport type { ApiReferenceConfiguration } from \"@scalar/express-api-reference\" with { \"resolution-mode\": \"import\" };\nimport nodemailer from \"nodemailer\";\nimport { ModuleComponents } from \"../utils/dynamic-loader\";\n/*\n Defines the initial configs of the api to be loaded at startup when arkos.init() is called.\n /\nexport type ArkosConfig = {\n /\n Allows to configure request configs\n /\n request?: {\n /\n Allows to configure request parameters\n /\n parameters?: {\n /\n Toggles allowing `VERY DANGEROUS` request paramateres under `req.query` for passing prisma query options.\n \n See more\n /\n allowDangerousPrismaQueryOptions?: boolean;\n };\n };\n /* Message you would like to send, as Json and 200 response when\n * ```curl\n * GET /api\n * ```\n \n ```json\n * { \"message\": \"Welcome to YourAppName\" }\n * ```\n \n default message is: Welcome to our Rest API generated by Arkos, find more about Arkos at www.arkosjs.com.\n \n \n * /\n welcomeMessage?: string;\n /\n Port where the application will run, can be set in 3 ways:\n \n 1. default is 8000\n * 2. PORT under environment variables (Lower precedence)\n * 3. this config option (Higher precedence)\n /\n port?: number \| undefined;\n /\n Allows to listen on a different host than localhost only\n /\n host?: string;\n /\n Defines authentication related configurations, by default is undefined.\n \n See [www.arkosjs.com/docs/core-concepts/authentication-system](https://www.arkosjs.com/docs/core-concepts/authentication-system) for details.\n /\n authentication?: {\n /\n Defines whether to use Static or Dynamic Role-Based Acess Control\n \n Visit [www.arkosjs.com/docs/core-concepts/authentication-system](https://www.arkosjs.com/docs/core-concepts/authentication-system) for more details.\n /\n mode: \"static\" \| \"dynamic\";\n /\n Defines auth login related configurations to customize the api.\n /\n login?: {\n /\n Defines the field that will be used as username by the built-in auth system, by default arkos will look for the field \"username\" in your model User, hence when making login for example you must send:\n \n ```json\n * {\n * \"username\": \"johndoe\",\n * \"password\": \"somePassword123\"\n * }\n * ```\n \n Note: You can also modify the usernameField on the fly by passing it to the request query parameters. example:\n \n ```curl\n * POST /api/auth/login?usernameField=email\n * ```\n \n See more at [www.arkosjs.com/docs/core-concepts/authentication-system#login-with-different-fileds](https://www.arkosjs.com/docs/core-concepts/authentication-system#login-with-different-fileds)\n \n By specifing here another field for username, for example passing \"email\", \"companyCode\" or something else your json will be like:\n \n Example with email\n \n ```json\n * {\n * \"email\": \"john.doe@example.com\",\n * \"password\": \"somePassword123\"\n * }\n * ```\n /\n allowedUsernames?: string[];\n /* Defines wether to send the access token in response after login or only send as cookie, defeault is both./\n sendAccessTokenThrough?: \"cookie-only\" \| \"response-only\" \| \"both\";\n };\n /\n Specifies the regex pattern used by the authentication system to enforce password strength requirements.\n \n Important: If using validation libraries like Zod or class-validator, this will be completely overwritten.\n \n Default: ```/^(?=.[A-Z])(?=.[a-z])(?=.\\d).+$/``` - Ensures the password contains at least one uppercase letter, one lowercase letter, and one numeric digit.\n \n * message: (Optional) A custom error message to display when the password does not meet the required strength criteria.\n /\n passwordValidation?: { regex: RegExp; message?: string };\n /\n Allows to specify the request rate limit for all authentication endpoints but `/api/users/me`.\n * \n * #### Default\n {\n windowMs: 5000,\n limit: 10,\n standardHeaders: \"draft-7\",\n legacyHeaders: false,\n }\n \n * Passing an object not overriding all the default options will only\n * cause it to be deepmerged and not actually replace with empty fields\n * \n @see This is are the options used on the `express-rate-limit` npm package used on epxress. read more about [https://www.npmjs.com/package/express-rate-limit](https://www.npmjs.com/package/express-rate-limit)\n /\n requestRateLimitOptions?: Partial<RateLimitOptions>;\n /*\n JWT (JSON Web Token) authentication configuration.\n \n You can override these values directly in code, or use environment variables:\n \n - `JWT_SECRET`: Secret used to sign and verify JWT tokens.\n * - `JWT_EXPIRES_IN`: Duration string or number indicating when the token should expire (e.g. \"30d\", 3600).\n * - `JWT_COOKIE_SECURE`: Whether the cookie is sent only over HTTPS. Default: `true` in production.\n * - `JWT_COOKIE_HTTP_ONLY`: Whether the cookie is HTTP-only. Default: `true`.\n * - `JWT_COOKIE_SAME_SITE`: Can be \"lax\", \"strict\", or \"none\". Defaults to \"lax\" in dev, \"none\" in prod.\n \n ⚠️ Values passed here take precedence over environment variables.\n /\n jwt?: {\n /* Secret key used for signing and verifying JWT tokens /\n secret?: string;\n /\n Duration after which the JWT token expires.\n * Accepts either a duration string (e.g. \"30d\", \"1h\") or a number in milliseconds.\n * Defaults to \"30d\" if not provided.\n /\n expiresIn?: MsDuration \| number;\n\n /\n Configuration for the JWT cookie sent to the client\n /\n cookie?: {\n /\n Whether the cookie should be marked as secure (sent only over HTTPS).\n * Defaults to `true` in production and `false` in development.\n /\n secure?: boolean;\n\n /\n Whether the cookie should be marked as HTTP-only.\n * Default is `true` to prevent access via JavaScript.\n /\n httpOnly?: boolean;\n\n /\n Controls the SameSite attribute of the cookie.\n * Defaults to \"none\" in production and \"lax\" in development.\n * Options: \"lax\" \| \"strict\" \| \"none\"\n /\n sameSite?: \"lax\" \| \"strict\" \| \"none\";\n };\n };\n };\n /* Allows to customize and toggle the built-in validation, by default it is set to `false`. If true is passed it will use validation with the default resolver set to `class-validator` if you intend to change the resolver to `zod` do the following:\n \n ```ts\n * // src/app.ts\n * import arkos from 'arkos'\n \n arkos.init({\n * validation: {\n * resolver: \"zod\"\n * }\n * })\n * ```\n \n @See [www.arkosjs.com/docs/core-concepts/request-data-validation](https://www.arkosjs.com/docs/core-concepts/request-data-validation) for more details.\n /\n validation?: {\n /\n Defines whether to use strict request validation, it means in every request using `ArkosRouter()` you must pass the validation options with all options (e.g: query, params, body, etc.).\n \n How It Works:\n * - If it is true, Arkos will require all the options a stated above on the routes and if you don't pass it will throw an error.\n * What if you don't want to pass a validator to some options?\n * - You will need to pass `undefined` to the validator option (see example below), this way Arkos will throw an error if something is passed to `req.query` if you passed undefined as validator into `validation.query`\n \n ```ts\n * import { ArkosRouter } from \"arkos\"\n \n const router = ArkosRouter()\n \n router.get({\n * route: \"/api/posts\",\n * validation: {\n * query: undefined\n * }\n * })\n \n ```\n /\n strict?: boolean;\n } & (\n \| {\n resolver?: \"class-validator\";\n /\n ValidatorOptions to used while validating request data.\n \n Default:\n * ```ts\n * {\n * whitelist: true\n * }\n * ```\n /\n validationOptions?: ValidatorOptions;\n }\n \| {\n resolver?: \"zod\";\n validationOptions?: Record<string, any>;\n }\n );\n /\n Defines file upload configurations\n \n See [www.arkosjs.com/docs/core-concepts/file-upload#costum-configurations](https://www.arkosjs.com/docs/core-concepts/file-upload#costum-configurations)\n /\n fileUpload?: {\n /\n Defiens the base file upload directory, default is set to /uploads (on root directory)\n \n When setting up a path dir always now that root directory will be the starting reference.\n \n #### Example\n * passing `../my-arkos-uploaded-files`\n \n Will save uploaded files one level outside the root dir inside `my-arkos-uploaded-files`\n \n NB: You must be aware of permissions on your server to acess files outside your project directory.\n \n /\n baseUploadDir?: string;\n /*\n Changes the default `/api/uploads` base route for accessing file upload route.\n \n #### IMPORTANT\n * Changing this will not affect the `baseUploadDir` folder. You can\n * pass here `/api/files/my-user-files` and `baseUploadDir` be `/uploaded-files`.\n \n /\n baseRoute?: string;\n /*\n Defines options for `express.static(somePath, someOptions)`\n \n #### Default:\n \n ```ts\n {\n maxAge: \"1y\",\n etag: true,\n lastModified: true,\n dotfiles: \"ignore\",\n fallthrough: true,\n index: false,\n cacheControl: true,\n }\n ```\n * \n * By passing your custom options have in mind that it\n * will be deepmerged with the default.\n * \n * Visit [https://expressjs.com/en/4x/api.html#express.static](https://expressjs.com/en/4x/api.html#express.static) for more understanding.\n * \n /\n expressStaticOptions?: Parameters<typeof express.static>[1];\n /\n Defines upload restrictions for each file type: image, video, document or other.\n \n #### Important:\n * Passing an object without overriding everything will only cause it\n * to be deepmerged with the default options.\n \n See [www.arkosjs.com/docs/api-reference/default-supported-upload-files](https://www.arkosjs.com/docs/api-reference/default-supported-upload-files) for detailed explanation about default values.\n * ```\n /\n restrictions?: {\n images?: {\n maxCount?: number;\n maxSize?: number;\n supportedFilesRegex?: RegExp;\n };\n videos?: {\n maxCount?: number;\n maxSize?: number;\n supportedFilesRegex?: RegExp;\n };\n documents?: {\n maxCount?: number;\n maxSize?: number;\n supportedFilesRegex?: RegExp;\n };\n files?: {\n maxCount?: number;\n maxSize?: number;\n supportedFilesRegex?: RegExp;\n };\n };\n };\n /\n Allows to specify the request rate limit for all endpoints.\n * \n * #### Default\n ```ts\n {\n windowMs: 60 * 1000,\n limit: 1000,\n standardHeaders: \"draft-7\",\n legacyHeaders: false,\n }\n ```\n * \n * Passing an object not overriding all the default options will only\n * cause it to be deepmerged and not actually replace with empty fields\n * \n * This is are the options used on the `express-rate-limit` npm package used on epxress. read more about [https://www.npmjs.com/package/express-rate-limit](https://www.npmjs.com/package/express-rate-limit)\n /\n globalRequestRateLimitOptions?: Partial<RateLimitOptions>;\n /\n Defines options for the built-in express.json() middleware\n * Nothing is passed by default.\n /\n jsonBodyParserOptions?: Parameters<typeof express.json>[0];\n /\n Allows to pass paremeters to cookieParser from npm package cookie-parser\n * Nothing is passed by default.\n \n See [www.npmjs.com/package/cookie-parser](https://www.npmjs.com/package/cookie-parser) for further details.\n /\n cookieParserParameters?: Parameters<typeof cookieParser>;\n /\n Allows to define options for npm package compression\n * Nothing is passed by default.\n \n See [www.npmjs.com/package/compression](https://www.npmjs.com/package/compression) for further details.\n /\n compressionOptions?: compression.CompressionOptions;\n /\n Options to define how query must be parsed.\n \n #### for example:\n * ```\n * GET /api/product?saleId=null\n * ```\n \n Normally would parsed to { saleId: \"null\" } so query parser\n * trough setting option `parseNull` will transform { saleId: null }\n * \n * #### Default:\n * \n * {\n parseNull: true,\n parseUndefined: true,\n parseBoolean: true,\n }\n * \n * parseNumber may convert fields that are string but you only passed\n * numbers to query pay attention to this.\n * \n * Soon a feature to converted the query to the end prisma type will be added.\n /\n queryParserOptions?: QueryParserOptions;\n /\n Configuration for CORS (Cross-Origin Resource Sharing).\n \n @property {string \| string[] \| \"all\"} [allowedOrigins] - List of allowed origins. If set to `\"all\"`, all origins are accepted.\n * @property {import('cors').CorsOptions} [options] - Additional CORS options passed directly to the `cors` middleware.\n * @property {import('cors').CorsOptionsDelegate} [customMiddleware] - A custom middleware function that overrides the default behavior.\n \n @remarks\n * If `customMiddleware` is provided, both `allowedOrigins` and `options` will be ignored in favor of the custom logic.\n \n See https://www.npmjs.com/package/cors\n /\n cors?: {\n /\n Defines allowed origins to acess the API.\n /\n allowedOrigins?: string \| string[] \| \"\";\n options?: cors.CorsOptions;\n /*\n If you would like to override the entire middleware\n \n see\n /\n customHandler?: cors.CorsOptionsDelegate;\n };\n /\n Defines express/arkos middlewares configurations\n /\n middlewares?: {\n /\n Allows to add an array of custom express middlewares into the default middleware stack.\n \n Tip: If you would like to acess the express app before everthing use `configureApp` and pass a function.\n \n Where will these be placed?: see [www.arkosjs.com/docs/advanced-guide/replace-or-disable-built-in-middlewares#middleware-execution-order](https://www.arkosjs.com/docs/advanced-guide/replace-or-disable-built-in-middlewares#middleware-execution-order)\n \n Note: If you want to use custom global error handler middleware use `middlewares.replace.globalErrorHandler`.\n \n Read more about The Arkos Middleware Stack at [www.arkosjs.com/docs/the-middleware-stack](https://www.arkosjs.com/docs/the-middleware-stack) for in-depth details.\n /\n additional?: express.RequestHandler[];\n /\n An array containing a list of defaults middlewares to be disabled\n \n Caution: Be careful with this because you may endup breaking your entire application.\n \n /\n disable?: (\n \| \"compression\"\n \| \"global-rate-limit\"\n \| \"auth-rate-limit\"\n \| \"cors\"\n \| \"express-json\"\n \| \"cookie-parser\"\n \| \"query-parser\"\n \| \"request-logger\"\n \| \"global-error-handler\"\n )[];\n /*\n Allows you to replace each of the built-in middlewares with your own implementation\n \n Caution: Be careful with this because you may endup breaking your entire application.\n /\n replace?: {\n /\n Replace the default compression middleware\n /\n compression?: express.RequestHandler;\n /\n Replace the default global rate limit middleware\n /\n globalRateLimit?: express.RequestHandler;\n /\n Replace the default authentication rate limit middleware\n /\n authRateLimit?: express.RequestHandler;\n /\n Replace the default CORS middleware\n /\n cors?: express.RequestHandler;\n /\n Replace the default JSON body parser middleware\n /\n expressJson?: express.RequestHandler;\n /\n Replace the default cookie parser middleware\n /\n cookieParser?: express.RequestHandler;\n /\n Replace the default query parser middleware\n /\n queryParser?: express.RequestHandler;\n /\n Replace the default request logger middleware\n /\n requestLogger?: express.RequestHandler;\n /\n Replace the default global error handler middleware\n /\n globalErrorHandler?: express.ErrorRequestHandler;\n };\n };\n /\n Defines express/arkos routers configurations\n /\n routers?: {\n /\n Strict mode configuration for routing security\n \n @default false\n * - all CRUD + Auth (if using auth) endpoits are enabled and avialable by default.\n \n When enabled:\n * - If `true`: All CRUD endpoints start disabled and must be explicitly enabled\n * in each model's router configuration\n * - If `'no-bulk'`: Bulk operations (createMany, updateMany, deleteMany) are disabled\n * by default, while individual operations can be enabled per model\n \n This provides enhanced security by ensuring no routes are accidentally exposed.\n * Use this in production environments to follow the principle of least privilege.\n \n See documentation: https://www.arkosjs.com/docs/guide/security#strict-mode\n /\n strict?: boolean \| \"no-bulk\";\n /\n Allows to add an array of custom express routers into the default middleware/router stack.\n \n Where will these be placed?: see [www.arkosjs.com/docs/advanced-guide/adding-custom-routers](https://www.arkosjs.com/docs/advanced-guide/adding-custom-routers)\n \n \n * Read more about The Arkos Middleware Stack at [www.arkosjs.com/docs/the-middleware-stack](https://www.arkosjs.com/docs/the-middleware-stack) for in-depth details.\n /\n additional?: express.Router[];\n disable?: (\n \| \"auth-router\"\n \| \"prisma-models-router\"\n \| \"file-upload\"\n \| \"welcome-endpoint\"\n )[];\n /\n Allows you to replace each of the built-in routers with your own implementation.\n \n Note: Doing this you will lose all default middleware chaining, auth control, handlers from the specific router.\n \n Tip: I you want to disable some prisma models specific endpoint\n * see [www.arkosjs.com/docs/guide/adding-custom-routers#disabling-auto-generated-endpoints](https://www.arkosjs.com/docs/guide/adding-custom-routers#disabling-auto-generated-endpoints)\n \n Caution: Be careful with this because you may endup breaking your entire application.\n /\n replace?: {\n /\n Replace the default authentication router\n * @param config The original Arkos configuration\n * @returns A router handling authentication endpoints\n /\n authRouter?: (\n config: ArkosConfig\n ) => express.Router \| Promise<express.Router>;\n /\n Replace the default Prisma models router\n * @param config The original Arkos configuration\n * @returns A router handling Prisma model endpoints\n /\n prismaModelsRouter?: (\n config: ArkosConfig\n ) => express.Router \| Promise<express.Router>;\n /\n Replace the default file upload router\n * @param config The original Arkos configuration\n * @returns A router handling file upload endpoints\n /\n fileUpload?: (\n config: ArkosConfig\n ) => express.Router \| Promise<express.Router>;\n /\n Replace the default welcome endpoint handler\n * @param req Express request object\n * @param res Express response object\n * @param next Express next function\n /\n welcomeEndpoint?: express.RequestHandler;\n };\n };\n /\n Gives acess to the underlying express app so that you can add custom configurations beyong Arkos customization capabilities\n \n Note: In the end Arkos will call `app.listen` for you.\n \n If you want to call `app.listen` by yourself pass port as `undefined` and then use the return app from `arkos.init()`.\n \n See how to call `app.listen` correctly [www.arkosjs.com/docs/guide/accessing-the-express-app#calling-applisten-by-yourself](https://www.arkosjs.com/docs/guide/accessing-the-express-app#calling-applisten-by-yourself)\n \n See [www.arkosjs.com/docs/guide/accessing-the-express-app](https://www.arkosjs.com/docs/guide/accessing-the-express-app) for further details on the method configureApp.\n \n @param {express.Express} app\n * @returns {any}\n /\n configureApp?: (app: express.Express) => Promise<any> \| any;\n /\n Gives access to the underlying HTTP server so that you can add custom configurations beyond Arkos customization capabilities\n \n Note: In the end Arkos will call `server.listen` for you.\n \n If you want to call `server.listen` by yourself pass port as `undefined` and then use the return server from `arkos.init()`.\n \n See how to call `server.listen` correctly [www.arkosjs.com/docs/guide/accessing-the-express-app#creating-your-own-http-server](https://www.arkosjs.com/docs/guide/accessing-the-express-app#creating-your-own-http-server)\n \n See [www.arkosjs.com/docs/guide/accessing-the-express-app#accessing-the-http-server](https://www.arkosjs.com/docs/guide/accessing-the-express-app#accessing-the-http-server) for further details on the method configureServer.\n \n @param {http.Server} server - The HTTP server instance\n * @returns {any}\n /\n configureServer?: (server: http.Server) => Promise<any> \| any;\n /\n Allows to configure email configurations for sending emails through `emailService`\n \n See [www.arkosjs.com/docs/core-concepts/sending-emails](https://www.arkosjs.com/docs/core-concepts/sending-emails)\n /\n email?: {\n /\n Email name to used like:\n \n John Doe\\<john.doe@gmail.com>\n /\n name?: string;\n /\n Your email provider url\n /\n host: string;\n /\n Email provider SMTP port, Default is `465`\n /\n port?: number;\n /\n If smtp connection must be secure, Default is `true`\n /\n secure?: boolean;\n /\n Used to authenticate in your smtp server\n /\n auth: {\n /\n Email used for auth as well as sending emails\n /\n user: string;\n /\n Your SMTP password\n /\n pass: string;\n };\n } & Parameters<typeof nodemailer.createTransport>[0];\n /\n Defines Swagger and OpenApi specifications for auto generating swagger documentation UI using whether it is Prisma Schemas, Class-validator DTOs, Zod Schemas or JSON-Schemas.\n \n Important: Is worth mentioning that this works alongside `@scalar/express-api-reference` npm package, you define it's ApiReferenceConfiguration under ``. also consider checking the package documentation at []\n \n Usage\n \n ```ts\n * // src/app.ts\n \n import arkos from \"arkos\"\n \n arkos.init({\n * // other configs\n * swagger: {\n * mode: \"zod\",\n * options: {\n * defintion: {\n * info: {\n * openapi: \"3.0.0\",\n * title: \"API Generated By Arkos.js\",\n * description: \"This API was automatically generated by Arkos.js read more about at www.arkosjs.com\"\n * }\n * }\n * }\n * }\n * })\n * ```\n * @see {@link https://www.arkosjs.com/docs/core-concepts/swagger-api-documentation}\n /\n swagger?: {\n /\n By default Arkos will disable API Documentation when the project is built `npm run build`, it does not matter what node environment is set. If you want to use it even after the `arkos build` command just set this to `true`.\n * /\n enableAfterBuild?: boolean;\n /\n Endpoint where the Swagger UI will be available.\n \n @default \"/api/api-docs\"\n /\n endpoint?: string;\n /\n Determines how your API schemas should be generated.\n \n - \"prisma\": Generates schemas based on Prisma models\n * - \"class-validator\": Uses class-validator and class-transformer DTO classes\n * - \"zod\": Uses OpenAPI-compliant schemas directly\n /\n mode: \"prisma\" \| \"class-validator\" \| \"zod\";\n /\n Allows `Arkos.js` to fallback to prisma schema and use them as json schema for defining request body and response data\n * when a given zod Schema or class-validator Class is not found to be transformed to json schema.\n \n @default false\n /\n strict?: boolean;\n /\n Defines your swagger configurations\n /\n options?: {\n /\n Swagger definition according to OpenAPI Specification.\n /\n definition?: {\n /\n OpenAPI version.\n \n @default \"3.0.0\"\n /\n openapi?: string;\n\n /\n Information about your API.\n /\n info?: {\n /\n Title of the API documentation.\n \n \n * @example \"My API\"\n \n @default \"API Generated By Arkos.js\"\n /\n title?: string;\n\n /\n Version of the API.\n \n @example \"1.0.0\"\n /\n version?: string;\n\n /\n Description of the API.\n \n @default \"This API was automatically generated by Arkos.js read more about at www.arkosjs.com\"\n /\n description?: string;\n };\n\n /\n Server configurations for the API.\n \n @default [{ url: \"http://localhost:8000\", description: \"Development server\" }]\n \n This can be overridden automatically by Arkos based on CLI, .env, or `arkos.init()`.\n /\n servers?: {\n /\n Base URL of the server.\n \n @example \"http://localhost:8000\"\n /\n url: string;\n\n /\n Human-readable description of the server.\n \n @example \"Development Server\"\n /\n description?: string;\n }[];\n /\n Allows adding more paths for your OpenAPI documentation\n \n /\n paths?: OpenAPIV3.PathsObject;\n /\n (Optional) Additional metadata such as terms of service, contact, or license.\n \n See: https://swagger.io/specification/#infoObject\n /\n termsOfService?: string;\n contact?: {\n name?: string;\n url?: string;\n email?: string;\n };\n license?: {\n name: string;\n url?: string;\n };\n\n /\n Tags to group and describe endpoints.\n /\n tags?: {\n name: string;\n description?: string;\n }[];\n\n /\n Security definitions (e.g., Bearer Auth).\n /\n components?: {\n securitySchemes?: Record<string, any>;\n schemas?: Record<string, any>;\n };\n\n /\n Global security requirements.\n /\n security?: Array<Record<string, string[]>>;\n };\n\n /\n Glob patterns defining where Swagger should look for API route definitions and comments.\n \n @default \n * ```ts\n * [\"./src/routers/.router.{ts,js}\", \"./src/modules/\\/.router.{ts,js}\"]\n ```\n \n Adjust depending on TypeScript or JavaScript usage.\n /\n apis?: string[];\n\n /\n Enables deep linking in the Swagger UI.\n \n @default true\n /\n deepLinking?: boolean;\n\n /\n Enable/disable the \"Try it out\" button globally.\n \n @default true\n /\n tryItOutEnabled?: boolean;\n\n /\n Whether to persist authorization data across page reloads.\n \n @default false\n /\n persistAuthorization?: boolean;\n };\n /\n Custom `@scalar/express-api-reference` package options.\n \n @see {@link https://guides.scalar.com/scalar/scalar-api-references/integrations/express}\n /\n scalarApiReferenceConfiguration?: Partial<ApiReferenceConfiguration>;\n };\n /\n Helps in debugging some of the variables values that are used inside arkos from dynamic loaded components towhat is used into the generated api.\n \n /\n debugging?: {\n /*\n Controls debugging over HTTP request level\n /\n requests?: {\n level?: 0 \| 1 \| 2 \| 3;\n filter?: (\n \| \"Query\"\n \| \"Body\"\n \| \"Params\"\n \| \"TransformedQuery\"\n \| \"ServiceArgs\"\n \| \"FinalPrismaQueryArgs\"\n )[];\n };\n /\n Controls debugging over the dynamic loaded modules and it's components on app starting\n /\n dynamicLoader?: {\n /\n Adjusts logging details\n \n 1 - Loaded modules and list of it's components files\n * 2 - All from 1 and detailed inspection per module component\n * 3 - All from 1 and 2, plus the final router component after merged with autho generated router.\n /\n level?: 0 \| 1 \| 2 \| 3;\n filters?: {\n /\n Allows filtering by specific modules.\n \n Supports only searching for the starting parts of the module name, e.g: If there is`user-profile`, `user`, `posts`, passing `[\"user\"]` will match both `user-profile` and `user`.\n /\n modules?: string[];\n /\n Allows filtering by component's names\n */\n components?: keyof ModuleComponents[];\n };\n };\n };\n};\n"]}
1	+ {"version":3,"file":"arkos-config.js","sourceRoot":"","sources":["../../../src/types/arkos-config.ts"],"names":[],"mappings":"","sourcesContent":["import http from \"http\";\nimport cors from \"cors\";\nimport express from \"express\";\nimport { Options as RateLimitOptions } from \"express-rate-limit\";\nimport cookieParser from \"cookie-parser\";\nimport compression from \"compression\";\nimport { Options as QueryParserOptions } from \"../utils/helpers/query-parser.helpers\";\nimport { ValidatorOptions } from \"class-validator\";\nimport { MsDuration } from \"../modules/auth/utils/helpers/auth.controller.helpers\";\nimport { OpenAPIV3 } from \"openapi-types\";\nimport type { ApiReferenceConfiguration } from \"@scalar/express-api-reference\" with { \"resolution-mode\": \"import\" };\nimport nodemailer from \"nodemailer\";\nimport { ModuleComponents } from \"../utils/dynamic-loader\";\nimport { IArkosRouter } from \"../utils/arkos-router/types\";\n/*\n Defines the initial configs of the api to be loaded at startup when arkos.init() is called.\n /\nexport type ArkosConfig = {\n /\n Allows to configure request configs\n /\n request?: {\n /\n Allows to configure request parameters\n /\n parameters?: {\n /\n Toggles allowing `VERY DANGEROUS` request paramateres under `req.query` for passing prisma query options.\n \n See more\n /\n allowDangerousPrismaQueryOptions?: boolean;\n };\n };\n /* Message you would like to send, as Json and 200 response when\n * ```curl\n * GET /api\n * ```\n \n ```json\n * { \"message\": \"Welcome to YourAppName\" }\n * ```\n \n default message is: Welcome to our Rest API generated by Arkos, find more about Arkos at www.arkosjs.com.\n \n \n * /\n welcomeMessage?: string;\n /\n Port where the application will run, can be set in 3 ways:\n \n 1. default is 8000\n * 2. PORT under environment variables (Lower precedence)\n * 3. this config option (Higher precedence)\n /\n port?: number \| undefined;\n /\n Allows to listen on a different host than localhost only\n /\n host?: string;\n /\n Defines authentication related configurations, by default is undefined.\n \n See [www.arkosjs.com/docs/core-concepts/authentication-system](https://www.arkosjs.com/docs/core-concepts/authentication-system) for details.\n /\n authentication?: {\n /\n Defines whether to use Static or Dynamic Role-Based Acess Control\n \n Visit [www.arkosjs.com/docs/core-concepts/authentication-system](https://www.arkosjs.com/docs/core-concepts/authentication-system) for more details.\n /\n mode: \"static\" \| \"dynamic\";\n /\n Defines auth login related configurations to customize the api.\n /\n login?: {\n /\n Defines the field that will be used as username by the built-in auth system, by default arkos will look for the field \"username\" in your model User, hence when making login for example you must send:\n \n ```json\n * {\n * \"username\": \"johndoe\",\n * \"password\": \"somePassword123\"\n * }\n * ```\n \n Note: You can also modify the usernameField on the fly by passing it to the request query parameters. example:\n \n ```curl\n * POST /api/auth/login?usernameField=email\n * ```\n \n See more at [www.arkosjs.com/docs/core-concepts/authentication-system#login-with-different-fileds](https://www.arkosjs.com/docs/core-concepts/authentication-system#login-with-different-fileds)\n \n By specifing here another field for username, for example passing \"email\", \"companyCode\" or something else your json will be like:\n \n Example with email\n \n ```json\n * {\n * \"email\": \"john.doe@example.com\",\n * \"password\": \"somePassword123\"\n * }\n * ```\n /\n allowedUsernames?: string[];\n /* Defines wether to send the access token in response after login or only send as cookie, defeault is both./\n sendAccessTokenThrough?: \"cookie-only\" \| \"response-only\" \| \"both\";\n };\n /\n Specifies the regex pattern used by the authentication system to enforce password strength requirements.\n \n Important: If using validation libraries like Zod or class-validator, this will be completely overwritten.\n \n Default: ```/^(?=.[A-Z])(?=.[a-z])(?=.\\d).+$/``` - Ensures the password contains at least one uppercase letter, one lowercase letter, and one numeric digit.\n \n * message: (Optional) A custom error message to display when the password does not meet the required strength criteria.\n /\n passwordValidation?: { regex: RegExp; message?: string };\n /\n Allows to specify the request rate limit for all authentication endpoints but `/api/users/me`.\n * \n * #### Default\n {\n windowMs: 5000,\n limit: 10,\n standardHeaders: \"draft-7\",\n legacyHeaders: false,\n }\n \n * Passing an object not overriding all the default options will only\n * cause it to be deepmerged and not actually replace with empty fields\n * \n @see This is are the options used on the `express-rate-limit` npm package used on epxress. read more about [https://www.npmjs.com/package/express-rate-limit](https://www.npmjs.com/package/express-rate-limit)\n /\n requestRateLimitOptions?: Partial<RateLimitOptions>;\n /*\n JWT (JSON Web Token) authentication configuration.\n \n You can override these values directly in code, or use environment variables:\n \n - `JWT_SECRET`: Secret used to sign and verify JWT tokens.\n * - `JWT_EXPIRES_IN`: Duration string or number indicating when the token should expire (e.g. \"30d\", 3600).\n * - `JWT_COOKIE_SECURE`: Whether the cookie is sent only over HTTPS. Default: `true` in production.\n * - `JWT_COOKIE_HTTP_ONLY`: Whether the cookie is HTTP-only. Default: `true`.\n * - `JWT_COOKIE_SAME_SITE`: Can be \"lax\", \"strict\", or \"none\". Defaults to \"lax\" in dev, \"none\" in prod.\n \n ⚠️ Values passed here take precedence over environment variables.\n /\n jwt?: {\n /* Secret key used for signing and verifying JWT tokens /\n secret?: string;\n /\n Duration after which the JWT token expires.\n * Accepts either a duration string (e.g. \"30d\", \"1h\") or a number in milliseconds.\n * Defaults to \"30d\" if not provided.\n /\n expiresIn?: MsDuration \| number;\n\n /\n Configuration for the JWT cookie sent to the client\n /\n cookie?: {\n /\n Whether the cookie should be marked as secure (sent only over HTTPS).\n * Defaults to `true` in production and `false` in development.\n /\n secure?: boolean;\n\n /\n Whether the cookie should be marked as HTTP-only.\n * Default is `true` to prevent access via JavaScript.\n /\n httpOnly?: boolean;\n\n /\n Controls the SameSite attribute of the cookie.\n * Defaults to \"none\" in production and \"lax\" in development.\n * Options: \"lax\" \| \"strict\" \| \"none\"\n /\n sameSite?: \"lax\" \| \"strict\" \| \"none\";\n };\n };\n };\n /* Allows to customize and toggle the built-in validation, by default it is set to `false`. If true is passed it will use validation with the default resolver set to `class-validator` if you intend to change the resolver to `zod` do the following:\n \n ```ts\n * // src/app.ts\n * import arkos from 'arkos'\n \n arkos.init({\n * validation: {\n * resolver: \"zod\"\n * }\n * })\n * ```\n \n @See [www.arkosjs.com/docs/core-concepts/request-data-validation](https://www.arkosjs.com/docs/core-concepts/request-data-validation) for more details.\n /\n validation?: {\n /\n Defines whether to use strict request validation, it means in every request using `ArkosRouter()` you must pass the validation options with all options (e.g: query, params, body, etc.).\n \n How It Works:\n * - If it is true, Arkos will require all the options a stated above on the routes and if you don't pass it will throw an error.\n * What if you don't want to pass a validator to some options?\n * - You will need to pass `undefined` to the validator option (see example below), this way Arkos will throw an error if something is passed to `req.query` if you passed undefined as validator into `validation.query`\n \n ```ts\n * import { ArkosRouter } from \"arkos\"\n \n const router = ArkosRouter()\n \n router.get({\n * route: \"/api/posts\",\n * validation: {\n * query: undefined\n * }\n * })\n \n ```\n /\n strict?: boolean;\n } & (\n \| {\n resolver?: \"class-validator\";\n /\n ValidatorOptions to used while validating request data.\n \n Default:\n * ```ts\n * {\n * whitelist: true\n * }\n * ```\n /\n validationOptions?: ValidatorOptions;\n }\n \| {\n resolver?: \"zod\";\n validationOptions?: Record<string, any>;\n }\n );\n /\n Defines file upload configurations\n \n See [www.arkosjs.com/docs/core-concepts/file-upload#costum-configurations](https://www.arkosjs.com/docs/core-concepts/file-upload#costum-configurations)\n /\n fileUpload?: {\n /\n Defiens the base file upload directory, default is set to /uploads (on root directory)\n \n When setting up a path dir always now that root directory will be the starting reference.\n \n #### Example\n * passing `../my-arkos-uploaded-files`\n \n Will save uploaded files one level outside the root dir inside `my-arkos-uploaded-files`\n \n NB: You must be aware of permissions on your server to acess files outside your project directory.\n \n /\n baseUploadDir?: string;\n /*\n Changes the default `/api/uploads` base route for accessing file upload route.\n \n #### IMPORTANT\n * Changing this will not affect the `baseUploadDir` folder. You can\n * pass here `/api/files/my-user-files` and `baseUploadDir` be `/uploaded-files`.\n \n /\n baseRoute?: string;\n /*\n Defines options for `express.static(somePath, someOptions)`\n \n #### Default:\n \n ```ts\n {\n maxAge: \"1y\",\n etag: true,\n lastModified: true,\n dotfiles: \"ignore\",\n fallthrough: true,\n index: false,\n cacheControl: true,\n }\n ```\n * \n * By passing your custom options have in mind that it\n * will be deepmerged with the default.\n * \n * Visit [https://expressjs.com/en/4x/api.html#express.static](https://expressjs.com/en/4x/api.html#express.static) for more understanding.\n * \n /\n expressStaticOptions?: Parameters<typeof express.static>[1];\n /\n Defines upload restrictions for each file type: image, video, document or other.\n \n #### Important:\n * Passing an object without overriding everything will only cause it\n * to be deepmerged with the default options.\n \n See [www.arkosjs.com/docs/api-reference/default-supported-upload-files](https://www.arkosjs.com/docs/api-reference/default-supported-upload-files) for detailed explanation about default values.\n * ```\n /\n restrictions?: {\n images?: {\n maxCount?: number;\n maxSize?: number;\n supportedFilesRegex?: RegExp;\n };\n videos?: {\n maxCount?: number;\n maxSize?: number;\n supportedFilesRegex?: RegExp;\n };\n documents?: {\n maxCount?: number;\n maxSize?: number;\n supportedFilesRegex?: RegExp;\n };\n files?: {\n maxCount?: number;\n maxSize?: number;\n supportedFilesRegex?: RegExp;\n };\n };\n };\n /\n Allows to specify the request rate limit for all endpoints.\n * \n * #### Default\n ```ts\n {\n windowMs: 60 * 1000,\n limit: 1000,\n standardHeaders: \"draft-7\",\n legacyHeaders: false,\n }\n ```\n * \n * Passing an object not overriding all the default options will only\n * cause it to be deepmerged and not actually replace with empty fields\n * \n * This is are the options used on the `express-rate-limit` npm package used on epxress. read more about [https://www.npmjs.com/package/express-rate-limit](https://www.npmjs.com/package/express-rate-limit)\n /\n globalRequestRateLimitOptions?: Partial<RateLimitOptions>;\n /\n Defines options for the built-in express.json() middleware\n * Nothing is passed by default.\n /\n jsonBodyParserOptions?: Parameters<typeof express.json>[0];\n /\n Allows to pass paremeters to cookieParser from npm package cookie-parser\n * Nothing is passed by default.\n \n See [www.npmjs.com/package/cookie-parser](https://www.npmjs.com/package/cookie-parser) for further details.\n /\n cookieParserParameters?: Parameters<typeof cookieParser>;\n /\n Allows to define options for npm package compression\n * Nothing is passed by default.\n \n See [www.npmjs.com/package/compression](https://www.npmjs.com/package/compression) for further details.\n /\n compressionOptions?: compression.CompressionOptions;\n /\n Options to define how query must be parsed.\n \n #### for example:\n * ```\n * GET /api/product?saleId=null\n * ```\n \n Normally would parsed to { saleId: \"null\" } so query parser\n * trough setting option `parseNull` will transform { saleId: null }\n * \n * #### Default:\n * \n * {\n parseNull: true,\n parseUndefined: true,\n parseBoolean: true,\n }\n * \n * parseNumber may convert fields that are string but you only passed\n * numbers to query pay attention to this.\n * \n * Soon a feature to converted the query to the end prisma type will be added.\n /\n queryParserOptions?: QueryParserOptions;\n /\n Configuration for CORS (Cross-Origin Resource Sharing).\n \n @property {string \| string[] \| \"all\"} [allowedOrigins] - List of allowed origins. If set to `\"all\"`, all origins are accepted.\n * @property {import('cors').CorsOptions} [options] - Additional CORS options passed directly to the `cors` middleware.\n * @property {import('cors').CorsOptionsDelegate} [customMiddleware] - A custom middleware function that overrides the default behavior.\n \n @remarks\n * If `customMiddleware` is provided, both `allowedOrigins` and `options` will be ignored in favor of the custom logic.\n \n See https://www.npmjs.com/package/cors\n /\n cors?: {\n /\n Defines allowed origins to acess the API.\n /\n allowedOrigins?: string \| string[] \| \"\";\n options?: cors.CorsOptions;\n /*\n If you would like to override the entire middleware\n \n see\n /\n customHandler?: cors.CorsOptionsDelegate;\n };\n /\n Defines express/arkos middlewares configurations\n /\n middlewares?: {\n /\n Allows to add an array of custom express middlewares into the default middleware stack.\n \n Tip: If you would like to acess the express app before everthing use `configureApp` and pass a function.\n \n Where will these be placed?: see [www.arkosjs.com/docs/advanced-guide/replace-or-disable-built-in-middlewares#middleware-execution-order](https://www.arkosjs.com/docs/advanced-guide/replace-or-disable-built-in-middlewares#middleware-execution-order)\n \n Note: If you want to use custom global error handler middleware use `middlewares.replace.globalErrorHandler`.\n \n Read more about The Arkos Middleware Stack at [www.arkosjs.com/docs/the-middleware-stack](https://www.arkosjs.com/docs/the-middleware-stack) for in-depth details.\n /\n additional?: express.RequestHandler[];\n /\n An array containing a list of defaults middlewares to be disabled\n \n Caution: Be careful with this because you may endup breaking your entire application.\n \n /\n disable?: (\n \| \"compression\"\n \| \"global-rate-limit\"\n \| \"auth-rate-limit\"\n \| \"cors\"\n \| \"express-json\"\n \| \"cookie-parser\"\n \| \"query-parser\"\n \| \"request-logger\"\n \| \"global-error-handler\"\n )[];\n /*\n Allows you to replace each of the built-in middlewares with your own implementation\n \n Caution: Be careful with this because you may endup breaking your entire application.\n /\n replace?: {\n /\n Replace the default compression middleware\n /\n compression?: express.RequestHandler;\n /\n Replace the default global rate limit middleware\n /\n globalRateLimit?: express.RequestHandler;\n /\n Replace the default authentication rate limit middleware\n /\n authRateLimit?: express.RequestHandler;\n /\n Replace the default CORS middleware\n /\n cors?: express.RequestHandler;\n /\n Replace the default JSON body parser middleware\n /\n expressJson?: express.RequestHandler;\n /\n Replace the default cookie parser middleware\n /\n cookieParser?: express.RequestHandler;\n /\n Replace the default query parser middleware\n /\n queryParser?: express.RequestHandler;\n /\n Replace the default request logger middleware\n /\n requestLogger?: express.RequestHandler;\n /\n Replace the default global error handler middleware\n /\n globalErrorHandler?: express.ErrorRequestHandler;\n };\n };\n /\n Defines express/arkos routers configurations\n /\n routers?: {\n /\n Strict mode configuration for routing security\n \n @default false\n * - all CRUD + Auth (if using auth) endpoits are enabled and avialable by default.\n \n When enabled:\n * - If `true`: All CRUD endpoints start disabled and must be explicitly enabled\n * in each model's router configuration\n * - If `'no-bulk'`: Bulk operations (createMany, updateMany, deleteMany) are disabled\n * by default, while individual operations can be enabled per model\n \n This provides enhanced security by ensuring no routes are accidentally exposed.\n * Use this in production environments to follow the principle of least privilege.\n \n See documentation: https://www.arkosjs.com/docs/guide/security#strict-mode\n /\n strict?: boolean \| \"no-bulk\";\n /\n Allows to add an array of custom express routers into the default middleware/router stack.\n \n Where will these be placed?: see [www.arkosjs.com/docs/advanced-guide/adding-custom-routers](https://www.arkosjs.com/docs/advanced-guide/adding-custom-routers)\n \n \n * Read more about The Arkos Middleware Stack at [www.arkosjs.com/docs/the-middleware-stack](https://www.arkosjs.com/docs/the-middleware-stack) for in-depth details.\n /\n additional?: express.Router[] \| IArkosRouter[];\n disable?: (\n \| \"auth-router\"\n \| \"prisma-models-router\"\n \| \"file-upload\"\n \| \"welcome-endpoint\"\n )[];\n /\n Allows you to replace each of the built-in routers with your own implementation.\n \n Note: Doing this you will lose all default middleware chaining, auth control, handlers from the specific router.\n \n Tip: I you want to disable some prisma models specific endpoint\n * see [www.arkosjs.com/docs/guide/adding-custom-routers#disabling-auto-generated-endpoints](https://www.arkosjs.com/docs/guide/adding-custom-routers#disabling-auto-generated-endpoints)\n \n Caution: Be careful with this because you may endup breaking your entire application.\n /\n replace?: {\n /\n Replace the default authentication router\n * @param config The original Arkos configuration\n * @returns A router handling authentication endpoints\n /\n authRouter?: (\n config: ArkosConfig\n ) => express.Router \| Promise<express.Router>;\n /\n Replace the default Prisma models router\n * @param config The original Arkos configuration\n * @returns A router handling Prisma model endpoints\n /\n prismaModelsRouter?: (\n config: ArkosConfig\n ) => express.Router \| Promise<express.Router>;\n /\n Replace the default file upload router\n * @param config The original Arkos configuration\n * @returns A router handling file upload endpoints\n /\n fileUpload?: (\n config: ArkosConfig\n ) => express.Router \| Promise<express.Router>;\n /\n Replace the default welcome endpoint handler\n * @param req Express request object\n * @param res Express response object\n * @param next Express next function\n /\n welcomeEndpoint?: express.RequestHandler;\n };\n };\n /\n Gives acess to the underlying express app so that you can add custom configurations beyong Arkos customization capabilities\n \n Note: In the end Arkos will call `app.listen` for you.\n \n If you want to call `app.listen` by yourself pass port as `undefined` and then use the return app from `arkos.init()`.\n \n See how to call `app.listen` correctly [www.arkosjs.com/docs/guide/accessing-the-express-app#calling-applisten-by-yourself](https://www.arkosjs.com/docs/guide/accessing-the-express-app#calling-applisten-by-yourself)\n \n See [www.arkosjs.com/docs/guide/accessing-the-express-app](https://www.arkosjs.com/docs/guide/accessing-the-express-app) for further details on the method configureApp.\n \n @param {express.Express} app\n * @returns {any}\n /\n configureApp?: (app: express.Express) => Promise<any> \| any;\n /\n Gives access to the underlying HTTP server so that you can add custom configurations beyond Arkos customization capabilities\n \n Note: In the end Arkos will call `server.listen` for you.\n \n If you want to call `server.listen` by yourself pass port as `undefined` and then use the return server from `arkos.init()`.\n \n See how to call `server.listen` correctly [www.arkosjs.com/docs/guide/accessing-the-express-app#creating-your-own-http-server](https://www.arkosjs.com/docs/guide/accessing-the-express-app#creating-your-own-http-server)\n \n See [www.arkosjs.com/docs/guide/accessing-the-express-app#accessing-the-http-server](https://www.arkosjs.com/docs/guide/accessing-the-express-app#accessing-the-http-server) for further details on the method configureServer.\n \n @param {http.Server} server - The HTTP server instance\n * @returns {any}\n /\n configureServer?: (server: http.Server) => Promise<any> \| any;\n /\n Allows to configure email configurations for sending emails through `emailService`\n \n See [www.arkosjs.com/docs/core-concepts/sending-emails](https://www.arkosjs.com/docs/core-concepts/sending-emails)\n /\n email?: {\n /\n Email name to used like:\n \n John Doe\\<john.doe@gmail.com>\n /\n name?: string;\n /\n Your email provider url\n /\n host: string;\n /\n Email provider SMTP port, Default is `465`\n /\n port?: number;\n /\n If smtp connection must be secure, Default is `true`\n /\n secure?: boolean;\n /\n Used to authenticate in your smtp server\n /\n auth: {\n /\n Email used for auth as well as sending emails\n /\n user: string;\n /\n Your SMTP password\n /\n pass: string;\n };\n } & Parameters<typeof nodemailer.createTransport>[0];\n /\n Defines Swagger and OpenApi specifications for auto generating swagger documentation UI using whether it is Prisma Schemas, Class-validator DTOs, Zod Schemas or JSON-Schemas.\n \n Important: Is worth mentioning that this works alongside `@scalar/express-api-reference` npm package, you define it's ApiReferenceConfiguration under ``. also consider checking the package documentation at []\n \n Usage\n \n ```ts\n * // src/app.ts\n \n import arkos from \"arkos\"\n \n arkos.init({\n * // other configs\n * swagger: {\n * mode: \"zod\",\n * options: {\n * defintion: {\n * info: {\n * openapi: \"3.0.0\",\n * title: \"API Generated By Arkos.js\",\n * description: \"This API was automatically generated by Arkos.js read more about at www.arkosjs.com\"\n * }\n * }\n * }\n * }\n * })\n * ```\n * @see {@link https://www.arkosjs.com/docs/core-concepts/swagger-api-documentation}\n /\n swagger?: {\n /\n By default Arkos will disable API Documentation when the project is built `npm run build`, it does not matter what node environment is set. If you want to use it even after the `arkos build` command just set this to `true`.\n * /\n enableAfterBuild?: boolean;\n /\n Endpoint where the Swagger UI will be available.\n \n @default \"/api/api-docs\"\n /\n endpoint?: string;\n /\n Determines how your API schemas should be generated.\n \n - \"prisma\": Generates schemas based on Prisma models\n * - \"class-validator\": Uses class-validator and class-transformer DTO classes\n * - \"zod\": Uses OpenAPI-compliant schemas directly\n /\n mode: \"prisma\" \| \"class-validator\" \| \"zod\";\n /\n Allows `Arkos.js` to fallback to prisma schema and use them as json schema for defining request body and response data\n * when a given zod Schema or class-validator Class is not found to be transformed to json schema.\n \n @default false\n /\n strict?: boolean;\n /\n Defines your swagger configurations\n /\n options?: {\n /\n Swagger definition according to OpenAPI Specification.\n /\n definition?: {\n /\n OpenAPI version.\n \n @default \"3.0.0\"\n /\n openapi?: string;\n\n /\n Information about your API.\n /\n info?: {\n /\n Title of the API documentation.\n \n \n * @example \"My API\"\n \n @default \"API Generated By Arkos.js\"\n /\n title?: string;\n\n /\n Version of the API.\n \n @example \"1.0.0\"\n /\n version?: string;\n\n /\n Description of the API.\n \n @default \"This API was automatically generated by Arkos.js read more about at www.arkosjs.com\"\n /\n description?: string;\n };\n\n /\n Server configurations for the API.\n \n @default [{ url: \"http://localhost:8000\", description: \"Development server\" }]\n \n This can be overridden automatically by Arkos based on CLI, .env, or `arkos.init()`.\n /\n servers?: {\n /\n Base URL of the server.\n \n @example \"http://localhost:8000\"\n /\n url: string;\n\n /\n Human-readable description of the server.\n \n @example \"Development Server\"\n /\n description?: string;\n }[];\n /\n Allows adding more paths for your OpenAPI documentation\n \n /\n paths?: OpenAPIV3.PathsObject;\n /\n (Optional) Additional metadata such as terms of service, contact, or license.\n \n See: https://swagger.io/specification/#infoObject\n /\n termsOfService?: string;\n contact?: {\n name?: string;\n url?: string;\n email?: string;\n };\n license?: {\n name: string;\n url?: string;\n };\n\n /\n Tags to group and describe endpoints.\n /\n tags?: {\n name: string;\n description?: string;\n }[];\n\n /\n Security definitions (e.g., Bearer Auth).\n /\n components?: {\n securitySchemes?: Record<string, any>;\n schemas?: Record<string, any>;\n };\n\n /\n Global security requirements.\n /\n security?: Array<Record<string, string[]>>;\n };\n\n /\n Glob patterns defining where Swagger should look for API route definitions and comments.\n \n @default \n * ```ts\n * [\"./src/routers/.router.{ts,js}\", \"./src/modules/\\/.router.{ts,js}\"]\n ```\n \n Adjust depending on TypeScript or JavaScript usage.\n /\n apis?: string[];\n\n /\n Enables deep linking in the Swagger UI.\n \n @default true\n /\n deepLinking?: boolean;\n\n /\n Enable/disable the \"Try it out\" button globally.\n \n @default true\n /\n tryItOutEnabled?: boolean;\n\n /\n Whether to persist authorization data across page reloads.\n \n @default false\n /\n persistAuthorization?: boolean;\n };\n /\n Custom `@scalar/express-api-reference` package options.\n \n @see {@link https://guides.scalar.com/scalar/scalar-api-references/integrations/express}\n /\n scalarApiReferenceConfiguration?: Partial<ApiReferenceConfiguration>;\n };\n /\n Helps in debugging some of the variables values that are used inside arkos from dynamic loaded components towhat is used into the generated api.\n \n /\n debugging?: {\n /*\n Controls debugging over HTTP request level\n /\n requests?: {\n level?: 0 \| 1 \| 2 \| 3;\n filter?: (\n \| \"Query\"\n \| \"Body\"\n \| \"Params\"\n \| \"TransformedQuery\"\n \| \"ServiceArgs\"\n \| \"FinalPrismaQueryArgs\"\n )[];\n };\n /\n Controls debugging over the dynamic loaded modules and it's components on app starting\n /\n dynamicLoader?: {\n /\n Adjusts logging details\n \n 1 - Loaded modules and list of it's components files\n * 2 - All from 1 and detailed inspection per module component\n * 3 - All from 1 and 2, plus the final router component after merged with autho generated router.\n /\n level?: 0 \| 1 \| 2 \| 3;\n filters?: {\n /\n Allows filtering by specific modules.\n \n Supports only searching for the starting parts of the module name, e.g: If there is`user-profile`, `user`, `posts`, passing `[\"user\"]` will match both `user-profile` and `user`.\n /\n modules?: string[];\n /\n Allows filtering by component's names\n */\n components?: keyof ModuleComponents[];\n };\n };\n };\n};\n"]}

package/dist/esm/utils/arkos-router/types/index.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/utils/arkos-router/types/index.ts"],"names":[],"mappings":"","sourcesContent":["import { IRouter } from \"express\";\nimport { OpenAPIV3 } from \"openapi-types\";\nimport { ZodSchema } from \"zod\";\nimport { Options as RateLimitOptions } from \"express-rate-limit\";\nimport { AccessControlRules } from \"../../../types/auth\";\nimport { ArkosErrorRequestHandler, ArkosRequestHandler } from \"../../../types\";\nimport { CorsOptions } from \"cors\";\nimport express from \"express\";\n\ntype MethodHandler = (\n config: ArkosRouteConfig,\n ...handlers: (ArkosRequestHandler \| ArkosErrorRequestHandler)[]\n) => ~~IArkosRouter~~;\n\nexport interface IArkosRouter\n extends Omit<\n IRouter,\n \| \"get\"\n \| \"post\"\n \| \"put\"\n \| \"patch\"\n \| \"delete\"\n \| \"options\"\n \| \"head\"\n \| \"trace\"\n \| \"all\"\n > {\n get: MethodHandler;\n post: MethodHandler;\n put: MethodHandler;\n patch: MethodHandler;\n delete: MethodHandler;\n options: MethodHandler;\n head: MethodHandler;\n trace: MethodHandler;\n all: MethodHandler;\n}\n\nexport interface ArkosRouteConfig {\n route: string;\n authentication?:\n \| boolean\n \| {\n resource: string;\n action: string;\n rule?: AccessControlRules;\n };\n validation?:\n \| false\n \| {\n query?: ZodSchema \| (new (...args: any[]) => object) \| false;\n body?: ZodSchema \| (new (...args: any[]) => object) \| false;\n params?: ZodSchema \| (new (...args: any[]) => object) \| false;\n };\n openapi?: boolean \| Partial<OpenAPIV3.OperationObject>;\n rateLimit?: Partial<RateLimitOptions>;\n /*\n Configuration for CORS (Cross-Origin Resource Sharing).\n \n @property {string \| string[] \| \"all\"} [allowedOrigins] - List of allowed origins. If set to `\"all\"`, all origins are accepted.\n * @property {import('cors').CorsOptions} [options] - Additional CORS options passed directly to the `cors` middleware.\n * @property {import('cors').CorsOptionsDelegate} [customMiddleware] - A custom middleware function that overrides the default behavior.\n \n @remarks\n * If `customMiddleware` is provided, both `allowedOrigins` and `options` will be ignored in favor of the custom logic.\n \n See https://www.npmjs.com/package/cors\n /\n cors?: {\n /\n Defines allowed origins to acess the API.\n /\n allowedOrigins?: string \| string[] \| \"\";\n options?: CorsOptions;\n };\n /*\n Configuration for request body parsing.\n \n @property {(\"json\" \| \"urlencoded\" \| \"raw\" \| \"text\")} parser - The type of body parser to use.\n * @property {object} [options] - Parser-specific options passed to the corresponding Express body parser middleware.\n \n @remarks\n * - When `parser` is `\"json\"`, options are passed to `express.json()`.\n * - When `parser` is `\"urlencoded\"`, options are passed to `express.urlencoded()`.\n * - When `parser` is `\"raw\"`, options are passed to `express.raw()`.\n * - When `parser` is `\"text\"`, options are passed to `express.text()`.\n * - Set to `false` to disable body parsing for this route.\n \n See https://expressjs.com/en/api.html#express.json\n */\n bodyParser?:\n \| { parser: \"json\"; options?: Parameters<typeof express.json>[0] }\n \| {\n parser: \"urlencoded\";\n options?: Parameters<typeof express.urlencoded>[0];\n }\n \| { parser: \"raw\"; options?: Parameters<typeof express.raw>[0] }\n \| { parser: \"text\"; options?: Parameters<typeof express.text>[0] }\n \| false;\n}\n"]}
1	+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/utils/arkos-router/types/index.ts"],"names":[],"mappings":"","sourcesContent":["import { IRouter } from \"express\";\nimport { OpenAPIV3 } from \"openapi-types\";\nimport { ZodSchema } from \"zod\";\nimport { Options as RateLimitOptions } from \"express-rate-limit\";\nimport { AccessControlRules } from \"../../../types/auth\";\nimport { ArkosErrorRequestHandler, ArkosRequestHandler } from \"../../../types\";\nimport { CorsOptions } from \"cors\";\nimport express from \"express\";\n\ntype MethodHandler = (\n config: ArkosRouteConfig,\n ...handlers: (ArkosRequestHandler \| ArkosErrorRequestHandler)[]\n) => IRouter;\n\nexport interface IArkosRouter\n extends Omit<\n IRouter,\n \| \"get\"\n \| \"post\"\n \| \"put\"\n \| \"patch\"\n \| \"delete\"\n \| \"options\"\n \| \"head\"\n \| \"trace\"\n \| \"all\"\n > {\n get: MethodHandler;\n post: MethodHandler;\n put: MethodHandler;\n patch: MethodHandler;\n delete: MethodHandler;\n options: MethodHandler;\n head: MethodHandler;\n trace: MethodHandler;\n all: MethodHandler;\n}\n\nexport interface ArkosRouteConfig {\n route: string;\n authentication?:\n \| boolean\n \| {\n resource: string;\n action: string;\n rule?: AccessControlRules;\n };\n validation?:\n \| false\n \| {\n query?: ZodSchema \| (new (...args: any[]) => object) \| false;\n body?: ZodSchema \| (new (...args: any[]) => object) \| false;\n params?: ZodSchema \| (new (...args: any[]) => object) \| false;\n };\n openapi?: boolean \| Partial<OpenAPIV3.OperationObject>;\n rateLimit?: Partial<RateLimitOptions>;\n /*\n Configuration for CORS (Cross-Origin Resource Sharing).\n \n @property {string \| string[] \| \"all\"} [allowedOrigins] - List of allowed origins. If set to `\"all\"`, all origins are accepted.\n * @property {import('cors').CorsOptions} [options] - Additional CORS options passed directly to the `cors` middleware.\n * @property {import('cors').CorsOptionsDelegate} [customMiddleware] - A custom middleware function that overrides the default behavior.\n \n @remarks\n * If `customMiddleware` is provided, both `allowedOrigins` and `options` will be ignored in favor of the custom logic.\n \n See https://www.npmjs.com/package/cors\n /\n cors?: {\n /\n Defines allowed origins to acess the API.\n /\n allowedOrigins?: string \| string[] \| \"\";\n options?: CorsOptions;\n };\n /*\n Configuration for request body parsing.\n \n @property {(\"json\" \| \"urlencoded\" \| \"raw\" \| \"text\")} parser - The type of body parser to use.\n * @property {object} [options] - Parser-specific options passed to the corresponding Express body parser middleware.\n \n @remarks\n * - When `parser` is `\"json\"`, options are passed to `express.json()`.\n * - When `parser` is `\"urlencoded\"`, options are passed to `express.urlencoded()`.\n * - When `parser` is `\"raw\"`, options are passed to `express.raw()`.\n * - When `parser` is `\"text\"`, options are passed to `express.text()`.\n * - Set to `false` to disable body parsing for this route.\n \n See https://expressjs.com/en/api.html#express.json\n */\n bodyParser?:\n \| { parser: \"json\"; options?: Parameters<typeof express.json>[0] }\n \| {\n parser: \"urlencoded\";\n options?: Parameters<typeof express.urlencoded>[0];\n }\n \| { parser: \"raw\"; options?: Parameters<typeof express.raw>[0] }\n \| { parser: \"text\"; options?: Parameters<typeof express.text>[0] }\n \| false;\n}\n"]}

package/dist/esm/utils/arkos-router/utils/helpers/index.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../src/utils/arkos-router/utils/helpers/index.ts"],"names":[],"mappings":"~~AACA~~,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,2CAA2C,CAAC;AAClF,OAAO,mBAAmB,MAAM,6BAA6B,CAAC;~~AAG9D~~,OAAO,OAAO,MAAM,SAAS,CAAC;AAE9B,MAAM,UAAU,kBAAkB,CAChC,GAAQ,EACR,QAAQ,GAAG,EAAE;IAMb,MAAM,MAAM,GAIP,EAAE,CAAC;IAER,SAAS,gBAAgB,CAAC,KAAY,EAAE,MAAM,GAAG,EAAE;QACjD,KAAK,CAAC,OAAO,CAAC,CAAC,KAAU,EAAE,EAAE;YAC3B,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;gBAChB,MAAM,QAAQ,GAAG,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC;gBAC3C,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBAEjD,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;oBACzB,MAAM,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC;oBACzC,IAAI,MAAoC,CAAC;oBAEzC,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;wBAC/B,MAAM,WAAW,GAAG,mBAAmB,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;wBAE5D,IAAI,WAAW,EAAE,CAAC;4BAChB,MAAM,GAAG,WAAW,CAAC;4BACrB,MAAM,CAAC,IAAI,CAAC;gCACV,IAAI,EAAE,QAAQ;gCACd,MAAM,EAAE,MAAM,CAAC,WAAW,EAAE;gCAC5B,MAAM;6BACP,CAAC,CAAC;4BAEH,MAAM;wBACR,CAAC;oBACH,CAAC;gBACH,CAAC,CAAC,CAAC;YACL,CAAC;iBAAM,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC;gBAC1D,IAAI,YAAY,GAAG,MAAM,CAAC;gBAE1B,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;oBACjB,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM;yBACvB,QAAQ,EAAE;yBACV,KAAK,CAAC,0BAA0B,CAAC,CAAC;oBACrC,IAAI,KAAK,EAAE,CAAC;wBACV,YAAY,GAAG,MAAM,GAAG,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;wBAC7D,YAAY,GAAG,YAAY;6BACxB,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC;6BACrB,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;oBACxB,CAAC;gBACH,CAAC;gBAED,gBAAgB,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;YACrD,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,KAAK,GAAG,GAAG,CAAC,OAAO,EAAE,KAAK,IAAI,GAAG,CAAC,KAAK,CAAC;IAC9C,IAAI,KAAK;QAAE,gBAAgB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAE7C,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,MAAwB;IACzD,MAAM,WAAW,GAAG,EAAE,CAAC;IAEvB,IAAI,MAAM,CAAC,cAAc;QAAE,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;IAEtE,IACE,OAAO,MAAM,CAAC,cAAc,KAAK,QAAQ;QACzC,MAAM,CAAC,cAAc,CAAC,MAAM;QAC5B,MAAM,CAAC,cAAc,CAAC,QAAQ;QAE9B,WAAW,CAAC,IAAI,CACd,WAAW,CAAC,mBAAmB,CAC7B,MAAM,CAAC,cAAc,CAAC,MAAM,EAC5B,MAAM,CAAC,cAAc,CAAC,QAAQ,EAC9B,MAAM,CAAC,cAAc,EAAE,IAAI,CAC5B,CACF,CAAC;IAMJ,IACE,OAAO,MAAM,EAAE,UAAU,KAAK,QAAQ;QACtC,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,CAAC;QAE1E,WAAW,CAAC,IAAI,CACd,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAC7D,CAAC;IAEJ,WAAW,CAAC,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC,CAAC;IAEhD,OAAO,WAAW,CAAC;AACrB,CAAC","sourcesContent":["import ~~rateLimit from \"express-rate-limit\";\nimport~~ { authService } from \"../../../../exports/services\";\nimport { validateRequestInputs } from \"../../../../modules/base/base.middlewares\";\nimport RouteConfigRegistry from \"../../route-config-registry\";\nimport { ArkosRouteConfig } from \"../../types\";\nimport ~~cors from \"cors\";\nimport~~ express from \"express\";\n\nexport function extractArkosRoutes(\n app: any,\n basePath = \"\"\n): Array<{\n path: string;\n method: string;\n config?: ArkosRouteConfig;\n}> {\n const routes: Array<{\n path: string;\n method: string;\n config?: ArkosRouteConfig;\n }> = [];\n\n function extractFromStack(stack: any[], prefix = \"\") {\n stack.forEach((layer: any) => {\n if (layer.route) {\n const fullPath = prefix + layer.route.path;\n const methods = Object.keys(layer.route.methods);\n\n methods.forEach((method) => {\n const handlers = layer.route.stack \|\| [];\n let config: ArkosRouteConfig \| undefined;\n\n for (const handler of handlers) {\n const foundConfig = RouteConfigRegistry.get(handler.handle);\n\n if (foundConfig) {\n config = foundConfig;\n routes.push({\n path: fullPath,\n method: method.toUpperCase(),\n config,\n });\n\n break;\n }\n }\n });\n } else if (layer.name === \"router\" && layer.handle?.stack) {\n let nestedPrefix = prefix;\n\n if (layer.regexp) {\n const match = layer.regexp\n .toString()\n .match(/\\/\\^?(\\\\\\/[^?]+\|\\/[^?]+)/);\n if (match) {\n nestedPrefix = prefix + \"/\" + match[1].replace(/\\\\\\//g, \"/\");\n nestedPrefix = nestedPrefix\n .replace(/\\/\\//g, \"/\")\n .replace(/\\/$/, \"\");\n }\n }\n\n extractFromStack(layer.handle.stack, nestedPrefix);\n }\n });\n }\n\n const stack = app._router?.stack \|\| app.stack;\n if (stack) extractFromStack(stack, basePath);\n\n return routes;\n}\n\nexport function getMiddlewareStack(config: ArkosRouteConfig) {\n const middlewares = [];\n\n if (config.authentication) middlewares.push(authService.authenticate);\n\n if (\n typeof config.authentication === \"object\" &&\n config.authentication.action &&\n config.authentication.resource\n )\n middlewares.push(\n authService.handleAccessControl(\n config.authentication.action,\n config.authentication.resource,\n config.authentication?.rule\n )\n );\n\n // if (config.rateLimit) middlewares.push(rateLimit(config.rateLimit));\n\n // if (config.cors) middlewares.push(cors(config.cors.options));\n\n if (\n typeof config?.bodyParser === \"object\" &&\n [\"json\", \"urlencoded\", \"raw\", \"text\"].includes(config?.bodyParser?.parser)\n )\n middlewares.push(\n express[config.bodyParser.parser](config.bodyParser.options)\n );\n\n middlewares.push(validateRequestInputs(config));\n\n return middlewares;\n}\n"]}
1	+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../src/utils/arkos-router/utils/helpers/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,2CAA2C,CAAC;AAClF,OAAO,mBAAmB,MAAM,6BAA6B,CAAC;AAE9D,OAAO,OAAO,MAAM,SAAS,CAAC;AAE9B,MAAM,UAAU,kBAAkB,CAChC,GAAQ,EACR,QAAQ,GAAG,EAAE;IAMb,MAAM,MAAM,GAIP,EAAE,CAAC;IAER,SAAS,gBAAgB,CAAC,KAAY,EAAE,MAAM,GAAG,EAAE;QACjD,KAAK,CAAC,OAAO,CAAC,CAAC,KAAU,EAAE,EAAE;YAC3B,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;gBAChB,MAAM,QAAQ,GAAG,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC;gBAC3C,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBAEjD,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;oBACzB,MAAM,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC;oBACzC,IAAI,MAAoC,CAAC;oBAEzC,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;wBAC/B,MAAM,WAAW,GAAG,mBAAmB,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;wBAE5D,IAAI,WAAW,EAAE,CAAC;4BAChB,MAAM,GAAG,WAAW,CAAC;4BACrB,MAAM,CAAC,IAAI,CAAC;gCACV,IAAI,EAAE,QAAQ;gCACd,MAAM,EAAE,MAAM,CAAC,WAAW,EAAE;gCAC5B,MAAM;6BACP,CAAC,CAAC;4BAEH,MAAM;wBACR,CAAC;oBACH,CAAC;gBACH,CAAC,CAAC,CAAC;YACL,CAAC;iBAAM,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC;gBAC1D,IAAI,YAAY,GAAG,MAAM,CAAC;gBAE1B,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;oBACjB,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM;yBACvB,QAAQ,EAAE;yBACV,KAAK,CAAC,0BAA0B,CAAC,CAAC;oBACrC,IAAI,KAAK,EAAE,CAAC;wBACV,YAAY,GAAG,MAAM,GAAG,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;wBAC7D,YAAY,GAAG,YAAY;6BACxB,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC;6BACrB,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;oBACxB,CAAC;gBACH,CAAC;gBAED,gBAAgB,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;YACrD,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,KAAK,GAAG,GAAG,CAAC,OAAO,EAAE,KAAK,IAAI,GAAG,CAAC,KAAK,CAAC;IAC9C,IAAI,KAAK;QAAE,gBAAgB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAE7C,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,MAAwB;IACzD,MAAM,WAAW,GAAG,EAAE,CAAC;IAEvB,IAAI,MAAM,CAAC,cAAc;QAAE,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;IAEtE,IACE,OAAO,MAAM,CAAC,cAAc,KAAK,QAAQ;QACzC,MAAM,CAAC,cAAc,CAAC,MAAM;QAC5B,MAAM,CAAC,cAAc,CAAC,QAAQ;QAE9B,WAAW,CAAC,IAAI,CACd,WAAW,CAAC,mBAAmB,CAC7B,MAAM,CAAC,cAAc,CAAC,MAAM,EAC5B,MAAM,CAAC,cAAc,CAAC,QAAQ,EAC9B,MAAM,CAAC,cAAc,EAAE,IAAI,CAC5B,CACF,CAAC;IAMJ,IACE,OAAO,MAAM,EAAE,UAAU,KAAK,QAAQ;QACtC,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,CAAC;QAE1E,WAAW,CAAC,IAAI,CACd,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAC7D,CAAC;IAEJ,WAAW,CAAC,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC,CAAC;IAEhD,OAAO,WAAW,CAAC;AACrB,CAAC","sourcesContent":["import { authService } from \"../../../../exports/services\";\nimport { validateRequestInputs } from \"../../../../modules/base/base.middlewares\";\nimport RouteConfigRegistry from \"../../route-config-registry\";\nimport { ArkosRouteConfig } from \"../../types\";\nimport express from \"express\";\n\nexport function extractArkosRoutes(\n app: any,\n basePath = \"\"\n): Array<{\n path: string;\n method: string;\n config?: ArkosRouteConfig;\n}> {\n const routes: Array<{\n path: string;\n method: string;\n config?: ArkosRouteConfig;\n }> = [];\n\n function extractFromStack(stack: any[], prefix = \"\") {\n stack.forEach((layer: any) => {\n if (layer.route) {\n const fullPath = prefix + layer.route.path;\n const methods = Object.keys(layer.route.methods);\n\n methods.forEach((method) => {\n const handlers = layer.route.stack \|\| [];\n let config: ArkosRouteConfig \| undefined;\n\n for (const handler of handlers) {\n const foundConfig = RouteConfigRegistry.get(handler.handle);\n\n if (foundConfig) {\n config = foundConfig;\n routes.push({\n path: fullPath,\n method: method.toUpperCase(),\n config,\n });\n\n break;\n }\n }\n });\n } else if (layer.name === \"router\" && layer.handle?.stack) {\n let nestedPrefix = prefix;\n\n if (layer.regexp) {\n const match = layer.regexp\n .toString()\n .match(/\\/\\^?(\\\\\\/[^?]+\|\\/[^?]+)/);\n if (match) {\n nestedPrefix = prefix + \"/\" + match[1].replace(/\\\\\\//g, \"/\");\n nestedPrefix = nestedPrefix\n .replace(/\\/\\//g, \"/\")\n .replace(/\\/$/, \"\");\n }\n }\n\n extractFromStack(layer.handle.stack, nestedPrefix);\n }\n });\n }\n\n const stack = app._router?.stack \|\| app.stack;\n if (stack) extractFromStack(stack, basePath);\n\n return routes;\n}\n\nexport function getMiddlewareStack(config: ArkosRouteConfig) {\n const middlewares = [];\n\n if (config.authentication) middlewares.push(authService.authenticate);\n\n if (\n typeof config.authentication === \"object\" &&\n config.authentication.action &&\n config.authentication.resource\n )\n middlewares.push(\n authService.handleAccessControl(\n config.authentication.action,\n config.authentication.resource,\n config.authentication?.rule\n )\n );\n\n // if (config.rateLimit) middlewares.push(rateLimit(config.rateLimit));\n\n // if (config.cors) middlewares.push(cors(config.cors.options));\n\n if (\n typeof config?.bodyParser === \"object\" &&\n [\"json\", \"urlencoded\", \"raw\", \"text\"].includes(config?.bodyParser?.parser)\n )\n middlewares.push(\n express[config.bodyParser.parser](config.bodyParser.options)\n );\n\n middlewares.push(validateRequestInputs(config));\n\n return middlewares;\n}\n"]}

package/dist/esm/utils/cli/utils/cli.helpers.js CHANGED Viewed

@@ -11,6 +11,6 @@ export function killServerChildProcess() {
     killProductionServerChildProcess();
 }
 export function getVersion() {
-    return "1.4.0-canary.27";
+    return "1.4.0-canary.29";
 }
 //# sourceMappingURL=cli.helpers.js.map

package/dist/types/types/arkos-config.d.ts CHANGED Viewed

@@ -11,6 +11,7 @@ import { OpenAPIV3 } from "openapi-types";
 import type { ApiReferenceConfiguration } from "@scalar/express-api-reference" with { "resolution-mode": "import" };
 import nodemailer from "nodemailer";
 import { ModuleComponents } from "../utils/dynamic-loader";
+import { IArkosRouter } from "../utils/arkos-router/types";
 export type ArkosConfig = {
     request?: {
         parameters?: {
@@ -104,7 +105,7 @@ export type ArkosConfig = {
     };
     routers?: {
         strict?: boolean | "no-bulk";
-        additional?: express.Router[];
+        additional?: express.Router[] | IArkosRouter[];
         disable?: ("auth-router" | "prisma-models-router" | "file-upload" | "welcome-endpoint")[];
         replace?: {
             authRouter?: (config: ArkosConfig) => express.Router | Promise<express.Router>;

package/dist/types/utils/arkos-router/types/index.d.ts CHANGED Viewed

@@ -6,7 +6,7 @@ import { AccessControlRules } from "../../../types/auth";
 import { ArkosErrorRequestHandler, ArkosRequestHandler } from "../../../types";
 import { CorsOptions } from "cors";
 import express from "express";
-type MethodHandler = (config: ArkosRouteConfig, ...handlers: (ArkosRequestHandler | ArkosErrorRequestHandler)[]) => IArkosRouter;
+type MethodHandler = (config: ArkosRouteConfig, ...handlers: (ArkosRequestHandler | ArkosErrorRequestHandler)[]) => IRouter;
 export interface IArkosRouter extends Omit<IRouter, "get" | "post" | "put" | "patch" | "delete" | "options" | "head" | "trace" | "all"> {
     get: MethodHandler;
     post: MethodHandler;

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "arkos",
-  "version": "1.4.0-canary.27",
+  "version": "1.4.0-canary.29",
   "description": "The Express & Prisma RESTful Framework",
   "main": "dist/cjs/exports/index.js",
   "module": "dist/esm/exports/index.js",