initial commit

Author: Umed Khudoiberdiev

.gitignore

@@ -0,0 +1,24 @@
+### OS
+
+Thumbs.db
+ehthumbs.db
+Desktop.ini
+$RECYCLE.BIN/
+.DS_Store
+.AppleDouble
+.LSOverride
+Icon
+._*
+.Spotlight-V100
+.Trashes
+
+### IDE
+
+.idea/
+
+### Project
+
+typings/
+node_modules/
+built/
+npm-debug.log

README.md

@@ -0,0 +1,56 @@
+# Type Validator
+
+Wrapper over [validator.js][1] library that provides you easy way to use it with Typescript classes.
+
+## Usage
+
+Create your class and put some validation annotations on its properties you want to validate:
+
+```typescript
+import {Contains, IsInt, IsLength, IsEmail, IsFQDN, IsDate} from "type-validator/ValidationAnnotations";
+
+export class Post {
+
+    @IsLength(10, 20)
+    title: string;
+
+    @Contains('hello')
+    text: string;
+
+    @IsInt({ min: 0, max: 10 })
+    rating: number;
+
+    @IsEmail()
+    email: string;
+
+    @IsFQDN()
+    site: string;
+
+    @IsDate()
+    createDate: Date;
+
+}
+
+let validator = new Validator();
+
+let post = new Post();
+post.title = 'Hello'; // should not pass
+post.text = 'this is a great post about hell world'; // should not pass
+post.rating = 11; // should not pass
+post.email = 'google.com'; // should not pass
+post.site = 'googlecom'; // should not pass
+
+console.log(validator.validate(Post, post)); // returns you array of errors for fields that didn't pass validation
+```
+
+Validator also supports validation groups.
+Take a look on samples in `./sample` for more examples of usages.
+
+## Todos
+
+* cover with tests
+* more documentation and samples
+* add support to load validation configuration from json and plain javascript objects 
+* add support to work with vanila js
+
+[1]: https://github.com/chriso/validator.js

gulpfile.js

@@ -0,0 +1,85 @@
+var gulp = require('gulp');
+var runSequence = require('run-sequence');
+var del = require('del');
+var plumber = require('gulp-plumber');
+var ts = require('gulp-typescript');
+var exec = require('gulp-exec');
+
+gulp.task('clean', function (cb) {
+    return del(['./built/**'], cb);
+});
+
+gulp.task('compile', function() {
+    var tsProject = ts.createProject('tsconfig.json', {
+        sortOutput: true,
+        typescript: require('typescript')
+    });
+    return tsProject.src()
+        .pipe(plumber())
+        .pipe(ts(tsProject))
+        .js.pipe(gulp.dest('./built/es5'));
+});
+
+gulp.task('tsd', function() {
+    return gulp.src('./')
+        .pipe(exec('./node_modules/.bin/tsd install'))
+        .pipe(exec('./node_modules/.bin/tsd rebundle'))
+        .pipe(exec('./node_modules/.bin/tsd link'))
+        .pipe(exec.reporter());
+});
+
+gulp.task('build-package-copy-src', function() {
+    return gulp.src('./built/es5/src/**/*')
+        .pipe(gulp.dest('./built/package'));
+});
+
+gulp.task('build-package-copy-package-files', function() {
+    return gulp.src(['./package.json', 'README.md'])
+        .pipe(gulp.dest('./built/package'));
+});
+
+gulp.task('build-package-generate-dts', function () {
+    var fs = require('fs');
+    function getFiles (dir, files){
+        files = files || [];
+        var filesInDir = fs.readdirSync(dir);
+        for (var i in filesInDir){
+            var name = dir + '/' + filesInDir[i];
+            if (fs.statSync(name).isDirectory()){
+                getFiles(name, files);
+            } else {
+                files.push(name);
+            }
+        }
+        return files;
+    }
+
+    var dtsGenerator = require('dts-generator');
+    var name = require('./package.json').name;
+    var files = getFiles('./src');
+    dtsGenerator.generate({
+        name: name,
+        baseDir: './src',
+        files: files,
+        out: './built/package/' + name + '.d.ts'
+    });
+});
+
+gulp.task('build', function(cb) {
+    return runSequence(
+        'clean',
+        'tsd',
+        'compile',
+        cb
+    );
+});
+
+gulp.task('package', function(cb) {
+    return runSequence(
+        'build',
+        ['build-package-copy-src', 'build-package-copy-package-files', 'build-package-generate-dts'],
+        cb
+    );
+});
+
+gulp.task('default', ['build']);

package.json

@@ -0,0 +1,48 @@
+{
+  "name": "type-validator",
+  "version": "0.0.1",
+  "description": "Wrapper over validator.js library that allows to use validation decorators in your Typescript classes",
+  "license": "Apache-2.0",
+  "readmeFilename": "README.md",
+  "author": {
+    "name": "Umed Khudoiberdiev",
+    "email": "zarrhost@gmail.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/PLEEROCK/type-validator.git"
+  },
+  "bugs": {
+    "url": "https://github.com/PLEEROCK/type-validator/issues"
+  },
+  "tags": [
+    "validator",
+    "validation",
+    "typescript",
+    "typescript-validator"
+  ],
+  "typings": "./type-validator.d.ts",
+  "typescript": {
+    "definitions": [
+      "type-validator.d.ts"
+    ]
+  },
+  "dependencies": {
+    "validator": "^4.1.0"
+  },
+  "devDependencies": {
+    "del": "^2.0.2",
+    "dts-generator": "^1.5.0",
+    "fs": "0.0.2",
+    "gulp": "^3.9.0",
+    "gulp-exec": "^2.1.1",
+    "gulp-plumber": "^1.0.1",
+    "gulp-typescript": "^2.9.0",
+    "run-sequence": "^1.1.4",
+    "tsd": "^0.6.4",
+    "typescript": "^1.6.2"
+  },
+  "scripts": {
+    "postversion": "./node_modules/.bin/gulp package"
+  }
+}

