fastest-validator

What's Changed

• fix(types): improve typing by @thib3113 in https://github.com/icebob/fastest-validator/pull/339
• allow to add metas in the schema by @thib3113 in https://github.com/icebob/fastest-validator/pull/341

New Contributors

• @thib3113 made their first contribution in https://github.com/icebob/fastest-validator/pull/339

Full Changelog: https://github.com/icebob/fastest-validator/compare/v1.17.0...v1.18.0

What's Changed

• consider null as a value by @Freezystem in https://github.com/icebob/fastest-validator/pull/317
• Add type definition for haltOnFirstError on Validator constructor | fix: #316 by @hateablestream in https://github.com/icebob/fastest-validator/pull/322

New Contributors

• @Freezystem made their first contribution in https://github.com/icebob/fastest-validator/pull/317

Full Changelog: https://github.com/icebob/fastest-validator/compare/v1.16.0...v1.17.0

What's Changed

• convert property in array type by @DenisFerrero in https://github.com/icebob/fastest-validator/pull/314

New Contributors

• @DenisFerrero made their first contribution in https://github.com/icebob/fastest-validator/pull/314

Full Changelog: https://github.com/icebob/fastest-validator/compare/v1.15.0...v1.16.0

What's Changed

• fix record rule by @hugebdu in https://github.com/icebob/fastest-validator/pull/308
• Using labels in error messages by @Abdullah0sama in https://github.com/icebob/fastest-validator/pull/306

New Contributors

• @hugebdu made their first contribution in https://github.com/icebob/fastest-validator/pull/308
• @Abdullah0sama made their first contribution in https://github.com/icebob/fastest-validator/pull/306

Full Changelog: https://github.com/icebob/fastest-validator/compare/v1.14.0...v1.15.0

What's Changed

• Add: haltOnFirstError option by @avanelli in https://github.com/icebob/fastest-validator/pull/304
• fix: Multi-schema nullable validators not working as expected. #303

New Contributors

• @avanelli made their first contribution in https://github.com/icebob/fastest-validator/pull/304

Full Changelog: https://github.com/icebob/fastest-validator/compare/v1.13.0...v1.14.0

What's Changed

• add missing strict by @0x0a0d in https://github.com/icebob/fastest-validator/pull/279
• check empty: true in string rule. Fixes #283 by @icebob in https://github.com/icebob/fastest-validator/pull/284
• fix(date): rule date add convert string to number for timestamp by @intech in https://github.com/icebob/fastest-validator/pull/286
• add context.data to d.ts by @0x0a0d in https://github.com/icebob/fastest-validator/pull/288
• fix(multi): item rule has custom checker will throw error if validate… by @0x0a0d in https://github.com/icebob/fastest-validator/pull/290
• fix: issue #297 by @0x0a0d in https://github.com/icebob/fastest-validator/pull/298
• Add Record rule by @FFKL in https://github.com/icebob/fastest-validator/pull/300

Full Changelog: https://github.com/icebob/fastest-validator/compare/v1.12.0...v1.13.0

Changes

• update dev dependencies.
• add parameters to dynamic default value function. E.g: age: (schema, field, parent, context) => { ... }
• fix typescript definitions. #269, #270, #261
• fix multi validate with object strict remove. #272
• add normalize method. #275 E.g.: validator.normalize({ a: "string[]|optional" })

Changes

• fix debug mode. #237
• fix object "toString" issue. #235
• remove Node 10 from CI pipeline.
• refactoring the typescript definitions. #251
• update examples in readme. #255

Async custom validator supports

const schema = {
    // Turn on async mode for this schema
    $$async: true,
    name: {
        type: "string",
        min: 4,
        max: 25,
        custom: async (v) => {
            await new Promise(resolve => setTimeout(resolve, 1000));
            return v.toUpperCase();
        }
    },

    username: {
        type: "custom",
        custom: async (v) => {
            // E.g. checking in the DB that whether is unique.
            await new Promise(resolve => setTimeout(resolve, 1000));
            return v.trim();
        }
    },
}

The compiled check function has an async property to detect this mode. If true it returns a Promise.

const check = v.compile(schema);
console.log("Is async?", check.async);

Meta-information for custom validators

