Easy-auth-validator NPM

Based on the document you shared, here's the complete README.md content for Easy Auth Validator:

Easy Auth Validator

A lightweight and intuitive library for validating registration and login forms, written in pure JavaScript. Compatible with Node.js, React.js, and browsers. No dependencies or compilation required.

Installation

Install the package via npm:

npm install easy-auth-validator

Features

Validation for username, email, and password.
Customizable: Minimum length, strict password rules, allowed email domains.
Universal Compatibility: Works with Node.js, React, and browsers.
Performance: Cached regular expressions for efficiency.
Simplicity: Pure JavaScript, no TypeScript or build steps needed.

Usage

1. With Node.js

Basic Example

const EasyValidator = require('easy-auth-validator');

const validator = new EasyValidator();
const data = {
    username: 'john',
    email: 'john@example.com',
    password: '123456'
};

const result = validator.register(data);
console.log(result);

With Custom Options

const EasyValidator = require('easy-auth-validator');

const validator = new EasyValidator({
    usernameMin: 5,
    passwordMin: 8,
    strictPassword: true,
    allowedEmails: ['gmail.com', 'outlook.com']
});

const data = {
    username: 'johnny',
    email: 'johnny@gmail.com',
    password: 'Password123!'
};
console.log(validator.register(data));

2. With React.js

Registration Form Example

import React, { useState } from 'react';
import EasyValidator from 'easy-auth-validator';

const RegisterForm = () => {
    const [formData, setFormData] = useState({ username: '', email: '', password: '' });
    const [errors, setErrors] = useState({});
    const validator = new EasyValidator({ strictPassword: true, usernameMin: 4 });

    const handleChange = (e) => {
        setFormData({ ...formData, [e.target.name]: e.target.value });
    };

    const handleSubmit = (e) => {
        e.preventDefault();
        const result = validator.register(formData);
        if (!result.valid) {
            setErrors(result.fields);
        } else {
            setErrors({});
            console.log('Registration successful!', formData);
        }
    };

    return (
        <form onSubmit={handleSubmit}>
            <div>
                <input
                    name="username"
                    value={formData.username}
                    onChange={handleChange}
                    placeholder="Username"
                />
                {errors.username && !errors.username.valid && (
                    <span style={{ color: 'red' }}>{errors.username.message}</span>
                )}
            </div>
            <div>
                <input
                    name="email"
                    value={formData.email}
                    onChange={handleChange}
                    placeholder="Email"
                />
                {errors.email && !errors.email.valid && (
                    <span style={{ color: 'red' }}>{errors.email.message}</span>
                )}
            </div>
            <div>
                <input
                    name="password"
                    type="password"
                    value={formData.password}
                    onChange={handleChange}
                    placeholder="Password"
                />
                {errors.password && !errors.password.valid && (
                    <span style={{ color: 'red' }}>{errors.password.message}</span>
                )}
            </div>
            <button type="submit">Register</button>
        </form>
    );
};

export default RegisterForm;

3. In a Browser

HTML Example

<!DOCTYPE html>
<html>
<head>
    <title>Easy Auth Validator Test</title>
</head>
<body>
    <script src="node_modules/easy-auth-validator/src/index.js"></script>
    <script>
        const validator = new EasyValidator();
        const data = {
            email: 'test@example.com',
            password: '123456'
        };
        const result = validator.login(data);
        console.log(result);
    </script>
</body>
</html>

Configuration Options

Pass an options object to the constructor to customize validation rules:

Option	Type	Default	Description
usernameMin	Number	3	Minimum length for the username
passwordMin	Number	6	Minimum length for the password
strictPassword	Boolean	false	Requires a special character and a digit
allowedEmails	Array	[]	List of allowed email domains

Example:

const validator = new EasyValidator({
    usernameMin: 4,
    passwordMin: 8,
    strictPassword: true,
    allowedEmails: ['gmail.com']
});

Return Structure

The register and login methods return an object with:

valid: true if all fields are valid, false otherwise.
fields: An object with validation details for each field:
- valid: true or false.
- message: Error message or 'OK' if valid.

Example Return:

{
    valid: false,
    fields: {
        username: { valid: true, message: 'OK' },
        email: { valid: false, message: 'Email is not valid.' },
        password: { valid: true, message: 'OK' }
    }
}

Examples

Registration with Error

const validator = new EasyValidator({ passwordMin: 8 });
const data = {
    username: 'bob',
    email: 'bob@example.com',
    password: '123' // Too short
};
console.log(validator.register(data));
// {
//   valid: false,
//   fields: {
//     username: { valid: true, message: 'OK' },
//     email: { valid: true, message: 'OK' },
//     password: { valid: false, message: 'Password must be at least 8 characters long.' }
//   }
// }

Successful Login

const validator = new EasyValidator();
const data = {
    email: 'user@example.com',
    password: 'password123'
};
console.log(validator.login(data));
// {
//   valid: true,
//   fields: {
//     email: { valid: true, message: 'OK' },
//     password: { valid: true, message: 'OK' }
//   }
// }

validation auth react node javascript simple

1.0.1

5 months ago

1.0.0

5 months ago

easy-auth-validator v1.0.1