Validation Module Documentation

This module provides validation schemas for various common fields using Yup. These schemas are reusable and support custom error messages for each validation type. Fields cover validation for email, phone numbers, passports, and more.

Table of Contents

• Installation
• Usage
• Validation Functions
• Regular Expressions
• Example

Installation

To use Yup in your project, install it with npm:

npm install dpfv

Usage

Import specific validation functions as needed:

import { COUNTRY_REQUIRED, CURRENCY, EMAIL, EMAIL_REQUIRED, FIRSTNAME, PASSWORD_REQUIRED, PHONE_NUMBER_REQUIRED } from "dpfv";

Validation Functions

Each validation function returns a Yup schema with custom validation requirements. Optional custom error messages can be provided.

| Validator | Description | | ----------------------- | -------------------------------------------------------------------------------- | | EMAIL | Validates email format. | | EMAIL_REQUIRED | Validates and requires email format. | | FIRSTNAME | Validates first name with a minimum length of 1. | | FIRSTNAME_REQUIRED | Requires first name with a minimum length of 1. | | PASSWORD | Validates password with min 8 and max 64 characters. | | PASSWORD_REQUIRED | Requires password with min 8 and max 64 characters. | | PHONE_PREFIX | Validates international phone prefix format (e.g., +1, +44). | | PHONE_PREFIX_REQUIRED | Requires international phone prefix format. | | PHONE_NUMBER | Validates phone number format. | | PHONE_NUMBER_REQUIRED | Requires phone number format. | | ADDRESS | Validates address with max 300 characters. | | ADDRESS_REQUIRED | Requires address with max 300 characters. | | COUNTRY | Validates country code (min 2 characters). | | COUNTRY_REQUIRED | Requires country code (min 2 characters). | | NATIONALITY | Validates nationality code (min 2 characters). | | NATIONALITY_REQUIRED | Requires nationality code (min 2 characters). | | LOCALE | Validates locale format (e.g., en-US). | | LOCALE_REQUIRED | Requires locale format. | | PASSPORT | Validates passport format (8-9 alphanumeric or specific patterns). | | PASSPORT_REQUIRED | Requires passport format. | | OTP | Validates OTP format (4 characters). | | OTP_REQUIRED | Requires OTP format (4 characters). | | PROJECT | Validates project type (either "properties" or "corporate"). | | PROJECT_REQUIRED | Requires project type. | | CURRENCY | Validates currency code (e.g., AED, USD). Default: "AED". | | CURRENCY_REQUIRED | Requires currency code with default "AED". | | MEASUREMENT | Validates measurement unit (either "imperial" or "metric"). Default: "imperial". | | MEASUREMENT_REQUIRED | Requires measurement unit with default "imperial". |

Regular Expressions

• prefixRegExp: Used for validating international phone prefixes (e.g., +1, +44).
• unicodeLocaleRegExp: Used for validating locale formats (e.g., en-US).
• passportRegexp: Validates passport numbers with common format variations.
• phonenumberRegexp: Supports validation for various international phone number formats.

Example

Sample code using some of the validation schemas:

import { COUNTRY_REQUIRED, EMAIL_REQUIRED, PHONE_NUMBER_REQUIRED } from "dpfv";
import { object } from "yup";

const formSchema = object().shape({
  email: EMAIL_REQUIRED("Invalid email address", "Required validation error"),
  phoneNumber: PHONE_NUMBER_REQUIRED("Invalid phone number format", "Required validation error"),
  country: COUNTRY_REQUIRED("Country is required", "Required validation error"),
});
try {
  const validatedParams = await formSchema.validate(
    {
      email: "[email protected]",
      phoneNumber: "+123456789",
      country: "US",
    },
    { abortEarly: false },
  );
} catch (error) {
  //validation error
}

License

ISC License

Permission to use, copy, modify, and distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.