@spinajs/validation 1.0.0

package/lib/config/validation.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/config/validation.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = require("path");
+function dir(path) {
+    return path_1.resolve(path_1.normalize(path_1.join(__dirname, path)));
+}
+module.exports = {
+    system: {
+        dirs: {
+            schemas: [dir('./../schemas')],
+        }
+    },
+    validation: {
+        // enable all errors on  validation, not only first one that occurred
+        allErrors: true,
+        // remove properties that are not defined in schema
+        removeAdditional: true,
+        // set default values if possible
+        useDefaults: true,
+        // The option coerceTypes allows you to have your data types coerced to the types specified in your schema type keywords
+        coerceTypes: true
+    }
+};
+//# sourceMappingURL=validation.js.map

package/lib/config/validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.js","sourceRoot":"","sources":["../../src/config/validation.ts"],"names":[],"mappings":";;AAAA,+BAAgD;AAEhD,SAAS,GAAG,CAAC,IAAY;IACrB,OAAO,cAAO,CAAC,gBAAS,CAAC,WAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;AACrD,CAAC;AAED,MAAM,CAAC,OAAO,GAAG;IACb,MAAM,EAAE;QACJ,IAAI,EAAE;YACF,OAAO,EAAE,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;SACjC;KACJ;IACD,UAAU,EAAE;QAER,qEAAqE;QACrE,SAAS,EAAE,IAAI;QAEf,mDAAmD;QACnD,gBAAgB,EAAE,IAAI;QAEtB,iCAAiC;QACjC,WAAW,EAAE,IAAI;QAEjB,wHAAwH;QACxH,WAAW,EAAE,IAAI;KACpB;CACJ,CAAA"}

package/lib/decorators.d.ts

@@ -0,0 +1,8 @@
+export declare const SCHEMA_SYMBOL: unique symbol;
+/**
+ *
+ * Add schema for object eg. model or dto.
+ *
+ * @param schema schema for object or schema name
+ */
+export declare function Schema(schema: object | string): (target: any) => void;

package/lib/decorators.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Schema = exports.SCHEMA_SYMBOL = void 0;
+exports.SCHEMA_SYMBOL = Symbol('SCHEMA_SYMBOL');
+/**
+ *
+ * Add schema for object eg. model or dto.
+ *
+ * @param schema schema for object or schema name
+ */
+function Schema(schema) {
+    return (target) => {
+        Reflect.defineMetadata(exports.SCHEMA_SYMBOL, schema, target);
+    };
+}
+exports.Schema = Schema;
+//# sourceMappingURL=decorators.js.map

package/lib/decorators.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"decorators.js","sourceRoot":"","sources":["../src/decorators.ts"],"names":[],"mappings":";;;AAAa,QAAA,aAAa,GAAG,MAAM,CAAC,eAAe,CAAC,CAAC;AAErD;;;;;GAKG;AACH,SAAgB,MAAM,CAAC,MAAuB;IAC1C,OAAO,CAAC,MAAW,EAAE,EAAE;QACnB,OAAO,CAAC,cAAc,CAAC,qBAAa,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1D,CAAC,CAAC;AACN,CAAC;AAJD,wBAIC"}

package/lib/exceptions/index.d.ts

@@ -0,0 +1,11 @@
+import { Exception } from "@spinajs/exceptions";
+import { ErrorObject } from "ajv";
+/**
+ * The exception that is thrown when JSON entity is checked against schema and is invalid
+ */
+export declare class ValidationFailed extends Exception {
+    parameter: any;
+    constructor(message: string, validationErrors: ValidationError[]);
+}
+export interface ValidationError extends ErrorObject {
+}

package/lib/exceptions/index.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ValidationFailed = void 0;
+const exceptions_1 = require("@spinajs/exceptions");
+/**
+ * The exception that is thrown when JSON entity is checked against schema and is invalid
+ */
+class ValidationFailed extends exceptions_1.Exception {
+    constructor(message, validationErrors) {
+        super(message);
+        this.parameter = validationErrors;
+    }
+}
+exports.ValidationFailed = ValidationFailed;
+//# sourceMappingURL=index.js.map

package/lib/exceptions/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/exceptions/index.ts"],"names":[],"mappings":";;;AAAA,oDAAgD;AAEhD;;GAEG;AACF,MAAa,gBAAiB,SAAQ,sBAAS;IAG5C,YAAY,OAAe,EAAE,gBAAmC;QAC9D,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,SAAS,GAAG,gBAAgB,CAAC;IACpC,CAAC;CACF;AAPF,4CAOE"}

