@alanszp/express 14.0.5 → 14.1.0

package/dist/endpoints/BaseApi.d.ts

@@ -0,0 +1,21 @@
+import { JWTUser } from "@alanszp/jwt";
+import { BaseModel } from "@alanszp/validations";
+import { Controller } from "tsoa";
+import { Request } from "express";
+import { ILogger } from "@alanszp/logger";
+export declare type AuthRequest = Request & {
+    user: JWTUser;
+};
+export declare type BuildAuthEndpointOptions<Input extends BaseModel, CommandReturnType, ViewReturnType> = {
+    request: AuthRequest;
+    inputConstructor: (jwtUser: JWTUser) => Input;
+    command: (input: Input) => Promise<CommandReturnType & {
+        toView?: () => ViewReturnType;
+    }>;
+    returnCode?: number;
+    view?: (commandReturn: CommandReturnType) => ViewReturnType;
+    getLogger: () => ILogger;
+};
+export declare class BaseApi extends Controller {
+    protected buildAuthEndpoint<Input extends BaseModel, CommandReturnType, ViewReturnType>({ request, inputConstructor, command, returnCode, view, getLogger, }: BuildAuthEndpointOptions<Input, CommandReturnType, ViewReturnType>): Promise<ViewReturnType | CommandReturnType>;
+}

package/dist/endpoints/BaseApi.js

@@ -0,0 +1,37 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseApi = void 0;
+const tsoa_1 = require("tsoa");
+const lodash_1 = require("lodash");
+class BaseApi extends tsoa_1.Controller {
+    buildAuthEndpoint({ request, inputConstructor, command, returnCode = 200, view, getLogger, }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { path, method, user } = request;
+            const baseLog = `${(0, lodash_1.snakeCase)(path)}.${(0, lodash_1.snakeCase)(method)}`;
+            const logger = getLogger();
+            const input = inputConstructor(user);
+            logger.info(`${baseLog}.controller.starting`, { input });
+            const viewResponse = yield command(input);
+            this.setStatus(returnCode);
+            logger.info(`${baseLog}.controller.succeed`, { returnCode });
+            return view
+                ? view(viewResponse)
+                : (viewResponse === null || viewResponse === void 0 ? void 0 : viewResponse.toView) &&
+                    typeof viewResponse.toView === "function" &&
+                    viewResponse.toView.arguments === 0
+                    ? viewResponse.toView()
+                    : viewResponse;
+        });
+    }
+}
+exports.BaseApi = BaseApi;
+//# sourceMappingURL=BaseApi.js.map

package/dist/endpoints/BaseApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseApi.js","sourceRoot":"","sources":["../../src/endpoints/BaseApi.ts"],"names":[],"mappings":";;;;;;;;;;;;AAEA,+BAAkC;AAElC,mCAAmC;AAoBnC,MAAa,OAAQ,SAAQ,iBAAU;IACrB,iBAAiB,CAI/B,EACA,OAAO,EACP,gBAAgB,EAChB,OAAO,EACP,UAAU,GAAG,GAAG,EAChB,IAAI,EACJ,SAAS,GAKV;;YACC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;YACvC,MAAM,OAAO,GAAG,GAAG,IAAA,kBAAS,EAAC,IAAI,CAAC,IAAI,IAAA,kBAAS,EAAC,MAAM,CAAC,EAAE,CAAC;YAC1D,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;YAE3B,MAAM,KAAK,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC;YAErC,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,sBAAsB,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;YAEzD,MAAM,YAAY,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,CAAC;YAE1C,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;YAC3B,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,qBAAqB,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC;YAE7D,OAAO,IAAI;gBACT,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC;gBACpB,CAAC,CAAC,CAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,MAAM;oBAClB,OAAO,YAAY,CAAC,MAAM,KAAK,UAAU;oBACzC,YAAY,CAAC,MAAM,CAAC,SAAS,KAAK,CAAC;oBACrC,CAAC,CAAC,YAAY,CAAC,MAAM,EAAE;oBACvB,CAAC,CAAC,YAAY,CAAC;QACrB,CAAC;KAAA;CACF;AAtCD,0BAsCC"}

package/dist/errors/AuthMethodFailureError.d.ts

@@ -0,0 +1,7 @@
+import { HttpRenderableError, RenderableContext } from "@alanszp/errors";
+export declare class AuthenticationMethodError extends HttpRenderableError {
+    requiredChecks: string[];
+    constructor(requiredChecks: string[]);
+    httpCode(): number;
+    context(): RenderableContext;
+}

package/dist/errors/AuthMethodFailureError.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuthenticationMethodError = void 0;
+const errors_1 = require("@alanszp/errors");
+class AuthenticationMethodError extends errors_1.HttpRenderableError {
+    constructor(requiredChecks) {
+        super("Authentication Method Error");
+        this.requiredChecks = requiredChecks;
+    }
+    httpCode() {
+        return 401;
+    }
+    context() {
+        return {
+            requiredChecks: this.requiredChecks,
+        };
+    }
+}
+exports.AuthenticationMethodError = AuthenticationMethodError;
+//# sourceMappingURL=AuthMethodFailureError.js.map

