@whiterabbitai/yup-ast

Forked from Yup AST generator


Install
npm install @whiterabbitai/yup-ast@1.0.6

Documentation

./images/Overgear.png

YUP AST to validatior generator

We wanted to create a system where validations did not have to be statically compiled into the frontend sources, but rather served from the backend database, and usable by both the backend and the frontend simultaneously.

To do this we created a simple AST model using yup for validation.

For many examples of the AST we can look into the tests file, where different use cases are defined.

Installing

With NPM:

npm install @overgear/yup-ast

With yarn:

yarn add @overgear/yup-ast

Schema

The schema is defined as follows:

A simple array with a string name is seen as a prefix notational function lookup.

["yup.object"]

Is seen as a call to the function

yup.object()

Functions can be chained together by surrounding them by an array:

[
    ["yup.object"],
    ["yup.required"],
]

Becomes

yup
    .object()
    .required()

Anything else in the array after the prefix function is treated as an argument to be passed to that function:

[
    ["yup.number"],
    ["yup.required"],
    ["yup.min", 50],
    ["yup.max", 500],

]

Becomes

yup
    .object()
    .required()
    .min(50)
    .max(500)

(Which validates that a number is required, greater than 50 and less than 500.

Multiple arguments can be passed to functions

[
    ["yup.number"],
    ["yup.required"],
    ["yup.min", 50, "This is the error for failing this validation"],
    ["yup.max", 500, "Number should be less than 500"],
]

Becomes

yup
    .object()
    .required()
    .min(50, "This is the error for failing this validation")
    .max(500, "Number should be less than 500")

and additional yup validators

[
    ["yup.object"],
    ["yup.required"],
    [
        "yup.shape",
        {
            "game": [["yup.string"], ["yup.required", "wizard.validations.is_required"]],
            "locale": [["yup.string"], ["yup.required", "wizard.validations.is_required"]],
            "category": [["yup.string"], ["yup.required", "wizard.validations.is_required"]],
            "subcategory": [["yup.string"], ["yup.required", "wizard.validations.is_required"]],
        },
    ],
]

Becomes

yup
    .object()
    .required()
    .shape({
          "game": yup.string().required("wizard.validations.is_required"),
          "locale": yup.string().required("wizard.validations.is_required"),
          "category": yup.string().required("wizard.validations.is_required"),
          "subcategory": yup.string().required("wizard.validations.is_required"),
    })

Custom validators

addCustomValidator(name, validator, binding = false)

Adds a custom validator by name:

addCustomValidator('myCustomValidator', yup.number().min(50).max(500))

Which creates a custom validator, to be used as:

[
  ["myCustomValidator"]
]

getCustomValidator(name)

Gets the value of a custom validator

delCustomValidator(name)

Removes a validator which the user has added

Generated validator

Since the result of a call to transformAll is a yup validator, please see the yup documentation for more information about features available.