You can pass any extra meta information for the custom validators which is available via context.meta.

const schema = {
    name: { type: "string", custom: (value, errors, schema, name, parent, context) => {
        // Access to the meta
        return context.meta.a;
    } },
};
const check = v.compile(schema);

const res = check(obj, {
    // Passes meta information
    meta: { a: "from-meta" }
});

Changes

• support default and optional in tuples and arrays #226
• fix that this points to the Validator instance in custom functions #231

Changes

• fix issue with regex pattern in string rule #221
• fix returned value issue in email rule in case of empty: false #224

Changes

• fix issue in multiple custom validator #203
• Add min, max property to email rule #213
• Add base64 property to string rule #214

Changes

• uuid rule supports version 0 in #201 by @intech

New nullable rule attribute in #185

const schema = {
    age: { type: "number", nullable: true }
}
v.validate({ age: 42 }, schema); // Valid
v.validate({ age: null }, schema); // Valid
v.validate({ age: undefined }, schema); // Fail because undefined is disallowed
v.validate({}, schema); // Fail because undefined is disallowed

Changes

• Shorthand for array foo: "string[]" // means array of string in #190
• allow converting objectID to string in in #196

Changes

• New currency rule by @ishan-srivastava in #178
• fix issue in any rule #185
• update dev deps

Changes

• Fix issue with ObjectID rule

New objectID rule

You can validate BSON/MongoDB ObjectID's

Example

const  { ObjectID } = require("mongodb") // or anywhere else 
const schema = {
    id: {
        type: "objectID",
        ObjectID // passing the ObjectID class
    }  
}
const check = v.compile(schema);
check({ id: "5f082780b00cc7401fb8e8fc" }) // ok
check({ id: new ObjectID() }) // ok
check({ id: "5f082780b00cc7401fb8e8" }) // Error

Dynamic default value

You can use dynamic default value by defining a function that returns a value.

Example
In the following code, if createdAt field not defined in object`, the validator sets the current time into the property:

const schema = {
    createdAt: {
        type: "date",
        default: () => new Date()
    }
};
const obj = {}
v.validate(obj, schema); // Valid
console.log(obj);
/*
{
    createdAt: Date(2020-07-25T13:17:41.052Z)
}
*/

Changes

• Add support for uuid v6. #181
• Add addMessage method for using in plugins #166
• Fix uppercase uuid issue. #176
• Add singleLine property to string rule. #180

Credits

Many thanks to @intech and @erfanium for contributing.

Changes

• Fixing issue with pattern & empty handling in string rule #165

New tuple validation rule

Thanks for @Gamote, in this version there is a new tuple. This rule checks if a value is an Array with the elements order as described by the schema.

Example

const schema = {
    grade: { type: "tuple", items: ["string", "number", "string"] }
};

const schema = {
    location: { type: "tuple", empty: false, items: [
        { type: "number", min: 35, max: 45 },
        { type: "number", min: -75, max: -65 }
    ] }
}

Define aliases & custom rules in constructor options #162

You can define aliases & custom rules in constructor options instead of using v.alias and v.add.

Example

const v = new Validator({
    aliases: {
        username: {
            type: 'string',
            min: 4,
            max: 30
        }
    },
    customRules: {
        even: function({ schema, messages }, path, context) {
            return {
                source: `
                    if (value % 2 != 0)
                        ${this.makeError({ type: "evenNumber",  actual: "value", messages })}

                    return value;
                `
            };
        })
    }
});

Support plugins

Thanks for @erfanium, you can create plugin for fastest-validator.

Example

// Plugin Side
function myPlugin(validator){
    // you can modify validator here
    // e.g.: validator.add(...)
    // or  : validator.alias(...)
}
// Validator Side
const v = new Validator();
v.plugin(myPlugin)

Changes

• Allow empty property in string rule with pattern #149
• Add empty property to url and email rule #150
• Fix custom rule issue when multiple rules #155
• Update type definition #156

Changes

• added Deno example to readme.
• added minProps and maxProps by @alexjab #142
• shorthand for nested objectsby @erfanium #143
• typescript generics for compile method by @Gamote #146

Changes

• Fix custom function issue in array rule and in root-level #136, #137