webiny-validation

v1.15.1

A simple data validation library, packed with frequently used validators. For more information about how to use this package see README

Latest version published 5 years ago

License: MIT

NPM

GitHub

Package Health Score

66 / 100

security
No known security issues
popularity
Small
maintenance
Inactive
community
Active

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
1.15.1	\|	05/2019	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.14.2	\|	05/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.13.1	\|	04/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.12.7	\|	03/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.11.0	\|	01/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Yes

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (2)

GitHub Stars: 7.39K
Forks: 612
Contributors: 80

Direct Usage Popularity

The npm package webiny-validation receives a total of 2 downloads a week. As such, we scored webiny-validation popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package webiny-validation, we found that it has been starred 7,388 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 80
Funding: No

With more than 10 contributors for the webiny-validation repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 289
Open PR: 42
Last Release: 5 years ago
Last Commit: 4 days ago

Further analysis of the maintenance status of webiny-validation based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for webiny-validation is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 6 years
Dependencies: 3 Direct
Versions: 35
Install Size: 95.3 kB
Dist-tags: 1
# of Files: 69
Maintainers: 1
TS Typings: No

webiny-validation has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Not sure how to use webiny-validation?

To help you get started, we've collected the most common ways that webiny-validation is being used within popular public projects.

webiny / webiny-js / packages / webiny-api-security / src / models / SecurityUser.model.js View on Github

return value;
                }

                value = value.toLowerCase().trim();
                instance.registerHookCallback("beforeSave", async () => {
                    const existingUser = await getModel("SecurityUser").findOne({
                        query: { email: value }
                    });
                    if (existingUser) {
                        throw Error("User with given e-mail already exists.");
                    }
                });
                // TODO .setOnce();

                return value;
            })(string({ validation: validation.create("required,email") }))
        })),
        withName("SecurityUser")

View more ways to use webiny-validation

Validation

A simple data validation library, packed with frequently used validators like required, email, url, creditCard etc.

Documentation

Installation

yarn add webiny-validation

Get Started

Simple example

Validation of data is performed asynchronously by default, like in the following example:

import { validation } from 'webiny-validation';

validation.validate(123, 'required,number,gt:20').then(() =&gt; {
    // Value is valid
}).catch(e =&gt; {
    // Value is invalid
});

Validators are specified by its name and in this case, there are three - required, number and gt. Since value is not empty, it is a number and is greater than 20, code execution will proceed regularly. On the other hand, if one of the validator was not satisfied, an instance of ValidationError would be thrown.

import { validation } from 'webiny-validation';

validation.validate(10, 'required,number,gt:20').catch(e =&gt; {
    // Throws an Error with message "Value needs to be greater than 20.".
});

It is possible to provide as many validators as needed.

Passing arguments

As seen in previous section, validators can accept additional arguments, which are divided by colon. The following validator simply states that value must be greater than 20:

gt:20

Some validators may even accept more than one arguments:

in:dog:cat:fish:bird

There is no limit on the number of passed arguments.

Built-in validators

The following is a complete list of built-in validators, ready to be used immediately:

creditCard
email
eq
gt
gte
in
integer
lt
lte
maxLength
minLength
number
password
phone
required
url

More information about each can be found in the following sections.

Adding custom validators

Apart from built-in validators, there are cases where additional validators might be needed. The following example shows how to add a custom validator:

import { validation, ValidationError } from 'webiny-validation';

