Split external and internal modules apart, add additional RequestVali…

…dation functions, extend Express Request to include RequestValidation.
jessep · Apr 15, 2015 · b76b014 · b76b014
1 parent 7ca8add
commit b76b014
Showing 1 changed file with 171 additions and 154 deletions.
diff --git a/express-validator/express-validator.d.ts b/express-validator/express-validator.d.ts
@@ -5,169 +5,186 @@
 
 /// <reference path="../express/express.d.ts" />
 
+// Add RequestValidation Interface on to Express's Request Interface.
+declare module Express {
+  interface Request extends ExpressValidator.RequestValidation {}
+}
 
+// External express-validator module.
 declare module "express-validator" {
   import express = require('express');
 
-  module ExpressValidator {
-
-    export interface ValidationError {
-      msg: string;
-      param: string;
-    }
-
-    export interface RequestValidation {
-      check(field:string, message:string): Validator;
-      assert(field:string, message:string): Validator;
-      sanitize(field:string): Sanitizer;
-      onValidationError(func:(msg:string) => void): void;
-      validationErrors() : any;
-    }
-
-    export interface Validator {
-      /**
-       * Alias for regex()
-       */
-      is(): Validator;
-      /**
-       * Alias for notRegex()
-       */
-      not(): Validator;
-      isEmail(): Validator;
-      /**
-       * Accepts http, https, ftp
-       */
-      isUrl(): Validator;
-      /**
-       * Combines isIPv4 and isIPv6
-       */
-      isIP(): Validator;
-      isIPv4(): Validator;
-      isIPv6(): Validator;
-      isAlpha(): Validator;
-      isAlphanumeric(): Validator;
-      isNumeric(): Validator;
-      isHexadecimal(): Validator;
-      /**
-       * Accepts valid hexcolors with or without # prefix
-       */
-      isHexColor(): Validator;
-      /**
-       * isNumeric accepts zero padded numbers, e.g. '001', isInt doesn't
-       */
-      isInt(): Validator;
-      isLowercase(): Validator;
-      isUppercase(): Validator;
-      isDecimal(): Validator;
-      /**
-       * Alias for isDecimal
-       */
-      isFloat(): Validator;
-      /**
-       * Check if length is 0
-       */
-      notNull(): Validator;
-      isNull(): Validator;
-      /**
-       * Not just whitespace (input.trim().length !== 0)
-       */
-      notEmpty(): Validator;
-      equals(equals:any): Validator;
-      contains(str:string): Validator;
-      notContains(str:string): Validator;
-      /**
-       * Usage: regex(/[a-z]/i) or regex('[a-z]','i')
-       */
-      regex(pattern:string, modifiers:string): Validator;
-      notRegex(pattern:string, modifiers:string): Validator;
-      /**
-       * max is optional
-       */
-      len(min:number, max?:number): Validator;
-      /**
-       * Version can be 3, 4 or 5 or empty, see http://en.wikipedia.org/wiki/Universally_unique_identifier
-       */
-      isUUID(version:number): Validator;
-      /**
-       * Alias for isUUID(3)
-       */
-      isUUIDv3(): Validator;
-      /**
-       * Alias for isUUID(4)
-       */
-      isUUIDv4(): Validator;
-      /**
-       * Alias for isUUID(5)
-       */
-      isUUIDv5(): Validator;
-      /**
-       * Uses Date.parse() - regex is probably a better choice
-       */
-      isDate(): Validator;
-      /**
-       * Argument is optional and defaults to today. Comparison is non-inclusive
-       */
-      isAfter(date:Date): Validator;
-      /**
-       * Argument is optional and defaults to today. Comparison is non-inclusive
-       */
-      isBefore(date:Date): Validator;
-      isIn(options:string): Validator;
-      isIn(options:string[]): Validator;
-      notIn(options:string): Validator;
-      notIn(options:string[]): Validator;
-      max(val:string): Validator;
-      min(val:string): Validator;
-      /**
-       * Will work against Visa, MasterCard, American Express, Discover, Diners Club, and JCB card numbering formats
-       */
-      isCreditCard(): Validator;
-    }
-
-    interface Sanitizer {
-      /**
-       * Trim optional `chars`, default is to trim whitespace (\r\n\t )
-       */
-      trim(...chars:string[]): Sanitizer;
-      ltrim(...chars:string[]): Sanitizer;
-      rtrim(...chars:string[]): Sanitizer;
-      ifNull(replace:any): Sanitizer;
-      toFloat(): Sanitizer;
-      toInt(): Sanitizer;
-      /**
-       * True unless str = '0', 'false', or str.length == 0
-       */
-      toBoolean(): Sanitizer;
-      /**
-       * False unless str = '1' or 'true'
-       */
-      toBooleanStrict(): Sanitizer;
-      /**
-       * Decode HTML entities
-       */
-      entityDecode(): Sanitizer;
-      entityEncode(): Sanitizer;
-      /**
-       * Escape &, <, >, and "
-       */
-      escape(): Sanitizer;
-      /**
-       * Remove common XSS attack vectors from user-supplied HTML
-       */
-      xss(): Sanitizer;
-      /**
-       * Remove common XSS attack vectors from images
-       */
-      xss(fromImages:boolean): Sanitizer;
-    }
-  }
-
   /**
    *
    * @middlewareOptions see: https://github.com/ctavan/express-validator#middleware-options
    */
   function ExpressValidator(middlewareOptions?:any):express.RequestHandler;
 
-
   export = ExpressValidator;
 }