package/lib/index.d.ts

@@ -0,0 +1,44 @@
+import { AsyncModule, IContainer } from "@spinajs/di";
+import Ajv from "ajv";
+import { Configuration } from "@spinajs/configuration";
+import { Log } from "@spinajs/log";
+import { ValidationError } from "./exceptions";
+export declare class DataValidator extends AsyncModule {
+    protected Validator: Ajv.Ajv;
+    protected Configuration: Configuration;
+    protected Container: IContainer;
+    protected Log: Log;
+    resolveAsync(container: IContainer): Promise<void>;
+    /**
+     * Tries to validate given data
+     *
+     * @param data data to validate. Function will try to extract schema attached to object via @Schema decorator
+     * @return { array : [boolean, ValidationError[]]} [0] true if data is valid, false otherwise, [1] list of all errors. If
+     *                                                 set in config validation.allErrors is set to false, only firs error is returned
+     */
+    tryValidate(data: any): [boolean, ValidationError[]];
+    /**
+     * Tries to validate given data
+     *
+     * @param  {string|object|Boolean} schemaKeyRef key, ref or schema object
+     * @param  {Any} data to be validated
+     * @return { array : [boolean, ValidationError[]]} [0] true if data is valid, false otherwise, [1] list of all errors. If
+     *                                                 set in config validation.allErrors is set to false, only firs error is returned
+     */
+    tryValidate(schema: object | string | boolean, data: any): [boolean, ValidationError[]];
+    /**
+     * Validate given data. When failed, exception is thrown
+     *
+     * @param data data to validate. Function will try to extract schema attached to object via @Schema decorator
+     * @throws {InvalidArgumen | ValidationFailed }
+     */
+    validate(data: any): void;
+    /**
+     * Validate given data
+     *
+     * @param  {string|object|Boolean} schemaKeyRef key, ref or schema object
+     * @param  {Any} data to be validated
+     * @throws {InvalidArgumen | ValidationFailed }
+     */
+    validate(schema: object | string | boolean, data: any): void;
+}

package/lib/index.js