package/dist/errors/AuthMethodFailureError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AuthMethodFailureError.js","sourceRoot":"","sources":["../../src/errors/AuthMethodFailureError.ts"],"names":[],"mappings":";;;AAAA,4CAAyE;AAEzE,MAAa,yBAA0B,SAAQ,4BAAmB;IAGhE,YAAY,cAAwB;QAClC,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACrC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;IACvC,CAAC;IAED,QAAQ;QACN,OAAO,GAAG,CAAC;IACb,CAAC;IAEM,OAAO;QACZ,OAAO;YACL,cAAc,EAAE,IAAI,CAAC,cAAc;SACpC,CAAC;IACJ,CAAC;CACF;AAjBD,8DAiBC"}

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./types/AuthMethod";
+export * from "./types/docs/examples";
 export * from "./middlewares/auditLog";
 export * from "./middlewares/accessLogger";
 export * from "./middlewares/authedForOrg";
@@ -10,3 +11,5 @@ export * from "./middlewares/jsonBodyParser";
 export * from "./middlewares/hasRoles";
 export * from "./middlewares/hasPermissions";
 export * from "./helpers/getRequestBaseLog";
+export * from "./endpoints/BaseApi";
+export * from "./errors/AuthMethodFailureError";

package/dist/index.js

@@ -11,6 +11,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./types/AuthMethod"), exports);
+__exportStar(require("./types/docs/examples"), exports);
 __exportStar(require("./middlewares/auditLog"), exports);
 __exportStar(require("./middlewares/accessLogger"), exports);
 __exportStar(require("./middlewares/authedForOrg"), exports);
@@ -22,4 +23,6 @@ __exportStar(require("./middlewares/jsonBodyParser"), exports);
 __exportStar(require("./middlewares/hasRoles"), exports);
 __exportStar(require("./middlewares/hasPermissions"), exports);
 __exportStar(require("./helpers/getRequestBaseLog"), exports);