+
+// Internal Module.
+declare module ExpressValidator {
+
+  export interface ValidationError {
+    msg: string;
+    param: string;
+  }
+
+  export interface RequestValidation {
+    checkBody(field:string, message:string): Validator;
+    checkParams(field:string, message:string): Validator;
+    checkQuery(field:string, message:string): Validator;
+    checkHeader(field:string, message:string): Validator;
+    checkFiles(field:string, message:string): Validator;
+
+    filter(field:string): Sanitizer;
+    sanitize(field:string): Sanitizer;
+
+    check(field:string, message:string): Validator;
+    validate(field:string, message: string): Validator;
+
+    assert(field:string, message:string): Validator;
+
+    onValidationError(func:(msg:string) => void): void;
+    validationErrors(): any;
+  }
+
+  export interface Validator {
+    /**
+     * Alias for regex()
+     */
+    is(): Validator;
+    /**
+     * Alias for notRegex()
+     */
+    not(): Validator;
+    isEmail(): Validator;
+    /**
+     * Accepts http, https, ftp
+     */
+    isUrl(): Validator;
+    /**
+     * Combines isIPv4 and isIPv6
+     */
+    isIP(): Validator;
+    isIPv4(): Validator;
+    isIPv6(): Validator;
+    isAlpha(): Validator;
+    isAlphanumeric(): Validator;
+    isNumeric(): Validator;
+    isHexadecimal(): Validator;
+    /**
+     * Accepts valid hexcolors with or without # prefix
+     */
+    isHexColor(): Validator;
+    /**
+     * isNumeric accepts zero padded numbers, e.g. '001', isInt doesn't
+     */
+    isInt(): Validator;
+    isLowercase(): Validator;
+    isUppercase(): Validator;
+    isDecimal(): Validator;
+    /**
+     * Alias for isDecimal
+     */
+    isFloat(): Validator;
+    /**
+     * Check if length is 0
+     */
+    notNull(): Validator;
+    isNull(): Validator;
+    /**
+     * Not just whitespace (input.trim().length !== 0)
+     */
+    notEmpty(): Validator;
+    equals(equals:any): Validator;
+    contains(str:string): Validator;
+    notContains(str:string): Validator;
+    /**
+     * Usage: regex(/[a-z]/i) or regex('[a-z]','i')
+     */
+    regex(pattern:string, modifiers:string): Validator;
+    notRegex(pattern:string, modifiers:string): Validator;
+    /**
+     * max is optional
+     */
+    len(min:number, max?:number): Validator;
+    /**
+     * Version can be 3, 4 or 5 or empty, see http://en.wikipedia.org/wiki/Universally_unique_identifier
+     */
+    isUUID(version:number): Validator;
+    /**
+     * Alias for isUUID(3)
+     */
+    isUUIDv3(): Validator;
+    /**
+     * Alias for isUUID(4)
+     */
+    isUUIDv4(): Validator;
+    /**
+     * Alias for isUUID(5)
+     */
+    isUUIDv5(): Validator;
+    /**
+     * Uses Date.parse() - regex is probably a better choice
+     */
+    isDate(): Validator;
+    /**
+     * Argument is optional and defaults to today. Comparison is non-inclusive
+     */
+    isAfter(date:Date): Validator;
+    /**
+     * Argument is optional and defaults to today. Comparison is non-inclusive
+     */
+    isBefore(date:Date): Validator;
+    isIn(options:string): Validator;
+    isIn(options:string[]): Validator;
+    notIn(options:string): Validator;
+    notIn(options:string[]): Validator;
+    max(val:string): Validator;
+    min(val:string): Validator;
+    /**
+     * Will work against Visa, MasterCard, American Express, Discover, Diners Club, and JCB card numbering formats
+     */
+    isCreditCard(): Validator;
+  }
+
+  interface Sanitizer {
+    /**
+     * Trim optional `chars`, default is to trim whitespace (\r\n\t )
+     */
+    trim(...chars:string[]): Sanitizer;
+    ltrim(...chars:string[]): Sanitizer;
+    rtrim(...chars:string[]): Sanitizer;
+    ifNull(replace:any): Sanitizer;
+    toFloat(): Sanitizer;
+    toInt(): Sanitizer;
+    /**
+     * True unless str = '0', 'false', or str.length == 0
+     */
+    toBoolean(): Sanitizer;
+    /**
+     * False unless str = '1' or 'true'
+     */
+    toBooleanStrict(): Sanitizer;
+    /**
+     * Decode HTML entities
+     */
+    entityDecode(): Sanitizer;
+    entityEncode(): Sanitizer;
+    /**
+     * Escape &, <, >, and "
+     */
+    escape(): Sanitizer;
+    /**
+     * Remove common XSS attack vectors from user-supplied HTML
+     */
+    xss(): Sanitizer;
+    /**
+     * Remove common XSS attack vectors from images
+     */
+    xss(fromImages:boolean): Sanitizer;
+  }
+
+}