simple-validation-for-express

Getting Started

Install it using npm:

npm i @diegoti/simple-validation-for-express

Validations List

• string
  • required
  • size
  • range
  • email
  • confirmPassword
  • inList
  • equal
  • notEqual
  • custom
• number
  • required
  • range
  • inList
  • equal
  • notEqual
  • custom

Config object definition

{
  source: 'req property from express: body, query or params',
  type: 'string or number',
  field: 'property name that exists inside source',
  validations: {
    'validations_list_above': { 
      value: 'see examples below.',
      message: 'it overrides default message.',
    }
  }
},

Usage

Define a configuration object with the validations.

const uservalidator = [
  {
    source: 'body',
    type: 'string',
    field: 'name',
    validations: {
      required: { value: true, message: '[name.required] custom message.' },
    },
  },
  {
    source: 'body',
    type: 'string',
    field: 'email',
    validations: {
      required: { value: true, message: '[email.required] custom message.' },
      email: { value: true },
    },
  },
  {
    source: 'body',
    type: 'string',
    field: 'password',
    validations: {
      required: { value: true, message: '[password.required] custom message.' },
      range: { value: { min: 8, max: 16 } },
      confirmPassword: { value: "confirmPassword", message: '[password.confirmPassword] doesn\'t match new password.' },
    },
  },
  {
    source: '',
    type: 'string',
    field: 'confirmPassword',
    validations: {
      custom: {
        value: (body, query, params) => (body.confirmPassword === '123456'),
        message: 'Weak password, choose a strong password.',
      },
    },
  },
  {
    source: 'body',
    type: 'string',
    field: 'role',
    validations: {
      required: { value: false },
      size: { value: 3 },
      inList: { value: ['ADM', 'USE', 'MAN'] },
    },
  },
  {
    source: 'body',
    type: 'number',
    field: 'age',
    validations: {
      required: { value: true },
      range: { value: { min: 0, max: 100 }, message: null },
      inList: { value: [1, 55, 530] },
      equal: { value: 1111 },
    },
  },
];

module.exports = {
  uservalidator,
};

Import simple-validation-for-express and your config object and pass it to your route, if any validation is found, an error object is added to req object.

var express = require('express');
const simpleValidationForExpress = require("@diegoti/simple-validation-for-express");

const { uservalidator } = require('./user.validator');
var router = express.Router();

router.get('/', simpleValidationForExpress.validate(uservalidator), function (req, res, next) {
  res.status(req.errors ? 400 : 200).json({errors: req.errors})
});

module.exports = router;

Example of req.errors:

{
  "errors": [
    {
      "field": "name",
      "message": "[name.required] custom message."
    },
    {
      "field": "email",
      "message": "[email.required] custom message."
    },
    {
      "field": "email",
      "message": "email with value [@[email protected]] is not a valid email."
    },
    {
      "field": "password",
      "message": "[password.required] custom message."
    },
    {
      "field": "password",
      "message": "password must be between 8 and 16 characters."
    },
    {
      "field": "password",
      "message": "[password.confirmPassword] doesn't match new password."
    },
    {
      "field": "confirmPassword",
      "message": "Weak password, choose a strong password."
    },
    {
      "field": "role",
      "message": "role must contain one of these values [ADM,USE,MAN]."
    },
    {
      "field": "role",
      "message": "role must have 3 characters."
    },
    {
      "field": "age",
      "message": "age must be provided"
    },
    {
      "field": "age",
      "message": "age must be equal to [1111]"
    },
    {
      "field": "age",
      "message": "age must contain one of these values [1,55,530]."
    },
    {
      "field": "age",
      "message": "age must be a valid Number."
    },
    {
      "field": "age",
      "message": "age must be between 0 and 100."
    }
  ]
}