+__exportStar(require("./endpoints/BaseApi"), exports);
+__exportStar(require("./errors/AuthMethodFailureError"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qDAAmC;AACnC,yDAAuC;AACvC,6DAA2C;AAC3C,6DAA2C;AAC3C,8DAA4C;AAC5C,iEAA+C;AAC/C,8EAA4D;AAC5D,+DAA6C;AAC7C,+DAA6C;AAC7C,yDAAuC;AACvC,+DAA6C;AAC7C,8DAA4C"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qDAAmC;AACnC,wDAAsC;AACtC,yDAAuC;AACvC,6DAA2C;AAC3C,6DAA2C;AAC3C,8DAA4C;AAC5C,iEAA+C;AAC/C,8EAA4D;AAC5D,+DAA6C;AAC7C,+DAA6C;AAC7C,yDAAuC;AACvC,+DAA6C;AAC7C,8DAA4C;AAC5C,sDAAoC;AACpC,kEAAgD"}

package/dist/middlewares/authenticateUser.d.ts

@@ -1,4 +1,4 @@
-import { VerifyOptions } from "@alanszp/jwt";
+import { JWTUser, VerifyOptions } from "@alanszp/jwt";
 import { NextFunction, Response } from "express";
 import { GenericRequest } from "../types/GenericRequest";
 export declare enum AuthMethods {
@@ -23,3 +23,9 @@ export interface BothMethodsOptions {
 }
 export declare type AuthOptions = JWTOptions | ApiKeyOptions | BothMethodsOptions;
 export declare function createAuthContext<Options extends AuthOptions>(options: Options): (authMethods: Options["types"][number][]) => (req: GenericRequest, res: Response, next: NextFunction) => Promise<void>;
+/**
+ * Attempt to authenticate a user using the authentication methods sent by parameter
+ * Used in authenticationModule for TSOA
+ * https://tsoa-community.github.io/docs/authentication.html
+ */
+export declare function tsoaAuthProvider<Options extends AuthOptions>(req: GenericRequest, options: Options, authMethods: AuthMethods[]): Promise<JWTUser>;

package/dist/middlewares/authenticateUser.js

@@ -9,10 +9,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createAuthContext = exports.AuthMethods = void 0;
+exports.tsoaAuthProvider = exports.createAuthContext = exports.AuthMethods = void 0;
 const jwt_1 = require("@alanszp/jwt");
 const getRequestLogger_1 = require("../helpers/getRequestLogger");
 const lodash_1 = require("lodash");
+const AuthMethodFailureError_1 = require("../errors/AuthMethodFailureError");
 const renderErrorJson_1 = require("../helpers/renderErrorJson");
 function parseAuthorizationHeader(authorization) {
     if (!authorization)
@@ -40,7 +41,7 @@ const middlewareGetterByAuthType = {
             return jwtUser;
         }
         catch (error) {
-            logger.info("auth.authWithJwt.invalidJwt", { jwt, error });
+            logger.info("auth.authWithJwt.invalidJwt", { error });
             return null;
         }
     }),
@@ -77,34 +78,17 @@ function createAuthContext(options) {
     return function getMiddlewareForMethods(authMethods) {
         return function authWithGivenMethods(req, res, next) {
             return __awaiter(this, void 0, void 0, function* () {
-                const logger = (0, getRequestLogger_1.getRequestLogger)(req);
-                const cookies = req.cookies || {};
-                const jwt = cookies.jwt || parseAuthorizationHeader(req.headers.authorization);
                 try {
-                    const authAttempts = yield Promise.all(authMethods.map((method) => middlewareGetterByAuthType[method](method === AuthMethods.JWT ? jwt : req.headers.authorization, options, logger)));
-                    const successfulAuthAttempts = (0, lodash_1.compact)(authAttempts);
-                    if ((0, lodash_1.isEmpty)(successfulAuthAttempts)) {
-                        res
-                            .status(401)
-                            .json((0, renderErrorJson_1.render401Error)([
-                            authAttempts.includes(null)
-                                ? `Token invalid for methods ${authMethods}`
-                                : `Token not set for methods ${authMethods}`,
-                        ]));
-                        return;
-                    }
-                    const jwtUser = successfulAuthAttempts[0];
-                    req.context.jwtUser = jwtUser;
-                    req.context.authenticated.push(jwtUser.employeeReference !== "0" ? "jwt" : "api_key");
+                    yield tsoaAuthProvider(req, options, authMethods);
                     next();
                 }
                 catch (error) {
-                    logger.info("auth.authenticateUser.error", {
-                        jwt,
-                        token: req.headers.authorization,
-                        methods: AuthMethods,
-                        error,
-                    });
+                    if (error instanceof AuthMethodFailureError_1.AuthenticationMethodError) {
+                        res
+                            .status(error.httpCode())
+                            .json((0, renderErrorJson_1.render401Error)(error.requiredChecks));
+                        return;
+                    }
                     res.status(401).json((0, renderErrorJson_1.render401Error)(authMethods));
                 }
             });
@@ -112,4 +96,46 @@ function createAuthContext(options) {
     };
 }
 exports.createAuthContext = createAuthContext;
+/**
+ * Attempt to authenticate a user using the authentication methods sent by parameter
+ * Used in authenticationModule for TSOA
+ * https://tsoa-community.github.io/docs/authentication.html
+ */
+function tsoaAuthProvider(req, options, authMethods) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const logger = (0, getRequestLogger_1.getRequestLogger)(req);
+        const cookies = req.cookies || {};
+        const jwt = cookies.jwt || parseAuthorizationHeader(req.headers.authorization);
+        try {
+            const authAttempts = yield Promise.all(authMethods.map((method) => middlewareGetterByAuthType[method](method === AuthMethods.JWT ? jwt : req.headers.authorization, options, logger)));
+            const successfulAuthAttempts = (0, lodash_1.compact)(authAttempts);
+            if ((0, lodash_1.isEmpty)(successfulAuthAttempts)) {
+                throw new AuthMethodFailureError_1.AuthenticationMethodError([
+                    authAttempts.includes(null)
+                        ? `Token invalid for methods ${authMethods}`
+                        : `Token not set for methods ${authMethods}`,
+                ]);
+            }
+            const jwtUser = successfulAuthAttempts[0];
+            req.context.jwtUser = jwtUser;
+            req.context.authenticated.push(jwtUser.employeeReference !== "0" ? "jwt" : "api_key");
+            return jwtUser;
+        }
+        catch (error) {
+            if (error instanceof AuthMethodFailureError_1.AuthenticationMethodError) {
+                logger.info("auth.authenticate_with_methods.authentication_user_fail", {
+                    methods: authMethods,
+                    error,
+                });
+                throw error;
+            }
+            logger.error("auth.authenticate_with_methods.error", {
+                error,
+                authMethods,
+            });
+            throw new AuthMethodFailureError_1.AuthenticationMethodError(authMethods);
+        }
+    });
+}
+exports.tsoaAuthProvider = tsoaAuthProvider;
 //# sourceMappingURL=authenticateUser.js.map

package/dist/middlewares/authenticateUser.js.map

