class-sanitizer

Allows to use decorator and non-decorator based sanitation in your Typescript classes. Internally uses validator.js to make sanitation.

Installation

1. Install module:

   npm install class-sanitizer --save

2. ES6 features are used, so you may want to install es6-shim too:

   npm install es6-shim --save

   if you are building nodejs app, you may want to require("es6-shim"); in your app. or if you are building web app, you man want to add <script src="path-to-shim/es6-shim.js"> on your page.

Usage

Create your class and put some sanity decorators on its properties you want to sanitize:

import {sanitize, Trim, Rtrim, Blacklist} from "class-sanitizer";

export class Post {

    @Trim()
    title: string;

    @Rtrim(["."])
    @Blacklist(/(1-9)/)
    text: string;

}

let post1 = new Post();
post1.title = " Hello world ";
post1.text = "1. this is a great (2) post about hello 3 world.";

sanitize(post);
console.log(post);
// now post will look like this:
// Post {
// title: "Hello world",
// text: ". this is a great  post about hello  world"
// }

Custom sanitation classes

If you have custom sanity logic you want to use as annotations you can do it this way:

1. First create a file, lets say LetterReplacer.ts, and create there a new class:

   import {SanitizerInterface, SanitizerConstraint} from "class-sanitizer";
   
   @SanitizerConstraint()
   export class LetterReplacer implements SanitizerInterface {
   
       sanitize(text: string): string {
           return text.replace(/o/g, "w");
       }
   
   }

   Your class must implement SanitizerInterface interface and its sanitize method, which defines sanitation logic.

2. Then you can use your new sanitation constraint in your class:

   import {Sanitize} from "class-sanitizer";
   import {LetterReplacer} from "./LetterReplacer";
   
   export class Post {
   
       @Sanitize(LetterReplacer)
       title: string;
   
   }

   Here we set our newly created LetterReplacer sanitation constraint for Post.title.

3. Now you can use sanitizer as usual:

   import {sanitize} from "class-sanitizer";
   
   sanitize(post);

Using service container

Sanitizer supports service container in the case if want to inject dependencies into your custom sanity constraint classes. Here is example how to integrate it with typedi:

import {Container} from "typedi";
import {Sanitizer} from "class-sanitizer";

// do this somewhere in the global application level:
let sanitizer = Container.get(Sanitizer);
sanitizer.container = Container;

// now everywhere you can inject Sanitizer class which will go from the container
// also you can inject classes using constructor injection into your custom sanitizers.

Manual sanitation

There are several method exist in the Sanitizer that allows to perform non-decorator based sanitation:

import Sanitizer from "class-sanitizer";

Sanitizer.blacklist(str, chars);
Sanitizer.escape(str);
Sanitizer.ltrim(str, chars);
Sanitizer.normalizeEmail(str, isLowercase);
Sanitizer.rtrim(str, chars);
Sanitizer.stripLow(str, keepNewLines);
Sanitizer.toBoolean(input, isStrict);
Sanitizer.toDate(input);
Sanitizer.toFloat(input);
Sanitizer.toInt(input, radix);
Sanitizer.toString(input);
Sanitizer.trim(str, chars);
Sanitizer.whitelist(str, chars);

Sanity decorators

| Decorator | Description | |----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | @Blacklist(chars: RegExp) | Remove characters that appear in the blacklist. | | @Escape() | Replace <, >, &, ', " and / with HTML entities. | | @Ltrim() | Trim characters from the left-side of the input. | | @NormalizeEmail() | Canonicalize an email address. | | @Rtrim() | Trim characters from the right-side of the input. | | @StripLow() | Remove characters with a numerical value < 32 and 127, mostly control characters. | | @ToBoolean(isStrict?: boolean) | Convert the input to a boolean. Everything except for '0', 'false' and '' returns true. In strict mode only '1' and 'true' return true. | | @ToDate() | Convert the input to a date, or null if the input is not a date. | | @ToFloat() | Convert the input to a float. | | @ToInt() | Convert the input to an integer, or NaN if the input is not an integer. | | @ToString() | Convert the input to a string. | | @Trim(chars?: string[]) | Trim characters (whitespace by default) from both sides of the input. You can specify chars that should be trimmed. | | @Whitelist(chars: RegExp) | Remove characters that do not appear in the whitelist.* The characters are used in a RegExp and so you will need to escape some chars, e.g. whitelist(input, '\[\]'). |

Samples

Take a look on samples in ./sample for more examples of usages.

Todos

• cover with tests