@@ -0,0 +1,135 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DataValidator = void 0;
+const di_1 = require("@spinajs/di");
+const ajv_1 = __importDefault(require("ajv"));
+const configuration_1 = require("@spinajs/configuration");
+const fs = __importStar(require("fs"));
+const glob = __importStar(require("glob"));
+const path = __importStar(require("path"));
+const log_1 = require("@spinajs/log");
+const exceptions_1 = require("./exceptions");
+const exceptions_2 = require("@spinajs/exceptions");
+const decorators_1 = require("./decorators");
+class DataValidator extends di_1.AsyncModule {
+    async resolveAsync(container) {
+        this.Configuration = await container.resolve(configuration_1.Configuration);
+        this.Container = container;
+        const ajvConfig = Object.assign({ logger: {
+                log: this.Log.info.bind(this.Log),
+                warn: this.Log.warn.bind(this.Log),
+                error: this.Log.error.bind(this.Log)
+            } }, this.Configuration.get("validation"));
+        this.Validator = new ajv_1.default(ajvConfig);
+        // add $merge & $patch for json schema
+        require("ajv-merge-patch")(this.Validator);
+        // add common formats validation eg: date time
+        require("ajv-formats")(this.Validator);
+        // add keywords
+        require("ajv-keywords")(this.Validator);
+        this.Configuration.get("system.dirs.schemas", [])
+            .filter(dir => fs.existsSync(dir))
+            .flatMap((d) => glob.sync(path.join(d, "*.json")))
+            .map(f => {
+            return {
+                schema: require(f),
+                file: path.basename(f)
+            };
+        })
+            .filter(s => {
+            const isValid = this.Validator.validateSchema(s.schema);
+            if (!isValid) {
+                this.Log.warn(`Schema is not valid %s`, s.file);
+                return false;
+            }
+            return true;
+        })
+            .forEach(s => {
+            var _a;
+            const schemaId = (_a = s.schema.$id) !== null && _a !== void 0 ? _a : path.basename(s.file);
+            this.Log.trace(`Added schema ${schemaId}`);
+            this.Validator.addSchema(s.schema, schemaId);
+        });
+    }
+    tryValidate(schemaOrData, data) {
+        if (arguments.length === 1) {
+            const schema = Reflect.getMetadata(decorators_1.SCHEMA_SYMBOL, schemaOrData);
+            if (!schema) {
+                return [false, [{
+                            keyword: "empty_schema",
+                            dataPath: "data",
+                            schemaPath: "",
+                            params: "data"
+                        }]];
+            }
+            const result = this.Validator.validate(schema, schemaOrData);
+            if (!result) {
+                return [false, this.Validator.errors];
+            }
+        }
+        else {
+            if (!data) {
+                return [false, [{
+                            keyword: "invalid_argument",
+                            dataPath: "data",
+                            schemaPath: "",
+                            params: "data"
+                        }]];
+            }
+            const result = this.Validator.validate(schemaOrData, data);
+            if (!result) {
+                return [false, this.Validator.errors];
+            }
+        }
+    }
+    validate(schemaOrData, data) {
+        const [isValid, errors] = this.tryValidate(schemaOrData, data);
+        if (!isValid) {
+            switch (errors[0].keyword) {
+                case "invalid_argument":
+                    throw new exceptions_2.InvalidArgument("data is null or undefined");
+                case "empty_schema":
+                    throw new exceptions_2.InvalidArgument("objects schema is not set");
+                default:
+                    throw new exceptions_1.ValidationFailed("validation error", errors);
+            }
+        }
+    }
+}
+__decorate([
+    log_1.Logger(),
+    __metadata("design:type", Object)
+], DataValidator.prototype, "Log", void 0);
+exports.DataValidator = DataValidator;
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oCAAsD;AACtD,8CAAsB;AACtB,0DAAuD;AACvD,uCAAyB;AACzB,2CAA6B;AAC7B,2CAA6B;AAC7B,sCAA2C;AAC3C,6CAAiE;AACjE,oDAAsD;AACtD,6CAA6C;AAE7C,MAAa,aAAc,SAAQ,gBAAW;IAWnC,KAAK,CAAC,YAAY,CAAC,SAAqB;QAE3C,IAAI,CAAC,aAAa,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,6BAAa,CAAC,CAAC;QAC5D,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAE3B,MAAM,SAAS,mBACX,MAAM,EAAE;gBACJ,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;gBACjC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;gBAClC,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;aACvC,IACE,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,YAAY,CAAQ,CACjD,CAAA;QAED,IAAI,CAAC,SAAS,GAAG,IAAI,aAAG,CAAC,SAAS,CAAC,CAAC;QAEpC,sCAAsC;QACtC,OAAO,CAAC,iBAAiB,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAE3C,8CAA8C;QAC9C,OAAO,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAEvC,eAAe;QACf,OAAO,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAExC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAW,qBAAqB,EAAE,EAAE,CAAC;aACtD,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;aACjC,OAAO,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC;aACzD,GAAG,CAAC,CAAC,CAAC,EAAE;YACL,OAAO;gBACH,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;gBAClB,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;aACzB,CAAC;QACN,CAAC,CAAC;aACD,MAAM,CAAC,CAAC,CAAC,EAAE;YACR,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;YAExD,IAAI,CAAC,OAAO,EAAE;gBACV,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,wBAAwB,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;gBAChD,OAAO,KAAK,CAAC;aAChB;YAED,OAAO,IAAI,CAAC;QAChB,CAAC,CAAC;aACD,OAAO,CAAC,CAAC,CAAC,EAAE;;YACT,MAAM,QAAQ,SAAG,CAAC,CAAC,MAAM,CAAC,GAAG,mCAAI,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YACvD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,gBAAgB,QAAQ,EAAE,CAAC,CAAC;YAC3C,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;IACX,CAAC;IAoBM,WAAW,CAAC,YAAuC,EAAE,IAAU;QAElE,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE;YACxB,MAAM,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,0BAAa,EAAE,YAAY,CAAC,CAAC;YAEhE,IAAI,CAAC,MAAM,EAAE;gBACT,OAAO,CAAC,KAAK,EAAE,CAAC;4BACZ,OAAO,EAAE,cAAc;4BACvB,QAAQ,EAAE,MAAM;4BAChB,UAAU,EAAE,EAAE;4BACd,MAAM,EAAE,MAAM;yBACjB,CAAC,CAAC,CAAC;aACP;YAED,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;YAC7D,IAAI,CAAC,MAAM,EAAE;gBACT,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;aACxC;SAEJ;aAAM;YAEH,IAAI,CAAC,IAAI,EAAE;gBACP,OAAO,CAAC,KAAK,EAAE,CAAC;4BACZ,OAAO,EAAE,kBAAkB;4BAC3B,QAAQ,EAAE,MAAM;4BAChB,UAAU,EAAE,EAAE;4BACd,MAAM,EAAE,MAAM;yBACjB,CAAC,CAAC,CAAA;aACN;YAED,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;YAC3D,IAAI,CAAC,MAAM,EAAE;gBACT,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;aACxC;SACJ;IAGL,CAAC;IAkBM,QAAQ,CAAC,YAAuC,EAAE,IAAU;QAC/D,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;QAC/D,IAAI,CAAC,OAAO,EAAE;YACV,QAAQ,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE;gBACvB,KAAK,kBAAkB;oBACnB,MAAM,IAAI,4BAAe,CAAC,2BAA2B,CAAC,CAAC;gBAC3D,KAAK,cAAc;oBACf,MAAM,IAAI,4BAAe,CAAC,2BAA2B,CAAC,CAAC;gBAC3D;oBACI,MAAM,IAAI,6BAAgB,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;aAE9D;SACJ;IACL,CAAC;CACJ;AA5IG;IADC,YAAM,EAAE;;0CACU;AATvB,sCAqJC"}

package/package.json

@@ -0,0 +1,87 @@
+{
+  "name": "@spinajs/validation",
+  "version": "1.0.0",
+  "description": "validation library for spinajs framework",
+  "main": "lib/index.js",
+  "private": false,
+  "scripts": {
+    "test": "ts-mocha -p tsconfig.json test/**/*.test.ts",
+    "coverage": "nyc npm run test",
+    "build-docs": "rimraf docs && typedoc --options typedoc.json src/",
+    "build": "tsc",
+    "prepare": "npm run build",
+    "format": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",
+    "lint": "tslint -p tsconfig.json",
+    "prepublishOnly": "",
+    "preversion": "npm run lint",
+    "version": "npm run format && git add -A src",
+    "postversion": "git push && git push --tags"
+  },
+  "files": [
+    "lib/**/*"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/spinajs/validation.git"
+  },
+  "keywords": [
+    "spinajs",
+    "validation",
+    "schema"
+  ],
+  "author": "SpinaJS <spinajs@coderush.pl> (https://github.com/spinajs/core)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/spinajs/validation/issues"
+  },
+  "homepage": "https://github.com/spinajs/validation#readme",
+  "dependencies": {
+    "@spinajs/configuration": "^1.0.16",
+    "@spinajs/di": "^1.1.0",
+    "@spinajs/exceptions": "^1.0.4",
+    "@spinajs/log": "^1.0.10",
+    "ajv": "^6.12.2",
+    "ajv-formats": "^2.1.1",
+    "ajv-keywords": "^5.1.0",
+    "ajv-merge-patch": "^4.1.0"
+  },
+  "devDependencies": {
+    "@types/bunyan": "^1.8.6",
+    "@types/chai": "^4.1.7",
+    "@types/chai-as-promised": "^7.1.0",
+    "@types/compression": "^1.7.0",
+    "@types/cookie-parser": "^1.4.2",
+    "@types/cookie-signature": "^1.0.3",
+    "@types/cors": "^2.8.6",
+    "@types/express": "^4.17.6",
+    "@types/formidable": "^1.0.31",
+    "@types/helmet": "^0.0.47",
+    "@types/lodash": "^4.14.136",
+    "@types/luxon": "^2.0.8",
+    "@types/mime": "^2.0.3",
+    "@types/mocha": "^5.2.7",
+    "@types/node": "^16.11.11",
+    "@types/pug": "^2.0.4",
+    "@types/randomstring": "^1.1.6",
+    "@types/sinon": "^7.0.13",
+    "@types/uuid": "^8.3.3",
+    "chai": "^4.2.0",
+    "chai-as-promised": "^7.1.1",
+    "chai-dom": "^1.8.2",
+    "chai-http": "^4.3.0",
+    "cpx": "^1.5.0",
+    "mocha": "^6.1.4",
+    "nyc": "^14.1.1",
+    "prettier": "^1.18.2",
+    "sinon": "^7.3.2",
+    "ts-mocha": "^6.0.0",
+    "ts-node": "^8.3.0",
+    "tslint": "^5.20.1",
+    "tslint-circular-dependencies": "^0.1.0",
+    "tslint-config-prettier": "^1.18.0",
+    "tslint-config-standard": "^8.0.1",
+    "tslint-no-unused-expression-chai": "^0.1.4",
+    "typedoc": "^0.14.2",
+    "typescript": "^3.7.3"
+  }
+}