@dechamp/express-auto-route/dist/middleware/routeResponseJsonSchemaValidatorMiddleware/RouteResponseJsonSchemaValidator.js

An express auto route module which allows routes and middleware to be configured via config file.

"use strict";
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
    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) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
        step((generator = generator.apply(thisArg, _arguments || [])).next());
    });
};
var __generator = (this && this.__generator) || function (thisArg, body) {
    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
    function verb(n) { return function (v) { return step([n, v]); }; }
    function step(op) {
        if (f) throw new TypeError("Generator is already executing.");
        while (_) try {
            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
            if (y = 0, t) op = [op[0] & 2, t.value];
            switch (op[0]) {
                case 0: case 1: t = op; break;
                case 4: _.label++; return { value: op[1], done: false };
                case 5: _.label++; y = op[1]; op = [0]; continue;
                case 7: op = _.ops.pop(); _.trys.pop(); continue;
                default:
                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
                    if (t[2]) _.ops.pop();
                    _.trys.pop(); continue;
            }
            op = body.call(thisArg, _);
        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
    }
};
var __importDefault = (this && this.__importDefault) || function (mod) {
    return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
var path = require("path");
var joi = require("@hapi/joi");
var sprintf = require("sprintf-js").sprintf;
var jsonSchemaValidationService_1 = __importDefault(require("../../jsonSchema/jsonSchemaValidationService"));
var MSG_SCHEMA_FAILED = "Failed json schema on %s, errors: %s";
var deref = require("json-schema-deref-sync");
var RouteResponseJsonSchemaValidator = /** @class */ (function () {
    function RouteResponseJsonSchemaValidator() {
    }
    RouteResponseJsonSchemaValidator.prototype.callback = function (req, res, next) {
        return __awaiter(this, void 0, void 0, function () {
            var route, origionalJson;
            var _this = this;
            return __generator(this, function (_a) {
                route = req.config.route;
                if (!route.hasOwnProperty("responseJsonSchema")) {
                    return [2 /*return*/, next()];
                }
                origionalJson = res.json;
                res.json = function (data) {
                    // We only needed to intercept the json data, now we can
                    // restore json back to the original for future calls.
                    res.json = origionalJson;
                    var error = _this.validateData(route, data);
                    if (error) {
                        return next(error);
                    }
                    res.json(data);
                };
                next();
                return [2 /*return*/];
            });
        });
    };
    RouteResponseJsonSchemaValidator.prototype.validateData = function (route, data) {
        try {
            joi.assert(route, joi.object().keys({
                responseJsonSchema: joi.string().required(),
            }).unknown(true));
            var schema = this._buildResponseJsonSchema(route.responseJsonSchema);
            if (schema) {
                var error = jsonSchemaValidationService_1.default(schema, data);
                if (error) {
                    return sprintf(MSG_SCHEMA_FAILED, "response", error)
                        .trim("\n");
                }
            }
        }
        catch (error) {
            if (error.hasOwnProperty("details")) {
                console.debug("Skipping route \"" + route.id + "\" due to " + error.details[0].message);
            }
            return error.message;
        }
    };
    RouteResponseJsonSchemaValidator.prototype._buildResponseJsonSchema = function (responseJsonSchema) {
        var querySchemaPath = path.join(process.cwd(), responseJsonSchema);
        var schema = require(querySchemaPath);
        return deref(schema);
    };
    return RouteResponseJsonSchemaValidator;
}());
exports.default = RouteResponseJsonSchemaValidator;