sample/sample1-simple-validation/Post.ts

@@ -0,0 +1,23 @@
+import {Contains, IsInt, IsLength, IsEmail, IsFQDN, IsDate} from "../../src/annotation/ValidationAnnotations";
+
+export class Post {
+
+    @IsLength(10, 20)
+    title: string;
+
+    @Contains('hello')
+    text: string;
+
+    @IsInt({ min: 0, max: 10 })
+    rating: number;
+
+    @IsEmail()
+    email: string;
+
+    @IsFQDN()
+    site: string;
+
+    @IsDate()
+    createDate: Date;
+
+}

sample/sample1-simple-validation/app.ts

@@ -0,0 +1,57 @@
+import {Validator} from "../../src/Validator";
+import {Post} from "./Post";
+
+let validator = new Validator();
+
+// Sample1. simple validation
+
+let post1 = new Post();
+post1.title = 'Hello world'; // should pass
+post1.text = 'this is a great post about hello world'; // should pass
+post1.rating = 10; // should pass
+post1.email = 'info@google.com'; // should pass
+post1.site = 'google.com'; // should pass
+post1.createDate = new Date(); // should pass
+
+console.log(validator.validate(Post, post1)); // should pass completely, e.g. return empty array
+
+let post2 = new Post();
+post2.title = 'Hello'; // should not pass
+post2.text = 'this is a great post about hell world'; // should not pass
+post2.rating = 11; // should not pass
+post2.email = 'google.com'; // should not pass
+post2.site = 'googlecom'; // should not pass
+// should not pass because date property is missing
+
+console.log(validator.validate(Post, post2)); // should not pass completely, must return array of ValidationError-s
+
+// Sample2. using validation options to skip properties that are not defined
+
+let post3 = new Post();
+post3.title = 'Hello'; // should not pass
+post3.text = 'this is a great post about hell world'; // should not pass
+post3.rating = 11; // should not pass
+post3.email = 'google.com'; // should not pass
+post3.site = 'googlecom'; // should not pass
+
+console.log(validator.validate(Post, post3, { skipMissingProperties: true })); // should not pass, but returned ValidationError-s should not have error about date field
+
+let post4 = new Post();
+post4.title = 'Hello world'; // should pass
+post4.text = 'this is a great post about hello world'; // should pass
+post4.rating = 10; // should pass
+post4.email = 'info@google.com'; // should pass
+post4.site = 'google.com'; // should pass
+
+console.log(validator.validate(Post, post4, { skipMissingProperties: true })); // should pass even if date is not set
+
+// Sample3. using validation groups
+
+let post5 = new Post();
+post5.title = 'Hello world'; // should pass
+post5.text = 'this is a great post about hello world'; // should pass
+post5.rating = 10; // should pass
+post5.email = 'info@google.com'; // should pass
+post5.site = 'google.com'; // should pass
+
+console.log(validator.validate(Post, post5, { skipMissingProperties: true })); // should pass even if date is not set

sample/sample2-simple-sanitization/Post.ts

@@ -0,0 +1,15 @@
+import {Trim, Rtrim, ToInt, Blacklist} from "../../src/annotation/SanitizeAnnotations";
+
+export class Post {
+
+    @Trim()
+    title: string;
+
+    @Rtrim(['.'])
+    @Blacklist(/(1-9)/)
+    text: string;
+
+    @ToInt()
+    rating: number;
+
+}

sample/sample2-simple-sanitization/app.ts

@@ -0,0 +1,14 @@
+import {Validator} from "../../src/Validator";
+import {Post} from "./Post";
+
+let validator = new Validator();
+
+// Sample1. simple sanitization
+
+let post1 = new Post();
+post1.title = ' Hello world '; // should pass
+post1.text = '1. this is a great (2) post about hello 3 world.'; // should pass
+post1.rating = 12.2; // should pass
+
+validator.sanitize(Post, post1);
+console.log(post1);

sample/sample3-using-groups/Post.ts

@@ -0,0 +1,38 @@
+import {Contains, IsInt, IsLength, IsEmail, IsFQDN, IsDate} from "../../src/annotation/ValidationAnnotations";
+
+export class Post {
+
+    @IsLength(10, 20, {
+        message: 'Incorrect length!',
+        groups: ['users', 'moderators']
+    })
+    @IsLength(0, 20, {
+        message: 'Incorrect length!',
+        groups: ['admins']
+    })
+    title: string;
+
+    @Contains('hello', {
+        message: 'It should contain word "hello!"',
+        groups: ['users', 'moderators']
+    })
+    text: string;
+
+    @IsInt({ min: 0, max: 10 })
+    rating: number;
+
+    @IsEmail(null, {
+        always: true
+    })
+    email: string;
+
+    @IsFQDN(null, {
+        message: 'Site address should be correct',
+        groups: ['users']
+    })
+    site: string;
+
+    @IsDate()
+    createDate: Date;
+
+}