@@ -1 +1 @@
-{"version":3,"file":"authenticateUser.js","sourceRoot":"","sources":["../../src/middlewares/authenticateUser.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,sCAAiE;AAEjE,kEAA+D;AAG/D,mCAAgD;AAChD,gEAA4D;AAE5D,SAAS,wBAAwB,CAC/B,aAAiC;IAEjC,IAAI,CAAC,aAAa;QAAE,OAAO,SAAS,CAAC;IACrC,MAAM,CAAC,MAAM,EAAE,GAAG,EAAE,GAAG,KAAK,CAAC,GAAG,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAEzD,IAAI,MAAM,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,SAAS,CAAC;IAE9D,OAAO,GAAG,CAAC;AACb,CAAC;AAED,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,0BAAW,CAAA;IACX,kCAAmB,CAAA;AACrB,CAAC,EAHW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAGtB;AA0BD,MAAM,0BAA0B,GAO5B;IACF,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CACjB,GAA8B,EAC9B,OAA4C,EAC5C,MAAe,EACf,EAAE;QACF,IAAI;YACF,IAAI,CAAC,GAAG;gBAAE,OAAO,SAAS,CAAC;YAC3B,MAAM,OAAO,GAAG,MAAM,IAAA,eAAS,EAC7B,OAAO,CAAC,gBAAgB,CAAC,SAAS,EAClC,GAAG,EACH,IAAA,aAAI,EAAC,OAAO,CAAC,gBAAgB,EAAE,WAAW,CAAC,CAC5C,CAAC;YACF,MAAM,CAAC,KAAK,CAAC,yBAAyB,EAAE;gBACtC,IAAI,EAAE,OAAO,CAAC,EAAE;gBAChB,GAAG,EAAE,OAAO,CAAC,qBAAqB;aACnC,CAAC,CAAC;YACH,OAAO,OAAO,CAAC;SAChB;QAAC,OAAO,KAAc,EAAE;YACvB,MAAM,CAAC,IAAI,CAAC,6BAA6B,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC;YAC3D,OAAO,IAAI,CAAC;SACb;IACH,CAAC,CAAA;IACD,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,CACrB,KAAgC,EAChC,OAAyC,EACzC,MAAe,EACsB,EAAE;QACvC,IAAI;YACF,IAAI,CAAC,KAAK;gBAAE,OAAO,SAAS,CAAC;YAC7B,IAAI,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;gBACxC,MAAM,CAAC,KAAK,CAAC,4BAA4B,EAAE;oBACzC,IAAI,EAAE,GAAG;oBACT,GAAG,EAAE,MAAM;iBACZ,CAAC,CAAC;gBACH,OAAO,OAAO,CAAC,OAAO,CACpB,IAAI,aAAO,CAAC;oBACV,EAAE,EAAE,GAAG;oBACP,iBAAiB,EAAE,GAAG;oBACtB,qBAAqB,EAAE,MAAM;oBAC7B,KAAK,EAAE,EAAE;oBACT,gBAAgB,EAAE,IAAI;oBACtB,mEAAmE;oBACnE,WAAW,EAAE,MAAM,EAAE,cAAc;iBACpC,CAAC,CACH,CAAC;aACH;iBAAM;gBACL,OAAO,IAAI,CAAC;aACb;SACF;QAAC,OAAO,KAAc,EAAE;YACvB,MAAM,CAAC,IAAI,CAAC,mCAAmC,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;YACnE,OAAO,IAAI,CAAC;SACb;IACH,CAAC,CAAA;CACF,CAAC;AAEF,SAAgB,iBAAiB,CAC/B,OAAgB;IAEhB,OAAO,SAAS,uBAAuB,CACrC,WAAuC;QAEvC,OAAO,SAAe,oBAAoB,CACxC,GAAmB,EACnB,GAAa,EACb,IAAkB;;gBAElB,MAAM,MAAM,GAAG,IAAA,mCAAgB,EAAC,GAAG,CAAC,CAAC;gBACrC,MAAM,OAAO,GAAI,GAAG,CAAC,OAA8C,IAAI,EAAE,CAAC;gBAC1E,MAAM,GAAG,GACP,OAAO,CAAC,GAAG,IAAI,wBAAwB,CAAC,GAAG,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;gBAErE,IAAI;oBACF,MAAM,YAAY,GAAG,MAAM,OAAO,CAAC,GAAG,CACpC,WAAW,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CACzB,0BAA0B,CAAC,MAAM,CAAC,CAChC,MAAM,KAAK,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,aAAa,EAC5D,OAAO,EACP,MAAM,CACP,CACF,CACF,CAAC;oBAEF,MAAM,sBAAsB,GAAG,IAAA,gBAAO,EAAC,YAAY,CAAC,CAAC;oBAErD,IAAI,IAAA,gBAAO,EAAC,sBAAsB,CAAC,EAAE;wBACnC,GAAG;6BACA,MAAM,CAAC,GAAG,CAAC;6BACX,IAAI,CACH,IAAA,gCAAc,EAAC;4BACb,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC;gCACzB,CAAC,CAAC,6BAA6B,WAAW,EAAE;gCAC5C,CAAC,CAAC,6BAA6B,WAAW,EAAE;yBAC/C,CAAC,CACH,CAAC;wBACJ,OAAO;qBACR;oBAED,MAAM,OAAO,GAAY,sBAAsB,CAAC,CAAC,CAAC,CAAC;oBACnD,GAAG,CAAC,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC;oBAC9B,GAAG,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,CAC5B,OAAO,CAAC,iBAAiB,KAAK,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CACtD,CAAC;oBACF,IAAI,EAAE,CAAC;iBACR;gBAAC,OAAO,KAAc,EAAE;oBACvB,MAAM,CAAC,IAAI,CAAC,6BAA6B,EAAE;wBACzC,GAAG;wBACH,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,aAAa;wBAChC,OAAO,EAAE,WAAW;wBACpB,KAAK;qBACN,CAAC,CAAC;oBACH,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAA,gCAAc,EAAC,WAAW,CAAC,CAAC,CAAC;iBACnD;YACH,CAAC;SAAA,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AA3DD,8CA2DC"}
+{"version":3,"file":"authenticateUser.js","sourceRoot":"","sources":["../../src/middlewares/authenticateUser.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,sCAAiE;AAEjE,kEAA+D;AAG/D,mCAAgD;AAChD,6EAA6E;AAC7E,gEAA4D;AAE5D,SAAS,wBAAwB,CAC/B,aAAiC;IAEjC,IAAI,CAAC,aAAa;QAAE,OAAO,SAAS,CAAC;IACrC,MAAM,CAAC,MAAM,EAAE,GAAG,EAAE,GAAG,KAAK,CAAC,GAAG,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAEzD,IAAI,MAAM,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,SAAS,CAAC;IAE9D,OAAO,GAAG,CAAC;AACb,CAAC;AAED,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,0BAAW,CAAA;IACX,kCAAmB,CAAA;AACrB,CAAC,EAHW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAGtB;AA0BD,MAAM,0BAA0B,GAO5B;IACF,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CACjB,GAA8B,EAC9B,OAA4C,EAC5C,MAAe,EACf,EAAE;QACF,IAAI;YACF,IAAI,CAAC,GAAG;gBAAE,OAAO,SAAS,CAAC;YAC3B,MAAM,OAAO,GAAG,MAAM,IAAA,eAAS,EAC7B,OAAO,CAAC,gBAAgB,CAAC,SAAS,EAClC,GAAG,EACH,IAAA,aAAI,EAAC,OAAO,CAAC,gBAAgB,EAAE,WAAW,CAAC,CAC5C,CAAC;YACF,MAAM,CAAC,KAAK,CAAC,yBAAyB,EAAE;gBACtC,IAAI,EAAE,OAAO,CAAC,EAAE;gBAChB,GAAG,EAAE,OAAO,CAAC,qBAAqB;aACnC,CAAC,CAAC;YACH,OAAO,OAAO,CAAC;SAChB;QAAC,OAAO,KAAc,EAAE;YACvB,MAAM,CAAC,IAAI,CAAC,6BAA6B,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;YACtD,OAAO,IAAI,CAAC;SACb;IACH,CAAC,CAAA;IACD,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,CACrB,KAAgC,EAChC,OAAyC,EACzC,MAAe,EACsB,EAAE;QACvC,IAAI;YACF,IAAI,CAAC,KAAK;gBAAE,OAAO,SAAS,CAAC;YAC7B,IAAI,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;gBACxC,MAAM,CAAC,KAAK,CAAC,4BAA4B,EAAE;oBACzC,IAAI,EAAE,GAAG;oBACT,GAAG,EAAE,MAAM;iBACZ,CAAC,CAAC;gBACH,OAAO,OAAO,CAAC,OAAO,CACpB,IAAI,aAAO,CAAC;oBACV,EAAE,EAAE,GAAG;oBACP,iBAAiB,EAAE,GAAG;oBACtB,qBAAqB,EAAE,MAAM;oBAC7B,KAAK,EAAE,EAAE;oBACT,gBAAgB,EAAE,IAAI;oBACtB,mEAAmE;oBACnE,WAAW,EAAE,MAAM,EAAE,cAAc;iBACpC,CAAC,CACH,CAAC;aACH;iBAAM;gBACL,OAAO,IAAI,CAAC;aACb;SACF;QAAC,OAAO,KAAc,EAAE;YACvB,MAAM,CAAC,IAAI,CAAC,mCAAmC,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;YACnE,OAAO,IAAI,CAAC;SACb;IACH,CAAC,CAAA;CACF,CAAC;AAEF,SAAgB,iBAAiB,CAC/B,OAAgB;IAEhB,OAAO,SAAS,uBAAuB,CACrC,WAAuC;QAEvC,OAAO,SAAe,oBAAoB,CACxC,GAAmB,EACnB,GAAa,EACb,IAAkB;;gBAElB,IAAI;oBACF,MAAM,gBAAgB,CAAC,GAAG,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;oBAClD,IAAI,EAAE,CAAC;iBACR;gBAAC,OAAO,KAAc,EAAE;oBACvB,IAAI,KAAK,YAAY,kDAAyB,EAAE;wBAC9C,GAAG;6BACA,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;6BACxB,IAAI,CAAC,IAAA,gCAAc,EAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC;wBAC9C,OAAO;qBACR;oBACD,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAA,gCAAc,EAAC,WAAW,CAAC,CAAC,CAAC;iBACnD;YACH,CAAC;SAAA,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAzBD,8CAyBC;AAED;;;;GAIG;AACH,SAAsB,gBAAgB,CACpC,GAAmB,EACnB,OAAgB,EAChB,WAA0B;;QAE1B,MAAM,MAAM,GAAG,IAAA,mCAAgB,EAAC,GAAG,CAAC,CAAC;QACrC,MAAM,OAAO,GAAI,GAAG,CAAC,OAA8C,IAAI,EAAE,CAAC;QAC1E,MAAM,GAAG,GACP,OAAO,CAAC,GAAG,IAAI,wBAAwB,CAAC,GAAG,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAErE,IAAI;YACF,MAAM,YAAY,GAAG,MAAM,OAAO,CAAC,GAAG,CACpC,WAAW,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CACzB,0BAA0B,CAAC,MAAM,CAAC,CAChC,MAAM,KAAK,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,aAAa,EAC5D,OAAO,EACP,MAAM,CACP,CACF,CACF,CAAC;YAEF,MAAM,sBAAsB,GAAG,IAAA,gBAAO,EAAC,YAAY,CAAC,CAAC;YAErD,IAAI,IAAA,gBAAO,EAAC,sBAAsB,CAAC,EAAE;gBACnC,MAAM,IAAI,kDAAyB,CAAC;oBAClC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC;wBACzB,CAAC,CAAC,6BAA6B,WAAW,EAAE;wBAC5C,CAAC,CAAC,6BAA6B,WAAW,EAAE;iBAC/C,CAAC,CAAC;aACJ;YAED,MAAM,OAAO,GAAY,sBAAsB,CAAC,CAAC,CAAC,CAAC;YACnD,GAAG,CAAC,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC;YAC9B,GAAG,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,CAC5B,OAAO,CAAC,iBAAiB,KAAK,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CACtD,CAAC;YACF,OAAO,OAAO,CAAC;SAChB;QAAC,OAAO,KAAc,EAAE;YACvB,IAAI,KAAK,YAAY,kDAAyB,EAAE;gBAC9C,MAAM,CAAC,IAAI,CAAC,yDAAyD,EAAE;oBACrE,OAAO,EAAE,WAAW;oBACpB,KAAK;iBACN,CAAC,CAAC;gBACH,MAAM,KAAK,CAAC;aACb;YACD,MAAM,CAAC,KAAK,CAAC,sCAAsC,EAAE;gBACnD,KAAK;gBACL,WAAW;aACZ,CAAC,CAAC;YACH,MAAM,IAAI,kDAAyB,CAAC,WAAW,CAAC,CAAC;SAClD;IACH,CAAC;CAAA;AAnDD,4CAmDC"}

package/dist/middlewares/errorRequestHandlerMiddleware.js

@@ -2,13 +2,26 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.errorRequestHandlerMiddleware = void 0;
 const errors_1 = require("@alanszp/errors");
+const core_1 = require("@alanszp/core");
+const tsoa_1 = require("tsoa");
 const getRequestBaseLog_1 = require("../helpers/getRequestBaseLog");
 const typeorm_1 = require("typeorm");
 const renderErrorJson_1 = require("../helpers/renderErrorJson");
-const errorRequestHandlerMiddleware = (getLogger) => (error, req, res, _next) => {
+const errorRequestHandlerMiddleware = (getLogger) => (error, req, res, next) => {
     const logger = getLogger();
     const baseLog = (0, getRequestBaseLog_1.getRequestBaseLog)(req);
     try {
+        if (error instanceof tsoa_1.ValidateError) {
+            const { body } = error.fields;
+            return res.status(400).json({
+                code: "json_schema_error",
+                message: "Error to validate JSON Schema",
+                context: {
+                    errors: body === null || body === void 0 ? void 0 : body.message,
+                },
+                origin: (0, core_1.appIdentifier)(),
+            });
+        }
         if (error instanceof errors_1.RenderableError) {
             const statusCode = error instanceof errors_1.HttpRenderableError ? error.httpCode() : 500;
             if (statusCode >= 500) {

package/dist/middlewares/errorRequestHandlerMiddleware.js.map

@@ -1 +1 @@
-{"version":3,"file":"errorRequestHandlerMiddleware.js","sourceRoot":"","sources":["../../src/middlewares/errorRequestHandlerMiddleware.ts"],"names":[],"mappings":";;;AACA,4CAIyB;AAGzB,oEAAiE;AACjE,qCAAgE;AAChE,gEAA4E;AAMrE,MAAM,6BAA6B,GACxC,CAAC,SAAwB,EAAE,EAAE,CAC7B,CAAC,KAAc,EAAE,GAAmB,EAAE,GAAa,EAAE,KAAmB,EAAE,EAAE;IAC1E,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAC3B,MAAM,OAAO,GAAG,IAAA,qCAAiB,EAAC,GAAG,CAAC,CAAC;IAEvC,IAAI;QACF,IAAI,KAAK,YAAY,wBAAe,EAAE;YACpC,MAAM,UAAU,GACd,KAAK,YAAY,4BAAmB,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;YAEhE,IAAI,UAAU,IAAI,GAAG,EAAE;gBACrB,MAAM,CAAC,KAAK,CAAC,GAAG,OAAO,UAAU,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE;oBAC/C,UAAU;oBACV,KAAK;iBACN,CAAC,CAAC;aACJ;iBAAM;gBACL,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,UAAU,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE;oBAC9C,UAAU;oBACV,KAAK;iBACN,CAAC,CAAC;aACJ;YAED,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;YAC5C,OAAO;SACR;QAED,IAAI,KAAK,YAAY,6BAAmB,EAAE;YACxC,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,iCAAiC,EAAE;gBACvD,KAAK;aACN,CAAC,CAAC;YACH,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAA,gCAAc,GAAE,CAAC,CAAC;YACvC,OAAO;SACR;QAED,IAAI,KAAK,YAAY,0BAAgB,EAAE;YACrC,IAAK,KAAqC,CAAC,IAAI,KAAK,OAAO,EAAE;gBAC3D,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,sCAAsC,EAAE;oBAC5D,KAAK;iBACN,CAAC,CAAC;gBACH,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAA,gCAAc,EAAC,uBAAuB,CAAC,CAAC,CAAC;aAC/D;iBAAM;gBACL,MAAM,CAAC,KAAK,CAAC,GAAG,OAAO,oCAAoC,EAAE;oBAC3D,KAAK;iBACN,CAAC,CAAC;gBACH,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,4BAAmB,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;aAC/D;YACD,OAAO;SACR;QAED,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,4BAAmB,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QAC9D,MAAM,CAAC,KAAK,CACV,GAAG,OAAO,qDAAqD,EAC/D,EAAE,KAAK,EAAE,CACV,CAAC;KACH;IAAC,OAAO,YAAqB,EAAE;QAC9B,IAAI;YACF,qCAAqC;YACrC,MAAM,CAAC,KAAK,CACV,GAAG,OAAO,qEAAqE,EAC/E,EAAE,KAAK,EAAE,YAAY,EAAE,CACxB,CAAC;SACH;QAAC,OAAO,MAAe,EAAE,GAAE;QAE5B,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;YACnB,IAAI,EAAE,uBAAuB;YAC7B,OAAO,EAAE,uBAAuB;YAChC,OAAO,EAAE,EAAE;SACZ,CAAC,CAAC;KACJ;AACH,CAAC,CAAC;AAtES,QAAA,6BAA6B,iCAsEtC"}
+{"version":3,"file":"errorRequestHandlerMiddleware.js","sourceRoot":"","sources":["../../src/middlewares/errorRequestHandlerMiddleware.ts"],"names":[],"mappings":";;;AACA,4CAIyB;AACzB,wCAA8C;AAC9C,+BAAqC;AAGrC,oEAAiE;AACjE,qCAAgE;AAChE,gEAA4E;AAMrE,MAAM,6BAA6B,GACxC,CAAC,SAAwB,EAAE,EAAE,CAC7B,CAAC,KAAc,EAAE,GAAmB,EAAE,GAAa,EAAE,IAAkB,EAAE,EAAE;IACzE,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAC3B,MAAM,OAAO,GAAG,IAAA,qCAAiB,EAAC,GAAG,CAAC,CAAC;IAEvC,IAAI;QACF,IAAI,KAAK,YAAY,oBAAa,EAAE;YAClC,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC,MAAM,CAAC;YAC9B,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;gBAC1B,IAAI,EAAE,mBAAmB;gBACzB,OAAO,EAAE,+BAA+B;gBACxC,OAAO,EAAE;oBACP,MAAM,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,OAAO;iBACtB;gBACD,MAAM,EAAE,IAAA,oBAAa,GAAE;aACxB,CAAC,CAAC;SACJ;QAED,IAAI,KAAK,YAAY,wBAAe,EAAE;YACpC,MAAM,UAAU,GACd,KAAK,YAAY,4BAAmB,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;YAEhE,IAAI,UAAU,IAAI,GAAG,EAAE;gBACrB,MAAM,CAAC,KAAK,CAAC,GAAG,OAAO,UAAU,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE;oBAC/C,UAAU;oBACV,KAAK;iBACN,CAAC,CAAC;aACJ;iBAAM;gBACL,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,UAAU,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE;oBAC9C,UAAU;oBACV,KAAK;iBACN,CAAC,CAAC;aACJ;YAED,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;YAC5C,OAAO;SACR;QAED,IAAI,KAAK,YAAY,6BAAmB,EAAE;YACxC,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,iCAAiC,EAAE;gBACvD,KAAK;aACN,CAAC,CAAC;YACH,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAA,gCAAc,GAAE,CAAC,CAAC;YACvC,OAAO;SACR;QAED,IAAI,KAAK,YAAY,0BAAgB,EAAE;YACrC,IAAK,KAAqC,CAAC,IAAI,KAAK,OAAO,EAAE;gBAC3D,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,sCAAsC,EAAE;oBAC5D,KAAK;iBACN,CAAC,CAAC;gBACH,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAA,gCAAc,EAAC,uBAAuB,CAAC,CAAC,CAAC;aAC/D;iBAAM;gBACL,MAAM,CAAC,KAAK,CAAC,GAAG,OAAO,oCAAoC,EAAE;oBAC3D,KAAK;iBACN,CAAC,CAAC;gBACH,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,4BAAmB,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;aAC/D;YACD,OAAO;SACR;QAED,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,4BAAmB,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QAC9D,MAAM,CAAC,KAAK,CACV,GAAG,OAAO,qDAAqD,EAC/D,EAAE,KAAK,EAAE,CACV,CAAC;KACH;IAAC,OAAO,YAAqB,EAAE;QAC9B,IAAI;YACF,qCAAqC;YACrC,MAAM,CAAC,KAAK,CACV,GAAG,OAAO,qEAAqE,EAC/E,EAAE,KAAK,EAAE,YAAY,EAAE,CACxB,CAAC;SACH;QAAC,OAAO,MAAe,EAAE,GAAE;QAE5B,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;YACnB,IAAI,EAAE,uBAAuB;YAC7B,OAAO,EAAE,uBAAuB;YAChC,OAAO,EAAE,EAAE;SACZ,CAAC,CAAC;KACJ;AACH,CAAC,CAAC;AAlFS,QAAA,6BAA6B,iCAkFtC"}

package/dist/types/docs/examples.d.ts

@@ -0,0 +1,26 @@
+import { RenderableView } from "@alanszp/errors";
+/**
+ * Internal server error
+ * Error 500
+ */
+export declare const InternalServerErrorExample: RenderableView;
+/**
+ * Bad request
+ * Error 400
+ */
+export declare const MalformedJSONExample: {
+    code: string;
+    message: string;
+    context: {};
+    origin: string;
+};
+/**
+ * Not Found
+ * Error 404
+ */
+export declare const NotFoundExample: {
+    code: string;
+    message: string;
+    context: {};
+    origin: string;
+};

package/dist/types/docs/examples.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotFoundExample = exports.MalformedJSONExample = exports.InternalServerErrorExample = void 0;
+/**
+ * Internal server error
+ * Error 500
+ */
+exports.InternalServerErrorExample = {
+    code: "internal_server_error",
+    message: "Internal Server Error",
+    context: {},
+    origin: "example-service:dev",
+};
+/**
+ * Bad request
+ * Error 400
+ */
+exports.MalformedJSONExample = {
+    code: "bad_request",
+    message: "Malformed JSON",
+    context: {},
+    origin: "example-service:dev",
+};
+/**
+ * Not Found
+ * Error 404
+ */
+exports.NotFoundExample = {
+    code: "not_found",
+    message: "Not Found",
+    context: {},
+    origin: "example-service:dev",
+};
+//# sourceMappingURL=examples.js.map

package/dist/types/docs/examples.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"examples.js","sourceRoot":"","sources":["../../../src/types/docs/examples.ts"],"names":[],"mappings":";;;AAEA;;;GAGG;AACU,QAAA,0BAA0B,GAAmB;IACxD,IAAI,EAAE,uBAAuB;IAC7B,OAAO,EAAE,uBAAuB;IAChC,OAAO,EAAE,EAAE;IACX,MAAM,EAAE,qBAAqB;CAC9B,CAAC;AAEF;;;GAGG;AACU,QAAA,oBAAoB,GAAG;IAClC,IAAI,EAAE,aAAa;IACnB,OAAO,EAAE,gBAAgB;IACzB,OAAO,EAAE,EAAE;IACX,MAAM,EAAE,qBAAqB;CAC9B,CAAC;AAEF;;;GAGG;AACU,QAAA,eAAe,GAAG;IAC7B,IAAI,EAAE,WAAW;IACjB,OAAO,EAAE,WAAW;IACpB,OAAO,EAAE,EAAE;IACX,MAAM,EAAE,qBAAqB;CAC9B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alanszp/express",
-  "version": "14.0.5",
+  "version": "14.1.0",
   "description": "Alan's express utils and middlewares.",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -18,19 +18,22 @@
   },
   "peerDependencies": {
     "@alanszp/errors": ">=12.0.0",
-    "express": "^4.17.1",
+    "express": "^4.19.2",
+    "tsoa": "^6.2.0",
     "typeorm": "^0.2.41"
   },
   "devDependencies": {
     "@types/body-parser": "^1.19.1",
     "@types/express": "^4.17.12",
     "@types/jest": "^28.1.8",
+    "@types/joi": "^17.2.3",
     "@types/lodash": "^4.14.170",
     "@types/node": "^20.11.17",
     "babel-jest": "^29.7.0",
     "jest": "^29.7.0",
     "ts-node": "^10.0.0",
     "tslint": "^6.1.3",
+    "tsoa": "^6.2.0",
     "typeorm": "^0.2.41",
     "typescript": "^4.3.4"
   },
@@ -44,5 +47,5 @@
     "body-parser": "^1.20.2",
     "lodash": "^4.17.21"
   },
-  "gitHead": "48c66d81045868fad55c17430517b0ec06dc9005"
+  "gitHead": "3af1b8c59ee05bd5835260f4688c639d96a14ca4"
 }