validation.setValidator('gender', value =&gt; {
  if (['male', 'female'].includes(value)) {
      return;
  }
  throw new ValidationError('Value needs to be "male" or "female".);
});

// Throws an instance of ValidationError error.
await validation.validate('none', 'gender');

Synchronous validation

As mentioned, validation by default is performed asynchronously. But if more suitable, it can also be performed synchronously:

import { validation } from 'webiny-validation';

// Throws an instance of ValidationError error.
validation.validateSync('parrot', 'in:cat:dog:fish:parrot');

// Success.
validation.validateSync('fish', 'in:cat:dog:fish:parrot');

Returning instead of throwing

The following example shows how to force ValidationError to be returned, instead of thrown:

import { validation } from 'webiny-validation';
const error = await validation.validate("", "required", { throw: false });

Once executed, an instance of ValidationError will be assigned to the error constant.

Classes

Validation

packages-utils/webiny-validation/src/validation.js:23-148

Main class of Validation library. Exported as a singleton instance, it offers methods for sync/async data validation and overwriting or adding new validators.

Examples

import { validation } from 'webiny-validation';

// `validation` is a preconfigured instance of Validation class.
// From here you can either add new validators or use it as-is.

setValidator

packages-utils/webiny-validation/src/validation.js:40-43

Add new validator.

Parameters

name string Validator name.
callable Validator Validator function which throws a ValidationError if validation fails.

Returns Validation

getValidator

packages-utils/webiny-validation/src/validation.js:50-55

Get validator function by name.

Parameters

name string Validator name.

Returns Validator A validator function.

validate

packages-utils/webiny-validation/src/validation.js:64-92

Asynchronously validates value.

Parameters

value any Value to validate.
validators string A list of comma-separated validators (eg. required,number,gt:20).
options ValidateOptions Validation options.

Returns Promise<(boolean | ValidationError)>

validateSync

packages-utils/webiny-validation/src/validation.js:101-129

Synchronously validates value.

Parameters

value any Value to validate.
validators string A list of comma-separated validators (eg. required,number,gt:20).
options ValidateOptions Validation options.

Returns Promise<(boolean | ValidationError)>

Flow Types

ValidationError

packages-utils/webiny-validation/src/validationError.js:10-21

This class is used by validators to throw an error when value validation fails.

Parameters

message string Error message
validator string Validator that triggered this error
value any Value that triggered this error

creditCard

packages-utils/webiny-validation/src/validators/creditCard.js:17-54

Credit card validator. This validator will check if the given value is a credit card number.

Parameters

value any This is the value that will be validated.

Examples

import { validation } from 'webiny-validation';
validation.validate('notACreditCard', 'creditCard').then(() =&gt; {
 // Valid
}).catch(e =&gt; {
 // Invalid
});

Throws ValidationError

email

packages-utils/webiny-validation/src/validators/email.js:17-27

Email validator. This validator checks if the given value is a valid email address.

Parameters

value any This is the value that will be validated.

Examples

import { validation } from 'webiny-validation';
validation.validate('email@gmail.com', 'email').then(() =&gt; {
 // Valid
}).catch(e =&gt; {
 // Invalid
});

Throws ValidationError

eq

packages-utils/webiny-validation/src/validators/eq.js:18-27

Equality validator. This validator checks if the given values are equal.

Parameters

value any This is the value that will be validated.
params Array<string> This is the value to validate against. It is passed as a validator parameter: eq:valueToCompareWith

Examples

import { validation } from 'webiny-validation';
validation.validate('email@gmail.com', 'eq:another@gmail.com').then(() =&gt; {
 // Valid
}).catch(e =&gt; {
 // Invalid
});

Throws ValidationError

gt

packages-utils/webiny-validation/src/validators/gt.js:18-25

"Greater than" validator. This validator checks if the given values is greater than the min value.

Parameters

value any This is the value that will be validated.
params Array<string> This is the value to validate against. It is passed as a validator parameter: gt:valueToCompareAgainst

Examples

import { validation } from 'webiny-validation';
validation.validate(10, 'gt:100').then(() =&gt; {
 // Valid
}).catch(e =&gt; {
 // Invalid
});

Throws ValidationError

gte

packages-utils/webiny-validation/src/validators/gte.js:18-25

"Greater than or equals" validator. This validator checks if the given values is greater than or equal to the min value.

Parameters

value any This is the value that will be validated.
min any This is the value to validate against. It is passed as a validator parameter: gte:valueToCompareAgainst

Examples

import { validation } from 'webiny-validation';
validation.validate(10, 'gte:100').then(() =&gt; {
 // Valid
}).catch(e =&gt; {
 // Invalid
});

Throws ValidationError

in

packages-utils/webiny-validation/src/validators/in.js:18-27

"In array" validator. This validator checks if the given values is greater than or equal to the min value.

Parameters

value any This is the value that will be validated.
params any This is the array of values to search in. It is passed as a validator parameter: in:1:2:3. Array values are separated by :.

Examples

import { validation } from 'webiny-validation';
validation.validate(10, 'in:10:20:30').then(() =&gt; {
 // Valid
}).catch(e =&gt; {
 // Invalid
});

Throws ValidationError

number

packages-utils/webiny-validation/src/validators/number.js:11-19

This validator checks of the given value is a number

Parameters

value any

Returns boolean

Validator

packages-utils/webiny-validation/types.js:9-9

This type defines the validator function.

Parameters

value any This is the value being validated.
parameters Array<string> (Optional) This represents an array validator parameters.
Throws ValidationError

ValidateOptions

packages-utils/webiny-validation/types.js:17-19

This is an object containing validation options.

Properties

throw boolean Should validation throw on failure? Default: true.

webiny-validation dependencies

@babel/runtime isnumeric lodash

webiny-validation development dependencies

chai @babel/cli @babel/core @babel/plugin-proposal-object-rest-spread @babel/plugin-transform-runtime @babel/preset-env @babel/preset-flow babel-plugin-lodash chai-as-promised

FAQs

What is webiny-validation?

A simple data validation library, packed with frequently used validators. Visit Snyk Advisor to see a full health score report for webiny-validation, including popularity, security, maintenance & community analysis.

Is webiny-validation popular?

The npm package webiny-validation receives a total of 2 weekly downloads. As such, webiny-validation popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is webiny-validation well maintained?

We found indications that webiny-validation is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is webiny-validation safe to use?

The npm package webiny-validation was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 2 November-2024, at 14:28 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (2)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Not sure how to use webiny-validation?

Validation

Documentation

Table of Contents

Installation

Get Started

Simple example

Passing arguments

Built-in validators

Adding custom validators

Synchronous validation

Returning instead of throwing

Classes

Validation

setValidator

getValidator

validate

validateSync

Flow Types

ValidationError

creditCard

email

eq

gt

gte

in

number

Validator

ValidateOptions

webiny-validation dependencies

webiny-validation development dependencies

FAQs

What is webiny-validation?

Is webiny-validation popular?

Is webiny-validation well maintained?

Is webiny-validation safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues