First release of ElValidator

Author: ybouane

.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+node_modules
+
+package-lock.json
+yarn.lock

elvalidator.min.js

@@ -0,0 +1,88 @@
+//import ElValidator from 'elvalidator';
+import ElValidator from './index.js';
+
+// Set up the validator object
+let validator = new ElValidator({
+	name				: { type: String, required:true, trim:true, minlength:3 },
+	age					: { type: Number, required:true, integer:true, min:18, max:100 },
+	agreedTelemetry		: { type: Boolean, default:false },
+
+	// Array example:
+	tags				: [
+		{ type: String, minlength:3, lowercase:true, trim:true, match: /^[a-z0-9]+$/  }
+	],
+
+	// Object example:
+	settings	: {
+		darkMode	: { type: Boolean, required: true, },
+		codeEditor	: { type: String, default:'atom', enum:['atom', 'vstudio', 'notepad++'] },
+		extras		: { type: Object, required:true, }
+	},
+	stringOrBool	: {
+		$or	: [
+			{ type: String },
+			{ type: Boolean },
+		]
+	},
+	arrayWithOptions	: {
+		type	: [
+			{ type: String, minlength:3, lowercase:true, trim:true, match: /^[a-z0-9]+$/  }
+		],
+		minEntries		: 0,
+		maxEntries		: 20,
+		uniqueValues	: true,
+	},
+	custom	: { type: String, validator: async (value) => {
+		if(value.length%2 == 1)
+			throw new Error('The number of characters must be odd.');
+		return '->'+value;
+	}},
+}, {
+	strictMode			: true,
+	throwUnkownFields	: false,
+	accumulateErrors	: false,
+});
+
+// Validate/Sanitize a data object
+var sanitizedData = await validator.validate({
+	name				: 'Yassine',
+	age					: 27,
+
+	tags				: ['programmer', 'javascript'],
+	settings			: {
+		darkMode	: false,
+		//codeEditor	: 'atom',
+		extras		: {
+			one	: '1',
+			two	: 'anything',
+		}
+	},
+	other				: 'unknown field',
+	stringOrBool		: false,
+	arrayWithOptions	: ['hello', 'world', 'tag', 'WillDownCase', 'TAG', 'last'],
+	custom				: 'node'
+});
+
+console.log(sanitizedData);
+
+
+
+/*
+OUTPUT:
+
+{
+  name: 'Yassine',
+  age: 27,
+  agreedTelemetry: false,
+  tags: [ 'programmer', 'javascript' ],
+  settings: {
+    darkMode: false,
+    codeEditor: 'atom',
+    extras: { one: '1', two: 'anything' }
+  },
+  stringOrBool: false,
+  arrayWithOptions: [ 'hello', 'world', 'tag', 'willdowncase', 'last' ],
+  custom: '->node'
+}
+
+*/

example.js

@@ -0,0 +1,31 @@
+
+
+// Without ElValidator
+
+if(!Object.prototype.hasOwnProperty.call(req.body, 'name'))
+	throw new Error('The "Name" field is required.');
+if(typeof req.body.name!=='string')
+	throw new Error('The "Name" field must be a text field.');
+if(req.body.name.length<3)
+	throw new Error('The "Name" field must have at least 3 characters.');
+
+if(!Object.prototype.hasOwnProperty.call(req.body, 'tags'))
+	throw new Error('The "Tags" field is required.');
+if(!Array.isArray(req.body.tags))
+	throw new Error('The "Tags" field must be an array.');
+if(req.body.tags.some(tag=> {
+	return typeof tag!='string' || tag.length<2 || !tag.match(/[a-z0-9_]+/);
+}))
+	throw new Error('The "Tags" field has invalid value(s).');
+
+req.body.tags = req.body.tags.map(tag=>tag.toLowerCase());
+
+
+
+// With ElValidator
+let sanitized = await ElValidator.validate(req.body, {
+	name	: { type: String, required: true, minlength:3 },
+	tags	: [
+		{ type: String, required:true, lowercase:true, minlength:2, match:/[a-z0-9_]+/ }
+	],
+})