nsoufian / v4f Goto Github PK

View Code? Open in Web Editor NEW

50.0 50.0 6.0 678 KB

:heavy_check_mark:4F | A declarative , efficient, and flexible javaScript validation library for Humans.

Home Page: https://v4f.js.org

License: MIT License

JavaScript 97.87% CSS 2.13%

forms javascript-library validate-js validation validation-library validations validator validatorjs

v4f's People

Contributors

Stargazers

Watchers

Forkers

fossabot shinroo fstfwd

v4f's Issues

Fix access to nested value in When

When with nested field name not work

example

import {When, Field} from "v4f";
const username = Field()
  .string()
  .required({
    when: When(
      "address.zipCode",
      Field()
        .string()
        .required()
    )
  });

Improve and Refactor code base

Refactor and improve the code base :

Start Documentation web site

Create documentation using docusaurus
Create brach pages to create CHAIME file for domain v4f.js.org

Improve the Readme

Add Verbose boolean Validation

Add publish to npm pipline

Change circleci configuration from simple jobs to workflows
Add publish to npm pipline

Create Examples

React.js from example
Vue.js from example
Angular.js from example

Improve tests suite , with cool test philosophy

Implement Rule validation with cross field data

exemple :

import {Schema, Field, When} from "v4f";

const User = Schema({
username: Field()
 .string()
 .required();
email: Field()
 .string()
 .required();
password:Field()
 .string()
 .notEquals(["#username"])
 .required();
passwordConfirmation:Field()
 .string()
 .equals(["#password"])
 .required();
});

Fix jest unittest

Move Examples from this repo to it own repo

Fix Nested Schema with async options and nested schema with message template

Fix Required and Optional rules

Fix When field access in nested schema

Add Message error template for value and field name

Questions about the future

Is there plans to add support for custom validators?
is there plans for remote validation?

Add callback to apply to value of cross field rule

Fix Security issues CVE-2019-12043

Change the name of when to apply to make more sense

Implement SchemaType object to create schema validator

Implement SchemaType Object that will Be Exported as default to create validator schema,
The syntax must be like this examples :

Data to validate :

const user = {
  username: "reyx",
  password: "mypass",
  session: false,
}

Simple Schema

Create Simple Schema for user with no messages:

import SchemaType , {field} from "v4f";
const UserSchemaSimple = SchemaType({
 username: field().string().minLength(6).maxLength(20).requierd(),
 password: field().string().minLegnth(6).maxLength(30).required(),
 session: field().boolean().optional()
});

Schema wtih erros message

import SchemaType , {field} from "v4f";
const UserSchemaMessage = SchemaType({
 username: field()
  .string({message:"Username field must be string"})
  .minLength(6,{message:"Username field must have 6 characters min length"})
  .maxLength(20, {message:"Username field must have 20 characters max length"})
  .requierd({message:"Username field is required"}),
 password: field()
  .string({message:"Password field must be string"})
  .minLegnth(6,{message:"Password field must have 6 characters min length"})
  .maxLength(30, {message:"Password field must have 20 characters max length"})
  .required({message:"Password field is required"}),
 session: field().
  boolean()
  .optional()
});

Nessted Schema

nessted Schema syntax exemple:

const AdminUesr = Schematype({
isAdmin: field().
  boolean()
 .truthly(),
user: User
})

Validation

Simple validation with boolean resulte :

const errors = UserSchemaSimple.validate(user);
/**
 error object with containe false because validation faild in 
 username min length
**/

Validation with object errors contains messages:

const errors = UserSchemaMessage.validate(user, {message: true});
/**
 erros objects contain : 
{
  username: "Username field must have 6 characters min length"
}
If  validation success will contain null.
**/

Validate Only one field of the schema:

 const usernameError = UserSchemaMessage.username("myusername", {message: true});
/**
  usernameError will contain null validation success
**/

Improve rollupjs config file

Add umd

Improve Project directory structure

Move test to the root directory
Split rules module to submodules
Clean the code

Publish to open source community

Add Async Validation

Passing related field's value in custom function

Lately I've been wondering and trying to make custom function that could use value of some other related field.

I'm fine using custom validators in custom(), but can't figure out if it's possible to pass

["#someField"]

inside that custom validator, like

Field().custom(someNotYetWorkingValidator(["#someField"]))

To be more precise - I have two datepickers in my form and would like to validate their dates (later/earlier etc.)

I'm not experienced in js, but looking at source code, it doesn't seem to be possible just because how custom() is written.

export const custom = (fun, value) => fun(value);

Could you provide me with some tips? (i've been thinking about forking and trying to add some additional lines, but maybe I'm missing some existing solution)

Add multiple field names to When

Accept multiple field names as an array for When to check the same rule for multiple fields:

example :

import {Schema, Field, When} from "v4f";

const User = Schema({
  username: Field()
    .string()
    .required(),
  isAdmin: Field()
    .boolean()
    .required(),
  isActive: Field()
    .boolean()
    .required(),
  url: Field()
    .string()
    .required({
      when: When(
        ["isAdmin", "isActive"],
        Field()
          .boolean()
          .truthy()
      )
        .or(
          "username",
          Field()
            .string()
            .notEquals("admin")
        )
    })
});
});

Is there a way to do async username checks? [Question]

I see I can do an async check. I'm just unsure how to insert a method into the username field of my signup screen to have it fail if the username doesn't work. Is this possible to do with v4f?

My schema:

const SignUpValidator = Schema(
    {
        email: Field()
            .string()
            .email({ message: "Not an e-mail address" })
            .required({ message: "E-mail is required" }),
        firstName: Field()
            .string()
            .required({ message: "First name is required." }),
        lastName: Field()
            .string()
            .required({ message: "Last name is required."}),
        password: Field()
            .string()
            .not.equals(['#email'], { message: "Password cannot be the same as email" })
            .min(8, { message: "Password must be at least 8 characters" })
            .max(64, { message: "Password cannot be longer than 64 characters" })
            .required({ message: "Password is required" }),
        cpassword: Field()
            .equals(['#password'], { message: "Confirmation password must match password." })
            .required({ message: "Password is required" })
    },
    { verbose: true, async: true }
    // We set the options on creation all call to Schema Product will be verbose and async
);

Add new sets of rules for v4f

add new sets of rules to library

array rules
string rules
costume rules

Add When object for cross-field validation

Implement cross-field validation by adding new Type When that will be added in rules options to declare the condition for that rule.

simple When

example :

import {Field, Schema, When} from "v4f";

const Server = Schema({
host: Field().string().required(),
user: Field().string().required(),
sudo: Field().boolean().truly({
  when: When('user', Field().string().notEqual('root'))
})
});

Boolean sudo must be true when user field is not root.

When with multiple conditition

import {Field, Schema, When} from "v4f";
const User = Schema({
username: Field().string().required(),
password: Field().string().required(),
isAdmin: Field().boolean().optional(),
isActive: Field().boolean().required(),
adminUrl: Field().string().url().required({when:
When('isAdmin',Field().boolean().truly()).end('isActive': Field().boolean().truly())
 })
});

adminUrl field is required when isAdmin is true and isActive is true

nsoufian / v4f Goto Github PK

v4f's People

Contributors

Stargazers

Watchers

Forkers

v4f's Issues

example

exemple :

Simple Schema

Schema wtih erros message

Nessted Schema

Validation

example :

simple When

When with multiple conditition

Recommend Projects

Recommend Topics

Recommend Org